github.com/rclone/rclone@v1.66.1-0.20240517100346-7b89735ae726/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> 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 div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;} 15 ul.task-list{list-style: none;} 16 pre > code.sourceCode { white-space: pre; position: relative; } 17 pre > code.sourceCode > span { display: inline-block; line-height: 1.25; } 18 pre > code.sourceCode > span:empty { height: 1.2em; } 19 code.sourceCode > span { color: inherit; text-decoration: inherit; } 20 div.sourceCode { margin: 1em 0; } 21 pre.sourceCode { margin: 0; } 22 @media screen { 23 div.sourceCode { overflow: auto; } 24 } 25 @media print { 26 pre > code.sourceCode { white-space: pre-wrap; } 27 pre > code.sourceCode > span { text-indent: -5em; padding-left: 5em; } 28 } 29 pre.numberSource code 30 { counter-reset: source-line 0; } 31 pre.numberSource code > span 32 { position: relative; left: -4em; counter-increment: source-line; } 33 pre.numberSource code > span > a:first-child::before 34 { content: counter(source-line); 35 position: relative; left: -1em; text-align: right; vertical-align: baseline; 36 border: none; display: inline-block; 37 -webkit-touch-callout: none; -webkit-user-select: none; 38 -khtml-user-select: none; -moz-user-select: none; 39 -ms-user-select: none; user-select: none; 40 padding: 0 4px; width: 4em; 41 color: #aaaaaa; 42 } 43 pre.numberSource { margin-left: 3em; border-left: 1px solid #aaaaaa; padding-left: 4px; } 44 div.sourceCode 45 { } 46 @media screen { 47 pre > code.sourceCode > span > a:first-child::before { text-decoration: underline; } 48 } 49 code span.al { color: #ff0000; font-weight: bold; } /* Alert */ 50 code span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */ 51 code span.at { color: #7d9029; } /* Attribute */ 52 code span.bn { color: #40a070; } /* BaseN */ 53 code span.bu { } /* BuiltIn */ 54 code span.cf { color: #007020; font-weight: bold; } /* ControlFlow */ 55 code span.ch { color: #4070a0; } /* Char */ 56 code span.cn { color: #880000; } /* Constant */ 57 code span.co { color: #60a0b0; font-style: italic; } /* Comment */ 58 code span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */ 59 code span.do { color: #ba2121; font-style: italic; } /* Documentation */ 60 code span.dt { color: #902000; } /* DataType */ 61 code span.dv { color: #40a070; } /* DecVal */ 62 code span.er { color: #ff0000; font-weight: bold; } /* Error */ 63 code span.ex { } /* Extension */ 64 code span.fl { color: #40a070; } /* Float */ 65 code span.fu { color: #06287e; } /* Function */ 66 code span.im { } /* Import */ 67 code span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */ 68 code span.kw { color: #007020; font-weight: bold; } /* Keyword */ 69 code span.op { color: #666666; } /* Operator */ 70 code span.ot { color: #007020; } /* Other */ 71 code span.pp { color: #bc7a00; } /* Preprocessor */ 72 code span.sc { color: #4070a0; } /* SpecialChar */ 73 code span.ss { color: #bb6688; } /* SpecialString */ 74 code span.st { color: #4070a0; } /* String */ 75 code span.va { color: #19177c; } /* Variable */ 76 code span.vs { color: #4070a0; } /* VerbatimString */ 77 code span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */ 78 </style> 79 </head> 80 <body> 81 <header id="title-block-header"> 82 <h1 class="title">rclone(1) User Manual</h1> 83 <p class="author">Nick Craig-Wood</p> 84 <p class="date">Mar 10, 2024</p> 85 </header> 86 <h1 id="rclone-syncs-your-files-to-cloud-storage">Rclone syncs your files to cloud storage</h1> 87 <p><img width="50%" src="https://rclone.org/img/logo_on_light__horizontal_color.svg" alt="rclone logo" style="float:right; padding: 5px;" ></p> 88 <ul> 89 <li><a href="#about">About rclone</a></li> 90 <li><a href="#what">What can rclone do for you?</a></li> 91 <li><a href="#features">What features does rclone have?</a></li> 92 <li><a href="#providers">What providers does rclone support?</a></li> 93 <li><a href="https://rclone.org/downloads/">Download</a></li> 94 <li><a href="https://rclone.org/install/">Install</a></li> 95 <li><a href="https://rclone.org/donate/">Donate.</a></li> 96 </ul> 97 <h2 id="about">About rclone</h2> 98 <p>Rclone is a command-line program to manage files on cloud storage. It is a feature-rich alternative to cloud vendors' web storage interfaces. <a href="#providers">Over 70 cloud storage products</a> support rclone including S3 object stores, business & consumer file storage services, as well as standard transfer protocols.</p> 99 <p>Rclone has powerful cloud equivalents to the unix commands rsync, cp, mv, mount, ls, ncdu, tree, rm, and cat. Rclone's familiar syntax includes shell pipeline support, and <code>--dry-run</code> protection. It is used at the command line, in scripts or via its <a href="/rc">API</a>.</p> 100 <p>Users call rclone <em>"The Swiss army knife of cloud storage"</em>, and <em>"Technology indistinguishable from magic"</em>.</p> 101 <p>Rclone really looks after your data. It preserves timestamps and verifies checksums at all times. Transfers over limited bandwidth; intermittent connections, or subject to quota can be restarted, from the last good file transferred. You can <a href="https://rclone.org/commands/rclone_check/">check</a> the integrity of your files. Where possible, rclone employs server-side transfers to minimise local bandwidth use and transfers from one provider to another without using local disk.</p> 102 <p>Virtual backends wrap local and cloud file systems to apply <a href="https://rclone.org/crypt/">encryption</a>, <a href="https://rclone.org/compress/">compression</a>, <a href="https://rclone.org/chunker/">chunking</a>, <a href="https://rclone.org/hasher/">hashing</a> and <a href="https://rclone.org/union/">joining</a>.</p> 103 <p>Rclone <a href="https://rclone.org/commands/rclone_mount/">mounts</a> any local, cloud or virtual filesystem as a disk on Windows, macOS, linux and FreeBSD, and also serves these over <a href="https://rclone.org/commands/rclone_serve_sftp/">SFTP</a>, <a href="https://rclone.org/commands/rclone_serve_http/">HTTP</a>, <a href="https://rclone.org/commands/rclone_serve_webdav/">WebDAV</a>, <a href="https://rclone.org/commands/rclone_serve_ftp/">FTP</a> and <a href="https://rclone.org/commands/rclone_serve_dlna/">DLNA</a>.</p> 104 <p>Rclone is mature, open-source software originally inspired by rsync and written in <a href="https://golang.org">Go</a>. The friendly support community is familiar with varied use cases. Official Ubuntu, Debian, Fedora, Brew and Chocolatey repos. include rclone. For the latest version <a href="https://rclone.org/downloads/">downloading from rclone.org</a> is recommended.</p> 105 <p>Rclone is widely used on Linux, Windows and Mac. Third-party developers create innovative backup, restore, GUI and business process solutions using the rclone command line or API.</p> 106 <p>Rclone does the heavy lifting of communicating with cloud storage.</p> 107 <h2 id="what">What can rclone do for you?</h2> 108 <p>Rclone helps you:</p> 109 <ul> 110 <li>Backup (and encrypt) files to cloud storage</li> 111 <li>Restore (and decrypt) files from cloud storage</li> 112 <li>Mirror cloud data to other cloud services or locally</li> 113 <li>Migrate data to the cloud, or between cloud storage vendors</li> 114 <li>Mount multiple, encrypted, cached or diverse cloud storage as a disk</li> 115 <li>Analyse and account for data held on cloud storage using <a href="https://rclone.org/commands/rclone_lsf/">lsf</a>, <a href="https://rclone.org/commands/rclone_lsjson/">ljson</a>, <a href="https://rclone.org/commands/rclone_size/">size</a>, <a href="https://rclone.org/commands/rclone_ncdu/">ncdu</a></li> 116 <li><a href="https://rclone.org/union/">Union</a> file systems together to present multiple local and/or cloud file systems as one</li> 117 </ul> 118 <h2 id="features">Features</h2> 119 <ul> 120 <li>Transfers 121 <ul> 122 <li>MD5, SHA1 hashes are checked at all times for file integrity</li> 123 <li>Timestamps are preserved on files</li> 124 <li>Operations can be restarted at any time</li> 125 <li>Can be to and from network, e.g. two different cloud providers</li> 126 <li>Can use multi-threaded downloads to local disk</li> 127 </ul></li> 128 <li><a href="https://rclone.org/commands/rclone_copy/">Copy</a> new or changed files to cloud storage</li> 129 <li><a href="https://rclone.org/commands/rclone_sync/">Sync</a> (one way) to make a directory identical</li> 130 <li><a href="https://rclone.org/bisync/">Bisync</a> (two way) to keep two directories in sync bidirectionally</li> 131 <li><a href="https://rclone.org/commands/rclone_move/">Move</a> files to cloud storage deleting the local after verification</li> 132 <li><a href="https://rclone.org/commands/rclone_check/">Check</a> hashes and for missing/extra files</li> 133 <li><a href="https://rclone.org/commands/rclone_mount/">Mount</a> your cloud storage as a network disk</li> 134 <li><a href="https://rclone.org/commands/rclone_serve/">Serve</a> local or remote files over <a href="https://rclone.org/commands/rclone_serve_http/">HTTP</a>/<a href="https://rclone.org/commands/rclone_serve_webdav/">WebDav</a>/<a href="https://rclone.org/commands/rclone_serve_ftp/">FTP</a>/<a href="https://rclone.org/commands/rclone_serve_sftp/">SFTP</a>/<a href="https://rclone.org/commands/rclone_serve_dlna/">DLNA</a></li> 135 <li>Experimental <a href="https://rclone.org/gui/">Web based GUI</a></li> 136 </ul> 137 <h2 id="providers">Supported providers</h2> 138 <p>(There are many others, built on standard protocols such as WebDAV or S3, that work out of the box.)</p> 139 <ul> 140 <li>1Fichier</li> 141 <li>Akamai Netstorage</li> 142 <li>Alibaba Cloud (Aliyun) Object Storage System (OSS)</li> 143 <li>Amazon S3</li> 144 <li>Backblaze B2</li> 145 <li>Box</li> 146 <li>Ceph</li> 147 <li>China Mobile Ecloud Elastic Object Storage (EOS)</li> 148 <li>Arvan Cloud Object Storage (AOS)</li> 149 <li>Citrix ShareFile</li> 150 <li>Cloudflare R2</li> 151 <li>DigitalOcean Spaces</li> 152 <li>Digi Storage</li> 153 <li>Dreamhost</li> 154 <li>Dropbox</li> 155 <li>Enterprise File Fabric</li> 156 <li>Fastmail Files</li> 157 <li>FTP</li> 158 <li>Google Cloud Storage</li> 159 <li>Google Drive</li> 160 <li>Google Photos</li> 161 <li>HDFS</li> 162 <li>Hetzner Storage Box</li> 163 <li>HiDrive</li> 164 <li>HTTP</li> 165 <li>ImageKit</li> 166 <li>Internet Archive</li> 167 <li>Jottacloud</li> 168 <li>IBM COS S3</li> 169 <li>IDrive e2</li> 170 <li>IONOS Cloud</li> 171 <li>Koofr</li> 172 <li>Leviia Object Storage</li> 173 <li>Liara Object Storage</li> 174 <li>Linkbox</li> 175 <li>Linode Object Storage</li> 176 <li>Mail.ru Cloud</li> 177 <li>Memset Memstore</li> 178 <li>Mega</li> 179 <li>Memory</li> 180 <li>Microsoft Azure Blob Storage</li> 181 <li>Microsoft Azure Files Storage</li> 182 <li>Microsoft OneDrive</li> 183 <li>Minio</li> 184 <li>Nextcloud</li> 185 <li>OVH</li> 186 <li>Blomp Cloud Storage</li> 187 <li>OpenDrive</li> 188 <li>OpenStack Swift</li> 189 <li>Oracle Cloud Storage Swift</li> 190 <li>Oracle Object Storage</li> 191 <li>ownCloud</li> 192 <li>pCloud</li> 193 <li>Petabox</li> 194 <li>PikPak</li> 195 <li>premiumize.me</li> 196 <li>put.io</li> 197 <li>Proton Drive</li> 198 <li>QingStor</li> 199 <li>Qiniu Cloud Object Storage (Kodo)</li> 200 <li>Quatrix by Maytech</li> 201 <li>Rackspace Cloud Files</li> 202 <li>rsync.net</li> 203 <li>Scaleway</li> 204 <li>Seafile</li> 205 <li>Seagate Lyve Cloud</li> 206 <li>SeaweedFS</li> 207 <li>SFTP</li> 208 <li>Sia</li> 209 <li>SMB / CIFS</li> 210 <li>StackPath</li> 211 <li>Storj</li> 212 <li>Synology</li> 213 <li>SugarSync</li> 214 <li>Tencent Cloud Object Storage (COS)</li> 215 <li>Uptobox</li> 216 <li>Wasabi</li> 217 <li>WebDAV</li> 218 <li>Yandex Disk</li> 219 <li>Zoho WorkDrive</li> 220 <li>The local filesystem</li> 221 </ul> 222 <h2 id="virtual-providers">Virtual providers</h2> 223 <p>These backends adapt or modify other storage providers:</p> 224 <ul> 225 <li>Alias: Rename existing remotes</li> 226 <li>Cache: Cache remotes (DEPRECATED)</li> 227 <li>Chunker: Split large files</li> 228 <li>Combine: Combine multiple remotes into a directory tree</li> 229 <li>Compress: Compress files</li> 230 <li>Crypt: Encrypt files</li> 231 <li>Hasher: Hash files</li> 232 <li>Union: Join multiple remotes to work together</li> 233 </ul> 234 <h2 id="links">Links</h2> 235 <ul> 236 <li><a href="https://rclone.org/">Home page</a></li> 237 <li><a href="https://github.com/rclone/rclone">GitHub project page for source and bug tracker</a></li> 238 <li><a href="https://forum.rclone.org">Rclone Forum</a></li> 239 <li><a href="https://rclone.org/downloads/">Downloads</a></li> 240 </ul> 241 <h1 id="install">Install</h1> 242 <p>Rclone is a Go program and comes as a single binary file.</p> 243 <h2 id="quickstart">Quickstart</h2> 244 <ul> 245 <li><a href="https://rclone.org/downloads/">Download</a> the relevant binary.</li> 246 <li>Extract the <code>rclone</code> executable, <code>rclone.exe</code> on Windows, from the archive.</li> 247 <li>Run <code>rclone config</code> to setup. See <a href="https://rclone.org/docs/">rclone config docs</a> for more details.</li> 248 <li>Optionally configure <a href="#autostart">automatic execution</a>.</li> 249 </ul> 250 <p>See below for some expanded Linux / macOS / Windows instructions.</p> 251 <p>See the <a href="https://rclone.org/docs/">usage</a> docs for how to use rclone, or run <code>rclone -h</code>.</p> 252 <p>Already installed rclone can be easily updated to the latest version using the <a href="https://rclone.org/commands/rclone_selfupdate/">rclone selfupdate</a> command.</p> 253 <p>See <a href="https://rclone.org/release_signing/">the release signing docs</a> for how to verify signatures on the release.</p> 254 <h2 id="script-installation">Script installation</h2> 255 <p>To install rclone on Linux/macOS/BSD systems, run:</p> 256 <pre><code>sudo -v ; curl https://rclone.org/install.sh | sudo bash</code></pre> 257 <p>For beta installation, run:</p> 258 <pre><code>sudo -v ; curl https://rclone.org/install.sh | sudo bash -s beta</code></pre> 259 <p>Note that this script checks the version of rclone installed first and won't re-download if not needed.</p> 260 <h2 id="linux">Linux installation</h2> 261 <h3 id="linux-precompiled">Precompiled binary</h3> 262 <p>Fetch and unpack</p> 263 <pre><code>curl -O https://downloads.rclone.org/rclone-current-linux-amd64.zip 264 unzip rclone-current-linux-amd64.zip 265 cd rclone-*-linux-amd64</code></pre> 266 <p>Copy binary file</p> 267 <pre><code>sudo cp rclone /usr/bin/ 268 sudo chown root:root /usr/bin/rclone 269 sudo chmod 755 /usr/bin/rclone</code></pre> 270 <p>Install manpage</p> 271 <pre><code>sudo mkdir -p /usr/local/share/man/man1 272 sudo cp rclone.1 /usr/local/share/man/man1/ 273 sudo mandb</code></pre> 274 <p>Run <code>rclone config</code> to setup. See <a href="https://rclone.org/docs/">rclone config docs</a> for more details.</p> 275 <pre><code>rclone config</code></pre> 276 <h2 id="macos">macOS installation</h2> 277 <h3 id="macos-brew">Installation with brew</h3> 278 <pre><code>brew install rclone</code></pre> 279 <p>NOTE: This version of rclone will not support <code>mount</code> any more (see <a href="https://github.com/rclone/rclone/issues/5373">#5373</a>). If mounting is wanted on macOS, either install a precompiled binary or enable the relevant option when <a href="#install-from-source">installing from source</a>.</p> 280 <p>Note that this is a third party installer not controlled by the rclone developers so it may be out of date. Its current version is as below.</p> 281 <p><a href="https://repology.org/project/rclone/versions"><img src="https://repology.org/badge/version-for-repo/homebrew/rclone.svg" alt="Homebrew package" /></a></p> 282 <h3 id="installation-with-macports-macos-macports">Installation with MacPorts (#macos-macports)</h3> 283 <p>On macOS, rclone can also be installed via <a href="https://www.macports.org">MacPorts</a>:</p> 284 <pre><code>sudo port install rclone</code></pre> 285 <p>Note that this is a third party installer not controlled by the rclone developers so it may be out of date. Its current version is as below.</p> 286 <p><a href="https://repology.org/project/rclone/versions"><img src="https://repology.org/badge/version-for-repo/macports/rclone.svg" alt="MacPorts port" /></a></p> 287 <p>More information <a href="https://ports.macports.org/port/rclone/">here</a>.</p> 288 <h3 id="macos-precompiled">Precompiled binary, using curl</h3> 289 <p>To avoid problems with macOS gatekeeper enforcing the binary to be signed and notarized it is enough to download with <code>curl</code>.</p> 290 <p>Download the latest version of rclone.</p> 291 <pre><code>cd && curl -O https://downloads.rclone.org/rclone-current-osx-amd64.zip</code></pre> 292 <p>Unzip the download and cd to the extracted folder.</p> 293 <pre><code>unzip -a rclone-current-osx-amd64.zip && cd rclone-*-osx-amd64</code></pre> 294 <p>Move rclone to your $PATH. You will be prompted for your password.</p> 295 <pre><code>sudo mkdir -p /usr/local/bin 296 sudo mv rclone /usr/local/bin/</code></pre> 297 <p>(the <code>mkdir</code> command is safe to run, even if the directory already exists).</p> 298 <p>Remove the leftover files.</p> 299 <pre><code>cd .. && rm -rf rclone-*-osx-amd64 rclone-current-osx-amd64.zip</code></pre> 300 <p>Run <code>rclone config</code> to setup. See <a href="https://rclone.org/docs/">rclone config docs</a> for more details.</p> 301 <pre><code>rclone config</code></pre> 302 <h3 id="macos-precompiled-web">Precompiled binary, using a web browser</h3> 303 <p>When downloading a binary with a web browser, the browser will set the macOS gatekeeper quarantine attribute. Starting from Catalina, when attempting to run <code>rclone</code>, a pop-up will appear saying:</p> 304 <pre><code>"rclone" cannot be opened because the developer cannot be verified. 305 macOS cannot verify that this app is free from malware.</code></pre> 306 <p>The simplest fix is to run</p> 307 <pre><code>xattr -d com.apple.quarantine rclone</code></pre> 308 <h2 id="windows">Windows installation</h2> 309 <h3 id="windows-precompiled">Precompiled binary</h3> 310 <p>Fetch the correct binary for your processor type by clicking on these links. If not sure, use the first link.</p> 311 <ul> 312 <li><a href="https://downloads.rclone.org/rclone-current-windows-amd64.zip">Intel/AMD - 64 Bit</a></li> 313 <li><a href="https://downloads.rclone.org/rclone-current-windows-386.zip">Intel/AMD - 32 Bit</a></li> 314 <li><a href="https://downloads.rclone.org/rclone-current-windows-arm64.zip">ARM - 64 Bit</a></li> 315 </ul> 316 <p>Open this file in the Explorer and extract <code>rclone.exe</code>. Rclone is a portable executable so you can place it wherever is convenient.</p> 317 <p>Open a CMD window (or powershell) and run the binary. Note that rclone does not launch a GUI by default, it runs in the CMD Window.</p> 318 <ul> 319 <li>Run <code>rclone.exe config</code> to setup. See <a href="https://rclone.org/docs/">rclone config docs</a> for more details.</li> 320 <li>Optionally configure <a href="#autostart">automatic execution</a>.</li> 321 </ul> 322 <p>If you are planning to use the <a href="https://rclone.org/commands/rclone_mount/">rclone mount</a> feature then you will need to install the third party utility <a href="https://winfsp.dev/">WinFsp</a> also.</p> 323 <h3 id="windows-chocolatey">Windows package manager (Winget)</h3> 324 <p><a href="https://learn.microsoft.com/en-us/windows/package-manager/">Winget</a> comes pre-installed with the latest versions of Windows. If not, update the <a href="https://www.microsoft.com/p/app-installer/9nblggh4nns1">App Installer</a> package from the Microsoft store.</p> 325 <p>To install rclone</p> 326 <pre><code>winget install Rclone.Rclone</code></pre> 327 <p>To uninstall rclone</p> 328 <pre><code>winget uninstall Rclone.Rclone --force</code></pre> 329 <h3 id="windows-chocolatey">Chocolatey package manager</h3> 330 <p>Make sure you have <a href="https://chocolatey.org/">Choco</a> installed</p> 331 <pre><code>choco search rclone 332 choco install rclone</code></pre> 333 <p>This will install rclone on your Windows machine. If you are planning to use <a href="https://rclone.org/commands/rclone_mount/">rclone mount</a> then</p> 334 <pre><code>choco install winfsp</code></pre> 335 <p>will install that too.</p> 336 <p>Note that this is a third party installer not controlled by the rclone developers so it may be out of date. Its current version is as below.</p> 337 <p><a href="https://repology.org/project/rclone/versions"><img src="https://repology.org/badge/version-for-repo/chocolatey/rclone.svg" alt="Chocolatey package" /></a></p> 338 <h3 id="windows-scoop">Scoop package manager</h3> 339 <p>Make sure you have <a href="https://scoop.sh/">Scoop</a> installed</p> 340 <pre><code>scoop install rclone</code></pre> 341 <p>Note that this is a third party installer not controlled by the rclone developers so it may be out of date. Its current version is as below.</p> 342 <p><a href="https://repology.org/project/rclone/versions"><img src="https://repology.org/badge/version-for-repo/scoop/rclone.svg" alt="Scoop package" /></a></p> 343 <h2 id="package-manager">Package manager installation</h2> 344 <p>Many Linux, Windows, macOS and other OS distributions package and distribute rclone.</p> 345 <p>The distributed versions of rclone are often quite out of date and for this reason we recommend one of the other installation methods if possible.</p> 346 <p>You can get an idea of how up to date or not your OS distribution's package is here.</p> 347 <p><a href="https://repology.org/project/rclone/versions"><img src="https://repology.org/badge/vertical-allrepos/rclone.svg?columns=3" alt="Packaging status" /></a></p> 348 <h2 id="docker">Docker installation</h2> 349 <p>The rclone developers maintain a <a href="https://hub.docker.com/r/rclone/rclone">docker image for rclone</a>.</p> 350 <p>These images are built as part of the release process based on a minimal Alpine Linux.</p> 351 <p>The <code>:latest</code> tag will always point to the latest stable release. You can use the <code>:beta</code> tag to get the latest build from master. You can also use version tags, e.g. <code>:1.49.1</code>, <code>:1.49</code> or <code>:1</code>.</p> 352 <pre><code>$ docker pull rclone/rclone:latest 353 latest: Pulling from rclone/rclone 354 Digest: sha256:0e0ced72671989bb837fea8e88578b3fc48371aa45d209663683e24cfdaa0e11 355 ... 356 $ docker run --rm rclone/rclone:latest version 357 rclone v1.49.1 358 - os/arch: linux/amd64 359 - go version: go1.12.9</code></pre> 360 <p>There are a few command line options to consider when starting an rclone Docker container from the rclone image.</p> 361 <ul> 362 <li><p>You need to mount the host rclone config dir at <code>/config/rclone</code> into the Docker container. Due to the fact that rclone updates tokens inside its config file, and that the update process involves a file rename, you need to mount the whole host rclone config dir, not just the single host rclone config file.</p></li> 363 <li><p>You need to mount a host data dir at <code>/data</code> into the Docker container.</p></li> 364 <li><p>By default, the rclone binary inside a Docker container runs with UID=0 (root). As a result, all files created in a run will have UID=0. If your config and data files reside on the host with a non-root UID:GID, you need to pass these on the container start command line.</p></li> 365 <li><p>If you want to access the RC interface (either via the API or the Web UI), it is required to set the <code>--rc-addr</code> to <code>:5572</code> in order to connect to it from outside the container. An explanation about why this is necessary is present <a href="https://web.archive.org/web/20200808071950/https://pythonspeed.com/articles/docker-connection-refused/">here</a>.</p> 366 <ul> 367 <li>NOTE: Users running this container with the docker network set to <code>host</code> should probably set it to listen to localhost only, with <code>127.0.0.1:5572</code> as the value for <code>--rc-addr</code></li> 368 </ul></li> 369 <li><p>It is possible to use <code>rclone mount</code> inside a userspace Docker container, and expose the resulting fuse mount to the host. The exact <code>docker run</code> options to do that might vary slightly between hosts. See, e.g. the discussion in this <a href="https://github.com/moby/moby/issues/9448">thread</a>.</p> 370 <p>You also need to mount the host <code>/etc/passwd</code> and <code>/etc/group</code> for fuse to work inside the container.</p></li> 371 </ul> 372 <p>Here are some commands tested on an Ubuntu 18.04.3 host:</p> 373 <pre><code># config on host at ~/.config/rclone/rclone.conf 374 # data on host at ~/data 375 376 # add a remote interactively 377 docker run --rm -it \ 378 --volume ~/.config/rclone:/config/rclone \ 379 --user $(id -u):$(id -g) \ 380 rclone/rclone \ 381 config 382 383 # make sure the config is ok by listing the remotes 384 docker run --rm \ 385 --volume ~/.config/rclone:/config/rclone \ 386 --user $(id -u):$(id -g) \ 387 rclone/rclone \ 388 listremotes 389 390 # perform mount inside Docker container, expose result to host 391 mkdir -p ~/data/mount 392 docker run --rm \ 393 --volume ~/.config/rclone:/config/rclone \ 394 --volume ~/data:/data:shared \ 395 --user $(id -u):$(id -g) \ 396 --volume /etc/passwd:/etc/passwd:ro --volume /etc/group:/etc/group:ro \ 397 --device /dev/fuse --cap-add SYS_ADMIN --security-opt apparmor:unconfined \ 398 rclone/rclone \ 399 mount dropbox:Photos /data/mount & 400 ls ~/data/mount 401 kill %1</code></pre> 402 <h2 id="snap">Snap installation</h2> 403 <p><a href="https://snapcraft.io/rclone"><img src="https://snapcraft.io/static/images/badges/en/snap-store-black.svg" alt="Get it from the Snap Store" /></a></p> 404 <p>Make sure you have <a href="https://snapcraft.io/docs/installing-snapd">Snapd installed</a></p> 405 <div class="sourceCode" id="cb23"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb23-1"><a href="#cb23-1" aria-hidden="true"></a>$ <span class="fu">sudo</span> snap install rclone</span></code></pre></div> 406 <p>Due to the strict confinement of Snap, rclone snap cannot access real /home/$USER/.config/rclone directory, default config path is as below.</p> 407 <ul> 408 <li>Default config directory: 409 <ul> 410 <li>/home/$USER/snap/rclone/current/.config/rclone</li> 411 </ul></li> 412 </ul> 413 <p>Note: Due to the strict confinement of Snap, <code>rclone mount</code> feature is <code>not</code> supported.</p> 414 <p>If mounting is wanted, either install a precompiled binary or enable the relevant option when <a href="#source">installing from source</a>.</p> 415 <p>Note that this is controlled by <a href="https://github.com/boukendesho/rclone-snap">community maintainer</a> not the rclone developers so it may be out of date. Its current version is as below.</p> 416 <p><a href="https://snapcraft.io/rclone"><img src="https://snapcraft.io/rclone/badge.svg" alt="rclone" /></a></p> 417 <h2 id="source">Source installation</h2> 418 <p>Make sure you have git and <a href="https://golang.org/">Go</a> installed. Go version 1.18 or newer is required, the latest release is recommended. You can get it from your package manager, or download it from <a href="https://golang.org/dl/">golang.org/dl</a>. Then you can run the following:</p> 419 <pre><code>git clone https://github.com/rclone/rclone.git 420 cd rclone 421 go build</code></pre> 422 <p>This will check out the rclone source in subfolder rclone, which you can later modify and send pull requests with. Then it will build the rclone executable in the same folder. As an initial check you can now run <code>./rclone version</code> (<code>.\rclone version</code> on Windows).</p> 423 <p>Note that on macOS and Windows the <a href="https://rclone.org/commands/rclone_mount/">mount</a> command will not be available unless you specify an additional build tag <code>cmount</code>.</p> 424 <pre><code>go build -tags cmount</code></pre> 425 <p>This assumes you have a GCC compatible C compiler (GCC or Clang) in your PATH, as it uses <a href="https://pkg.go.dev/cmd/cgo">cgo</a>. But on Windows, the <a href="https://github.com/winfsp/cgofuse">cgofuse</a> library that the cmount implementation is based on, also supports building <a href="https://github.com/golang/go/wiki/WindowsDLLs">without cgo</a>, i.e. by setting environment variable CGO_ENABLED to value 0 (static linking). This is how the official Windows release of rclone is being built, starting with version 1.59. It is still possible to build with cgo on Windows as well, by using the MinGW port of GCC, e.g. by installing it in a <a href="https://www.msys2.org">MSYS2</a> distribution (make sure you install it in the classic mingw64 subsystem, the ucrt64 version is not compatible).</p> 426 <p>Additionally, to build with mount on Windows, you must install the third party utility <a href="https://winfsp.dev/">WinFsp</a>, with the "Developer" feature selected. If building with cgo, you must also set environment variable CPATH pointing to the fuse include directory within the WinFsp installation (normally <code>C:\Program Files (x86)\WinFsp\inc\fuse</code>).</p> 427 <p>You may add arguments <code>-ldflags -s</code> to omit symbol table and debug information, making the executable file smaller, and <code>-trimpath</code> to remove references to local file system paths. The official rclone releases are built with both of these.</p> 428 <pre><code>go build -trimpath -ldflags -s -tags cmount</code></pre> 429 <p>If you want to customize the version string, as reported by the <code>rclone version</code> command, you can set one of the variables <code>fs.Version</code>, <code>fs.VersionTag</code> (to keep default suffix but customize the number), or <code>fs.VersionSuffix</code> (to keep default number but customize the suffix). This can be done from the build command, by adding to the <code>-ldflags</code> argument value as shown below.</p> 430 <pre><code>go build -trimpath -ldflags "-s -X github.com/rclone/rclone/fs.Version=v9.9.9-test" -tags cmount</code></pre> 431 <p>On Windows, the official executables also have the version information, as well as a file icon, embedded as binary resources. To get that with your own build you need to run the following command <strong>before</strong> the build command. It generates a Windows resource system object file, with extension .syso, e.g. <code>resource_windows_amd64.syso</code>, that will be automatically picked up by future build commands.</p> 432 <pre><code>go run bin/resource_windows.go</code></pre> 433 <p>The above command will generate a resource file containing version information based on the fs.Version variable in source at the time you run the command, which means if the value of this variable changes you need to re-run the command for it to be reflected in the version information. Also, if you override this version variable in the build command as described above, you need to do that also when generating the resource file, or else it will still use the value from the source.</p> 434 <pre><code>go run bin/resource_windows.go -version v9.9.9-test</code></pre> 435 <p>Instead of executing the <code>go build</code> command directly, you can run it via the Makefile. The default target changes the version suffix from "-DEV" to "-beta" followed by additional commit details, embeds version information binary resources on Windows, and copies the resulting rclone executable into your GOPATH bin folder (<code>$(go env GOPATH)/bin</code>, which corresponds to <code>~/go/bin/rclone</code> by default).</p> 436 <pre><code>make</code></pre> 437 <p>To include mount command on macOS and Windows with Makefile build:</p> 438 <pre><code>make GOTAGS=cmount</code></pre> 439 <p>There are other make targets that can be used for more advanced builds, such as cross-compiling for all supported os/architectures, and packaging results into release artifacts. See <a href="https://github.com/rclone/rclone/blob/master/Makefile">Makefile</a> and <a href="https://github.com/rclone/rclone/blob/master/bin/cross-compile.go">cross-compile.go</a> for details.</p> 440 <p>Another alternative method for source installation is to download the source, build and install rclone - all in one operation, as a regular Go package. The source will be stored it in the Go module cache, and the resulting executable will be in your GOPATH bin folder (<code>$(go env GOPATH)/bin</code>, which corresponds to <code>~/go/bin/rclone</code> by default).</p> 441 <pre><code>go install github.com/rclone/rclone@latest</code></pre> 442 <h2 id="ansible">Ansible installation</h2> 443 <p>This can be done with <a href="https://github.com/stefangweichinger/ansible-rclone">Stefan Weichinger's ansible role</a>.</p> 444 <p>Instructions</p> 445 <ol type="1"> 446 <li><code>git clone https://github.com/stefangweichinger/ansible-rclone.git</code> into your local roles-directory</li> 447 <li>add the role to the hosts you want rclone installed to:</li> 448 </ol> 449 <pre><code> - hosts: rclone-hosts 450 roles: 451 - rclone</code></pre> 452 <h2 id="portable">Portable installation</h2> 453 <p>As mentioned <a href="https://rclone.org/install/#quickstart">above</a>, rclone is single executable (<code>rclone</code>, or <code>rclone.exe</code> on Windows) that you can download as a zip archive and extract into a location of your choosing. When executing different commands, it may create files in different locations, such as a configuration file and various temporary files. By default the locations for these are according to your operating system, e.g. configuration file in your user profile directory and temporary files in the standard temporary directory, but you can customize all of them, e.g. to make a completely self-contained, portable installation.</p> 454 <p>Run the <a href="https://rclone.org/commands/rclone_config_paths/">config paths</a> command to see the locations that rclone will use.</p> 455 <p>To override them set the corresponding options (as command-line arguments, or as <a href="https://rclone.org/docs/#environment-variables">environment variables</a>): - <a href="https://rclone.org/docs/#config-config-file">--config</a> - <a href="https://rclone.org/docs/#cache-dir-dir">--cache-dir</a> - <a href="https://rclone.org/docs/#temp-dir-dir">--temp-dir</a></p> 456 <h2 id="autostart">Autostart</h2> 457 <p>After installing and configuring rclone, as described above, you are ready to use rclone as an interactive command line utility. If your goal is to perform <em>periodic</em> operations, such as a regular <a href="https://rclone.org/commands/rclone_sync/">sync</a>, you will probably want to configure your rclone command in your operating system's scheduler. If you need to expose <em>service</em>-like features, such as <a href="https://rclone.org/rc/">remote control</a>, <a href="https://rclone.org/gui/">GUI</a>, <a href="https://rclone.org/commands/rclone_serve/">serve</a> or <a href="https://rclone.org/commands/rclone_mount/">mount</a>, you will often want an rclone command always running in the background, and configuring it to run in a service infrastructure may be a better option. Below are some alternatives on how to achieve this on different operating systems.</p> 458 <p>NOTE: Before setting up autorun it is highly recommended that you have tested your command manually from a Command Prompt first.</p> 459 <h3 id="autostart-on-windows">Autostart on Windows</h3> 460 <p>The most relevant alternatives for autostart on Windows are: - Run at user log on using the Startup folder - Run at user log on, at system startup or at schedule using Task Scheduler - Run at system startup using Windows service</p> 461 <h4 id="running-in-background">Running in background</h4> 462 <p>Rclone is a console application, so if not starting from an existing Command Prompt, e.g. when starting rclone.exe from a shortcut, it will open a Command Prompt window. When configuring rclone to run from task scheduler and windows service you are able to set it to run hidden in background. From rclone version 1.54 you can also make it run hidden from anywhere by adding option <code>--no-console</code> (it may still flash briefly when the program starts). Since rclone normally writes information and any error messages to the console, you must redirect this to a file to be able to see it. Rclone has a built-in option <code>--log-file</code> for that.</p> 463 <p>Example command to run a sync in background:</p> 464 <pre><code>c:\rclone\rclone.exe sync c:\files remote:/files --no-console --log-file c:\rclone\logs\sync_files.txt</code></pre> 465 <h4 id="user-account">User account</h4> 466 <p>As mentioned in the <a href="https://rclone.org/commands/rclone_mount/">mount</a> documentation, mounted drives created as Administrator are not visible to other accounts, not even the account that was elevated as Administrator. By running the mount command as the built-in <code>SYSTEM</code> user account, it will create drives accessible for everyone on the system. Both scheduled task and Windows service can be used to achieve this.</p> 467 <p>NOTE: Remember that when rclone runs as the <code>SYSTEM</code> user, the user profile that it sees will not be yours. This means that if you normally run rclone with configuration file in the default location, to be able to use the same configuration when running as the system user you must explicitly tell rclone where to find it with the <a href="https://rclone.org/docs/#config-config-file"><code>--config</code></a> option, or else it will look in the system users profile path (<code>C:\Windows\System32\config\systemprofile</code>). To test your command manually from a Command Prompt, you can run it with the <a href="https://docs.microsoft.com/en-us/sysinternals/downloads/psexec">PsExec</a> utility from Microsoft's Sysinternals suite, which takes option <code>-s</code> to execute commands as the <code>SYSTEM</code> user.</p> 468 <h4 id="start-from-startup-folder">Start from Startup folder</h4> 469 <p>To quickly execute an rclone command you can simply create a standard Windows Explorer shortcut for the complete rclone command you want to run. If you store this shortcut in the special "Startup" start-menu folder, Windows will automatically run it at login. To open this folder in Windows Explorer, enter path <code>%APPDATA%\Microsoft\Windows\Start Menu\Programs\Startup</code>, or <code>C:\ProgramData\Microsoft\Windows\Start Menu\Programs\StartUp</code> if you want the command to start for <em>every</em> user that logs in.</p> 470 <p>This is the easiest approach to autostarting of rclone, but it offers no functionality to set it to run as different user, or to set conditions or actions on certain events. Setting up a scheduled task as described below will often give you better results.</p> 471 <h4 id="start-from-task-scheduler">Start from Task Scheduler</h4> 472 <p>Task Scheduler is an administrative tool built into Windows, and it can be used to configure rclone to be started automatically in a highly configurable way, e.g. periodically on a schedule, on user log on, or at system startup. It can run be configured to run as the current user, or for a mount command that needs to be available to all users it can run as the <code>SYSTEM</code> user. For technical information, see https://docs.microsoft.com/windows/win32/taskschd/task-scheduler-start-page.</p> 473 <h4 id="run-as-service">Run as service</h4> 474 <p>For running rclone at system startup, you can create a Windows service that executes your rclone command, as an alternative to scheduled task configured to run at startup.</p> 475 <h5 id="mount-command-built-in-service-integration">Mount command built-in service integration</h5> 476 <p>For mount commands, rclone has a built-in Windows service integration via the third-party WinFsp library it uses. Registering as a regular Windows service easy, as you just have to execute the built-in PowerShell command <code>New-Service</code> (requires administrative privileges).</p> 477 <p>Example of a PowerShell command that creates a Windows service for mounting some <code>remote:/files</code> as drive letter <code>X:</code>, for <em>all</em> users (service will be running as the local system account):</p> 478 <pre><code>New-Service -Name Rclone -BinaryPathName 'c:\rclone\rclone.exe mount remote:/files X: --config c:\rclone\config\rclone.conf --log-file c:\rclone\logs\mount.txt'</code></pre> 479 <p>The <a href="https://github.com/billziss-gh/winfsp/wiki/WinFsp-Service-Architecture">WinFsp service infrastructure</a> supports incorporating services for file system implementations, such as rclone, into its own launcher service, as kind of "child services". This has the additional advantage that it also implements a network provider that integrates into Windows standard methods for managing network drives. This is currently not officially supported by Rclone, but with WinFsp version 2019.3 B2 / v1.5B2 or later it should be possible through path rewriting as described <a href="https://github.com/rclone/rclone/issues/3340">here</a>.</p> 480 <h5 id="third-party-service-integration">Third-party service integration</h5> 481 <p>To Windows service running any rclone command, the excellent third-party utility <a href="http://nssm.cc">NSSM</a>, the "Non-Sucking Service Manager", can be used. It includes some advanced features such as adjusting process priority, defining process environment variables, redirect to file anything written to stdout, and customized response to different exit codes, with a GUI to configure everything from (although it can also be used from command line ).</p> 482 <p>There are also several other alternatives. To mention one more, <a href="https://github.com/winsw/winsw">WinSW</a>, "Windows Service Wrapper", is worth checking out. It requires .NET Framework, but it is preinstalled on newer versions of Windows, and it also provides alternative standalone distributions which includes necessary runtime (.NET 5). WinSW is a command-line only utility, where you have to manually create an XML file with service configuration. This may be a drawback for some, but it can also be an advantage as it is easy to back up and reuse the configuration settings, without having go through manual steps in a GUI. One thing to note is that by default it does not restart the service on error, one have to explicit enable this in the configuration file (via the "onfailure" parameter).</p> 483 <h3 id="autostart-on-linux">Autostart on Linux</h3> 484 <h4 id="start-as-a-service">Start as a service</h4> 485 <p>To always run rclone in background, relevant for mount commands etc, you can use systemd to set up rclone as a system or user service. Running as a system service ensures that it is run at startup even if the user it is running as has no active session. Running rclone as a user service ensures that it only starts after the configured user has logged into the system.</p> 486 <h4 id="run-periodically-from-cron">Run periodically from cron</h4> 487 <p>To run a periodic command, such as a copy/sync, you can set up a cron job.</p> 488 <h1 id="usage">Usage</h1> 489 <p>Rclone is a command line program to manage files on cloud storage. After <a href="https://rclone.org/downloads/">download</a> and <a href="/install">install</a>, continue here to learn how to use it: Initial <a href="#configure">configuration</a>, what the <a href="#basic-syntax">basic syntax</a> looks like, describes the various <a href="#subcommands">subcommands</a>, the various <a href="#options">options</a>, and more.</p> 490 <h2 id="configure">Configure</h2> 491 <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 <a href="#config-config-file"><code>--config</code></a> entry for how to find the config file and choose its location.)</p> 492 <p>The easiest way to make the config is to run rclone with the config option:</p> 493 <pre><code>rclone config</code></pre> 494 <p>See the following for detailed instructions for</p> 495 <ul> 496 <li><a href="https://rclone.org/fichier/">1Fichier</a></li> 497 <li><a href="https://rclone.org/netstorage/">Akamai Netstorage</a></li> 498 <li><a href="https://rclone.org/alias/">Alias</a></li> 499 <li><a href="https://rclone.org/s3/">Amazon S3</a></li> 500 <li><a href="https://rclone.org/b2/">Backblaze B2</a></li> 501 <li><a href="https://rclone.org/box/">Box</a></li> 502 <li><a href="https://rclone.org/chunker/">Chunker</a> - transparently splits large files for other remotes</li> 503 <li><a href="https://rclone.org/sharefile/">Citrix ShareFile</a></li> 504 <li><a href="https://rclone.org/compress/">Compress</a></li> 505 <li><a href="https://rclone.org/combine/">Combine</a></li> 506 <li><a href="https://rclone.org/crypt/">Crypt</a> - to encrypt other remotes</li> 507 <li><a href="https://rclone.org/s3/#digitalocean-spaces">DigitalOcean Spaces</a></li> 508 <li><a href="https://rclone.org/koofr/#digi-storage">Digi Storage</a></li> 509 <li><a href="https://rclone.org/dropbox/">Dropbox</a></li> 510 <li><a href="https://rclone.org/filefabric/">Enterprise File Fabric</a></li> 511 <li><a href="https://rclone.org/ftp/">FTP</a></li> 512 <li><a href="https://rclone.org/googlecloudstorage/">Google Cloud Storage</a></li> 513 <li><a href="https://rclone.org/drive/">Google Drive</a></li> 514 <li><a href="https://rclone.org/googlephotos/">Google Photos</a></li> 515 <li><a href="https://rclone.org/hasher/">Hasher</a> - to handle checksums for other remotes</li> 516 <li><a href="https://rclone.org/hdfs/">HDFS</a></li> 517 <li><a href="https://rclone.org/hidrive/">HiDrive</a></li> 518 <li><a href="https://rclone.org/http/">HTTP</a></li> 519 <li><a href="https://rclone.org/internetarchive/">Internet Archive</a></li> 520 <li><a href="https://rclone.org/jottacloud/">Jottacloud</a></li> 521 <li><a href="https://rclone.org/koofr/">Koofr</a></li> 522 <li><a href="https://rclone.org/linkbox/">Linkbox</a></li> 523 <li><a href="https://rclone.org/mailru/">Mail.ru Cloud</a></li> 524 <li><a href="https://rclone.org/mega/">Mega</a></li> 525 <li><a href="https://rclone.org/memory/">Memory</a></li> 526 <li><a href="https://rclone.org/azureblob/">Microsoft Azure Blob Storage</a></li> 527 <li><a href="https://rclone.org/azurefiles/">Microsoft Azure Files Storage</a></li> 528 <li><a href="https://rclone.org/onedrive/">Microsoft OneDrive</a></li> 529 <li><a href="https://rclone.org/swift/">OpenStack Swift / Rackspace Cloudfiles / Blomp Cloud Storage / Memset Memstore</a></li> 530 <li><a href="https://rclone.org/opendrive/">OpenDrive</a></li> 531 <li><a href="https://rclone.org/oracleobjectstorage/">Oracle Object Storage</a></li> 532 <li><a href="https://rclone.org/pcloud/">Pcloud</a></li> 533 <li><a href="https://rclone.org/pikpak/">PikPak</a></li> 534 <li><a href="https://rclone.org/premiumizeme/">premiumize.me</a></li> 535 <li><a href="https://rclone.org/putio/">put.io</a></li> 536 <li><a href="https://rclone.org/protondrive/">Proton Drive</a></li> 537 <li><a href="https://rclone.org/qingstor/">QingStor</a></li> 538 <li><a href="https://rclone.org/quatrix/">Quatrix by Maytech</a></li> 539 <li><a href="https://rclone.org/seafile/">Seafile</a></li> 540 <li><a href="https://rclone.org/sftp/">SFTP</a></li> 541 <li><a href="https://rclone.org/sia/">Sia</a></li> 542 <li><a href="https://rclone.org/smb/">SMB</a></li> 543 <li><a href="https://rclone.org/storj/">Storj</a></li> 544 <li><a href="https://rclone.org/sugarsync/">SugarSync</a></li> 545 <li><a href="https://rclone.org/union/">Union</a></li> 546 <li><a href="https://rclone.org/uptobox/">Uptobox</a></li> 547 <li><a href="https://rclone.org/webdav/">WebDAV</a></li> 548 <li><a href="https://rclone.org/yandex/">Yandex Disk</a></li> 549 <li><a href="https://rclone.org/zoho/">Zoho WorkDrive</a></li> 550 <li><a href="https://rclone.org/local/">The local filesystem</a></li> 551 </ul> 552 <h2 id="basic-syntax">Basic syntax</h2> 553 <p>Rclone syncs a directory tree from one storage system to another.</p> 554 <p>Its syntax is like this</p> 555 <pre><code>Syntax: [options] subcommand <parameters> <parameters...></code></pre> 556 <p>Source and destination paths are specified by the name you gave the storage system in the config file then the sub path, e.g. "drive:myfolder" to look at "myfolder" in Google drive.</p> 557 <p>You can define as many storage paths as you like in the config file.</p> 558 <p>Please use the <a href="#interactive"><code>--interactive</code>/<code>-i</code></a> flag while learning rclone to avoid accidental data loss.</p> 559 <h2 id="subcommands">Subcommands</h2> 560 <p>rclone uses a system of subcommands. For example</p> 561 <pre><code>rclone ls remote:path # lists a remote 562 rclone copy /local/path remote:path # copies /local/path to the remote 563 rclone sync --interactive /local/path remote:path # syncs /local/path to the remote</code></pre> 564 <h1 id="rclone-config">rclone config</h1> 565 <p>Enter an interactive configuration session.</p> 566 <h2 id="synopsis">Synopsis</h2> 567 <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> 568 <pre><code>rclone config [flags]</code></pre> 569 <h2 id="options">Options</h2> 570 <pre><code> -h, --help help for config</code></pre> 571 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 572 <h1 id="see-also">SEE ALSO</h1> 573 <ul> 574 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 575 <li><a href="https://rclone.org/commands/rclone_config_create/">rclone config create</a> - Create a new remote with name, type and options.</li> 576 <li><a href="https://rclone.org/commands/rclone_config_delete/">rclone config delete</a> - Delete an existing remote.</li> 577 <li><a href="https://rclone.org/commands/rclone_config_disconnect/">rclone config disconnect</a> - Disconnects user from remote</li> 578 <li><a href="https://rclone.org/commands/rclone_config_dump/">rclone config dump</a> - Dump the config file as JSON.</li> 579 <li><a href="https://rclone.org/commands/rclone_config_edit/">rclone config edit</a> - Enter an interactive configuration session.</li> 580 <li><a href="https://rclone.org/commands/rclone_config_file/">rclone config file</a> - Show path of configuration file in use.</li> 581 <li><a href="https://rclone.org/commands/rclone_config_password/">rclone config password</a> - Update password in an existing remote.</li> 582 <li><a href="https://rclone.org/commands/rclone_config_paths/">rclone config paths</a> - Show paths used for configuration, cache, temp etc.</li> 583 <li><a href="https://rclone.org/commands/rclone_config_providers/">rclone config providers</a> - List in JSON format all the providers and options.</li> 584 <li><a href="https://rclone.org/commands/rclone_config_reconnect/">rclone config reconnect</a> - Re-authenticates user with remote.</li> 585 <li><a href="https://rclone.org/commands/rclone_config_redacted/">rclone config redacted</a> - Print redacted (decrypted) config file, or the redacted config for a single remote.</li> 586 <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> 587 <li><a href="https://rclone.org/commands/rclone_config_touch/">rclone config touch</a> - Ensure configuration file exists.</li> 588 <li><a href="https://rclone.org/commands/rclone_config_update/">rclone config update</a> - Update options in an existing remote.</li> 589 <li><a href="https://rclone.org/commands/rclone_config_userinfo/">rclone config userinfo</a> - Prints info about logged in user of remote.</li> 590 </ul> 591 <h1 id="rclone-copy">rclone copy</h1> 592 <p>Copy files from source to dest, skipping identical files.</p> 593 <h2 id="synopsis-1">Synopsis</h2> 594 <p>Copy the source to the destination. Does not transfer files that are identical on source and destination, testing by size and modification time or MD5SUM. Doesn't delete files from the destination. If you want to also delete files from destination, to make it match source, use the <a href="https://rclone.org/commands/rclone_sync/">sync</a> command instead.</p> 595 <p>Note that it is always the contents of the directory that is synced, not the directory itself. So when source:path is a directory, it's the contents of source:path that are copied, not the directory name and contents.</p> 596 <p>To copy single files, use the <a href="https://rclone.org/commands/rclone_copyto/">copyto</a> command instead.</p> 597 <p>If dest:path doesn't exist, it is created and the source:path contents go there.</p> 598 <p>For example</p> 599 <pre><code>rclone copy source:sourcepath dest:destpath</code></pre> 600 <p>Let's say there are two files in sourcepath</p> 601 <pre><code>sourcepath/one.txt 602 sourcepath/two.txt</code></pre> 603 <p>This copies them to</p> 604 <pre><code>destpath/one.txt 605 destpath/two.txt</code></pre> 606 <p>Not to</p> 607 <pre><code>destpath/sourcepath/one.txt 608 destpath/sourcepath/two.txt</code></pre> 609 <p>If you are familiar with <code>rsync</code>, rclone always works as if you had written a trailing <code>/</code> - meaning "copy the contents of this directory". This applies to all commands and whether you are talking about the source or destination.</p> 610 <p>See the <a href="https://rclone.org/docs/#no-traverse">--no-traverse</a> option for controlling whether rclone lists the destination directory or not. Supplying this option when copying a small number of files into a large destination can speed transfers up greatly.</p> 611 <p>For example, if you have many files in /path/to/src but only a few of them change every day, you can copy all the files which have changed recently very efficiently like this:</p> 612 <pre><code>rclone copy --max-age 24h --no-traverse /path/to/src remote:</code></pre> 613 <p>Rclone will sync the modification times of files and directories if the backend supports it. If metadata syncing is required then use the <code>--metadata</code> flag.</p> 614 <p>Note that the modification time and metadata for the root directory will <strong>not</strong> be synced. See https://github.com/rclone/rclone/issues/7652 for more info.</p> 615 <p><strong>Note</strong>: Use the <code>-P</code>/<code>--progress</code> flag to view real-time transfer statistics.</p> 616 <p><strong>Note</strong>: Use the <code>--dry-run</code> or the <code>--interactive</code>/<code>-i</code> flag to test without copying anything.</p> 617 <pre><code>rclone copy source:path dest:path [flags]</code></pre> 618 <h2 id="options-1">Options</h2> 619 <pre><code> --create-empty-src-dirs Create empty source dirs on destination after copy 620 -h, --help help for copy</code></pre> 621 <h2 id="copy-options">Copy Options</h2> 622 <p>Flags for anything which can Copy a file.</p> 623 <pre><code> --check-first Do all the checks before starting transfers 624 -c, --checksum Check for changes with size & checksum (if available, or fallback to size only). 625 --compare-dest stringArray Include additional comma separated server-side paths during comparison 626 --copy-dest stringArray Implies --compare-dest but also copies files from paths into destination 627 --cutoff-mode HARD|SOFT|CAUTIOUS Mode to stop transfers when reaching the max transfer limit HARD|SOFT|CAUTIOUS (default HARD) 628 --ignore-case-sync Ignore case when synchronizing 629 --ignore-checksum Skip post copy check of checksums 630 --ignore-existing Skip all files that exist on destination 631 --ignore-size Ignore size when skipping use modtime or checksum 632 -I, --ignore-times Don't skip items that match size and time - transfer all unconditionally 633 --immutable Do not modify files, fail if existing files have been modified 634 --inplace Download directly to destination file instead of atomic download to temp/rename 635 --max-backlog int Maximum number of objects in sync or check backlog (default 10000) 636 --max-duration Duration Maximum duration rclone will transfer data for (default 0s) 637 --max-transfer SizeSuffix Maximum size of data to transfer (default off) 638 -M, --metadata If set, preserve metadata when copying objects 639 --modify-window Duration Max time diff to be considered the same (default 1ns) 640 --multi-thread-chunk-size SizeSuffix Chunk size for multi-thread downloads / uploads, if not set by filesystem (default 64Mi) 641 --multi-thread-cutoff SizeSuffix Use multi-thread downloads for files above this size (default 256Mi) 642 --multi-thread-streams int Number of streams to use for multi-thread downloads (default 4) 643 --multi-thread-write-buffer-size SizeSuffix In memory buffer size for writing when in multi-thread mode (default 128Ki) 644 --no-check-dest Don't check the destination, copy regardless 645 --no-traverse Don't traverse destination file system on copy 646 --no-update-dir-modtime Don't update directory modification times 647 --no-update-modtime Don't update destination modtime if files identical 648 --order-by string Instructions on how to order the transfers, e.g. 'size,descending' 649 --partial-suffix string Add partial-suffix to temporary file name when --inplace is not used (default ".partial") 650 --refresh-times Refresh the modtime of remote files 651 --server-side-across-configs Allow server-side operations (e.g. copy) to work across different configs 652 --size-only Skip based on size only, not modtime or checksum 653 --streaming-upload-cutoff SizeSuffix Cutoff for switching to chunked upload if file size is unknown, upload starts after reaching cutoff or when file ends (default 100Ki) 654 -u, --update Skip files that are newer on the destination</code></pre> 655 <h2 id="important-options">Important Options</h2> 656 <p>Important flags useful for most commands.</p> 657 <pre><code> -n, --dry-run Do a trial run with no permanent changes 658 -i, --interactive Enable interactive mode 659 -v, --verbose count Print lots more stuff (repeat for more)</code></pre> 660 <h2 id="filter-options">Filter Options</h2> 661 <p>Flags for filtering directory listings.</p> 662 <pre><code> --delete-excluded Delete files on dest excluded from sync 663 --exclude stringArray Exclude files matching pattern 664 --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) 665 --exclude-if-present stringArray Exclude directories if filename is present 666 --files-from stringArray Read list of source-file names from file (use - to read from stdin) 667 --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) 668 -f, --filter stringArray Add a file filtering rule 669 --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) 670 --ignore-case Ignore case in filters (case insensitive) 671 --include stringArray Include files matching pattern 672 --include-from stringArray Read file include patterns from file (use - to read from stdin) 673 --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) 674 --max-depth int If set limits the recursion depth to this (default -1) 675 --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) 676 --metadata-exclude stringArray Exclude metadatas matching pattern 677 --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) 678 --metadata-filter stringArray Add a metadata filtering rule 679 --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) 680 --metadata-include stringArray Include metadatas matching pattern 681 --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) 682 --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) 683 --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre> 684 <h2 id="listing-options">Listing Options</h2> 685 <p>Flags for listing directories.</p> 686 <pre><code> --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) 687 --fast-list Use recursive list if available; uses more memory but fewer transactions</code></pre> 688 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 689 <h1 id="see-also-1">SEE ALSO</h1> 690 <ul> 691 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 692 </ul> 693 <h1 id="rclone-sync">rclone sync</h1> 694 <p>Make source and dest identical, modifying destination only.</p> 695 <h2 id="synopsis-2">Synopsis</h2> 696 <p>Sync the source to the destination, changing the destination only. Doesn't transfer files that are identical on source and destination, testing by size and modification time or MD5SUM. Destination is updated to match source, including deleting files if necessary (except duplicate objects, see below). If you don't want to delete files from destination, use the <a href="https://rclone.org/commands/rclone_copy/">copy</a> command instead.</p> 697 <p><strong>Important</strong>: Since this can cause data loss, test first with the <code>--dry-run</code> or the <code>--interactive</code>/<code>-i</code> flag.</p> 698 <pre><code>rclone sync --interactive SOURCE remote:DESTINATION</code></pre> 699 <p>Note that files in the destination won't be deleted if there were any errors at any point. Duplicate objects (files with the same name, on those providers that support it) are also not yet handled.</p> 700 <p>It is always the contents of the directory that is synced, not the directory itself. So when source:path is a directory, it's the contents of source:path that are copied, not the directory name and contents. See extended explanation in the <a href="https://rclone.org/commands/rclone_copy/">copy</a> command if unsure.</p> 701 <p>If dest:path doesn't exist, it is created and the source:path contents go there.</p> 702 <p>It is not possible to sync overlapping remotes. However, you may exclude the destination from the sync with a filter rule or by putting an exclude-if-present file inside the destination directory and sync to a destination that is inside the source directory.</p> 703 <p>Rclone will sync the modification times of files and directories if the backend supports it. If metadata syncing is required then use the <code>--metadata</code> flag.</p> 704 <p>Note that the modification time and metadata for the root directory will <strong>not</strong> be synced. See https://github.com/rclone/rclone/issues/7652 for more info.</p> 705 <p><strong>Note</strong>: Use the <code>-P</code>/<code>--progress</code> flag to view real-time transfer statistics</p> 706 <p><strong>Note</strong>: Use the <code>rclone dedupe</code> command to deal with "Duplicate object/directory found in source/destination - ignoring" errors. See <a href="https://forum.rclone.org/t/sync-not-clearing-duplicates/14372">this forum post</a> for more info.</p> 707 <h1 id="logger-flags">Logger Flags</h1> 708 <p>The <code>--differ</code>, <code>--missing-on-dst</code>, <code>--missing-on-src</code>, <code>--match</code> and <code>--error</code> flags write paths, one per line, to the file name (or stdout if it is <code>-</code>) supplied. What they write is described in the help below. For example <code>--differ</code> will write all paths which are present on both the source and destination but different.</p> 709 <p>The <code>--combined</code> flag will write a file (or stdout) which contains all file paths with a symbol and then a space and then the path to tell you what happened to it. These are reminiscent of diff files.</p> 710 <ul> 711 <li><code>= path</code> means path was found in source and destination and was identical</li> 712 <li>`- path` means path was missing on the source, so only in the destination</li> 713 <li>`+ path` means path was missing on the destination, so only in the source</li> 714 <li>`* path` means path was present in source and destination but different.</li> 715 <li><code>! path</code> means there was an error reading or hashing the source or dest.</li> 716 </ul> 717 <p>The <code>--dest-after</code> flag writes a list file using the same format flags as <a href="https://rclone.org/commands/rclone_lsf/#synopsis"><code>lsf</code></a> (including <a href="https://rclone.org/commands/rclone_lsf/#synopsis">customizable options for hash, modtime, etc.</a>) Conceptually it is similar to rsync's <code>--itemize-changes</code>, but not identical -- it should output an accurate list of what will be on the destination after the sync.</p> 718 <p>Note that these logger flags have a few limitations, and certain scenarios are not currently supported:</p> 719 <ul> 720 <li><code>--max-duration</code> / <code>CutoffModeHard</code></li> 721 <li><code>--compare-dest</code> / <code>--copy-dest</code></li> 722 <li>server-side moves of an entire dir at once</li> 723 <li>High-level retries, because there would be duplicates (use <code>--retries 1</code> to disable)</li> 724 <li>Possibly some unusual error scenarios</li> 725 </ul> 726 <p>Note also that each file is logged during the sync, as opposed to after, so it is most useful as a predictor of what SHOULD happen to each file (which may or may not match what actually DID.)</p> 727 <pre><code>rclone sync source:path dest:path [flags]</code></pre> 728 <h2 id="options-2">Options</h2> 729 <pre><code> --absolute Put a leading / in front of path names 730 --combined string Make a combined report of changes to this file 731 --create-empty-src-dirs Create empty source dirs on destination after sync 732 --csv Output in CSV format 733 --dest-after string Report all files that exist on the dest post-sync 734 --differ string Report all non-matching files to this file 735 -d, --dir-slash Append a slash to directory names (default true) 736 --dirs-only Only list directories 737 --error string Report all files with errors (hashing or reading) to this file 738 --files-only Only list files (default true) 739 -F, --format string Output format - see lsf help for details (default "p") 740 --hash h Use this hash when h is used in the format MD5|SHA-1|DropboxHash (default "md5") 741 -h, --help help for sync 742 --match string Report all matching files to this file 743 --missing-on-dst string Report all files missing from the destination to this file 744 --missing-on-src string Report all files missing from the source to this file 745 -s, --separator string Separator for the items in the format (default ";") 746 -t, --timeformat string Specify a custom time format, or 'max' for max precision supported by remote (default: 2006-01-02 15:04:05)</code></pre> 747 <h2 id="copy-options-1">Copy Options</h2> 748 <p>Flags for anything which can Copy a file.</p> 749 <pre><code> --check-first Do all the checks before starting transfers 750 -c, --checksum Check for changes with size & checksum (if available, or fallback to size only). 751 --compare-dest stringArray Include additional comma separated server-side paths during comparison 752 --copy-dest stringArray Implies --compare-dest but also copies files from paths into destination 753 --cutoff-mode HARD|SOFT|CAUTIOUS Mode to stop transfers when reaching the max transfer limit HARD|SOFT|CAUTIOUS (default HARD) 754 --ignore-case-sync Ignore case when synchronizing 755 --ignore-checksum Skip post copy check of checksums 756 --ignore-existing Skip all files that exist on destination 757 --ignore-size Ignore size when skipping use modtime or checksum 758 -I, --ignore-times Don't skip items that match size and time - transfer all unconditionally 759 --immutable Do not modify files, fail if existing files have been modified 760 --inplace Download directly to destination file instead of atomic download to temp/rename 761 --max-backlog int Maximum number of objects in sync or check backlog (default 10000) 762 --max-duration Duration Maximum duration rclone will transfer data for (default 0s) 763 --max-transfer SizeSuffix Maximum size of data to transfer (default off) 764 -M, --metadata If set, preserve metadata when copying objects 765 --modify-window Duration Max time diff to be considered the same (default 1ns) 766 --multi-thread-chunk-size SizeSuffix Chunk size for multi-thread downloads / uploads, if not set by filesystem (default 64Mi) 767 --multi-thread-cutoff SizeSuffix Use multi-thread downloads for files above this size (default 256Mi) 768 --multi-thread-streams int Number of streams to use for multi-thread downloads (default 4) 769 --multi-thread-write-buffer-size SizeSuffix In memory buffer size for writing when in multi-thread mode (default 128Ki) 770 --no-check-dest Don't check the destination, copy regardless 771 --no-traverse Don't traverse destination file system on copy 772 --no-update-dir-modtime Don't update directory modification times 773 --no-update-modtime Don't update destination modtime if files identical 774 --order-by string Instructions on how to order the transfers, e.g. 'size,descending' 775 --partial-suffix string Add partial-suffix to temporary file name when --inplace is not used (default ".partial") 776 --refresh-times Refresh the modtime of remote files 777 --server-side-across-configs Allow server-side operations (e.g. copy) to work across different configs 778 --size-only Skip based on size only, not modtime or checksum 779 --streaming-upload-cutoff SizeSuffix Cutoff for switching to chunked upload if file size is unknown, upload starts after reaching cutoff or when file ends (default 100Ki) 780 -u, --update Skip files that are newer on the destination</code></pre> 781 <h2 id="sync-options">Sync Options</h2> 782 <p>Flags just used for <code>rclone sync</code>.</p> 783 <pre><code> --backup-dir string Make backups into hierarchy based in DIR 784 --delete-after When synchronizing, delete files on destination after transferring (default) 785 --delete-before When synchronizing, delete files on destination before transferring 786 --delete-during When synchronizing, delete files during transfer 787 --fix-case Force rename of case insensitive dest to match source 788 --ignore-errors Delete even if there are I/O errors 789 --max-delete int When synchronizing, limit the number of deletes (default -1) 790 --max-delete-size SizeSuffix When synchronizing, limit the total size of deletes (default off) 791 --suffix string Suffix to add to changed files 792 --suffix-keep-extension Preserve the extension when using --suffix 793 --track-renames When synchronizing, track file renames and do a server-side move if possible 794 --track-renames-strategy string Strategies to use when synchronizing using track-renames hash|modtime|leaf (default "hash")</code></pre> 795 <h2 id="important-options-1">Important Options</h2> 796 <p>Important flags useful for most commands.</p> 797 <pre><code> -n, --dry-run Do a trial run with no permanent changes 798 -i, --interactive Enable interactive mode 799 -v, --verbose count Print lots more stuff (repeat for more)</code></pre> 800 <h2 id="filter-options-1">Filter Options</h2> 801 <p>Flags for filtering directory listings.</p> 802 <pre><code> --delete-excluded Delete files on dest excluded from sync 803 --exclude stringArray Exclude files matching pattern 804 --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) 805 --exclude-if-present stringArray Exclude directories if filename is present 806 --files-from stringArray Read list of source-file names from file (use - to read from stdin) 807 --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) 808 -f, --filter stringArray Add a file filtering rule 809 --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) 810 --ignore-case Ignore case in filters (case insensitive) 811 --include stringArray Include files matching pattern 812 --include-from stringArray Read file include patterns from file (use - to read from stdin) 813 --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) 814 --max-depth int If set limits the recursion depth to this (default -1) 815 --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) 816 --metadata-exclude stringArray Exclude metadatas matching pattern 817 --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) 818 --metadata-filter stringArray Add a metadata filtering rule 819 --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) 820 --metadata-include stringArray Include metadatas matching pattern 821 --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) 822 --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) 823 --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre> 824 <h2 id="listing-options-1">Listing Options</h2> 825 <p>Flags for listing directories.</p> 826 <pre><code> --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) 827 --fast-list Use recursive list if available; uses more memory but fewer transactions</code></pre> 828 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 829 <h1 id="see-also-2">SEE ALSO</h1> 830 <ul> 831 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 832 </ul> 833 <h1 id="rclone-move">rclone move</h1> 834 <p>Move files from source to dest.</p> 835 <h2 id="synopsis-3">Synopsis</h2> 836 <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> 837 <p>To move single files, use the <a href="https://rclone.org/commands/rclone_moveto/">moveto</a> command instead.</p> 838 <p>If no filters are in use and if possible this will server-side move <code>source:path</code> into <code>dest:path</code>. After this <code>source:path</code> will no longer exist.</p> 839 <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> 840 <p>If you want to delete empty source directories after move, use the <code>--delete-empty-src-dirs</code> flag.</p> 841 <p>See the <a href="https://rclone.org/docs/#no-traverse">--no-traverse</a> option for controlling whether rclone lists the destination directory or not. Supplying this option when moving a small number of files into a large destination can speed transfers up greatly.</p> 842 <p>Rclone will sync the modification times of files and directories if the backend supports it. If metadata syncing is required then use the <code>--metadata</code> flag.</p> 843 <p>Note that the modification time and metadata for the root directory will <strong>not</strong> be synced. See https://github.com/rclone/rclone/issues/7652 for more info.</p> 844 <p><strong>Important</strong>: Since this can cause data loss, test first with the <code>--dry-run</code> or the <code>--interactive</code>/<code>-i</code> flag.</p> 845 <p><strong>Note</strong>: Use the <code>-P</code>/<code>--progress</code> flag to view real-time transfer statistics.</p> 846 <pre><code>rclone move source:path dest:path [flags]</code></pre> 847 <h2 id="options-3">Options</h2> 848 <pre><code> --create-empty-src-dirs Create empty source dirs on destination after move 849 --delete-empty-src-dirs Delete empty source dirs after move 850 -h, --help help for move</code></pre> 851 <h2 id="copy-options-2">Copy Options</h2> 852 <p>Flags for anything which can Copy a file.</p> 853 <pre><code> --check-first Do all the checks before starting transfers 854 -c, --checksum Check for changes with size & checksum (if available, or fallback to size only). 855 --compare-dest stringArray Include additional comma separated server-side paths during comparison 856 --copy-dest stringArray Implies --compare-dest but also copies files from paths into destination 857 --cutoff-mode HARD|SOFT|CAUTIOUS Mode to stop transfers when reaching the max transfer limit HARD|SOFT|CAUTIOUS (default HARD) 858 --ignore-case-sync Ignore case when synchronizing 859 --ignore-checksum Skip post copy check of checksums 860 --ignore-existing Skip all files that exist on destination 861 --ignore-size Ignore size when skipping use modtime or checksum 862 -I, --ignore-times Don't skip items that match size and time - transfer all unconditionally 863 --immutable Do not modify files, fail if existing files have been modified 864 --inplace Download directly to destination file instead of atomic download to temp/rename 865 --max-backlog int Maximum number of objects in sync or check backlog (default 10000) 866 --max-duration Duration Maximum duration rclone will transfer data for (default 0s) 867 --max-transfer SizeSuffix Maximum size of data to transfer (default off) 868 -M, --metadata If set, preserve metadata when copying objects 869 --modify-window Duration Max time diff to be considered the same (default 1ns) 870 --multi-thread-chunk-size SizeSuffix Chunk size for multi-thread downloads / uploads, if not set by filesystem (default 64Mi) 871 --multi-thread-cutoff SizeSuffix Use multi-thread downloads for files above this size (default 256Mi) 872 --multi-thread-streams int Number of streams to use for multi-thread downloads (default 4) 873 --multi-thread-write-buffer-size SizeSuffix In memory buffer size for writing when in multi-thread mode (default 128Ki) 874 --no-check-dest Don't check the destination, copy regardless 875 --no-traverse Don't traverse destination file system on copy 876 --no-update-dir-modtime Don't update directory modification times 877 --no-update-modtime Don't update destination modtime if files identical 878 --order-by string Instructions on how to order the transfers, e.g. 'size,descending' 879 --partial-suffix string Add partial-suffix to temporary file name when --inplace is not used (default ".partial") 880 --refresh-times Refresh the modtime of remote files 881 --server-side-across-configs Allow server-side operations (e.g. copy) to work across different configs 882 --size-only Skip based on size only, not modtime or checksum 883 --streaming-upload-cutoff SizeSuffix Cutoff for switching to chunked upload if file size is unknown, upload starts after reaching cutoff or when file ends (default 100Ki) 884 -u, --update Skip files that are newer on the destination</code></pre> 885 <h2 id="important-options-2">Important Options</h2> 886 <p>Important flags useful for most commands.</p> 887 <pre><code> -n, --dry-run Do a trial run with no permanent changes 888 -i, --interactive Enable interactive mode 889 -v, --verbose count Print lots more stuff (repeat for more)</code></pre> 890 <h2 id="filter-options-2">Filter Options</h2> 891 <p>Flags for filtering directory listings.</p> 892 <pre><code> --delete-excluded Delete files on dest excluded from sync 893 --exclude stringArray Exclude files matching pattern 894 --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) 895 --exclude-if-present stringArray Exclude directories if filename is present 896 --files-from stringArray Read list of source-file names from file (use - to read from stdin) 897 --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) 898 -f, --filter stringArray Add a file filtering rule 899 --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) 900 --ignore-case Ignore case in filters (case insensitive) 901 --include stringArray Include files matching pattern 902 --include-from stringArray Read file include patterns from file (use - to read from stdin) 903 --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) 904 --max-depth int If set limits the recursion depth to this (default -1) 905 --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) 906 --metadata-exclude stringArray Exclude metadatas matching pattern 907 --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) 908 --metadata-filter stringArray Add a metadata filtering rule 909 --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) 910 --metadata-include stringArray Include metadatas matching pattern 911 --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) 912 --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) 913 --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre> 914 <h2 id="listing-options-2">Listing Options</h2> 915 <p>Flags for listing directories.</p> 916 <pre><code> --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) 917 --fast-list Use recursive list if available; uses more memory but fewer transactions</code></pre> 918 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 919 <h1 id="see-also-3">SEE ALSO</h1> 920 <ul> 921 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 922 </ul> 923 <h1 id="rclone-delete">rclone delete</h1> 924 <p>Remove the files in path.</p> 925 <h2 id="synopsis-4">Synopsis</h2> 926 <p>Remove the files in path. Unlike <a href="https://rclone.org/commands/rclone_purge/">purge</a> it obeys include/exclude filters so can be used to selectively delete files.</p> 927 <p><code>rclone delete</code> only deletes files but leaves the directory structure alone. If you want to delete a directory and all of its contents use the <a href="https://rclone.org/commands/rclone_purge/">purge</a> command.</p> 928 <p>If you supply the <code>--rmdirs</code> flag, it will remove all empty directories along with it. You can also use the separate command <a href="https://rclone.org/commands/rclone_rmdir/">rmdir</a> or <a href="https://rclone.org/commands/rclone_rmdirs/">rmdirs</a> to delete empty directories only.</p> 929 <p>For example, to delete all files bigger than 100 MiB, you may first want to check what would be deleted (use either):</p> 930 <pre><code>rclone --min-size 100M lsl remote:path 931 rclone --dry-run --min-size 100M delete remote:path</code></pre> 932 <p>Then proceed with the actual delete:</p> 933 <pre><code>rclone --min-size 100M delete remote:path</code></pre> 934 <p>That reads "delete everything with a minimum size of 100 MiB", hence delete all files bigger than 100 MiB.</p> 935 <p><strong>Important</strong>: Since this can cause data loss, test first with the <code>--dry-run</code> or the <code>--interactive</code>/<code>-i</code> flag.</p> 936 <pre><code>rclone delete remote:path [flags]</code></pre> 937 <h2 id="options-4">Options</h2> 938 <pre><code> -h, --help help for delete 939 --rmdirs rmdirs removes empty directories but leaves root intact</code></pre> 940 <h2 id="important-options-3">Important Options</h2> 941 <p>Important flags useful for most commands.</p> 942 <pre><code> -n, --dry-run Do a trial run with no permanent changes 943 -i, --interactive Enable interactive mode 944 -v, --verbose count Print lots more stuff (repeat for more)</code></pre> 945 <h2 id="filter-options-3">Filter Options</h2> 946 <p>Flags for filtering directory listings.</p> 947 <pre><code> --delete-excluded Delete files on dest excluded from sync 948 --exclude stringArray Exclude files matching pattern 949 --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) 950 --exclude-if-present stringArray Exclude directories if filename is present 951 --files-from stringArray Read list of source-file names from file (use - to read from stdin) 952 --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) 953 -f, --filter stringArray Add a file filtering rule 954 --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) 955 --ignore-case Ignore case in filters (case insensitive) 956 --include stringArray Include files matching pattern 957 --include-from stringArray Read file include patterns from file (use - to read from stdin) 958 --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) 959 --max-depth int If set limits the recursion depth to this (default -1) 960 --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) 961 --metadata-exclude stringArray Exclude metadatas matching pattern 962 --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) 963 --metadata-filter stringArray Add a metadata filtering rule 964 --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) 965 --metadata-include stringArray Include metadatas matching pattern 966 --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) 967 --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) 968 --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre> 969 <h2 id="listing-options-3">Listing Options</h2> 970 <p>Flags for listing directories.</p> 971 <pre><code> --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) 972 --fast-list Use recursive list if available; uses more memory but fewer transactions</code></pre> 973 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 974 <h1 id="see-also-4">SEE ALSO</h1> 975 <ul> 976 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 977 </ul> 978 <h1 id="rclone-purge">rclone purge</h1> 979 <p>Remove the path and all of its contents.</p> 980 <h2 id="synopsis-5">Synopsis</h2> 981 <p>Remove the path and all of its contents. Note that this does not obey include/exclude filters - everything will be removed. Use the <a href="https://rclone.org/commands/rclone_delete/">delete</a> command if you want to selectively delete files. To delete empty directories only, use command <a href="https://rclone.org/commands/rclone_rmdir/">rmdir</a> or <a href="https://rclone.org/commands/rclone_rmdirs/">rmdirs</a>.</p> 982 <p><strong>Important</strong>: Since this can cause data loss, test first with the <code>--dry-run</code> or the <code>--interactive</code>/<code>-i</code> flag.</p> 983 <pre><code>rclone purge remote:path [flags]</code></pre> 984 <h2 id="options-5">Options</h2> 985 <pre><code> -h, --help help for purge</code></pre> 986 <h2 id="important-options-4">Important Options</h2> 987 <p>Important flags useful for most commands.</p> 988 <pre><code> -n, --dry-run Do a trial run with no permanent changes 989 -i, --interactive Enable interactive mode 990 -v, --verbose count Print lots more stuff (repeat for more)</code></pre> 991 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 992 <h1 id="see-also-5">SEE ALSO</h1> 993 <ul> 994 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 995 </ul> 996 <h1 id="rclone-mkdir">rclone mkdir</h1> 997 <p>Make the path if it doesn't already exist.</p> 998 <pre><code>rclone mkdir remote:path [flags]</code></pre> 999 <h2 id="options-6">Options</h2> 1000 <pre><code> -h, --help help for mkdir</code></pre> 1001 <h2 id="important-options-5">Important Options</h2> 1002 <p>Important flags useful for most commands.</p> 1003 <pre><code> -n, --dry-run Do a trial run with no permanent changes 1004 -i, --interactive Enable interactive mode 1005 -v, --verbose count Print lots more stuff (repeat for more)</code></pre> 1006 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1007 <h1 id="see-also-6">SEE ALSO</h1> 1008 <ul> 1009 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1010 </ul> 1011 <h1 id="rclone-rmdir">rclone rmdir</h1> 1012 <p>Remove the empty directory at path.</p> 1013 <h2 id="synopsis-6">Synopsis</h2> 1014 <p>This removes empty directory given by path. Will not remove the path if it has any objects in it, not even empty subdirectories. Use command <a href="https://rclone.org/commands/rclone_rmdirs/">rmdirs</a> (or <a href="https://rclone.org/commands/rclone_delete/">delete</a> with option <code>--rmdirs</code>) to do that.</p> 1015 <p>To delete a path and any objects in it, use <a href="https://rclone.org/commands/rclone_purge/">purge</a> command.</p> 1016 <pre><code>rclone rmdir remote:path [flags]</code></pre> 1017 <h2 id="options-7">Options</h2> 1018 <pre><code> -h, --help help for rmdir</code></pre> 1019 <h2 id="important-options-6">Important Options</h2> 1020 <p>Important flags useful for most commands.</p> 1021 <pre><code> -n, --dry-run Do a trial run with no permanent changes 1022 -i, --interactive Enable interactive mode 1023 -v, --verbose count Print lots more stuff (repeat for more)</code></pre> 1024 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1025 <h1 id="see-also-7">SEE ALSO</h1> 1026 <ul> 1027 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1028 </ul> 1029 <h1 id="rclone-check">rclone check</h1> 1030 <p>Checks the files in the source and destination match.</p> 1031 <h2 id="synopsis-7">Synopsis</h2> 1032 <p>Checks the files in the source and destination match. It compares sizes and hashes (MD5 or SHA1) and logs a report of files that don't match. It doesn't alter the source or destination.</p> 1033 <p>For the <a href="https://rclone.org/crypt/">crypt</a> remote there is a dedicated command, <a href="https://rclone.org/commands/rclone_cryptcheck/">cryptcheck</a>, that are able to check the checksums of the encrypted files.</p> 1034 <p>If you supply the <code>--size-only</code> flag, it will only compare the sizes not the hashes as well. Use this for a quick check.</p> 1035 <p>If you supply the <code>--download</code> 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> 1036 <p>If you supply the <code>--checkfile HASH</code> flag with a valid hash name, the <code>source:path</code> must point to a text file in the SUM format.</p> 1037 <p>If you supply the <code>--one-way</code> flag, it will only check that files in the source match the files in the destination, not the other way around. This means that extra files in the destination that are not in the source will not be detected.</p> 1038 <p>The <code>--differ</code>, <code>--missing-on-dst</code>, <code>--missing-on-src</code>, <code>--match</code> and <code>--error</code> flags write paths, one per line, to the file name (or stdout if it is <code>-</code>) supplied. What they write is described in the help below. For example <code>--differ</code> will write all paths which are present on both the source and destination but different.</p> 1039 <p>The <code>--combined</code> flag will write a file (or stdout) which contains all file paths with a symbol and then a space and then the path to tell you what happened to it. These are reminiscent of diff files.</p> 1040 <ul> 1041 <li><code>= path</code> means path was found in source and destination and was identical</li> 1042 <li>`- path` means path was missing on the source, so only in the destination</li> 1043 <li>`+ path` means path was missing on the destination, so only in the source</li> 1044 <li>`* path` means path was present in source and destination but different.</li> 1045 <li><code>! path</code> means there was an error reading or hashing the source or dest.</li> 1046 </ul> 1047 <p>The default number of parallel checks is 8. See the <a href="https://rclone.org/docs/#checkers-n">--checkers=N</a> option for more information.</p> 1048 <pre><code>rclone check source:path dest:path [flags]</code></pre> 1049 <h2 id="options-8">Options</h2> 1050 <pre><code> -C, --checkfile string Treat source:path as a SUM file with hashes of given type 1051 --combined string Make a combined report of changes to this file 1052 --differ string Report all non-matching files to this file 1053 --download Check by downloading rather than with hash 1054 --error string Report all files with errors (hashing or reading) to this file 1055 -h, --help help for check 1056 --match string Report all matching files to this file 1057 --missing-on-dst string Report all files missing from the destination to this file 1058 --missing-on-src string Report all files missing from the source to this file 1059 --one-way Check one way only, source files must exist on remote</code></pre> 1060 <h2 id="check-options">Check Options</h2> 1061 <p>Flags used for <code>rclone check</code>.</p> 1062 <pre><code> --max-backlog int Maximum number of objects in sync or check backlog (default 10000)</code></pre> 1063 <h2 id="filter-options-4">Filter Options</h2> 1064 <p>Flags for filtering directory listings.</p> 1065 <pre><code> --delete-excluded Delete files on dest excluded from sync 1066 --exclude stringArray Exclude files matching pattern 1067 --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) 1068 --exclude-if-present stringArray Exclude directories if filename is present 1069 --files-from stringArray Read list of source-file names from file (use - to read from stdin) 1070 --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) 1071 -f, --filter stringArray Add a file filtering rule 1072 --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) 1073 --ignore-case Ignore case in filters (case insensitive) 1074 --include stringArray Include files matching pattern 1075 --include-from stringArray Read file include patterns from file (use - to read from stdin) 1076 --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) 1077 --max-depth int If set limits the recursion depth to this (default -1) 1078 --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) 1079 --metadata-exclude stringArray Exclude metadatas matching pattern 1080 --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) 1081 --metadata-filter stringArray Add a metadata filtering rule 1082 --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) 1083 --metadata-include stringArray Include metadatas matching pattern 1084 --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) 1085 --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) 1086 --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre> 1087 <h2 id="listing-options-4">Listing Options</h2> 1088 <p>Flags for listing directories.</p> 1089 <pre><code> --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) 1090 --fast-list Use recursive list if available; uses more memory but fewer transactions</code></pre> 1091 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1092 <h1 id="see-also-8">SEE ALSO</h1> 1093 <ul> 1094 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1095 </ul> 1096 <h1 id="rclone-ls">rclone ls</h1> 1097 <p>List the objects in the path with size and path.</p> 1098 <h2 id="synopsis-8">Synopsis</h2> 1099 <p>Lists the objects in the source path to standard output in a human readable format with size and path. Recurses by default.</p> 1100 <p>Eg</p> 1101 <pre><code>$ rclone ls swift:bucket 1102 60295 bevajer5jef 1103 90613 canole 1104 94467 diwogej7 1105 37600 fubuwic</code></pre> 1106 <p>Any of the filtering options can be applied to this command.</p> 1107 <p>There are several related list commands</p> 1108 <ul> 1109 <li><code>ls</code> to list size and path of objects only</li> 1110 <li><code>lsl</code> to list modification time, size and path of objects only</li> 1111 <li><code>lsd</code> to list directories only</li> 1112 <li><code>lsf</code> to list objects and directories in easy to parse format</li> 1113 <li><code>lsjson</code> to list objects and directories in JSON format</li> 1114 </ul> 1115 <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> 1116 <p>Note that <code>ls</code> and <code>lsl</code> recurse by default - use <code>--max-depth 1</code> to stop the recursion.</p> 1117 <p>The other list commands <code>lsd</code>,<code>lsf</code>,<code>lsjson</code> do not recurse by default - use <code>-R</code> to make them recurse.</p> 1118 <p>Listing a nonexistent directory will produce an error except for remotes which can't have empty directories (e.g. s3, swift, or gcs - the bucket-based remotes).</p> 1119 <pre><code>rclone ls remote:path [flags]</code></pre> 1120 <h2 id="options-9">Options</h2> 1121 <pre><code> -h, --help help for ls</code></pre> 1122 <h2 id="filter-options-5">Filter Options</h2> 1123 <p>Flags for filtering directory listings.</p> 1124 <pre><code> --delete-excluded Delete files on dest excluded from sync 1125 --exclude stringArray Exclude files matching pattern 1126 --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) 1127 --exclude-if-present stringArray Exclude directories if filename is present 1128 --files-from stringArray Read list of source-file names from file (use - to read from stdin) 1129 --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) 1130 -f, --filter stringArray Add a file filtering rule 1131 --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) 1132 --ignore-case Ignore case in filters (case insensitive) 1133 --include stringArray Include files matching pattern 1134 --include-from stringArray Read file include patterns from file (use - to read from stdin) 1135 --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) 1136 --max-depth int If set limits the recursion depth to this (default -1) 1137 --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) 1138 --metadata-exclude stringArray Exclude metadatas matching pattern 1139 --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) 1140 --metadata-filter stringArray Add a metadata filtering rule 1141 --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) 1142 --metadata-include stringArray Include metadatas matching pattern 1143 --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) 1144 --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) 1145 --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre> 1146 <h2 id="listing-options-5">Listing Options</h2> 1147 <p>Flags for listing directories.</p> 1148 <pre><code> --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) 1149 --fast-list Use recursive list if available; uses more memory but fewer transactions</code></pre> 1150 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1151 <h1 id="see-also-9">SEE ALSO</h1> 1152 <ul> 1153 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1154 </ul> 1155 <h1 id="rclone-lsd">rclone lsd</h1> 1156 <p>List all directories/containers/buckets in the path.</p> 1157 <h2 id="synopsis-9">Synopsis</h2> 1158 <p>Lists the directories in the source path to standard output. Does not recurse by default. Use the <code>-R</code> flag to recurse.</p> 1159 <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> 1160 <pre><code>$ rclone lsd swift: 1161 494000 2018-04-26 08:43:20 10000 10000files 1162 65 2018-04-26 08:43:20 1 1File</code></pre> 1163 <p>Or</p> 1164 <pre><code>$ rclone lsd drive:test 1165 -1 2016-10-17 17:41:53 -1 1000files 1166 -1 2017-01-03 14:40:54 -1 2500files 1167 -1 2017-07-08 14:39:28 -1 4000files</code></pre> 1168 <p>If you just want the directory names use <code>rclone lsf --dirs-only</code>.</p> 1169 <p>Any of the filtering options can be applied to this command.</p> 1170 <p>There are several related list commands</p> 1171 <ul> 1172 <li><code>ls</code> to list size and path of objects only</li> 1173 <li><code>lsl</code> to list modification time, size and path of objects only</li> 1174 <li><code>lsd</code> to list directories only</li> 1175 <li><code>lsf</code> to list objects and directories in easy to parse format</li> 1176 <li><code>lsjson</code> to list objects and directories in JSON format</li> 1177 </ul> 1178 <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> 1179 <p>Note that <code>ls</code> and <code>lsl</code> recurse by default - use <code>--max-depth 1</code> to stop the recursion.</p> 1180 <p>The other list commands <code>lsd</code>,<code>lsf</code>,<code>lsjson</code> do not recurse by default - use <code>-R</code> to make them recurse.</p> 1181 <p>Listing a nonexistent directory will produce an error except for remotes which can't have empty directories (e.g. s3, swift, or gcs - the bucket-based remotes).</p> 1182 <pre><code>rclone lsd remote:path [flags]</code></pre> 1183 <h2 id="options-10">Options</h2> 1184 <pre><code> -h, --help help for lsd 1185 -R, --recursive Recurse into the listing</code></pre> 1186 <h2 id="filter-options-6">Filter Options</h2> 1187 <p>Flags for filtering directory listings.</p> 1188 <pre><code> --delete-excluded Delete files on dest excluded from sync 1189 --exclude stringArray Exclude files matching pattern 1190 --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) 1191 --exclude-if-present stringArray Exclude directories if filename is present 1192 --files-from stringArray Read list of source-file names from file (use - to read from stdin) 1193 --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) 1194 -f, --filter stringArray Add a file filtering rule 1195 --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) 1196 --ignore-case Ignore case in filters (case insensitive) 1197 --include stringArray Include files matching pattern 1198 --include-from stringArray Read file include patterns from file (use - to read from stdin) 1199 --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) 1200 --max-depth int If set limits the recursion depth to this (default -1) 1201 --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) 1202 --metadata-exclude stringArray Exclude metadatas matching pattern 1203 --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) 1204 --metadata-filter stringArray Add a metadata filtering rule 1205 --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) 1206 --metadata-include stringArray Include metadatas matching pattern 1207 --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) 1208 --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) 1209 --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre> 1210 <h2 id="listing-options-6">Listing Options</h2> 1211 <p>Flags for listing directories.</p> 1212 <pre><code> --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) 1213 --fast-list Use recursive list if available; uses more memory but fewer transactions</code></pre> 1214 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1215 <h1 id="see-also-10">SEE ALSO</h1> 1216 <ul> 1217 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1218 </ul> 1219 <h1 id="rclone-lsl">rclone lsl</h1> 1220 <p>List the objects in path with modification time, size and path.</p> 1221 <h2 id="synopsis-10">Synopsis</h2> 1222 <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> 1223 <p>Eg</p> 1224 <pre><code>$ rclone lsl swift:bucket 1225 60295 2016-06-25 18:55:41.062626927 bevajer5jef 1226 90613 2016-06-25 18:55:43.302607074 canole 1227 94467 2016-06-25 18:55:43.046609333 diwogej7 1228 37600 2016-06-25 18:55:40.814629136 fubuwic</code></pre> 1229 <p>Any of the filtering options can be applied to this command.</p> 1230 <p>There are several related list commands</p> 1231 <ul> 1232 <li><code>ls</code> to list size and path of objects only</li> 1233 <li><code>lsl</code> to list modification time, size and path of objects only</li> 1234 <li><code>lsd</code> to list directories only</li> 1235 <li><code>lsf</code> to list objects and directories in easy to parse format</li> 1236 <li><code>lsjson</code> to list objects and directories in JSON format</li> 1237 </ul> 1238 <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> 1239 <p>Note that <code>ls</code> and <code>lsl</code> recurse by default - use <code>--max-depth 1</code> to stop the recursion.</p> 1240 <p>The other list commands <code>lsd</code>,<code>lsf</code>,<code>lsjson</code> do not recurse by default - use <code>-R</code> to make them recurse.</p> 1241 <p>Listing a nonexistent directory will produce an error except for remotes which can't have empty directories (e.g. s3, swift, or gcs - the bucket-based remotes).</p> 1242 <pre><code>rclone lsl remote:path [flags]</code></pre> 1243 <h2 id="options-11">Options</h2> 1244 <pre><code> -h, --help help for lsl</code></pre> 1245 <h2 id="filter-options-7">Filter Options</h2> 1246 <p>Flags for filtering directory listings.</p> 1247 <pre><code> --delete-excluded Delete files on dest excluded from sync 1248 --exclude stringArray Exclude files matching pattern 1249 --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) 1250 --exclude-if-present stringArray Exclude directories if filename is present 1251 --files-from stringArray Read list of source-file names from file (use - to read from stdin) 1252 --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) 1253 -f, --filter stringArray Add a file filtering rule 1254 --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) 1255 --ignore-case Ignore case in filters (case insensitive) 1256 --include stringArray Include files matching pattern 1257 --include-from stringArray Read file include patterns from file (use - to read from stdin) 1258 --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) 1259 --max-depth int If set limits the recursion depth to this (default -1) 1260 --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) 1261 --metadata-exclude stringArray Exclude metadatas matching pattern 1262 --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) 1263 --metadata-filter stringArray Add a metadata filtering rule 1264 --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) 1265 --metadata-include stringArray Include metadatas matching pattern 1266 --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) 1267 --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) 1268 --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre> 1269 <h2 id="listing-options-7">Listing Options</h2> 1270 <p>Flags for listing directories.</p> 1271 <pre><code> --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) 1272 --fast-list Use recursive list if available; uses more memory but fewer transactions</code></pre> 1273 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1274 <h1 id="see-also-11">SEE ALSO</h1> 1275 <ul> 1276 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1277 </ul> 1278 <h1 id="rclone-md5sum">rclone md5sum</h1> 1279 <p>Produces an md5sum file for all the objects in the path.</p> 1280 <h2 id="synopsis-11">Synopsis</h2> 1281 <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> 1282 <p>By default, the hash is requested from the remote. If MD5 is not supported by the remote, no hash will be returned. With the download flag, the file will be downloaded from the remote and hashed locally enabling MD5 for any remote.</p> 1283 <p>For other algorithms, see the <a href="https://rclone.org/commands/rclone_hashsum/">hashsum</a> command. Running <code>rclone md5sum remote:path</code> is equivalent to running <code>rclone hashsum MD5 remote:path</code>.</p> 1284 <p>This command can also hash data received on standard input (stdin), by not passing a remote:path, or by passing a hyphen as remote:path when there is data to read (if not, the hyphen will be treated literally, as a relative path).</p> 1285 <pre><code>rclone md5sum remote:path [flags]</code></pre> 1286 <h2 id="options-12">Options</h2> 1287 <pre><code> --base64 Output base64 encoded hashsum 1288 -C, --checkfile string Validate hashes against a given SUM file instead of printing them 1289 --download Download the file and hash it locally; if this flag is not specified, the hash is requested from the remote 1290 -h, --help help for md5sum 1291 --output-file string Output hashsums to a file rather than the terminal</code></pre> 1292 <h2 id="filter-options-8">Filter Options</h2> 1293 <p>Flags for filtering directory listings.</p> 1294 <pre><code> --delete-excluded Delete files on dest excluded from sync 1295 --exclude stringArray Exclude files matching pattern 1296 --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) 1297 --exclude-if-present stringArray Exclude directories if filename is present 1298 --files-from stringArray Read list of source-file names from file (use - to read from stdin) 1299 --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) 1300 -f, --filter stringArray Add a file filtering rule 1301 --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) 1302 --ignore-case Ignore case in filters (case insensitive) 1303 --include stringArray Include files matching pattern 1304 --include-from stringArray Read file include patterns from file (use - to read from stdin) 1305 --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) 1306 --max-depth int If set limits the recursion depth to this (default -1) 1307 --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) 1308 --metadata-exclude stringArray Exclude metadatas matching pattern 1309 --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) 1310 --metadata-filter stringArray Add a metadata filtering rule 1311 --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) 1312 --metadata-include stringArray Include metadatas matching pattern 1313 --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) 1314 --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) 1315 --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre> 1316 <h2 id="listing-options-8">Listing Options</h2> 1317 <p>Flags for listing directories.</p> 1318 <pre><code> --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) 1319 --fast-list Use recursive list if available; uses more memory but fewer transactions</code></pre> 1320 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1321 <h1 id="see-also-12">SEE ALSO</h1> 1322 <ul> 1323 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1324 </ul> 1325 <h1 id="rclone-sha1sum">rclone sha1sum</h1> 1326 <p>Produces an sha1sum file for all the objects in the path.</p> 1327 <h2 id="synopsis-12">Synopsis</h2> 1328 <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> 1329 <p>By default, the hash is requested from the remote. If SHA-1 is not supported by the remote, no hash will be returned. With the download flag, the file will be downloaded from the remote and hashed locally enabling SHA-1 for any remote.</p> 1330 <p>For other algorithms, see the <a href="https://rclone.org/commands/rclone_hashsum/">hashsum</a> command. Running <code>rclone sha1sum remote:path</code> is equivalent to running <code>rclone hashsum SHA1 remote:path</code>.</p> 1331 <p>This command can also hash data received on standard input (stdin), by not passing a remote:path, or by passing a hyphen as remote:path when there is data to read (if not, the hyphen will be treated literally, as a relative path).</p> 1332 <p>This command can also hash data received on STDIN, if not passing a remote:path.</p> 1333 <pre><code>rclone sha1sum remote:path [flags]</code></pre> 1334 <h2 id="options-13">Options</h2> 1335 <pre><code> --base64 Output base64 encoded hashsum 1336 -C, --checkfile string Validate hashes against a given SUM file instead of printing them 1337 --download Download the file and hash it locally; if this flag is not specified, the hash is requested from the remote 1338 -h, --help help for sha1sum 1339 --output-file string Output hashsums to a file rather than the terminal</code></pre> 1340 <h2 id="filter-options-9">Filter Options</h2> 1341 <p>Flags for filtering directory listings.</p> 1342 <pre><code> --delete-excluded Delete files on dest excluded from sync 1343 --exclude stringArray Exclude files matching pattern 1344 --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) 1345 --exclude-if-present stringArray Exclude directories if filename is present 1346 --files-from stringArray Read list of source-file names from file (use - to read from stdin) 1347 --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) 1348 -f, --filter stringArray Add a file filtering rule 1349 --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) 1350 --ignore-case Ignore case in filters (case insensitive) 1351 --include stringArray Include files matching pattern 1352 --include-from stringArray Read file include patterns from file (use - to read from stdin) 1353 --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) 1354 --max-depth int If set limits the recursion depth to this (default -1) 1355 --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) 1356 --metadata-exclude stringArray Exclude metadatas matching pattern 1357 --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) 1358 --metadata-filter stringArray Add a metadata filtering rule 1359 --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) 1360 --metadata-include stringArray Include metadatas matching pattern 1361 --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) 1362 --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) 1363 --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre> 1364 <h2 id="listing-options-9">Listing Options</h2> 1365 <p>Flags for listing directories.</p> 1366 <pre><code> --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) 1367 --fast-list Use recursive list if available; uses more memory but fewer transactions</code></pre> 1368 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1369 <h1 id="see-also-13">SEE ALSO</h1> 1370 <ul> 1371 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1372 </ul> 1373 <h1 id="rclone-size">rclone size</h1> 1374 <p>Prints the total size and number of objects in remote:path.</p> 1375 <h2 id="synopsis-13">Synopsis</h2> 1376 <p>Counts objects in the path and calculates the total size. Prints the result to standard output.</p> 1377 <p>By default the output is in human-readable format, but shows values in both human-readable format as well as the raw numbers (global option <code>--human-readable</code> is not considered). Use option <code>--json</code> to format output as JSON instead.</p> 1378 <p>Recurses by default, use <code>--max-depth 1</code> to stop the recursion.</p> 1379 <p>Some backends do not always provide file sizes, see for example <a href="https://rclone.org/googlephotos/#size">Google Photos</a> and <a href="https://rclone.org/drive/#limitations-of-google-docs">Google Docs</a>. Rclone will then show a notice in the log indicating how many such files were encountered, and count them in as empty files in the output of the size command.</p> 1380 <pre><code>rclone size remote:path [flags]</code></pre> 1381 <h2 id="options-14">Options</h2> 1382 <pre><code> -h, --help help for size 1383 --json Format output as JSON</code></pre> 1384 <h2 id="filter-options-10">Filter Options</h2> 1385 <p>Flags for filtering directory listings.</p> 1386 <pre><code> --delete-excluded Delete files on dest excluded from sync 1387 --exclude stringArray Exclude files matching pattern 1388 --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) 1389 --exclude-if-present stringArray Exclude directories if filename is present 1390 --files-from stringArray Read list of source-file names from file (use - to read from stdin) 1391 --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) 1392 -f, --filter stringArray Add a file filtering rule 1393 --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) 1394 --ignore-case Ignore case in filters (case insensitive) 1395 --include stringArray Include files matching pattern 1396 --include-from stringArray Read file include patterns from file (use - to read from stdin) 1397 --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) 1398 --max-depth int If set limits the recursion depth to this (default -1) 1399 --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) 1400 --metadata-exclude stringArray Exclude metadatas matching pattern 1401 --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) 1402 --metadata-filter stringArray Add a metadata filtering rule 1403 --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) 1404 --metadata-include stringArray Include metadatas matching pattern 1405 --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) 1406 --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) 1407 --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre> 1408 <h2 id="listing-options-10">Listing Options</h2> 1409 <p>Flags for listing directories.</p> 1410 <pre><code> --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) 1411 --fast-list Use recursive list if available; uses more memory but fewer transactions</code></pre> 1412 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1413 <h1 id="see-also-14">SEE ALSO</h1> 1414 <ul> 1415 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1416 </ul> 1417 <h1 id="rclone-version">rclone version</h1> 1418 <p>Show the version number.</p> 1419 <h2 id="synopsis-14">Synopsis</h2> 1420 <p>Show the rclone version number, the go version, the build target OS and architecture, the runtime OS and kernel version and bitness, build tags and the type of executable (static or dynamic).</p> 1421 <p>For example:</p> 1422 <pre><code>$ rclone version 1423 rclone v1.55.0 1424 - os/version: ubuntu 18.04 (64 bit) 1425 - os/kernel: 4.15.0-136-generic (x86_64) 1426 - os/type: linux 1427 - os/arch: amd64 1428 - go/version: go1.16 1429 - go/linking: static 1430 - go/tags: none</code></pre> 1431 <p>Note: before rclone version 1.55 the os/type and os/arch lines were merged, and the "go/version" line was tagged as "go version".</p> 1432 <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> 1433 <pre><code>$ rclone version --check 1434 yours: 1.42.0.6 1435 latest: 1.42 (released 2018-06-16) 1436 beta: 1.42.0.5 (released 2018-06-17)</code></pre> 1437 <p>Or</p> 1438 <pre><code>$ rclone version --check 1439 yours: 1.41 1440 latest: 1.42 (released 2018-06-16) 1441 upgrade: https://downloads.rclone.org/v1.42 1442 beta: 1.42.0.5 (released 2018-06-17) 1443 upgrade: https://beta.rclone.org/v1.42-005-g56e1e820</code></pre> 1444 <pre><code>rclone version [flags]</code></pre> 1445 <h2 id="options-15">Options</h2> 1446 <pre><code> --check Check for new version 1447 -h, --help help for version</code></pre> 1448 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1449 <h1 id="see-also-15">SEE ALSO</h1> 1450 <ul> 1451 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1452 </ul> 1453 <h1 id="rclone-cleanup">rclone cleanup</h1> 1454 <p>Clean up the remote if possible.</p> 1455 <h2 id="synopsis-15">Synopsis</h2> 1456 <p>Clean up the remote if possible. Empty the trash or delete old file versions. Not supported by all remotes.</p> 1457 <pre><code>rclone cleanup remote:path [flags]</code></pre> 1458 <h2 id="options-16">Options</h2> 1459 <pre><code> -h, --help help for cleanup</code></pre> 1460 <h2 id="important-options-7">Important Options</h2> 1461 <p>Important flags useful for most commands.</p> 1462 <pre><code> -n, --dry-run Do a trial run with no permanent changes 1463 -i, --interactive Enable interactive mode 1464 -v, --verbose count Print lots more stuff (repeat for more)</code></pre> 1465 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1466 <h1 id="see-also-16">SEE ALSO</h1> 1467 <ul> 1468 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1469 </ul> 1470 <h1 id="rclone-dedupe">rclone dedupe</h1> 1471 <p>Interactively find duplicate filenames and delete/rename them.</p> 1472 <h2 id="synopsis-16">Synopsis</h2> 1473 <p>By default <code>dedupe</code> interactively finds files with duplicate names and offers to delete all but one or rename them to be different. This is known as deduping by name.</p> 1474 <p>Deduping by name is only useful with a small group of backends (e.g. Google Drive, Opendrive) that can have duplicate file names. It can be run on wrapping backends (e.g. crypt) if they wrap a backend which supports duplicate file names.</p> 1475 <p>However if <code>--by-hash</code> is passed in then dedupe will find files with duplicate hashes instead which will work on any backend which supports at least one hash. This can be used to find files with duplicate content. This is known as deduping by hash.</p> 1476 <p>If deduping by name, first rclone will merge directories with the same name. It will do this iteratively until all the identically named directories have been merged.</p> 1477 <p>Next, if deduping by name, for every group of duplicate file names / hashes, it will delete all but one identical file it finds without confirmation. This means that for most duplicated files the <code>dedupe</code> command will not be interactive.</p> 1478 <p><code>dedupe</code> considers files to be identical if they have the same file path and the same hash. If the backend does not support hashes (e.g. crypt wrapping Google Drive) then they will never be found to be identical. If you use the <code>--size-only</code> flag then files will be considered identical if they have the same size (any hash will be ignored). This can be useful on crypt backends which do not support hashes.</p> 1479 <p>Next rclone will resolve the remaining duplicates. Exactly which action is taken depends on the dedupe mode. By default, rclone will interactively query the user for each one.</p> 1480 <p><strong>Important</strong>: Since this can cause data loss, test first with the <code>--dry-run</code> or the <code>--interactive</code>/<code>-i</code> flag.</p> 1481 <p>Here is an example run.</p> 1482 <p>Before - with duplicates</p> 1483 <pre><code>$ rclone lsl drive:dupes 1484 6048320 2016-03-05 16:23:16.798000000 one.txt 1485 6048320 2016-03-05 16:23:11.775000000 one.txt 1486 564374 2016-03-05 16:23:06.731000000 one.txt 1487 6048320 2016-03-05 16:18:26.092000000 one.txt 1488 6048320 2016-03-05 16:22:46.185000000 two.txt 1489 1744073 2016-03-05 16:22:38.104000000 two.txt 1490 564374 2016-03-05 16:22:52.118000000 two.txt</code></pre> 1491 <p>Now the <code>dedupe</code> session</p> 1492 <pre><code>$ rclone dedupe drive:dupes 1493 2016/03/05 16:24:37 Google drive root 'dupes': Looking for duplicates using interactive mode. 1494 one.txt: Found 4 files with duplicate names 1495 one.txt: Deleting 2/3 identical duplicates (MD5 "1eedaa9fe86fd4b8632e2ac549403b36") 1496 one.txt: 2 duplicates remain 1497 1: 6048320 bytes, 2016-03-05 16:23:16.798000000, MD5 1eedaa9fe86fd4b8632e2ac549403b36 1498 2: 564374 bytes, 2016-03-05 16:23:06.731000000, MD5 7594e7dc9fc28f727c42ee3e0749de81 1499 s) Skip and do nothing 1500 k) Keep just one (choose which in next step) 1501 r) Rename all to be different (by changing file.jpg to file-1.jpg) 1502 s/k/r> k 1503 Enter the number of the file to keep> 1 1504 one.txt: Deleted 1 extra copies 1505 two.txt: Found 3 files with duplicate names 1506 two.txt: 3 duplicates remain 1507 1: 564374 bytes, 2016-03-05 16:22:52.118000000, MD5 7594e7dc9fc28f727c42ee3e0749de81 1508 2: 6048320 bytes, 2016-03-05 16:22:46.185000000, MD5 1eedaa9fe86fd4b8632e2ac549403b36 1509 3: 1744073 bytes, 2016-03-05 16:22:38.104000000, MD5 851957f7fb6f0bc4ce76be966d336802 1510 s) Skip and do nothing 1511 k) Keep just one (choose which in next step) 1512 r) Rename all to be different (by changing file.jpg to file-1.jpg) 1513 s/k/r> r 1514 two-1.txt: renamed from: two.txt 1515 two-2.txt: renamed from: two.txt 1516 two-3.txt: renamed from: two.txt</code></pre> 1517 <p>The result being</p> 1518 <pre><code>$ rclone lsl drive:dupes 1519 6048320 2016-03-05 16:23:16.798000000 one.txt 1520 564374 2016-03-05 16:22:52.118000000 two-1.txt 1521 6048320 2016-03-05 16:22:46.185000000 two-2.txt 1522 1744073 2016-03-05 16:22:38.104000000 two-3.txt</code></pre> 1523 <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> 1524 <ul> 1525 <li><code>--dedupe-mode interactive</code> - interactive as above.</li> 1526 <li><code>--dedupe-mode skip</code> - removes identical files then skips anything left.</li> 1527 <li><code>--dedupe-mode first</code> - removes identical files then keeps the first one.</li> 1528 <li><code>--dedupe-mode newest</code> - removes identical files then keeps the newest one.</li> 1529 <li><code>--dedupe-mode oldest</code> - removes identical files then keeps the oldest one.</li> 1530 <li><code>--dedupe-mode largest</code> - removes identical files then keeps the largest one.</li> 1531 <li><code>--dedupe-mode smallest</code> - removes identical files then keeps the smallest one.</li> 1532 <li><code>--dedupe-mode rename</code> - removes identical files then renames the rest to be different.</li> 1533 <li><code>--dedupe-mode list</code> - lists duplicate dirs and files only and changes nothing.</li> 1534 </ul> 1535 <p>For example, to rename all the identically named photos in your Google Photos directory, do</p> 1536 <pre><code>rclone dedupe --dedupe-mode rename "drive:Google Photos"</code></pre> 1537 <p>Or</p> 1538 <pre><code>rclone dedupe rename "drive:Google Photos"</code></pre> 1539 <pre><code>rclone dedupe [mode] remote:path [flags]</code></pre> 1540 <h2 id="options-17">Options</h2> 1541 <pre><code> --by-hash Find identical hashes rather than names 1542 --dedupe-mode string Dedupe mode interactive|skip|first|newest|oldest|largest|smallest|rename (default "interactive") 1543 -h, --help help for dedupe</code></pre> 1544 <h2 id="important-options-8">Important Options</h2> 1545 <p>Important flags useful for most commands.</p> 1546 <pre><code> -n, --dry-run Do a trial run with no permanent changes 1547 -i, --interactive Enable interactive mode 1548 -v, --verbose count Print lots more stuff (repeat for more)</code></pre> 1549 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1550 <h1 id="see-also-17">SEE ALSO</h1> 1551 <ul> 1552 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1553 </ul> 1554 <h1 id="rclone-about">rclone about</h1> 1555 <p>Get quota information from the remote.</p> 1556 <h2 id="synopsis-17">Synopsis</h2> 1557 <p><code>rclone about</code> prints quota information about a remote to standard output. The output is typically used, free, quota and trash contents.</p> 1558 <p>E.g. Typical output from <code>rclone about remote:</code> is:</p> 1559 <pre><code>Total: 17 GiB 1560 Used: 7.444 GiB 1561 Free: 1.315 GiB 1562 Trashed: 100.000 MiB 1563 Other: 8.241 GiB</code></pre> 1564 <p>Where the fields are:</p> 1565 <ul> 1566 <li>Total: Total size available.</li> 1567 <li>Used: Total size used.</li> 1568 <li>Free: Total space available to this user.</li> 1569 <li>Trashed: Total space used by trash.</li> 1570 <li>Other: Total amount in other storage (e.g. Gmail, Google Photos).</li> 1571 <li>Objects: Total number of objects in the storage.</li> 1572 </ul> 1573 <p>All sizes are in number of bytes.</p> 1574 <p>Applying a <code>--full</code> flag to the command prints the bytes in full, e.g.</p> 1575 <pre><code>Total: 18253611008 1576 Used: 7993453766 1577 Free: 1411001220 1578 Trashed: 104857602 1579 Other: 8849156022</code></pre> 1580 <p>A <code>--json</code> flag generates conveniently machine-readable output, e.g.</p> 1581 <pre><code>{ 1582 "total": 18253611008, 1583 "used": 7993453766, 1584 "trashed": 104857602, 1585 "other": 8849156022, 1586 "free": 1411001220 1587 }</code></pre> 1588 <p>Not all backends print all fields. Information is not included if it is not provided by a backend. Where the value is unlimited it is omitted.</p> 1589 <p>Some backends does not support the <code>rclone about</code> command at all, see complete list in <a href="https://rclone.org/overview/#optional-features">documentation</a>.</p> 1590 <pre><code>rclone about remote: [flags]</code></pre> 1591 <h2 id="options-18">Options</h2> 1592 <pre><code> --full Full numbers instead of human-readable 1593 -h, --help help for about 1594 --json Format output as JSON</code></pre> 1595 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1596 <h1 id="see-also-18">SEE ALSO</h1> 1597 <ul> 1598 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1599 </ul> 1600 <h1 id="rclone-authorize">rclone authorize</h1> 1601 <p>Remote authorization.</p> 1602 <h2 id="synopsis-18">Synopsis</h2> 1603 <p>Remote authorization. Used to authorize a remote or headless rclone from a machine with a browser - use as instructed by rclone config.</p> 1604 <p>Use --auth-no-open-browser to prevent rclone to open auth link in default browser automatically.</p> 1605 <p>Use --template to generate HTML output via a custom Go template. If a blank string is provided as an argument to this flag, the default template is used.</p> 1606 <pre><code>rclone authorize [flags]</code></pre> 1607 <h2 id="options-19">Options</h2> 1608 <pre><code> --auth-no-open-browser Do not automatically open auth link in default browser 1609 -h, --help help for authorize 1610 --template string The path to a custom Go template for generating HTML responses</code></pre> 1611 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1612 <h1 id="see-also-19">SEE ALSO</h1> 1613 <ul> 1614 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1615 </ul> 1616 <h1 id="rclone-backend">rclone backend</h1> 1617 <p>Run a backend-specific command.</p> 1618 <h2 id="synopsis-19">Synopsis</h2> 1619 <p>This runs a backend-specific command. The commands themselves (except for "help" and "features") are defined by the backends and you should see the backend docs for definitions.</p> 1620 <p>You can discover what commands a backend implements by using</p> 1621 <pre><code>rclone backend help remote: 1622 rclone backend help <backendname></code></pre> 1623 <p>You can also discover information about the backend using (see <a href="https://rclone.org/rc/#operations-fsinfo">operations/fsinfo</a> in the remote control docs for more info).</p> 1624 <pre><code>rclone backend features remote:</code></pre> 1625 <p>Pass options to the backend command with -o. This should be key=value or key, e.g.:</p> 1626 <pre><code>rclone backend stats remote:path stats -o format=json -o long</code></pre> 1627 <p>Pass arguments to the backend by placing them on the end of the line</p> 1628 <pre><code>rclone backend cleanup remote:path file1 file2 file3</code></pre> 1629 <p>Note to run these commands on a running backend then see <a href="https://rclone.org/rc/#backend-command">backend/command</a> in the rc docs.</p> 1630 <pre><code>rclone backend <command> remote:path [opts] <args> [flags]</code></pre> 1631 <h2 id="options-20">Options</h2> 1632 <pre><code> -h, --help help for backend 1633 --json Always output in JSON format 1634 -o, --option stringArray Option in the form name=value or name</code></pre> 1635 <h2 id="important-options-9">Important Options</h2> 1636 <p>Important flags useful for most commands.</p> 1637 <pre><code> -n, --dry-run Do a trial run with no permanent changes 1638 -i, --interactive Enable interactive mode 1639 -v, --verbose count Print lots more stuff (repeat for more)</code></pre> 1640 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1641 <h1 id="see-also-20">SEE ALSO</h1> 1642 <ul> 1643 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1644 </ul> 1645 <h1 id="rclone-bisync">rclone bisync</h1> 1646 <p>Perform bidirectional synchronization between two paths.</p> 1647 <h2 id="synopsis-20">Synopsis</h2> 1648 <p>Perform bidirectional synchronization between two paths.</p> 1649 <p><a href="https://rclone.org/bisync/">Bisync</a> provides a bidirectional cloud sync solution in rclone. It retains the Path1 and Path2 filesystem listings from the prior run. On each successive run it will: - list files on Path1 and Path2, and check for changes on each side. Changes include <code>New</code>, <code>Newer</code>, <code>Older</code>, and <code>Deleted</code> files. - Propagate changes on Path1 to Path2, and vice-versa.</p> 1650 <p>Bisync is <strong>in beta</strong> and is considered an <strong>advanced command</strong>, so use with care. Make sure you have read and understood the entire <a href="https://rclone.org/bisync">manual</a> (especially the <a href="https://rclone.org/bisync/#limitations">Limitations</a> section) before using, or data loss can result. Questions can be asked in the <a href="https://forum.rclone.org/">Rclone Forum</a>.</p> 1651 <p>See <a href="https://rclone.org/bisync/">full bisync description</a> for details.</p> 1652 <pre><code>rclone bisync remote1:path1 remote2:path2 [flags]</code></pre> 1653 <h2 id="options-21">Options</h2> 1654 <pre><code> --backup-dir1 string --backup-dir for Path1. Must be a non-overlapping path on the same remote. 1655 --backup-dir2 string --backup-dir for Path2. Must be a non-overlapping path on the same remote. 1656 --check-access Ensure expected RCLONE_TEST files are found on both Path1 and Path2 filesystems, else abort. 1657 --check-filename string Filename for --check-access (default: RCLONE_TEST) 1658 --check-sync string Controls comparison of final listings: true|false|only (default: true) (default "true") 1659 --compare string Comma-separated list of bisync-specific compare options ex. 'size,modtime,checksum' (default: 'size,modtime') 1660 --conflict-loser ConflictLoserAction Action to take on the loser of a sync conflict (when there is a winner) or on both files (when there is no winner): , num, pathname, delete (default: num) 1661 --conflict-resolve string Automatically resolve conflicts by preferring the version that is: none, path1, path2, newer, older, larger, smaller (default: none) (default "none") 1662 --conflict-suffix string Suffix to use when renaming a --conflict-loser. Can be either one string or two comma-separated strings to assign different suffixes to Path1/Path2. (default: 'conflict') 1663 --create-empty-src-dirs Sync creation and deletion of empty directories. (Not compatible with --remove-empty-dirs) 1664 --download-hash Compute hash by downloading when otherwise unavailable. (warning: may be slow and use lots of data!) 1665 --filters-file string Read filtering patterns from a file 1666 --force Bypass --max-delete safety check and run the sync. Consider using with --verbose 1667 -h, --help help for bisync 1668 --ignore-listing-checksum Do not use checksums for listings (add --ignore-checksum to additionally skip post-copy checksum checks) 1669 --max-lock Duration Consider lock files older than this to be expired (default: 0 (never expire)) (minimum: 2m) (default 0s) 1670 --no-cleanup Retain working files (useful for troubleshooting and testing). 1671 --no-slow-hash Ignore listing checksums only on backends where they are slow 1672 --recover Automatically recover from interruptions without requiring --resync. 1673 --remove-empty-dirs Remove ALL empty directories at the final cleanup step. 1674 --resilient Allow future runs to retry after certain less-serious errors, instead of requiring --resync. Use at your own risk! 1675 -1, --resync Performs the resync run. Equivalent to --resync-mode path1. Consider using --verbose or --dry-run first. 1676 --resync-mode string During resync, prefer the version that is: path1, path2, newer, older, larger, smaller (default: path1 if --resync, otherwise none for no resync.) (default "none") 1677 --slow-hash-sync-only Ignore slow checksums for listings and deltas, but still consider them during sync calls. 1678 --workdir string Use custom working dir - useful for testing. (default: {WORKDIR})</code></pre> 1679 <h2 id="copy-options-3">Copy Options</h2> 1680 <p>Flags for anything which can Copy a file.</p> 1681 <pre><code> --check-first Do all the checks before starting transfers 1682 -c, --checksum Check for changes with size & checksum (if available, or fallback to size only). 1683 --compare-dest stringArray Include additional comma separated server-side paths during comparison 1684 --copy-dest stringArray Implies --compare-dest but also copies files from paths into destination 1685 --cutoff-mode HARD|SOFT|CAUTIOUS Mode to stop transfers when reaching the max transfer limit HARD|SOFT|CAUTIOUS (default HARD) 1686 --ignore-case-sync Ignore case when synchronizing 1687 --ignore-checksum Skip post copy check of checksums 1688 --ignore-existing Skip all files that exist on destination 1689 --ignore-size Ignore size when skipping use modtime or checksum 1690 -I, --ignore-times Don't skip items that match size and time - transfer all unconditionally 1691 --immutable Do not modify files, fail if existing files have been modified 1692 --inplace Download directly to destination file instead of atomic download to temp/rename 1693 --max-backlog int Maximum number of objects in sync or check backlog (default 10000) 1694 --max-duration Duration Maximum duration rclone will transfer data for (default 0s) 1695 --max-transfer SizeSuffix Maximum size of data to transfer (default off) 1696 -M, --metadata If set, preserve metadata when copying objects 1697 --modify-window Duration Max time diff to be considered the same (default 1ns) 1698 --multi-thread-chunk-size SizeSuffix Chunk size for multi-thread downloads / uploads, if not set by filesystem (default 64Mi) 1699 --multi-thread-cutoff SizeSuffix Use multi-thread downloads for files above this size (default 256Mi) 1700 --multi-thread-streams int Number of streams to use for multi-thread downloads (default 4) 1701 --multi-thread-write-buffer-size SizeSuffix In memory buffer size for writing when in multi-thread mode (default 128Ki) 1702 --no-check-dest Don't check the destination, copy regardless 1703 --no-traverse Don't traverse destination file system on copy 1704 --no-update-dir-modtime Don't update directory modification times 1705 --no-update-modtime Don't update destination modtime if files identical 1706 --order-by string Instructions on how to order the transfers, e.g. 'size,descending' 1707 --partial-suffix string Add partial-suffix to temporary file name when --inplace is not used (default ".partial") 1708 --refresh-times Refresh the modtime of remote files 1709 --server-side-across-configs Allow server-side operations (e.g. copy) to work across different configs 1710 --size-only Skip based on size only, not modtime or checksum 1711 --streaming-upload-cutoff SizeSuffix Cutoff for switching to chunked upload if file size is unknown, upload starts after reaching cutoff or when file ends (default 100Ki) 1712 -u, --update Skip files that are newer on the destination</code></pre> 1713 <h2 id="important-options-10">Important Options</h2> 1714 <p>Important flags useful for most commands.</p> 1715 <pre><code> -n, --dry-run Do a trial run with no permanent changes 1716 -i, --interactive Enable interactive mode 1717 -v, --verbose count Print lots more stuff (repeat for more)</code></pre> 1718 <h2 id="filter-options-11">Filter Options</h2> 1719 <p>Flags for filtering directory listings.</p> 1720 <pre><code> --delete-excluded Delete files on dest excluded from sync 1721 --exclude stringArray Exclude files matching pattern 1722 --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) 1723 --exclude-if-present stringArray Exclude directories if filename is present 1724 --files-from stringArray Read list of source-file names from file (use - to read from stdin) 1725 --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) 1726 -f, --filter stringArray Add a file filtering rule 1727 --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) 1728 --ignore-case Ignore case in filters (case insensitive) 1729 --include stringArray Include files matching pattern 1730 --include-from stringArray Read file include patterns from file (use - to read from stdin) 1731 --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) 1732 --max-depth int If set limits the recursion depth to this (default -1) 1733 --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) 1734 --metadata-exclude stringArray Exclude metadatas matching pattern 1735 --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) 1736 --metadata-filter stringArray Add a metadata filtering rule 1737 --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) 1738 --metadata-include stringArray Include metadatas matching pattern 1739 --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) 1740 --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) 1741 --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre> 1742 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1743 <h1 id="see-also-21">SEE ALSO</h1> 1744 <ul> 1745 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1746 </ul> 1747 <h1 id="rclone-cat">rclone cat</h1> 1748 <p>Concatenates any files and sends them to stdout.</p> 1749 <h2 id="synopsis-21">Synopsis</h2> 1750 <p>rclone cat sends any files to standard output.</p> 1751 <p>You can use it like this to output a single file</p> 1752 <pre><code>rclone cat remote:path/to/file</code></pre> 1753 <p>Or like this to output any file in dir or its subdirectories.</p> 1754 <pre><code>rclone cat remote:path/to/dir</code></pre> 1755 <p>Or like this to output any .txt files in dir or its subdirectories.</p> 1756 <pre><code>rclone --include "*.txt" cat remote:path/to/dir</code></pre> 1757 <p>Use the <code>--head</code> flag to print characters only at the start, <code>--tail</code> for the end and <code>--offset</code> and <code>--count</code> to print a section in the middle. Note that if offset is negative it will count from the end, so <code>--offset -1 --count 1</code> is equivalent to <code>--tail 1</code>.</p> 1758 <p>Use the <code>--separator</code> flag to print a separator value between files. Be sure to shell-escape special characters. For example, to print a newline between files, use:</p> 1759 <ul> 1760 <li><p>bash:</p> 1761 <pre><code>rclone --include "*.txt" --separator $'\n' cat remote:path/to/dir</code></pre></li> 1762 <li><p>powershell:</p> 1763 <pre><code>rclone --include "*.txt" --separator "`n" cat remote:path/to/dir</code></pre></li> 1764 </ul> 1765 <pre><code>rclone cat remote:path [flags]</code></pre> 1766 <h2 id="options-22">Options</h2> 1767 <pre><code> --count int Only print N characters (default -1) 1768 --discard Discard the output instead of printing 1769 --head int Only print the first N characters 1770 -h, --help help for cat 1771 --offset int Start printing at offset N (or from end if -ve) 1772 --separator string Separator to use between objects when printing multiple files 1773 --tail int Only print the last N characters</code></pre> 1774 <h2 id="filter-options-12">Filter Options</h2> 1775 <p>Flags for filtering directory listings.</p> 1776 <pre><code> --delete-excluded Delete files on dest excluded from sync 1777 --exclude stringArray Exclude files matching pattern 1778 --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) 1779 --exclude-if-present stringArray Exclude directories if filename is present 1780 --files-from stringArray Read list of source-file names from file (use - to read from stdin) 1781 --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) 1782 -f, --filter stringArray Add a file filtering rule 1783 --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) 1784 --ignore-case Ignore case in filters (case insensitive) 1785 --include stringArray Include files matching pattern 1786 --include-from stringArray Read file include patterns from file (use - to read from stdin) 1787 --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) 1788 --max-depth int If set limits the recursion depth to this (default -1) 1789 --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) 1790 --metadata-exclude stringArray Exclude metadatas matching pattern 1791 --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) 1792 --metadata-filter stringArray Add a metadata filtering rule 1793 --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) 1794 --metadata-include stringArray Include metadatas matching pattern 1795 --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) 1796 --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) 1797 --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre> 1798 <h2 id="listing-options-11">Listing Options</h2> 1799 <p>Flags for listing directories.</p> 1800 <pre><code> --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) 1801 --fast-list Use recursive list if available; uses more memory but fewer transactions</code></pre> 1802 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1803 <h1 id="see-also-22">SEE ALSO</h1> 1804 <ul> 1805 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1806 </ul> 1807 <h1 id="rclone-checksum">rclone checksum</h1> 1808 <p>Checks the files in the destination against a SUM file.</p> 1809 <h2 id="synopsis-22">Synopsis</h2> 1810 <p>Checks that hashsums of destination files match the SUM file. It compares hashes (MD5, SHA1, etc) and logs a report of files which don't match. It doesn't alter the file system.</p> 1811 <p>The sumfile is treated as the source and the dst:path is treated as the destination for the purposes of the output.</p> 1812 <p>If you supply the <code>--download</code> flag, it will download the data from the remote and calculate the content hash on the fly. This can be useful for remotes that don't support hashes or if you really want to check all the data.</p> 1813 <p>Note that hash values in the SUM file are treated as case insensitive.</p> 1814 <p>If you supply the <code>--one-way</code> flag, it will only check that files in the source match the files in the destination, not the other way around. This means that extra files in the destination that are not in the source will not be detected.</p> 1815 <p>The <code>--differ</code>, <code>--missing-on-dst</code>, <code>--missing-on-src</code>, <code>--match</code> and <code>--error</code> flags write paths, one per line, to the file name (or stdout if it is <code>-</code>) supplied. What they write is described in the help below. For example <code>--differ</code> will write all paths which are present on both the source and destination but different.</p> 1816 <p>The <code>--combined</code> flag will write a file (or stdout) which contains all file paths with a symbol and then a space and then the path to tell you what happened to it. These are reminiscent of diff files.</p> 1817 <ul> 1818 <li><code>= path</code> means path was found in source and destination and was identical</li> 1819 <li>`- path` means path was missing on the source, so only in the destination</li> 1820 <li>`+ path` means path was missing on the destination, so only in the source</li> 1821 <li>`* path` means path was present in source and destination but different.</li> 1822 <li><code>! path</code> means there was an error reading or hashing the source or dest.</li> 1823 </ul> 1824 <p>The default number of parallel checks is 8. See the <a href="https://rclone.org/docs/#checkers-n">--checkers=N</a> option for more information.</p> 1825 <pre><code>rclone checksum <hash> sumfile dst:path [flags]</code></pre> 1826 <h2 id="options-23">Options</h2> 1827 <pre><code> --combined string Make a combined report of changes to this file 1828 --differ string Report all non-matching files to this file 1829 --download Check by hashing the contents 1830 --error string Report all files with errors (hashing or reading) to this file 1831 -h, --help help for checksum 1832 --match string Report all matching files to this file 1833 --missing-on-dst string Report all files missing from the destination to this file 1834 --missing-on-src string Report all files missing from the source to this file 1835 --one-way Check one way only, source files must exist on remote</code></pre> 1836 <h2 id="filter-options-13">Filter Options</h2> 1837 <p>Flags for filtering directory listings.</p> 1838 <pre><code> --delete-excluded Delete files on dest excluded from sync 1839 --exclude stringArray Exclude files matching pattern 1840 --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) 1841 --exclude-if-present stringArray Exclude directories if filename is present 1842 --files-from stringArray Read list of source-file names from file (use - to read from stdin) 1843 --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) 1844 -f, --filter stringArray Add a file filtering rule 1845 --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) 1846 --ignore-case Ignore case in filters (case insensitive) 1847 --include stringArray Include files matching pattern 1848 --include-from stringArray Read file include patterns from file (use - to read from stdin) 1849 --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) 1850 --max-depth int If set limits the recursion depth to this (default -1) 1851 --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) 1852 --metadata-exclude stringArray Exclude metadatas matching pattern 1853 --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) 1854 --metadata-filter stringArray Add a metadata filtering rule 1855 --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) 1856 --metadata-include stringArray Include metadatas matching pattern 1857 --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) 1858 --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) 1859 --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre> 1860 <h2 id="listing-options-12">Listing Options</h2> 1861 <p>Flags for listing directories.</p> 1862 <pre><code> --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) 1863 --fast-list Use recursive list if available; uses more memory but fewer transactions</code></pre> 1864 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1865 <h1 id="see-also-23">SEE ALSO</h1> 1866 <ul> 1867 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1868 </ul> 1869 <h1 id="rclone-completion">rclone completion</h1> 1870 <p>Output completion script for a given shell.</p> 1871 <h2 id="synopsis-23">Synopsis</h2> 1872 <p>Generates a shell completion script for rclone. Run with <code>--help</code> to list the supported shells.</p> 1873 <h2 id="options-24">Options</h2> 1874 <pre><code> -h, --help help for completion</code></pre> 1875 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1876 <h1 id="see-also-24">SEE ALSO</h1> 1877 <ul> 1878 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 1879 <li><a href="https://rclone.org/commands/rclone_completion_bash/">rclone completion bash</a> - Output bash completion script for rclone.</li> 1880 <li><a href="https://rclone.org/commands/rclone_completion_fish/">rclone completion fish</a> - Output fish completion script for rclone.</li> 1881 <li><a href="https://rclone.org/commands/rclone_completion_powershell/">rclone completion powershell</a> - Output powershell completion script for rclone.</li> 1882 <li><a href="https://rclone.org/commands/rclone_completion_zsh/">rclone completion zsh</a> - Output zsh completion script for rclone.</li> 1883 </ul> 1884 <h1 id="rclone-completion-bash">rclone completion bash</h1> 1885 <p>Output bash completion script for rclone.</p> 1886 <h2 id="synopsis-24">Synopsis</h2> 1887 <p>Generates a bash shell autocompletion script for rclone.</p> 1888 <p>This writes to /etc/bash_completion.d/rclone by default so will probably need to be run with sudo or as root, e.g.</p> 1889 <pre><code>sudo rclone genautocomplete bash</code></pre> 1890 <p>Logout and login again to use the autocompletion scripts, or source them directly</p> 1891 <pre><code>. /etc/bash_completion</code></pre> 1892 <p>If you supply a command line argument the script will be written there.</p> 1893 <p>If output_file is "-", then the output will be written to stdout.</p> 1894 <pre><code>rclone completion bash [output_file] [flags]</code></pre> 1895 <h2 id="options-25">Options</h2> 1896 <pre><code> -h, --help help for bash</code></pre> 1897 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1898 <h1 id="see-also-25">SEE ALSO</h1> 1899 <ul> 1900 <li><a href="https://rclone.org/commands/rclone_completion/">rclone completion</a> - Output completion script for a given shell.</li> 1901 </ul> 1902 <h1 id="rclone-completion-fish">rclone completion fish</h1> 1903 <p>Output fish completion script for rclone.</p> 1904 <h2 id="synopsis-25">Synopsis</h2> 1905 <p>Generates a fish autocompletion script for rclone.</p> 1906 <p>This writes to /etc/fish/completions/rclone.fish by default so will probably need to be run with sudo or as root, e.g.</p> 1907 <pre><code>sudo rclone genautocomplete fish</code></pre> 1908 <p>Logout and login again to use the autocompletion scripts, or source them directly</p> 1909 <pre><code>. /etc/fish/completions/rclone.fish</code></pre> 1910 <p>If you supply a command line argument the script will be written there.</p> 1911 <p>If output_file is "-", then the output will be written to stdout.</p> 1912 <pre><code>rclone completion fish [output_file] [flags]</code></pre> 1913 <h2 id="options-26">Options</h2> 1914 <pre><code> -h, --help help for fish</code></pre> 1915 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1916 <h1 id="see-also-26">SEE ALSO</h1> 1917 <ul> 1918 <li><a href="https://rclone.org/commands/rclone_completion/">rclone completion</a> - Output completion script for a given shell.</li> 1919 </ul> 1920 <h1 id="rclone-completion-powershell">rclone completion powershell</h1> 1921 <p>Output powershell completion script for rclone.</p> 1922 <h2 id="synopsis-26">Synopsis</h2> 1923 <p>Generate the autocompletion script for powershell.</p> 1924 <p>To load completions in your current shell session:</p> 1925 <pre><code>rclone completion powershell | Out-String | Invoke-Expression</code></pre> 1926 <p>To load completions for every new session, add the output of the above command to your powershell profile.</p> 1927 <p>If output_file is "-" or missing, then the output will be written to stdout.</p> 1928 <pre><code>rclone completion powershell [output_file] [flags]</code></pre> 1929 <h2 id="options-27">Options</h2> 1930 <pre><code> -h, --help help for powershell</code></pre> 1931 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1932 <h1 id="see-also-27">SEE ALSO</h1> 1933 <ul> 1934 <li><a href="https://rclone.org/commands/rclone_completion/">rclone completion</a> - Output completion script for a given shell.</li> 1935 </ul> 1936 <h1 id="rclone-completion-zsh">rclone completion zsh</h1> 1937 <p>Output zsh completion script for rclone.</p> 1938 <h2 id="synopsis-27">Synopsis</h2> 1939 <p>Generates a zsh autocompletion script for rclone.</p> 1940 <p>This writes to /usr/share/zsh/vendor-completions/_rclone by default so will probably need to be run with sudo or as root, e.g.</p> 1941 <pre><code>sudo rclone genautocomplete zsh</code></pre> 1942 <p>Logout and login again to use the autocompletion scripts, or source them directly</p> 1943 <pre><code>autoload -U compinit && compinit</code></pre> 1944 <p>If you supply a command line argument the script will be written there.</p> 1945 <p>If output_file is "-", then the output will be written to stdout.</p> 1946 <pre><code>rclone completion zsh [output_file] [flags]</code></pre> 1947 <h2 id="options-28">Options</h2> 1948 <pre><code> -h, --help help for zsh</code></pre> 1949 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 1950 <h1 id="see-also-28">SEE ALSO</h1> 1951 <ul> 1952 <li><a href="https://rclone.org/commands/rclone_completion/">rclone completion</a> - Output completion script for a given shell.</li> 1953 </ul> 1954 <h1 id="rclone-config-create">rclone config create</h1> 1955 <p>Create a new remote with name, type and options.</p> 1956 <h2 id="synopsis-28">Synopsis</h2> 1957 <p>Create a new remote of <code>name</code> with <code>type</code> and options. The options should be passed in pairs of <code>key</code> <code>value</code> or as <code>key=value</code>.</p> 1958 <p>For example, to make a swift remote of name myremote using auto config you would do:</p> 1959 <pre><code>rclone config create myremote swift env_auth true 1960 rclone config create myremote swift env_auth=true</code></pre> 1961 <p>So for example if you wanted to configure a Google Drive remote but using remote authorization you would do this:</p> 1962 <pre><code>rclone config create mydrive drive config_is_local=false</code></pre> 1963 <p>Note that if the config process would normally ask a question the default is taken (unless <code>--non-interactive</code> is used). Each time that happens rclone will print or DEBUG a message saying how to affect the value taken.</p> 1964 <p>If any of the parameters passed is a password field, then rclone will automatically obscure them if they aren't already obscured before putting them in the config file.</p> 1965 <p><strong>NB</strong> If the password parameter is 22 characters or longer and consists only of base64 characters then rclone can get confused about whether the password is already obscured or not and put unobscured passwords into the config file. If you want to be 100% certain that the passwords get obscured then use the <code>--obscure</code> flag, or if you are 100% certain you are already passing obscured passwords then use <code>--no-obscure</code>. You can also set obscured passwords using the <code>rclone config password</code> command.</p> 1966 <p>The flag <code>--non-interactive</code> is for use by applications that wish to configure rclone themselves, rather than using rclone's text based configuration questions. If this flag is set, and rclone needs to ask the user a question, a JSON blob will be returned with the question in it.</p> 1967 <p>This will look something like (some irrelevant detail removed):</p> 1968 <pre><code>{ 1969 "State": "*oauth-islocal,teamdrive,,", 1970 "Option": { 1971 "Name": "config_is_local", 1972 "Help": "Use web browser to automatically authenticate rclone with remote?\n * Say Y if the machine running rclone has a web browser you can use\n * Say N if running rclone on a (remote) machine without web browser access\nIf not sure try Y. If Y failed, try N.\n", 1973 "Default": true, 1974 "Examples": [ 1975 { 1976 "Value": "true", 1977 "Help": "Yes" 1978 }, 1979 { 1980 "Value": "false", 1981 "Help": "No" 1982 } 1983 ], 1984 "Required": false, 1985 "IsPassword": false, 1986 "Type": "bool", 1987 "Exclusive": true, 1988 }, 1989 "Error": "", 1990 }</code></pre> 1991 <p>The format of <code>Option</code> is the same as returned by <code>rclone config providers</code>. The question should be asked to the user and returned to rclone as the <code>--result</code> option along with the <code>--state</code> parameter.</p> 1992 <p>The keys of <code>Option</code> are used as follows:</p> 1993 <ul> 1994 <li><code>Name</code> - name of variable - show to user</li> 1995 <li><code>Help</code> - help text. Hard wrapped at 80 chars. Any URLs should be clicky.</li> 1996 <li><code>Default</code> - default value - return this if the user just wants the default.</li> 1997 <li><code>Examples</code> - the user should be able to choose one of these</li> 1998 <li><code>Required</code> - the value should be non-empty</li> 1999 <li><code>IsPassword</code> - the value is a password and should be edited as such</li> 2000 <li><code>Type</code> - type of value, eg <code>bool</code>, <code>string</code>, <code>int</code> and others</li> 2001 <li><code>Exclusive</code> - if set no free-form entry allowed only the <code>Examples</code></li> 2002 <li>Irrelevant keys <code>Provider</code>, <code>ShortOpt</code>, <code>Hide</code>, <code>NoPrefix</code>, <code>Advanced</code></li> 2003 </ul> 2004 <p>If <code>Error</code> is set then it should be shown to the user at the same time as the question.</p> 2005 <pre><code>rclone config update name --continue --state "*oauth-islocal,teamdrive,," --result "true"</code></pre> 2006 <p>Note that when using <code>--continue</code> all passwords should be passed in the clear (not obscured). Any default config values should be passed in with each invocation of <code>--continue</code>.</p> 2007 <p>At the end of the non interactive process, rclone will return a result with <code>State</code> as empty string.</p> 2008 <p>If <code>--all</code> is passed then rclone will ask all the config questions, not just the post config questions. Any parameters are used as defaults for questions as usual.</p> 2009 <p>Note that <code>bin/config.py</code> in the rclone source implements this protocol as a readable demonstration.</p> 2010 <pre><code>rclone config create name type [key value]* [flags]</code></pre> 2011 <h2 id="options-29">Options</h2> 2012 <pre><code> --all Ask the full set of config questions 2013 --continue Continue the configuration process with an answer 2014 -h, --help help for create 2015 --no-obscure Force any passwords not to be obscured 2016 --non-interactive Don't interact with user and return questions 2017 --obscure Force any passwords to be obscured 2018 --result string Result - use with --continue 2019 --state string State - use with --continue</code></pre> 2020 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 2021 <h1 id="see-also-29">SEE ALSO</h1> 2022 <ul> 2023 <li><a href="https://rclone.org/commands/rclone_config/">rclone config</a> - Enter an interactive configuration session.</li> 2024 </ul> 2025 <h1 id="rclone-config-delete">rclone config delete</h1> 2026 <p>Delete an existing remote.</p> 2027 <pre><code>rclone config delete name [flags]</code></pre> 2028 <h2 id="options-30">Options</h2> 2029 <pre><code> -h, --help help for delete</code></pre> 2030 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 2031 <h1 id="see-also-30">SEE ALSO</h1> 2032 <ul> 2033 <li><a href="https://rclone.org/commands/rclone_config/">rclone config</a> - Enter an interactive configuration session.</li> 2034 </ul> 2035 <h1 id="rclone-config-disconnect">rclone config disconnect</h1> 2036 <p>Disconnects user from remote</p> 2037 <h2 id="synopsis-29">Synopsis</h2> 2038 <p>This disconnects the remote: passed in to the cloud storage system.</p> 2039 <p>This normally means revoking the oauth token.</p> 2040 <p>To reconnect use "rclone config reconnect".</p> 2041 <pre><code>rclone config disconnect remote: [flags]</code></pre> 2042 <h2 id="options-31">Options</h2> 2043 <pre><code> -h, --help help for disconnect</code></pre> 2044 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 2045 <h1 id="see-also-31">SEE ALSO</h1> 2046 <ul> 2047 <li><a href="https://rclone.org/commands/rclone_config/">rclone config</a> - Enter an interactive configuration session.</li> 2048 </ul> 2049 <h1 id="rclone-config-dump">rclone config dump</h1> 2050 <p>Dump the config file as JSON.</p> 2051 <pre><code>rclone config dump [flags]</code></pre> 2052 <h2 id="options-32">Options</h2> 2053 <pre><code> -h, --help help for dump</code></pre> 2054 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 2055 <h1 id="see-also-32">SEE ALSO</h1> 2056 <ul> 2057 <li><a href="https://rclone.org/commands/rclone_config/">rclone config</a> - Enter an interactive configuration session.</li> 2058 </ul> 2059 <h1 id="rclone-config-edit">rclone config edit</h1> 2060 <p>Enter an interactive configuration session.</p> 2061 <h2 id="synopsis-30">Synopsis</h2> 2062 <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> 2063 <pre><code>rclone config edit [flags]</code></pre> 2064 <h2 id="options-33">Options</h2> 2065 <pre><code> -h, --help help for edit</code></pre> 2066 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 2067 <h1 id="see-also-33">SEE ALSO</h1> 2068 <ul> 2069 <li><a href="https://rclone.org/commands/rclone_config/">rclone config</a> - Enter an interactive configuration session.</li> 2070 </ul> 2071 <h1 id="rclone-config-file">rclone config file</h1> 2072 <p>Show path of configuration file in use.</p> 2073 <pre><code>rclone config file [flags]</code></pre> 2074 <h2 id="options-34">Options</h2> 2075 <pre><code> -h, --help help for file</code></pre> 2076 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 2077 <h1 id="see-also-34">SEE ALSO</h1> 2078 <ul> 2079 <li><a href="https://rclone.org/commands/rclone_config/">rclone config</a> - Enter an interactive configuration session.</li> 2080 </ul> 2081 <h1 id="rclone-config-password">rclone config password</h1> 2082 <p>Update password in an existing remote.</p> 2083 <h2 id="synopsis-31">Synopsis</h2> 2084 <p>Update an existing remote's password. The password should be passed in pairs of <code>key</code> <code>password</code> or as <code>key=password</code>. The <code>password</code> should be passed in in clear (unobscured).</p> 2085 <p>For example, to set password of a remote of name myremote you would do:</p> 2086 <pre><code>rclone config password myremote fieldname mypassword 2087 rclone config password myremote fieldname=mypassword</code></pre> 2088 <p>This command is obsolete now that "config update" and "config create" both support obscuring passwords directly.</p> 2089 <pre><code>rclone config password name [key value]+ [flags]</code></pre> 2090 <h2 id="options-35">Options</h2> 2091 <pre><code> -h, --help help for password</code></pre> 2092 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 2093 <h1 id="see-also-35">SEE ALSO</h1> 2094 <ul> 2095 <li><a href="https://rclone.org/commands/rclone_config/">rclone config</a> - Enter an interactive configuration session.</li> 2096 </ul> 2097 <h1 id="rclone-config-paths">rclone config paths</h1> 2098 <p>Show paths used for configuration, cache, temp etc.</p> 2099 <pre><code>rclone config paths [flags]</code></pre> 2100 <h2 id="options-36">Options</h2> 2101 <pre><code> -h, --help help for paths</code></pre> 2102 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 2103 <h1 id="see-also-36">SEE ALSO</h1> 2104 <ul> 2105 <li><a href="https://rclone.org/commands/rclone_config/">rclone config</a> - Enter an interactive configuration session.</li> 2106 </ul> 2107 <h1 id="rclone-config-providers">rclone config providers</h1> 2108 <p>List in JSON format all the providers and options.</p> 2109 <pre><code>rclone config providers [flags]</code></pre> 2110 <h2 id="options-37">Options</h2> 2111 <pre><code> -h, --help help for providers</code></pre> 2112 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 2113 <h1 id="see-also-37">SEE ALSO</h1> 2114 <ul> 2115 <li><a href="https://rclone.org/commands/rclone_config/">rclone config</a> - Enter an interactive configuration session.</li> 2116 </ul> 2117 <h1 id="rclone-config-reconnect">rclone config reconnect</h1> 2118 <p>Re-authenticates user with remote.</p> 2119 <h2 id="synopsis-32">Synopsis</h2> 2120 <p>This reconnects remote: passed in to the cloud storage system.</p> 2121 <p>To disconnect the remote use "rclone config disconnect".</p> 2122 <p>This normally means going through the interactive oauth flow again.</p> 2123 <pre><code>rclone config reconnect remote: [flags]</code></pre> 2124 <h2 id="options-38">Options</h2> 2125 <pre><code> -h, --help help for reconnect</code></pre> 2126 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 2127 <h1 id="see-also-38">SEE ALSO</h1> 2128 <ul> 2129 <li><a href="https://rclone.org/commands/rclone_config/">rclone config</a> - Enter an interactive configuration session.</li> 2130 </ul> 2131 <h1 id="rclone-config-redacted">rclone config redacted</h1> 2132 <p>Print redacted (decrypted) config file, or the redacted config for a single remote.</p> 2133 <h2 id="synopsis-33">Synopsis</h2> 2134 <p>This prints a redacted copy of the config file, either the whole config file or for a given remote.</p> 2135 <p>The config file will be redacted by replacing all passwords and other sensitive info with XXX.</p> 2136 <p>This makes the config file suitable for posting online for support.</p> 2137 <p>It should be double checked before posting as the redaction may not be perfect.</p> 2138 <pre><code>rclone config redacted [<remote>] [flags]</code></pre> 2139 <h2 id="options-39">Options</h2> 2140 <pre><code> -h, --help help for redacted</code></pre> 2141 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 2142 <h1 id="see-also-39">SEE ALSO</h1> 2143 <ul> 2144 <li><a href="https://rclone.org/commands/rclone_config/">rclone config</a> - Enter an interactive configuration session.</li> 2145 </ul> 2146 <h1 id="rclone-config-show">rclone config show</h1> 2147 <p>Print (decrypted) config file, or the config for a single remote.</p> 2148 <pre><code>rclone config show [<remote>] [flags]</code></pre> 2149 <h2 id="options-40">Options</h2> 2150 <pre><code> -h, --help help for show</code></pre> 2151 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 2152 <h1 id="see-also-40">SEE ALSO</h1> 2153 <ul> 2154 <li><a href="https://rclone.org/commands/rclone_config/">rclone config</a> - Enter an interactive configuration session.</li> 2155 </ul> 2156 <h1 id="rclone-config-touch">rclone config touch</h1> 2157 <p>Ensure configuration file exists.</p> 2158 <pre><code>rclone config touch [flags]</code></pre> 2159 <h2 id="options-41">Options</h2> 2160 <pre><code> -h, --help help for touch</code></pre> 2161 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 2162 <h1 id="see-also-41">SEE ALSO</h1> 2163 <ul> 2164 <li><a href="https://rclone.org/commands/rclone_config/">rclone config</a> - Enter an interactive configuration session.</li> 2165 </ul> 2166 <h1 id="rclone-config-update">rclone config update</h1> 2167 <p>Update options in an existing remote.</p> 2168 <h2 id="synopsis-34">Synopsis</h2> 2169 <p>Update an existing remote's options. The options should be passed in pairs of <code>key</code> <code>value</code> or as <code>key=value</code>.</p> 2170 <p>For example, to update the env_auth field of a remote of name myremote you would do:</p> 2171 <pre><code>rclone config update myremote env_auth true 2172 rclone config update myremote env_auth=true</code></pre> 2173 <p>If the remote uses OAuth the token will be updated, if you don't require this add an extra parameter thus:</p> 2174 <pre><code>rclone config update myremote env_auth=true config_refresh_token=false</code></pre> 2175 <p>Note that if the config process would normally ask a question the default is taken (unless <code>--non-interactive</code> is used). Each time that happens rclone will print or DEBUG a message saying how to affect the value taken.</p> 2176 <p>If any of the parameters passed is a password field, then rclone will automatically obscure them if they aren't already obscured before putting them in the config file.</p> 2177 <p><strong>NB</strong> If the password parameter is 22 characters or longer and consists only of base64 characters then rclone can get confused about whether the password is already obscured or not and put unobscured passwords into the config file. If you want to be 100% certain that the passwords get obscured then use the <code>--obscure</code> flag, or if you are 100% certain you are already passing obscured passwords then use <code>--no-obscure</code>. You can also set obscured passwords using the <code>rclone config password</code> command.</p> 2178 <p>The flag <code>--non-interactive</code> is for use by applications that wish to configure rclone themselves, rather than using rclone's text based configuration questions. If this flag is set, and rclone needs to ask the user a question, a JSON blob will be returned with the question in it.</p> 2179 <p>This will look something like (some irrelevant detail removed):</p> 2180 <pre><code>{ 2181 "State": "*oauth-islocal,teamdrive,,", 2182 "Option": { 2183 "Name": "config_is_local", 2184 "Help": "Use web browser to automatically authenticate rclone with remote?\n * Say Y if the machine running rclone has a web browser you can use\n * Say N if running rclone on a (remote) machine without web browser access\nIf not sure try Y. If Y failed, try N.\n", 2185 "Default": true, 2186 "Examples": [ 2187 { 2188 "Value": "true", 2189 "Help": "Yes" 2190 }, 2191 { 2192 "Value": "false", 2193 "Help": "No" 2194 } 2195 ], 2196 "Required": false, 2197 "IsPassword": false, 2198 "Type": "bool", 2199 "Exclusive": true, 2200 }, 2201 "Error": "", 2202 }</code></pre> 2203 <p>The format of <code>Option</code> is the same as returned by <code>rclone config providers</code>. The question should be asked to the user and returned to rclone as the <code>--result</code> option along with the <code>--state</code> parameter.</p> 2204 <p>The keys of <code>Option</code> are used as follows:</p> 2205 <ul> 2206 <li><code>Name</code> - name of variable - show to user</li> 2207 <li><code>Help</code> - help text. Hard wrapped at 80 chars. Any URLs should be clicky.</li> 2208 <li><code>Default</code> - default value - return this if the user just wants the default.</li> 2209 <li><code>Examples</code> - the user should be able to choose one of these</li> 2210 <li><code>Required</code> - the value should be non-empty</li> 2211 <li><code>IsPassword</code> - the value is a password and should be edited as such</li> 2212 <li><code>Type</code> - type of value, eg <code>bool</code>, <code>string</code>, <code>int</code> and others</li> 2213 <li><code>Exclusive</code> - if set no free-form entry allowed only the <code>Examples</code></li> 2214 <li>Irrelevant keys <code>Provider</code>, <code>ShortOpt</code>, <code>Hide</code>, <code>NoPrefix</code>, <code>Advanced</code></li> 2215 </ul> 2216 <p>If <code>Error</code> is set then it should be shown to the user at the same time as the question.</p> 2217 <pre><code>rclone config update name --continue --state "*oauth-islocal,teamdrive,," --result "true"</code></pre> 2218 <p>Note that when using <code>--continue</code> all passwords should be passed in the clear (not obscured). Any default config values should be passed in with each invocation of <code>--continue</code>.</p> 2219 <p>At the end of the non interactive process, rclone will return a result with <code>State</code> as empty string.</p> 2220 <p>If <code>--all</code> is passed then rclone will ask all the config questions, not just the post config questions. Any parameters are used as defaults for questions as usual.</p> 2221 <p>Note that <code>bin/config.py</code> in the rclone source implements this protocol as a readable demonstration.</p> 2222 <pre><code>rclone config update name [key value]+ [flags]</code></pre> 2223 <h2 id="options-42">Options</h2> 2224 <pre><code> --all Ask the full set of config questions 2225 --continue Continue the configuration process with an answer 2226 -h, --help help for update 2227 --no-obscure Force any passwords not to be obscured 2228 --non-interactive Don't interact with user and return questions 2229 --obscure Force any passwords to be obscured 2230 --result string Result - use with --continue 2231 --state string State - use with --continue</code></pre> 2232 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 2233 <h1 id="see-also-42">SEE ALSO</h1> 2234 <ul> 2235 <li><a href="https://rclone.org/commands/rclone_config/">rclone config</a> - Enter an interactive configuration session.</li> 2236 </ul> 2237 <h1 id="rclone-config-userinfo">rclone config userinfo</h1> 2238 <p>Prints info about logged in user of remote.</p> 2239 <h2 id="synopsis-35">Synopsis</h2> 2240 <p>This prints the details of the person logged in to the cloud storage system.</p> 2241 <pre><code>rclone config userinfo remote: [flags]</code></pre> 2242 <h2 id="options-43">Options</h2> 2243 <pre><code> -h, --help help for userinfo 2244 --json Format output as JSON</code></pre> 2245 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 2246 <h1 id="see-also-43">SEE ALSO</h1> 2247 <ul> 2248 <li><a href="https://rclone.org/commands/rclone_config/">rclone config</a> - Enter an interactive configuration session.</li> 2249 </ul> 2250 <h1 id="rclone-copyto">rclone copyto</h1> 2251 <p>Copy files from source to dest, skipping identical files.</p> 2252 <h2 id="synopsis-36">Synopsis</h2> 2253 <p>If source:path is a file or directory then it copies it to a file or directory named dest:path.</p> 2254 <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 <a href="https://rclone.org/commands/rclone_copy/">copy</a> command.</p> 2255 <p>So</p> 2256 <pre><code>rclone copyto src dst</code></pre> 2257 <p>where src and dst are rclone paths, either remote:path or /path/to/local or C:.</p> 2258 <p>This will:</p> 2259 <pre><code>if src is file 2260 copy it to dst, overwriting an existing file if it exists 2261 if src is directory 2262 copy it to dst, overwriting existing files if they exist 2263 see copy command for full details</code></pre> 2264 <p>This doesn't transfer files that are identical on src and dst, testing by size and modification time or MD5SUM. It doesn't delete files from the destination.</p> 2265 <p><strong>Note</strong>: Use the <code>-P</code>/<code>--progress</code> flag to view real-time transfer statistics</p> 2266 <pre><code>rclone copyto source:path dest:path [flags]</code></pre> 2267 <h2 id="options-44">Options</h2> 2268 <pre><code> -h, --help help for copyto</code></pre> 2269 <h2 id="copy-options-4">Copy Options</h2> 2270 <p>Flags for anything which can Copy a file.</p> 2271 <pre><code> --check-first Do all the checks before starting transfers 2272 -c, --checksum Check for changes with size & checksum (if available, or fallback to size only). 2273 --compare-dest stringArray Include additional comma separated server-side paths during comparison 2274 --copy-dest stringArray Implies --compare-dest but also copies files from paths into destination 2275 --cutoff-mode HARD|SOFT|CAUTIOUS Mode to stop transfers when reaching the max transfer limit HARD|SOFT|CAUTIOUS (default HARD) 2276 --ignore-case-sync Ignore case when synchronizing 2277 --ignore-checksum Skip post copy check of checksums 2278 --ignore-existing Skip all files that exist on destination 2279 --ignore-size Ignore size when skipping use modtime or checksum 2280 -I, --ignore-times Don't skip items that match size and time - transfer all unconditionally 2281 --immutable Do not modify files, fail if existing files have been modified 2282 --inplace Download directly to destination file instead of atomic download to temp/rename 2283 --max-backlog int Maximum number of objects in sync or check backlog (default 10000) 2284 --max-duration Duration Maximum duration rclone will transfer data for (default 0s) 2285 --max-transfer SizeSuffix Maximum size of data to transfer (default off) 2286 -M, --metadata If set, preserve metadata when copying objects 2287 --modify-window Duration Max time diff to be considered the same (default 1ns) 2288 --multi-thread-chunk-size SizeSuffix Chunk size for multi-thread downloads / uploads, if not set by filesystem (default 64Mi) 2289 --multi-thread-cutoff SizeSuffix Use multi-thread downloads for files above this size (default 256Mi) 2290 --multi-thread-streams int Number of streams to use for multi-thread downloads (default 4) 2291 --multi-thread-write-buffer-size SizeSuffix In memory buffer size for writing when in multi-thread mode (default 128Ki) 2292 --no-check-dest Don't check the destination, copy regardless 2293 --no-traverse Don't traverse destination file system on copy 2294 --no-update-dir-modtime Don't update directory modification times 2295 --no-update-modtime Don't update destination modtime if files identical 2296 --order-by string Instructions on how to order the transfers, e.g. 'size,descending' 2297 --partial-suffix string Add partial-suffix to temporary file name when --inplace is not used (default ".partial") 2298 --refresh-times Refresh the modtime of remote files 2299 --server-side-across-configs Allow server-side operations (e.g. copy) to work across different configs 2300 --size-only Skip based on size only, not modtime or checksum 2301 --streaming-upload-cutoff SizeSuffix Cutoff for switching to chunked upload if file size is unknown, upload starts after reaching cutoff or when file ends (default 100Ki) 2302 -u, --update Skip files that are newer on the destination</code></pre> 2303 <h2 id="important-options-11">Important Options</h2> 2304 <p>Important flags useful for most commands.</p> 2305 <pre><code> -n, --dry-run Do a trial run with no permanent changes 2306 -i, --interactive Enable interactive mode 2307 -v, --verbose count Print lots more stuff (repeat for more)</code></pre> 2308 <h2 id="filter-options-14">Filter Options</h2> 2309 <p>Flags for filtering directory listings.</p> 2310 <pre><code> --delete-excluded Delete files on dest excluded from sync 2311 --exclude stringArray Exclude files matching pattern 2312 --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) 2313 --exclude-if-present stringArray Exclude directories if filename is present 2314 --files-from stringArray Read list of source-file names from file (use - to read from stdin) 2315 --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) 2316 -f, --filter stringArray Add a file filtering rule 2317 --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) 2318 --ignore-case Ignore case in filters (case insensitive) 2319 --include stringArray Include files matching pattern 2320 --include-from stringArray Read file include patterns from file (use - to read from stdin) 2321 --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) 2322 --max-depth int If set limits the recursion depth to this (default -1) 2323 --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) 2324 --metadata-exclude stringArray Exclude metadatas matching pattern 2325 --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) 2326 --metadata-filter stringArray Add a metadata filtering rule 2327 --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) 2328 --metadata-include stringArray Include metadatas matching pattern 2329 --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) 2330 --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) 2331 --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre> 2332 <h2 id="listing-options-13">Listing Options</h2> 2333 <p>Flags for listing directories.</p> 2334 <pre><code> --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) 2335 --fast-list Use recursive list if available; uses more memory but fewer transactions</code></pre> 2336 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 2337 <h1 id="see-also-44">SEE ALSO</h1> 2338 <ul> 2339 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 2340 </ul> 2341 <h1 id="rclone-copyurl">rclone copyurl</h1> 2342 <p>Copy the contents of the URL supplied content to dest:path.</p> 2343 <h2 id="synopsis-37">Synopsis</h2> 2344 <p>Download a URL's content and copy it to the destination without saving it in temporary storage.</p> 2345 <p>Setting <code>--auto-filename</code> will attempt to automatically determine the filename from the URL (after any redirections) and used in the destination path.</p> 2346 <p>With <code>--auto-filename-header</code> in addition, if a specific filename is set in HTTP headers, it will be used instead of the name from the URL. With <code>--print-filename</code> in addition, the resulting file name will be printed.</p> 2347 <p>Setting <code>--no-clobber</code> will prevent overwriting file on the destination if there is one with the same name.</p> 2348 <p>Setting <code>--stdout</code> or making the output file name <code>-</code> will cause the output to be written to standard output.</p> 2349 <h2 id="troublshooting">Troublshooting</h2> 2350 <p>If you can't get <code>rclone copyurl</code> to work then here are some things you can try:</p> 2351 <ul> 2352 <li><code>--disable-http2</code> rclone will use HTTP2 if available - try disabling it</li> 2353 <li><code>--bind 0.0.0.0</code> rclone will use IPv6 if available - try disabling it</li> 2354 <li><code>--bind ::0</code> to disable IPv4</li> 2355 <li><code>--user agent curl</code> - some sites have whitelists for curl's user-agent - try that</li> 2356 <li>Make sure the site works with <code>curl</code> directly</li> 2357 </ul> 2358 <pre><code>rclone copyurl https://example.com dest:path [flags]</code></pre> 2359 <h2 id="options-45">Options</h2> 2360 <pre><code> -a, --auto-filename Get the file name from the URL and use it for destination file path 2361 --header-filename Get the file name from the Content-Disposition header 2362 -h, --help help for copyurl 2363 --no-clobber Prevent overwriting file with same name 2364 -p, --print-filename Print the resulting name from --auto-filename 2365 --stdout Write the output to stdout rather than a file</code></pre> 2366 <h2 id="important-options-12">Important Options</h2> 2367 <p>Important flags useful for most commands.</p> 2368 <pre><code> -n, --dry-run Do a trial run with no permanent changes 2369 -i, --interactive Enable interactive mode 2370 -v, --verbose count Print lots more stuff (repeat for more)</code></pre> 2371 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 2372 <h1 id="see-also-45">SEE ALSO</h1> 2373 <ul> 2374 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 2375 </ul> 2376 <h1 id="rclone-cryptcheck">rclone cryptcheck</h1> 2377 <p>Cryptcheck checks the integrity of an encrypted remote.</p> 2378 <h2 id="synopsis-38">Synopsis</h2> 2379 <p>rclone cryptcheck checks a remote against a <a href="https://rclone.org/crypt/">crypted</a> remote. This is the equivalent of running rclone <a href="https://rclone.org/commands/rclone_check/">check</a>, but able to check the checksums of the encrypted remote.</p> 2380 <p>For it to work the underlying remote of the cryptedremote must support some kind of checksum.</p> 2381 <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> 2382 <p>Use it like this</p> 2383 <pre><code>rclone cryptcheck /path/to/files encryptedremote:path</code></pre> 2384 <p>You can use it like this also, but that will involve downloading all the files in remote:path.</p> 2385 <pre><code>rclone cryptcheck remote:path encryptedremote:path</code></pre> 2386 <p>After it has run it will log the status of the encryptedremote:.</p> 2387 <p>If you supply the <code>--one-way</code> flag, it will only check that files in the source match the files in the destination, not the other way around. This means that extra files in the destination that are not in the source will not be detected.</p> 2388 <p>The <code>--differ</code>, <code>--missing-on-dst</code>, <code>--missing-on-src</code>, <code>--match</code> and <code>--error</code> flags write paths, one per line, to the file name (or stdout if it is <code>-</code>) supplied. What they write is described in the help below. For example <code>--differ</code> will write all paths which are present on both the source and destination but different.</p> 2389 <p>The <code>--combined</code> flag will write a file (or stdout) which contains all file paths with a symbol and then a space and then the path to tell you what happened to it. These are reminiscent of diff files.</p> 2390 <ul> 2391 <li><code>= path</code> means path was found in source and destination and was identical</li> 2392 <li>`- path` means path was missing on the source, so only in the destination</li> 2393 <li>`+ path` means path was missing on the destination, so only in the source</li> 2394 <li>`* path` means path was present in source and destination but different.</li> 2395 <li><code>! path</code> means there was an error reading or hashing the source or dest.</li> 2396 </ul> 2397 <p>The default number of parallel checks is 8. See the <a href="https://rclone.org/docs/#checkers-n">--checkers=N</a> option for more information.</p> 2398 <pre><code>rclone cryptcheck remote:path cryptedremote:path [flags]</code></pre> 2399 <h2 id="options-46">Options</h2> 2400 <pre><code> --combined string Make a combined report of changes to this file 2401 --differ string Report all non-matching files to this file 2402 --error string Report all files with errors (hashing or reading) to this file 2403 -h, --help help for cryptcheck 2404 --match string Report all matching files to this file 2405 --missing-on-dst string Report all files missing from the destination to this file 2406 --missing-on-src string Report all files missing from the source to this file 2407 --one-way Check one way only, source files must exist on remote</code></pre> 2408 <h2 id="check-options-1">Check Options</h2> 2409 <p>Flags used for <code>rclone check</code>.</p> 2410 <pre><code> --max-backlog int Maximum number of objects in sync or check backlog (default 10000)</code></pre> 2411 <h2 id="filter-options-15">Filter Options</h2> 2412 <p>Flags for filtering directory listings.</p> 2413 <pre><code> --delete-excluded Delete files on dest excluded from sync 2414 --exclude stringArray Exclude files matching pattern 2415 --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) 2416 --exclude-if-present stringArray Exclude directories if filename is present 2417 --files-from stringArray Read list of source-file names from file (use - to read from stdin) 2418 --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) 2419 -f, --filter stringArray Add a file filtering rule 2420 --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) 2421 --ignore-case Ignore case in filters (case insensitive) 2422 --include stringArray Include files matching pattern 2423 --include-from stringArray Read file include patterns from file (use - to read from stdin) 2424 --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) 2425 --max-depth int If set limits the recursion depth to this (default -1) 2426 --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) 2427 --metadata-exclude stringArray Exclude metadatas matching pattern 2428 --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) 2429 --metadata-filter stringArray Add a metadata filtering rule 2430 --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) 2431 --metadata-include stringArray Include metadatas matching pattern 2432 --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) 2433 --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) 2434 --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre> 2435 <h2 id="listing-options-14">Listing Options</h2> 2436 <p>Flags for listing directories.</p> 2437 <pre><code> --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) 2438 --fast-list Use recursive list if available; uses more memory but fewer transactions</code></pre> 2439 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 2440 <h1 id="see-also-46">SEE ALSO</h1> 2441 <ul> 2442 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 2443 </ul> 2444 <h1 id="rclone-cryptdecode">rclone cryptdecode</h1> 2445 <p>Cryptdecode returns unencrypted file names.</p> 2446 <h2 id="synopsis-39">Synopsis</h2> 2447 <p>rclone cryptdecode returns unencrypted file names when provided with a list of encrypted file names. List limit is 10 items.</p> 2448 <p>If you supply the <code>--reverse</code> flag, it will return encrypted file names.</p> 2449 <p>use it like this</p> 2450 <pre><code>rclone cryptdecode encryptedremote: encryptedfilename1 encryptedfilename2 2451 2452 rclone cryptdecode --reverse encryptedremote: filename1 filename2</code></pre> 2453 <p>Another way to accomplish this is by using the <code>rclone backend encode</code> (or <code>decode</code>) command. See the documentation on the <a href="https://rclone.org/crypt/">crypt</a> overlay for more info.</p> 2454 <pre><code>rclone cryptdecode encryptedremote: encryptedfilename [flags]</code></pre> 2455 <h2 id="options-47">Options</h2> 2456 <pre><code> -h, --help help for cryptdecode 2457 --reverse Reverse cryptdecode, encrypts filenames</code></pre> 2458 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 2459 <h1 id="see-also-47">SEE ALSO</h1> 2460 <ul> 2461 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 2462 </ul> 2463 <h1 id="rclone-deletefile">rclone deletefile</h1> 2464 <p>Remove a single file from remote.</p> 2465 <h2 id="synopsis-40">Synopsis</h2> 2466 <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> 2467 <pre><code>rclone deletefile remote:path [flags]</code></pre> 2468 <h2 id="options-48">Options</h2> 2469 <pre><code> -h, --help help for deletefile</code></pre> 2470 <h2 id="important-options-13">Important Options</h2> 2471 <p>Important flags useful for most commands.</p> 2472 <pre><code> -n, --dry-run Do a trial run with no permanent changes 2473 -i, --interactive Enable interactive mode 2474 -v, --verbose count Print lots more stuff (repeat for more)</code></pre> 2475 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 2476 <h1 id="see-also-48">SEE ALSO</h1> 2477 <ul> 2478 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 2479 </ul> 2480 <h1 id="rclone-genautocomplete">rclone genautocomplete</h1> 2481 <p>Output completion script for a given shell.</p> 2482 <h1 id="synopsis-41">Synopsis</h1> 2483 <p>Generates a shell completion script for rclone. Run with <code>--help</code> to list the supported shells.</p> 2484 <h1 id="options-49">Options</h1> 2485 <pre><code> -h, --help help for genautocomplete</code></pre> 2486 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 2487 <h1 id="see-also-49">SEE ALSO</h1> 2488 <ul> 2489 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 2490 <li><a href="https://rclone.org/commands/rclone_genautocomplete_bash/">rclone genautocomplete bash</a> - Output bash completion script for rclone.</li> 2491 <li><a href="https://rclone.org/commands/rclone_genautocomplete_fish/">rclone genautocomplete fish</a> - Output fish completion script for rclone.</li> 2492 <li><a href="https://rclone.org/commands/rclone_genautocomplete_zsh/">rclone genautocomplete zsh</a> - Output zsh completion script for rclone.</li> 2493 </ul> 2494 <h1 id="rclone-genautocomplete-bash">rclone genautocomplete bash</h1> 2495 <p>Output bash completion script for rclone.</p> 2496 <h1 id="synopsis-42">Synopsis</h1> 2497 <p>Generates a bash shell autocompletion script for rclone.</p> 2498 <p>This writes to /etc/bash_completion.d/rclone by default so will probably need to be run with sudo or as root, e.g.</p> 2499 <pre><code>sudo rclone genautocomplete bash</code></pre> 2500 <p>Logout and login again to use the autocompletion scripts, or source them directly</p> 2501 <pre><code>. /etc/bash_completion</code></pre> 2502 <p>If you supply a command line argument the script will be written there.</p> 2503 <p>If output_file is "-", then the output will be written to stdout.</p> 2504 <pre><code>rclone genautocomplete bash [output_file] [flags]</code></pre> 2505 <h1 id="options-50">Options</h1> 2506 <pre><code> -h, --help help for bash</code></pre> 2507 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 2508 <h1 id="see-also-50">SEE ALSO</h1> 2509 <ul> 2510 <li><a href="https://rclone.org/commands/rclone_genautocomplete/">rclone genautocomplete</a> - Output completion script for a given shell.</li> 2511 </ul> 2512 <h1 id="rclone-genautocomplete-fish">rclone genautocomplete fish</h1> 2513 <p>Output fish completion script for rclone.</p> 2514 <h1 id="synopsis-43">Synopsis</h1> 2515 <p>Generates a fish autocompletion script for rclone.</p> 2516 <p>This writes to /etc/fish/completions/rclone.fish by default so will probably need to be run with sudo or as root, e.g.</p> 2517 <pre><code>sudo rclone genautocomplete fish</code></pre> 2518 <p>Logout and login again to use the autocompletion scripts, or source them directly</p> 2519 <pre><code>. /etc/fish/completions/rclone.fish</code></pre> 2520 <p>If you supply a command line argument the script will be written there.</p> 2521 <p>If output_file is "-", then the output will be written to stdout.</p> 2522 <pre><code>rclone genautocomplete fish [output_file] [flags]</code></pre> 2523 <h1 id="options-51">Options</h1> 2524 <pre><code> -h, --help help for fish</code></pre> 2525 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 2526 <h1 id="see-also-51">SEE ALSO</h1> 2527 <ul> 2528 <li><a href="https://rclone.org/commands/rclone_genautocomplete/">rclone genautocomplete</a> - Output completion script for a given shell.</li> 2529 </ul> 2530 <h1 id="rclone-genautocomplete-zsh">rclone genautocomplete zsh</h1> 2531 <p>Output zsh completion script for rclone.</p> 2532 <h1 id="synopsis-44">Synopsis</h1> 2533 <p>Generates a zsh autocompletion script for rclone.</p> 2534 <p>This writes to /usr/share/zsh/vendor-completions/_rclone by default so will probably need to be run with sudo or as root, e.g.</p> 2535 <pre><code>sudo rclone genautocomplete zsh</code></pre> 2536 <p>Logout and login again to use the autocompletion scripts, or source them directly</p> 2537 <pre><code>autoload -U compinit && compinit</code></pre> 2538 <p>If you supply a command line argument the script will be written there.</p> 2539 <p>If output_file is "-", then the output will be written to stdout.</p> 2540 <pre><code>rclone genautocomplete zsh [output_file] [flags]</code></pre> 2541 <h1 id="options-52">Options</h1> 2542 <pre><code> -h, --help help for zsh</code></pre> 2543 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 2544 <h1 id="see-also-52">SEE ALSO</h1> 2545 <ul> 2546 <li><a href="https://rclone.org/commands/rclone_genautocomplete/">rclone genautocomplete</a> - Output completion script for a given shell.</li> 2547 </ul> 2548 <h1 id="rclone-gendocs">rclone gendocs</h1> 2549 <p>Output markdown docs for rclone to the directory supplied.</p> 2550 <h2 id="synopsis-45">Synopsis</h2> 2551 <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> 2552 <pre><code>rclone gendocs output_directory [flags]</code></pre> 2553 <h2 id="options-53">Options</h2> 2554 <pre><code> -h, --help help for gendocs</code></pre> 2555 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 2556 <h1 id="see-also-53">SEE ALSO</h1> 2557 <ul> 2558 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 2559 </ul> 2560 <h1 id="rclone-hashsum">rclone hashsum</h1> 2561 <p>Produces a hashsum file for all the objects in the path.</p> 2562 <h2 id="synopsis-46">Synopsis</h2> 2563 <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> 2564 <p>By default, the hash is requested from the remote. If the hash is not supported by the remote, no hash will be returned. With the download flag, the file will be downloaded from the remote and hashed locally enabling any hash for any remote.</p> 2565 <p>For the MD5 and SHA1 algorithms there are also dedicated commands, <a href="https://rclone.org/commands/rclone_md5sum/">md5sum</a> and <a href="https://rclone.org/commands/rclone_sha1sum/">sha1sum</a>.</p> 2566 <p>This command can also hash data received on standard input (stdin), by not passing a remote:path, or by passing a hyphen as remote:path when there is data to read (if not, the hyphen will be treated literally, as a relative path).</p> 2567 <p>Run without a hash to see the list of all supported hashes, e.g.</p> 2568 <pre><code>$ rclone hashsum 2569 Supported hashes are: 2570 * md5 2571 * sha1 2572 * whirlpool 2573 * crc32 2574 * sha256</code></pre> 2575 <p>Then</p> 2576 <pre><code>$ rclone hashsum MD5 remote:path</code></pre> 2577 <p>Note that hash names are case insensitive and values are output in lower case.</p> 2578 <pre><code>rclone hashsum [<hash> remote:path] [flags]</code></pre> 2579 <h2 id="options-54">Options</h2> 2580 <pre><code> --base64 Output base64 encoded hashsum 2581 -C, --checkfile string Validate hashes against a given SUM file instead of printing them 2582 --download Download the file and hash it locally; if this flag is not specified, the hash is requested from the remote 2583 -h, --help help for hashsum 2584 --output-file string Output hashsums to a file rather than the terminal</code></pre> 2585 <h2 id="filter-options-16">Filter Options</h2> 2586 <p>Flags for filtering directory listings.</p> 2587 <pre><code> --delete-excluded Delete files on dest excluded from sync 2588 --exclude stringArray Exclude files matching pattern 2589 --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) 2590 --exclude-if-present stringArray Exclude directories if filename is present 2591 --files-from stringArray Read list of source-file names from file (use - to read from stdin) 2592 --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) 2593 -f, --filter stringArray Add a file filtering rule 2594 --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) 2595 --ignore-case Ignore case in filters (case insensitive) 2596 --include stringArray Include files matching pattern 2597 --include-from stringArray Read file include patterns from file (use - to read from stdin) 2598 --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) 2599 --max-depth int If set limits the recursion depth to this (default -1) 2600 --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) 2601 --metadata-exclude stringArray Exclude metadatas matching pattern 2602 --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) 2603 --metadata-filter stringArray Add a metadata filtering rule 2604 --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) 2605 --metadata-include stringArray Include metadatas matching pattern 2606 --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) 2607 --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) 2608 --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre> 2609 <h2 id="listing-options-15">Listing Options</h2> 2610 <p>Flags for listing directories.</p> 2611 <pre><code> --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) 2612 --fast-list Use recursive list if available; uses more memory but fewer transactions</code></pre> 2613 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 2614 <h1 id="see-also-54">SEE ALSO</h1> 2615 <ul> 2616 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 2617 </ul> 2618 <h1 id="rclone-link">rclone link</h1> 2619 <p>Generate public link to file/folder.</p> 2620 <h2 id="synopsis-47">Synopsis</h2> 2621 <p>rclone link will create, retrieve or remove a public link to the given file or folder.</p> 2622 <pre><code>rclone link remote:path/to/file 2623 rclone link remote:path/to/folder/ 2624 rclone link --unlink remote:path/to/folder/ 2625 rclone link --expire 1d remote:path/to/file</code></pre> 2626 <p>If you supply the --expire flag, it will set the expiration time otherwise it will use the default (100 years). <strong>Note</strong> not all backends support the --expire flag - if the backend doesn't support it then the link returned won't expire.</p> 2627 <p>Use the --unlink flag to remove existing public links to the file or folder. <strong>Note</strong> not all backends support "--unlink" flag - those that don't will just ignore it.</p> 2628 <p>If successful, the last line of the output will contain the link. Exact capabilities depend on the remote, but the link will always by default be created with the least constraints – e.g. no expiry, no password protection, accessible without account.</p> 2629 <pre><code>rclone link remote:path [flags]</code></pre> 2630 <h2 id="options-55">Options</h2> 2631 <pre><code> --expire Duration The amount of time that the link will be valid (default off) 2632 -h, --help help for link 2633 --unlink Remove existing public link to file/folder</code></pre> 2634 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 2635 <h1 id="see-also-55">SEE ALSO</h1> 2636 <ul> 2637 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 2638 </ul> 2639 <h1 id="rclone-listremotes">rclone listremotes</h1> 2640 <p>List all the remotes in the config file and defined in environment variables.</p> 2641 <h2 id="synopsis-48">Synopsis</h2> 2642 <p>rclone listremotes lists all the available remotes from the config file.</p> 2643 <p>When used with the <code>--long</code> flag it lists the types and the descriptions too.</p> 2644 <pre><code>rclone listremotes [flags]</code></pre> 2645 <h2 id="options-56">Options</h2> 2646 <pre><code> -h, --help help for listremotes 2647 --long Show the type and the description as well as names</code></pre> 2648 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 2649 <h1 id="see-also-56">SEE ALSO</h1> 2650 <ul> 2651 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 2652 </ul> 2653 <h1 id="rclone-lsf">rclone lsf</h1> 2654 <p>List directories and objects in remote:path formatted for parsing.</p> 2655 <h2 id="synopsis-49">Synopsis</h2> 2656 <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> 2657 <p>Eg</p> 2658 <pre><code>$ rclone lsf swift:bucket 2659 bevajer5jef 2660 canole 2661 diwogej7 2662 ferejej3gux/ 2663 fubuwic</code></pre> 2664 <p>Use the <code>--format</code> option to control what gets listed. By default this is just the path, but you can use these parameters to control the output:</p> 2665 <pre><code>p - path 2666 s - size 2667 t - modification time 2668 h - hash 2669 i - ID of object 2670 o - Original ID of underlying object 2671 m - MimeType of object if known 2672 e - encrypted name 2673 T - tier of storage if known, e.g. "Hot" or "Cool" 2674 M - Metadata of object in JSON blob format, eg {"key":"value"}</code></pre> 2675 <p>So if you wanted the path, size and modification time, you would use <code>--format "pst"</code>, or maybe <code>--format "tsp"</code> to put the path last.</p> 2676 <p>Eg</p> 2677 <pre><code>$ rclone lsf --format "tsp" swift:bucket 2678 2016-06-25 18:55:41;60295;bevajer5jef 2679 2016-06-25 18:55:43;90613;canole 2680 2016-06-25 18:55:43;94467;diwogej7 2681 2018-04-26 08:50:45;0;ferejej3gux/ 2682 2016-06-25 18:55:40;37600;fubuwic</code></pre> 2683 <p>If you specify "h" in the format you will get the MD5 hash by default, use the <code>--hash</code> 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> 2684 <p>For example, to emulate the md5sum command you can use</p> 2685 <pre><code>rclone lsf -R --hash MD5 --format hp --separator " " --files-only .</code></pre> 2686 <p>Eg</p> 2687 <pre><code>$ rclone lsf -R --hash MD5 --format hp --separator " " --files-only swift:bucket 2688 7908e352297f0f530b84a756f188baa3 bevajer5jef 2689 cd65ac234e6fea5925974a51cdd865cc canole 2690 03b5341b4f234b9d984d03ad076bae91 diwogej7 2691 8fd37c3810dd660778137ac3a66cc06d fubuwic 2692 99713e14a4c4ff553acaf1930fad985b gixacuh7ku</code></pre> 2693 <p>(Though "rclone md5sum ." is an easier way of typing this.)</p> 2694 <p>By default the separator is ";" this can be changed with the <code>--separator</code> flag. Note that separators aren't escaped in the path so putting it last is a good strategy.</p> 2695 <p>Eg</p> 2696 <pre><code>$ rclone lsf --separator "," --format "tshp" swift:bucket 2697 2016-06-25 18:55:41,60295,7908e352297f0f530b84a756f188baa3,bevajer5jef 2698 2016-06-25 18:55:43,90613,cd65ac234e6fea5925974a51cdd865cc,canole 2699 2016-06-25 18:55:43,94467,03b5341b4f234b9d984d03ad076bae91,diwogej7 2700 2018-04-26 08:52:53,0,,ferejej3gux/ 2701 2016-06-25 18:55:40,37600,8fd37c3810dd660778137ac3a66cc06d,fubuwic</code></pre> 2702 <p>You can output in CSV standard format. This will escape things in " if they contain ,</p> 2703 <p>Eg</p> 2704 <pre><code>$ rclone lsf --csv --files-only --format ps remote:path 2705 test.log,22355 2706 test.sh,449 2707 "this file contains a comma, in the file name.txt",6</code></pre> 2708 <p>Note that the <code>--absolute</code> parameter is useful for making lists of files to pass to an rclone copy with the <code>--files-from-raw</code> flag.</p> 2709 <p>For example, to find all the files modified within one day and copy those only (without traversing the whole directory structure):</p> 2710 <pre><code>rclone lsf --absolute --files-only --max-age 1d /path/to/local > new_files 2711 rclone copy --files-from-raw new_files /path/to/local remote:path</code></pre> 2712 <p>The default time format is <code>'2006-01-02 15:04:05'</code>. <a href="https://pkg.go.dev/time#pkg-constants">Other formats</a> can be specified with the <code>--time-format</code> flag. Examples:</p> 2713 <pre><code>rclone lsf remote:path --format pt --time-format 'Jan 2, 2006 at 3:04pm (MST)' 2714 rclone lsf remote:path --format pt --time-format '2006-01-02 15:04:05.000000000' 2715 rclone lsf remote:path --format pt --time-format '2006-01-02T15:04:05.999999999Z07:00' 2716 rclone lsf remote:path --format pt --time-format RFC3339 2717 rclone lsf remote:path --format pt --time-format DateOnly 2718 rclone lsf remote:path --format pt --time-format max</code></pre> 2719 <p><code>--time-format max</code> will automatically truncate '<code>2006-01-02 15:04:05.000000000</code>' to the maximum precision supported by the remote.</p> 2720 <p>Any of the filtering options can be applied to this command.</p> 2721 <p>There are several related list commands</p> 2722 <ul> 2723 <li><code>ls</code> to list size and path of objects only</li> 2724 <li><code>lsl</code> to list modification time, size and path of objects only</li> 2725 <li><code>lsd</code> to list directories only</li> 2726 <li><code>lsf</code> to list objects and directories in easy to parse format</li> 2727 <li><code>lsjson</code> to list objects and directories in JSON format</li> 2728 </ul> 2729 <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> 2730 <p>Note that <code>ls</code> and <code>lsl</code> recurse by default - use <code>--max-depth 1</code> to stop the recursion.</p> 2731 <p>The other list commands <code>lsd</code>,<code>lsf</code>,<code>lsjson</code> do not recurse by default - use <code>-R</code> to make them recurse.</p> 2732 <p>Listing a nonexistent directory will produce an error except for remotes which can't have empty directories (e.g. s3, swift, or gcs - the bucket-based remotes).</p> 2733 <pre><code>rclone lsf remote:path [flags]</code></pre> 2734 <h2 id="options-57">Options</h2> 2735 <pre><code> --absolute Put a leading / in front of path names 2736 --csv Output in CSV format 2737 -d, --dir-slash Append a slash to directory names (default true) 2738 --dirs-only Only list directories 2739 --files-only Only list files 2740 -F, --format string Output format - see help for details (default "p") 2741 --hash h Use this hash when h is used in the format MD5|SHA-1|DropboxHash (default "md5") 2742 -h, --help help for lsf 2743 -R, --recursive Recurse into the listing 2744 -s, --separator string Separator for the items in the format (default ";") 2745 -t, --time-format string Specify a custom time format, or 'max' for max precision supported by remote (default: 2006-01-02 15:04:05)</code></pre> 2746 <h2 id="filter-options-17">Filter Options</h2> 2747 <p>Flags for filtering directory listings.</p> 2748 <pre><code> --delete-excluded Delete files on dest excluded from sync 2749 --exclude stringArray Exclude files matching pattern 2750 --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) 2751 --exclude-if-present stringArray Exclude directories if filename is present 2752 --files-from stringArray Read list of source-file names from file (use - to read from stdin) 2753 --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) 2754 -f, --filter stringArray Add a file filtering rule 2755 --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) 2756 --ignore-case Ignore case in filters (case insensitive) 2757 --include stringArray Include files matching pattern 2758 --include-from stringArray Read file include patterns from file (use - to read from stdin) 2759 --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) 2760 --max-depth int If set limits the recursion depth to this (default -1) 2761 --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) 2762 --metadata-exclude stringArray Exclude metadatas matching pattern 2763 --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) 2764 --metadata-filter stringArray Add a metadata filtering rule 2765 --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) 2766 --metadata-include stringArray Include metadatas matching pattern 2767 --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) 2768 --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) 2769 --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre> 2770 <h2 id="listing-options-16">Listing Options</h2> 2771 <p>Flags for listing directories.</p> 2772 <pre><code> --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) 2773 --fast-list Use recursive list if available; uses more memory but fewer transactions</code></pre> 2774 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 2775 <h1 id="see-also-57">SEE ALSO</h1> 2776 <ul> 2777 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 2778 </ul> 2779 <h1 id="rclone-lsjson">rclone lsjson</h1> 2780 <p>List directories and objects in the path in JSON format.</p> 2781 <h2 id="synopsis-50">Synopsis</h2> 2782 <p>List directories and objects in the path in JSON format.</p> 2783 <p>The output is an array of Items, where each Item looks like this</p> 2784 <pre><code>{ 2785 "Hashes" : { 2786 "SHA-1" : "f572d396fae9206628714fb2ce00f72e94f2258f", 2787 "MD5" : "b1946ac92492d2347c6235b4d2611184", 2788 "DropboxHash" : "ecb65bb98f9d905b70458986c39fcbad7715e5f2fcc3b1f07767d7c83e2438cc" 2789 }, 2790 "ID": "y2djkhiujf83u33", 2791 "OrigID": "UYOJVTUW00Q1RzTDA", 2792 "IsBucket" : false, 2793 "IsDir" : false, 2794 "MimeType" : "application/octet-stream", 2795 "ModTime" : "2017-05-31T16:15:57.034468261+01:00", 2796 "Name" : "file.txt", 2797 "Encrypted" : "v0qpsdq8anpci8n929v3uu9338", 2798 "EncryptedPath" : "kja9098349023498/v0qpsdq8anpci8n929v3uu9338", 2799 "Path" : "full/path/goes/here/file.txt", 2800 "Size" : 6, 2801 "Tier" : "hot", 2802 }</code></pre> 2803 <p>If <code>--hash</code> is not specified the Hashes property won't be emitted. The types of hash can be specified with the <code>--hash-type</code> parameter (which may be repeated). If <code>--hash-type</code> is set then it implies <code>--hash</code>.</p> 2804 <p>If <code>--no-modtime</code> is specified then ModTime will be blank. This can speed things up on remotes where reading the ModTime takes an extra request (e.g. s3, swift).</p> 2805 <p>If <code>--no-mimetype</code> is specified then MimeType will be blank. This can speed things up on remotes where reading the MimeType takes an extra request (e.g. s3, swift).</p> 2806 <p>If <code>--encrypted</code> is not specified the Encrypted won't be emitted.</p> 2807 <p>If <code>--dirs-only</code> is not specified files in addition to directories are returned</p> 2808 <p>If <code>--files-only</code> is not specified directories in addition to the files will be returned.</p> 2809 <p>If <code>--metadata</code> is set then an additional Metadata key will be returned. This will have metadata in rclone standard format as a JSON object.</p> 2810 <p>if <code>--stat</code> is set then a single JSON blob will be returned about the item pointed to. This will return an error if the item isn't found. However on bucket based backends (like s3, gcs, b2, azureblob etc) if the item isn't found it will return an empty directory as it isn't possible to tell empty directories from missing directories there.</p> 2811 <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 <code>--recursive</code> the Path will always be the same as Name.</p> 2812 <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> 2813 <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 (e.g. Google Drive) then 3 digits will always be shown ("2017-05-31T16:15:57.034+01:00") whereas if the times are accurate to the nearest second (Dropbox, Box, WebDav, etc.) no digits will be shown ("2017-05-31T16:15:57+01:00").</p> 2814 <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> 2815 <p>Any of the filtering options can be applied to this command.</p> 2816 <p>There are several related list commands</p> 2817 <ul> 2818 <li><code>ls</code> to list size and path of objects only</li> 2819 <li><code>lsl</code> to list modification time, size and path of objects only</li> 2820 <li><code>lsd</code> to list directories only</li> 2821 <li><code>lsf</code> to list objects and directories in easy to parse format</li> 2822 <li><code>lsjson</code> to list objects and directories in JSON format</li> 2823 </ul> 2824 <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> 2825 <p>Note that <code>ls</code> and <code>lsl</code> recurse by default - use <code>--max-depth 1</code> to stop the recursion.</p> 2826 <p>The other list commands <code>lsd</code>,<code>lsf</code>,<code>lsjson</code> do not recurse by default - use <code>-R</code> to make them recurse.</p> 2827 <p>Listing a nonexistent directory will produce an error except for remotes which can't have empty directories (e.g. s3, swift, or gcs - the bucket-based remotes).</p> 2828 <pre><code>rclone lsjson remote:path [flags]</code></pre> 2829 <h2 id="options-58">Options</h2> 2830 <pre><code> --dirs-only Show only directories in the listing 2831 --encrypted Show the encrypted names 2832 --files-only Show only files in the listing 2833 --hash Include hashes in the output (may take longer) 2834 --hash-type stringArray Show only this hash type (may be repeated) 2835 -h, --help help for lsjson 2836 -M, --metadata Add metadata to the listing 2837 --no-mimetype Don't read the mime type (can speed things up) 2838 --no-modtime Don't read the modification time (can speed things up) 2839 --original Show the ID of the underlying Object 2840 -R, --recursive Recurse into the listing 2841 --stat Just return the info for the pointed to file</code></pre> 2842 <h2 id="filter-options-18">Filter Options</h2> 2843 <p>Flags for filtering directory listings.</p> 2844 <pre><code> --delete-excluded Delete files on dest excluded from sync 2845 --exclude stringArray Exclude files matching pattern 2846 --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) 2847 --exclude-if-present stringArray Exclude directories if filename is present 2848 --files-from stringArray Read list of source-file names from file (use - to read from stdin) 2849 --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) 2850 -f, --filter stringArray Add a file filtering rule 2851 --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) 2852 --ignore-case Ignore case in filters (case insensitive) 2853 --include stringArray Include files matching pattern 2854 --include-from stringArray Read file include patterns from file (use - to read from stdin) 2855 --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) 2856 --max-depth int If set limits the recursion depth to this (default -1) 2857 --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) 2858 --metadata-exclude stringArray Exclude metadatas matching pattern 2859 --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) 2860 --metadata-filter stringArray Add a metadata filtering rule 2861 --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) 2862 --metadata-include stringArray Include metadatas matching pattern 2863 --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) 2864 --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) 2865 --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre> 2866 <h2 id="listing-options-17">Listing Options</h2> 2867 <p>Flags for listing directories.</p> 2868 <pre><code> --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) 2869 --fast-list Use recursive list if available; uses more memory but fewer transactions</code></pre> 2870 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 2871 <h1 id="see-also-58">SEE ALSO</h1> 2872 <ul> 2873 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 2874 </ul> 2875 <h1 id="rclone-mount">rclone mount</h1> 2876 <p>Mount the remote as file system on a mountpoint.</p> 2877 <h2 id="synopsis-51">Synopsis</h2> 2878 <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> 2879 <p>First set up your remote using <code>rclone config</code>. Check it works with <code>rclone ls</code> etc.</p> 2880 <p>On Linux and macOS, you can run mount in either foreground or background (aka daemon) mode. Mount runs in foreground mode by default. Use the <code>--daemon</code> flag to force background mode. On Windows you can run mount in foreground only, the flag is ignored.</p> 2881 <p>In background mode rclone acts as a generic Unix mount program: the main program starts, spawns background rclone process to setup and maintain the mount, waits until success or timeout and exits with appropriate code (killing the child process if it fails).</p> 2882 <p>On Linux/macOS/FreeBSD start the mount like this, where <code>/path/to/local/mount</code> is an <strong>empty</strong> <strong>existing</strong> directory:</p> 2883 <pre><code>rclone mount remote:path/to/files /path/to/local/mount</code></pre> 2884 <p>On Windows you can start a mount in different ways. See <a href="#mounting-modes-on-windows">below</a> for details. If foreground mount is used interactively from a console window, rclone will serve the mount and occupy the console so another window should be used to work with the mount until rclone is interrupted e.g. by pressing Ctrl-C.</p> 2885 <p>The following examples will mount to an automatically assigned drive, to specific drive letter <code>X:</code>, to path <code>C:\path\parent\mount</code> (where parent directory or drive must exist, and mount must <strong>not</strong> exist, and is not supported when <a href="#mounting-modes-on-windows">mounting as a network drive</a>), and the last example will mount as network share <code>\\cloud\remote</code> and map it to an automatically assigned drive:</p> 2886 <pre><code>rclone mount remote:path/to/files * 2887 rclone mount remote:path/to/files X: 2888 rclone mount remote:path/to/files C:\path\parent\mount 2889 rclone mount remote:path/to/files \\cloud\remote</code></pre> 2890 <p>When the program ends while in foreground mode, either via Ctrl+C or receiving a SIGINT or SIGTERM signal, the mount should be automatically stopped.</p> 2891 <p>When running in background mode the user will have to stop the mount manually:</p> 2892 <pre><code># Linux 2893 fusermount -u /path/to/local/mount 2894 # OS X 2895 umount /path/to/local/mount</code></pre> 2896 <p>The umount operation can fail, for example when the mountpoint is busy. When that happens, it is the user's responsibility to stop the mount manually.</p> 2897 <p>The size of the mounted file system will be set according to information retrieved from the remote, the same as returned by the <a href="https://rclone.org/commands/rclone_about/">rclone about</a> command. Remotes with unlimited storage may report the used size only, then an additional 1 PiB of free space is assumed. If the remote does not <a href="https://rclone.org/overview/#optional-features">support</a> the about feature at all, then 1 PiB is set as both the total and the free size.</p> 2898 <h2 id="installing-on-windows">Installing on Windows</h2> 2899 <p>To run rclone mount on Windows, you will need to download and install <a href="http://www.secfs.net/winfsp/">WinFsp</a>.</p> 2900 <p><a href="https://github.com/winfsp/winfsp">WinFsp</a> is an open-source Windows File System Proxy which makes it easy to write user space file systems for Windows. It provides a FUSE emulation layer which rclone uses combination with <a href="https://github.com/winfsp/cgofuse">cgofuse</a>. Both of these packages are by Bill Zissimopoulos who was very helpful during the implementation of rclone mount for Windows.</p> 2901 <h3 id="mounting-modes-on-windows">Mounting modes on windows</h3> 2902 <p>Unlike other operating systems, Microsoft Windows provides a different filesystem type for network and fixed drives. It optimises access on the assumption fixed disk drives are fast and reliable, while network drives have relatively high latency and less reliability. Some settings can also be differentiated between the two types, for example that Windows Explorer should just display icons and not create preview thumbnails for image and video files on network drives.</p> 2903 <p>In most cases, rclone will mount the remote as a normal, fixed disk drive by default. However, you can also choose to mount it as a remote network drive, often described as a network share. If you mount an rclone remote using the default, fixed drive mode and experience unexpected program errors, freezes or other issues, consider mounting as a network drive instead.</p> 2904 <p>When mounting as a fixed disk drive you can either mount to an unused drive letter, or to a path representing a <strong>nonexistent</strong> subdirectory of an <strong>existing</strong> parent directory or drive. Using the special value <code>*</code> will tell rclone to automatically assign the next available drive letter, starting with Z: and moving backward. Examples:</p> 2905 <pre><code>rclone mount remote:path/to/files * 2906 rclone mount remote:path/to/files X: 2907 rclone mount remote:path/to/files C:\path\parent\mount 2908 rclone mount remote:path/to/files X:</code></pre> 2909 <p>Option <code>--volname</code> can be used to set a custom volume name for the mounted file system. The default is to use the remote name and path.</p> 2910 <p>To mount as network drive, you can add option <code>--network-mode</code> to your mount command. Mounting to a directory path is not supported in this mode, it is a limitation Windows imposes on junctions, so the remote must always be mounted to a drive letter.</p> 2911 <pre><code>rclone mount remote:path/to/files X: --network-mode</code></pre> 2912 <p>A volume name specified with <code>--volname</code> will be used to create the network share path. A complete UNC path, such as <code>\\cloud\remote</code>, optionally with path <code>\\cloud\remote\madeup\path</code>, will be used as is. Any other string will be used as the share part, after a default prefix <code>\\server\</code>. If no volume name is specified then <code>\\server\share</code> will be used. You must make sure the volume name is unique when you are mounting more than one drive, or else the mount command will fail. The share name will treated as the volume label for the mapped drive, shown in Windows Explorer etc, while the complete <code>\\server\share</code> will be reported as the remote UNC path by <code>net use</code> etc, just like a normal network drive mapping.</p> 2913 <p>If you specify a full network share UNC path with <code>--volname</code>, this will implicitly set the <code>--network-mode</code> option, so the following two examples have same result:</p> 2914 <pre><code>rclone mount remote:path/to/files X: --network-mode 2915 rclone mount remote:path/to/files X: --volname \\server\share</code></pre> 2916 <p>You may also specify the network share UNC path as the mountpoint itself. Then rclone will automatically assign a drive letter, same as with <code>*</code> and use that as mountpoint, and instead use the UNC path specified as the volume name, as if it were specified with the <code>--volname</code> option. This will also implicitly set the <code>--network-mode</code> option. This means the following two examples have same result:</p> 2917 <pre><code>rclone mount remote:path/to/files \\cloud\remote 2918 rclone mount remote:path/to/files * --volname \\cloud\remote</code></pre> 2919 <p>There is yet another way to enable network mode, and to set the share path, and that is to pass the "native" libfuse/WinFsp option directly: <code>--fuse-flag --VolumePrefix=\server\share</code>. Note that the path must be with just a single backslash prefix in this case.</p> 2920 <p><em>Note:</em> In previous versions of rclone this was the only supported method.</p> 2921 <p><a href="https://en.wikipedia.org/wiki/Drive_mapping">Read more about drive mapping</a></p> 2922 <p>See also <a href="#limitations">Limitations</a> section below.</p> 2923 <h3 id="windows-filesystem-permissions">Windows filesystem permissions</h3> 2924 <p>The FUSE emulation layer on Windows must convert between the POSIX-based permission model used in FUSE, and the permission model used in Windows, based on access-control lists (ACL).</p> 2925 <p>The mounted filesystem will normally get three entries in its access-control list (ACL), representing permissions for the POSIX permission scopes: Owner, group and others. By default, the owner and group will be taken from the current user, and the built-in group "Everyone" will be used to represent others. The user/group can be customized with FUSE options "UserName" and "GroupName", e.g. <code>-o UserName=user123 -o GroupName="Authenticated Users"</code>. The permissions on each entry will be set according to <a href="#options">options</a> <code>--dir-perms</code> and <code>--file-perms</code>, which takes a value in traditional Unix <a href="https://en.wikipedia.org/wiki/File-system_permissions#Numeric_notation">numeric notation</a>.</p> 2926 <p>The default permissions corresponds to <code>--file-perms 0666 --dir-perms 0777</code>, i.e. read and write permissions to everyone. This means you will not be able to start any programs from the mount. To be able to do that you must add execute permissions, e.g. <code>--file-perms 0777 --dir-perms 0777</code> to add it to everyone. If the program needs to write files, chances are you will have to enable <a href="#vfs-file-caching">VFS File Caching</a> as well (see also <a href="#limitations">limitations</a>). Note that the default write permission have some restrictions for accounts other than the owner, specifically it lacks the "write extended attributes", as explained next.</p> 2927 <p>The mapping of permissions is not always trivial, and the result you see in Windows Explorer may not be exactly like you expected. For example, when setting a value that includes write access for the group or others scope, this will be mapped to individual permissions "write attributes", "write data" and "append data", but not "write extended attributes". Windows will then show this as basic permission "Special" instead of "Write", because "Write" also covers the "write extended attributes" permission. When setting digit 0 for group or others, to indicate no permissions, they will still get individual permissions "read attributes", "read extended attributes" and "read permissions". This is done for compatibility reasons, e.g. to allow users without additional permissions to be able to read basic metadata about files like in Unix.</p> 2928 <p>WinFsp 2021 (version 1.9) introduced a new FUSE option "FileSecurity", that allows the complete specification of file security descriptors using <a href="https://docs.microsoft.com/en-us/windows/win32/secauthz/security-descriptor-string-format">SDDL</a>. With this you get detailed control of the resulting permissions, compared to use of the POSIX permissions described above, and no additional permissions will be added automatically for compatibility with Unix. Some example use cases will following.</p> 2929 <p>If you set POSIX permissions for only allowing access to the owner, using <code>--file-perms 0600 --dir-perms 0700</code>, the user group and the built-in "Everyone" group will still be given some special permissions, as described above. Some programs may then (incorrectly) interpret this as the file being accessible by everyone, for example an SSH client may warn about "unprotected private key file". You can work around this by specifying <code>-o FileSecurity="D:P(A;;FA;;;OW)"</code>, which sets file all access (FA) to the owner (OW), and nothing else.</p> 2930 <p>When setting write permissions then, except for the owner, this does not include the "write extended attributes" permission, as mentioned above. This may prevent applications from writing to files, giving permission denied error instead. To set working write permissions for the built-in "Everyone" group, similar to what it gets by default but with the addition of the "write extended attributes", you can specify <code>-o FileSecurity="D:P(A;;FRFW;;;WD)"</code>, which sets file read (FR) and file write (FW) to everyone (WD). If file execute (FX) is also needed, then change to <code>-o FileSecurity="D:P(A;;FRFWFX;;;WD)"</code>, or set file all access (FA) to get full access permissions, including delete, with <code>-o FileSecurity="D:P(A;;FA;;;WD)"</code>.</p> 2931 <h3 id="windows-caveats">Windows caveats</h3> 2932 <p>Drives created as Administrator are not visible to other accounts, not even an account that was elevated to Administrator with the User Account Control (UAC) feature. A result of this is that if you mount to a drive letter from a Command Prompt run as Administrator, and then try to access the same drive from Windows Explorer (which does not run as Administrator), you will not be able to see the mounted drive.</p> 2933 <p>If you don't need to access the drive from applications running with administrative privileges, the easiest way around this is to always create the mount from a non-elevated command prompt.</p> 2934 <p>To make mapped drives available to the user account that created them regardless if elevated or not, there is a special Windows setting called <a href="https://docs.microsoft.com/en-us/troubleshoot/windows-client/networking/mapped-drives-not-available-from-elevated-command#detail-to-configure-the-enablelinkedconnections-registry-entry">linked connections</a> that can be enabled.</p> 2935 <p>It is also possible to make a drive mount available to everyone on the system, by running the process creating it as the built-in SYSTEM account. There are several ways to do this: One is to use the command-line utility <a href="https://docs.microsoft.com/en-us/sysinternals/downloads/psexec">PsExec</a>, from Microsoft's Sysinternals suite, which has option <code>-s</code> to start processes as the SYSTEM account. Another alternative is to run the mount command from a Windows Scheduled Task, or a Windows Service, configured to run as the SYSTEM account. A third alternative is to use the <a href="https://github.com/winfsp/winfsp/wiki/WinFsp-Service-Architecture">WinFsp.Launcher infrastructure</a>). Read more in the <a href="https://rclone.org/install/">install documentation</a>. Note that when running rclone as another user, it will not use the configuration file from your profile unless you tell it to with the <a href="https://rclone.org/docs/#config-config-file"><code>--config</code></a> option. Note also that it is now the SYSTEM account that will have the owner permissions, and other accounts will have permissions according to the group or others scopes. As mentioned above, these will then not get the "write extended attributes" permission, and this may prevent writing to files. You can work around this with the FileSecurity option, see example above.</p> 2936 <p>Note that mapping to a directory path, instead of a drive letter, does not suffer from the same limitations.</p> 2937 <h2 id="mounting-on-macos">Mounting on macOS</h2> 2938 <p>Mounting on macOS can be done either via <a href="https://rclone.org/commands/rclone_serve_nfs/">built-in NFS server</a>, <a href="https://osxfuse.github.io/">macFUSE</a> (also known as osxfuse) or <a href="https://www.fuse-t.org/">FUSE-T</a>. macFUSE is a traditional FUSE driver utilizing a macOS kernel extension (kext). FUSE-T is an alternative FUSE system which "mounts" via an NFSv4 local server.</p> 2939 <h4 id="unicode-normalization">Unicode Normalization</h4> 2940 <p>It is highly recommended to keep the default of <code>--no-unicode-normalization=false</code> for all <code>mount</code> and <code>serve</code> commands on macOS. For details, see <a href="https://rclone.org/commands/rclone_mount/#vfs-case-sensitivity">vfs-case-sensitivity</a>.</p> 2941 <h3 id="nfs-mount">NFS mount</h3> 2942 <p>This method spins up an NFS server using <a href="https://rclone.org/commands/rclone_serve_nfs/">serve nfs</a> command and mounts it to the specified mountpoint. If you run this in background mode using |--daemon|, you will need to send SIGTERM signal to the rclone process using |kill| command to stop the mount.</p> 2943 <p>Note that <code>--nfs-cache-handle-limit</code> controls the maximum number of cached file handles stored by the <code>nfsmount</code> caching handler. This should not be set too low or you may experience errors when trying to access files. The default is 1000000, but consider lowering this limit if the server's system resource usage causes problems.</p> 2944 <h3 id="macfuse-notes">macFUSE Notes</h3> 2945 <p>If installing macFUSE using <a href="https://github.com/osxfuse/osxfuse/releases">dmg packages</a> from the website, rclone will locate the macFUSE libraries without any further intervention. If however, macFUSE is installed using the <a href="https://www.macports.org/">macports</a> package manager, the following addition steps are required.</p> 2946 <pre><code>sudo mkdir /usr/local/lib 2947 cd /usr/local/lib 2948 sudo ln -s /opt/local/lib/libfuse.2.dylib</code></pre> 2949 <h3 id="fuse-t-limitations-caveats-and-notes">FUSE-T Limitations, Caveats, and Notes</h3> 2950 <p>There are some limitations, caveats, and notes about how it works. These are current as of FUSE-T version 1.0.14.</p> 2951 <h4 id="modtime-update-on-read">ModTime update on read</h4> 2952 <p>As per the <a href="https://github.com/macos-fuse-t/fuse-t/wiki#caveats">FUSE-T wiki</a>:</p> 2953 <blockquote> 2954 <p>File access and modification times cannot be set separately as it seems to be an issue with the NFS client which always modifies both. Can be reproduced with 'touch -m' and 'touch -a' commands</p> 2955 </blockquote> 2956 <p>This means that viewing files with various tools, notably macOS Finder, will cause rlcone to update the modification time of the file. This may make rclone upload a full new copy of the file.</p> 2957 <h4 id="read-only-mounts">Read Only mounts</h4> 2958 <p>When mounting with <code>--read-only</code>, attempts to write to files will fail <em>silently</em> as opposed to with a clear warning as in macFUSE.</p> 2959 <h2 id="limitations">Limitations</h2> 2960 <p>Without the use of <code>--vfs-cache-mode</code> 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 <code>--vfs-cache-mode writes</code> or <code>--vfs-cache-mode full</code>. See the <a href="#vfs-file-caching">VFS File Caching</a> section for more info. When using NFS mount on macOS, if you don't specify |--vfs-cache-mode| the mount point will be read-only.</p> 2961 <p>The bucket-based remotes (e.g. Swift, S3, Google Compute Storage, B2) do not support the concept of empty directories, so empty directories will have a tendency to disappear once they fall out of the directory cache.</p> 2962 <p>When <code>rclone mount</code> is invoked on Unix with <code>--daemon</code> flag, the main rclone program will wait for the background mount to become ready or until the timeout specified by the <code>--daemon-wait</code> flag. On Linux it can check mount status using ProcFS so the flag in fact sets <strong>maximum</strong> time to wait, while the real wait can be less. On macOS / BSD the time to wait is constant and the check is performed only at the end. We advise you to set wait time on macOS reasonably.</p> 2963 <p>Only supported on Linux, FreeBSD, OS X and Windows at the moment.</p> 2964 <h2 id="rclone-mount-vs-rclone-synccopy">rclone mount vs rclone sync/copy</h2> 2965 <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="#vfs-file-caching">VFS File Caching</a> for solutions to make mount more reliable.</p> 2966 <h2 id="attribute-caching">Attribute caching</h2> 2967 <p>You can use the flag <code>--attr-timeout</code> to set the time the kernel caches the attributes (size, modification time, etc.) for directory entries.</p> 2968 <p>The default is <code>1s</code> which caches files just long enough to avoid too many callbacks to rclone from the kernel.</p> 2969 <p>In theory 0s should be the correct value for filesystems which can change outside the control of the kernel. However this causes quite a few problems such as <a href="https://github.com/rclone/rclone/issues/2157">rclone using too much memory</a>, <a href="https://forum.rclone.org/t/rclone-1-39-vs-1-40-mount-issue/5112">rclone not serving files to samba</a> and <a href="https://github.com/rclone/rclone/issues/2095#issuecomment-371141147">excessive time listing directories</a>.</p> 2970 <p>The kernel can cache the info about a file for the time given by <code>--attr-timeout</code>. 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 <code>--attr-timeout 1s</code> this is very unlikely but not impossible. The higher you set <code>--attr-timeout</code> the more likely it is. The default setting of "1s" is the lowest setting which mitigates the problems above.</p> 2971 <p>If you set it higher (<code>10s</code> or <code>1m</code> 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> 2972 <p>If files don't change on the remote outside of the control of rclone then there is no chance of corruption.</p> 2973 <p>This is the same as setting the attr_timeout option in mount.fuse.</p> 2974 <h2 id="filters">Filters</h2> 2975 <p>Note that all the rclone filters can be used to select a subset of the files to be visible in the mount.</p> 2976 <h2 id="systemd">systemd</h2> 2977 <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> 2978 <p>Note that systemd runs mount units without any environment variables including <code>PATH</code> or <code>HOME</code>. This means that tilde (<code>~</code>) expansion will not work and you should provide <code>--config</code> and <code>--cache-dir</code> explicitly as absolute paths via rclone arguments. Since mounting requires the <code>fusermount</code> program, rclone will use the fallback PATH of <code>/bin:/usr/bin</code> in this scenario. Please ensure that <code>fusermount</code> is present on this PATH.</p> 2979 <h2 id="rclone-as-unix-mount-helper">Rclone as Unix mount helper</h2> 2980 <p>The core Unix program <code>/bin/mount</code> normally takes the <code>-t FSTYPE</code> argument then runs the <code>/sbin/mount.FSTYPE</code> helper program passing it mount options as <code>-o key=val,...</code> or <code>--opt=...</code>. Automount (classic or systemd) behaves in a similar way.</p> 2981 <p>rclone by default expects GNU-style flags <code>--key val</code>. To run it as a mount helper you should symlink rclone binary to <code>/sbin/mount.rclone</code> and optionally <code>/usr/bin/rclonefs</code>, e.g. <code>ln -s /usr/bin/rclone /sbin/mount.rclone</code>. rclone will detect it and translate command-line arguments appropriately.</p> 2982 <p>Now you can run classic mounts like this:</p> 2983 <pre><code>mount sftp1:subdir /mnt/data -t rclone -o vfs_cache_mode=writes,sftp_key_file=/path/to/pem</code></pre> 2984 <p>or create systemd mount units:</p> 2985 <pre><code># /etc/systemd/system/mnt-data.mount 2986 [Unit] 2987 Description=Mount for /mnt/data 2988 [Mount] 2989 Type=rclone 2990 What=sftp1:subdir 2991 Where=/mnt/data 2992 Options=rw,_netdev,allow_other,args2env,vfs-cache-mode=writes,config=/etc/rclone.conf,cache-dir=/var/rclone</code></pre> 2993 <p>optionally accompanied by systemd automount unit</p> 2994 <pre><code># /etc/systemd/system/mnt-data.automount 2995 [Unit] 2996 Description=AutoMount for /mnt/data 2997 [Automount] 2998 Where=/mnt/data 2999 TimeoutIdleSec=600 3000 [Install] 3001 WantedBy=multi-user.target</code></pre> 3002 <p>or add in <code>/etc/fstab</code> a line like</p> 3003 <pre><code>sftp1:subdir /mnt/data rclone rw,noauto,nofail,_netdev,x-systemd.automount,args2env,vfs_cache_mode=writes,config=/etc/rclone.conf,cache_dir=/var/cache/rclone 0 0</code></pre> 3004 <p>or use classic Automountd. Remember to provide explicit <code>config=...,cache-dir=...</code> as a workaround for mount units being run without <code>HOME</code>.</p> 3005 <p>Rclone in the mount helper mode will split <code>-o</code> argument(s) by comma, replace <code>_</code> by <code>-</code> and prepend <code>--</code> to get the command-line flags. Options containing commas or spaces can be wrapped in single or double quotes. Any inner quotes inside outer quotes of the same type should be doubled.</p> 3006 <p>Mount option syntax includes a few extra options treated specially:</p> 3007 <ul> 3008 <li><code>env.NAME=VALUE</code> will set an environment variable for the mount process. This helps with Automountd and Systemd.mount which don't allow setting custom environment for mount helpers. Typically you will use <code>env.HTTPS_PROXY=proxy.host:3128</code> or <code>env.HOME=/root</code></li> 3009 <li><code>command=cmount</code> can be used to run <code>cmount</code> or any other rclone command rather than the default <code>mount</code>.</li> 3010 <li><code>args2env</code> will pass mount options to the mount helper running in background via environment variables instead of command line arguments. This allows to hide secrets from such commands as <code>ps</code> or <code>pgrep</code>.</li> 3011 <li><code>vv...</code> will be transformed into appropriate <code>--verbose=N</code></li> 3012 <li>standard mount options like <code>x-systemd.automount</code>, <code>_netdev</code>, <code>nosuid</code> and alike are intended only for Automountd and ignored by rclone. ## VFS - Virtual File System</li> 3013 </ul> 3014 <p>This command uses the VFS layer. This adapts the cloud storage objects that rclone uses into something which looks much more like a disk filing system.</p> 3015 <p>Cloud storage objects have lots of properties which aren't like disk files - you can't extend them or write to the middle of them, so the VFS layer has to deal with that. Because there is no one right way of doing this there are various options explained below.</p> 3016 <p>The VFS layer also implements a directory cache - this caches info about files and directories (but not the data) in memory.</p> 3017 <h2 id="vfs-directory-cache">VFS Directory Cache</h2> 3018 <p>Using the <code>--dir-cache-time</code> flag, you can control how long a directory should be considered up to date and not refreshed from the backend. Changes made through the VFS will appear immediately or invalidate the cache.</p> 3019 <pre><code>--dir-cache-time duration Time to cache directory entries for (default 5m0s) 3020 --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)</code></pre> 3021 <p>However, changes made directly on the cloud storage by the web interface or a different copy of rclone will only be picked up once the directory cache expires if the backend configured does not support polling for changes. If the backend supports polling, changes will be picked up within the polling interval.</p> 3022 <p>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> 3023 <pre><code>kill -SIGHUP $(pidof rclone)</code></pre> 3024 <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> 3025 <pre><code>rclone rc vfs/forget</code></pre> 3026 <p>Or individual files or directories:</p> 3027 <pre><code>rclone rc vfs/forget file=path/to/file dir=path/to/dir</code></pre> 3028 <h2 id="vfs-file-buffering">VFS File Buffering</h2> 3029 <p>The <code>--buffer-size</code> flag determines the amount of memory, that will be used to buffer data in advance.</p> 3030 <p>Each open file will try to keep the specified amount of data in memory at all times. The buffered data is bound to one open file and won't be shared.</p> 3031 <p>This flag is a upper limit for the used memory per open file. The buffer will only use memory for data that is downloaded but not not yet read. If the buffer is empty, only a small amount of memory will be used.</p> 3032 <p>The maximum memory used by rclone for buffering can be up to <code>--buffer-size * open files</code>.</p> 3033 <h2 id="vfs-file-caching">VFS File Caching</h2> 3034 <p>These flags control the VFS file caching options. File caching is necessary to make the VFS layer appear compatible with a normal file system. It can be disabled at the cost of some compatibility.</p> 3035 <p>For example you'll need to enable VFS caching if you want to read and write simultaneously to a file. See below for more details.</p> 3036 <p>Note that the VFS cache is separate from the cache backend and you may find that you need one or the other or both.</p> 3037 <pre><code>--cache-dir string Directory rclone will use for caching. 3038 --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) 3039 --vfs-cache-max-age duration Max time since last access of objects in the cache (default 1h0m0s) 3040 --vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off) 3041 --vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off) 3042 --vfs-cache-poll-interval duration Interval to poll the cache for stale objects (default 1m0s) 3043 --vfs-write-back duration Time to writeback files after last use when using cache (default 5s)</code></pre> 3044 <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> 3045 <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> 3046 <p>Note that files are written back to the remote only when they are closed and if they haven't been accessed for <code>--vfs-write-back</code> seconds. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags.</p> 3047 <p>If using <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-size</code> note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every <code>--vfs-cache-poll-interval</code>. Secondly because open files cannot be evicted from the cache. When <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-size</code> is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven't been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached.</p> 3048 <p>The <code>--vfs-cache-max-age</code> will evict files from the cache after the set time since last access has passed. The default value of 1 hour will start evicting files from cache that haven't been accessed for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0 and will wait for 1 more hour before evicting. Specify the time with standard notation, s, m, h, d, w .</p> 3049 <p>You <strong>should not</strong> run two copies of rclone using the same VFS cache with the same or overlapping remotes if using <code>--vfs-cache-mode > off</code>. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with <code>--cache-dir</code>. You don't need to worry about this if the remotes in use don't overlap.</p> 3050 <h3 id="vfs-cache-mode-off">--vfs-cache-mode off</h3> 3051 <p>In this mode (the default) the cache will read directly from the remote and write directly to the remote without caching anything on disk.</p> 3052 <p>This will mean some operations are not possible</p> 3053 <ul> 3054 <li>Files can't be opened for both read AND write</li> 3055 <li>Files opened for write can't be seeked</li> 3056 <li>Existing files opened for write must have O_TRUNC set</li> 3057 <li>Files open for read with O_TRUNC will be opened write only</li> 3058 <li>Files open for write only will behave as if O_TRUNC was supplied</li> 3059 <li>Open modes O_APPEND, O_TRUNC are ignored</li> 3060 <li>If an upload fails it can't be retried</li> 3061 </ul> 3062 <h3 id="vfs-cache-mode-minimal">--vfs-cache-mode minimal</h3> 3063 <p>This is very similar to "off" except that files opened for read AND write will be buffered to disk. This means that files opened for write will be a lot more compatible, but uses the minimal disk space.</p> 3064 <p>These operations are not possible</p> 3065 <ul> 3066 <li>Files opened for write only can't be seeked</li> 3067 <li>Existing files opened for write must have O_TRUNC set</li> 3068 <li>Files opened for write only will ignore O_APPEND, O_TRUNC</li> 3069 <li>If an upload fails it can't be retried</li> 3070 </ul> 3071 <h3 id="vfs-cache-mode-writes">--vfs-cache-mode writes</h3> 3072 <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> 3073 <p>This mode should support all normal file system operations.</p> 3074 <p>If an upload fails it will be retried at exponentially increasing intervals up to 1 minute.</p> 3075 <h3 id="vfs-cache-mode-full">--vfs-cache-mode full</h3> 3076 <p>In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well.</p> 3077 <p>In this mode the files in the cache will be sparse files and rclone will keep track of which bits of the files it has downloaded.</p> 3078 <p>So if an application only reads the starts of each file, then rclone will only buffer the start of the file. These files will appear to be their full size in the cache, but they will be sparse files with only the data that has been downloaded present in them.</p> 3079 <p>This mode should support all normal file system operations and is otherwise identical to <code>--vfs-cache-mode</code> writes.</p> 3080 <p>When reading a file rclone will read <code>--buffer-size</code> plus <code>--vfs-read-ahead</code> bytes ahead. The <code>--buffer-size</code> is buffered in memory whereas the <code>--vfs-read-ahead</code> is buffered on disk.</p> 3081 <p>When using this mode it is recommended that <code>--buffer-size</code> is not set too large and <code>--vfs-read-ahead</code> is set large if required.</p> 3082 <p><strong>IMPORTANT</strong> not all file systems support sparse files. In particular FAT/exFAT do not. Rclone will perform very badly if the cache directory is on a filesystem which doesn't support sparse files and it will log an ERROR message if one is detected.</p> 3083 <h3 id="fingerprinting">Fingerprinting</h3> 3084 <p>Various parts of the VFS use fingerprinting to see if a local file copy has changed relative to a remote file. Fingerprints are made from:</p> 3085 <ul> 3086 <li>size</li> 3087 <li>modification time</li> 3088 <li>hash</li> 3089 </ul> 3090 <p>where available on an object.</p> 3091 <p>On some backends some of these attributes are slow to read (they take an extra API call per object, or extra work per object).</p> 3092 <p>For example <code>hash</code> is slow with the <code>local</code> and <code>sftp</code> backends as they have to read the entire file and hash it, and <code>modtime</code> is slow with the <code>s3</code>, <code>swift</code>, <code>ftp</code> and <code>qinqstor</code> backends because they need to do an extra API call to fetch it.</p> 3093 <p>If you use the <code>--vfs-fast-fingerprint</code> flag then rclone will not include the slow operations in the fingerprint. This makes the fingerprinting less accurate but much faster and will improve the opening time of cached files.</p> 3094 <p>If you are running a vfs cache over <code>local</code>, <code>s3</code> or <code>swift</code> backends then using this flag is recommended.</p> 3095 <p>Note that if you change the value of this flag, the fingerprints of the files in the cache may be invalidated and the files will need to be downloaded again.</p> 3096 <h2 id="vfs-chunked-reading">VFS Chunked Reading</h2> 3097 <p>When rclone reads files from a remote it reads them in chunks. This means that rather than requesting the whole file rclone reads the chunk specified. This can reduce the used download quota for some remotes by requesting only chunks from the remote that are actually read, at the cost of an increased number of requests.</p> 3098 <p>These flags control the chunking:</p> 3099 <pre><code>--vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128M) 3100 --vfs-read-chunk-size-limit SizeSuffix Max chunk doubling size (default off)</code></pre> 3101 <p>Rclone will start reading a chunk of size <code>--vfs-read-chunk-size</code>, and then double the size for each read. When <code>--vfs-read-chunk-size-limit</code> is specified, and greater than <code>--vfs-read-chunk-size</code>, the chunk size for each open file will get doubled only until the specified value is reached. If the value is "off", which is the default, the limit is disabled and the chunk size will grow indefinitely.</p> 3102 <p>With <code>--vfs-read-chunk-size 100M</code> and <code>--vfs-read-chunk-size-limit 0</code> the following parts will be downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. When <code>--vfs-read-chunk-size-limit 500M</code> is specified, the result would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so on.</p> 3103 <p>Setting <code>--vfs-read-chunk-size</code> to <code>0</code> or "off" disables chunked reading.</p> 3104 <h2 id="vfs-performance">VFS Performance</h2> 3105 <p>These flags may be used to enable/disable features of the VFS for performance or other reasons. See also the <a href="#vfs-chunked-reading">chunked reading</a> feature.</p> 3106 <p>In particular S3 and Swift benefit hugely from the <code>--no-modtime</code> flag (or use <code>--use-server-modtime</code> for a slightly different effect) as each read of the modification time takes a transaction.</p> 3107 <pre><code>--no-checksum Don't compare checksums on up/download. 3108 --no-modtime Don't read/write the modification time (can speed things up). 3109 --no-seek Don't allow seeking in files. 3110 --read-only Only allow read-only access.</code></pre> 3111 <p>Sometimes rclone is delivered reads or writes out of order. Rather than seeking rclone will wait a short time for the in sequence read or write to come in. These flags only come into effect when not using an on disk cache file.</p> 3112 <pre><code>--vfs-read-wait duration Time to wait for in-sequence read before seeking (default 20ms) 3113 --vfs-write-wait duration Time to wait for in-sequence write before giving error (default 1s)</code></pre> 3114 <p>When using VFS write caching (<code>--vfs-cache-mode</code> with value writes or full), the global flag <code>--transfers</code> can be set to adjust the number of parallel uploads of modified files from the cache (the related global flag <code>--checkers</code> has no effect on the VFS).</p> 3115 <pre><code>--transfers int Number of file transfers to run in parallel (default 4)</code></pre> 3116 <h2 id="vfs-case-sensitivity">VFS Case Sensitivity</h2> 3117 <p>Linux file systems are case-sensitive: two files can differ only by case, and the exact case must be used when opening a file.</p> 3118 <p>File systems in modern Windows are case-insensitive but case-preserving: although existing files can be opened using any case, the exact case used to create the file is preserved and available for programs to query. It is not allowed for two files in the same directory to differ only by case.</p> 3119 <p>Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default.</p> 3120 <p>The <code>--vfs-case-insensitive</code> VFS flag controls how rclone handles these two cases. If its value is "false", rclone passes file names to the remote as-is. If the flag is "true" (or appears without a value on the command line), rclone may perform a "fixup" as explained below.</p> 3121 <p>The user may specify a file name to open/delete/rename/etc with a case different than what is stored on the remote. If an argument refers to an existing file with exactly the same name, then the case of the existing file on the disk will be used. However, if a file name with exactly the same name is not found but a name differing only by case exists, rclone will transparently fixup the name. This fixup happens only when an existing file is requested. Case sensitivity of file names created anew by rclone is controlled by the underlying remote.</p> 3122 <p>Note that case sensitivity of the operating system running rclone (the target) may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target.</p> 3123 <p>If the flag is not provided on the command line, then its default value depends on the operating system where rclone runs: "true" on Windows and macOS, "false" otherwise. If the flag is provided without a value, then it is "true".</p> 3124 <p>The <code>--no-unicode-normalization</code> flag controls whether a similar "fixup" is performed for filenames that differ but are <a href="https://en.wikipedia.org/wiki/Unicode_equivalence">canonically equivalent</a> with respect to unicode. Unicode normalization can be particularly helpful for users of macOS, which prefers form NFD instead of the NFC used by most other platforms. It is therefore highly recommended to keep the default of <code>false</code> on macOS, to avoid encoding compatibility issues.</p> 3125 <p>In the (probably unlikely) event that a directory has multiple duplicate filenames after applying case and unicode normalization, the <code>--vfs-block-norm-dupes</code> flag allows hiding these duplicates. This comes with a performance tradeoff, as rclone will have to scan the entire directory for duplicates when listing a directory. For this reason, it is recommended to leave this disabled if not needed. However, macOS users may wish to consider using it, as otherwise, if a remote directory contains both NFC and NFD versions of the same filename, an odd situation will occur: both versions of the file will be visible in the mount, and both will appear to be editable, however, editing either version will actually result in only the NFD version getting edited under the hood. <code>--vfs-block- norm-dupes</code> prevents this confusion by detecting this scenario, hiding the duplicates, and logging an error, similar to how this is handled in <code>rclone sync</code>.</p> 3126 <h2 id="vfs-disk-options">VFS Disk Options</h2> 3127 <p>This flag allows you to manually set the statistics about the filing system. It can be useful when those statistics cannot be read correctly automatically.</p> 3128 <pre><code>--vfs-disk-space-total-size Manually set the total disk space size (example: 256G, default: -1)</code></pre> 3129 <h2 id="alternate-report-of-used-bytes">Alternate report of used bytes</h2> 3130 <p>Some backends, most notably S3, do not report the amount of bytes used. If you need this information to be available when running <code>df</code> on the filesystem, then pass the flag <code>--vfs-used-is-size</code> to rclone. With this flag set, instead of relying on the backend to report this information, rclone will scan the whole remote similar to <code>rclone size</code> and compute the total used space itself.</p> 3131 <p><em>WARNING.</em> Contrary to <code>rclone size</code>, this flag ignores filters so that the result is accurate. However, this is very inefficient and may cost lots of API calls resulting in extra charges. Use it as a last resort and only with caching.</p> 3132 <pre><code>rclone mount remote:path /path/to/mountpoint [flags]</code></pre> 3133 <h2 id="options-59">Options</h2> 3134 <pre><code> --allow-non-empty Allow mounting over a non-empty directory (not supported on Windows) 3135 --allow-other Allow access to other users (not supported on Windows) 3136 --allow-root Allow access to root user (not supported on Windows) 3137 --async-read Use asynchronous reads (not supported on Windows) (default true) 3138 --attr-timeout Duration Time for which file/directory attributes are cached (default 1s) 3139 --daemon Run mount in background and exit parent process (as background output is suppressed, use --log-file with --log-format=pid,... to monitor) (not supported on Windows) 3140 --daemon-timeout Duration Time limit for rclone to respond to kernel (not supported on Windows) (default 0s) 3141 --daemon-wait Duration Time to wait for ready mount from daemon (maximum time on Linux, constant sleep time on OSX/BSD) (not supported on Windows) (default 1m0s) 3142 --debug-fuse Debug the FUSE internals - needs -v 3143 --default-permissions Makes kernel enforce access control based on the file mode (not supported on Windows) 3144 --devname string Set the device name - default is remote:path 3145 --dir-cache-time Duration Time to cache directory entries for (default 5m0s) 3146 --dir-perms FileMode Directory permissions (default 0777) 3147 --file-perms FileMode File permissions (default 0666) 3148 --fuse-flag stringArray Flags or arguments to be passed direct to libfuse/WinFsp (repeat if required) 3149 --gid uint32 Override the gid field set by the filesystem (not supported on Windows) (default 1000) 3150 -h, --help help for mount 3151 --max-read-ahead SizeSuffix The number of bytes that can be prefetched for sequential reads (not supported on Windows) (default 128Ki) 3152 --mount-case-insensitive Tristate Tell the OS the mount is case insensitive (true) or sensitive (false) regardless of the backend (auto) (default unset) 3153 --network-mode Mount as remote network drive, instead of fixed disk drive (supported on Windows only) 3154 --no-checksum Don't compare checksums on up/download 3155 --no-modtime Don't read/write the modification time (can speed things up) 3156 --no-seek Don't allow seeking in files 3157 --noappledouble Ignore Apple Double (._) and .DS_Store files (supported on OSX only) (default true) 3158 --noapplexattr Ignore all "com.apple.*" extended attributes (supported on OSX only) 3159 -o, --option stringArray Option for libfuse/WinFsp (repeat if required) 3160 --poll-interval Duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) 3161 --read-only Only allow read-only access 3162 --uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000) 3163 --umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2) 3164 --vfs-block-norm-dupes If duplicate filenames exist in the same directory (after normalization), log an error and hide the duplicates (may have a performance cost) 3165 --vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s) 3166 --vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off) 3167 --vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off) 3168 --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) 3169 --vfs-cache-poll-interval Duration Interval to poll the cache for stale objects (default 1m0s) 3170 --vfs-case-insensitive If a file name not found, find a case insensitive match 3171 --vfs-disk-space-total-size SizeSuffix Specify the total space of disk (default off) 3172 --vfs-fast-fingerprint Use fast (less accurate) fingerprints for change detection 3173 --vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full 3174 --vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128Mi) 3175 --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) 3176 --vfs-read-wait Duration Time to wait for in-sequence read before seeking (default 20ms) 3177 --vfs-refresh Refreshes the directory cache recursively in the background on start 3178 --vfs-used-is-size rclone size Use the rclone size algorithm for Used size 3179 --vfs-write-back Duration Time to writeback files after last use when using cache (default 5s) 3180 --vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s) 3181 --volname string Set the volume name (supported on Windows and OSX only) 3182 --write-back-cache Makes kernel buffer writes before sending them to rclone (without this, writethrough caching is used) (not supported on Windows)</code></pre> 3183 <h2 id="filter-options-19">Filter Options</h2> 3184 <p>Flags for filtering directory listings.</p> 3185 <pre><code> --delete-excluded Delete files on dest excluded from sync 3186 --exclude stringArray Exclude files matching pattern 3187 --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) 3188 --exclude-if-present stringArray Exclude directories if filename is present 3189 --files-from stringArray Read list of source-file names from file (use - to read from stdin) 3190 --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) 3191 -f, --filter stringArray Add a file filtering rule 3192 --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) 3193 --ignore-case Ignore case in filters (case insensitive) 3194 --include stringArray Include files matching pattern 3195 --include-from stringArray Read file include patterns from file (use - to read from stdin) 3196 --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) 3197 --max-depth int If set limits the recursion depth to this (default -1) 3198 --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) 3199 --metadata-exclude stringArray Exclude metadatas matching pattern 3200 --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) 3201 --metadata-filter stringArray Add a metadata filtering rule 3202 --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) 3203 --metadata-include stringArray Include metadatas matching pattern 3204 --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) 3205 --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) 3206 --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre> 3207 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 3208 <h1 id="see-also-59">SEE ALSO</h1> 3209 <ul> 3210 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 3211 </ul> 3212 <h1 id="rclone-moveto">rclone moveto</h1> 3213 <p>Move file or directory from source to dest.</p> 3214 <h2 id="synopsis-52">Synopsis</h2> 3215 <p>If source:path is a file or directory then it moves it to a file or directory named dest:path.</p> 3216 <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 <a href="https://rclone.org/commands/rclone_move/">move</a> command.</p> 3217 <p>So</p> 3218 <pre><code>rclone moveto src dst</code></pre> 3219 <p>where src and dst are rclone paths, either remote:path or /path/to/local or C:.</p> 3220 <p>This will:</p> 3221 <pre><code>if src is file 3222 move it to dst, overwriting an existing file if it exists 3223 if src is directory 3224 move it to dst, overwriting existing files if they exist 3225 see move command for full details</code></pre> 3226 <p>This doesn't transfer files that are identical on src and dst, testing by size and modification time or MD5SUM. src will be deleted on successful transfer.</p> 3227 <p><strong>Important</strong>: Since this can cause data loss, test first with the <code>--dry-run</code> or the <code>--interactive</code>/<code>-i</code> flag.</p> 3228 <p><strong>Note</strong>: Use the <code>-P</code>/<code>--progress</code> flag to view real-time transfer statistics.</p> 3229 <pre><code>rclone moveto source:path dest:path [flags]</code></pre> 3230 <h2 id="options-60">Options</h2> 3231 <pre><code> -h, --help help for moveto</code></pre> 3232 <h2 id="copy-options-5">Copy Options</h2> 3233 <p>Flags for anything which can Copy a file.</p> 3234 <pre><code> --check-first Do all the checks before starting transfers 3235 -c, --checksum Check for changes with size & checksum (if available, or fallback to size only). 3236 --compare-dest stringArray Include additional comma separated server-side paths during comparison 3237 --copy-dest stringArray Implies --compare-dest but also copies files from paths into destination 3238 --cutoff-mode HARD|SOFT|CAUTIOUS Mode to stop transfers when reaching the max transfer limit HARD|SOFT|CAUTIOUS (default HARD) 3239 --ignore-case-sync Ignore case when synchronizing 3240 --ignore-checksum Skip post copy check of checksums 3241 --ignore-existing Skip all files that exist on destination 3242 --ignore-size Ignore size when skipping use modtime or checksum 3243 -I, --ignore-times Don't skip items that match size and time - transfer all unconditionally 3244 --immutable Do not modify files, fail if existing files have been modified 3245 --inplace Download directly to destination file instead of atomic download to temp/rename 3246 --max-backlog int Maximum number of objects in sync or check backlog (default 10000) 3247 --max-duration Duration Maximum duration rclone will transfer data for (default 0s) 3248 --max-transfer SizeSuffix Maximum size of data to transfer (default off) 3249 -M, --metadata If set, preserve metadata when copying objects 3250 --modify-window Duration Max time diff to be considered the same (default 1ns) 3251 --multi-thread-chunk-size SizeSuffix Chunk size for multi-thread downloads / uploads, if not set by filesystem (default 64Mi) 3252 --multi-thread-cutoff SizeSuffix Use multi-thread downloads for files above this size (default 256Mi) 3253 --multi-thread-streams int Number of streams to use for multi-thread downloads (default 4) 3254 --multi-thread-write-buffer-size SizeSuffix In memory buffer size for writing when in multi-thread mode (default 128Ki) 3255 --no-check-dest Don't check the destination, copy regardless 3256 --no-traverse Don't traverse destination file system on copy 3257 --no-update-dir-modtime Don't update directory modification times 3258 --no-update-modtime Don't update destination modtime if files identical 3259 --order-by string Instructions on how to order the transfers, e.g. 'size,descending' 3260 --partial-suffix string Add partial-suffix to temporary file name when --inplace is not used (default ".partial") 3261 --refresh-times Refresh the modtime of remote files 3262 --server-side-across-configs Allow server-side operations (e.g. copy) to work across different configs 3263 --size-only Skip based on size only, not modtime or checksum 3264 --streaming-upload-cutoff SizeSuffix Cutoff for switching to chunked upload if file size is unknown, upload starts after reaching cutoff or when file ends (default 100Ki) 3265 -u, --update Skip files that are newer on the destination</code></pre> 3266 <h2 id="important-options-14">Important Options</h2> 3267 <p>Important flags useful for most commands.</p> 3268 <pre><code> -n, --dry-run Do a trial run with no permanent changes 3269 -i, --interactive Enable interactive mode 3270 -v, --verbose count Print lots more stuff (repeat for more)</code></pre> 3271 <h2 id="filter-options-20">Filter Options</h2> 3272 <p>Flags for filtering directory listings.</p> 3273 <pre><code> --delete-excluded Delete files on dest excluded from sync 3274 --exclude stringArray Exclude files matching pattern 3275 --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) 3276 --exclude-if-present stringArray Exclude directories if filename is present 3277 --files-from stringArray Read list of source-file names from file (use - to read from stdin) 3278 --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) 3279 -f, --filter stringArray Add a file filtering rule 3280 --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) 3281 --ignore-case Ignore case in filters (case insensitive) 3282 --include stringArray Include files matching pattern 3283 --include-from stringArray Read file include patterns from file (use - to read from stdin) 3284 --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) 3285 --max-depth int If set limits the recursion depth to this (default -1) 3286 --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) 3287 --metadata-exclude stringArray Exclude metadatas matching pattern 3288 --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) 3289 --metadata-filter stringArray Add a metadata filtering rule 3290 --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) 3291 --metadata-include stringArray Include metadatas matching pattern 3292 --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) 3293 --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) 3294 --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre> 3295 <h2 id="listing-options-18">Listing Options</h2> 3296 <p>Flags for listing directories.</p> 3297 <pre><code> --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) 3298 --fast-list Use recursive list if available; uses more memory but fewer transactions</code></pre> 3299 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 3300 <h1 id="see-also-60">SEE ALSO</h1> 3301 <ul> 3302 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 3303 </ul> 3304 <h1 id="rclone-ncdu">rclone ncdu</h1> 3305 <p>Explore a remote with a text based user interface.</p> 3306 <h2 id="synopsis-53">Synopsis</h2> 3307 <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> 3308 <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> 3309 <p>You can interact with the user interface using key presses, press '?' to toggle the help on and off. The supported keys are:</p> 3310 <pre><code> ↑,↓ or k,j to Move 3311 →,l to enter 3312 ←,h to return 3313 g toggle graph 3314 c toggle counts 3315 a toggle average size in directory 3316 m toggle modified time 3317 u toggle human-readable format 3318 n,s,C,A,M sort by name,size,count,asize,mtime 3319 d delete file/directory 3320 v select file/directory 3321 V enter visual select mode 3322 D delete selected files/directories 3323 y copy current path to clipboard 3324 Y display current path 3325 ^L refresh screen (fix screen corruption) 3326 r recalculate file sizes 3327 ? to toggle help on and off 3328 q/ESC/^c to quit</code></pre> 3329 <p>Listed files/directories may be prefixed by a one-character flag, some of them combined with a description in brackets at end of line. These flags have the following meaning:</p> 3330 <pre><code>e means this is an empty directory, i.e. contains no files (but 3331 may contain empty subdirectories) 3332 ~ means this is a directory where some of the files (possibly in 3333 subdirectories) have unknown size, and therefore the directory 3334 size may be underestimated (and average size inaccurate, as it 3335 is average of the files with known sizes). 3336 . means an error occurred while reading a subdirectory, and 3337 therefore the directory size may be underestimated (and average 3338 size inaccurate) 3339 ! means an error occurred while reading this directory</code></pre> 3340 <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> 3341 <p>Note that it might take some time to delete big files/directories. The UI won't respond in the meantime since the deletion is done synchronously.</p> 3342 <p>For a non-interactive listing of the remote, see the <a href="https://rclone.org/commands/rclone_tree/">tree</a> command. To just get the total size of the remote you can also use the <a href="https://rclone.org/commands/rclone_size/">size</a> command.</p> 3343 <pre><code>rclone ncdu remote:path [flags]</code></pre> 3344 <h2 id="options-61">Options</h2> 3345 <pre><code> -h, --help help for ncdu</code></pre> 3346 <h2 id="filter-options-21">Filter Options</h2> 3347 <p>Flags for filtering directory listings.</p> 3348 <pre><code> --delete-excluded Delete files on dest excluded from sync 3349 --exclude stringArray Exclude files matching pattern 3350 --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) 3351 --exclude-if-present stringArray Exclude directories if filename is present 3352 --files-from stringArray Read list of source-file names from file (use - to read from stdin) 3353 --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) 3354 -f, --filter stringArray Add a file filtering rule 3355 --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) 3356 --ignore-case Ignore case in filters (case insensitive) 3357 --include stringArray Include files matching pattern 3358 --include-from stringArray Read file include patterns from file (use - to read from stdin) 3359 --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) 3360 --max-depth int If set limits the recursion depth to this (default -1) 3361 --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) 3362 --metadata-exclude stringArray Exclude metadatas matching pattern 3363 --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) 3364 --metadata-filter stringArray Add a metadata filtering rule 3365 --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) 3366 --metadata-include stringArray Include metadatas matching pattern 3367 --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) 3368 --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) 3369 --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre> 3370 <h2 id="listing-options-19">Listing Options</h2> 3371 <p>Flags for listing directories.</p> 3372 <pre><code> --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) 3373 --fast-list Use recursive list if available; uses more memory but fewer transactions</code></pre> 3374 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 3375 <h1 id="see-also-61">SEE ALSO</h1> 3376 <ul> 3377 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 3378 </ul> 3379 <h1 id="rclone-nfsmount">rclone nfsmount</h1> 3380 <p>Mount the remote as file system on a mountpoint.</p> 3381 <h2 id="synopsis-54">Synopsis</h2> 3382 <p>rclone nfsmount allows Linux, FreeBSD, macOS and Windows to mount any of Rclone's cloud storage systems as a file system with FUSE.</p> 3383 <p>First set up your remote using <code>rclone config</code>. Check it works with <code>rclone ls</code> etc.</p> 3384 <p>On Linux and macOS, you can run mount in either foreground or background (aka daemon) mode. Mount runs in foreground mode by default. Use the <code>--daemon</code> flag to force background mode. On Windows you can run mount in foreground only, the flag is ignored.</p> 3385 <p>In background mode rclone acts as a generic Unix mount program: the main program starts, spawns background rclone process to setup and maintain the mount, waits until success or timeout and exits with appropriate code (killing the child process if it fails).</p> 3386 <p>On Linux/macOS/FreeBSD start the mount like this, where <code>/path/to/local/mount</code> is an <strong>empty</strong> <strong>existing</strong> directory:</p> 3387 <pre><code>rclone nfsmount remote:path/to/files /path/to/local/mount</code></pre> 3388 <p>On Windows you can start a mount in different ways. See <a href="#mounting-modes-on-windows">below</a> for details. If foreground mount is used interactively from a console window, rclone will serve the mount and occupy the console so another window should be used to work with the mount until rclone is interrupted e.g. by pressing Ctrl-C.</p> 3389 <p>The following examples will mount to an automatically assigned drive, to specific drive letter <code>X:</code>, to path <code>C:\path\parent\mount</code> (where parent directory or drive must exist, and mount must <strong>not</strong> exist, and is not supported when <a href="#mounting-modes-on-windows">mounting as a network drive</a>), and the last example will mount as network share <code>\\cloud\remote</code> and map it to an automatically assigned drive:</p> 3390 <pre><code>rclone nfsmount remote:path/to/files * 3391 rclone nfsmount remote:path/to/files X: 3392 rclone nfsmount remote:path/to/files C:\path\parent\mount 3393 rclone nfsmount remote:path/to/files \\cloud\remote</code></pre> 3394 <p>When the program ends while in foreground mode, either via Ctrl+C or receiving a SIGINT or SIGTERM signal, the mount should be automatically stopped.</p> 3395 <p>When running in background mode the user will have to stop the mount manually:</p> 3396 <pre><code># Linux 3397 fusermount -u /path/to/local/mount 3398 # OS X 3399 umount /path/to/local/mount</code></pre> 3400 <p>The umount operation can fail, for example when the mountpoint is busy. When that happens, it is the user's responsibility to stop the mount manually.</p> 3401 <p>The size of the mounted file system will be set according to information retrieved from the remote, the same as returned by the <a href="https://rclone.org/commands/rclone_about/">rclone about</a> command. Remotes with unlimited storage may report the used size only, then an additional 1 PiB of free space is assumed. If the remote does not <a href="https://rclone.org/overview/#optional-features">support</a> the about feature at all, then 1 PiB is set as both the total and the free size.</p> 3402 <h2 id="installing-on-windows-1">Installing on Windows</h2> 3403 <p>To run rclone nfsmount on Windows, you will need to download and install <a href="http://www.secfs.net/winfsp/">WinFsp</a>.</p> 3404 <p><a href="https://github.com/winfsp/winfsp">WinFsp</a> is an open-source Windows File System Proxy which makes it easy to write user space file systems for Windows. It provides a FUSE emulation layer which rclone uses combination with <a href="https://github.com/winfsp/cgofuse">cgofuse</a>. Both of these packages are by Bill Zissimopoulos who was very helpful during the implementation of rclone nfsmount for Windows.</p> 3405 <h3 id="mounting-modes-on-windows-1">Mounting modes on windows</h3> 3406 <p>Unlike other operating systems, Microsoft Windows provides a different filesystem type for network and fixed drives. It optimises access on the assumption fixed disk drives are fast and reliable, while network drives have relatively high latency and less reliability. Some settings can also be differentiated between the two types, for example that Windows Explorer should just display icons and not create preview thumbnails for image and video files on network drives.</p> 3407 <p>In most cases, rclone will mount the remote as a normal, fixed disk drive by default. However, you can also choose to mount it as a remote network drive, often described as a network share. If you mount an rclone remote using the default, fixed drive mode and experience unexpected program errors, freezes or other issues, consider mounting as a network drive instead.</p> 3408 <p>When mounting as a fixed disk drive you can either mount to an unused drive letter, or to a path representing a <strong>nonexistent</strong> subdirectory of an <strong>existing</strong> parent directory or drive. Using the special value <code>*</code> will tell rclone to automatically assign the next available drive letter, starting with Z: and moving backward. Examples:</p> 3409 <pre><code>rclone nfsmount remote:path/to/files * 3410 rclone nfsmount remote:path/to/files X: 3411 rclone nfsmount remote:path/to/files C:\path\parent\mount 3412 rclone nfsmount remote:path/to/files X:</code></pre> 3413 <p>Option <code>--volname</code> can be used to set a custom volume name for the mounted file system. The default is to use the remote name and path.</p> 3414 <p>To mount as network drive, you can add option <code>--network-mode</code> to your nfsmount command. Mounting to a directory path is not supported in this mode, it is a limitation Windows imposes on junctions, so the remote must always be mounted to a drive letter.</p> 3415 <pre><code>rclone nfsmount remote:path/to/files X: --network-mode</code></pre> 3416 <p>A volume name specified with <code>--volname</code> will be used to create the network share path. A complete UNC path, such as <code>\\cloud\remote</code>, optionally with path <code>\\cloud\remote\madeup\path</code>, will be used as is. Any other string will be used as the share part, after a default prefix <code>\\server\</code>. If no volume name is specified then <code>\\server\share</code> will be used. You must make sure the volume name is unique when you are mounting more than one drive, or else the mount command will fail. The share name will treated as the volume label for the mapped drive, shown in Windows Explorer etc, while the complete <code>\\server\share</code> will be reported as the remote UNC path by <code>net use</code> etc, just like a normal network drive mapping.</p> 3417 <p>If you specify a full network share UNC path with <code>--volname</code>, this will implicitly set the <code>--network-mode</code> option, so the following two examples have same result:</p> 3418 <pre><code>rclone nfsmount remote:path/to/files X: --network-mode 3419 rclone nfsmount remote:path/to/files X: --volname \\server\share</code></pre> 3420 <p>You may also specify the network share UNC path as the mountpoint itself. Then rclone will automatically assign a drive letter, same as with <code>*</code> and use that as mountpoint, and instead use the UNC path specified as the volume name, as if it were specified with the <code>--volname</code> option. This will also implicitly set the <code>--network-mode</code> option. This means the following two examples have same result:</p> 3421 <pre><code>rclone nfsmount remote:path/to/files \\cloud\remote 3422 rclone nfsmount remote:path/to/files * --volname \\cloud\remote</code></pre> 3423 <p>There is yet another way to enable network mode, and to set the share path, and that is to pass the "native" libfuse/WinFsp option directly: <code>--fuse-flag --VolumePrefix=\server\share</code>. Note that the path must be with just a single backslash prefix in this case.</p> 3424 <p><em>Note:</em> In previous versions of rclone this was the only supported method.</p> 3425 <p><a href="https://en.wikipedia.org/wiki/Drive_mapping">Read more about drive mapping</a></p> 3426 <p>See also <a href="#limitations">Limitations</a> section below.</p> 3427 <h3 id="windows-filesystem-permissions-1">Windows filesystem permissions</h3> 3428 <p>The FUSE emulation layer on Windows must convert between the POSIX-based permission model used in FUSE, and the permission model used in Windows, based on access-control lists (ACL).</p> 3429 <p>The mounted filesystem will normally get three entries in its access-control list (ACL), representing permissions for the POSIX permission scopes: Owner, group and others. By default, the owner and group will be taken from the current user, and the built-in group "Everyone" will be used to represent others. The user/group can be customized with FUSE options "UserName" and "GroupName", e.g. <code>-o UserName=user123 -o GroupName="Authenticated Users"</code>. The permissions on each entry will be set according to <a href="#options">options</a> <code>--dir-perms</code> and <code>--file-perms</code>, which takes a value in traditional Unix <a href="https://en.wikipedia.org/wiki/File-system_permissions#Numeric_notation">numeric notation</a>.</p> 3430 <p>The default permissions corresponds to <code>--file-perms 0666 --dir-perms 0777</code>, i.e. read and write permissions to everyone. This means you will not be able to start any programs from the mount. To be able to do that you must add execute permissions, e.g. <code>--file-perms 0777 --dir-perms 0777</code> to add it to everyone. If the program needs to write files, chances are you will have to enable <a href="#vfs-file-caching">VFS File Caching</a> as well (see also <a href="#limitations">limitations</a>). Note that the default write permission have some restrictions for accounts other than the owner, specifically it lacks the "write extended attributes", as explained next.</p> 3431 <p>The mapping of permissions is not always trivial, and the result you see in Windows Explorer may not be exactly like you expected. For example, when setting a value that includes write access for the group or others scope, this will be mapped to individual permissions "write attributes", "write data" and "append data", but not "write extended attributes". Windows will then show this as basic permission "Special" instead of "Write", because "Write" also covers the "write extended attributes" permission. When setting digit 0 for group or others, to indicate no permissions, they will still get individual permissions "read attributes", "read extended attributes" and "read permissions". This is done for compatibility reasons, e.g. to allow users without additional permissions to be able to read basic metadata about files like in Unix.</p> 3432 <p>WinFsp 2021 (version 1.9) introduced a new FUSE option "FileSecurity", that allows the complete specification of file security descriptors using <a href="https://docs.microsoft.com/en-us/windows/win32/secauthz/security-descriptor-string-format">SDDL</a>. With this you get detailed control of the resulting permissions, compared to use of the POSIX permissions described above, and no additional permissions will be added automatically for compatibility with Unix. Some example use cases will following.</p> 3433 <p>If you set POSIX permissions for only allowing access to the owner, using <code>--file-perms 0600 --dir-perms 0700</code>, the user group and the built-in "Everyone" group will still be given some special permissions, as described above. Some programs may then (incorrectly) interpret this as the file being accessible by everyone, for example an SSH client may warn about "unprotected private key file". You can work around this by specifying <code>-o FileSecurity="D:P(A;;FA;;;OW)"</code>, which sets file all access (FA) to the owner (OW), and nothing else.</p> 3434 <p>When setting write permissions then, except for the owner, this does not include the "write extended attributes" permission, as mentioned above. This may prevent applications from writing to files, giving permission denied error instead. To set working write permissions for the built-in "Everyone" group, similar to what it gets by default but with the addition of the "write extended attributes", you can specify <code>-o FileSecurity="D:P(A;;FRFW;;;WD)"</code>, which sets file read (FR) and file write (FW) to everyone (WD). If file execute (FX) is also needed, then change to <code>-o FileSecurity="D:P(A;;FRFWFX;;;WD)"</code>, or set file all access (FA) to get full access permissions, including delete, with <code>-o FileSecurity="D:P(A;;FA;;;WD)"</code>.</p> 3435 <h3 id="windows-caveats-1">Windows caveats</h3> 3436 <p>Drives created as Administrator are not visible to other accounts, not even an account that was elevated to Administrator with the User Account Control (UAC) feature. A result of this is that if you mount to a drive letter from a Command Prompt run as Administrator, and then try to access the same drive from Windows Explorer (which does not run as Administrator), you will not be able to see the mounted drive.</p> 3437 <p>If you don't need to access the drive from applications running with administrative privileges, the easiest way around this is to always create the mount from a non-elevated command prompt.</p> 3438 <p>To make mapped drives available to the user account that created them regardless if elevated or not, there is a special Windows setting called <a href="https://docs.microsoft.com/en-us/troubleshoot/windows-client/networking/mapped-drives-not-available-from-elevated-command#detail-to-configure-the-enablelinkedconnections-registry-entry">linked connections</a> that can be enabled.</p> 3439 <p>It is also possible to make a drive mount available to everyone on the system, by running the process creating it as the built-in SYSTEM account. There are several ways to do this: One is to use the command-line utility <a href="https://docs.microsoft.com/en-us/sysinternals/downloads/psexec">PsExec</a>, from Microsoft's Sysinternals suite, which has option <code>-s</code> to start processes as the SYSTEM account. Another alternative is to run the mount command from a Windows Scheduled Task, or a Windows Service, configured to run as the SYSTEM account. A third alternative is to use the <a href="https://github.com/winfsp/winfsp/wiki/WinFsp-Service-Architecture">WinFsp.Launcher infrastructure</a>). Read more in the <a href="https://rclone.org/install/">install documentation</a>. Note that when running rclone as another user, it will not use the configuration file from your profile unless you tell it to with the <a href="https://rclone.org/docs/#config-config-file"><code>--config</code></a> option. Note also that it is now the SYSTEM account that will have the owner permissions, and other accounts will have permissions according to the group or others scopes. As mentioned above, these will then not get the "write extended attributes" permission, and this may prevent writing to files. You can work around this with the FileSecurity option, see example above.</p> 3440 <p>Note that mapping to a directory path, instead of a drive letter, does not suffer from the same limitations.</p> 3441 <h2 id="mounting-on-macos-1">Mounting on macOS</h2> 3442 <p>Mounting on macOS can be done either via <a href="https://rclone.org/commands/rclone_serve_nfs/">built-in NFS server</a>, <a href="https://osxfuse.github.io/">macFUSE</a> (also known as osxfuse) or <a href="https://www.fuse-t.org/">FUSE-T</a>. macFUSE is a traditional FUSE driver utilizing a macOS kernel extension (kext). FUSE-T is an alternative FUSE system which "mounts" via an NFSv4 local server.</p> 3443 <h4 id="unicode-normalization-1">Unicode Normalization</h4> 3444 <p>It is highly recommended to keep the default of <code>--no-unicode-normalization=false</code> for all <code>mount</code> and <code>serve</code> commands on macOS. For details, see <a href="https://rclone.org/commands/rclone_mount/#vfs-case-sensitivity">vfs-case-sensitivity</a>.</p> 3445 <h3 id="nfs-mount-1">NFS mount</h3> 3446 <p>This method spins up an NFS server using <a href="https://rclone.org/commands/rclone_serve_nfs/">serve nfs</a> command and mounts it to the specified mountpoint. If you run this in background mode using |--daemon|, you will need to send SIGTERM signal to the rclone process using |kill| command to stop the mount.</p> 3447 <p>Note that <code>--nfs-cache-handle-limit</code> controls the maximum number of cached file handles stored by the <code>nfsmount</code> caching handler. This should not be set too low or you may experience errors when trying to access files. The default is 1000000, but consider lowering this limit if the server's system resource usage causes problems.</p> 3448 <h3 id="macfuse-notes-1">macFUSE Notes</h3> 3449 <p>If installing macFUSE using <a href="https://github.com/osxfuse/osxfuse/releases">dmg packages</a> from the website, rclone will locate the macFUSE libraries without any further intervention. If however, macFUSE is installed using the <a href="https://www.macports.org/">macports</a> package manager, the following addition steps are required.</p> 3450 <pre><code>sudo mkdir /usr/local/lib 3451 cd /usr/local/lib 3452 sudo ln -s /opt/local/lib/libfuse.2.dylib</code></pre> 3453 <h3 id="fuse-t-limitations-caveats-and-notes-1">FUSE-T Limitations, Caveats, and Notes</h3> 3454 <p>There are some limitations, caveats, and notes about how it works. These are current as of FUSE-T version 1.0.14.</p> 3455 <h4 id="modtime-update-on-read-1">ModTime update on read</h4> 3456 <p>As per the <a href="https://github.com/macos-fuse-t/fuse-t/wiki#caveats">FUSE-T wiki</a>:</p> 3457 <blockquote> 3458 <p>File access and modification times cannot be set separately as it seems to be an issue with the NFS client which always modifies both. Can be reproduced with 'touch -m' and 'touch -a' commands</p> 3459 </blockquote> 3460 <p>This means that viewing files with various tools, notably macOS Finder, will cause rlcone to update the modification time of the file. This may make rclone upload a full new copy of the file.</p> 3461 <h4 id="read-only-mounts-1">Read Only mounts</h4> 3462 <p>When mounting with <code>--read-only</code>, attempts to write to files will fail <em>silently</em> as opposed to with a clear warning as in macFUSE.</p> 3463 <h2 id="limitations-1">Limitations</h2> 3464 <p>Without the use of <code>--vfs-cache-mode</code> 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 <code>--vfs-cache-mode writes</code> or <code>--vfs-cache-mode full</code>. See the <a href="#vfs-file-caching">VFS File Caching</a> section for more info. When using NFS mount on macOS, if you don't specify |--vfs-cache-mode| the mount point will be read-only.</p> 3465 <p>The bucket-based remotes (e.g. Swift, S3, Google Compute Storage, B2) do not support the concept of empty directories, so empty directories will have a tendency to disappear once they fall out of the directory cache.</p> 3466 <p>When <code>rclone mount</code> is invoked on Unix with <code>--daemon</code> flag, the main rclone program will wait for the background mount to become ready or until the timeout specified by the <code>--daemon-wait</code> flag. On Linux it can check mount status using ProcFS so the flag in fact sets <strong>maximum</strong> time to wait, while the real wait can be less. On macOS / BSD the time to wait is constant and the check is performed only at the end. We advise you to set wait time on macOS reasonably.</p> 3467 <p>Only supported on Linux, FreeBSD, OS X and Windows at the moment.</p> 3468 <h2 id="rclone-nfsmount-vs-rclone-synccopy">rclone nfsmount vs rclone sync/copy</h2> 3469 <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 nfsmount can't use retries in the same way without making local copies of the uploads. Look at the <a href="#vfs-file-caching">VFS File Caching</a> for solutions to make nfsmount more reliable.</p> 3470 <h2 id="attribute-caching-1">Attribute caching</h2> 3471 <p>You can use the flag <code>--attr-timeout</code> to set the time the kernel caches the attributes (size, modification time, etc.) for directory entries.</p> 3472 <p>The default is <code>1s</code> which caches files just long enough to avoid too many callbacks to rclone from the kernel.</p> 3473 <p>In theory 0s should be the correct value for filesystems which can change outside the control of the kernel. However this causes quite a few problems such as <a href="https://github.com/rclone/rclone/issues/2157">rclone using too much memory</a>, <a href="https://forum.rclone.org/t/rclone-1-39-vs-1-40-mount-issue/5112">rclone not serving files to samba</a> and <a href="https://github.com/rclone/rclone/issues/2095#issuecomment-371141147">excessive time listing directories</a>.</p> 3474 <p>The kernel can cache the info about a file for the time given by <code>--attr-timeout</code>. 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 <code>--attr-timeout 1s</code> this is very unlikely but not impossible. The higher you set <code>--attr-timeout</code> the more likely it is. The default setting of "1s" is the lowest setting which mitigates the problems above.</p> 3475 <p>If you set it higher (<code>10s</code> or <code>1m</code> 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> 3476 <p>If files don't change on the remote outside of the control of rclone then there is no chance of corruption.</p> 3477 <p>This is the same as setting the attr_timeout option in mount.fuse.</p> 3478 <h2 id="filters-1">Filters</h2> 3479 <p>Note that all the rclone filters can be used to select a subset of the files to be visible in the mount.</p> 3480 <h2 id="systemd-1">systemd</h2> 3481 <p>When running rclone nfsmount as a systemd service, it is possible to use Type=notify. In this case the service will enter the started state after the mountpoint has been successfully set up. Units having the rclone nfsmount service specified as a requirement will see all files and folders immediately in this mode.</p> 3482 <p>Note that systemd runs mount units without any environment variables including <code>PATH</code> or <code>HOME</code>. This means that tilde (<code>~</code>) expansion will not work and you should provide <code>--config</code> and <code>--cache-dir</code> explicitly as absolute paths via rclone arguments. Since mounting requires the <code>fusermount</code> program, rclone will use the fallback PATH of <code>/bin:/usr/bin</code> in this scenario. Please ensure that <code>fusermount</code> is present on this PATH.</p> 3483 <h2 id="rclone-as-unix-mount-helper-1">Rclone as Unix mount helper</h2> 3484 <p>The core Unix program <code>/bin/mount</code> normally takes the <code>-t FSTYPE</code> argument then runs the <code>/sbin/mount.FSTYPE</code> helper program passing it mount options as <code>-o key=val,...</code> or <code>--opt=...</code>. Automount (classic or systemd) behaves in a similar way.</p> 3485 <p>rclone by default expects GNU-style flags <code>--key val</code>. To run it as a mount helper you should symlink rclone binary to <code>/sbin/mount.rclone</code> and optionally <code>/usr/bin/rclonefs</code>, e.g. <code>ln -s /usr/bin/rclone /sbin/mount.rclone</code>. rclone will detect it and translate command-line arguments appropriately.</p> 3486 <p>Now you can run classic mounts like this:</p> 3487 <pre><code>mount sftp1:subdir /mnt/data -t rclone -o vfs_cache_mode=writes,sftp_key_file=/path/to/pem</code></pre> 3488 <p>or create systemd mount units:</p> 3489 <pre><code># /etc/systemd/system/mnt-data.mount 3490 [Unit] 3491 Description=Mount for /mnt/data 3492 [Mount] 3493 Type=rclone 3494 What=sftp1:subdir 3495 Where=/mnt/data 3496 Options=rw,_netdev,allow_other,args2env,vfs-cache-mode=writes,config=/etc/rclone.conf,cache-dir=/var/rclone</code></pre> 3497 <p>optionally accompanied by systemd automount unit</p> 3498 <pre><code># /etc/systemd/system/mnt-data.automount 3499 [Unit] 3500 Description=AutoMount for /mnt/data 3501 [Automount] 3502 Where=/mnt/data 3503 TimeoutIdleSec=600 3504 [Install] 3505 WantedBy=multi-user.target</code></pre> 3506 <p>or add in <code>/etc/fstab</code> a line like</p> 3507 <pre><code>sftp1:subdir /mnt/data rclone rw,noauto,nofail,_netdev,x-systemd.automount,args2env,vfs_cache_mode=writes,config=/etc/rclone.conf,cache_dir=/var/cache/rclone 0 0</code></pre> 3508 <p>or use classic Automountd. Remember to provide explicit <code>config=...,cache-dir=...</code> as a workaround for mount units being run without <code>HOME</code>.</p> 3509 <p>Rclone in the mount helper mode will split <code>-o</code> argument(s) by comma, replace <code>_</code> by <code>-</code> and prepend <code>--</code> to get the command-line flags. Options containing commas or spaces can be wrapped in single or double quotes. Any inner quotes inside outer quotes of the same type should be doubled.</p> 3510 <p>Mount option syntax includes a few extra options treated specially:</p> 3511 <ul> 3512 <li><code>env.NAME=VALUE</code> will set an environment variable for the mount process. This helps with Automountd and Systemd.mount which don't allow setting custom environment for mount helpers. Typically you will use <code>env.HTTPS_PROXY=proxy.host:3128</code> or <code>env.HOME=/root</code></li> 3513 <li><code>command=cmount</code> can be used to run <code>cmount</code> or any other rclone command rather than the default <code>mount</code>.</li> 3514 <li><code>args2env</code> will pass mount options to the mount helper running in background via environment variables instead of command line arguments. This allows to hide secrets from such commands as <code>ps</code> or <code>pgrep</code>.</li> 3515 <li><code>vv...</code> will be transformed into appropriate <code>--verbose=N</code></li> 3516 <li>standard mount options like <code>x-systemd.automount</code>, <code>_netdev</code>, <code>nosuid</code> and alike are intended only for Automountd and ignored by rclone. ## VFS - Virtual File System</li> 3517 </ul> 3518 <p>This command uses the VFS layer. This adapts the cloud storage objects that rclone uses into something which looks much more like a disk filing system.</p> 3519 <p>Cloud storage objects have lots of properties which aren't like disk files - you can't extend them or write to the middle of them, so the VFS layer has to deal with that. Because there is no one right way of doing this there are various options explained below.</p> 3520 <p>The VFS layer also implements a directory cache - this caches info about files and directories (but not the data) in memory.</p> 3521 <h2 id="vfs-directory-cache-1">VFS Directory Cache</h2> 3522 <p>Using the <code>--dir-cache-time</code> flag, you can control how long a directory should be considered up to date and not refreshed from the backend. Changes made through the VFS will appear immediately or invalidate the cache.</p> 3523 <pre><code>--dir-cache-time duration Time to cache directory entries for (default 5m0s) 3524 --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)</code></pre> 3525 <p>However, changes made directly on the cloud storage by the web interface or a different copy of rclone will only be picked up once the directory cache expires if the backend configured does not support polling for changes. If the backend supports polling, changes will be picked up within the polling interval.</p> 3526 <p>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> 3527 <pre><code>kill -SIGHUP $(pidof rclone)</code></pre> 3528 <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> 3529 <pre><code>rclone rc vfs/forget</code></pre> 3530 <p>Or individual files or directories:</p> 3531 <pre><code>rclone rc vfs/forget file=path/to/file dir=path/to/dir</code></pre> 3532 <h2 id="vfs-file-buffering-1">VFS File Buffering</h2> 3533 <p>The <code>--buffer-size</code> flag determines the amount of memory, that will be used to buffer data in advance.</p> 3534 <p>Each open file will try to keep the specified amount of data in memory at all times. The buffered data is bound to one open file and won't be shared.</p> 3535 <p>This flag is a upper limit for the used memory per open file. The buffer will only use memory for data that is downloaded but not not yet read. If the buffer is empty, only a small amount of memory will be used.</p> 3536 <p>The maximum memory used by rclone for buffering can be up to <code>--buffer-size * open files</code>.</p> 3537 <h2 id="vfs-file-caching-1">VFS File Caching</h2> 3538 <p>These flags control the VFS file caching options. File caching is necessary to make the VFS layer appear compatible with a normal file system. It can be disabled at the cost of some compatibility.</p> 3539 <p>For example you'll need to enable VFS caching if you want to read and write simultaneously to a file. See below for more details.</p> 3540 <p>Note that the VFS cache is separate from the cache backend and you may find that you need one or the other or both.</p> 3541 <pre><code>--cache-dir string Directory rclone will use for caching. 3542 --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) 3543 --vfs-cache-max-age duration Max time since last access of objects in the cache (default 1h0m0s) 3544 --vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off) 3545 --vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off) 3546 --vfs-cache-poll-interval duration Interval to poll the cache for stale objects (default 1m0s) 3547 --vfs-write-back duration Time to writeback files after last use when using cache (default 5s)</code></pre> 3548 <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> 3549 <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> 3550 <p>Note that files are written back to the remote only when they are closed and if they haven't been accessed for <code>--vfs-write-back</code> seconds. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags.</p> 3551 <p>If using <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-size</code> note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every <code>--vfs-cache-poll-interval</code>. Secondly because open files cannot be evicted from the cache. When <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-size</code> is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven't been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached.</p> 3552 <p>The <code>--vfs-cache-max-age</code> will evict files from the cache after the set time since last access has passed. The default value of 1 hour will start evicting files from cache that haven't been accessed for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0 and will wait for 1 more hour before evicting. Specify the time with standard notation, s, m, h, d, w .</p> 3553 <p>You <strong>should not</strong> run two copies of rclone using the same VFS cache with the same or overlapping remotes if using <code>--vfs-cache-mode > off</code>. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with <code>--cache-dir</code>. You don't need to worry about this if the remotes in use don't overlap.</p> 3554 <h3 id="vfs-cache-mode-off-1">--vfs-cache-mode off</h3> 3555 <p>In this mode (the default) the cache will read directly from the remote and write directly to the remote without caching anything on disk.</p> 3556 <p>This will mean some operations are not possible</p> 3557 <ul> 3558 <li>Files can't be opened for both read AND write</li> 3559 <li>Files opened for write can't be seeked</li> 3560 <li>Existing files opened for write must have O_TRUNC set</li> 3561 <li>Files open for read with O_TRUNC will be opened write only</li> 3562 <li>Files open for write only will behave as if O_TRUNC was supplied</li> 3563 <li>Open modes O_APPEND, O_TRUNC are ignored</li> 3564 <li>If an upload fails it can't be retried</li> 3565 </ul> 3566 <h3 id="vfs-cache-mode-minimal-1">--vfs-cache-mode minimal</h3> 3567 <p>This is very similar to "off" except that files opened for read AND write will be buffered to disk. This means that files opened for write will be a lot more compatible, but uses the minimal disk space.</p> 3568 <p>These operations are not possible</p> 3569 <ul> 3570 <li>Files opened for write only can't be seeked</li> 3571 <li>Existing files opened for write must have O_TRUNC set</li> 3572 <li>Files opened for write only will ignore O_APPEND, O_TRUNC</li> 3573 <li>If an upload fails it can't be retried</li> 3574 </ul> 3575 <h3 id="vfs-cache-mode-writes-1">--vfs-cache-mode writes</h3> 3576 <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> 3577 <p>This mode should support all normal file system operations.</p> 3578 <p>If an upload fails it will be retried at exponentially increasing intervals up to 1 minute.</p> 3579 <h3 id="vfs-cache-mode-full-1">--vfs-cache-mode full</h3> 3580 <p>In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well.</p> 3581 <p>In this mode the files in the cache will be sparse files and rclone will keep track of which bits of the files it has downloaded.</p> 3582 <p>So if an application only reads the starts of each file, then rclone will only buffer the start of the file. These files will appear to be their full size in the cache, but they will be sparse files with only the data that has been downloaded present in them.</p> 3583 <p>This mode should support all normal file system operations and is otherwise identical to <code>--vfs-cache-mode</code> writes.</p> 3584 <p>When reading a file rclone will read <code>--buffer-size</code> plus <code>--vfs-read-ahead</code> bytes ahead. The <code>--buffer-size</code> is buffered in memory whereas the <code>--vfs-read-ahead</code> is buffered on disk.</p> 3585 <p>When using this mode it is recommended that <code>--buffer-size</code> is not set too large and <code>--vfs-read-ahead</code> is set large if required.</p> 3586 <p><strong>IMPORTANT</strong> not all file systems support sparse files. In particular FAT/exFAT do not. Rclone will perform very badly if the cache directory is on a filesystem which doesn't support sparse files and it will log an ERROR message if one is detected.</p> 3587 <h3 id="fingerprinting-1">Fingerprinting</h3> 3588 <p>Various parts of the VFS use fingerprinting to see if a local file copy has changed relative to a remote file. Fingerprints are made from:</p> 3589 <ul> 3590 <li>size</li> 3591 <li>modification time</li> 3592 <li>hash</li> 3593 </ul> 3594 <p>where available on an object.</p> 3595 <p>On some backends some of these attributes are slow to read (they take an extra API call per object, or extra work per object).</p> 3596 <p>For example <code>hash</code> is slow with the <code>local</code> and <code>sftp</code> backends as they have to read the entire file and hash it, and <code>modtime</code> is slow with the <code>s3</code>, <code>swift</code>, <code>ftp</code> and <code>qinqstor</code> backends because they need to do an extra API call to fetch it.</p> 3597 <p>If you use the <code>--vfs-fast-fingerprint</code> flag then rclone will not include the slow operations in the fingerprint. This makes the fingerprinting less accurate but much faster and will improve the opening time of cached files.</p> 3598 <p>If you are running a vfs cache over <code>local</code>, <code>s3</code> or <code>swift</code> backends then using this flag is recommended.</p> 3599 <p>Note that if you change the value of this flag, the fingerprints of the files in the cache may be invalidated and the files will need to be downloaded again.</p> 3600 <h2 id="vfs-chunked-reading-1">VFS Chunked Reading</h2> 3601 <p>When rclone reads files from a remote it reads them in chunks. This means that rather than requesting the whole file rclone reads the chunk specified. This can reduce the used download quota for some remotes by requesting only chunks from the remote that are actually read, at the cost of an increased number of requests.</p> 3602 <p>These flags control the chunking:</p> 3603 <pre><code>--vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128M) 3604 --vfs-read-chunk-size-limit SizeSuffix Max chunk doubling size (default off)</code></pre> 3605 <p>Rclone will start reading a chunk of size <code>--vfs-read-chunk-size</code>, and then double the size for each read. When <code>--vfs-read-chunk-size-limit</code> is specified, and greater than <code>--vfs-read-chunk-size</code>, the chunk size for each open file will get doubled only until the specified value is reached. If the value is "off", which is the default, the limit is disabled and the chunk size will grow indefinitely.</p> 3606 <p>With <code>--vfs-read-chunk-size 100M</code> and <code>--vfs-read-chunk-size-limit 0</code> the following parts will be downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. When <code>--vfs-read-chunk-size-limit 500M</code> is specified, the result would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so on.</p> 3607 <p>Setting <code>--vfs-read-chunk-size</code> to <code>0</code> or "off" disables chunked reading.</p> 3608 <h2 id="vfs-performance-1">VFS Performance</h2> 3609 <p>These flags may be used to enable/disable features of the VFS for performance or other reasons. See also the <a href="#vfs-chunked-reading">chunked reading</a> feature.</p> 3610 <p>In particular S3 and Swift benefit hugely from the <code>--no-modtime</code> flag (or use <code>--use-server-modtime</code> for a slightly different effect) as each read of the modification time takes a transaction.</p> 3611 <pre><code>--no-checksum Don't compare checksums on up/download. 3612 --no-modtime Don't read/write the modification time (can speed things up). 3613 --no-seek Don't allow seeking in files. 3614 --read-only Only allow read-only access.</code></pre> 3615 <p>Sometimes rclone is delivered reads or writes out of order. Rather than seeking rclone will wait a short time for the in sequence read or write to come in. These flags only come into effect when not using an on disk cache file.</p> 3616 <pre><code>--vfs-read-wait duration Time to wait for in-sequence read before seeking (default 20ms) 3617 --vfs-write-wait duration Time to wait for in-sequence write before giving error (default 1s)</code></pre> 3618 <p>When using VFS write caching (<code>--vfs-cache-mode</code> with value writes or full), the global flag <code>--transfers</code> can be set to adjust the number of parallel uploads of modified files from the cache (the related global flag <code>--checkers</code> has no effect on the VFS).</p> 3619 <pre><code>--transfers int Number of file transfers to run in parallel (default 4)</code></pre> 3620 <h2 id="vfs-case-sensitivity-1">VFS Case Sensitivity</h2> 3621 <p>Linux file systems are case-sensitive: two files can differ only by case, and the exact case must be used when opening a file.</p> 3622 <p>File systems in modern Windows are case-insensitive but case-preserving: although existing files can be opened using any case, the exact case used to create the file is preserved and available for programs to query. It is not allowed for two files in the same directory to differ only by case.</p> 3623 <p>Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default.</p> 3624 <p>The <code>--vfs-case-insensitive</code> VFS flag controls how rclone handles these two cases. If its value is "false", rclone passes file names to the remote as-is. If the flag is "true" (or appears without a value on the command line), rclone may perform a "fixup" as explained below.</p> 3625 <p>The user may specify a file name to open/delete/rename/etc with a case different than what is stored on the remote. If an argument refers to an existing file with exactly the same name, then the case of the existing file on the disk will be used. However, if a file name with exactly the same name is not found but a name differing only by case exists, rclone will transparently fixup the name. This fixup happens only when an existing file is requested. Case sensitivity of file names created anew by rclone is controlled by the underlying remote.</p> 3626 <p>Note that case sensitivity of the operating system running rclone (the target) may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target.</p> 3627 <p>If the flag is not provided on the command line, then its default value depends on the operating system where rclone runs: "true" on Windows and macOS, "false" otherwise. If the flag is provided without a value, then it is "true".</p> 3628 <p>The <code>--no-unicode-normalization</code> flag controls whether a similar "fixup" is performed for filenames that differ but are <a href="https://en.wikipedia.org/wiki/Unicode_equivalence">canonically equivalent</a> with respect to unicode. Unicode normalization can be particularly helpful for users of macOS, which prefers form NFD instead of the NFC used by most other platforms. It is therefore highly recommended to keep the default of <code>false</code> on macOS, to avoid encoding compatibility issues.</p> 3629 <p>In the (probably unlikely) event that a directory has multiple duplicate filenames after applying case and unicode normalization, the <code>--vfs-block-norm-dupes</code> flag allows hiding these duplicates. This comes with a performance tradeoff, as rclone will have to scan the entire directory for duplicates when listing a directory. For this reason, it is recommended to leave this disabled if not needed. However, macOS users may wish to consider using it, as otherwise, if a remote directory contains both NFC and NFD versions of the same filename, an odd situation will occur: both versions of the file will be visible in the mount, and both will appear to be editable, however, editing either version will actually result in only the NFD version getting edited under the hood. <code>--vfs-block- norm-dupes</code> prevents this confusion by detecting this scenario, hiding the duplicates, and logging an error, similar to how this is handled in <code>rclone sync</code>.</p> 3630 <h2 id="vfs-disk-options-1">VFS Disk Options</h2> 3631 <p>This flag allows you to manually set the statistics about the filing system. It can be useful when those statistics cannot be read correctly automatically.</p> 3632 <pre><code>--vfs-disk-space-total-size Manually set the total disk space size (example: 256G, default: -1)</code></pre> 3633 <h2 id="alternate-report-of-used-bytes-1">Alternate report of used bytes</h2> 3634 <p>Some backends, most notably S3, do not report the amount of bytes used. If you need this information to be available when running <code>df</code> on the filesystem, then pass the flag <code>--vfs-used-is-size</code> to rclone. With this flag set, instead of relying on the backend to report this information, rclone will scan the whole remote similar to <code>rclone size</code> and compute the total used space itself.</p> 3635 <p><em>WARNING.</em> Contrary to <code>rclone size</code>, this flag ignores filters so that the result is accurate. However, this is very inefficient and may cost lots of API calls resulting in extra charges. Use it as a last resort and only with caching.</p> 3636 <pre><code>rclone nfsmount remote:path /path/to/mountpoint [flags]</code></pre> 3637 <h2 id="options-62">Options</h2> 3638 <pre><code> --addr string IPaddress:Port or :Port to bind server to 3639 --allow-non-empty Allow mounting over a non-empty directory (not supported on Windows) 3640 --allow-other Allow access to other users (not supported on Windows) 3641 --allow-root Allow access to root user (not supported on Windows) 3642 --async-read Use asynchronous reads (not supported on Windows) (default true) 3643 --attr-timeout Duration Time for which file/directory attributes are cached (default 1s) 3644 --daemon Run mount in background and exit parent process (as background output is suppressed, use --log-file with --log-format=pid,... to monitor) (not supported on Windows) 3645 --daemon-timeout Duration Time limit for rclone to respond to kernel (not supported on Windows) (default 0s) 3646 --daemon-wait Duration Time to wait for ready mount from daemon (maximum time on Linux, constant sleep time on OSX/BSD) (not supported on Windows) (default 1m0s) 3647 --debug-fuse Debug the FUSE internals - needs -v 3648 --default-permissions Makes kernel enforce access control based on the file mode (not supported on Windows) 3649 --devname string Set the device name - default is remote:path 3650 --dir-cache-time Duration Time to cache directory entries for (default 5m0s) 3651 --dir-perms FileMode Directory permissions (default 0777) 3652 --file-perms FileMode File permissions (default 0666) 3653 --fuse-flag stringArray Flags or arguments to be passed direct to libfuse/WinFsp (repeat if required) 3654 --gid uint32 Override the gid field set by the filesystem (not supported on Windows) (default 1000) 3655 -h, --help help for nfsmount 3656 --max-read-ahead SizeSuffix The number of bytes that can be prefetched for sequential reads (not supported on Windows) (default 128Ki) 3657 --mount-case-insensitive Tristate Tell the OS the mount is case insensitive (true) or sensitive (false) regardless of the backend (auto) (default unset) 3658 --network-mode Mount as remote network drive, instead of fixed disk drive (supported on Windows only) 3659 --nfs-cache-handle-limit int max file handles cached simultaneously (min 5) (default 1000000) 3660 --no-checksum Don't compare checksums on up/download 3661 --no-modtime Don't read/write the modification time (can speed things up) 3662 --no-seek Don't allow seeking in files 3663 --noappledouble Ignore Apple Double (._) and .DS_Store files (supported on OSX only) (default true) 3664 --noapplexattr Ignore all "com.apple.*" extended attributes (supported on OSX only) 3665 -o, --option stringArray Option for libfuse/WinFsp (repeat if required) 3666 --poll-interval Duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) 3667 --read-only Only allow read-only access 3668 --sudo Use sudo to run the mount command as root. 3669 --uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000) 3670 --umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2) 3671 --vfs-block-norm-dupes If duplicate filenames exist in the same directory (after normalization), log an error and hide the duplicates (may have a performance cost) 3672 --vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s) 3673 --vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off) 3674 --vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off) 3675 --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) 3676 --vfs-cache-poll-interval Duration Interval to poll the cache for stale objects (default 1m0s) 3677 --vfs-case-insensitive If a file name not found, find a case insensitive match 3678 --vfs-disk-space-total-size SizeSuffix Specify the total space of disk (default off) 3679 --vfs-fast-fingerprint Use fast (less accurate) fingerprints for change detection 3680 --vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full 3681 --vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128Mi) 3682 --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) 3683 --vfs-read-wait Duration Time to wait for in-sequence read before seeking (default 20ms) 3684 --vfs-refresh Refreshes the directory cache recursively in the background on start 3685 --vfs-used-is-size rclone size Use the rclone size algorithm for Used size 3686 --vfs-write-back Duration Time to writeback files after last use when using cache (default 5s) 3687 --vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s) 3688 --volname string Set the volume name (supported on Windows and OSX only) 3689 --write-back-cache Makes kernel buffer writes before sending them to rclone (without this, writethrough caching is used) (not supported on Windows)</code></pre> 3690 <h2 id="filter-options-22">Filter Options</h2> 3691 <p>Flags for filtering directory listings.</p> 3692 <pre><code> --delete-excluded Delete files on dest excluded from sync 3693 --exclude stringArray Exclude files matching pattern 3694 --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) 3695 --exclude-if-present stringArray Exclude directories if filename is present 3696 --files-from stringArray Read list of source-file names from file (use - to read from stdin) 3697 --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) 3698 -f, --filter stringArray Add a file filtering rule 3699 --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) 3700 --ignore-case Ignore case in filters (case insensitive) 3701 --include stringArray Include files matching pattern 3702 --include-from stringArray Read file include patterns from file (use - to read from stdin) 3703 --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) 3704 --max-depth int If set limits the recursion depth to this (default -1) 3705 --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) 3706 --metadata-exclude stringArray Exclude metadatas matching pattern 3707 --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) 3708 --metadata-filter stringArray Add a metadata filtering rule 3709 --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) 3710 --metadata-include stringArray Include metadatas matching pattern 3711 --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) 3712 --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) 3713 --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre> 3714 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 3715 <h1 id="see-also-62">SEE ALSO</h1> 3716 <ul> 3717 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 3718 </ul> 3719 <h1 id="rclone-obscure">rclone obscure</h1> 3720 <p>Obscure password for use in the rclone config file.</p> 3721 <h2 id="synopsis-55">Synopsis</h2> 3722 <p>In the rclone config file, human-readable passwords are obscured. Obscuring them is done by encrypting them and writing them out in base64. This is <strong>not</strong> a secure way of encrypting these passwords as rclone can decrypt them - it is to prevent "eyedropping" - namely someone seeing a password in the rclone config file by accident.</p> 3723 <p>Many equally important things (like access tokens) are not obscured in the config file. However it is very hard to shoulder surf a 64 character hex token.</p> 3724 <p>This command can also accept a password through STDIN instead of an argument by passing a hyphen as an argument. This will use the first line of STDIN as the password not including the trailing newline.</p> 3725 <pre><code>echo "secretpassword" | rclone obscure -</code></pre> 3726 <p>If there is no data on STDIN to read, rclone obscure will default to obfuscating the hyphen itself.</p> 3727 <p>If you want to encrypt the config file then please use config file encryption - see <a href="https://rclone.org/commands/rclone_config/">rclone config</a> for more info.</p> 3728 <pre><code>rclone obscure password [flags]</code></pre> 3729 <h2 id="options-63">Options</h2> 3730 <pre><code> -h, --help help for obscure</code></pre> 3731 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 3732 <h1 id="see-also-63">SEE ALSO</h1> 3733 <ul> 3734 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 3735 </ul> 3736 <h1 id="rclone-rc">rclone rc</h1> 3737 <p>Run a command against a running rclone.</p> 3738 <h2 id="synopsis-56">Synopsis</h2> 3739 <p>This runs a command against a running rclone. Use the <code>--url</code> 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> 3740 <p>A username and password can be passed in with <code>--user</code> and <code>--pass</code>.</p> 3741 <p>Note that <code>--rc-addr</code>, <code>--rc-user</code>, <code>--rc-pass</code> will be read also for <code>--url</code>, <code>--user</code>, <code>--pass</code>.</p> 3742 <p>Arguments should be passed in as parameter=value.</p> 3743 <p>The result will be returned as a JSON object by default.</p> 3744 <p>The <code>--json</code> 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> 3745 <p>The <code>-o</code>/<code>--opt</code> option can be used to set a key "opt" with key, value options in the form <code>-o key=value</code> or <code>-o key</code>. It can be repeated as many times as required. This is useful for rc commands which take the "opt" parameter which by convention is a dictionary of strings.</p> 3746 <pre><code>-o key=value -o key2</code></pre> 3747 <p>Will place this in the "opt" value</p> 3748 <pre><code>{"key":"value", "key2","")</code></pre> 3749 <p>The <code>-a</code>/<code>--arg</code> option can be used to set strings in the "arg" value. It can be repeated as many times as required. This is useful for rc commands which take the "arg" parameter which by convention is a list of strings.</p> 3750 <pre><code>-a value -a value2</code></pre> 3751 <p>Will place this in the "arg" value</p> 3752 <pre><code>["value", "value2"]</code></pre> 3753 <p>Use <code>--loopback</code> to connect to the rclone instance running <code>rclone rc</code>. This is very useful for testing commands without having to run an rclone rc server, e.g.:</p> 3754 <pre><code>rclone rc --loopback operations/about fs=/</code></pre> 3755 <p>Use <code>rclone rc</code> to see a list of all possible commands.</p> 3756 <pre><code>rclone rc commands parameter [flags]</code></pre> 3757 <h2 id="options-64">Options</h2> 3758 <pre><code> -a, --arg stringArray Argument placed in the "arg" array 3759 -h, --help help for rc 3760 --json string Input JSON - use instead of key=value args 3761 --loopback If set connect to this rclone instance not via HTTP 3762 --no-output If set, don't output the JSON result 3763 -o, --opt stringArray Option in the form name=value or name placed in the "opt" array 3764 --pass string Password to use to connect to rclone remote control 3765 --url string URL to connect to rclone remote control (default "http://localhost:5572/") 3766 --user string Username to use to rclone remote control</code></pre> 3767 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 3768 <h1 id="see-also-64">SEE ALSO</h1> 3769 <ul> 3770 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 3771 </ul> 3772 <h1 id="rclone-rcat">rclone rcat</h1> 3773 <p>Copies standard input to file on remote.</p> 3774 <h2 id="synopsis-57">Synopsis</h2> 3775 <p>rclone rcat reads from standard input (stdin) and copies it to a single remote file.</p> 3776 <pre><code>echo "hello world" | rclone rcat remote:path/to/file 3777 ffmpeg - | rclone rcat remote:path/to/file</code></pre> 3778 <p>If the remote file already exists, it will be overwritten.</p> 3779 <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> 3780 <p>Use the <code>--size</code> flag to preallocate the file in advance at the remote end and actually stream it, even if remote backend doesn't support streaming.</p> 3781 <p><code>--size</code> should be the exact size of the input stream in bytes. If the size of the stream is different in length to the <code>--size</code> passed in then the transfer will likely fail.</p> 3782 <p>Note that the upload cannot be retried because the data is not stored. If the backend supports multipart uploading then individual chunks can be retried. If you need to transfer a lot of data, you may be better off caching it locally and then <code>rclone move</code> it to the destination which can use retries.</p> 3783 <pre><code>rclone rcat remote:path [flags]</code></pre> 3784 <h2 id="options-65">Options</h2> 3785 <pre><code> -h, --help help for rcat 3786 --size int File size hint to preallocate (default -1)</code></pre> 3787 <h2 id="important-options-15">Important Options</h2> 3788 <p>Important flags useful for most commands.</p> 3789 <pre><code> -n, --dry-run Do a trial run with no permanent changes 3790 -i, --interactive Enable interactive mode 3791 -v, --verbose count Print lots more stuff (repeat for more)</code></pre> 3792 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 3793 <h1 id="see-also-65">SEE ALSO</h1> 3794 <ul> 3795 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 3796 </ul> 3797 <h1 id="rclone-rcd">rclone rcd</h1> 3798 <p>Run rclone listening to remote control commands only.</p> 3799 <h2 id="synopsis-58">Synopsis</h2> 3800 <p>This runs rclone so that it only listens to remote control commands.</p> 3801 <p>This is useful if you are controlling rclone via the rc API.</p> 3802 <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> 3803 <p>See the <a href="https://rclone.org/rc/">rc documentation</a> for more info on the rc flags.</p> 3804 <h2 id="server-options">Server options</h2> 3805 <p>Use <code>--rc-addr</code> to specify which IP address and port the server should listen on, eg <code>--rc-addr 1.2.3.4:8000</code> or <code>--rc-addr :8080</code> 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> 3806 <p>If you set <code>--rc-addr</code> to listen on a public or LAN accessible IP address then using Authentication is advised - see the next section for info.</p> 3807 <p>You can use a unix socket by setting the url to <code>unix:///path/to/socket</code> or just by using an absolute path name. Note that unix sockets bypass the authentication - this is expected to be done with file system permissions.</p> 3808 <p><code>--rc-addr</code> may be repeated to listen on multiple IPs/ports/sockets.</p> 3809 <p><code>--rc-server-read-timeout</code> and <code>--rc-server-write-timeout</code> can be used to control the timeouts on the server. Note that this is the total time for a transfer.</p> 3810 <p><code>--rc-max-header-bytes</code> controls the maximum number of bytes the server will accept in the HTTP header.</p> 3811 <p><code>--rc-baseurl</code> controls the URL prefix that rclone serves from. By default rclone will serve from the root. If you used <code>--rc-baseurl "/rclone"</code> then rclone would serve from a URL starting with "/rclone/". This is useful if you wish to proxy rclone serve. Rclone automatically inserts leading and trailing "/" on <code>--rc-baseurl</code>, so <code>--rc-baseurl "rclone"</code>, <code>--rc-baseurl "/rclone"</code> and <code>--rc-baseurl "/rclone/"</code> are all treated identically.</p> 3812 <h3 id="tls-ssl">TLS (SSL)</h3> 3813 <p>By default this will serve over http. If you want you can serve over https. You will need to supply the <code>--rc-cert</code> and <code>--rc-key</code> flags. If you wish to do client side certificate validation then you will need to supply <code>--rc-client-ca</code> also.</p> 3814 <p><code>--rc-cert</code> should be a either a PEM encoded certificate or a concatenation of that with the CA certificate. <code>--krc-ey</code> should be the PEM encoded private key and <code>--rc-client-ca</code> should be the PEM encoded client certificate authority certificate.</p> 3815 <p>--rc-min-tls-version is minimum TLS version that is acceptable. Valid values are "tls1.0", "tls1.1", "tls1.2" and "tls1.3" (default "tls1.0").</p> 3816 <h3 id="template">Template</h3> 3817 <p><code>--rc-template</code> allows a user to specify a custom markup template for HTTP and WebDAV serve functions. The server exports the following markup to be used within the template to server pages:</p> 3818 <table> 3819 <colgroup> 3820 <col style="width: 50%" /> 3821 <col style="width: 50%" /> 3822 </colgroup> 3823 <thead> 3824 <tr class="header"> 3825 <th style="text-align: left;">Parameter</th> 3826 <th style="text-align: left;">Description</th> 3827 </tr> 3828 </thead> 3829 <tbody> 3830 <tr class="odd"> 3831 <td style="text-align: left;">.Name</td> 3832 <td style="text-align: left;">The full path of a file/directory.</td> 3833 </tr> 3834 <tr class="even"> 3835 <td style="text-align: left;">.Title</td> 3836 <td style="text-align: left;">Directory listing of .Name</td> 3837 </tr> 3838 <tr class="odd"> 3839 <td style="text-align: left;">.Sort</td> 3840 <td style="text-align: left;">The current sort used. This is changeable via ?sort= parameter</td> 3841 </tr> 3842 <tr class="even"> 3843 <td style="text-align: left;"></td> 3844 <td style="text-align: left;">Sort Options: namedirfirst,name,size,time (default namedirfirst)</td> 3845 </tr> 3846 <tr class="odd"> 3847 <td style="text-align: left;">.Order</td> 3848 <td style="text-align: left;">The current ordering used. This is changeable via ?order= parameter</td> 3849 </tr> 3850 <tr class="even"> 3851 <td style="text-align: left;"></td> 3852 <td style="text-align: left;">Order Options: asc,desc (default asc)</td> 3853 </tr> 3854 <tr class="odd"> 3855 <td style="text-align: left;">.Query</td> 3856 <td style="text-align: left;">Currently unused.</td> 3857 </tr> 3858 <tr class="even"> 3859 <td style="text-align: left;">.Breadcrumb</td> 3860 <td style="text-align: left;">Allows for creating a relative navigation</td> 3861 </tr> 3862 <tr class="odd"> 3863 <td style="text-align: left;">-- .Link</td> 3864 <td style="text-align: left;">The relative to the root link of the Text.</td> 3865 </tr> 3866 <tr class="even"> 3867 <td style="text-align: left;">-- .Text</td> 3868 <td style="text-align: left;">The Name of the directory.</td> 3869 </tr> 3870 <tr class="odd"> 3871 <td style="text-align: left;">.Entries</td> 3872 <td style="text-align: left;">Information about a specific file/directory.</td> 3873 </tr> 3874 <tr class="even"> 3875 <td style="text-align: left;">-- .URL</td> 3876 <td style="text-align: left;">The 'url' of an entry.</td> 3877 </tr> 3878 <tr class="odd"> 3879 <td style="text-align: left;">-- .Leaf</td> 3880 <td style="text-align: left;">Currently same as 'URL' but intended to be 'just' the name.</td> 3881 </tr> 3882 <tr class="even"> 3883 <td style="text-align: left;">-- .IsDir</td> 3884 <td style="text-align: left;">Boolean for if an entry is a directory or not.</td> 3885 </tr> 3886 <tr class="odd"> 3887 <td style="text-align: left;">-- .Size</td> 3888 <td style="text-align: left;">Size in Bytes of the entry.</td> 3889 </tr> 3890 <tr class="even"> 3891 <td style="text-align: left;">-- .ModTime</td> 3892 <td style="text-align: left;">The UTC timestamp of an entry.</td> 3893 </tr> 3894 </tbody> 3895 </table> 3896 <p>The server also makes the following functions available so that they can be used within the template. These functions help extend the options for dynamic rendering of HTML. They can be used to render HTML based on specific conditions.</p> 3897 <table> 3898 <colgroup> 3899 <col style="width: 50%" /> 3900 <col style="width: 50%" /> 3901 </colgroup> 3902 <thead> 3903 <tr class="header"> 3904 <th style="text-align: left;">Function</th> 3905 <th style="text-align: left;">Description</th> 3906 </tr> 3907 </thead> 3908 <tbody> 3909 <tr class="odd"> 3910 <td style="text-align: left;">afterEpoch</td> 3911 <td style="text-align: left;">Returns the time since the epoch for the given time.</td> 3912 </tr> 3913 <tr class="even"> 3914 <td style="text-align: left;">contains</td> 3915 <td style="text-align: left;">Checks whether a given substring is present or not in a given string.</td> 3916 </tr> 3917 <tr class="odd"> 3918 <td style="text-align: left;">hasPrefix</td> 3919 <td style="text-align: left;">Checks whether the given string begins with the specified prefix.</td> 3920 </tr> 3921 <tr class="even"> 3922 <td style="text-align: left;">hasSuffix</td> 3923 <td style="text-align: left;">Checks whether the given string end with the specified suffix.</td> 3924 </tr> 3925 </tbody> 3926 </table> 3927 <h3 id="authentication">Authentication</h3> 3928 <p>By default this will serve files without needing a login.</p> 3929 <p>You can either use an htpasswd file which can take lots of users, or set a single username and password with the <code>--rc-user</code> and <code>--rc-pass</code> flags.</p> 3930 <p>If no static users are configured by either of the above methods, and client certificates are required by the <code>--client-ca</code> flag passed to the server, the client certificate common name will be considered as the username.</p> 3931 <p>Use <code>--rc-htpasswd /path/to/htpasswd</code> to provide an htpasswd file. This is in standard apache format and supports MD5, SHA1 and BCrypt for basic authentication. Bcrypt is recommended.</p> 3932 <p>To create an htpasswd file:</p> 3933 <pre><code>touch htpasswd 3934 htpasswd -B htpasswd user 3935 htpasswd -B htpasswd anotherUser</code></pre> 3936 <p>The password file can be updated while rclone is running.</p> 3937 <p>Use <code>--rc-realm</code> to set the authentication realm.</p> 3938 <p>Use <code>--rc-salt</code> to change the password hashing salt from the default.</p> 3939 <pre><code>rclone rcd <path to files to serve>* [flags]</code></pre> 3940 <h2 id="options-66">Options</h2> 3941 <pre><code> -h, --help help for rcd</code></pre> 3942 <h2 id="rc-options">RC Options</h2> 3943 <p>Flags to control the Remote Control API.</p> 3944 <pre><code> --rc Enable the remote control server 3945 --rc-addr stringArray IPaddress:Port or :Port to bind server to (default [localhost:5572]) 3946 --rc-allow-origin string Origin which cross-domain request (CORS) can be executed from 3947 --rc-baseurl string Prefix for URLs - leave blank for root 3948 --rc-cert string TLS PEM key (concatenation of certificate and CA certificate) 3949 --rc-client-ca string Client certificate authority to verify clients with 3950 --rc-enable-metrics Enable prometheus metrics on /metrics 3951 --rc-files string Path to local files to serve on the HTTP server 3952 --rc-htpasswd string A htpasswd file - if not provided no authentication is done 3953 --rc-job-expire-duration Duration Expire finished async jobs older than this value (default 1m0s) 3954 --rc-job-expire-interval Duration Interval to check for expired async jobs (default 10s) 3955 --rc-key string TLS PEM Private key 3956 --rc-max-header-bytes int Maximum size of request header (default 4096) 3957 --rc-min-tls-version string Minimum TLS version that is acceptable (default "tls1.0") 3958 --rc-no-auth Don't require auth for certain methods 3959 --rc-pass string Password for authentication 3960 --rc-realm string Realm for authentication 3961 --rc-salt string Password hashing salt (default "dlPL2MqE") 3962 --rc-serve Enable the serving of remote objects 3963 --rc-server-read-timeout Duration Timeout for server reading data (default 1h0m0s) 3964 --rc-server-write-timeout Duration Timeout for server writing data (default 1h0m0s) 3965 --rc-template string User-specified template 3966 --rc-user string User name for authentication 3967 --rc-web-fetch-url string URL to fetch the releases for webgui (default "https://api.github.com/repos/rclone/rclone-webui-react/releases/latest") 3968 --rc-web-gui Launch WebGUI on localhost 3969 --rc-web-gui-force-update Force update to latest version of web gui 3970 --rc-web-gui-no-open-browser Don't open the browser automatically 3971 --rc-web-gui-update Check and update to latest version of web gui</code></pre> 3972 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 3973 <h1 id="see-also-66">SEE ALSO</h1> 3974 <ul> 3975 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 3976 </ul> 3977 <h1 id="rclone-rmdirs">rclone rmdirs</h1> 3978 <p>Remove empty directories under the path.</p> 3979 <h2 id="synopsis-59">Synopsis</h2> 3980 <p>This recursively removes any empty directories (including directories that only contain empty directories), that it finds under the path. The root path itself will also be removed if it is empty, unless you supply the <code>--leave-root</code> flag.</p> 3981 <p>Use command <a href="https://rclone.org/commands/rclone_rmdir/">rmdir</a> to delete just the empty directory given by path, not recurse.</p> 3982 <p>This is useful for tidying up remotes that rclone has left a lot of empty directories in. For example the <a href="https://rclone.org/commands/rclone_delete/">delete</a> command will delete files but leave the directory structure (unless used with option <code>--rmdirs</code>).</p> 3983 <p>This will delete <code>--checkers</code> directories concurrently so if you have thousands of empty directories consider increasing this number.</p> 3984 <p>To delete a path and any objects in it, use the <a href="https://rclone.org/commands/rclone_purge/">purge</a> command.</p> 3985 <pre><code>rclone rmdirs remote:path [flags]</code></pre> 3986 <h2 id="options-67">Options</h2> 3987 <pre><code> -h, --help help for rmdirs 3988 --leave-root Do not remove root directory if empty</code></pre> 3989 <h2 id="important-options-16">Important Options</h2> 3990 <p>Important flags useful for most commands.</p> 3991 <pre><code> -n, --dry-run Do a trial run with no permanent changes 3992 -i, --interactive Enable interactive mode 3993 -v, --verbose count Print lots more stuff (repeat for more)</code></pre> 3994 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 3995 <h1 id="see-also-67">SEE ALSO</h1> 3996 <ul> 3997 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 3998 </ul> 3999 <h1 id="rclone-selfupdate">rclone selfupdate</h1> 4000 <p>Update the rclone binary.</p> 4001 <h2 id="synopsis-60">Synopsis</h2> 4002 <p>This command downloads the latest release of rclone and replaces the currently running binary. The download is verified with a hashsum and cryptographically signed signature; see <a href="https://rclone.org/release_signing/">the release signing docs</a> for details.</p> 4003 <p>If used without flags (or with implied <code>--stable</code> flag), this command will install the latest stable release. However, some issues may be fixed (or features added) only in the latest beta release. In such cases you should run the command with the <code>--beta</code> flag, i.e. <code>rclone selfupdate --beta</code>. You can check in advance what version would be installed by adding the <code>--check</code> flag, then repeat the command without it when you are satisfied.</p> 4004 <p>Sometimes the rclone team may recommend you a concrete beta or stable rclone release to troubleshoot your issue or add a bleeding edge feature. The <code>--version VER</code> flag, if given, will update to the concrete version instead of the latest one. If you omit micro version from <code>VER</code> (for example <code>1.53</code>), the latest matching micro version will be used.</p> 4005 <p>Upon successful update rclone will print a message that contains a previous version number. You will need it if you later decide to revert your update for some reason. Then you'll have to note the previous version and run the following command: <code>rclone selfupdate [--beta] OLDVER</code>. If the old version contains only dots and digits (for example <code>v1.54.0</code>) then it's a stable release so you won't need the <code>--beta</code> flag. Beta releases have an additional information similar to <code>v1.54.0-beta.5111.06f1c0c61</code>. (if you are a developer and use a locally built rclone, the version number will end with <code>-DEV</code>, you will have to rebuild it as it obviously can't be distributed).</p> 4006 <p>If you previously installed rclone via a package manager, the package may include local documentation or configure services. You may wish to update with the flag <code>--package deb</code> or <code>--package rpm</code> (whichever is correct for your OS) to update these too. This command with the default <code>--package zip</code> will update only the rclone executable so the local manual may become inaccurate after it.</p> 4007 <p>The <a href="https://rclone.org/commands/rclone_mount/">rclone mount</a> command may or may not support extended FUSE options depending on the build and OS. <code>selfupdate</code> will refuse to update if the capability would be discarded.</p> 4008 <p>Note: Windows forbids deletion of a currently running executable so this command will rename the old executable to 'rclone.old.exe' upon success.</p> 4009 <p>Please note that this command was not available before rclone version 1.55. If it fails for you with the message <code>unknown command "selfupdate"</code> then you will need to update manually following the install instructions located at https://rclone.org/install/</p> 4010 <pre><code>rclone selfupdate [flags]</code></pre> 4011 <h2 id="options-68">Options</h2> 4012 <pre><code> --beta Install beta release 4013 --check Check for latest release, do not download 4014 -h, --help help for selfupdate 4015 --output string Save the downloaded binary at a given path (default: replace running binary) 4016 --package string Package format: zip|deb|rpm (default: zip) 4017 --stable Install stable release (this is the default) 4018 --version string Install the given rclone version (default: latest)</code></pre> 4019 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 4020 <h1 id="see-also-68">SEE ALSO</h1> 4021 <ul> 4022 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 4023 </ul> 4024 <h1 id="rclone-serve">rclone serve</h1> 4025 <p>Serve a remote over a protocol.</p> 4026 <h2 id="synopsis-61">Synopsis</h2> 4027 <p>Serve a remote over a given protocol. Requires the use of a subcommand to specify the protocol, e.g.</p> 4028 <pre><code>rclone serve http remote:</code></pre> 4029 <p>Each subcommand has its own options which you can see in their help.</p> 4030 <pre><code>rclone serve <protocol> [opts] <remote> [flags]</code></pre> 4031 <h2 id="options-69">Options</h2> 4032 <pre><code> -h, --help help for serve</code></pre> 4033 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 4034 <h1 id="see-also-69">SEE ALSO</h1> 4035 <ul> 4036 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 4037 <li><a href="https://rclone.org/commands/rclone_serve_dlna/">rclone serve dlna</a> - Serve remote:path over DLNA</li> 4038 <li><a href="https://rclone.org/commands/rclone_serve_docker/">rclone serve docker</a> - Serve any remote on docker's volume plugin API.</li> 4039 <li><a href="https://rclone.org/commands/rclone_serve_ftp/">rclone serve ftp</a> - Serve remote:path over FTP.</li> 4040 <li><a href="https://rclone.org/commands/rclone_serve_http/">rclone serve http</a> - Serve the remote over HTTP.</li> 4041 <li><a href="https://rclone.org/commands/rclone_serve_nfs/">rclone serve nfs</a> - Serve the remote as an NFS mount</li> 4042 <li><a href="https://rclone.org/commands/rclone_serve_restic/">rclone serve restic</a> - Serve the remote for restic's REST API.</li> 4043 <li><a href="https://rclone.org/commands/rclone_serve_s3/">rclone serve s3</a> - Serve remote:path over s3.</li> 4044 <li><a href="https://rclone.org/commands/rclone_serve_sftp/">rclone serve sftp</a> - Serve the remote over SFTP.</li> 4045 <li><a href="https://rclone.org/commands/rclone_serve_webdav/">rclone serve webdav</a> - Serve remote:path over WebDAV.</li> 4046 </ul> 4047 <h1 id="rclone-serve-dlna">rclone serve dlna</h1> 4048 <p>Serve remote:path over DLNA</p> 4049 <h2 id="synopsis-62">Synopsis</h2> 4050 <p>Run a DLNA media server for media stored in an rclone remote. Many devices, such as the Xbox and PlayStation, can automatically discover this server in the LAN and play audio/video from it. VLC is also supported. Service discovery uses UDP multicast packets (SSDP) and will thus only work on LANs.</p> 4051 <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> 4052 <h2 id="server-options-1">Server options</h2> 4053 <p>Use <code>--addr</code> to specify which IP address and port the server should listen on, e.g. <code>--addr 1.2.3.4:8000</code> or <code>--addr :8080</code> to listen to all IPs.</p> 4054 <p>Use <code>--name</code> to choose the friendly server name, which is by default "rclone (hostname)".</p> 4055 <p>Use <code>--log-trace</code> in conjunction with <code>-vv</code> to enable additional debug logging of all UPNP traffic. ## VFS - Virtual File System</p> 4056 <p>This command uses the VFS layer. This adapts the cloud storage objects that rclone uses into something which looks much more like a disk filing system.</p> 4057 <p>Cloud storage objects have lots of properties which aren't like disk files - you can't extend them or write to the middle of them, so the VFS layer has to deal with that. Because there is no one right way of doing this there are various options explained below.</p> 4058 <p>The VFS layer also implements a directory cache - this caches info about files and directories (but not the data) in memory.</p> 4059 <h2 id="vfs-directory-cache-2">VFS Directory Cache</h2> 4060 <p>Using the <code>--dir-cache-time</code> flag, you can control how long a directory should be considered up to date and not refreshed from the backend. Changes made through the VFS will appear immediately or invalidate the cache.</p> 4061 <pre><code>--dir-cache-time duration Time to cache directory entries for (default 5m0s) 4062 --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)</code></pre> 4063 <p>However, changes made directly on the cloud storage by the web interface or a different copy of rclone will only be picked up once the directory cache expires if the backend configured does not support polling for changes. If the backend supports polling, changes will be picked up within the polling interval.</p> 4064 <p>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> 4065 <pre><code>kill -SIGHUP $(pidof rclone)</code></pre> 4066 <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> 4067 <pre><code>rclone rc vfs/forget</code></pre> 4068 <p>Or individual files or directories:</p> 4069 <pre><code>rclone rc vfs/forget file=path/to/file dir=path/to/dir</code></pre> 4070 <h2 id="vfs-file-buffering-2">VFS File Buffering</h2> 4071 <p>The <code>--buffer-size</code> flag determines the amount of memory, that will be used to buffer data in advance.</p> 4072 <p>Each open file will try to keep the specified amount of data in memory at all times. The buffered data is bound to one open file and won't be shared.</p> 4073 <p>This flag is a upper limit for the used memory per open file. The buffer will only use memory for data that is downloaded but not not yet read. If the buffer is empty, only a small amount of memory will be used.</p> 4074 <p>The maximum memory used by rclone for buffering can be up to <code>--buffer-size * open files</code>.</p> 4075 <h2 id="vfs-file-caching-2">VFS File Caching</h2> 4076 <p>These flags control the VFS file caching options. File caching is necessary to make the VFS layer appear compatible with a normal file system. It can be disabled at the cost of some compatibility.</p> 4077 <p>For example you'll need to enable VFS caching if you want to read and write simultaneously to a file. See below for more details.</p> 4078 <p>Note that the VFS cache is separate from the cache backend and you may find that you need one or the other or both.</p> 4079 <pre><code>--cache-dir string Directory rclone will use for caching. 4080 --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) 4081 --vfs-cache-max-age duration Max time since last access of objects in the cache (default 1h0m0s) 4082 --vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off) 4083 --vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off) 4084 --vfs-cache-poll-interval duration Interval to poll the cache for stale objects (default 1m0s) 4085 --vfs-write-back duration Time to writeback files after last use when using cache (default 5s)</code></pre> 4086 <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> 4087 <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> 4088 <p>Note that files are written back to the remote only when they are closed and if they haven't been accessed for <code>--vfs-write-back</code> seconds. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags.</p> 4089 <p>If using <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-size</code> note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every <code>--vfs-cache-poll-interval</code>. Secondly because open files cannot be evicted from the cache. When <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-size</code> is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven't been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached.</p> 4090 <p>The <code>--vfs-cache-max-age</code> will evict files from the cache after the set time since last access has passed. The default value of 1 hour will start evicting files from cache that haven't been accessed for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0 and will wait for 1 more hour before evicting. Specify the time with standard notation, s, m, h, d, w .</p> 4091 <p>You <strong>should not</strong> run two copies of rclone using the same VFS cache with the same or overlapping remotes if using <code>--vfs-cache-mode > off</code>. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with <code>--cache-dir</code>. You don't need to worry about this if the remotes in use don't overlap.</p> 4092 <h3 id="vfs-cache-mode-off-2">--vfs-cache-mode off</h3> 4093 <p>In this mode (the default) the cache will read directly from the remote and write directly to the remote without caching anything on disk.</p> 4094 <p>This will mean some operations are not possible</p> 4095 <ul> 4096 <li>Files can't be opened for both read AND write</li> 4097 <li>Files opened for write can't be seeked</li> 4098 <li>Existing files opened for write must have O_TRUNC set</li> 4099 <li>Files open for read with O_TRUNC will be opened write only</li> 4100 <li>Files open for write only will behave as if O_TRUNC was supplied</li> 4101 <li>Open modes O_APPEND, O_TRUNC are ignored</li> 4102 <li>If an upload fails it can't be retried</li> 4103 </ul> 4104 <h3 id="vfs-cache-mode-minimal-2">--vfs-cache-mode minimal</h3> 4105 <p>This is very similar to "off" except that files opened for read AND write will be buffered to disk. This means that files opened for write will be a lot more compatible, but uses the minimal disk space.</p> 4106 <p>These operations are not possible</p> 4107 <ul> 4108 <li>Files opened for write only can't be seeked</li> 4109 <li>Existing files opened for write must have O_TRUNC set</li> 4110 <li>Files opened for write only will ignore O_APPEND, O_TRUNC</li> 4111 <li>If an upload fails it can't be retried</li> 4112 </ul> 4113 <h3 id="vfs-cache-mode-writes-2">--vfs-cache-mode writes</h3> 4114 <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> 4115 <p>This mode should support all normal file system operations.</p> 4116 <p>If an upload fails it will be retried at exponentially increasing intervals up to 1 minute.</p> 4117 <h3 id="vfs-cache-mode-full-2">--vfs-cache-mode full</h3> 4118 <p>In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well.</p> 4119 <p>In this mode the files in the cache will be sparse files and rclone will keep track of which bits of the files it has downloaded.</p> 4120 <p>So if an application only reads the starts of each file, then rclone will only buffer the start of the file. These files will appear to be their full size in the cache, but they will be sparse files with only the data that has been downloaded present in them.</p> 4121 <p>This mode should support all normal file system operations and is otherwise identical to <code>--vfs-cache-mode</code> writes.</p> 4122 <p>When reading a file rclone will read <code>--buffer-size</code> plus <code>--vfs-read-ahead</code> bytes ahead. The <code>--buffer-size</code> is buffered in memory whereas the <code>--vfs-read-ahead</code> is buffered on disk.</p> 4123 <p>When using this mode it is recommended that <code>--buffer-size</code> is not set too large and <code>--vfs-read-ahead</code> is set large if required.</p> 4124 <p><strong>IMPORTANT</strong> not all file systems support sparse files. In particular FAT/exFAT do not. Rclone will perform very badly if the cache directory is on a filesystem which doesn't support sparse files and it will log an ERROR message if one is detected.</p> 4125 <h3 id="fingerprinting-2">Fingerprinting</h3> 4126 <p>Various parts of the VFS use fingerprinting to see if a local file copy has changed relative to a remote file. Fingerprints are made from:</p> 4127 <ul> 4128 <li>size</li> 4129 <li>modification time</li> 4130 <li>hash</li> 4131 </ul> 4132 <p>where available on an object.</p> 4133 <p>On some backends some of these attributes are slow to read (they take an extra API call per object, or extra work per object).</p> 4134 <p>For example <code>hash</code> is slow with the <code>local</code> and <code>sftp</code> backends as they have to read the entire file and hash it, and <code>modtime</code> is slow with the <code>s3</code>, <code>swift</code>, <code>ftp</code> and <code>qinqstor</code> backends because they need to do an extra API call to fetch it.</p> 4135 <p>If you use the <code>--vfs-fast-fingerprint</code> flag then rclone will not include the slow operations in the fingerprint. This makes the fingerprinting less accurate but much faster and will improve the opening time of cached files.</p> 4136 <p>If you are running a vfs cache over <code>local</code>, <code>s3</code> or <code>swift</code> backends then using this flag is recommended.</p> 4137 <p>Note that if you change the value of this flag, the fingerprints of the files in the cache may be invalidated and the files will need to be downloaded again.</p> 4138 <h2 id="vfs-chunked-reading-2">VFS Chunked Reading</h2> 4139 <p>When rclone reads files from a remote it reads them in chunks. This means that rather than requesting the whole file rclone reads the chunk specified. This can reduce the used download quota for some remotes by requesting only chunks from the remote that are actually read, at the cost of an increased number of requests.</p> 4140 <p>These flags control the chunking:</p> 4141 <pre><code>--vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128M) 4142 --vfs-read-chunk-size-limit SizeSuffix Max chunk doubling size (default off)</code></pre> 4143 <p>Rclone will start reading a chunk of size <code>--vfs-read-chunk-size</code>, and then double the size for each read. When <code>--vfs-read-chunk-size-limit</code> is specified, and greater than <code>--vfs-read-chunk-size</code>, the chunk size for each open file will get doubled only until the specified value is reached. If the value is "off", which is the default, the limit is disabled and the chunk size will grow indefinitely.</p> 4144 <p>With <code>--vfs-read-chunk-size 100M</code> and <code>--vfs-read-chunk-size-limit 0</code> the following parts will be downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. When <code>--vfs-read-chunk-size-limit 500M</code> is specified, the result would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so on.</p> 4145 <p>Setting <code>--vfs-read-chunk-size</code> to <code>0</code> or "off" disables chunked reading.</p> 4146 <h2 id="vfs-performance-2">VFS Performance</h2> 4147 <p>These flags may be used to enable/disable features of the VFS for performance or other reasons. See also the <a href="#vfs-chunked-reading">chunked reading</a> feature.</p> 4148 <p>In particular S3 and Swift benefit hugely from the <code>--no-modtime</code> flag (or use <code>--use-server-modtime</code> for a slightly different effect) as each read of the modification time takes a transaction.</p> 4149 <pre><code>--no-checksum Don't compare checksums on up/download. 4150 --no-modtime Don't read/write the modification time (can speed things up). 4151 --no-seek Don't allow seeking in files. 4152 --read-only Only allow read-only access.</code></pre> 4153 <p>Sometimes rclone is delivered reads or writes out of order. Rather than seeking rclone will wait a short time for the in sequence read or write to come in. These flags only come into effect when not using an on disk cache file.</p> 4154 <pre><code>--vfs-read-wait duration Time to wait for in-sequence read before seeking (default 20ms) 4155 --vfs-write-wait duration Time to wait for in-sequence write before giving error (default 1s)</code></pre> 4156 <p>When using VFS write caching (<code>--vfs-cache-mode</code> with value writes or full), the global flag <code>--transfers</code> can be set to adjust the number of parallel uploads of modified files from the cache (the related global flag <code>--checkers</code> has no effect on the VFS).</p> 4157 <pre><code>--transfers int Number of file transfers to run in parallel (default 4)</code></pre> 4158 <h2 id="vfs-case-sensitivity-2">VFS Case Sensitivity</h2> 4159 <p>Linux file systems are case-sensitive: two files can differ only by case, and the exact case must be used when opening a file.</p> 4160 <p>File systems in modern Windows are case-insensitive but case-preserving: although existing files can be opened using any case, the exact case used to create the file is preserved and available for programs to query. It is not allowed for two files in the same directory to differ only by case.</p> 4161 <p>Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default.</p> 4162 <p>The <code>--vfs-case-insensitive</code> VFS flag controls how rclone handles these two cases. If its value is "false", rclone passes file names to the remote as-is. If the flag is "true" (or appears without a value on the command line), rclone may perform a "fixup" as explained below.</p> 4163 <p>The user may specify a file name to open/delete/rename/etc with a case different than what is stored on the remote. If an argument refers to an existing file with exactly the same name, then the case of the existing file on the disk will be used. However, if a file name with exactly the same name is not found but a name differing only by case exists, rclone will transparently fixup the name. This fixup happens only when an existing file is requested. Case sensitivity of file names created anew by rclone is controlled by the underlying remote.</p> 4164 <p>Note that case sensitivity of the operating system running rclone (the target) may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target.</p> 4165 <p>If the flag is not provided on the command line, then its default value depends on the operating system where rclone runs: "true" on Windows and macOS, "false" otherwise. If the flag is provided without a value, then it is "true".</p> 4166 <p>The <code>--no-unicode-normalization</code> flag controls whether a similar "fixup" is performed for filenames that differ but are <a href="https://en.wikipedia.org/wiki/Unicode_equivalence">canonically equivalent</a> with respect to unicode. Unicode normalization can be particularly helpful for users of macOS, which prefers form NFD instead of the NFC used by most other platforms. It is therefore highly recommended to keep the default of <code>false</code> on macOS, to avoid encoding compatibility issues.</p> 4167 <p>In the (probably unlikely) event that a directory has multiple duplicate filenames after applying case and unicode normalization, the <code>--vfs-block-norm-dupes</code> flag allows hiding these duplicates. This comes with a performance tradeoff, as rclone will have to scan the entire directory for duplicates when listing a directory. For this reason, it is recommended to leave this disabled if not needed. However, macOS users may wish to consider using it, as otherwise, if a remote directory contains both NFC and NFD versions of the same filename, an odd situation will occur: both versions of the file will be visible in the mount, and both will appear to be editable, however, editing either version will actually result in only the NFD version getting edited under the hood. <code>--vfs-block- norm-dupes</code> prevents this confusion by detecting this scenario, hiding the duplicates, and logging an error, similar to how this is handled in <code>rclone sync</code>.</p> 4168 <h2 id="vfs-disk-options-2">VFS Disk Options</h2> 4169 <p>This flag allows you to manually set the statistics about the filing system. It can be useful when those statistics cannot be read correctly automatically.</p> 4170 <pre><code>--vfs-disk-space-total-size Manually set the total disk space size (example: 256G, default: -1)</code></pre> 4171 <h2 id="alternate-report-of-used-bytes-2">Alternate report of used bytes</h2> 4172 <p>Some backends, most notably S3, do not report the amount of bytes used. If you need this information to be available when running <code>df</code> on the filesystem, then pass the flag <code>--vfs-used-is-size</code> to rclone. With this flag set, instead of relying on the backend to report this information, rclone will scan the whole remote similar to <code>rclone size</code> and compute the total used space itself.</p> 4173 <p><em>WARNING.</em> Contrary to <code>rclone size</code>, this flag ignores filters so that the result is accurate. However, this is very inefficient and may cost lots of API calls resulting in extra charges. Use it as a last resort and only with caching.</p> 4174 <pre><code>rclone serve dlna remote:path [flags]</code></pre> 4175 <h2 id="options-70">Options</h2> 4176 <pre><code> --addr string The ip:port or :port to bind the DLNA http server to (default ":7879") 4177 --announce-interval Duration The interval between SSDP announcements (default 12m0s) 4178 --dir-cache-time Duration Time to cache directory entries for (default 5m0s) 4179 --dir-perms FileMode Directory permissions (default 0777) 4180 --file-perms FileMode File permissions (default 0666) 4181 --gid uint32 Override the gid field set by the filesystem (not supported on Windows) (default 1000) 4182 -h, --help help for dlna 4183 --interface stringArray The interface to use for SSDP (repeat as necessary) 4184 --log-trace Enable trace logging of SOAP traffic 4185 --name string Name of DLNA server 4186 --no-checksum Don't compare checksums on up/download 4187 --no-modtime Don't read/write the modification time (can speed things up) 4188 --no-seek Don't allow seeking in files 4189 --poll-interval Duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) 4190 --read-only Only allow read-only access 4191 --uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000) 4192 --umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2) 4193 --vfs-block-norm-dupes If duplicate filenames exist in the same directory (after normalization), log an error and hide the duplicates (may have a performance cost) 4194 --vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s) 4195 --vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off) 4196 --vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off) 4197 --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) 4198 --vfs-cache-poll-interval Duration Interval to poll the cache for stale objects (default 1m0s) 4199 --vfs-case-insensitive If a file name not found, find a case insensitive match 4200 --vfs-disk-space-total-size SizeSuffix Specify the total space of disk (default off) 4201 --vfs-fast-fingerprint Use fast (less accurate) fingerprints for change detection 4202 --vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full 4203 --vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128Mi) 4204 --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) 4205 --vfs-read-wait Duration Time to wait for in-sequence read before seeking (default 20ms) 4206 --vfs-refresh Refreshes the directory cache recursively in the background on start 4207 --vfs-used-is-size rclone size Use the rclone size algorithm for Used size 4208 --vfs-write-back Duration Time to writeback files after last use when using cache (default 5s) 4209 --vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s)</code></pre> 4210 <h2 id="filter-options-23">Filter Options</h2> 4211 <p>Flags for filtering directory listings.</p> 4212 <pre><code> --delete-excluded Delete files on dest excluded from sync 4213 --exclude stringArray Exclude files matching pattern 4214 --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) 4215 --exclude-if-present stringArray Exclude directories if filename is present 4216 --files-from stringArray Read list of source-file names from file (use - to read from stdin) 4217 --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) 4218 -f, --filter stringArray Add a file filtering rule 4219 --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) 4220 --ignore-case Ignore case in filters (case insensitive) 4221 --include stringArray Include files matching pattern 4222 --include-from stringArray Read file include patterns from file (use - to read from stdin) 4223 --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) 4224 --max-depth int If set limits the recursion depth to this (default -1) 4225 --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) 4226 --metadata-exclude stringArray Exclude metadatas matching pattern 4227 --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) 4228 --metadata-filter stringArray Add a metadata filtering rule 4229 --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) 4230 --metadata-include stringArray Include metadatas matching pattern 4231 --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) 4232 --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) 4233 --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre> 4234 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 4235 <h1 id="see-also-70">SEE ALSO</h1> 4236 <ul> 4237 <li><a href="https://rclone.org/commands/rclone_serve/">rclone serve</a> - Serve a remote over a protocol.</li> 4238 </ul> 4239 <h1 id="rclone-serve-docker">rclone serve docker</h1> 4240 <p>Serve any remote on docker's volume plugin API.</p> 4241 <h2 id="synopsis-63">Synopsis</h2> 4242 <p>This command implements the Docker volume plugin API allowing docker to use rclone as a data storage mechanism for various cloud providers. rclone provides <a href="/docker">docker volume plugin</a> based on it.</p> 4243 <p>To create a docker plugin, one must create a Unix or TCP socket that Docker will look for when you use the plugin and then it listens for commands from docker daemon and runs the corresponding code when necessary. Docker plugins can run as a managed plugin under control of the docker daemon or as an independent native service. For testing, you can just run it directly from the command line, for example:</p> 4244 <pre><code>sudo rclone serve docker --base-dir /tmp/rclone-volumes --socket-addr localhost:8787 -vv</code></pre> 4245 <p>Running <code>rclone serve docker</code> will create the said socket, listening for commands from Docker to create the necessary Volumes. Normally you need not give the <code>--socket-addr</code> flag. The API will listen on the unix domain socket at <code>/run/docker/plugins/rclone.sock</code>. In the example above rclone will create a TCP socket and a small file <code>/etc/docker/plugins/rclone.spec</code> containing the socket address. We use <code>sudo</code> because both paths are writeable only by the root user.</p> 4246 <p>If you later decide to change listening socket, the docker daemon must be restarted to reconnect to <code>/run/docker/plugins/rclone.sock</code> or parse new <code>/etc/docker/plugins/rclone.spec</code>. Until you restart, any volume related docker commands will timeout trying to access the old socket. Running directly is supported on <strong>Linux only</strong>, not on Windows or MacOS. This is not a problem with managed plugin mode described in details in the <a href="https://rclone.org/docker">full documentation</a>.</p> 4247 <p>The command will create volume mounts under the path given by <code>--base-dir</code> (by default <code>/var/lib/docker-volumes/rclone</code> available only to root) and maintain the JSON formatted file <code>docker-plugin.state</code> in the rclone cache directory with book-keeping records of created and mounted volumes.</p> 4248 <p>All mount and VFS options are submitted by the docker daemon via API, but you can also provide defaults on the command line as well as set path to the config file and cache directory or adjust logging verbosity. ## VFS - Virtual File System</p> 4249 <p>This command uses the VFS layer. This adapts the cloud storage objects that rclone uses into something which looks much more like a disk filing system.</p> 4250 <p>Cloud storage objects have lots of properties which aren't like disk files - you can't extend them or write to the middle of them, so the VFS layer has to deal with that. Because there is no one right way of doing this there are various options explained below.</p> 4251 <p>The VFS layer also implements a directory cache - this caches info about files and directories (but not the data) in memory.</p> 4252 <h2 id="vfs-directory-cache-3">VFS Directory Cache</h2> 4253 <p>Using the <code>--dir-cache-time</code> flag, you can control how long a directory should be considered up to date and not refreshed from the backend. Changes made through the VFS will appear immediately or invalidate the cache.</p> 4254 <pre><code>--dir-cache-time duration Time to cache directory entries for (default 5m0s) 4255 --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)</code></pre> 4256 <p>However, changes made directly on the cloud storage by the web interface or a different copy of rclone will only be picked up once the directory cache expires if the backend configured does not support polling for changes. If the backend supports polling, changes will be picked up within the polling interval.</p> 4257 <p>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> 4258 <pre><code>kill -SIGHUP $(pidof rclone)</code></pre> 4259 <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> 4260 <pre><code>rclone rc vfs/forget</code></pre> 4261 <p>Or individual files or directories:</p> 4262 <pre><code>rclone rc vfs/forget file=path/to/file dir=path/to/dir</code></pre> 4263 <h2 id="vfs-file-buffering-3">VFS File Buffering</h2> 4264 <p>The <code>--buffer-size</code> flag determines the amount of memory, that will be used to buffer data in advance.</p> 4265 <p>Each open file will try to keep the specified amount of data in memory at all times. The buffered data is bound to one open file and won't be shared.</p> 4266 <p>This flag is a upper limit for the used memory per open file. The buffer will only use memory for data that is downloaded but not not yet read. If the buffer is empty, only a small amount of memory will be used.</p> 4267 <p>The maximum memory used by rclone for buffering can be up to <code>--buffer-size * open files</code>.</p> 4268 <h2 id="vfs-file-caching-3">VFS File Caching</h2> 4269 <p>These flags control the VFS file caching options. File caching is necessary to make the VFS layer appear compatible with a normal file system. It can be disabled at the cost of some compatibility.</p> 4270 <p>For example you'll need to enable VFS caching if you want to read and write simultaneously to a file. See below for more details.</p> 4271 <p>Note that the VFS cache is separate from the cache backend and you may find that you need one or the other or both.</p> 4272 <pre><code>--cache-dir string Directory rclone will use for caching. 4273 --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) 4274 --vfs-cache-max-age duration Max time since last access of objects in the cache (default 1h0m0s) 4275 --vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off) 4276 --vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off) 4277 --vfs-cache-poll-interval duration Interval to poll the cache for stale objects (default 1m0s) 4278 --vfs-write-back duration Time to writeback files after last use when using cache (default 5s)</code></pre> 4279 <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> 4280 <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> 4281 <p>Note that files are written back to the remote only when they are closed and if they haven't been accessed for <code>--vfs-write-back</code> seconds. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags.</p> 4282 <p>If using <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-size</code> note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every <code>--vfs-cache-poll-interval</code>. Secondly because open files cannot be evicted from the cache. When <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-size</code> is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven't been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached.</p> 4283 <p>The <code>--vfs-cache-max-age</code> will evict files from the cache after the set time since last access has passed. The default value of 1 hour will start evicting files from cache that haven't been accessed for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0 and will wait for 1 more hour before evicting. Specify the time with standard notation, s, m, h, d, w .</p> 4284 <p>You <strong>should not</strong> run two copies of rclone using the same VFS cache with the same or overlapping remotes if using <code>--vfs-cache-mode > off</code>. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with <code>--cache-dir</code>. You don't need to worry about this if the remotes in use don't overlap.</p> 4285 <h3 id="vfs-cache-mode-off-3">--vfs-cache-mode off</h3> 4286 <p>In this mode (the default) the cache will read directly from the remote and write directly to the remote without caching anything on disk.</p> 4287 <p>This will mean some operations are not possible</p> 4288 <ul> 4289 <li>Files can't be opened for both read AND write</li> 4290 <li>Files opened for write can't be seeked</li> 4291 <li>Existing files opened for write must have O_TRUNC set</li> 4292 <li>Files open for read with O_TRUNC will be opened write only</li> 4293 <li>Files open for write only will behave as if O_TRUNC was supplied</li> 4294 <li>Open modes O_APPEND, O_TRUNC are ignored</li> 4295 <li>If an upload fails it can't be retried</li> 4296 </ul> 4297 <h3 id="vfs-cache-mode-minimal-3">--vfs-cache-mode minimal</h3> 4298 <p>This is very similar to "off" except that files opened for read AND write will be buffered to disk. This means that files opened for write will be a lot more compatible, but uses the minimal disk space.</p> 4299 <p>These operations are not possible</p> 4300 <ul> 4301 <li>Files opened for write only can't be seeked</li> 4302 <li>Existing files opened for write must have O_TRUNC set</li> 4303 <li>Files opened for write only will ignore O_APPEND, O_TRUNC</li> 4304 <li>If an upload fails it can't be retried</li> 4305 </ul> 4306 <h3 id="vfs-cache-mode-writes-3">--vfs-cache-mode writes</h3> 4307 <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> 4308 <p>This mode should support all normal file system operations.</p> 4309 <p>If an upload fails it will be retried at exponentially increasing intervals up to 1 minute.</p> 4310 <h3 id="vfs-cache-mode-full-3">--vfs-cache-mode full</h3> 4311 <p>In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well.</p> 4312 <p>In this mode the files in the cache will be sparse files and rclone will keep track of which bits of the files it has downloaded.</p> 4313 <p>So if an application only reads the starts of each file, then rclone will only buffer the start of the file. These files will appear to be their full size in the cache, but they will be sparse files with only the data that has been downloaded present in them.</p> 4314 <p>This mode should support all normal file system operations and is otherwise identical to <code>--vfs-cache-mode</code> writes.</p> 4315 <p>When reading a file rclone will read <code>--buffer-size</code> plus <code>--vfs-read-ahead</code> bytes ahead. The <code>--buffer-size</code> is buffered in memory whereas the <code>--vfs-read-ahead</code> is buffered on disk.</p> 4316 <p>When using this mode it is recommended that <code>--buffer-size</code> is not set too large and <code>--vfs-read-ahead</code> is set large if required.</p> 4317 <p><strong>IMPORTANT</strong> not all file systems support sparse files. In particular FAT/exFAT do not. Rclone will perform very badly if the cache directory is on a filesystem which doesn't support sparse files and it will log an ERROR message if one is detected.</p> 4318 <h3 id="fingerprinting-3">Fingerprinting</h3> 4319 <p>Various parts of the VFS use fingerprinting to see if a local file copy has changed relative to a remote file. Fingerprints are made from:</p> 4320 <ul> 4321 <li>size</li> 4322 <li>modification time</li> 4323 <li>hash</li> 4324 </ul> 4325 <p>where available on an object.</p> 4326 <p>On some backends some of these attributes are slow to read (they take an extra API call per object, or extra work per object).</p> 4327 <p>For example <code>hash</code> is slow with the <code>local</code> and <code>sftp</code> backends as they have to read the entire file and hash it, and <code>modtime</code> is slow with the <code>s3</code>, <code>swift</code>, <code>ftp</code> and <code>qinqstor</code> backends because they need to do an extra API call to fetch it.</p> 4328 <p>If you use the <code>--vfs-fast-fingerprint</code> flag then rclone will not include the slow operations in the fingerprint. This makes the fingerprinting less accurate but much faster and will improve the opening time of cached files.</p> 4329 <p>If you are running a vfs cache over <code>local</code>, <code>s3</code> or <code>swift</code> backends then using this flag is recommended.</p> 4330 <p>Note that if you change the value of this flag, the fingerprints of the files in the cache may be invalidated and the files will need to be downloaded again.</p> 4331 <h2 id="vfs-chunked-reading-3">VFS Chunked Reading</h2> 4332 <p>When rclone reads files from a remote it reads them in chunks. This means that rather than requesting the whole file rclone reads the chunk specified. This can reduce the used download quota for some remotes by requesting only chunks from the remote that are actually read, at the cost of an increased number of requests.</p> 4333 <p>These flags control the chunking:</p> 4334 <pre><code>--vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128M) 4335 --vfs-read-chunk-size-limit SizeSuffix Max chunk doubling size (default off)</code></pre> 4336 <p>Rclone will start reading a chunk of size <code>--vfs-read-chunk-size</code>, and then double the size for each read. When <code>--vfs-read-chunk-size-limit</code> is specified, and greater than <code>--vfs-read-chunk-size</code>, the chunk size for each open file will get doubled only until the specified value is reached. If the value is "off", which is the default, the limit is disabled and the chunk size will grow indefinitely.</p> 4337 <p>With <code>--vfs-read-chunk-size 100M</code> and <code>--vfs-read-chunk-size-limit 0</code> the following parts will be downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. When <code>--vfs-read-chunk-size-limit 500M</code> is specified, the result would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so on.</p> 4338 <p>Setting <code>--vfs-read-chunk-size</code> to <code>0</code> or "off" disables chunked reading.</p> 4339 <h2 id="vfs-performance-3">VFS Performance</h2> 4340 <p>These flags may be used to enable/disable features of the VFS for performance or other reasons. See also the <a href="#vfs-chunked-reading">chunked reading</a> feature.</p> 4341 <p>In particular S3 and Swift benefit hugely from the <code>--no-modtime</code> flag (or use <code>--use-server-modtime</code> for a slightly different effect) as each read of the modification time takes a transaction.</p> 4342 <pre><code>--no-checksum Don't compare checksums on up/download. 4343 --no-modtime Don't read/write the modification time (can speed things up). 4344 --no-seek Don't allow seeking in files. 4345 --read-only Only allow read-only access.</code></pre> 4346 <p>Sometimes rclone is delivered reads or writes out of order. Rather than seeking rclone will wait a short time for the in sequence read or write to come in. These flags only come into effect when not using an on disk cache file.</p> 4347 <pre><code>--vfs-read-wait duration Time to wait for in-sequence read before seeking (default 20ms) 4348 --vfs-write-wait duration Time to wait for in-sequence write before giving error (default 1s)</code></pre> 4349 <p>When using VFS write caching (<code>--vfs-cache-mode</code> with value writes or full), the global flag <code>--transfers</code> can be set to adjust the number of parallel uploads of modified files from the cache (the related global flag <code>--checkers</code> has no effect on the VFS).</p> 4350 <pre><code>--transfers int Number of file transfers to run in parallel (default 4)</code></pre> 4351 <h2 id="vfs-case-sensitivity-3">VFS Case Sensitivity</h2> 4352 <p>Linux file systems are case-sensitive: two files can differ only by case, and the exact case must be used when opening a file.</p> 4353 <p>File systems in modern Windows are case-insensitive but case-preserving: although existing files can be opened using any case, the exact case used to create the file is preserved and available for programs to query. It is not allowed for two files in the same directory to differ only by case.</p> 4354 <p>Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default.</p> 4355 <p>The <code>--vfs-case-insensitive</code> VFS flag controls how rclone handles these two cases. If its value is "false", rclone passes file names to the remote as-is. If the flag is "true" (or appears without a value on the command line), rclone may perform a "fixup" as explained below.</p> 4356 <p>The user may specify a file name to open/delete/rename/etc with a case different than what is stored on the remote. If an argument refers to an existing file with exactly the same name, then the case of the existing file on the disk will be used. However, if a file name with exactly the same name is not found but a name differing only by case exists, rclone will transparently fixup the name. This fixup happens only when an existing file is requested. Case sensitivity of file names created anew by rclone is controlled by the underlying remote.</p> 4357 <p>Note that case sensitivity of the operating system running rclone (the target) may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target.</p> 4358 <p>If the flag is not provided on the command line, then its default value depends on the operating system where rclone runs: "true" on Windows and macOS, "false" otherwise. If the flag is provided without a value, then it is "true".</p> 4359 <p>The <code>--no-unicode-normalization</code> flag controls whether a similar "fixup" is performed for filenames that differ but are <a href="https://en.wikipedia.org/wiki/Unicode_equivalence">canonically equivalent</a> with respect to unicode. Unicode normalization can be particularly helpful for users of macOS, which prefers form NFD instead of the NFC used by most other platforms. It is therefore highly recommended to keep the default of <code>false</code> on macOS, to avoid encoding compatibility issues.</p> 4360 <p>In the (probably unlikely) event that a directory has multiple duplicate filenames after applying case and unicode normalization, the <code>--vfs-block-norm-dupes</code> flag allows hiding these duplicates. This comes with a performance tradeoff, as rclone will have to scan the entire directory for duplicates when listing a directory. For this reason, it is recommended to leave this disabled if not needed. However, macOS users may wish to consider using it, as otherwise, if a remote directory contains both NFC and NFD versions of the same filename, an odd situation will occur: both versions of the file will be visible in the mount, and both will appear to be editable, however, editing either version will actually result in only the NFD version getting edited under the hood. <code>--vfs-block- norm-dupes</code> prevents this confusion by detecting this scenario, hiding the duplicates, and logging an error, similar to how this is handled in <code>rclone sync</code>.</p> 4361 <h2 id="vfs-disk-options-3">VFS Disk Options</h2> 4362 <p>This flag allows you to manually set the statistics about the filing system. It can be useful when those statistics cannot be read correctly automatically.</p> 4363 <pre><code>--vfs-disk-space-total-size Manually set the total disk space size (example: 256G, default: -1)</code></pre> 4364 <h2 id="alternate-report-of-used-bytes-3">Alternate report of used bytes</h2> 4365 <p>Some backends, most notably S3, do not report the amount of bytes used. If you need this information to be available when running <code>df</code> on the filesystem, then pass the flag <code>--vfs-used-is-size</code> to rclone. With this flag set, instead of relying on the backend to report this information, rclone will scan the whole remote similar to <code>rclone size</code> and compute the total used space itself.</p> 4366 <p><em>WARNING.</em> Contrary to <code>rclone size</code>, this flag ignores filters so that the result is accurate. However, this is very inefficient and may cost lots of API calls resulting in extra charges. Use it as a last resort and only with caching.</p> 4367 <pre><code>rclone serve docker [flags]</code></pre> 4368 <h2 id="options-71">Options</h2> 4369 <pre><code> --allow-non-empty Allow mounting over a non-empty directory (not supported on Windows) 4370 --allow-other Allow access to other users (not supported on Windows) 4371 --allow-root Allow access to root user (not supported on Windows) 4372 --async-read Use asynchronous reads (not supported on Windows) (default true) 4373 --attr-timeout Duration Time for which file/directory attributes are cached (default 1s) 4374 --base-dir string Base directory for volumes (default "/var/lib/docker-volumes/rclone") 4375 --daemon Run mount in background and exit parent process (as background output is suppressed, use --log-file with --log-format=pid,... to monitor) (not supported on Windows) 4376 --daemon-timeout Duration Time limit for rclone to respond to kernel (not supported on Windows) (default 0s) 4377 --daemon-wait Duration Time to wait for ready mount from daemon (maximum time on Linux, constant sleep time on OSX/BSD) (not supported on Windows) (default 1m0s) 4378 --debug-fuse Debug the FUSE internals - needs -v 4379 --default-permissions Makes kernel enforce access control based on the file mode (not supported on Windows) 4380 --devname string Set the device name - default is remote:path 4381 --dir-cache-time Duration Time to cache directory entries for (default 5m0s) 4382 --dir-perms FileMode Directory permissions (default 0777) 4383 --file-perms FileMode File permissions (default 0666) 4384 --forget-state Skip restoring previous state 4385 --fuse-flag stringArray Flags or arguments to be passed direct to libfuse/WinFsp (repeat if required) 4386 --gid uint32 Override the gid field set by the filesystem (not supported on Windows) (default 1000) 4387 -h, --help help for docker 4388 --max-read-ahead SizeSuffix The number of bytes that can be prefetched for sequential reads (not supported on Windows) (default 128Ki) 4389 --mount-case-insensitive Tristate Tell the OS the mount is case insensitive (true) or sensitive (false) regardless of the backend (auto) (default unset) 4390 --network-mode Mount as remote network drive, instead of fixed disk drive (supported on Windows only) 4391 --no-checksum Don't compare checksums on up/download 4392 --no-modtime Don't read/write the modification time (can speed things up) 4393 --no-seek Don't allow seeking in files 4394 --no-spec Do not write spec file 4395 --noappledouble Ignore Apple Double (._) and .DS_Store files (supported on OSX only) (default true) 4396 --noapplexattr Ignore all "com.apple.*" extended attributes (supported on OSX only) 4397 -o, --option stringArray Option for libfuse/WinFsp (repeat if required) 4398 --poll-interval Duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) 4399 --read-only Only allow read-only access 4400 --socket-addr string Address <host:port> or absolute path (default: /run/docker/plugins/rclone.sock) 4401 --socket-gid int GID for unix socket (default: current process GID) (default 1000) 4402 --uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000) 4403 --umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2) 4404 --vfs-block-norm-dupes If duplicate filenames exist in the same directory (after normalization), log an error and hide the duplicates (may have a performance cost) 4405 --vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s) 4406 --vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off) 4407 --vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off) 4408 --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) 4409 --vfs-cache-poll-interval Duration Interval to poll the cache for stale objects (default 1m0s) 4410 --vfs-case-insensitive If a file name not found, find a case insensitive match 4411 --vfs-disk-space-total-size SizeSuffix Specify the total space of disk (default off) 4412 --vfs-fast-fingerprint Use fast (less accurate) fingerprints for change detection 4413 --vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full 4414 --vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128Mi) 4415 --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) 4416 --vfs-read-wait Duration Time to wait for in-sequence read before seeking (default 20ms) 4417 --vfs-refresh Refreshes the directory cache recursively in the background on start 4418 --vfs-used-is-size rclone size Use the rclone size algorithm for Used size 4419 --vfs-write-back Duration Time to writeback files after last use when using cache (default 5s) 4420 --vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s) 4421 --volname string Set the volume name (supported on Windows and OSX only) 4422 --write-back-cache Makes kernel buffer writes before sending them to rclone (without this, writethrough caching is used) (not supported on Windows)</code></pre> 4423 <h2 id="filter-options-24">Filter Options</h2> 4424 <p>Flags for filtering directory listings.</p> 4425 <pre><code> --delete-excluded Delete files on dest excluded from sync 4426 --exclude stringArray Exclude files matching pattern 4427 --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) 4428 --exclude-if-present stringArray Exclude directories if filename is present 4429 --files-from stringArray Read list of source-file names from file (use - to read from stdin) 4430 --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) 4431 -f, --filter stringArray Add a file filtering rule 4432 --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) 4433 --ignore-case Ignore case in filters (case insensitive) 4434 --include stringArray Include files matching pattern 4435 --include-from stringArray Read file include patterns from file (use - to read from stdin) 4436 --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) 4437 --max-depth int If set limits the recursion depth to this (default -1) 4438 --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) 4439 --metadata-exclude stringArray Exclude metadatas matching pattern 4440 --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) 4441 --metadata-filter stringArray Add a metadata filtering rule 4442 --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) 4443 --metadata-include stringArray Include metadatas matching pattern 4444 --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) 4445 --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) 4446 --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre> 4447 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 4448 <h1 id="see-also-71">SEE ALSO</h1> 4449 <ul> 4450 <li><a href="https://rclone.org/commands/rclone_serve/">rclone serve</a> - Serve a remote over a protocol.</li> 4451 </ul> 4452 <h1 id="rclone-serve-ftp">rclone serve ftp</h1> 4453 <p>Serve remote:path over FTP.</p> 4454 <h2 id="synopsis-64">Synopsis</h2> 4455 <p>Run a basic FTP server to serve a remote over FTP protocol. This can be viewed with a FTP client or you can make a remote of type FTP to read and write it.</p> 4456 <h2 id="server-options-2">Server options</h2> 4457 <p>Use --addr to specify which IP address and port the server should listen on, e.g. --addr 1.2.3.4:8000 or --addr :8080 to listen to all IPs. By default it only listens on localhost. You can use port :0 to let the OS choose an available port.</p> 4458 <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> 4459 <h3 id="authentication-1">Authentication</h3> 4460 <p>By default this will serve files without needing a login.</p> 4461 <p>You can set a single username and password with the --user and --pass flags. ## VFS - Virtual File System</p> 4462 <p>This command uses the VFS layer. This adapts the cloud storage objects that rclone uses into something which looks much more like a disk filing system.</p> 4463 <p>Cloud storage objects have lots of properties which aren't like disk files - you can't extend them or write to the middle of them, so the VFS layer has to deal with that. Because there is no one right way of doing this there are various options explained below.</p> 4464 <p>The VFS layer also implements a directory cache - this caches info about files and directories (but not the data) in memory.</p> 4465 <h2 id="vfs-directory-cache-4">VFS Directory Cache</h2> 4466 <p>Using the <code>--dir-cache-time</code> flag, you can control how long a directory should be considered up to date and not refreshed from the backend. Changes made through the VFS will appear immediately or invalidate the cache.</p> 4467 <pre><code>--dir-cache-time duration Time to cache directory entries for (default 5m0s) 4468 --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)</code></pre> 4469 <p>However, changes made directly on the cloud storage by the web interface or a different copy of rclone will only be picked up once the directory cache expires if the backend configured does not support polling for changes. If the backend supports polling, changes will be picked up within the polling interval.</p> 4470 <p>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> 4471 <pre><code>kill -SIGHUP $(pidof rclone)</code></pre> 4472 <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> 4473 <pre><code>rclone rc vfs/forget</code></pre> 4474 <p>Or individual files or directories:</p> 4475 <pre><code>rclone rc vfs/forget file=path/to/file dir=path/to/dir</code></pre> 4476 <h2 id="vfs-file-buffering-4">VFS File Buffering</h2> 4477 <p>The <code>--buffer-size</code> flag determines the amount of memory, that will be used to buffer data in advance.</p> 4478 <p>Each open file will try to keep the specified amount of data in memory at all times. The buffered data is bound to one open file and won't be shared.</p> 4479 <p>This flag is a upper limit for the used memory per open file. The buffer will only use memory for data that is downloaded but not not yet read. If the buffer is empty, only a small amount of memory will be used.</p> 4480 <p>The maximum memory used by rclone for buffering can be up to <code>--buffer-size * open files</code>.</p> 4481 <h2 id="vfs-file-caching-4">VFS File Caching</h2> 4482 <p>These flags control the VFS file caching options. File caching is necessary to make the VFS layer appear compatible with a normal file system. It can be disabled at the cost of some compatibility.</p> 4483 <p>For example you'll need to enable VFS caching if you want to read and write simultaneously to a file. See below for more details.</p> 4484 <p>Note that the VFS cache is separate from the cache backend and you may find that you need one or the other or both.</p> 4485 <pre><code>--cache-dir string Directory rclone will use for caching. 4486 --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) 4487 --vfs-cache-max-age duration Max time since last access of objects in the cache (default 1h0m0s) 4488 --vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off) 4489 --vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off) 4490 --vfs-cache-poll-interval duration Interval to poll the cache for stale objects (default 1m0s) 4491 --vfs-write-back duration Time to writeback files after last use when using cache (default 5s)</code></pre> 4492 <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> 4493 <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> 4494 <p>Note that files are written back to the remote only when they are closed and if they haven't been accessed for <code>--vfs-write-back</code> seconds. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags.</p> 4495 <p>If using <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-size</code> note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every <code>--vfs-cache-poll-interval</code>. Secondly because open files cannot be evicted from the cache. When <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-size</code> is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven't been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached.</p> 4496 <p>The <code>--vfs-cache-max-age</code> will evict files from the cache after the set time since last access has passed. The default value of 1 hour will start evicting files from cache that haven't been accessed for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0 and will wait for 1 more hour before evicting. Specify the time with standard notation, s, m, h, d, w .</p> 4497 <p>You <strong>should not</strong> run two copies of rclone using the same VFS cache with the same or overlapping remotes if using <code>--vfs-cache-mode > off</code>. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with <code>--cache-dir</code>. You don't need to worry about this if the remotes in use don't overlap.</p> 4498 <h3 id="vfs-cache-mode-off-4">--vfs-cache-mode off</h3> 4499 <p>In this mode (the default) the cache will read directly from the remote and write directly to the remote without caching anything on disk.</p> 4500 <p>This will mean some operations are not possible</p> 4501 <ul> 4502 <li>Files can't be opened for both read AND write</li> 4503 <li>Files opened for write can't be seeked</li> 4504 <li>Existing files opened for write must have O_TRUNC set</li> 4505 <li>Files open for read with O_TRUNC will be opened write only</li> 4506 <li>Files open for write only will behave as if O_TRUNC was supplied</li> 4507 <li>Open modes O_APPEND, O_TRUNC are ignored</li> 4508 <li>If an upload fails it can't be retried</li> 4509 </ul> 4510 <h3 id="vfs-cache-mode-minimal-4">--vfs-cache-mode minimal</h3> 4511 <p>This is very similar to "off" except that files opened for read AND write will be buffered to disk. This means that files opened for write will be a lot more compatible, but uses the minimal disk space.</p> 4512 <p>These operations are not possible</p> 4513 <ul> 4514 <li>Files opened for write only can't be seeked</li> 4515 <li>Existing files opened for write must have O_TRUNC set</li> 4516 <li>Files opened for write only will ignore O_APPEND, O_TRUNC</li> 4517 <li>If an upload fails it can't be retried</li> 4518 </ul> 4519 <h3 id="vfs-cache-mode-writes-4">--vfs-cache-mode writes</h3> 4520 <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> 4521 <p>This mode should support all normal file system operations.</p> 4522 <p>If an upload fails it will be retried at exponentially increasing intervals up to 1 minute.</p> 4523 <h3 id="vfs-cache-mode-full-4">--vfs-cache-mode full</h3> 4524 <p>In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well.</p> 4525 <p>In this mode the files in the cache will be sparse files and rclone will keep track of which bits of the files it has downloaded.</p> 4526 <p>So if an application only reads the starts of each file, then rclone will only buffer the start of the file. These files will appear to be their full size in the cache, but they will be sparse files with only the data that has been downloaded present in them.</p> 4527 <p>This mode should support all normal file system operations and is otherwise identical to <code>--vfs-cache-mode</code> writes.</p> 4528 <p>When reading a file rclone will read <code>--buffer-size</code> plus <code>--vfs-read-ahead</code> bytes ahead. The <code>--buffer-size</code> is buffered in memory whereas the <code>--vfs-read-ahead</code> is buffered on disk.</p> 4529 <p>When using this mode it is recommended that <code>--buffer-size</code> is not set too large and <code>--vfs-read-ahead</code> is set large if required.</p> 4530 <p><strong>IMPORTANT</strong> not all file systems support sparse files. In particular FAT/exFAT do not. Rclone will perform very badly if the cache directory is on a filesystem which doesn't support sparse files and it will log an ERROR message if one is detected.</p> 4531 <h3 id="fingerprinting-4">Fingerprinting</h3> 4532 <p>Various parts of the VFS use fingerprinting to see if a local file copy has changed relative to a remote file. Fingerprints are made from:</p> 4533 <ul> 4534 <li>size</li> 4535 <li>modification time</li> 4536 <li>hash</li> 4537 </ul> 4538 <p>where available on an object.</p> 4539 <p>On some backends some of these attributes are slow to read (they take an extra API call per object, or extra work per object).</p> 4540 <p>For example <code>hash</code> is slow with the <code>local</code> and <code>sftp</code> backends as they have to read the entire file and hash it, and <code>modtime</code> is slow with the <code>s3</code>, <code>swift</code>, <code>ftp</code> and <code>qinqstor</code> backends because they need to do an extra API call to fetch it.</p> 4541 <p>If you use the <code>--vfs-fast-fingerprint</code> flag then rclone will not include the slow operations in the fingerprint. This makes the fingerprinting less accurate but much faster and will improve the opening time of cached files.</p> 4542 <p>If you are running a vfs cache over <code>local</code>, <code>s3</code> or <code>swift</code> backends then using this flag is recommended.</p> 4543 <p>Note that if you change the value of this flag, the fingerprints of the files in the cache may be invalidated and the files will need to be downloaded again.</p> 4544 <h2 id="vfs-chunked-reading-4">VFS Chunked Reading</h2> 4545 <p>When rclone reads files from a remote it reads them in chunks. This means that rather than requesting the whole file rclone reads the chunk specified. This can reduce the used download quota for some remotes by requesting only chunks from the remote that are actually read, at the cost of an increased number of requests.</p> 4546 <p>These flags control the chunking:</p> 4547 <pre><code>--vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128M) 4548 --vfs-read-chunk-size-limit SizeSuffix Max chunk doubling size (default off)</code></pre> 4549 <p>Rclone will start reading a chunk of size <code>--vfs-read-chunk-size</code>, and then double the size for each read. When <code>--vfs-read-chunk-size-limit</code> is specified, and greater than <code>--vfs-read-chunk-size</code>, the chunk size for each open file will get doubled only until the specified value is reached. If the value is "off", which is the default, the limit is disabled and the chunk size will grow indefinitely.</p> 4550 <p>With <code>--vfs-read-chunk-size 100M</code> and <code>--vfs-read-chunk-size-limit 0</code> the following parts will be downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. When <code>--vfs-read-chunk-size-limit 500M</code> is specified, the result would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so on.</p> 4551 <p>Setting <code>--vfs-read-chunk-size</code> to <code>0</code> or "off" disables chunked reading.</p> 4552 <h2 id="vfs-performance-4">VFS Performance</h2> 4553 <p>These flags may be used to enable/disable features of the VFS for performance or other reasons. See also the <a href="#vfs-chunked-reading">chunked reading</a> feature.</p> 4554 <p>In particular S3 and Swift benefit hugely from the <code>--no-modtime</code> flag (or use <code>--use-server-modtime</code> for a slightly different effect) as each read of the modification time takes a transaction.</p> 4555 <pre><code>--no-checksum Don't compare checksums on up/download. 4556 --no-modtime Don't read/write the modification time (can speed things up). 4557 --no-seek Don't allow seeking in files. 4558 --read-only Only allow read-only access.</code></pre> 4559 <p>Sometimes rclone is delivered reads or writes out of order. Rather than seeking rclone will wait a short time for the in sequence read or write to come in. These flags only come into effect when not using an on disk cache file.</p> 4560 <pre><code>--vfs-read-wait duration Time to wait for in-sequence read before seeking (default 20ms) 4561 --vfs-write-wait duration Time to wait for in-sequence write before giving error (default 1s)</code></pre> 4562 <p>When using VFS write caching (<code>--vfs-cache-mode</code> with value writes or full), the global flag <code>--transfers</code> can be set to adjust the number of parallel uploads of modified files from the cache (the related global flag <code>--checkers</code> has no effect on the VFS).</p> 4563 <pre><code>--transfers int Number of file transfers to run in parallel (default 4)</code></pre> 4564 <h2 id="vfs-case-sensitivity-4">VFS Case Sensitivity</h2> 4565 <p>Linux file systems are case-sensitive: two files can differ only by case, and the exact case must be used when opening a file.</p> 4566 <p>File systems in modern Windows are case-insensitive but case-preserving: although existing files can be opened using any case, the exact case used to create the file is preserved and available for programs to query. It is not allowed for two files in the same directory to differ only by case.</p> 4567 <p>Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default.</p> 4568 <p>The <code>--vfs-case-insensitive</code> VFS flag controls how rclone handles these two cases. If its value is "false", rclone passes file names to the remote as-is. If the flag is "true" (or appears without a value on the command line), rclone may perform a "fixup" as explained below.</p> 4569 <p>The user may specify a file name to open/delete/rename/etc with a case different than what is stored on the remote. If an argument refers to an existing file with exactly the same name, then the case of the existing file on the disk will be used. However, if a file name with exactly the same name is not found but a name differing only by case exists, rclone will transparently fixup the name. This fixup happens only when an existing file is requested. Case sensitivity of file names created anew by rclone is controlled by the underlying remote.</p> 4570 <p>Note that case sensitivity of the operating system running rclone (the target) may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target.</p> 4571 <p>If the flag is not provided on the command line, then its default value depends on the operating system where rclone runs: "true" on Windows and macOS, "false" otherwise. If the flag is provided without a value, then it is "true".</p> 4572 <p>The <code>--no-unicode-normalization</code> flag controls whether a similar "fixup" is performed for filenames that differ but are <a href="https://en.wikipedia.org/wiki/Unicode_equivalence">canonically equivalent</a> with respect to unicode. Unicode normalization can be particularly helpful for users of macOS, which prefers form NFD instead of the NFC used by most other platforms. It is therefore highly recommended to keep the default of <code>false</code> on macOS, to avoid encoding compatibility issues.</p> 4573 <p>In the (probably unlikely) event that a directory has multiple duplicate filenames after applying case and unicode normalization, the <code>--vfs-block-norm-dupes</code> flag allows hiding these duplicates. This comes with a performance tradeoff, as rclone will have to scan the entire directory for duplicates when listing a directory. For this reason, it is recommended to leave this disabled if not needed. However, macOS users may wish to consider using it, as otherwise, if a remote directory contains both NFC and NFD versions of the same filename, an odd situation will occur: both versions of the file will be visible in the mount, and both will appear to be editable, however, editing either version will actually result in only the NFD version getting edited under the hood. <code>--vfs-block- norm-dupes</code> prevents this confusion by detecting this scenario, hiding the duplicates, and logging an error, similar to how this is handled in <code>rclone sync</code>.</p> 4574 <h2 id="vfs-disk-options-4">VFS Disk Options</h2> 4575 <p>This flag allows you to manually set the statistics about the filing system. It can be useful when those statistics cannot be read correctly automatically.</p> 4576 <pre><code>--vfs-disk-space-total-size Manually set the total disk space size (example: 256G, default: -1)</code></pre> 4577 <h2 id="alternate-report-of-used-bytes-4">Alternate report of used bytes</h2> 4578 <p>Some backends, most notably S3, do not report the amount of bytes used. If you need this information to be available when running <code>df</code> on the filesystem, then pass the flag <code>--vfs-used-is-size</code> to rclone. With this flag set, instead of relying on the backend to report this information, rclone will scan the whole remote similar to <code>rclone size</code> and compute the total used space itself.</p> 4579 <p><em>WARNING.</em> Contrary to <code>rclone size</code>, this flag ignores filters so that the result is accurate. However, this is very inefficient and may cost lots of API calls resulting in extra charges. Use it as a last resort and only with caching.</p> 4580 <h2 id="auth-proxy">Auth Proxy</h2> 4581 <p>If you supply the parameter <code>--auth-proxy /path/to/program</code> then rclone will use that program to generate backends on the fly which then are used to authenticate incoming requests. This uses a simple JSON based protocol with input on STDIN and output on STDOUT.</p> 4582 <p><strong>PLEASE NOTE:</strong> <code>--auth-proxy</code> and <code>--authorized-keys</code> cannot be used together, if <code>--auth-proxy</code> is set the authorized keys option will be ignored.</p> 4583 <p>There is an example program <a href="https://github.com/rclone/rclone/blob/master/bin/test_proxy.py">bin/test_proxy.py</a> in the rclone source code.</p> 4584 <p>The program's job is to take a <code>user</code> and <code>pass</code> on the input and turn those into the config for a backend on STDOUT in JSON format. This config will have any default parameters for the backend added, but it won't use configuration from environment variables or command line options - it is the job of the proxy program to make a complete config.</p> 4585 <p>This config generated must have this extra parameter - <code>_root</code> - root to use for the backend</p> 4586 <p>And it may have this parameter - <code>_obscure</code> - comma separated strings for parameters to obscure</p> 4587 <p>If password authentication was used by the client, input to the proxy process (on STDIN) would look similar to this:</p> 4588 <pre><code>{ 4589 "user": "me", 4590 "pass": "mypassword" 4591 }</code></pre> 4592 <p>If public-key authentication was used by the client, input to the proxy process (on STDIN) would look similar to this:</p> 4593 <pre><code>{ 4594 "user": "me", 4595 "public_key": "AAAAB3NzaC1yc2EAAAADAQABAAABAQDuwESFdAe14hVS6omeyX7edc...JQdf" 4596 }</code></pre> 4597 <p>And as an example return this on STDOUT</p> 4598 <pre><code>{ 4599 "type": "sftp", 4600 "_root": "", 4601 "_obscure": "pass", 4602 "user": "me", 4603 "pass": "mypassword", 4604 "host": "sftp.example.com" 4605 }</code></pre> 4606 <p>This would mean that an SFTP backend would be created on the fly for the <code>user</code> and <code>pass</code>/<code>public_key</code> returned in the output to the host given. Note that since <code>_obscure</code> is set to <code>pass</code>, rclone will obscure the <code>pass</code> parameter before creating the backend (which is required for sftp backends).</p> 4607 <p>The program can manipulate the supplied <code>user</code> in any way, for example to make proxy to many different sftp backends, you could make the <code>user</code> be <code>user@example.com</code> and then set the <code>host</code> to <code>example.com</code> in the output and the user to <code>user</code>. For security you'd probably want to restrict the <code>host</code> to a limited list.</p> 4608 <p>Note that an internal cache is keyed on <code>user</code> so only use that for configuration, don't use <code>pass</code> or <code>public_key</code>. This also means that if a user's password or public-key is changed the cache will need to expire (which takes 5 mins) before it takes effect.</p> 4609 <p>This can be used to build general purpose proxies to any kind of backend that rclone supports.</p> 4610 <pre><code>rclone serve ftp remote:path [flags]</code></pre> 4611 <h2 id="options-72">Options</h2> 4612 <pre><code> --addr string IPaddress:Port or :Port to bind server to (default "localhost:2121") 4613 --auth-proxy string A program to use to create the backend from the auth 4614 --cert string TLS PEM key (concatenation of certificate and CA certificate) 4615 --dir-cache-time Duration Time to cache directory entries for (default 5m0s) 4616 --dir-perms FileMode Directory permissions (default 0777) 4617 --file-perms FileMode File permissions (default 0666) 4618 --gid uint32 Override the gid field set by the filesystem (not supported on Windows) (default 1000) 4619 -h, --help help for ftp 4620 --key string TLS PEM Private key 4621 --no-checksum Don't compare checksums on up/download 4622 --no-modtime Don't read/write the modification time (can speed things up) 4623 --no-seek Don't allow seeking in files 4624 --pass string Password for authentication (empty value allow every password) 4625 --passive-port string Passive port range to use (default "30000-32000") 4626 --poll-interval Duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) 4627 --public-ip string Public IP address to advertise for passive connections 4628 --read-only Only allow read-only access 4629 --uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000) 4630 --umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2) 4631 --user string User name for authentication (default "anonymous") 4632 --vfs-block-norm-dupes If duplicate filenames exist in the same directory (after normalization), log an error and hide the duplicates (may have a performance cost) 4633 --vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s) 4634 --vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off) 4635 --vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off) 4636 --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) 4637 --vfs-cache-poll-interval Duration Interval to poll the cache for stale objects (default 1m0s) 4638 --vfs-case-insensitive If a file name not found, find a case insensitive match 4639 --vfs-disk-space-total-size SizeSuffix Specify the total space of disk (default off) 4640 --vfs-fast-fingerprint Use fast (less accurate) fingerprints for change detection 4641 --vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full 4642 --vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128Mi) 4643 --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) 4644 --vfs-read-wait Duration Time to wait for in-sequence read before seeking (default 20ms) 4645 --vfs-refresh Refreshes the directory cache recursively in the background on start 4646 --vfs-used-is-size rclone size Use the rclone size algorithm for Used size 4647 --vfs-write-back Duration Time to writeback files after last use when using cache (default 5s) 4648 --vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s)</code></pre> 4649 <h2 id="filter-options-25">Filter Options</h2> 4650 <p>Flags for filtering directory listings.</p> 4651 <pre><code> --delete-excluded Delete files on dest excluded from sync 4652 --exclude stringArray Exclude files matching pattern 4653 --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) 4654 --exclude-if-present stringArray Exclude directories if filename is present 4655 --files-from stringArray Read list of source-file names from file (use - to read from stdin) 4656 --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) 4657 -f, --filter stringArray Add a file filtering rule 4658 --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) 4659 --ignore-case Ignore case in filters (case insensitive) 4660 --include stringArray Include files matching pattern 4661 --include-from stringArray Read file include patterns from file (use - to read from stdin) 4662 --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) 4663 --max-depth int If set limits the recursion depth to this (default -1) 4664 --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) 4665 --metadata-exclude stringArray Exclude metadatas matching pattern 4666 --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) 4667 --metadata-filter stringArray Add a metadata filtering rule 4668 --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) 4669 --metadata-include stringArray Include metadatas matching pattern 4670 --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) 4671 --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) 4672 --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre> 4673 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 4674 <h1 id="see-also-72">SEE ALSO</h1> 4675 <ul> 4676 <li><a href="https://rclone.org/commands/rclone_serve/">rclone serve</a> - Serve a remote over a protocol.</li> 4677 </ul> 4678 <h1 id="rclone-serve-http">rclone serve http</h1> 4679 <p>Serve the remote over HTTP.</p> 4680 <h2 id="synopsis-65">Synopsis</h2> 4681 <p>Run a basic web server to serve a remote over HTTP. This can be viewed in a web browser or you can make a remote of type http read from it.</p> 4682 <p>You can use the filter flags (e.g. <code>--include</code>, <code>--exclude</code>) to control what is served.</p> 4683 <p>The server will log errors. Use <code>-v</code> to see access logs.</p> 4684 <p><code>--bwlimit</code> will be respected for file transfers. Use <code>--stats</code> to control the stats printing.</p> 4685 <h2 id="server-options-3">Server options</h2> 4686 <p>Use <code>--addr</code> to specify which IP address and port the server should listen on, eg <code>--addr 1.2.3.4:8000</code> or <code>--addr :8080</code> 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> 4687 <p>If you set <code>--addr</code> to listen on a public or LAN accessible IP address then using Authentication is advised - see the next section for info.</p> 4688 <p>You can use a unix socket by setting the url to <code>unix:///path/to/socket</code> or just by using an absolute path name. Note that unix sockets bypass the authentication - this is expected to be done with file system permissions.</p> 4689 <p><code>--addr</code> may be repeated to listen on multiple IPs/ports/sockets.</p> 4690 <p><code>--server-read-timeout</code> and <code>--server-write-timeout</code> can be used to control the timeouts on the server. Note that this is the total time for a transfer.</p> 4691 <p><code>--max-header-bytes</code> controls the maximum number of bytes the server will accept in the HTTP header.</p> 4692 <p><code>--baseurl</code> controls the URL prefix that rclone serves from. By default rclone will serve from the root. If you used <code>--baseurl "/rclone"</code> then rclone would serve from a URL starting with "/rclone/". This is useful if you wish to proxy rclone serve. Rclone automatically inserts leading and trailing "/" on <code>--baseurl</code>, so <code>--baseurl "rclone"</code>, <code>--baseurl "/rclone"</code> and <code>--baseurl "/rclone/"</code> are all treated identically.</p> 4693 <h3 id="tls-ssl-1">TLS (SSL)</h3> 4694 <p>By default this will serve over http. If you want you can serve over https. You will need to supply the <code>--cert</code> and <code>--key</code> flags. If you wish to do client side certificate validation then you will need to supply <code>--client-ca</code> also.</p> 4695 <p><code>--cert</code> should be a either a PEM encoded certificate or a concatenation of that with the CA certificate. <code>--key</code> should be the PEM encoded private key and <code>--client-ca</code> should be the PEM encoded client certificate authority certificate.</p> 4696 <p>--min-tls-version is minimum TLS version that is acceptable. Valid values are "tls1.0", "tls1.1", "tls1.2" and "tls1.3" (default "tls1.0").</p> 4697 <h3 id="template-1">Template</h3> 4698 <p><code>--template</code> allows a user to specify a custom markup template for HTTP and WebDAV serve functions. The server exports the following markup to be used within the template to server pages:</p> 4699 <table> 4700 <colgroup> 4701 <col style="width: 50%" /> 4702 <col style="width: 50%" /> 4703 </colgroup> 4704 <thead> 4705 <tr class="header"> 4706 <th style="text-align: left;">Parameter</th> 4707 <th style="text-align: left;">Description</th> 4708 </tr> 4709 </thead> 4710 <tbody> 4711 <tr class="odd"> 4712 <td style="text-align: left;">.Name</td> 4713 <td style="text-align: left;">The full path of a file/directory.</td> 4714 </tr> 4715 <tr class="even"> 4716 <td style="text-align: left;">.Title</td> 4717 <td style="text-align: left;">Directory listing of .Name</td> 4718 </tr> 4719 <tr class="odd"> 4720 <td style="text-align: left;">.Sort</td> 4721 <td style="text-align: left;">The current sort used. This is changeable via ?sort= parameter</td> 4722 </tr> 4723 <tr class="even"> 4724 <td style="text-align: left;"></td> 4725 <td style="text-align: left;">Sort Options: namedirfirst,name,size,time (default namedirfirst)</td> 4726 </tr> 4727 <tr class="odd"> 4728 <td style="text-align: left;">.Order</td> 4729 <td style="text-align: left;">The current ordering used. This is changeable via ?order= parameter</td> 4730 </tr> 4731 <tr class="even"> 4732 <td style="text-align: left;"></td> 4733 <td style="text-align: left;">Order Options: asc,desc (default asc)</td> 4734 </tr> 4735 <tr class="odd"> 4736 <td style="text-align: left;">.Query</td> 4737 <td style="text-align: left;">Currently unused.</td> 4738 </tr> 4739 <tr class="even"> 4740 <td style="text-align: left;">.Breadcrumb</td> 4741 <td style="text-align: left;">Allows for creating a relative navigation</td> 4742 </tr> 4743 <tr class="odd"> 4744 <td style="text-align: left;">-- .Link</td> 4745 <td style="text-align: left;">The relative to the root link of the Text.</td> 4746 </tr> 4747 <tr class="even"> 4748 <td style="text-align: left;">-- .Text</td> 4749 <td style="text-align: left;">The Name of the directory.</td> 4750 </tr> 4751 <tr class="odd"> 4752 <td style="text-align: left;">.Entries</td> 4753 <td style="text-align: left;">Information about a specific file/directory.</td> 4754 </tr> 4755 <tr class="even"> 4756 <td style="text-align: left;">-- .URL</td> 4757 <td style="text-align: left;">The 'url' of an entry.</td> 4758 </tr> 4759 <tr class="odd"> 4760 <td style="text-align: left;">-- .Leaf</td> 4761 <td style="text-align: left;">Currently same as 'URL' but intended to be 'just' the name.</td> 4762 </tr> 4763 <tr class="even"> 4764 <td style="text-align: left;">-- .IsDir</td> 4765 <td style="text-align: left;">Boolean for if an entry is a directory or not.</td> 4766 </tr> 4767 <tr class="odd"> 4768 <td style="text-align: left;">-- .Size</td> 4769 <td style="text-align: left;">Size in Bytes of the entry.</td> 4770 </tr> 4771 <tr class="even"> 4772 <td style="text-align: left;">-- .ModTime</td> 4773 <td style="text-align: left;">The UTC timestamp of an entry.</td> 4774 </tr> 4775 </tbody> 4776 </table> 4777 <p>The server also makes the following functions available so that they can be used within the template. These functions help extend the options for dynamic rendering of HTML. They can be used to render HTML based on specific conditions.</p> 4778 <table> 4779 <colgroup> 4780 <col style="width: 50%" /> 4781 <col style="width: 50%" /> 4782 </colgroup> 4783 <thead> 4784 <tr class="header"> 4785 <th style="text-align: left;">Function</th> 4786 <th style="text-align: left;">Description</th> 4787 </tr> 4788 </thead> 4789 <tbody> 4790 <tr class="odd"> 4791 <td style="text-align: left;">afterEpoch</td> 4792 <td style="text-align: left;">Returns the time since the epoch for the given time.</td> 4793 </tr> 4794 <tr class="even"> 4795 <td style="text-align: left;">contains</td> 4796 <td style="text-align: left;">Checks whether a given substring is present or not in a given string.</td> 4797 </tr> 4798 <tr class="odd"> 4799 <td style="text-align: left;">hasPrefix</td> 4800 <td style="text-align: left;">Checks whether the given string begins with the specified prefix.</td> 4801 </tr> 4802 <tr class="even"> 4803 <td style="text-align: left;">hasSuffix</td> 4804 <td style="text-align: left;">Checks whether the given string end with the specified suffix.</td> 4805 </tr> 4806 </tbody> 4807 </table> 4808 <h3 id="authentication-2">Authentication</h3> 4809 <p>By default this will serve files without needing a login.</p> 4810 <p>You can either use an htpasswd file which can take lots of users, or set a single username and password with the <code>--user</code> and <code>--pass</code> flags.</p> 4811 <p>If no static users are configured by either of the above methods, and client certificates are required by the <code>--client-ca</code> flag passed to the server, the client certificate common name will be considered as the username.</p> 4812 <p>Use <code>--htpasswd /path/to/htpasswd</code> to provide an htpasswd file. This is in standard apache format and supports MD5, SHA1 and BCrypt for basic authentication. Bcrypt is recommended.</p> 4813 <p>To create an htpasswd file:</p> 4814 <pre><code>touch htpasswd 4815 htpasswd -B htpasswd user 4816 htpasswd -B htpasswd anotherUser</code></pre> 4817 <p>The password file can be updated while rclone is running.</p> 4818 <p>Use <code>--realm</code> to set the authentication realm.</p> 4819 <p>Use <code>--salt</code> to change the password hashing salt from the default. ## VFS - Virtual File System</p> 4820 <p>This command uses the VFS layer. This adapts the cloud storage objects that rclone uses into something which looks much more like a disk filing system.</p> 4821 <p>Cloud storage objects have lots of properties which aren't like disk files - you can't extend them or write to the middle of them, so the VFS layer has to deal with that. Because there is no one right way of doing this there are various options explained below.</p> 4822 <p>The VFS layer also implements a directory cache - this caches info about files and directories (but not the data) in memory.</p> 4823 <h2 id="vfs-directory-cache-5">VFS Directory Cache</h2> 4824 <p>Using the <code>--dir-cache-time</code> flag, you can control how long a directory should be considered up to date and not refreshed from the backend. Changes made through the VFS will appear immediately or invalidate the cache.</p> 4825 <pre><code>--dir-cache-time duration Time to cache directory entries for (default 5m0s) 4826 --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)</code></pre> 4827 <p>However, changes made directly on the cloud storage by the web interface or a different copy of rclone will only be picked up once the directory cache expires if the backend configured does not support polling for changes. If the backend supports polling, changes will be picked up within the polling interval.</p> 4828 <p>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> 4829 <pre><code>kill -SIGHUP $(pidof rclone)</code></pre> 4830 <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> 4831 <pre><code>rclone rc vfs/forget</code></pre> 4832 <p>Or individual files or directories:</p> 4833 <pre><code>rclone rc vfs/forget file=path/to/file dir=path/to/dir</code></pre> 4834 <h2 id="vfs-file-buffering-5">VFS File Buffering</h2> 4835 <p>The <code>--buffer-size</code> flag determines the amount of memory, that will be used to buffer data in advance.</p> 4836 <p>Each open file will try to keep the specified amount of data in memory at all times. The buffered data is bound to one open file and won't be shared.</p> 4837 <p>This flag is a upper limit for the used memory per open file. The buffer will only use memory for data that is downloaded but not not yet read. If the buffer is empty, only a small amount of memory will be used.</p> 4838 <p>The maximum memory used by rclone for buffering can be up to <code>--buffer-size * open files</code>.</p> 4839 <h2 id="vfs-file-caching-5">VFS File Caching</h2> 4840 <p>These flags control the VFS file caching options. File caching is necessary to make the VFS layer appear compatible with a normal file system. It can be disabled at the cost of some compatibility.</p> 4841 <p>For example you'll need to enable VFS caching if you want to read and write simultaneously to a file. See below for more details.</p> 4842 <p>Note that the VFS cache is separate from the cache backend and you may find that you need one or the other or both.</p> 4843 <pre><code>--cache-dir string Directory rclone will use for caching. 4844 --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) 4845 --vfs-cache-max-age duration Max time since last access of objects in the cache (default 1h0m0s) 4846 --vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off) 4847 --vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off) 4848 --vfs-cache-poll-interval duration Interval to poll the cache for stale objects (default 1m0s) 4849 --vfs-write-back duration Time to writeback files after last use when using cache (default 5s)</code></pre> 4850 <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> 4851 <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> 4852 <p>Note that files are written back to the remote only when they are closed and if they haven't been accessed for <code>--vfs-write-back</code> seconds. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags.</p> 4853 <p>If using <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-size</code> note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every <code>--vfs-cache-poll-interval</code>. Secondly because open files cannot be evicted from the cache. When <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-size</code> is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven't been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached.</p> 4854 <p>The <code>--vfs-cache-max-age</code> will evict files from the cache after the set time since last access has passed. The default value of 1 hour will start evicting files from cache that haven't been accessed for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0 and will wait for 1 more hour before evicting. Specify the time with standard notation, s, m, h, d, w .</p> 4855 <p>You <strong>should not</strong> run two copies of rclone using the same VFS cache with the same or overlapping remotes if using <code>--vfs-cache-mode > off</code>. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with <code>--cache-dir</code>. You don't need to worry about this if the remotes in use don't overlap.</p> 4856 <h3 id="vfs-cache-mode-off-5">--vfs-cache-mode off</h3> 4857 <p>In this mode (the default) the cache will read directly from the remote and write directly to the remote without caching anything on disk.</p> 4858 <p>This will mean some operations are not possible</p> 4859 <ul> 4860 <li>Files can't be opened for both read AND write</li> 4861 <li>Files opened for write can't be seeked</li> 4862 <li>Existing files opened for write must have O_TRUNC set</li> 4863 <li>Files open for read with O_TRUNC will be opened write only</li> 4864 <li>Files open for write only will behave as if O_TRUNC was supplied</li> 4865 <li>Open modes O_APPEND, O_TRUNC are ignored</li> 4866 <li>If an upload fails it can't be retried</li> 4867 </ul> 4868 <h3 id="vfs-cache-mode-minimal-5">--vfs-cache-mode minimal</h3> 4869 <p>This is very similar to "off" except that files opened for read AND write will be buffered to disk. This means that files opened for write will be a lot more compatible, but uses the minimal disk space.</p> 4870 <p>These operations are not possible</p> 4871 <ul> 4872 <li>Files opened for write only can't be seeked</li> 4873 <li>Existing files opened for write must have O_TRUNC set</li> 4874 <li>Files opened for write only will ignore O_APPEND, O_TRUNC</li> 4875 <li>If an upload fails it can't be retried</li> 4876 </ul> 4877 <h3 id="vfs-cache-mode-writes-5">--vfs-cache-mode writes</h3> 4878 <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> 4879 <p>This mode should support all normal file system operations.</p> 4880 <p>If an upload fails it will be retried at exponentially increasing intervals up to 1 minute.</p> 4881 <h3 id="vfs-cache-mode-full-5">--vfs-cache-mode full</h3> 4882 <p>In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well.</p> 4883 <p>In this mode the files in the cache will be sparse files and rclone will keep track of which bits of the files it has downloaded.</p> 4884 <p>So if an application only reads the starts of each file, then rclone will only buffer the start of the file. These files will appear to be their full size in the cache, but they will be sparse files with only the data that has been downloaded present in them.</p> 4885 <p>This mode should support all normal file system operations and is otherwise identical to <code>--vfs-cache-mode</code> writes.</p> 4886 <p>When reading a file rclone will read <code>--buffer-size</code> plus <code>--vfs-read-ahead</code> bytes ahead. The <code>--buffer-size</code> is buffered in memory whereas the <code>--vfs-read-ahead</code> is buffered on disk.</p> 4887 <p>When using this mode it is recommended that <code>--buffer-size</code> is not set too large and <code>--vfs-read-ahead</code> is set large if required.</p> 4888 <p><strong>IMPORTANT</strong> not all file systems support sparse files. In particular FAT/exFAT do not. Rclone will perform very badly if the cache directory is on a filesystem which doesn't support sparse files and it will log an ERROR message if one is detected.</p> 4889 <h3 id="fingerprinting-5">Fingerprinting</h3> 4890 <p>Various parts of the VFS use fingerprinting to see if a local file copy has changed relative to a remote file. Fingerprints are made from:</p> 4891 <ul> 4892 <li>size</li> 4893 <li>modification time</li> 4894 <li>hash</li> 4895 </ul> 4896 <p>where available on an object.</p> 4897 <p>On some backends some of these attributes are slow to read (they take an extra API call per object, or extra work per object).</p> 4898 <p>For example <code>hash</code> is slow with the <code>local</code> and <code>sftp</code> backends as they have to read the entire file and hash it, and <code>modtime</code> is slow with the <code>s3</code>, <code>swift</code>, <code>ftp</code> and <code>qinqstor</code> backends because they need to do an extra API call to fetch it.</p> 4899 <p>If you use the <code>--vfs-fast-fingerprint</code> flag then rclone will not include the slow operations in the fingerprint. This makes the fingerprinting less accurate but much faster and will improve the opening time of cached files.</p> 4900 <p>If you are running a vfs cache over <code>local</code>, <code>s3</code> or <code>swift</code> backends then using this flag is recommended.</p> 4901 <p>Note that if you change the value of this flag, the fingerprints of the files in the cache may be invalidated and the files will need to be downloaded again.</p> 4902 <h2 id="vfs-chunked-reading-5">VFS Chunked Reading</h2> 4903 <p>When rclone reads files from a remote it reads them in chunks. This means that rather than requesting the whole file rclone reads the chunk specified. This can reduce the used download quota for some remotes by requesting only chunks from the remote that are actually read, at the cost of an increased number of requests.</p> 4904 <p>These flags control the chunking:</p> 4905 <pre><code>--vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128M) 4906 --vfs-read-chunk-size-limit SizeSuffix Max chunk doubling size (default off)</code></pre> 4907 <p>Rclone will start reading a chunk of size <code>--vfs-read-chunk-size</code>, and then double the size for each read. When <code>--vfs-read-chunk-size-limit</code> is specified, and greater than <code>--vfs-read-chunk-size</code>, the chunk size for each open file will get doubled only until the specified value is reached. If the value is "off", which is the default, the limit is disabled and the chunk size will grow indefinitely.</p> 4908 <p>With <code>--vfs-read-chunk-size 100M</code> and <code>--vfs-read-chunk-size-limit 0</code> the following parts will be downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. When <code>--vfs-read-chunk-size-limit 500M</code> is specified, the result would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so on.</p> 4909 <p>Setting <code>--vfs-read-chunk-size</code> to <code>0</code> or "off" disables chunked reading.</p> 4910 <h2 id="vfs-performance-5">VFS Performance</h2> 4911 <p>These flags may be used to enable/disable features of the VFS for performance or other reasons. See also the <a href="#vfs-chunked-reading">chunked reading</a> feature.</p> 4912 <p>In particular S3 and Swift benefit hugely from the <code>--no-modtime</code> flag (or use <code>--use-server-modtime</code> for a slightly different effect) as each read of the modification time takes a transaction.</p> 4913 <pre><code>--no-checksum Don't compare checksums on up/download. 4914 --no-modtime Don't read/write the modification time (can speed things up). 4915 --no-seek Don't allow seeking in files. 4916 --read-only Only allow read-only access.</code></pre> 4917 <p>Sometimes rclone is delivered reads or writes out of order. Rather than seeking rclone will wait a short time for the in sequence read or write to come in. These flags only come into effect when not using an on disk cache file.</p> 4918 <pre><code>--vfs-read-wait duration Time to wait for in-sequence read before seeking (default 20ms) 4919 --vfs-write-wait duration Time to wait for in-sequence write before giving error (default 1s)</code></pre> 4920 <p>When using VFS write caching (<code>--vfs-cache-mode</code> with value writes or full), the global flag <code>--transfers</code> can be set to adjust the number of parallel uploads of modified files from the cache (the related global flag <code>--checkers</code> has no effect on the VFS).</p> 4921 <pre><code>--transfers int Number of file transfers to run in parallel (default 4)</code></pre> 4922 <h2 id="vfs-case-sensitivity-5">VFS Case Sensitivity</h2> 4923 <p>Linux file systems are case-sensitive: two files can differ only by case, and the exact case must be used when opening a file.</p> 4924 <p>File systems in modern Windows are case-insensitive but case-preserving: although existing files can be opened using any case, the exact case used to create the file is preserved and available for programs to query. It is not allowed for two files in the same directory to differ only by case.</p> 4925 <p>Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default.</p> 4926 <p>The <code>--vfs-case-insensitive</code> VFS flag controls how rclone handles these two cases. If its value is "false", rclone passes file names to the remote as-is. If the flag is "true" (or appears without a value on the command line), rclone may perform a "fixup" as explained below.</p> 4927 <p>The user may specify a file name to open/delete/rename/etc with a case different than what is stored on the remote. If an argument refers to an existing file with exactly the same name, then the case of the existing file on the disk will be used. However, if a file name with exactly the same name is not found but a name differing only by case exists, rclone will transparently fixup the name. This fixup happens only when an existing file is requested. Case sensitivity of file names created anew by rclone is controlled by the underlying remote.</p> 4928 <p>Note that case sensitivity of the operating system running rclone (the target) may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target.</p> 4929 <p>If the flag is not provided on the command line, then its default value depends on the operating system where rclone runs: "true" on Windows and macOS, "false" otherwise. If the flag is provided without a value, then it is "true".</p> 4930 <p>The <code>--no-unicode-normalization</code> flag controls whether a similar "fixup" is performed for filenames that differ but are <a href="https://en.wikipedia.org/wiki/Unicode_equivalence">canonically equivalent</a> with respect to unicode. Unicode normalization can be particularly helpful for users of macOS, which prefers form NFD instead of the NFC used by most other platforms. It is therefore highly recommended to keep the default of <code>false</code> on macOS, to avoid encoding compatibility issues.</p> 4931 <p>In the (probably unlikely) event that a directory has multiple duplicate filenames after applying case and unicode normalization, the <code>--vfs-block-norm-dupes</code> flag allows hiding these duplicates. This comes with a performance tradeoff, as rclone will have to scan the entire directory for duplicates when listing a directory. For this reason, it is recommended to leave this disabled if not needed. However, macOS users may wish to consider using it, as otherwise, if a remote directory contains both NFC and NFD versions of the same filename, an odd situation will occur: both versions of the file will be visible in the mount, and both will appear to be editable, however, editing either version will actually result in only the NFD version getting edited under the hood. <code>--vfs-block- norm-dupes</code> prevents this confusion by detecting this scenario, hiding the duplicates, and logging an error, similar to how this is handled in <code>rclone sync</code>.</p> 4932 <h2 id="vfs-disk-options-5">VFS Disk Options</h2> 4933 <p>This flag allows you to manually set the statistics about the filing system. It can be useful when those statistics cannot be read correctly automatically.</p> 4934 <pre><code>--vfs-disk-space-total-size Manually set the total disk space size (example: 256G, default: -1)</code></pre> 4935 <h2 id="alternate-report-of-used-bytes-5">Alternate report of used bytes</h2> 4936 <p>Some backends, most notably S3, do not report the amount of bytes used. If you need this information to be available when running <code>df</code> on the filesystem, then pass the flag <code>--vfs-used-is-size</code> to rclone. With this flag set, instead of relying on the backend to report this information, rclone will scan the whole remote similar to <code>rclone size</code> and compute the total used space itself.</p> 4937 <p><em>WARNING.</em> Contrary to <code>rclone size</code>, this flag ignores filters so that the result is accurate. However, this is very inefficient and may cost lots of API calls resulting in extra charges. Use it as a last resort and only with caching.</p> 4938 <h2 id="auth-proxy-1">Auth Proxy</h2> 4939 <p>If you supply the parameter <code>--auth-proxy /path/to/program</code> then rclone will use that program to generate backends on the fly which then are used to authenticate incoming requests. This uses a simple JSON based protocol with input on STDIN and output on STDOUT.</p> 4940 <p><strong>PLEASE NOTE:</strong> <code>--auth-proxy</code> and <code>--authorized-keys</code> cannot be used together, if <code>--auth-proxy</code> is set the authorized keys option will be ignored.</p> 4941 <p>There is an example program <a href="https://github.com/rclone/rclone/blob/master/bin/test_proxy.py">bin/test_proxy.py</a> in the rclone source code.</p> 4942 <p>The program's job is to take a <code>user</code> and <code>pass</code> on the input and turn those into the config for a backend on STDOUT in JSON format. This config will have any default parameters for the backend added, but it won't use configuration from environment variables or command line options - it is the job of the proxy program to make a complete config.</p> 4943 <p>This config generated must have this extra parameter - <code>_root</code> - root to use for the backend</p> 4944 <p>And it may have this parameter - <code>_obscure</code> - comma separated strings for parameters to obscure</p> 4945 <p>If password authentication was used by the client, input to the proxy process (on STDIN) would look similar to this:</p> 4946 <pre><code>{ 4947 "user": "me", 4948 "pass": "mypassword" 4949 }</code></pre> 4950 <p>If public-key authentication was used by the client, input to the proxy process (on STDIN) would look similar to this:</p> 4951 <pre><code>{ 4952 "user": "me", 4953 "public_key": "AAAAB3NzaC1yc2EAAAADAQABAAABAQDuwESFdAe14hVS6omeyX7edc...JQdf" 4954 }</code></pre> 4955 <p>And as an example return this on STDOUT</p> 4956 <pre><code>{ 4957 "type": "sftp", 4958 "_root": "", 4959 "_obscure": "pass", 4960 "user": "me", 4961 "pass": "mypassword", 4962 "host": "sftp.example.com" 4963 }</code></pre> 4964 <p>This would mean that an SFTP backend would be created on the fly for the <code>user</code> and <code>pass</code>/<code>public_key</code> returned in the output to the host given. Note that since <code>_obscure</code> is set to <code>pass</code>, rclone will obscure the <code>pass</code> parameter before creating the backend (which is required for sftp backends).</p> 4965 <p>The program can manipulate the supplied <code>user</code> in any way, for example to make proxy to many different sftp backends, you could make the <code>user</code> be <code>user@example.com</code> and then set the <code>host</code> to <code>example.com</code> in the output and the user to <code>user</code>. For security you'd probably want to restrict the <code>host</code> to a limited list.</p> 4966 <p>Note that an internal cache is keyed on <code>user</code> so only use that for configuration, don't use <code>pass</code> or <code>public_key</code>. This also means that if a user's password or public-key is changed the cache will need to expire (which takes 5 mins) before it takes effect.</p> 4967 <p>This can be used to build general purpose proxies to any kind of backend that rclone supports.</p> 4968 <pre><code>rclone serve http remote:path [flags]</code></pre> 4969 <h2 id="options-73">Options</h2> 4970 <pre><code> --addr stringArray IPaddress:Port or :Port to bind server to (default [127.0.0.1:8080]) 4971 --allow-origin string Origin which cross-domain request (CORS) can be executed from 4972 --auth-proxy string A program to use to create the backend from the auth 4973 --baseurl string Prefix for URLs - leave blank for root 4974 --cert string TLS PEM key (concatenation of certificate and CA certificate) 4975 --client-ca string Client certificate authority to verify clients with 4976 --dir-cache-time Duration Time to cache directory entries for (default 5m0s) 4977 --dir-perms FileMode Directory permissions (default 0777) 4978 --file-perms FileMode File permissions (default 0666) 4979 --gid uint32 Override the gid field set by the filesystem (not supported on Windows) (default 1000) 4980 -h, --help help for http 4981 --htpasswd string A htpasswd file - if not provided no authentication is done 4982 --key string TLS PEM Private key 4983 --max-header-bytes int Maximum size of request header (default 4096) 4984 --min-tls-version string Minimum TLS version that is acceptable (default "tls1.0") 4985 --no-checksum Don't compare checksums on up/download 4986 --no-modtime Don't read/write the modification time (can speed things up) 4987 --no-seek Don't allow seeking in files 4988 --pass string Password for authentication 4989 --poll-interval Duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) 4990 --read-only Only allow read-only access 4991 --realm string Realm for authentication 4992 --salt string Password hashing salt (default "dlPL2MqE") 4993 --server-read-timeout Duration Timeout for server reading data (default 1h0m0s) 4994 --server-write-timeout Duration Timeout for server writing data (default 1h0m0s) 4995 --template string User-specified template 4996 --uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000) 4997 --umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2) 4998 --user string User name for authentication 4999 --vfs-block-norm-dupes If duplicate filenames exist in the same directory (after normalization), log an error and hide the duplicates (may have a performance cost) 5000 --vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s) 5001 --vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off) 5002 --vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off) 5003 --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) 5004 --vfs-cache-poll-interval Duration Interval to poll the cache for stale objects (default 1m0s) 5005 --vfs-case-insensitive If a file name not found, find a case insensitive match 5006 --vfs-disk-space-total-size SizeSuffix Specify the total space of disk (default off) 5007 --vfs-fast-fingerprint Use fast (less accurate) fingerprints for change detection 5008 --vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full 5009 --vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128Mi) 5010 --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) 5011 --vfs-read-wait Duration Time to wait for in-sequence read before seeking (default 20ms) 5012 --vfs-refresh Refreshes the directory cache recursively in the background on start 5013 --vfs-used-is-size rclone size Use the rclone size algorithm for Used size 5014 --vfs-write-back Duration Time to writeback files after last use when using cache (default 5s) 5015 --vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s)</code></pre> 5016 <h2 id="filter-options-26">Filter Options</h2> 5017 <p>Flags for filtering directory listings.</p> 5018 <pre><code> --delete-excluded Delete files on dest excluded from sync 5019 --exclude stringArray Exclude files matching pattern 5020 --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) 5021 --exclude-if-present stringArray Exclude directories if filename is present 5022 --files-from stringArray Read list of source-file names from file (use - to read from stdin) 5023 --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) 5024 -f, --filter stringArray Add a file filtering rule 5025 --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) 5026 --ignore-case Ignore case in filters (case insensitive) 5027 --include stringArray Include files matching pattern 5028 --include-from stringArray Read file include patterns from file (use - to read from stdin) 5029 --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) 5030 --max-depth int If set limits the recursion depth to this (default -1) 5031 --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) 5032 --metadata-exclude stringArray Exclude metadatas matching pattern 5033 --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) 5034 --metadata-filter stringArray Add a metadata filtering rule 5035 --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) 5036 --metadata-include stringArray Include metadatas matching pattern 5037 --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) 5038 --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) 5039 --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre> 5040 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 5041 <h1 id="see-also-73">SEE ALSO</h1> 5042 <ul> 5043 <li><a href="https://rclone.org/commands/rclone_serve/">rclone serve</a> - Serve a remote over a protocol.</li> 5044 </ul> 5045 <h1 id="rclone-serve-nfs">rclone serve nfs</h1> 5046 <p>Serve the remote as an NFS mount</p> 5047 <h2 id="synopsis-66">Synopsis</h2> 5048 <p>Create an NFS server that serves the given remote over the network.</p> 5049 <p>The primary purpose for this command is to enable <a href="https://rclone.org/commands/rclone_mount/">mount command</a> on recent macOS versions where installing FUSE is very cumbersome.</p> 5050 <p>Since this is running on NFSv3, no authentication method is available. Any client will be able to access the data. To limit access, you can use serve NFS on loopback address and rely on secure tunnels (such as SSH). For this reason, by default, a random TCP port is chosen and loopback interface is used for the listening address; meaning that it is only available to the local machine. If you want other machines to access the NFS mount over local network, you need to specify the listening address and port using <code>--addr</code> flag.</p> 5051 <p>Modifying files through NFS protocol requires VFS caching. Usually you will need to specify <code>--vfs-cache-mode</code> in order to be able to write to the mountpoint (full is recommended). If you don't specify VFS cache mode, the mount will be read-only. Note also that <code>--nfs-cache-handle-limit</code> controls the maximum number of cached file handles stored by the caching handler. This should not be set too low or you may experience errors when trying to access files. The default is <code>1000000</code>, but consider lowering this limit if the server's system resource usage causes problems.</p> 5052 <p>To serve NFS over the network use following command:</p> 5053 <pre><code>rclone serve nfs remote: --addr 0.0.0.0:$PORT --vfs-cache-mode=full</code></pre> 5054 <p>We specify a specific port that we can use in the mount command:</p> 5055 <p>To mount the server under Linux/macOS, use the following command:</p> 5056 <pre><code>mount -oport=$PORT,mountport=$PORT $HOSTNAME: path/to/mountpoint</code></pre> 5057 <p>Where <code>$PORT</code> is the same port number we used in the serve nfs command.</p> 5058 <p>This feature is only available on Unix platforms.</p> 5059 <h2 id="vfs---virtual-file-system">VFS - Virtual File System</h2> 5060 <p>This command uses the VFS layer. This adapts the cloud storage objects that rclone uses into something which looks much more like a disk filing system.</p> 5061 <p>Cloud storage objects have lots of properties which aren't like disk files - you can't extend them or write to the middle of them, so the VFS layer has to deal with that. Because there is no one right way of doing this there are various options explained below.</p> 5062 <p>The VFS layer also implements a directory cache - this caches info about files and directories (but not the data) in memory.</p> 5063 <h2 id="vfs-directory-cache-6">VFS Directory Cache</h2> 5064 <p>Using the <code>--dir-cache-time</code> flag, you can control how long a directory should be considered up to date and not refreshed from the backend. Changes made through the VFS will appear immediately or invalidate the cache.</p> 5065 <pre><code>--dir-cache-time duration Time to cache directory entries for (default 5m0s) 5066 --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)</code></pre> 5067 <p>However, changes made directly on the cloud storage by the web interface or a different copy of rclone will only be picked up once the directory cache expires if the backend configured does not support polling for changes. If the backend supports polling, changes will be picked up within the polling interval.</p> 5068 <p>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> 5069 <pre><code>kill -SIGHUP $(pidof rclone)</code></pre> 5070 <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> 5071 <pre><code>rclone rc vfs/forget</code></pre> 5072 <p>Or individual files or directories:</p> 5073 <pre><code>rclone rc vfs/forget file=path/to/file dir=path/to/dir</code></pre> 5074 <h2 id="vfs-file-buffering-6">VFS File Buffering</h2> 5075 <p>The <code>--buffer-size</code> flag determines the amount of memory, that will be used to buffer data in advance.</p> 5076 <p>Each open file will try to keep the specified amount of data in memory at all times. The buffered data is bound to one open file and won't be shared.</p> 5077 <p>This flag is a upper limit for the used memory per open file. The buffer will only use memory for data that is downloaded but not not yet read. If the buffer is empty, only a small amount of memory will be used.</p> 5078 <p>The maximum memory used by rclone for buffering can be up to <code>--buffer-size * open files</code>.</p> 5079 <h2 id="vfs-file-caching-6">VFS File Caching</h2> 5080 <p>These flags control the VFS file caching options. File caching is necessary to make the VFS layer appear compatible with a normal file system. It can be disabled at the cost of some compatibility.</p> 5081 <p>For example you'll need to enable VFS caching if you want to read and write simultaneously to a file. See below for more details.</p> 5082 <p>Note that the VFS cache is separate from the cache backend and you may find that you need one or the other or both.</p> 5083 <pre><code>--cache-dir string Directory rclone will use for caching. 5084 --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) 5085 --vfs-cache-max-age duration Max time since last access of objects in the cache (default 1h0m0s) 5086 --vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off) 5087 --vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off) 5088 --vfs-cache-poll-interval duration Interval to poll the cache for stale objects (default 1m0s) 5089 --vfs-write-back duration Time to writeback files after last use when using cache (default 5s)</code></pre> 5090 <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> 5091 <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> 5092 <p>Note that files are written back to the remote only when they are closed and if they haven't been accessed for <code>--vfs-write-back</code> seconds. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags.</p> 5093 <p>If using <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-size</code> note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every <code>--vfs-cache-poll-interval</code>. Secondly because open files cannot be evicted from the cache. When <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-size</code> is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven't been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached.</p> 5094 <p>The <code>--vfs-cache-max-age</code> will evict files from the cache after the set time since last access has passed. The default value of 1 hour will start evicting files from cache that haven't been accessed for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0 and will wait for 1 more hour before evicting. Specify the time with standard notation, s, m, h, d, w .</p> 5095 <p>You <strong>should not</strong> run two copies of rclone using the same VFS cache with the same or overlapping remotes if using <code>--vfs-cache-mode > off</code>. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with <code>--cache-dir</code>. You don't need to worry about this if the remotes in use don't overlap.</p> 5096 <h3 id="vfs-cache-mode-off-6">--vfs-cache-mode off</h3> 5097 <p>In this mode (the default) the cache will read directly from the remote and write directly to the remote without caching anything on disk.</p> 5098 <p>This will mean some operations are not possible</p> 5099 <ul> 5100 <li>Files can't be opened for both read AND write</li> 5101 <li>Files opened for write can't be seeked</li> 5102 <li>Existing files opened for write must have O_TRUNC set</li> 5103 <li>Files open for read with O_TRUNC will be opened write only</li> 5104 <li>Files open for write only will behave as if O_TRUNC was supplied</li> 5105 <li>Open modes O_APPEND, O_TRUNC are ignored</li> 5106 <li>If an upload fails it can't be retried</li> 5107 </ul> 5108 <h3 id="vfs-cache-mode-minimal-6">--vfs-cache-mode minimal</h3> 5109 <p>This is very similar to "off" except that files opened for read AND write will be buffered to disk. This means that files opened for write will be a lot more compatible, but uses the minimal disk space.</p> 5110 <p>These operations are not possible</p> 5111 <ul> 5112 <li>Files opened for write only can't be seeked</li> 5113 <li>Existing files opened for write must have O_TRUNC set</li> 5114 <li>Files opened for write only will ignore O_APPEND, O_TRUNC</li> 5115 <li>If an upload fails it can't be retried</li> 5116 </ul> 5117 <h3 id="vfs-cache-mode-writes-6">--vfs-cache-mode writes</h3> 5118 <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> 5119 <p>This mode should support all normal file system operations.</p> 5120 <p>If an upload fails it will be retried at exponentially increasing intervals up to 1 minute.</p> 5121 <h3 id="vfs-cache-mode-full-6">--vfs-cache-mode full</h3> 5122 <p>In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well.</p> 5123 <p>In this mode the files in the cache will be sparse files and rclone will keep track of which bits of the files it has downloaded.</p> 5124 <p>So if an application only reads the starts of each file, then rclone will only buffer the start of the file. These files will appear to be their full size in the cache, but they will be sparse files with only the data that has been downloaded present in them.</p> 5125 <p>This mode should support all normal file system operations and is otherwise identical to <code>--vfs-cache-mode</code> writes.</p> 5126 <p>When reading a file rclone will read <code>--buffer-size</code> plus <code>--vfs-read-ahead</code> bytes ahead. The <code>--buffer-size</code> is buffered in memory whereas the <code>--vfs-read-ahead</code> is buffered on disk.</p> 5127 <p>When using this mode it is recommended that <code>--buffer-size</code> is not set too large and <code>--vfs-read-ahead</code> is set large if required.</p> 5128 <p><strong>IMPORTANT</strong> not all file systems support sparse files. In particular FAT/exFAT do not. Rclone will perform very badly if the cache directory is on a filesystem which doesn't support sparse files and it will log an ERROR message if one is detected.</p> 5129 <h3 id="fingerprinting-6">Fingerprinting</h3> 5130 <p>Various parts of the VFS use fingerprinting to see if a local file copy has changed relative to a remote file. Fingerprints are made from:</p> 5131 <ul> 5132 <li>size</li> 5133 <li>modification time</li> 5134 <li>hash</li> 5135 </ul> 5136 <p>where available on an object.</p> 5137 <p>On some backends some of these attributes are slow to read (they take an extra API call per object, or extra work per object).</p> 5138 <p>For example <code>hash</code> is slow with the <code>local</code> and <code>sftp</code> backends as they have to read the entire file and hash it, and <code>modtime</code> is slow with the <code>s3</code>, <code>swift</code>, <code>ftp</code> and <code>qinqstor</code> backends because they need to do an extra API call to fetch it.</p> 5139 <p>If you use the <code>--vfs-fast-fingerprint</code> flag then rclone will not include the slow operations in the fingerprint. This makes the fingerprinting less accurate but much faster and will improve the opening time of cached files.</p> 5140 <p>If you are running a vfs cache over <code>local</code>, <code>s3</code> or <code>swift</code> backends then using this flag is recommended.</p> 5141 <p>Note that if you change the value of this flag, the fingerprints of the files in the cache may be invalidated and the files will need to be downloaded again.</p> 5142 <h2 id="vfs-chunked-reading-6">VFS Chunked Reading</h2> 5143 <p>When rclone reads files from a remote it reads them in chunks. This means that rather than requesting the whole file rclone reads the chunk specified. This can reduce the used download quota for some remotes by requesting only chunks from the remote that are actually read, at the cost of an increased number of requests.</p> 5144 <p>These flags control the chunking:</p> 5145 <pre><code>--vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128M) 5146 --vfs-read-chunk-size-limit SizeSuffix Max chunk doubling size (default off)</code></pre> 5147 <p>Rclone will start reading a chunk of size <code>--vfs-read-chunk-size</code>, and then double the size for each read. When <code>--vfs-read-chunk-size-limit</code> is specified, and greater than <code>--vfs-read-chunk-size</code>, the chunk size for each open file will get doubled only until the specified value is reached. If the value is "off", which is the default, the limit is disabled and the chunk size will grow indefinitely.</p> 5148 <p>With <code>--vfs-read-chunk-size 100M</code> and <code>--vfs-read-chunk-size-limit 0</code> the following parts will be downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. When <code>--vfs-read-chunk-size-limit 500M</code> is specified, the result would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so on.</p> 5149 <p>Setting <code>--vfs-read-chunk-size</code> to <code>0</code> or "off" disables chunked reading.</p> 5150 <h2 id="vfs-performance-6">VFS Performance</h2> 5151 <p>These flags may be used to enable/disable features of the VFS for performance or other reasons. See also the <a href="#vfs-chunked-reading">chunked reading</a> feature.</p> 5152 <p>In particular S3 and Swift benefit hugely from the <code>--no-modtime</code> flag (or use <code>--use-server-modtime</code> for a slightly different effect) as each read of the modification time takes a transaction.</p> 5153 <pre><code>--no-checksum Don't compare checksums on up/download. 5154 --no-modtime Don't read/write the modification time (can speed things up). 5155 --no-seek Don't allow seeking in files. 5156 --read-only Only allow read-only access.</code></pre> 5157 <p>Sometimes rclone is delivered reads or writes out of order. Rather than seeking rclone will wait a short time for the in sequence read or write to come in. These flags only come into effect when not using an on disk cache file.</p> 5158 <pre><code>--vfs-read-wait duration Time to wait for in-sequence read before seeking (default 20ms) 5159 --vfs-write-wait duration Time to wait for in-sequence write before giving error (default 1s)</code></pre> 5160 <p>When using VFS write caching (<code>--vfs-cache-mode</code> with value writes or full), the global flag <code>--transfers</code> can be set to adjust the number of parallel uploads of modified files from the cache (the related global flag <code>--checkers</code> has no effect on the VFS).</p> 5161 <pre><code>--transfers int Number of file transfers to run in parallel (default 4)</code></pre> 5162 <h2 id="vfs-case-sensitivity-6">VFS Case Sensitivity</h2> 5163 <p>Linux file systems are case-sensitive: two files can differ only by case, and the exact case must be used when opening a file.</p> 5164 <p>File systems in modern Windows are case-insensitive but case-preserving: although existing files can be opened using any case, the exact case used to create the file is preserved and available for programs to query. It is not allowed for two files in the same directory to differ only by case.</p> 5165 <p>Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default.</p> 5166 <p>The <code>--vfs-case-insensitive</code> VFS flag controls how rclone handles these two cases. If its value is "false", rclone passes file names to the remote as-is. If the flag is "true" (or appears without a value on the command line), rclone may perform a "fixup" as explained below.</p> 5167 <p>The user may specify a file name to open/delete/rename/etc with a case different than what is stored on the remote. If an argument refers to an existing file with exactly the same name, then the case of the existing file on the disk will be used. However, if a file name with exactly the same name is not found but a name differing only by case exists, rclone will transparently fixup the name. This fixup happens only when an existing file is requested. Case sensitivity of file names created anew by rclone is controlled by the underlying remote.</p> 5168 <p>Note that case sensitivity of the operating system running rclone (the target) may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target.</p> 5169 <p>If the flag is not provided on the command line, then its default value depends on the operating system where rclone runs: "true" on Windows and macOS, "false" otherwise. If the flag is provided without a value, then it is "true".</p> 5170 <p>The <code>--no-unicode-normalization</code> flag controls whether a similar "fixup" is performed for filenames that differ but are <a href="https://en.wikipedia.org/wiki/Unicode_equivalence">canonically equivalent</a> with respect to unicode. Unicode normalization can be particularly helpful for users of macOS, which prefers form NFD instead of the NFC used by most other platforms. It is therefore highly recommended to keep the default of <code>false</code> on macOS, to avoid encoding compatibility issues.</p> 5171 <p>In the (probably unlikely) event that a directory has multiple duplicate filenames after applying case and unicode normalization, the <code>--vfs-block-norm-dupes</code> flag allows hiding these duplicates. This comes with a performance tradeoff, as rclone will have to scan the entire directory for duplicates when listing a directory. For this reason, it is recommended to leave this disabled if not needed. However, macOS users may wish to consider using it, as otherwise, if a remote directory contains both NFC and NFD versions of the same filename, an odd situation will occur: both versions of the file will be visible in the mount, and both will appear to be editable, however, editing either version will actually result in only the NFD version getting edited under the hood. <code>--vfs-block- norm-dupes</code> prevents this confusion by detecting this scenario, hiding the duplicates, and logging an error, similar to how this is handled in <code>rclone sync</code>.</p> 5172 <h2 id="vfs-disk-options-6">VFS Disk Options</h2> 5173 <p>This flag allows you to manually set the statistics about the filing system. It can be useful when those statistics cannot be read correctly automatically.</p> 5174 <pre><code>--vfs-disk-space-total-size Manually set the total disk space size (example: 256G, default: -1)</code></pre> 5175 <h2 id="alternate-report-of-used-bytes-6">Alternate report of used bytes</h2> 5176 <p>Some backends, most notably S3, do not report the amount of bytes used. If you need this information to be available when running <code>df</code> on the filesystem, then pass the flag <code>--vfs-used-is-size</code> to rclone. With this flag set, instead of relying on the backend to report this information, rclone will scan the whole remote similar to <code>rclone size</code> and compute the total used space itself.</p> 5177 <p><em>WARNING.</em> Contrary to <code>rclone size</code>, this flag ignores filters so that the result is accurate. However, this is very inefficient and may cost lots of API calls resulting in extra charges. Use it as a last resort and only with caching.</p> 5178 <pre><code>rclone serve nfs remote:path [flags]</code></pre> 5179 <h2 id="options-74">Options</h2> 5180 <pre><code> --addr string IPaddress:Port or :Port to bind server to 5181 --dir-cache-time Duration Time to cache directory entries for (default 5m0s) 5182 --dir-perms FileMode Directory permissions (default 0777) 5183 --file-perms FileMode File permissions (default 0666) 5184 --gid uint32 Override the gid field set by the filesystem (not supported on Windows) (default 1000) 5185 -h, --help help for nfs 5186 --nfs-cache-handle-limit int max file handles cached simultaneously (min 5) (default 1000000) 5187 --no-checksum Don't compare checksums on up/download 5188 --no-modtime Don't read/write the modification time (can speed things up) 5189 --no-seek Don't allow seeking in files 5190 --poll-interval Duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) 5191 --read-only Only allow read-only access 5192 --uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000) 5193 --umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2) 5194 --vfs-block-norm-dupes If duplicate filenames exist in the same directory (after normalization), log an error and hide the duplicates (may have a performance cost) 5195 --vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s) 5196 --vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off) 5197 --vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off) 5198 --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) 5199 --vfs-cache-poll-interval Duration Interval to poll the cache for stale objects (default 1m0s) 5200 --vfs-case-insensitive If a file name not found, find a case insensitive match 5201 --vfs-disk-space-total-size SizeSuffix Specify the total space of disk (default off) 5202 --vfs-fast-fingerprint Use fast (less accurate) fingerprints for change detection 5203 --vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full 5204 --vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128Mi) 5205 --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) 5206 --vfs-read-wait Duration Time to wait for in-sequence read before seeking (default 20ms) 5207 --vfs-refresh Refreshes the directory cache recursively in the background on start 5208 --vfs-used-is-size rclone size Use the rclone size algorithm for Used size 5209 --vfs-write-back Duration Time to writeback files after last use when using cache (default 5s) 5210 --vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s)</code></pre> 5211 <h2 id="filter-options-27">Filter Options</h2> 5212 <p>Flags for filtering directory listings.</p> 5213 <pre><code> --delete-excluded Delete files on dest excluded from sync 5214 --exclude stringArray Exclude files matching pattern 5215 --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) 5216 --exclude-if-present stringArray Exclude directories if filename is present 5217 --files-from stringArray Read list of source-file names from file (use - to read from stdin) 5218 --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) 5219 -f, --filter stringArray Add a file filtering rule 5220 --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) 5221 --ignore-case Ignore case in filters (case insensitive) 5222 --include stringArray Include files matching pattern 5223 --include-from stringArray Read file include patterns from file (use - to read from stdin) 5224 --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) 5225 --max-depth int If set limits the recursion depth to this (default -1) 5226 --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) 5227 --metadata-exclude stringArray Exclude metadatas matching pattern 5228 --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) 5229 --metadata-filter stringArray Add a metadata filtering rule 5230 --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) 5231 --metadata-include stringArray Include metadatas matching pattern 5232 --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) 5233 --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) 5234 --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre> 5235 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 5236 <h1 id="see-also-74">SEE ALSO</h1> 5237 <ul> 5238 <li><a href="https://rclone.org/commands/rclone_serve/">rclone serve</a> - Serve a remote over a protocol.</li> 5239 </ul> 5240 <h1 id="rclone-serve-restic">rclone serve restic</h1> 5241 <p>Serve the remote for restic's REST API.</p> 5242 <h2 id="synopsis-67">Synopsis</h2> 5243 <p>Run a basic web server to serve a remote over restic's REST backend API over HTTP. This allows restic to use rclone as a data storage mechanism for cloud providers that restic does not support directly.</p> 5244 <p><a href="https://restic.net/">Restic</a> is a command-line program for doing backups.</p> 5245 <p>The server will log errors. Use -v to see access logs.</p> 5246 <p><code>--bwlimit</code> will be respected for file transfers. Use <code>--stats</code> to control the stats printing.</p> 5247 <h2 id="setting-up-rclone-for-use-by-restic">Setting up rclone for use by restic</h2> 5248 <p>First <a href="https://rclone.org/docs/#configure">set up a remote for your chosen cloud provider</a>.</p> 5249 <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> 5250 <p>Now start the rclone restic server</p> 5251 <pre><code>rclone serve restic -v remote:backup</code></pre> 5252 <p>Where you can replace "backup" in the above by whatever path in the remote you wish to use.</p> 5253 <p>By default this will serve on "localhost:8080" you can change this with use of the <code>--addr</code> flag.</p> 5254 <p>You might wish to start this server on boot.</p> 5255 <p>Adding <code>--cache-objects=false</code> will cause rclone to stop caching objects returned from the List call. Caching is normally desirable as it speeds up downloading objects, saves transactions and uses very little memory.</p> 5256 <h2 id="setting-up-restic-to-use-rclone">Setting up restic to use rclone</h2> 5257 <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> 5258 <p>Note that you will need restic 0.8.2 or later to interoperate with rclone.</p> 5259 <p>For the example above you will want to use "http://localhost:8080/" as the URL for the REST server.</p> 5260 <p>For example:</p> 5261 <pre><code>$ export RESTIC_REPOSITORY=rest:http://localhost:8080/ 5262 $ export RESTIC_PASSWORD=yourpassword 5263 $ restic init 5264 created restic backend 8b1a4b56ae at rest:http://localhost:8080/ 5265 5266 Please note that knowledge of your password is required to access 5267 the repository. Losing your password means that your data is 5268 irrecoverably lost. 5269 $ restic backup /path/to/files/to/backup 5270 scan [/path/to/files/to/backup] 5271 scanned 189 directories, 312 files in 0:00 5272 [0:00] 100.00% 38.128 MiB / 38.128 MiB 501 / 501 items 0 errors ETA 0:00 5273 duration: 0:00 5274 snapshot 45c8fdd8 saved</code></pre> 5275 <h3 id="multiple-repositories">Multiple repositories</h3> 5276 <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> 5277 <pre><code>$ export RESTIC_REPOSITORY=rest:http://localhost:8080/user1repo/ 5278 # backup user1 stuff 5279 $ export RESTIC_REPOSITORY=rest:http://localhost:8080/user2repo/ 5280 # backup user2 stuff</code></pre> 5281 <h3 id="private-repositories">Private repositories</h3> 5282 <p>The<code>--private-repos</code> flag can be used to limit users to repositories starting with a path of <code>/<username>/</code>.</p> 5283 <h2 id="server-options-4">Server options</h2> 5284 <p>Use <code>--addr</code> to specify which IP address and port the server should listen on, eg <code>--addr 1.2.3.4:8000</code> or <code>--addr :8080</code> 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> 5285 <p>If you set <code>--addr</code> to listen on a public or LAN accessible IP address then using Authentication is advised - see the next section for info.</p> 5286 <p>You can use a unix socket by setting the url to <code>unix:///path/to/socket</code> or just by using an absolute path name. Note that unix sockets bypass the authentication - this is expected to be done with file system permissions.</p> 5287 <p><code>--addr</code> may be repeated to listen on multiple IPs/ports/sockets.</p> 5288 <p><code>--server-read-timeout</code> and <code>--server-write-timeout</code> can be used to control the timeouts on the server. Note that this is the total time for a transfer.</p> 5289 <p><code>--max-header-bytes</code> controls the maximum number of bytes the server will accept in the HTTP header.</p> 5290 <p><code>--baseurl</code> controls the URL prefix that rclone serves from. By default rclone will serve from the root. If you used <code>--baseurl "/rclone"</code> then rclone would serve from a URL starting with "/rclone/". This is useful if you wish to proxy rclone serve. Rclone automatically inserts leading and trailing "/" on <code>--baseurl</code>, so <code>--baseurl "rclone"</code>, <code>--baseurl "/rclone"</code> and <code>--baseurl "/rclone/"</code> are all treated identically.</p> 5291 <h3 id="tls-ssl-2">TLS (SSL)</h3> 5292 <p>By default this will serve over http. If you want you can serve over https. You will need to supply the <code>--cert</code> and <code>--key</code> flags. If you wish to do client side certificate validation then you will need to supply <code>--client-ca</code> also.</p> 5293 <p><code>--cert</code> should be a either a PEM encoded certificate or a concatenation of that with the CA certificate. <code>--key</code> should be the PEM encoded private key and <code>--client-ca</code> should be the PEM encoded client certificate authority certificate.</p> 5294 <p>--min-tls-version is minimum TLS version that is acceptable. Valid values are "tls1.0", "tls1.1", "tls1.2" and "tls1.3" (default "tls1.0").</p> 5295 <h3 id="authentication-3">Authentication</h3> 5296 <p>By default this will serve files without needing a login.</p> 5297 <p>You can either use an htpasswd file which can take lots of users, or set a single username and password with the <code>--user</code> and <code>--pass</code> flags.</p> 5298 <p>If no static users are configured by either of the above methods, and client certificates are required by the <code>--client-ca</code> flag passed to the server, the client certificate common name will be considered as the username.</p> 5299 <p>Use <code>--htpasswd /path/to/htpasswd</code> to provide an htpasswd file. This is in standard apache format and supports MD5, SHA1 and BCrypt for basic authentication. Bcrypt is recommended.</p> 5300 <p>To create an htpasswd file:</p> 5301 <pre><code>touch htpasswd 5302 htpasswd -B htpasswd user 5303 htpasswd -B htpasswd anotherUser</code></pre> 5304 <p>The password file can be updated while rclone is running.</p> 5305 <p>Use <code>--realm</code> to set the authentication realm.</p> 5306 <p>Use <code>--salt</code> to change the password hashing salt from the default.</p> 5307 <pre><code>rclone serve restic remote:path [flags]</code></pre> 5308 <h2 id="options-75">Options</h2> 5309 <pre><code> --addr stringArray IPaddress:Port or :Port to bind server to (default [127.0.0.1:8080]) 5310 --allow-origin string Origin which cross-domain request (CORS) can be executed from 5311 --append-only Disallow deletion of repository data 5312 --baseurl string Prefix for URLs - leave blank for root 5313 --cache-objects Cache listed objects (default true) 5314 --cert string TLS PEM key (concatenation of certificate and CA certificate) 5315 --client-ca string Client certificate authority to verify clients with 5316 -h, --help help for restic 5317 --htpasswd string A htpasswd file - if not provided no authentication is done 5318 --key string TLS PEM Private key 5319 --max-header-bytes int Maximum size of request header (default 4096) 5320 --min-tls-version string Minimum TLS version that is acceptable (default "tls1.0") 5321 --pass string Password for authentication 5322 --private-repos Users can only access their private repo 5323 --realm string Realm for authentication 5324 --salt string Password hashing salt (default "dlPL2MqE") 5325 --server-read-timeout Duration Timeout for server reading data (default 1h0m0s) 5326 --server-write-timeout Duration Timeout for server writing data (default 1h0m0s) 5327 --stdio Run an HTTP2 server on stdin/stdout 5328 --user string User name for authentication</code></pre> 5329 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 5330 <h1 id="see-also-75">SEE ALSO</h1> 5331 <ul> 5332 <li><a href="https://rclone.org/commands/rclone_serve/">rclone serve</a> - Serve a remote over a protocol.</li> 5333 </ul> 5334 <h1 id="rclone-serve-s3">rclone serve s3</h1> 5335 <p>Serve remote:path over s3.</p> 5336 <h2 id="synopsis-68">Synopsis</h2> 5337 <p><code>serve s3</code> implements a basic s3 server that serves a remote via s3. This can be viewed with an s3 client, or you can make an <a href="https://rclone.org/s3/">s3 type remote</a> to read and write to it with rclone.</p> 5338 <p><code>serve s3</code> is considered <strong>Experimental</strong> so use with care.</p> 5339 <p>S3 server supports Signature Version 4 authentication. Just use <code>--auth-key accessKey,secretKey</code> and set the <code>Authorization</code> header correctly in the request. (See the <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">AWS docs</a>).</p> 5340 <p><code>--auth-key</code> can be repeated for multiple auth pairs. If <code>--auth-key</code> is not provided then <code>serve s3</code> will allow anonymous access.</p> 5341 <p>Please note that some clients may require HTTPS endpoints. See <a href="#ssl-tls">the SSL docs</a> for more information.</p> 5342 <p>This command uses the <a href="#vfs-virtual-file-system">VFS directory cache</a>. All the functionality will work with <code>--vfs-cache-mode off</code>. Using <code>--vfs-cache-mode full</code> (or <code>writes</code>) can be used to cache objects locally to improve performance.</p> 5343 <p>Use <code>--force-path-style=false</code> if you want to use the bucket name as a part of the hostname (such as mybucket.local)</p> 5344 <p>Use <code>--etag-hash</code> if you want to change the hash uses for the <code>ETag</code>. Note that using anything other than <code>MD5</code> (the default) is likely to cause problems for S3 clients which rely on the Etag being the MD5.</p> 5345 <h2 id="quickstart-1">Quickstart</h2> 5346 <p>For a simple set up, to serve <code>remote:path</code> over s3, run the server like this:</p> 5347 <pre><code>rclone serve s3 --auth-key ACCESS_KEY_ID,SECRET_ACCESS_KEY remote:path</code></pre> 5348 <p>This will be compatible with an rclone remote which is defined like this:</p> 5349 <pre><code>[serves3] 5350 type = s3 5351 provider = Rclone 5352 endpoint = http://127.0.0.1:8080/ 5353 access_key_id = ACCESS_KEY_ID 5354 secret_access_key = SECRET_ACCESS_KEY 5355 use_multipart_uploads = false</code></pre> 5356 <p>Note that setting <code>disable_multipart_uploads = true</code> is to work around <a href="#bugs">a bug</a> which will be fixed in due course.</p> 5357 <h2 id="bugs">Bugs</h2> 5358 <p>When uploading multipart files <code>serve s3</code> holds all the parts in memory (see <a href="https://github.com/rclone/rclone/issues/7453">#7453</a>). This is a limitaton of the library rclone uses for serving S3 and will hopefully be fixed at some point.</p> 5359 <p>Multipart server side copies do not work (see <a href="https://github.com/rclone/rclone/issues/7454">#7454</a>). These take a very long time and eventually fail. The default threshold for multipart server side copies is 5G which is the maximum it can be, so files above this side will fail to be server side copied.</p> 5360 <p>For a current list of <code>serve s3</code> bugs see the <a href="https://github.com/rclone/rclone/labels/serve%20s3">serve s3</a> bug category on GitHub.</p> 5361 <h2 id="limitations-2">Limitations</h2> 5362 <p><code>serve s3</code> will treat all directories in the root as buckets and ignore all files in the root. You can use <code>CreateBucket</code> to create folders under the root, but you can't create empty folders under other folders not in the root.</p> 5363 <p>When using <code>PutObject</code> or <code>DeleteObject</code>, rclone will automatically create or clean up empty folders. If you don't want to clean up empty folders automatically, use <code>--no-cleanup</code>.</p> 5364 <p>When using <code>ListObjects</code>, rclone will use <code>/</code> when the delimiter is empty. This reduces backend requests with no effect on most operations, but if the delimiter is something other than <code>/</code> and empty, rclone will do a full recursive search of the backend, which can take some time.</p> 5365 <p>Versioning is not currently supported.</p> 5366 <p>Metadata will only be saved in memory other than the rclone <code>mtime</code> metadata which will be set as the modification time of the file.</p> 5367 <h2 id="supported-operations">Supported operations</h2> 5368 <p><code>serve s3</code> currently supports the following operations.</p> 5369 <ul> 5370 <li>Bucket 5371 <ul> 5372 <li><code>ListBuckets</code></li> 5373 <li><code>CreateBucket</code></li> 5374 <li><code>DeleteBucket</code></li> 5375 </ul></li> 5376 <li>Object 5377 <ul> 5378 <li><code>HeadObject</code></li> 5379 <li><code>ListObjects</code></li> 5380 <li><code>GetObject</code></li> 5381 <li><code>PutObject</code></li> 5382 <li><code>DeleteObject</code></li> 5383 <li><code>DeleteObjects</code></li> 5384 <li><code>CreateMultipartUpload</code></li> 5385 <li><code>CompleteMultipartUpload</code></li> 5386 <li><code>AbortMultipartUpload</code></li> 5387 <li><code>CopyObject</code></li> 5388 <li><code>UploadPart</code></li> 5389 </ul></li> 5390 </ul> 5391 <p>Other operations will return error <code>Unimplemented</code>.</p> 5392 <h2 id="server-options-5">Server options</h2> 5393 <p>Use <code>--addr</code> to specify which IP address and port the server should listen on, eg <code>--addr 1.2.3.4:8000</code> or <code>--addr :8080</code> 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> 5394 <p>If you set <code>--addr</code> to listen on a public or LAN accessible IP address then using Authentication is advised - see the next section for info.</p> 5395 <p>You can use a unix socket by setting the url to <code>unix:///path/to/socket</code> or just by using an absolute path name. Note that unix sockets bypass the authentication - this is expected to be done with file system permissions.</p> 5396 <p><code>--addr</code> may be repeated to listen on multiple IPs/ports/sockets.</p> 5397 <p><code>--server-read-timeout</code> and <code>--server-write-timeout</code> can be used to control the timeouts on the server. Note that this is the total time for a transfer.</p> 5398 <p><code>--max-header-bytes</code> controls the maximum number of bytes the server will accept in the HTTP header.</p> 5399 <p><code>--baseurl</code> controls the URL prefix that rclone serves from. By default rclone will serve from the root. If you used <code>--baseurl "/rclone"</code> then rclone would serve from a URL starting with "/rclone/". This is useful if you wish to proxy rclone serve. Rclone automatically inserts leading and trailing "/" on <code>--baseurl</code>, so <code>--baseurl "rclone"</code>, <code>--baseurl "/rclone"</code> and <code>--baseurl "/rclone/"</code> are all treated identically.</p> 5400 <h3 id="tls-ssl-3">TLS (SSL)</h3> 5401 <p>By default this will serve over http. If you want you can serve over https. You will need to supply the <code>--cert</code> and <code>--key</code> flags. If you wish to do client side certificate validation then you will need to supply <code>--client-ca</code> also.</p> 5402 <p><code>--cert</code> should be a either a PEM encoded certificate or a concatenation of that with the CA certificate. <code>--key</code> should be the PEM encoded private key and <code>--client-ca</code> should be the PEM encoded client certificate authority certificate.</p> 5403 <p>--min-tls-version is minimum TLS version that is acceptable. Valid values are "tls1.0", "tls1.1", "tls1.2" and "tls1.3" (default "tls1.0"). ## VFS - Virtual File System</p> 5404 <p>This command uses the VFS layer. This adapts the cloud storage objects that rclone uses into something which looks much more like a disk filing system.</p> 5405 <p>Cloud storage objects have lots of properties which aren't like disk files - you can't extend them or write to the middle of them, so the VFS layer has to deal with that. Because there is no one right way of doing this there are various options explained below.</p> 5406 <p>The VFS layer also implements a directory cache - this caches info about files and directories (but not the data) in memory.</p> 5407 <h2 id="vfs-directory-cache-7">VFS Directory Cache</h2> 5408 <p>Using the <code>--dir-cache-time</code> flag, you can control how long a directory should be considered up to date and not refreshed from the backend. Changes made through the VFS will appear immediately or invalidate the cache.</p> 5409 <pre><code>--dir-cache-time duration Time to cache directory entries for (default 5m0s) 5410 --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)</code></pre> 5411 <p>However, changes made directly on the cloud storage by the web interface or a different copy of rclone will only be picked up once the directory cache expires if the backend configured does not support polling for changes. If the backend supports polling, changes will be picked up within the polling interval.</p> 5412 <p>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> 5413 <pre><code>kill -SIGHUP $(pidof rclone)</code></pre> 5414 <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> 5415 <pre><code>rclone rc vfs/forget</code></pre> 5416 <p>Or individual files or directories:</p> 5417 <pre><code>rclone rc vfs/forget file=path/to/file dir=path/to/dir</code></pre> 5418 <h2 id="vfs-file-buffering-7">VFS File Buffering</h2> 5419 <p>The <code>--buffer-size</code> flag determines the amount of memory, that will be used to buffer data in advance.</p> 5420 <p>Each open file will try to keep the specified amount of data in memory at all times. The buffered data is bound to one open file and won't be shared.</p> 5421 <p>This flag is a upper limit for the used memory per open file. The buffer will only use memory for data that is downloaded but not not yet read. If the buffer is empty, only a small amount of memory will be used.</p> 5422 <p>The maximum memory used by rclone for buffering can be up to <code>--buffer-size * open files</code>.</p> 5423 <h2 id="vfs-file-caching-7">VFS File Caching</h2> 5424 <p>These flags control the VFS file caching options. File caching is necessary to make the VFS layer appear compatible with a normal file system. It can be disabled at the cost of some compatibility.</p> 5425 <p>For example you'll need to enable VFS caching if you want to read and write simultaneously to a file. See below for more details.</p> 5426 <p>Note that the VFS cache is separate from the cache backend and you may find that you need one or the other or both.</p> 5427 <pre><code>--cache-dir string Directory rclone will use for caching. 5428 --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) 5429 --vfs-cache-max-age duration Max time since last access of objects in the cache (default 1h0m0s) 5430 --vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off) 5431 --vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off) 5432 --vfs-cache-poll-interval duration Interval to poll the cache for stale objects (default 1m0s) 5433 --vfs-write-back duration Time to writeback files after last use when using cache (default 5s)</code></pre> 5434 <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> 5435 <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> 5436 <p>Note that files are written back to the remote only when they are closed and if they haven't been accessed for <code>--vfs-write-back</code> seconds. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags.</p> 5437 <p>If using <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-size</code> note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every <code>--vfs-cache-poll-interval</code>. Secondly because open files cannot be evicted from the cache. When <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-size</code> is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven't been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached.</p> 5438 <p>The <code>--vfs-cache-max-age</code> will evict files from the cache after the set time since last access has passed. The default value of 1 hour will start evicting files from cache that haven't been accessed for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0 and will wait for 1 more hour before evicting. Specify the time with standard notation, s, m, h, d, w .</p> 5439 <p>You <strong>should not</strong> run two copies of rclone using the same VFS cache with the same or overlapping remotes if using <code>--vfs-cache-mode > off</code>. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with <code>--cache-dir</code>. You don't need to worry about this if the remotes in use don't overlap.</p> 5440 <h3 id="vfs-cache-mode-off-7">--vfs-cache-mode off</h3> 5441 <p>In this mode (the default) the cache will read directly from the remote and write directly to the remote without caching anything on disk.</p> 5442 <p>This will mean some operations are not possible</p> 5443 <ul> 5444 <li>Files can't be opened for both read AND write</li> 5445 <li>Files opened for write can't be seeked</li> 5446 <li>Existing files opened for write must have O_TRUNC set</li> 5447 <li>Files open for read with O_TRUNC will be opened write only</li> 5448 <li>Files open for write only will behave as if O_TRUNC was supplied</li> 5449 <li>Open modes O_APPEND, O_TRUNC are ignored</li> 5450 <li>If an upload fails it can't be retried</li> 5451 </ul> 5452 <h3 id="vfs-cache-mode-minimal-7">--vfs-cache-mode minimal</h3> 5453 <p>This is very similar to "off" except that files opened for read AND write will be buffered to disk. This means that files opened for write will be a lot more compatible, but uses the minimal disk space.</p> 5454 <p>These operations are not possible</p> 5455 <ul> 5456 <li>Files opened for write only can't be seeked</li> 5457 <li>Existing files opened for write must have O_TRUNC set</li> 5458 <li>Files opened for write only will ignore O_APPEND, O_TRUNC</li> 5459 <li>If an upload fails it can't be retried</li> 5460 </ul> 5461 <h3 id="vfs-cache-mode-writes-7">--vfs-cache-mode writes</h3> 5462 <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> 5463 <p>This mode should support all normal file system operations.</p> 5464 <p>If an upload fails it will be retried at exponentially increasing intervals up to 1 minute.</p> 5465 <h3 id="vfs-cache-mode-full-7">--vfs-cache-mode full</h3> 5466 <p>In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well.</p> 5467 <p>In this mode the files in the cache will be sparse files and rclone will keep track of which bits of the files it has downloaded.</p> 5468 <p>So if an application only reads the starts of each file, then rclone will only buffer the start of the file. These files will appear to be their full size in the cache, but they will be sparse files with only the data that has been downloaded present in them.</p> 5469 <p>This mode should support all normal file system operations and is otherwise identical to <code>--vfs-cache-mode</code> writes.</p> 5470 <p>When reading a file rclone will read <code>--buffer-size</code> plus <code>--vfs-read-ahead</code> bytes ahead. The <code>--buffer-size</code> is buffered in memory whereas the <code>--vfs-read-ahead</code> is buffered on disk.</p> 5471 <p>When using this mode it is recommended that <code>--buffer-size</code> is not set too large and <code>--vfs-read-ahead</code> is set large if required.</p> 5472 <p><strong>IMPORTANT</strong> not all file systems support sparse files. In particular FAT/exFAT do not. Rclone will perform very badly if the cache directory is on a filesystem which doesn't support sparse files and it will log an ERROR message if one is detected.</p> 5473 <h3 id="fingerprinting-7">Fingerprinting</h3> 5474 <p>Various parts of the VFS use fingerprinting to see if a local file copy has changed relative to a remote file. Fingerprints are made from:</p> 5475 <ul> 5476 <li>size</li> 5477 <li>modification time</li> 5478 <li>hash</li> 5479 </ul> 5480 <p>where available on an object.</p> 5481 <p>On some backends some of these attributes are slow to read (they take an extra API call per object, or extra work per object).</p> 5482 <p>For example <code>hash</code> is slow with the <code>local</code> and <code>sftp</code> backends as they have to read the entire file and hash it, and <code>modtime</code> is slow with the <code>s3</code>, <code>swift</code>, <code>ftp</code> and <code>qinqstor</code> backends because they need to do an extra API call to fetch it.</p> 5483 <p>If you use the <code>--vfs-fast-fingerprint</code> flag then rclone will not include the slow operations in the fingerprint. This makes the fingerprinting less accurate but much faster and will improve the opening time of cached files.</p> 5484 <p>If you are running a vfs cache over <code>local</code>, <code>s3</code> or <code>swift</code> backends then using this flag is recommended.</p> 5485 <p>Note that if you change the value of this flag, the fingerprints of the files in the cache may be invalidated and the files will need to be downloaded again.</p> 5486 <h2 id="vfs-chunked-reading-7">VFS Chunked Reading</h2> 5487 <p>When rclone reads files from a remote it reads them in chunks. This means that rather than requesting the whole file rclone reads the chunk specified. This can reduce the used download quota for some remotes by requesting only chunks from the remote that are actually read, at the cost of an increased number of requests.</p> 5488 <p>These flags control the chunking:</p> 5489 <pre><code>--vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128M) 5490 --vfs-read-chunk-size-limit SizeSuffix Max chunk doubling size (default off)</code></pre> 5491 <p>Rclone will start reading a chunk of size <code>--vfs-read-chunk-size</code>, and then double the size for each read. When <code>--vfs-read-chunk-size-limit</code> is specified, and greater than <code>--vfs-read-chunk-size</code>, the chunk size for each open file will get doubled only until the specified value is reached. If the value is "off", which is the default, the limit is disabled and the chunk size will grow indefinitely.</p> 5492 <p>With <code>--vfs-read-chunk-size 100M</code> and <code>--vfs-read-chunk-size-limit 0</code> the following parts will be downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. When <code>--vfs-read-chunk-size-limit 500M</code> is specified, the result would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so on.</p> 5493 <p>Setting <code>--vfs-read-chunk-size</code> to <code>0</code> or "off" disables chunked reading.</p> 5494 <h2 id="vfs-performance-7">VFS Performance</h2> 5495 <p>These flags may be used to enable/disable features of the VFS for performance or other reasons. See also the <a href="#vfs-chunked-reading">chunked reading</a> feature.</p> 5496 <p>In particular S3 and Swift benefit hugely from the <code>--no-modtime</code> flag (or use <code>--use-server-modtime</code> for a slightly different effect) as each read of the modification time takes a transaction.</p> 5497 <pre><code>--no-checksum Don't compare checksums on up/download. 5498 --no-modtime Don't read/write the modification time (can speed things up). 5499 --no-seek Don't allow seeking in files. 5500 --read-only Only allow read-only access.</code></pre> 5501 <p>Sometimes rclone is delivered reads or writes out of order. Rather than seeking rclone will wait a short time for the in sequence read or write to come in. These flags only come into effect when not using an on disk cache file.</p> 5502 <pre><code>--vfs-read-wait duration Time to wait for in-sequence read before seeking (default 20ms) 5503 --vfs-write-wait duration Time to wait for in-sequence write before giving error (default 1s)</code></pre> 5504 <p>When using VFS write caching (<code>--vfs-cache-mode</code> with value writes or full), the global flag <code>--transfers</code> can be set to adjust the number of parallel uploads of modified files from the cache (the related global flag <code>--checkers</code> has no effect on the VFS).</p> 5505 <pre><code>--transfers int Number of file transfers to run in parallel (default 4)</code></pre> 5506 <h2 id="vfs-case-sensitivity-7">VFS Case Sensitivity</h2> 5507 <p>Linux file systems are case-sensitive: two files can differ only by case, and the exact case must be used when opening a file.</p> 5508 <p>File systems in modern Windows are case-insensitive but case-preserving: although existing files can be opened using any case, the exact case used to create the file is preserved and available for programs to query. It is not allowed for two files in the same directory to differ only by case.</p> 5509 <p>Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default.</p> 5510 <p>The <code>--vfs-case-insensitive</code> VFS flag controls how rclone handles these two cases. If its value is "false", rclone passes file names to the remote as-is. If the flag is "true" (or appears without a value on the command line), rclone may perform a "fixup" as explained below.</p> 5511 <p>The user may specify a file name to open/delete/rename/etc with a case different than what is stored on the remote. If an argument refers to an existing file with exactly the same name, then the case of the existing file on the disk will be used. However, if a file name with exactly the same name is not found but a name differing only by case exists, rclone will transparently fixup the name. This fixup happens only when an existing file is requested. Case sensitivity of file names created anew by rclone is controlled by the underlying remote.</p> 5512 <p>Note that case sensitivity of the operating system running rclone (the target) may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target.</p> 5513 <p>If the flag is not provided on the command line, then its default value depends on the operating system where rclone runs: "true" on Windows and macOS, "false" otherwise. If the flag is provided without a value, then it is "true".</p> 5514 <p>The <code>--no-unicode-normalization</code> flag controls whether a similar "fixup" is performed for filenames that differ but are <a href="https://en.wikipedia.org/wiki/Unicode_equivalence">canonically equivalent</a> with respect to unicode. Unicode normalization can be particularly helpful for users of macOS, which prefers form NFD instead of the NFC used by most other platforms. It is therefore highly recommended to keep the default of <code>false</code> on macOS, to avoid encoding compatibility issues.</p> 5515 <p>In the (probably unlikely) event that a directory has multiple duplicate filenames after applying case and unicode normalization, the <code>--vfs-block-norm-dupes</code> flag allows hiding these duplicates. This comes with a performance tradeoff, as rclone will have to scan the entire directory for duplicates when listing a directory. For this reason, it is recommended to leave this disabled if not needed. However, macOS users may wish to consider using it, as otherwise, if a remote directory contains both NFC and NFD versions of the same filename, an odd situation will occur: both versions of the file will be visible in the mount, and both will appear to be editable, however, editing either version will actually result in only the NFD version getting edited under the hood. <code>--vfs-block- norm-dupes</code> prevents this confusion by detecting this scenario, hiding the duplicates, and logging an error, similar to how this is handled in <code>rclone sync</code>.</p> 5516 <h2 id="vfs-disk-options-7">VFS Disk Options</h2> 5517 <p>This flag allows you to manually set the statistics about the filing system. It can be useful when those statistics cannot be read correctly automatically.</p> 5518 <pre><code>--vfs-disk-space-total-size Manually set the total disk space size (example: 256G, default: -1)</code></pre> 5519 <h2 id="alternate-report-of-used-bytes-7">Alternate report of used bytes</h2> 5520 <p>Some backends, most notably S3, do not report the amount of bytes used. If you need this information to be available when running <code>df</code> on the filesystem, then pass the flag <code>--vfs-used-is-size</code> to rclone. With this flag set, instead of relying on the backend to report this information, rclone will scan the whole remote similar to <code>rclone size</code> and compute the total used space itself.</p> 5521 <p><em>WARNING.</em> Contrary to <code>rclone size</code>, this flag ignores filters so that the result is accurate. However, this is very inefficient and may cost lots of API calls resulting in extra charges. Use it as a last resort and only with caching.</p> 5522 <pre><code>rclone serve s3 remote:path [flags]</code></pre> 5523 <h2 id="options-76">Options</h2> 5524 <pre><code> --addr stringArray IPaddress:Port or :Port to bind server to (default [127.0.0.1:8080]) 5525 --allow-origin string Origin which cross-domain request (CORS) can be executed from 5526 --auth-key stringArray Set key pair for v4 authorization: access_key_id,secret_access_key 5527 --baseurl string Prefix for URLs - leave blank for root 5528 --cert string TLS PEM key (concatenation of certificate and CA certificate) 5529 --client-ca string Client certificate authority to verify clients with 5530 --dir-cache-time Duration Time to cache directory entries for (default 5m0s) 5531 --dir-perms FileMode Directory permissions (default 0777) 5532 --etag-hash string Which hash to use for the ETag, or auto or blank for off (default "MD5") 5533 --file-perms FileMode File permissions (default 0666) 5534 --force-path-style If true use path style access if false use virtual hosted style (default true) (default true) 5535 --gid uint32 Override the gid field set by the filesystem (not supported on Windows) (default 1000) 5536 -h, --help help for s3 5537 --key string TLS PEM Private key 5538 --max-header-bytes int Maximum size of request header (default 4096) 5539 --min-tls-version string Minimum TLS version that is acceptable (default "tls1.0") 5540 --no-checksum Don't compare checksums on up/download 5541 --no-cleanup Not to cleanup empty folder after object is deleted 5542 --no-modtime Don't read/write the modification time (can speed things up) 5543 --no-seek Don't allow seeking in files 5544 --poll-interval Duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) 5545 --read-only Only allow read-only access 5546 --server-read-timeout Duration Timeout for server reading data (default 1h0m0s) 5547 --server-write-timeout Duration Timeout for server writing data (default 1h0m0s) 5548 --uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000) 5549 --umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2) 5550 --vfs-block-norm-dupes If duplicate filenames exist in the same directory (after normalization), log an error and hide the duplicates (may have a performance cost) 5551 --vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s) 5552 --vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off) 5553 --vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off) 5554 --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) 5555 --vfs-cache-poll-interval Duration Interval to poll the cache for stale objects (default 1m0s) 5556 --vfs-case-insensitive If a file name not found, find a case insensitive match 5557 --vfs-disk-space-total-size SizeSuffix Specify the total space of disk (default off) 5558 --vfs-fast-fingerprint Use fast (less accurate) fingerprints for change detection 5559 --vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full 5560 --vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128Mi) 5561 --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) 5562 --vfs-read-wait Duration Time to wait for in-sequence read before seeking (default 20ms) 5563 --vfs-refresh Refreshes the directory cache recursively in the background on start 5564 --vfs-used-is-size rclone size Use the rclone size algorithm for Used size 5565 --vfs-write-back Duration Time to writeback files after last use when using cache (default 5s) 5566 --vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s)</code></pre> 5567 <h2 id="filter-options-28">Filter Options</h2> 5568 <p>Flags for filtering directory listings.</p> 5569 <pre><code> --delete-excluded Delete files on dest excluded from sync 5570 --exclude stringArray Exclude files matching pattern 5571 --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) 5572 --exclude-if-present stringArray Exclude directories if filename is present 5573 --files-from stringArray Read list of source-file names from file (use - to read from stdin) 5574 --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) 5575 -f, --filter stringArray Add a file filtering rule 5576 --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) 5577 --ignore-case Ignore case in filters (case insensitive) 5578 --include stringArray Include files matching pattern 5579 --include-from stringArray Read file include patterns from file (use - to read from stdin) 5580 --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) 5581 --max-depth int If set limits the recursion depth to this (default -1) 5582 --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) 5583 --metadata-exclude stringArray Exclude metadatas matching pattern 5584 --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) 5585 --metadata-filter stringArray Add a metadata filtering rule 5586 --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) 5587 --metadata-include stringArray Include metadatas matching pattern 5588 --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) 5589 --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) 5590 --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre> 5591 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 5592 <h1 id="see-also-76">SEE ALSO</h1> 5593 <ul> 5594 <li><a href="https://rclone.org/commands/rclone_serve/">rclone serve</a> - Serve a remote over a protocol.</li> 5595 </ul> 5596 <h1 id="rclone-serve-sftp">rclone serve sftp</h1> 5597 <p>Serve the remote over SFTP.</p> 5598 <h2 id="synopsis-69">Synopsis</h2> 5599 <p>Run an SFTP server to serve a remote over SFTP. This can be used with an SFTP client or you can make a remote of type <a href="/sftp">sftp</a> to use with it.</p> 5600 <p>You can use the <a href="/filtering">filter</a> flags (e.g. <code>--include</code>, <code>--exclude</code>) to control what is served.</p> 5601 <p>The server will respond to a small number of shell commands, mainly md5sum, sha1sum and df, which enable it to provide support for checksums and the about feature when accessed from an sftp remote.</p> 5602 <p>Note that this server uses standard 32 KiB packet payload size, which means you must not configure the client to expect anything else, e.g. with the <a href="https://rclone.org/sftp/#sftp-chunk-size">chunk_size</a> option on an sftp remote.</p> 5603 <p>The server will log errors. Use <code>-v</code> to see access logs.</p> 5604 <p><code>--bwlimit</code> will be respected for file transfers. Use <code>--stats</code> to control the stats printing.</p> 5605 <p>You must provide some means of authentication, either with <code>--user</code>/<code>--pass</code>, an authorized keys file (specify location with <code>--authorized-keys</code> - the default is the same as ssh), an <code>--auth-proxy</code>, or set the <code>--no-auth</code> flag for no authentication when logging in.</p> 5606 <p>If you don't supply a host <code>--key</code> then rclone will generate rsa, ecdsa and ed25519 variants, and cache them for later use in rclone's cache directory (see <code>rclone help flags cache-dir</code>) in the "serve-sftp" directory.</p> 5607 <p>By default the server binds to localhost:2022 - if you want it to be reachable externally then supply <code>--addr :2022</code> for example.</p> 5608 <p>Note that the default of <code>--vfs-cache-mode off</code> is fine for the rclone sftp backend, but it may not be with other SFTP clients.</p> 5609 <p>If <code>--stdio</code> is specified, rclone will serve SFTP over stdio, which can be used with sshd via ~/.ssh/authorized_keys, for example:</p> 5610 <pre><code>restrict,command="rclone serve sftp --stdio ./photos" ssh-rsa ...</code></pre> 5611 <p>On the client you need to set <code>--transfers 1</code> when using <code>--stdio</code>. Otherwise multiple instances of the rclone server are started by OpenSSH which can lead to "corrupted on transfer" errors. This is the case because the client chooses indiscriminately which server to send commands to while the servers all have different views of the state of the filing system.</p> 5612 <p>The "restrict" in authorized_keys prevents SHA1SUMs and MD5SUMs from being used. Omitting "restrict" and using <code>--sftp-path-override</code> to enable checksumming is possible but less secure and you could use the SFTP server provided by OpenSSH in this case.</p> 5613 <h2 id="vfs---virtual-file-system-1">VFS - Virtual File System</h2> 5614 <p>This command uses the VFS layer. This adapts the cloud storage objects that rclone uses into something which looks much more like a disk filing system.</p> 5615 <p>Cloud storage objects have lots of properties which aren't like disk files - you can't extend them or write to the middle of them, so the VFS layer has to deal with that. Because there is no one right way of doing this there are various options explained below.</p> 5616 <p>The VFS layer also implements a directory cache - this caches info about files and directories (but not the data) in memory.</p> 5617 <h2 id="vfs-directory-cache-8">VFS Directory Cache</h2> 5618 <p>Using the <code>--dir-cache-time</code> flag, you can control how long a directory should be considered up to date and not refreshed from the backend. Changes made through the VFS will appear immediately or invalidate the cache.</p> 5619 <pre><code>--dir-cache-time duration Time to cache directory entries for (default 5m0s) 5620 --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)</code></pre> 5621 <p>However, changes made directly on the cloud storage by the web interface or a different copy of rclone will only be picked up once the directory cache expires if the backend configured does not support polling for changes. If the backend supports polling, changes will be picked up within the polling interval.</p> 5622 <p>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> 5623 <pre><code>kill -SIGHUP $(pidof rclone)</code></pre> 5624 <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> 5625 <pre><code>rclone rc vfs/forget</code></pre> 5626 <p>Or individual files or directories:</p> 5627 <pre><code>rclone rc vfs/forget file=path/to/file dir=path/to/dir</code></pre> 5628 <h2 id="vfs-file-buffering-8">VFS File Buffering</h2> 5629 <p>The <code>--buffer-size</code> flag determines the amount of memory, that will be used to buffer data in advance.</p> 5630 <p>Each open file will try to keep the specified amount of data in memory at all times. The buffered data is bound to one open file and won't be shared.</p> 5631 <p>This flag is a upper limit for the used memory per open file. The buffer will only use memory for data that is downloaded but not not yet read. If the buffer is empty, only a small amount of memory will be used.</p> 5632 <p>The maximum memory used by rclone for buffering can be up to <code>--buffer-size * open files</code>.</p> 5633 <h2 id="vfs-file-caching-8">VFS File Caching</h2> 5634 <p>These flags control the VFS file caching options. File caching is necessary to make the VFS layer appear compatible with a normal file system. It can be disabled at the cost of some compatibility.</p> 5635 <p>For example you'll need to enable VFS caching if you want to read and write simultaneously to a file. See below for more details.</p> 5636 <p>Note that the VFS cache is separate from the cache backend and you may find that you need one or the other or both.</p> 5637 <pre><code>--cache-dir string Directory rclone will use for caching. 5638 --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) 5639 --vfs-cache-max-age duration Max time since last access of objects in the cache (default 1h0m0s) 5640 --vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off) 5641 --vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off) 5642 --vfs-cache-poll-interval duration Interval to poll the cache for stale objects (default 1m0s) 5643 --vfs-write-back duration Time to writeback files after last use when using cache (default 5s)</code></pre> 5644 <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> 5645 <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> 5646 <p>Note that files are written back to the remote only when they are closed and if they haven't been accessed for <code>--vfs-write-back</code> seconds. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags.</p> 5647 <p>If using <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-size</code> note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every <code>--vfs-cache-poll-interval</code>. Secondly because open files cannot be evicted from the cache. When <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-size</code> is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven't been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached.</p> 5648 <p>The <code>--vfs-cache-max-age</code> will evict files from the cache after the set time since last access has passed. The default value of 1 hour will start evicting files from cache that haven't been accessed for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0 and will wait for 1 more hour before evicting. Specify the time with standard notation, s, m, h, d, w .</p> 5649 <p>You <strong>should not</strong> run two copies of rclone using the same VFS cache with the same or overlapping remotes if using <code>--vfs-cache-mode > off</code>. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with <code>--cache-dir</code>. You don't need to worry about this if the remotes in use don't overlap.</p> 5650 <h3 id="vfs-cache-mode-off-8">--vfs-cache-mode off</h3> 5651 <p>In this mode (the default) the cache will read directly from the remote and write directly to the remote without caching anything on disk.</p> 5652 <p>This will mean some operations are not possible</p> 5653 <ul> 5654 <li>Files can't be opened for both read AND write</li> 5655 <li>Files opened for write can't be seeked</li> 5656 <li>Existing files opened for write must have O_TRUNC set</li> 5657 <li>Files open for read with O_TRUNC will be opened write only</li> 5658 <li>Files open for write only will behave as if O_TRUNC was supplied</li> 5659 <li>Open modes O_APPEND, O_TRUNC are ignored</li> 5660 <li>If an upload fails it can't be retried</li> 5661 </ul> 5662 <h3 id="vfs-cache-mode-minimal-8">--vfs-cache-mode minimal</h3> 5663 <p>This is very similar to "off" except that files opened for read AND write will be buffered to disk. This means that files opened for write will be a lot more compatible, but uses the minimal disk space.</p> 5664 <p>These operations are not possible</p> 5665 <ul> 5666 <li>Files opened for write only can't be seeked</li> 5667 <li>Existing files opened for write must have O_TRUNC set</li> 5668 <li>Files opened for write only will ignore O_APPEND, O_TRUNC</li> 5669 <li>If an upload fails it can't be retried</li> 5670 </ul> 5671 <h3 id="vfs-cache-mode-writes-8">--vfs-cache-mode writes</h3> 5672 <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> 5673 <p>This mode should support all normal file system operations.</p> 5674 <p>If an upload fails it will be retried at exponentially increasing intervals up to 1 minute.</p> 5675 <h3 id="vfs-cache-mode-full-8">--vfs-cache-mode full</h3> 5676 <p>In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well.</p> 5677 <p>In this mode the files in the cache will be sparse files and rclone will keep track of which bits of the files it has downloaded.</p> 5678 <p>So if an application only reads the starts of each file, then rclone will only buffer the start of the file. These files will appear to be their full size in the cache, but they will be sparse files with only the data that has been downloaded present in them.</p> 5679 <p>This mode should support all normal file system operations and is otherwise identical to <code>--vfs-cache-mode</code> writes.</p> 5680 <p>When reading a file rclone will read <code>--buffer-size</code> plus <code>--vfs-read-ahead</code> bytes ahead. The <code>--buffer-size</code> is buffered in memory whereas the <code>--vfs-read-ahead</code> is buffered on disk.</p> 5681 <p>When using this mode it is recommended that <code>--buffer-size</code> is not set too large and <code>--vfs-read-ahead</code> is set large if required.</p> 5682 <p><strong>IMPORTANT</strong> not all file systems support sparse files. In particular FAT/exFAT do not. Rclone will perform very badly if the cache directory is on a filesystem which doesn't support sparse files and it will log an ERROR message if one is detected.</p> 5683 <h3 id="fingerprinting-8">Fingerprinting</h3> 5684 <p>Various parts of the VFS use fingerprinting to see if a local file copy has changed relative to a remote file. Fingerprints are made from:</p> 5685 <ul> 5686 <li>size</li> 5687 <li>modification time</li> 5688 <li>hash</li> 5689 </ul> 5690 <p>where available on an object.</p> 5691 <p>On some backends some of these attributes are slow to read (they take an extra API call per object, or extra work per object).</p> 5692 <p>For example <code>hash</code> is slow with the <code>local</code> and <code>sftp</code> backends as they have to read the entire file and hash it, and <code>modtime</code> is slow with the <code>s3</code>, <code>swift</code>, <code>ftp</code> and <code>qinqstor</code> backends because they need to do an extra API call to fetch it.</p> 5693 <p>If you use the <code>--vfs-fast-fingerprint</code> flag then rclone will not include the slow operations in the fingerprint. This makes the fingerprinting less accurate but much faster and will improve the opening time of cached files.</p> 5694 <p>If you are running a vfs cache over <code>local</code>, <code>s3</code> or <code>swift</code> backends then using this flag is recommended.</p> 5695 <p>Note that if you change the value of this flag, the fingerprints of the files in the cache may be invalidated and the files will need to be downloaded again.</p> 5696 <h2 id="vfs-chunked-reading-8">VFS Chunked Reading</h2> 5697 <p>When rclone reads files from a remote it reads them in chunks. This means that rather than requesting the whole file rclone reads the chunk specified. This can reduce the used download quota for some remotes by requesting only chunks from the remote that are actually read, at the cost of an increased number of requests.</p> 5698 <p>These flags control the chunking:</p> 5699 <pre><code>--vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128M) 5700 --vfs-read-chunk-size-limit SizeSuffix Max chunk doubling size (default off)</code></pre> 5701 <p>Rclone will start reading a chunk of size <code>--vfs-read-chunk-size</code>, and then double the size for each read. When <code>--vfs-read-chunk-size-limit</code> is specified, and greater than <code>--vfs-read-chunk-size</code>, the chunk size for each open file will get doubled only until the specified value is reached. If the value is "off", which is the default, the limit is disabled and the chunk size will grow indefinitely.</p> 5702 <p>With <code>--vfs-read-chunk-size 100M</code> and <code>--vfs-read-chunk-size-limit 0</code> the following parts will be downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. When <code>--vfs-read-chunk-size-limit 500M</code> is specified, the result would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so on.</p> 5703 <p>Setting <code>--vfs-read-chunk-size</code> to <code>0</code> or "off" disables chunked reading.</p> 5704 <h2 id="vfs-performance-8">VFS Performance</h2> 5705 <p>These flags may be used to enable/disable features of the VFS for performance or other reasons. See also the <a href="#vfs-chunked-reading">chunked reading</a> feature.</p> 5706 <p>In particular S3 and Swift benefit hugely from the <code>--no-modtime</code> flag (or use <code>--use-server-modtime</code> for a slightly different effect) as each read of the modification time takes a transaction.</p> 5707 <pre><code>--no-checksum Don't compare checksums on up/download. 5708 --no-modtime Don't read/write the modification time (can speed things up). 5709 --no-seek Don't allow seeking in files. 5710 --read-only Only allow read-only access.</code></pre> 5711 <p>Sometimes rclone is delivered reads or writes out of order. Rather than seeking rclone will wait a short time for the in sequence read or write to come in. These flags only come into effect when not using an on disk cache file.</p> 5712 <pre><code>--vfs-read-wait duration Time to wait for in-sequence read before seeking (default 20ms) 5713 --vfs-write-wait duration Time to wait for in-sequence write before giving error (default 1s)</code></pre> 5714 <p>When using VFS write caching (<code>--vfs-cache-mode</code> with value writes or full), the global flag <code>--transfers</code> can be set to adjust the number of parallel uploads of modified files from the cache (the related global flag <code>--checkers</code> has no effect on the VFS).</p> 5715 <pre><code>--transfers int Number of file transfers to run in parallel (default 4)</code></pre> 5716 <h2 id="vfs-case-sensitivity-8">VFS Case Sensitivity</h2> 5717 <p>Linux file systems are case-sensitive: two files can differ only by case, and the exact case must be used when opening a file.</p> 5718 <p>File systems in modern Windows are case-insensitive but case-preserving: although existing files can be opened using any case, the exact case used to create the file is preserved and available for programs to query. It is not allowed for two files in the same directory to differ only by case.</p> 5719 <p>Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default.</p> 5720 <p>The <code>--vfs-case-insensitive</code> VFS flag controls how rclone handles these two cases. If its value is "false", rclone passes file names to the remote as-is. If the flag is "true" (or appears without a value on the command line), rclone may perform a "fixup" as explained below.</p> 5721 <p>The user may specify a file name to open/delete/rename/etc with a case different than what is stored on the remote. If an argument refers to an existing file with exactly the same name, then the case of the existing file on the disk will be used. However, if a file name with exactly the same name is not found but a name differing only by case exists, rclone will transparently fixup the name. This fixup happens only when an existing file is requested. Case sensitivity of file names created anew by rclone is controlled by the underlying remote.</p> 5722 <p>Note that case sensitivity of the operating system running rclone (the target) may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target.</p> 5723 <p>If the flag is not provided on the command line, then its default value depends on the operating system where rclone runs: "true" on Windows and macOS, "false" otherwise. If the flag is provided without a value, then it is "true".</p> 5724 <p>The <code>--no-unicode-normalization</code> flag controls whether a similar "fixup" is performed for filenames that differ but are <a href="https://en.wikipedia.org/wiki/Unicode_equivalence">canonically equivalent</a> with respect to unicode. Unicode normalization can be particularly helpful for users of macOS, which prefers form NFD instead of the NFC used by most other platforms. It is therefore highly recommended to keep the default of <code>false</code> on macOS, to avoid encoding compatibility issues.</p> 5725 <p>In the (probably unlikely) event that a directory has multiple duplicate filenames after applying case and unicode normalization, the <code>--vfs-block-norm-dupes</code> flag allows hiding these duplicates. This comes with a performance tradeoff, as rclone will have to scan the entire directory for duplicates when listing a directory. For this reason, it is recommended to leave this disabled if not needed. However, macOS users may wish to consider using it, as otherwise, if a remote directory contains both NFC and NFD versions of the same filename, an odd situation will occur: both versions of the file will be visible in the mount, and both will appear to be editable, however, editing either version will actually result in only the NFD version getting edited under the hood. <code>--vfs-block- norm-dupes</code> prevents this confusion by detecting this scenario, hiding the duplicates, and logging an error, similar to how this is handled in <code>rclone sync</code>.</p> 5726 <h2 id="vfs-disk-options-8">VFS Disk Options</h2> 5727 <p>This flag allows you to manually set the statistics about the filing system. It can be useful when those statistics cannot be read correctly automatically.</p> 5728 <pre><code>--vfs-disk-space-total-size Manually set the total disk space size (example: 256G, default: -1)</code></pre> 5729 <h2 id="alternate-report-of-used-bytes-8">Alternate report of used bytes</h2> 5730 <p>Some backends, most notably S3, do not report the amount of bytes used. If you need this information to be available when running <code>df</code> on the filesystem, then pass the flag <code>--vfs-used-is-size</code> to rclone. With this flag set, instead of relying on the backend to report this information, rclone will scan the whole remote similar to <code>rclone size</code> and compute the total used space itself.</p> 5731 <p><em>WARNING.</em> Contrary to <code>rclone size</code>, this flag ignores filters so that the result is accurate. However, this is very inefficient and may cost lots of API calls resulting in extra charges. Use it as a last resort and only with caching.</p> 5732 <h2 id="auth-proxy-2">Auth Proxy</h2> 5733 <p>If you supply the parameter <code>--auth-proxy /path/to/program</code> then rclone will use that program to generate backends on the fly which then are used to authenticate incoming requests. This uses a simple JSON based protocol with input on STDIN and output on STDOUT.</p> 5734 <p><strong>PLEASE NOTE:</strong> <code>--auth-proxy</code> and <code>--authorized-keys</code> cannot be used together, if <code>--auth-proxy</code> is set the authorized keys option will be ignored.</p> 5735 <p>There is an example program <a href="https://github.com/rclone/rclone/blob/master/bin/test_proxy.py">bin/test_proxy.py</a> in the rclone source code.</p> 5736 <p>The program's job is to take a <code>user</code> and <code>pass</code> on the input and turn those into the config for a backend on STDOUT in JSON format. This config will have any default parameters for the backend added, but it won't use configuration from environment variables or command line options - it is the job of the proxy program to make a complete config.</p> 5737 <p>This config generated must have this extra parameter - <code>_root</code> - root to use for the backend</p> 5738 <p>And it may have this parameter - <code>_obscure</code> - comma separated strings for parameters to obscure</p> 5739 <p>If password authentication was used by the client, input to the proxy process (on STDIN) would look similar to this:</p> 5740 <pre><code>{ 5741 "user": "me", 5742 "pass": "mypassword" 5743 }</code></pre> 5744 <p>If public-key authentication was used by the client, input to the proxy process (on STDIN) would look similar to this:</p> 5745 <pre><code>{ 5746 "user": "me", 5747 "public_key": "AAAAB3NzaC1yc2EAAAADAQABAAABAQDuwESFdAe14hVS6omeyX7edc...JQdf" 5748 }</code></pre> 5749 <p>And as an example return this on STDOUT</p> 5750 <pre><code>{ 5751 "type": "sftp", 5752 "_root": "", 5753 "_obscure": "pass", 5754 "user": "me", 5755 "pass": "mypassword", 5756 "host": "sftp.example.com" 5757 }</code></pre> 5758 <p>This would mean that an SFTP backend would be created on the fly for the <code>user</code> and <code>pass</code>/<code>public_key</code> returned in the output to the host given. Note that since <code>_obscure</code> is set to <code>pass</code>, rclone will obscure the <code>pass</code> parameter before creating the backend (which is required for sftp backends).</p> 5759 <p>The program can manipulate the supplied <code>user</code> in any way, for example to make proxy to many different sftp backends, you could make the <code>user</code> be <code>user@example.com</code> and then set the <code>host</code> to <code>example.com</code> in the output and the user to <code>user</code>. For security you'd probably want to restrict the <code>host</code> to a limited list.</p> 5760 <p>Note that an internal cache is keyed on <code>user</code> so only use that for configuration, don't use <code>pass</code> or <code>public_key</code>. This also means that if a user's password or public-key is changed the cache will need to expire (which takes 5 mins) before it takes effect.</p> 5761 <p>This can be used to build general purpose proxies to any kind of backend that rclone supports.</p> 5762 <pre><code>rclone serve sftp remote:path [flags]</code></pre> 5763 <h2 id="options-77">Options</h2> 5764 <pre><code> --addr string IPaddress:Port or :Port to bind server to (default "localhost:2022") 5765 --auth-proxy string A program to use to create the backend from the auth 5766 --authorized-keys string Authorized keys file (default "~/.ssh/authorized_keys") 5767 --dir-cache-time Duration Time to cache directory entries for (default 5m0s) 5768 --dir-perms FileMode Directory permissions (default 0777) 5769 --file-perms FileMode File permissions (default 0666) 5770 --gid uint32 Override the gid field set by the filesystem (not supported on Windows) (default 1000) 5771 -h, --help help for sftp 5772 --key stringArray SSH private host key file (Can be multi-valued, leave blank to auto generate) 5773 --no-auth Allow connections with no authentication if set 5774 --no-checksum Don't compare checksums on up/download 5775 --no-modtime Don't read/write the modification time (can speed things up) 5776 --no-seek Don't allow seeking in files 5777 --pass string Password for authentication 5778 --poll-interval Duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) 5779 --read-only Only allow read-only access 5780 --stdio Run an sftp server on stdin/stdout 5781 --uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000) 5782 --umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2) 5783 --user string User name for authentication 5784 --vfs-block-norm-dupes If duplicate filenames exist in the same directory (after normalization), log an error and hide the duplicates (may have a performance cost) 5785 --vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s) 5786 --vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off) 5787 --vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off) 5788 --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) 5789 --vfs-cache-poll-interval Duration Interval to poll the cache for stale objects (default 1m0s) 5790 --vfs-case-insensitive If a file name not found, find a case insensitive match 5791 --vfs-disk-space-total-size SizeSuffix Specify the total space of disk (default off) 5792 --vfs-fast-fingerprint Use fast (less accurate) fingerprints for change detection 5793 --vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full 5794 --vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128Mi) 5795 --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) 5796 --vfs-read-wait Duration Time to wait for in-sequence read before seeking (default 20ms) 5797 --vfs-refresh Refreshes the directory cache recursively in the background on start 5798 --vfs-used-is-size rclone size Use the rclone size algorithm for Used size 5799 --vfs-write-back Duration Time to writeback files after last use when using cache (default 5s) 5800 --vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s)</code></pre> 5801 <h2 id="filter-options-29">Filter Options</h2> 5802 <p>Flags for filtering directory listings.</p> 5803 <pre><code> --delete-excluded Delete files on dest excluded from sync 5804 --exclude stringArray Exclude files matching pattern 5805 --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) 5806 --exclude-if-present stringArray Exclude directories if filename is present 5807 --files-from stringArray Read list of source-file names from file (use - to read from stdin) 5808 --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) 5809 -f, --filter stringArray Add a file filtering rule 5810 --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) 5811 --ignore-case Ignore case in filters (case insensitive) 5812 --include stringArray Include files matching pattern 5813 --include-from stringArray Read file include patterns from file (use - to read from stdin) 5814 --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) 5815 --max-depth int If set limits the recursion depth to this (default -1) 5816 --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) 5817 --metadata-exclude stringArray Exclude metadatas matching pattern 5818 --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) 5819 --metadata-filter stringArray Add a metadata filtering rule 5820 --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) 5821 --metadata-include stringArray Include metadatas matching pattern 5822 --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) 5823 --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) 5824 --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre> 5825 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 5826 <h1 id="see-also-77">SEE ALSO</h1> 5827 <ul> 5828 <li><a href="https://rclone.org/commands/rclone_serve/">rclone serve</a> - Serve a remote over a protocol.</li> 5829 </ul> 5830 <h1 id="rclone-serve-webdav">rclone serve webdav</h1> 5831 <p>Serve remote:path over WebDAV.</p> 5832 <h2 id="synopsis-70">Synopsis</h2> 5833 <p>Run a basic WebDAV server to serve a remote over HTTP via the WebDAV protocol. This can be viewed with a WebDAV client, through a web browser, or you can make a remote of type WebDAV to read and write it.</p> 5834 <h2 id="webdav-options">WebDAV options</h2> 5835 <h3 id="etag-hash">--etag-hash</h3> 5836 <p>This controls the ETag header. Without this flag the ETag will be based on the ModTime and Size of the object.</p> 5837 <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". Use the <a href="https://rclone.org/commands/rclone_hashsum/">hashsum</a> command to see the full list.</p> 5838 <h2 id="access-webdav-on-windows">Access WebDAV on Windows</h2> 5839 <p>WebDAV shared folder can be mapped as a drive on Windows, however the default settings prevent it. Windows will fail to connect to the server using insecure Basic authentication. It will not even display any login dialog. Windows requires SSL / HTTPS connection to be used with Basic. If you try to connect via Add Network Location Wizard you will get the following error: "The folder you entered does not appear to be valid. Please choose another". However, you still can connect if you set the following registry key on a client machine: HKEY_LOCAL_MACHINEto 2. The BasicAuthLevel can be set to the following values: 0 - Basic authentication disabled 1 - Basic authentication enabled for SSL connections only 2 - Basic authentication enabled for SSL connections and for non-SSL connections If required, increase the FileSizeLimitInBytes to a higher value. Navigate to the Services interface, then restart the WebClient service.</p> 5840 <h2 id="access-office-applications-on-webdav">Access Office applications on WebDAV</h2> 5841 <p>Navigate to following registry HKEY_CURRENT_USER[14.0/15.0/16.0] Create a new DWORD BasicAuthLevel with value 2. 0 - Basic authentication disabled 1 - Basic authentication enabled for SSL connections only 2 - Basic authentication enabled for SSL and for non-SSL connections</p> 5842 <p>https://learn.microsoft.com/en-us/office/troubleshoot/powerpoint/office-opens-blank-from-sharepoint</p> 5843 <h2 id="server-options-6">Server options</h2> 5844 <p>Use <code>--addr</code> to specify which IP address and port the server should listen on, eg <code>--addr 1.2.3.4:8000</code> or <code>--addr :8080</code> 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> 5845 <p>If you set <code>--addr</code> to listen on a public or LAN accessible IP address then using Authentication is advised - see the next section for info.</p> 5846 <p>You can use a unix socket by setting the url to <code>unix:///path/to/socket</code> or just by using an absolute path name. Note that unix sockets bypass the authentication - this is expected to be done with file system permissions.</p> 5847 <p><code>--addr</code> may be repeated to listen on multiple IPs/ports/sockets.</p> 5848 <p><code>--server-read-timeout</code> and <code>--server-write-timeout</code> can be used to control the timeouts on the server. Note that this is the total time for a transfer.</p> 5849 <p><code>--max-header-bytes</code> controls the maximum number of bytes the server will accept in the HTTP header.</p> 5850 <p><code>--baseurl</code> controls the URL prefix that rclone serves from. By default rclone will serve from the root. If you used <code>--baseurl "/rclone"</code> then rclone would serve from a URL starting with "/rclone/". This is useful if you wish to proxy rclone serve. Rclone automatically inserts leading and trailing "/" on <code>--baseurl</code>, so <code>--baseurl "rclone"</code>, <code>--baseurl "/rclone"</code> and <code>--baseurl "/rclone/"</code> are all treated identically.</p> 5851 <h3 id="tls-ssl-4">TLS (SSL)</h3> 5852 <p>By default this will serve over http. If you want you can serve over https. You will need to supply the <code>--cert</code> and <code>--key</code> flags. If you wish to do client side certificate validation then you will need to supply <code>--client-ca</code> also.</p> 5853 <p><code>--cert</code> should be a either a PEM encoded certificate or a concatenation of that with the CA certificate. <code>--key</code> should be the PEM encoded private key and <code>--client-ca</code> should be the PEM encoded client certificate authority certificate.</p> 5854 <p>--min-tls-version is minimum TLS version that is acceptable. Valid values are "tls1.0", "tls1.1", "tls1.2" and "tls1.3" (default "tls1.0").</p> 5855 <h3 id="template-2">Template</h3> 5856 <p><code>--template</code> allows a user to specify a custom markup template for HTTP and WebDAV serve functions. The server exports the following markup to be used within the template to server pages:</p> 5857 <table> 5858 <colgroup> 5859 <col style="width: 50%" /> 5860 <col style="width: 50%" /> 5861 </colgroup> 5862 <thead> 5863 <tr class="header"> 5864 <th style="text-align: left;">Parameter</th> 5865 <th style="text-align: left;">Description</th> 5866 </tr> 5867 </thead> 5868 <tbody> 5869 <tr class="odd"> 5870 <td style="text-align: left;">.Name</td> 5871 <td style="text-align: left;">The full path of a file/directory.</td> 5872 </tr> 5873 <tr class="even"> 5874 <td style="text-align: left;">.Title</td> 5875 <td style="text-align: left;">Directory listing of .Name</td> 5876 </tr> 5877 <tr class="odd"> 5878 <td style="text-align: left;">.Sort</td> 5879 <td style="text-align: left;">The current sort used. This is changeable via ?sort= parameter</td> 5880 </tr> 5881 <tr class="even"> 5882 <td style="text-align: left;"></td> 5883 <td style="text-align: left;">Sort Options: namedirfirst,name,size,time (default namedirfirst)</td> 5884 </tr> 5885 <tr class="odd"> 5886 <td style="text-align: left;">.Order</td> 5887 <td style="text-align: left;">The current ordering used. This is changeable via ?order= parameter</td> 5888 </tr> 5889 <tr class="even"> 5890 <td style="text-align: left;"></td> 5891 <td style="text-align: left;">Order Options: asc,desc (default asc)</td> 5892 </tr> 5893 <tr class="odd"> 5894 <td style="text-align: left;">.Query</td> 5895 <td style="text-align: left;">Currently unused.</td> 5896 </tr> 5897 <tr class="even"> 5898 <td style="text-align: left;">.Breadcrumb</td> 5899 <td style="text-align: left;">Allows for creating a relative navigation</td> 5900 </tr> 5901 <tr class="odd"> 5902 <td style="text-align: left;">-- .Link</td> 5903 <td style="text-align: left;">The relative to the root link of the Text.</td> 5904 </tr> 5905 <tr class="even"> 5906 <td style="text-align: left;">-- .Text</td> 5907 <td style="text-align: left;">The Name of the directory.</td> 5908 </tr> 5909 <tr class="odd"> 5910 <td style="text-align: left;">.Entries</td> 5911 <td style="text-align: left;">Information about a specific file/directory.</td> 5912 </tr> 5913 <tr class="even"> 5914 <td style="text-align: left;">-- .URL</td> 5915 <td style="text-align: left;">The 'url' of an entry.</td> 5916 </tr> 5917 <tr class="odd"> 5918 <td style="text-align: left;">-- .Leaf</td> 5919 <td style="text-align: left;">Currently same as 'URL' but intended to be 'just' the name.</td> 5920 </tr> 5921 <tr class="even"> 5922 <td style="text-align: left;">-- .IsDir</td> 5923 <td style="text-align: left;">Boolean for if an entry is a directory or not.</td> 5924 </tr> 5925 <tr class="odd"> 5926 <td style="text-align: left;">-- .Size</td> 5927 <td style="text-align: left;">Size in Bytes of the entry.</td> 5928 </tr> 5929 <tr class="even"> 5930 <td style="text-align: left;">-- .ModTime</td> 5931 <td style="text-align: left;">The UTC timestamp of an entry.</td> 5932 </tr> 5933 </tbody> 5934 </table> 5935 <p>The server also makes the following functions available so that they can be used within the template. These functions help extend the options for dynamic rendering of HTML. They can be used to render HTML based on specific conditions.</p> 5936 <table> 5937 <colgroup> 5938 <col style="width: 50%" /> 5939 <col style="width: 50%" /> 5940 </colgroup> 5941 <thead> 5942 <tr class="header"> 5943 <th style="text-align: left;">Function</th> 5944 <th style="text-align: left;">Description</th> 5945 </tr> 5946 </thead> 5947 <tbody> 5948 <tr class="odd"> 5949 <td style="text-align: left;">afterEpoch</td> 5950 <td style="text-align: left;">Returns the time since the epoch for the given time.</td> 5951 </tr> 5952 <tr class="even"> 5953 <td style="text-align: left;">contains</td> 5954 <td style="text-align: left;">Checks whether a given substring is present or not in a given string.</td> 5955 </tr> 5956 <tr class="odd"> 5957 <td style="text-align: left;">hasPrefix</td> 5958 <td style="text-align: left;">Checks whether the given string begins with the specified prefix.</td> 5959 </tr> 5960 <tr class="even"> 5961 <td style="text-align: left;">hasSuffix</td> 5962 <td style="text-align: left;">Checks whether the given string end with the specified suffix.</td> 5963 </tr> 5964 </tbody> 5965 </table> 5966 <h3 id="authentication-4">Authentication</h3> 5967 <p>By default this will serve files without needing a login.</p> 5968 <p>You can either use an htpasswd file which can take lots of users, or set a single username and password with the <code>--user</code> and <code>--pass</code> flags.</p> 5969 <p>If no static users are configured by either of the above methods, and client certificates are required by the <code>--client-ca</code> flag passed to the server, the client certificate common name will be considered as the username.</p> 5970 <p>Use <code>--htpasswd /path/to/htpasswd</code> to provide an htpasswd file. This is in standard apache format and supports MD5, SHA1 and BCrypt for basic authentication. Bcrypt is recommended.</p> 5971 <p>To create an htpasswd file:</p> 5972 <pre><code>touch htpasswd 5973 htpasswd -B htpasswd user 5974 htpasswd -B htpasswd anotherUser</code></pre> 5975 <p>The password file can be updated while rclone is running.</p> 5976 <p>Use <code>--realm</code> to set the authentication realm.</p> 5977 <p>Use <code>--salt</code> to change the password hashing salt from the default. ## VFS - Virtual File System</p> 5978 <p>This command uses the VFS layer. This adapts the cloud storage objects that rclone uses into something which looks much more like a disk filing system.</p> 5979 <p>Cloud storage objects have lots of properties which aren't like disk files - you can't extend them or write to the middle of them, so the VFS layer has to deal with that. Because there is no one right way of doing this there are various options explained below.</p> 5980 <p>The VFS layer also implements a directory cache - this caches info about files and directories (but not the data) in memory.</p> 5981 <h2 id="vfs-directory-cache-9">VFS Directory Cache</h2> 5982 <p>Using the <code>--dir-cache-time</code> flag, you can control how long a directory should be considered up to date and not refreshed from the backend. Changes made through the VFS will appear immediately or invalidate the cache.</p> 5983 <pre><code>--dir-cache-time duration Time to cache directory entries for (default 5m0s) 5984 --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)</code></pre> 5985 <p>However, changes made directly on the cloud storage by the web interface or a different copy of rclone will only be picked up once the directory cache expires if the backend configured does not support polling for changes. If the backend supports polling, changes will be picked up within the polling interval.</p> 5986 <p>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> 5987 <pre><code>kill -SIGHUP $(pidof rclone)</code></pre> 5988 <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> 5989 <pre><code>rclone rc vfs/forget</code></pre> 5990 <p>Or individual files or directories:</p> 5991 <pre><code>rclone rc vfs/forget file=path/to/file dir=path/to/dir</code></pre> 5992 <h2 id="vfs-file-buffering-9">VFS File Buffering</h2> 5993 <p>The <code>--buffer-size</code> flag determines the amount of memory, that will be used to buffer data in advance.</p> 5994 <p>Each open file will try to keep the specified amount of data in memory at all times. The buffered data is bound to one open file and won't be shared.</p> 5995 <p>This flag is a upper limit for the used memory per open file. The buffer will only use memory for data that is downloaded but not not yet read. If the buffer is empty, only a small amount of memory will be used.</p> 5996 <p>The maximum memory used by rclone for buffering can be up to <code>--buffer-size * open files</code>.</p> 5997 <h2 id="vfs-file-caching-9">VFS File Caching</h2> 5998 <p>These flags control the VFS file caching options. File caching is necessary to make the VFS layer appear compatible with a normal file system. It can be disabled at the cost of some compatibility.</p> 5999 <p>For example you'll need to enable VFS caching if you want to read and write simultaneously to a file. See below for more details.</p> 6000 <p>Note that the VFS cache is separate from the cache backend and you may find that you need one or the other or both.</p> 6001 <pre><code>--cache-dir string Directory rclone will use for caching. 6002 --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) 6003 --vfs-cache-max-age duration Max time since last access of objects in the cache (default 1h0m0s) 6004 --vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off) 6005 --vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off) 6006 --vfs-cache-poll-interval duration Interval to poll the cache for stale objects (default 1m0s) 6007 --vfs-write-back duration Time to writeback files after last use when using cache (default 5s)</code></pre> 6008 <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> 6009 <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> 6010 <p>Note that files are written back to the remote only when they are closed and if they haven't been accessed for <code>--vfs-write-back</code> seconds. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags.</p> 6011 <p>If using <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-size</code> note that the cache may exceed these quotas for two reasons. Firstly because it is only checked every <code>--vfs-cache-poll-interval</code>. Secondly because open files cannot be evicted from the cache. When <code>--vfs-cache-max-size</code> or <code>--vfs-cache-min-free-size</code> is exceeded, rclone will attempt to evict the least accessed files from the cache first. rclone will start with files that haven't been accessed for the longest. This cache flushing strategy is efficient and more relevant files are likely to remain cached.</p> 6012 <p>The <code>--vfs-cache-max-age</code> will evict files from the cache after the set time since last access has passed. The default value of 1 hour will start evicting files from cache that haven't been accessed for 1 hour. When a cached file is accessed the 1 hour timer is reset to 0 and will wait for 1 more hour before evicting. Specify the time with standard notation, s, m, h, d, w .</p> 6013 <p>You <strong>should not</strong> run two copies of rclone using the same VFS cache with the same or overlapping remotes if using <code>--vfs-cache-mode > off</code>. This can potentially cause data corruption if you do. You can work around this by giving each rclone its own cache hierarchy with <code>--cache-dir</code>. You don't need to worry about this if the remotes in use don't overlap.</p> 6014 <h3 id="vfs-cache-mode-off-9">--vfs-cache-mode off</h3> 6015 <p>In this mode (the default) the cache will read directly from the remote and write directly to the remote without caching anything on disk.</p> 6016 <p>This will mean some operations are not possible</p> 6017 <ul> 6018 <li>Files can't be opened for both read AND write</li> 6019 <li>Files opened for write can't be seeked</li> 6020 <li>Existing files opened for write must have O_TRUNC set</li> 6021 <li>Files open for read with O_TRUNC will be opened write only</li> 6022 <li>Files open for write only will behave as if O_TRUNC was supplied</li> 6023 <li>Open modes O_APPEND, O_TRUNC are ignored</li> 6024 <li>If an upload fails it can't be retried</li> 6025 </ul> 6026 <h3 id="vfs-cache-mode-minimal-9">--vfs-cache-mode minimal</h3> 6027 <p>This is very similar to "off" except that files opened for read AND write will be buffered to disk. This means that files opened for write will be a lot more compatible, but uses the minimal disk space.</p> 6028 <p>These operations are not possible</p> 6029 <ul> 6030 <li>Files opened for write only can't be seeked</li> 6031 <li>Existing files opened for write must have O_TRUNC set</li> 6032 <li>Files opened for write only will ignore O_APPEND, O_TRUNC</li> 6033 <li>If an upload fails it can't be retried</li> 6034 </ul> 6035 <h3 id="vfs-cache-mode-writes-9">--vfs-cache-mode writes</h3> 6036 <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> 6037 <p>This mode should support all normal file system operations.</p> 6038 <p>If an upload fails it will be retried at exponentially increasing intervals up to 1 minute.</p> 6039 <h3 id="vfs-cache-mode-full-9">--vfs-cache-mode full</h3> 6040 <p>In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well.</p> 6041 <p>In this mode the files in the cache will be sparse files and rclone will keep track of which bits of the files it has downloaded.</p> 6042 <p>So if an application only reads the starts of each file, then rclone will only buffer the start of the file. These files will appear to be their full size in the cache, but they will be sparse files with only the data that has been downloaded present in them.</p> 6043 <p>This mode should support all normal file system operations and is otherwise identical to <code>--vfs-cache-mode</code> writes.</p> 6044 <p>When reading a file rclone will read <code>--buffer-size</code> plus <code>--vfs-read-ahead</code> bytes ahead. The <code>--buffer-size</code> is buffered in memory whereas the <code>--vfs-read-ahead</code> is buffered on disk.</p> 6045 <p>When using this mode it is recommended that <code>--buffer-size</code> is not set too large and <code>--vfs-read-ahead</code> is set large if required.</p> 6046 <p><strong>IMPORTANT</strong> not all file systems support sparse files. In particular FAT/exFAT do not. Rclone will perform very badly if the cache directory is on a filesystem which doesn't support sparse files and it will log an ERROR message if one is detected.</p> 6047 <h3 id="fingerprinting-9">Fingerprinting</h3> 6048 <p>Various parts of the VFS use fingerprinting to see if a local file copy has changed relative to a remote file. Fingerprints are made from:</p> 6049 <ul> 6050 <li>size</li> 6051 <li>modification time</li> 6052 <li>hash</li> 6053 </ul> 6054 <p>where available on an object.</p> 6055 <p>On some backends some of these attributes are slow to read (they take an extra API call per object, or extra work per object).</p> 6056 <p>For example <code>hash</code> is slow with the <code>local</code> and <code>sftp</code> backends as they have to read the entire file and hash it, and <code>modtime</code> is slow with the <code>s3</code>, <code>swift</code>, <code>ftp</code> and <code>qinqstor</code> backends because they need to do an extra API call to fetch it.</p> 6057 <p>If you use the <code>--vfs-fast-fingerprint</code> flag then rclone will not include the slow operations in the fingerprint. This makes the fingerprinting less accurate but much faster and will improve the opening time of cached files.</p> 6058 <p>If you are running a vfs cache over <code>local</code>, <code>s3</code> or <code>swift</code> backends then using this flag is recommended.</p> 6059 <p>Note that if you change the value of this flag, the fingerprints of the files in the cache may be invalidated and the files will need to be downloaded again.</p> 6060 <h2 id="vfs-chunked-reading-9">VFS Chunked Reading</h2> 6061 <p>When rclone reads files from a remote it reads them in chunks. This means that rather than requesting the whole file rclone reads the chunk specified. This can reduce the used download quota for some remotes by requesting only chunks from the remote that are actually read, at the cost of an increased number of requests.</p> 6062 <p>These flags control the chunking:</p> 6063 <pre><code>--vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128M) 6064 --vfs-read-chunk-size-limit SizeSuffix Max chunk doubling size (default off)</code></pre> 6065 <p>Rclone will start reading a chunk of size <code>--vfs-read-chunk-size</code>, and then double the size for each read. When <code>--vfs-read-chunk-size-limit</code> is specified, and greater than <code>--vfs-read-chunk-size</code>, the chunk size for each open file will get doubled only until the specified value is reached. If the value is "off", which is the default, the limit is disabled and the chunk size will grow indefinitely.</p> 6066 <p>With <code>--vfs-read-chunk-size 100M</code> and <code>--vfs-read-chunk-size-limit 0</code> the following parts will be downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. When <code>--vfs-read-chunk-size-limit 500M</code> is specified, the result would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so on.</p> 6067 <p>Setting <code>--vfs-read-chunk-size</code> to <code>0</code> or "off" disables chunked reading.</p> 6068 <h2 id="vfs-performance-9">VFS Performance</h2> 6069 <p>These flags may be used to enable/disable features of the VFS for performance or other reasons. See also the <a href="#vfs-chunked-reading">chunked reading</a> feature.</p> 6070 <p>In particular S3 and Swift benefit hugely from the <code>--no-modtime</code> flag (or use <code>--use-server-modtime</code> for a slightly different effect) as each read of the modification time takes a transaction.</p> 6071 <pre><code>--no-checksum Don't compare checksums on up/download. 6072 --no-modtime Don't read/write the modification time (can speed things up). 6073 --no-seek Don't allow seeking in files. 6074 --read-only Only allow read-only access.</code></pre> 6075 <p>Sometimes rclone is delivered reads or writes out of order. Rather than seeking rclone will wait a short time for the in sequence read or write to come in. These flags only come into effect when not using an on disk cache file.</p> 6076 <pre><code>--vfs-read-wait duration Time to wait for in-sequence read before seeking (default 20ms) 6077 --vfs-write-wait duration Time to wait for in-sequence write before giving error (default 1s)</code></pre> 6078 <p>When using VFS write caching (<code>--vfs-cache-mode</code> with value writes or full), the global flag <code>--transfers</code> can be set to adjust the number of parallel uploads of modified files from the cache (the related global flag <code>--checkers</code> has no effect on the VFS).</p> 6079 <pre><code>--transfers int Number of file transfers to run in parallel (default 4)</code></pre> 6080 <h2 id="vfs-case-sensitivity-9">VFS Case Sensitivity</h2> 6081 <p>Linux file systems are case-sensitive: two files can differ only by case, and the exact case must be used when opening a file.</p> 6082 <p>File systems in modern Windows are case-insensitive but case-preserving: although existing files can be opened using any case, the exact case used to create the file is preserved and available for programs to query. It is not allowed for two files in the same directory to differ only by case.</p> 6083 <p>Usually file systems on macOS are case-insensitive. It is possible to make macOS file systems case-sensitive but that is not the default.</p> 6084 <p>The <code>--vfs-case-insensitive</code> VFS flag controls how rclone handles these two cases. If its value is "false", rclone passes file names to the remote as-is. If the flag is "true" (or appears without a value on the command line), rclone may perform a "fixup" as explained below.</p> 6085 <p>The user may specify a file name to open/delete/rename/etc with a case different than what is stored on the remote. If an argument refers to an existing file with exactly the same name, then the case of the existing file on the disk will be used. However, if a file name with exactly the same name is not found but a name differing only by case exists, rclone will transparently fixup the name. This fixup happens only when an existing file is requested. Case sensitivity of file names created anew by rclone is controlled by the underlying remote.</p> 6086 <p>Note that case sensitivity of the operating system running rclone (the target) may differ from case sensitivity of a file system presented by rclone (the source). The flag controls whether "fixup" is performed to satisfy the target.</p> 6087 <p>If the flag is not provided on the command line, then its default value depends on the operating system where rclone runs: "true" on Windows and macOS, "false" otherwise. If the flag is provided without a value, then it is "true".</p> 6088 <p>The <code>--no-unicode-normalization</code> flag controls whether a similar "fixup" is performed for filenames that differ but are <a href="https://en.wikipedia.org/wiki/Unicode_equivalence">canonically equivalent</a> with respect to unicode. Unicode normalization can be particularly helpful for users of macOS, which prefers form NFD instead of the NFC used by most other platforms. It is therefore highly recommended to keep the default of <code>false</code> on macOS, to avoid encoding compatibility issues.</p> 6089 <p>In the (probably unlikely) event that a directory has multiple duplicate filenames after applying case and unicode normalization, the <code>--vfs-block-norm-dupes</code> flag allows hiding these duplicates. This comes with a performance tradeoff, as rclone will have to scan the entire directory for duplicates when listing a directory. For this reason, it is recommended to leave this disabled if not needed. However, macOS users may wish to consider using it, as otherwise, if a remote directory contains both NFC and NFD versions of the same filename, an odd situation will occur: both versions of the file will be visible in the mount, and both will appear to be editable, however, editing either version will actually result in only the NFD version getting edited under the hood. <code>--vfs-block- norm-dupes</code> prevents this confusion by detecting this scenario, hiding the duplicates, and logging an error, similar to how this is handled in <code>rclone sync</code>.</p> 6090 <h2 id="vfs-disk-options-9">VFS Disk Options</h2> 6091 <p>This flag allows you to manually set the statistics about the filing system. It can be useful when those statistics cannot be read correctly automatically.</p> 6092 <pre><code>--vfs-disk-space-total-size Manually set the total disk space size (example: 256G, default: -1)</code></pre> 6093 <h2 id="alternate-report-of-used-bytes-9">Alternate report of used bytes</h2> 6094 <p>Some backends, most notably S3, do not report the amount of bytes used. If you need this information to be available when running <code>df</code> on the filesystem, then pass the flag <code>--vfs-used-is-size</code> to rclone. With this flag set, instead of relying on the backend to report this information, rclone will scan the whole remote similar to <code>rclone size</code> and compute the total used space itself.</p> 6095 <p><em>WARNING.</em> Contrary to <code>rclone size</code>, this flag ignores filters so that the result is accurate. However, this is very inefficient and may cost lots of API calls resulting in extra charges. Use it as a last resort and only with caching.</p> 6096 <h2 id="auth-proxy-3">Auth Proxy</h2> 6097 <p>If you supply the parameter <code>--auth-proxy /path/to/program</code> then rclone will use that program to generate backends on the fly which then are used to authenticate incoming requests. This uses a simple JSON based protocol with input on STDIN and output on STDOUT.</p> 6098 <p><strong>PLEASE NOTE:</strong> <code>--auth-proxy</code> and <code>--authorized-keys</code> cannot be used together, if <code>--auth-proxy</code> is set the authorized keys option will be ignored.</p> 6099 <p>There is an example program <a href="https://github.com/rclone/rclone/blob/master/bin/test_proxy.py">bin/test_proxy.py</a> in the rclone source code.</p> 6100 <p>The program's job is to take a <code>user</code> and <code>pass</code> on the input and turn those into the config for a backend on STDOUT in JSON format. This config will have any default parameters for the backend added, but it won't use configuration from environment variables or command line options - it is the job of the proxy program to make a complete config.</p> 6101 <p>This config generated must have this extra parameter - <code>_root</code> - root to use for the backend</p> 6102 <p>And it may have this parameter - <code>_obscure</code> - comma separated strings for parameters to obscure</p> 6103 <p>If password authentication was used by the client, input to the proxy process (on STDIN) would look similar to this:</p> 6104 <pre><code>{ 6105 "user": "me", 6106 "pass": "mypassword" 6107 }</code></pre> 6108 <p>If public-key authentication was used by the client, input to the proxy process (on STDIN) would look similar to this:</p> 6109 <pre><code>{ 6110 "user": "me", 6111 "public_key": "AAAAB3NzaC1yc2EAAAADAQABAAABAQDuwESFdAe14hVS6omeyX7edc...JQdf" 6112 }</code></pre> 6113 <p>And as an example return this on STDOUT</p> 6114 <pre><code>{ 6115 "type": "sftp", 6116 "_root": "", 6117 "_obscure": "pass", 6118 "user": "me", 6119 "pass": "mypassword", 6120 "host": "sftp.example.com" 6121 }</code></pre> 6122 <p>This would mean that an SFTP backend would be created on the fly for the <code>user</code> and <code>pass</code>/<code>public_key</code> returned in the output to the host given. Note that since <code>_obscure</code> is set to <code>pass</code>, rclone will obscure the <code>pass</code> parameter before creating the backend (which is required for sftp backends).</p> 6123 <p>The program can manipulate the supplied <code>user</code> in any way, for example to make proxy to many different sftp backends, you could make the <code>user</code> be <code>user@example.com</code> and then set the <code>host</code> to <code>example.com</code> in the output and the user to <code>user</code>. For security you'd probably want to restrict the <code>host</code> to a limited list.</p> 6124 <p>Note that an internal cache is keyed on <code>user</code> so only use that for configuration, don't use <code>pass</code> or <code>public_key</code>. This also means that if a user's password or public-key is changed the cache will need to expire (which takes 5 mins) before it takes effect.</p> 6125 <p>This can be used to build general purpose proxies to any kind of backend that rclone supports.</p> 6126 <pre><code>rclone serve webdav remote:path [flags]</code></pre> 6127 <h2 id="options-78">Options</h2> 6128 <pre><code> --addr stringArray IPaddress:Port or :Port to bind server to (default [127.0.0.1:8080]) 6129 --allow-origin string Origin which cross-domain request (CORS) can be executed from 6130 --auth-proxy string A program to use to create the backend from the auth 6131 --baseurl string Prefix for URLs - leave blank for root 6132 --cert string TLS PEM key (concatenation of certificate and CA certificate) 6133 --client-ca string Client certificate authority to verify clients with 6134 --dir-cache-time Duration Time to cache directory entries for (default 5m0s) 6135 --dir-perms FileMode Directory permissions (default 0777) 6136 --disable-dir-list Disable HTML directory list on GET request for a directory 6137 --etag-hash string Which hash to use for the ETag, or auto or blank for off 6138 --file-perms FileMode File permissions (default 0666) 6139 --gid uint32 Override the gid field set by the filesystem (not supported on Windows) (default 1000) 6140 -h, --help help for webdav 6141 --htpasswd string A htpasswd file - if not provided no authentication is done 6142 --key string TLS PEM Private key 6143 --max-header-bytes int Maximum size of request header (default 4096) 6144 --min-tls-version string Minimum TLS version that is acceptable (default "tls1.0") 6145 --no-checksum Don't compare checksums on up/download 6146 --no-modtime Don't read/write the modification time (can speed things up) 6147 --no-seek Don't allow seeking in files 6148 --pass string Password for authentication 6149 --poll-interval Duration Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s) 6150 --read-only Only allow read-only access 6151 --realm string Realm for authentication 6152 --salt string Password hashing salt (default "dlPL2MqE") 6153 --server-read-timeout Duration Timeout for server reading data (default 1h0m0s) 6154 --server-write-timeout Duration Timeout for server writing data (default 1h0m0s) 6155 --template string User-specified template 6156 --uid uint32 Override the uid field set by the filesystem (not supported on Windows) (default 1000) 6157 --umask int Override the permission bits set by the filesystem (not supported on Windows) (default 2) 6158 --user string User name for authentication 6159 --vfs-block-norm-dupes If duplicate filenames exist in the same directory (after normalization), log an error and hide the duplicates (may have a performance cost) 6160 --vfs-cache-max-age Duration Max time since last access of objects in the cache (default 1h0m0s) 6161 --vfs-cache-max-size SizeSuffix Max total size of objects in the cache (default off) 6162 --vfs-cache-min-free-space SizeSuffix Target minimum free space on the disk containing the cache (default off) 6163 --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) 6164 --vfs-cache-poll-interval Duration Interval to poll the cache for stale objects (default 1m0s) 6165 --vfs-case-insensitive If a file name not found, find a case insensitive match 6166 --vfs-disk-space-total-size SizeSuffix Specify the total space of disk (default off) 6167 --vfs-fast-fingerprint Use fast (less accurate) fingerprints for change detection 6168 --vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full 6169 --vfs-read-chunk-size SizeSuffix Read the source objects in chunks (default 128Mi) 6170 --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) 6171 --vfs-read-wait Duration Time to wait for in-sequence read before seeking (default 20ms) 6172 --vfs-refresh Refreshes the directory cache recursively in the background on start 6173 --vfs-used-is-size rclone size Use the rclone size algorithm for Used size 6174 --vfs-write-back Duration Time to writeback files after last use when using cache (default 5s) 6175 --vfs-write-wait Duration Time to wait for in-sequence write before giving error (default 1s)</code></pre> 6176 <h2 id="filter-options-30">Filter Options</h2> 6177 <p>Flags for filtering directory listings.</p> 6178 <pre><code> --delete-excluded Delete files on dest excluded from sync 6179 --exclude stringArray Exclude files matching pattern 6180 --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) 6181 --exclude-if-present stringArray Exclude directories if filename is present 6182 --files-from stringArray Read list of source-file names from file (use - to read from stdin) 6183 --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) 6184 -f, --filter stringArray Add a file filtering rule 6185 --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) 6186 --ignore-case Ignore case in filters (case insensitive) 6187 --include stringArray Include files matching pattern 6188 --include-from stringArray Read file include patterns from file (use - to read from stdin) 6189 --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) 6190 --max-depth int If set limits the recursion depth to this (default -1) 6191 --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) 6192 --metadata-exclude stringArray Exclude metadatas matching pattern 6193 --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) 6194 --metadata-filter stringArray Add a metadata filtering rule 6195 --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) 6196 --metadata-include stringArray Include metadatas matching pattern 6197 --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) 6198 --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) 6199 --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre> 6200 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 6201 <h1 id="see-also-78">SEE ALSO</h1> 6202 <ul> 6203 <li><a href="https://rclone.org/commands/rclone_serve/">rclone serve</a> - Serve a remote over a protocol.</li> 6204 </ul> 6205 <h1 id="rclone-settier">rclone settier</h1> 6206 <p>Changes storage class/tier of objects in remote.</p> 6207 <h2 id="synopsis-71">Synopsis</h2> 6208 <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> 6209 <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> 6210 <p>You can use it to tier single object</p> 6211 <pre><code>rclone settier Cool remote:path/file</code></pre> 6212 <p>Or use rclone filters to set tier on only specific files</p> 6213 <pre><code>rclone --include "*.txt" settier Hot remote:path/dir</code></pre> 6214 <p>Or just provide remote directory and all files in directory will be tiered</p> 6215 <pre><code>rclone settier tier remote:path/dir</code></pre> 6216 <pre><code>rclone settier tier remote:path [flags]</code></pre> 6217 <h2 id="options-79">Options</h2> 6218 <pre><code> -h, --help help for settier</code></pre> 6219 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 6220 <h1 id="see-also-79">SEE ALSO</h1> 6221 <ul> 6222 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 6223 </ul> 6224 <h1 id="rclone-test">rclone test</h1> 6225 <p>Run a test command</p> 6226 <h2 id="synopsis-72">Synopsis</h2> 6227 <p>Rclone test is used to run test commands.</p> 6228 <p>Select which test command you want with the subcommand, eg</p> 6229 <pre><code>rclone test memory remote:</code></pre> 6230 <p>Each subcommand has its own options which you can see in their help.</p> 6231 <p><strong>NB</strong> Be careful running these commands, they may do strange things so reading their documentation first is recommended.</p> 6232 <h2 id="options-80">Options</h2> 6233 <pre><code> -h, --help help for test</code></pre> 6234 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 6235 <h1 id="see-also-80">SEE ALSO</h1> 6236 <ul> 6237 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 6238 <li><a href="https://rclone.org/commands/rclone_test_changenotify/">rclone test changenotify</a> - Log any change notify requests for the remote passed in.</li> 6239 <li><a href="https://rclone.org/commands/rclone_test_histogram/">rclone test histogram</a> - Makes a histogram of file name characters.</li> 6240 <li><a href="https://rclone.org/commands/rclone_test_info/">rclone test info</a> - Discovers file name or other limitations for paths.</li> 6241 <li><a href="https://rclone.org/commands/rclone_test_makefile/">rclone test makefile</a> - Make files with random contents of the size given</li> 6242 <li><a href="https://rclone.org/commands/rclone_test_makefiles/">rclone test makefiles</a> - Make a random file hierarchy in a directory</li> 6243 <li><a href="https://rclone.org/commands/rclone_test_memory/">rclone test memory</a> - Load all the objects at remote:path into memory and report memory stats.</li> 6244 </ul> 6245 <h1 id="rclone-test-changenotify">rclone test changenotify</h1> 6246 <p>Log any change notify requests for the remote passed in.</p> 6247 <pre><code>rclone test changenotify remote: [flags]</code></pre> 6248 <h2 id="options-81">Options</h2> 6249 <pre><code> -h, --help help for changenotify 6250 --poll-interval Duration Time to wait between polling for changes (default 10s)</code></pre> 6251 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 6252 <h1 id="see-also-81">SEE ALSO</h1> 6253 <ul> 6254 <li><a href="https://rclone.org/commands/rclone_test/">rclone test</a> - Run a test command</li> 6255 </ul> 6256 <h1 id="rclone-test-histogram">rclone test histogram</h1> 6257 <p>Makes a histogram of file name characters.</p> 6258 <h2 id="synopsis-73">Synopsis</h2> 6259 <p>This command outputs JSON which shows the histogram of characters used in filenames in the remote:path specified.</p> 6260 <p>The data doesn't contain any identifying information but is useful for the rclone developers when developing filename compression.</p> 6261 <pre><code>rclone test histogram [remote:path] [flags]</code></pre> 6262 <h2 id="options-82">Options</h2> 6263 <pre><code> -h, --help help for histogram</code></pre> 6264 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 6265 <h1 id="see-also-82">SEE ALSO</h1> 6266 <ul> 6267 <li><a href="https://rclone.org/commands/rclone_test/">rclone test</a> - Run a test command</li> 6268 </ul> 6269 <h1 id="rclone-test-info">rclone test info</h1> 6270 <p>Discovers file name or other limitations for paths.</p> 6271 <h2 id="synopsis-74">Synopsis</h2> 6272 <p>rclone info discovers what filenames and upload methods are possible to write to the paths passed in and how long they can be. It can take some time. It will write test files into the remote:path passed in. It outputs a bit of go code for each one.</p> 6273 <p><strong>NB</strong> this can create undeletable files and other hazards - use with care</p> 6274 <pre><code>rclone test info [remote:path]+ [flags]</code></pre> 6275 <h2 id="options-83">Options</h2> 6276 <pre><code> --all Run all tests 6277 --check-base32768 Check can store all possible base32768 characters 6278 --check-control Check control characters 6279 --check-length Check max filename length 6280 --check-normalization Check UTF-8 Normalization 6281 --check-streaming Check uploads with indeterminate file size 6282 -h, --help help for info 6283 --upload-wait Duration Wait after writing a file (default 0s) 6284 --write-json string Write results to file</code></pre> 6285 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 6286 <h1 id="see-also-83">SEE ALSO</h1> 6287 <ul> 6288 <li><a href="https://rclone.org/commands/rclone_test/">rclone test</a> - Run a test command</li> 6289 </ul> 6290 <h1 id="rclone-test-makefile">rclone test makefile</h1> 6291 <p>Make files with random contents of the size given</p> 6292 <pre><code>rclone test makefile <size> [<file>]+ [flags]</code></pre> 6293 <h2 id="options-84">Options</h2> 6294 <pre><code> --ascii Fill files with random ASCII printable bytes only 6295 --chargen Fill files with a ASCII chargen pattern 6296 -h, --help help for makefile 6297 --pattern Fill files with a periodic pattern 6298 --seed int Seed for the random number generator (0 for random) (default 1) 6299 --sparse Make the files sparse (appear to be filled with ASCII 0x00) 6300 --zero Fill files with ASCII 0x00</code></pre> 6301 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 6302 <h1 id="see-also-84">SEE ALSO</h1> 6303 <ul> 6304 <li><a href="https://rclone.org/commands/rclone_test/">rclone test</a> - Run a test command</li> 6305 </ul> 6306 <h1 id="rclone-test-makefiles">rclone test makefiles</h1> 6307 <p>Make a random file hierarchy in a directory</p> 6308 <pre><code>rclone test makefiles <dir> [flags]</code></pre> 6309 <h2 id="options-85">Options</h2> 6310 <pre><code> --ascii Fill files with random ASCII printable bytes only 6311 --chargen Fill files with a ASCII chargen pattern 6312 --files int Number of files to create (default 1000) 6313 --files-per-directory int Average number of files per directory (default 10) 6314 -h, --help help for makefiles 6315 --max-depth int Maximum depth of directory hierarchy (default 10) 6316 --max-file-size SizeSuffix Maximum size of files to create (default 100) 6317 --max-name-length int Maximum size of file names (default 12) 6318 --min-file-size SizeSuffix Minimum size of file to create 6319 --min-name-length int Minimum size of file names (default 4) 6320 --pattern Fill files with a periodic pattern 6321 --seed int Seed for the random number generator (0 for random) (default 1) 6322 --sparse Make the files sparse (appear to be filled with ASCII 0x00) 6323 --zero Fill files with ASCII 0x00</code></pre> 6324 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 6325 <h1 id="see-also-85">SEE ALSO</h1> 6326 <ul> 6327 <li><a href="https://rclone.org/commands/rclone_test/">rclone test</a> - Run a test command</li> 6328 </ul> 6329 <h1 id="rclone-test-memory">rclone test memory</h1> 6330 <p>Load all the objects at remote:path into memory and report memory stats.</p> 6331 <pre><code>rclone test memory remote:path [flags]</code></pre> 6332 <h2 id="options-86">Options</h2> 6333 <pre><code> -h, --help help for memory</code></pre> 6334 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 6335 <h1 id="see-also-86">SEE ALSO</h1> 6336 <ul> 6337 <li><a href="https://rclone.org/commands/rclone_test/">rclone test</a> - Run a test command</li> 6338 </ul> 6339 <h1 id="rclone-touch">rclone touch</h1> 6340 <p>Create new file or change file modification time.</p> 6341 <h2 id="synopsis-75">Synopsis</h2> 6342 <p>Set the modification time on file(s) as specified by remote:path to have the current time.</p> 6343 <p>If remote:path does not exist then a zero sized file will be created, unless <code>--no-create</code> or <code>--recursive</code> is provided.</p> 6344 <p>If <code>--recursive</code> is used then recursively sets the modification time on all existing files that is found under the path. Filters are supported, and you can test with the <code>--dry-run</code> or the <code>--interactive</code>/<code>-i</code> flag.</p> 6345 <p>If <code>--timestamp</code> is used then sets the modification time to that time instead of the current time. Times may be specified as one of:</p> 6346 <ul> 6347 <li>'YYMMDD' - e.g. 17.10.30</li> 6348 <li>'YYYY-MM-DDTHH:MM:SS' - e.g. 2006-01-02T15:04:05</li> 6349 <li>'YYYY-MM-DDTHH:MM:SS.SSS' - e.g. 2006-01-02T15:04:05.123456789</li> 6350 </ul> 6351 <p>Note that value of <code>--timestamp</code> is in UTC. If you want local time then add the <code>--localtime</code> flag.</p> 6352 <pre><code>rclone touch remote:path [flags]</code></pre> 6353 <h2 id="options-87">Options</h2> 6354 <pre><code> -h, --help help for touch 6355 --localtime Use localtime for timestamp, not UTC 6356 -C, --no-create Do not create the file if it does not exist (implied with --recursive) 6357 -R, --recursive Recursively touch all files 6358 -t, --timestamp string Use specified time instead of the current time of day</code></pre> 6359 <h2 id="important-options-17">Important Options</h2> 6360 <p>Important flags useful for most commands.</p> 6361 <pre><code> -n, --dry-run Do a trial run with no permanent changes 6362 -i, --interactive Enable interactive mode 6363 -v, --verbose count Print lots more stuff (repeat for more)</code></pre> 6364 <h2 id="filter-options-31">Filter Options</h2> 6365 <p>Flags for filtering directory listings.</p> 6366 <pre><code> --delete-excluded Delete files on dest excluded from sync 6367 --exclude stringArray Exclude files matching pattern 6368 --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) 6369 --exclude-if-present stringArray Exclude directories if filename is present 6370 --files-from stringArray Read list of source-file names from file (use - to read from stdin) 6371 --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) 6372 -f, --filter stringArray Add a file filtering rule 6373 --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) 6374 --ignore-case Ignore case in filters (case insensitive) 6375 --include stringArray Include files matching pattern 6376 --include-from stringArray Read file include patterns from file (use - to read from stdin) 6377 --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) 6378 --max-depth int If set limits the recursion depth to this (default -1) 6379 --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) 6380 --metadata-exclude stringArray Exclude metadatas matching pattern 6381 --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) 6382 --metadata-filter stringArray Add a metadata filtering rule 6383 --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) 6384 --metadata-include stringArray Include metadatas matching pattern 6385 --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) 6386 --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) 6387 --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre> 6388 <h2 id="listing-options-20">Listing Options</h2> 6389 <p>Flags for listing directories.</p> 6390 <pre><code> --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) 6391 --fast-list Use recursive list if available; uses more memory but fewer transactions</code></pre> 6392 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 6393 <h1 id="see-also-87">SEE ALSO</h1> 6394 <ul> 6395 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 6396 </ul> 6397 <h1 id="rclone-tree">rclone tree</h1> 6398 <p>List the contents of the remote in a tree like fashion.</p> 6399 <h2 id="synopsis-76">Synopsis</h2> 6400 <p>rclone tree lists the contents of a remote in a similar way to the unix tree command.</p> 6401 <p>For example</p> 6402 <pre><code>$ rclone tree remote:path 6403 / 6404 ├── file1 6405 ├── file2 6406 ├── file3 6407 └── subdir 6408 ├── file4 6409 └── file5 6410 6411 1 directories, 5 files</code></pre> 6412 <p>You can use any of the filtering options with the tree command (e.g. <code>--include</code> and <code>--exclude</code>. You can also use <code>--fast-list</code>.</p> 6413 <p>The tree command has many options for controlling the listing which are compatible with the tree command, for example you can include file sizes with <code>--size</code>. Note that not all of them have short options as they conflict with rclone's short options.</p> 6414 <p>For a more interactive navigation of the remote see the <a href="https://rclone.org/commands/rclone_ncdu/">ncdu</a> command.</p> 6415 <pre><code>rclone tree remote:path [flags]</code></pre> 6416 <h2 id="options-88">Options</h2> 6417 <pre><code> -a, --all All files are listed (list . files too) 6418 -d, --dirs-only List directories only 6419 --dirsfirst List directories before files (-U disables) 6420 --full-path Print the full path prefix for each file 6421 -h, --help help for tree 6422 --level int Descend only level directories deep 6423 -D, --modtime Print the date of last modification. 6424 --noindent Don't print indentation lines 6425 --noreport Turn off file/directory count at end of tree listing 6426 -o, --output string Output to file instead of stdout 6427 -p, --protections Print the protections for each file. 6428 -Q, --quote Quote filenames with double quotes. 6429 -s, --size Print the size in bytes of each file. 6430 --sort string Select sort: name,version,size,mtime,ctime 6431 --sort-ctime Sort files by last status change time 6432 -t, --sort-modtime Sort files by last modification time 6433 -r, --sort-reverse Reverse the order of the sort 6434 -U, --unsorted Leave files unsorted 6435 --version Sort files alphanumerically by version</code></pre> 6436 <h2 id="filter-options-32">Filter Options</h2> 6437 <p>Flags for filtering directory listings.</p> 6438 <pre><code> --delete-excluded Delete files on dest excluded from sync 6439 --exclude stringArray Exclude files matching pattern 6440 --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) 6441 --exclude-if-present stringArray Exclude directories if filename is present 6442 --files-from stringArray Read list of source-file names from file (use - to read from stdin) 6443 --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) 6444 -f, --filter stringArray Add a file filtering rule 6445 --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) 6446 --ignore-case Ignore case in filters (case insensitive) 6447 --include stringArray Include files matching pattern 6448 --include-from stringArray Read file include patterns from file (use - to read from stdin) 6449 --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) 6450 --max-depth int If set limits the recursion depth to this (default -1) 6451 --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) 6452 --metadata-exclude stringArray Exclude metadatas matching pattern 6453 --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) 6454 --metadata-filter stringArray Add a metadata filtering rule 6455 --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) 6456 --metadata-include stringArray Include metadatas matching pattern 6457 --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) 6458 --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) 6459 --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre> 6460 <h2 id="listing-options-21">Listing Options</h2> 6461 <p>Flags for listing directories.</p> 6462 <pre><code> --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) 6463 --fast-list Use recursive list if available; uses more memory but fewer transactions</code></pre> 6464 <p>See the <a href="https://rclone.org/flags/">global flags page</a> for global options not listed here.</p> 6465 <h1 id="see-also-88">SEE ALSO</h1> 6466 <ul> 6467 <li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help for rclone commands, flags and backends.</li> 6468 </ul> 6469 <h2 id="copying-single-files">Copying single files</h2> 6470 <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> 6471 <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> 6472 <pre><code>rclone copy remote:test.jpg /tmp/download</code></pre> 6473 <p>The file <code>test.jpg</code> will be placed inside <code>/tmp/download</code>.</p> 6474 <p>This is equivalent to specifying</p> 6475 <pre><code>rclone copy --files-from /tmp/files remote: /tmp/download</code></pre> 6476 <p>Where <code>/tmp/files</code> contains the single line</p> 6477 <pre><code>test.jpg</code></pre> 6478 <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> 6479 <h2 id="syntax-of-remote-paths">Syntax of remote paths</h2> 6480 <p>The syntax of the paths passed to the rclone command are as follows.</p> 6481 <h3 id="pathtodir">/path/to/dir</h3> 6482 <p>This refers to the local file system.</p> 6483 <p>On Windows <code>\</code> may be used instead of <code>/</code> in local paths <strong>only</strong>, non local paths must use <code>/</code>. See <a href="https://rclone.org/local/#paths-on-windows">local filesystem</a> documentation for more about Windows-specific paths.</p> 6484 <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> 6485 <h3 id="remotepathtodir">remote:path/to/dir</h3> 6486 <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> 6487 <h3 id="remotepathtodir-1">remote:/path/to/dir</h3> 6488 <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> 6489 <h3 id="backendpathtodir">:backend:path/to/dir</h3> 6490 <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> 6491 <p>Here are some examples:</p> 6492 <pre><code>rclone lsd --http-url https://pub.rclone.org :http:</code></pre> 6493 <p>To list all the directories in the root of <code>https://pub.rclone.org/</code>.</p> 6494 <pre><code>rclone lsf --http-url https://example.com :http:path/to/dir</code></pre> 6495 <p>To list files and directories in <code>https://example.com/path/to/dir/</code></p> 6496 <pre><code>rclone copy --http-url https://example.com :http:path/to/dir /tmp/dir</code></pre> 6497 <p>To copy files and directories in <code>https://example.com/path/to/dir</code> to <code>/tmp/dir</code>.</p> 6498 <pre><code>rclone copy --sftp-host example.com :sftp:path/to/dir /tmp/dir</code></pre> 6499 <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> 6500 <h3 id="connection-strings">Connection strings</h3> 6501 <p>The above examples can also be written using a connection string syntax, so instead of providing the arguments as command line parameters <code>--http-url https://pub.rclone.org</code> they are provided as part of the remote specification as a kind of connection string.</p> 6502 <pre><code>rclone lsd ":http,url='https://pub.rclone.org':" 6503 rclone lsf ":http,url='https://example.com':path/to/dir" 6504 rclone copy ":http,url='https://example.com':path/to/dir" /tmp/dir 6505 rclone copy :sftp,host=example.com:path/to/dir /tmp/dir</code></pre> 6506 <p>These can apply to modify existing remotes as well as create new remotes with the on the fly syntax. This example is equivalent to adding the <code>--drive-shared-with-me</code> parameter to the remote <code>gdrive:</code>.</p> 6507 <pre><code>rclone lsf "gdrive,shared_with_me:path/to/dir"</code></pre> 6508 <p>The major advantage to using the connection string style syntax is that it only applies to the remote, not to all the remotes of that type of the command line. A common confusion is this attempt to copy a file shared on google drive to the normal drive which <strong>does not work</strong> because the <code>--drive-shared-with-me</code> flag applies to both the source and the destination.</p> 6509 <pre><code>rclone copy --drive-shared-with-me gdrive:shared-file.txt gdrive:</code></pre> 6510 <p>However using the connection string syntax, this does work.</p> 6511 <pre><code>rclone copy "gdrive,shared_with_me:shared-file.txt" gdrive:</code></pre> 6512 <p>Note that the connection string only affects the options of the immediate backend. If for example gdriveCrypt is a crypt based on gdrive, then the following command <strong>will not work</strong> as intended, because <code>shared_with_me</code> is ignored by the crypt backend:</p> 6513 <pre><code>rclone copy "gdriveCrypt,shared_with_me:shared-file.txt" gdriveCrypt:</code></pre> 6514 <p>The connection strings have the following syntax</p> 6515 <pre><code>remote,parameter=value,parameter2=value2:path/to/dir 6516 :backend,parameter=value,parameter2=value2:path/to/dir</code></pre> 6517 <p>If the <code>parameter</code> has a <code>:</code> or <code>,</code> then it must be placed in quotes <code>"</code> or <code>'</code>, so</p> 6518 <pre><code>remote,parameter="colon:value",parameter2="comma,value":path/to/dir 6519 :backend,parameter='colon:value',parameter2='comma,value':path/to/dir</code></pre> 6520 <p>If a quoted value needs to include that quote, then it should be doubled, so</p> 6521 <pre><code>remote,parameter="with""quote",parameter2='with''quote':path/to/dir</code></pre> 6522 <p>This will make <code>parameter</code> be <code>with"quote</code> and <code>parameter2</code> be <code>with'quote</code>.</p> 6523 <p>If you leave off the <code>=parameter</code> then rclone will substitute <code>=true</code> which works very well with flags. For example, to use s3 configured in the environment you could use:</p> 6524 <pre><code>rclone lsd :s3,env_auth:</code></pre> 6525 <p>Which is equivalent to</p> 6526 <pre><code>rclone lsd :s3,env_auth=true:</code></pre> 6527 <p>Note that on the command line you might need to surround these connection strings with <code>"</code> or <code>'</code> to stop the shell interpreting any special characters within them.</p> 6528 <p>If you are a shell master then you'll know which strings are OK and which aren't, but if you aren't sure then enclose them in <code>"</code> and use <code>'</code> as the inside quote. This syntax works on all OSes.</p> 6529 <pre><code>rclone copy ":http,url='https://example.com':path/to/dir" /tmp/dir</code></pre> 6530 <p>On Linux/macOS some characters are still interpreted inside <code>"</code> strings in the shell (notably <code>\</code> and <code>$</code> and <code>"</code>) so if your strings contain those you can swap the roles of <code>"</code> and <code>'</code> thus. (This syntax does not work on Windows.)</p> 6531 <pre><code>rclone copy ':http,url="https://example.com":path/to/dir' /tmp/dir</code></pre> 6532 <h4 id="connection-strings-config-and-logging">Connection strings, config and logging</h4> 6533 <p>If you supply extra configuration to a backend by command line flag, environment variable or connection string then rclone will add a suffix based on the hash of the config to the name of the remote, eg</p> 6534 <pre><code>rclone -vv lsf --s3-chunk-size 20M s3:</code></pre> 6535 <p>Has the log message</p> 6536 <pre><code>DEBUG : s3: detected overridden config - adding "{Srj1p}" suffix to name</code></pre> 6537 <p>This is so rclone can tell the modified remote apart from the unmodified remote when caching the backends.</p> 6538 <p>This should only be noticeable in the logs.</p> 6539 <p>This means that on the fly backends such as</p> 6540 <pre><code>rclone -vv lsf :s3,env_auth:</code></pre> 6541 <p>Will get their own names</p> 6542 <pre><code>DEBUG : :s3: detected overridden config - adding "{YTu53}" suffix to name</code></pre> 6543 <h3 id="valid-remote-names">Valid remote names</h3> 6544 <p>Remote names are case sensitive, and must adhere to the following rules: - May contain number, letter, <code>_</code>, <code>-</code>, <code>.</code>, <code>+</code>, <code>@</code> and space. - May not start with <code>-</code> or space. - May not end with space.</p> 6545 <p>Starting with rclone version 1.61, any Unicode numbers and letters are allowed, while in older versions it was limited to plain ASCII (0-9, A-Z, a-z). If you use the same rclone configuration from different shells, which may be configured with different character encoding, you must be cautious to use characters that are possible to write in all of them. This is mostly a problem on Windows, where the console traditionally uses a non-Unicode character set - defined by the so-called "code page".</p> 6546 <p>Do not use single character names on Windows as it creates ambiguity with Windows drives' names, e.g.: remote called <code>C</code> is indistinguishable from <code>C</code> drive. Rclone will always assume that single letter name refers to a drive.</p> 6547 <h2 id="quoting-and-the-shell">Quoting and the shell</h2> 6548 <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> 6549 <p>Here are some gotchas which may help users unfamiliar with the shell rules</p> 6550 <h3 id="linux-osx">Linux / OSX</h3> 6551 <p>If your names have spaces or shell metacharacters (e.g. <code>*</code>, <code>?</code>, <code>$</code>, <code>'</code>, <code>"</code>, etc.) then you must quote them. Use single quotes <code>'</code> by default.</p> 6552 <pre><code>rclone copy 'Important files?' remote:backup</code></pre> 6553 <p>If you want to send a <code>'</code> you will need to use <code>"</code>, e.g.</p> 6554 <pre><code>rclone copy "O'Reilly Reviews" remote:backup</code></pre> 6555 <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> 6556 <h3 id="windows-1">Windows</h3> 6557 <p>If your names have spaces in you need to put them in <code>"</code>, e.g.</p> 6558 <pre><code>rclone copy "E:\folder name\folder name\folder name" remote:backup</code></pre> 6559 <p>If you are using the root directory on its own then don't quote it (see <a href="https://github.com/rclone/rclone/issues/464">#464</a> for why), e.g.</p> 6560 <pre><code>rclone copy E:\ remote:backup</code></pre> 6561 <h2 id="copying-files-or-directories-with-in-the-names">Copying files or directories with <code>:</code> in the names</h2> 6562 <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> 6563 <p>So to sync a directory called <code>sync:me</code> to a remote called <code>remote:</code> use</p> 6564 <pre><code>rclone sync --interactive ./sync:me remote:path</code></pre> 6565 <p>or</p> 6566 <pre><code>rclone sync --interactive /full/path/to/sync:me remote:path</code></pre> 6567 <h2 id="server-side-copy">Server Side Copy</h2> 6568 <p>Most remotes (but not all - see <a href="https://rclone.org/overview/#optional-features">the overview</a>) support server-side copy.</p> 6569 <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> 6570 <p>Eg</p> 6571 <pre><code>rclone copy s3:oldbucket s3:newbucket</code></pre> 6572 <p>Will copy the contents of <code>oldbucket</code> to <code>newbucket</code> without downloading and re-uploading.</p> 6573 <p>Remotes which don't support server-side copy <strong>will</strong> download and re-upload in this case.</p> 6574 <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> 6575 <p>Server side copies will only be attempted if the remote names are the same.</p> 6576 <p>This can be used when scripting to make aged backups efficiently, e.g.</p> 6577 <pre><code>rclone sync --interactive remote:current-backup remote:previous-backup 6578 rclone sync --interactive /path/to/files remote:current-backup</code></pre> 6579 <h2 id="metadata">Metadata support</h2> 6580 <p>Metadata is data about a file (or directory) which isn't the contents of the file (or directory). Normally rclone only preserves the modification time and the content (MIME) type where possible.</p> 6581 <p>Rclone supports preserving all the available metadata on files and directories when using the <code>--metadata</code> or <code>-M</code> flag.</p> 6582 <p>Exactly what metadata is supported and what that support means depends on the backend. Backends that support metadata have a metadata section in their docs and are listed in the <a href="https://rclone.org/overview/#features">features table</a> (Eg <a href="https://rclone.org/local/#metadata">local</a>, <a href="/s3/#metadata">s3</a>)</p> 6583 <p>Some backends don't support metadata, some only support metadata on files and some support metadata on both files and directories.</p> 6584 <p>Rclone only supports a one-time sync of metadata. This means that metadata will be synced from the source object to the destination object only when the source object has changed and needs to be re-uploaded. If the metadata subsequently changes on the source object without changing the object itself then it won't be synced to the destination object. This is in line with the way rclone syncs <code>Content-Type</code> without the <code>--metadata</code> flag.</p> 6585 <p>Using <code>--metadata</code> when syncing from local to local will preserve file attributes such as file mode, owner, extended attributes (not Windows).</p> 6586 <p>Note that arbitrary metadata may be added to objects using the <code>--metadata-set key=value</code> flag when the object is first uploaded. This flag can be repeated as many times as necessary.</p> 6587 <p>The <a href="#metadata-mapper">--metadata-mapper</a> flag can be used to pass the name of a program in which can transform metadata when it is being copied from source to destination.</p> 6588 <p>Rclone supports <code>--metadata-set</code> and <code>--metadata-mapper</code> when doing sever side <code>Move</code> and server side <code>Copy</code>, but not when doing server side <code>DirMove</code> (renaming a directory) as this would involve recursing into the directory. Note that you can disable <code>DirMove</code> with <code>--disable DirMove</code> and rclone will revert back to using <code>Move</code> for each individual object where <code>--metadata-set</code> and <code>--metadata-mapper</code> are supported.</p> 6589 <h3 id="types-of-metadata">Types of metadata</h3> 6590 <p>Metadata is divided into two type. System metadata and User metadata.</p> 6591 <p>Metadata which the backend uses itself is called system metadata. For example on the local backend the system metadata <code>uid</code> will store the user ID of the file when used on a unix based platform.</p> 6592 <p>Arbitrary metadata is called user metadata and this can be set however is desired.</p> 6593 <p>When objects are copied from backend to backend, they will attempt to interpret system metadata if it is supplied. Metadata may change from being user metadata to system metadata as objects are copied between different backends. For example copying an object from s3 sets the <code>content-type</code> metadata. In a backend which understands this (like <code>azureblob</code>) this will become the Content-Type of the object. In a backend which doesn't understand this (like the <code>local</code> backend) this will become user metadata. However should the local object be copied back to s3, the Content-Type will be set correctly.</p> 6594 <h3 id="metadata-framework">Metadata framework</h3> 6595 <p>Rclone implements a metadata framework which can read metadata from an object and write it to the object when (and only when) it is being uploaded.</p> 6596 <p>This metadata is stored as a dictionary with string keys and string values.</p> 6597 <p>There are some limits on the names of the keys (these may be clarified further in the future).</p> 6598 <ul> 6599 <li>must be lower case</li> 6600 <li>may be <code>a-z</code> <code>0-9</code> containing <code>.</code> <code>-</code> or <code>_</code></li> 6601 <li>length is backend dependent</li> 6602 </ul> 6603 <p>Each backend can provide system metadata that it understands. Some backends can also store arbitrary user metadata.</p> 6604 <p>Where possible the key names are standardized, so, for example, it is possible to copy object metadata from s3 to azureblob for example and metadata will be translated appropriately.</p> 6605 <p>Some backends have limits on the size of the metadata and rclone will give errors on upload if they are exceeded.</p> 6606 <h3 id="metadata-preservation">Metadata preservation</h3> 6607 <p>The goal of the implementation is to</p> 6608 <ol type="1"> 6609 <li>Preserve metadata if at all possible</li> 6610 <li>Interpret metadata if at all possible</li> 6611 </ol> 6612 <p>The consequences of 1 is that you can copy an S3 object to a local disk then back to S3 losslessly. Likewise you can copy a local file with file attributes and xattrs from local disk to s3 and back again losslessly.</p> 6613 <p>The consequence of 2 is that you can copy an S3 object with metadata to Azureblob (say) and have the metadata appear on the Azureblob object also.</p> 6614 <h3 id="standard-system-metadata">Standard system metadata</h3> 6615 <p>Here is a table of standard system metadata which, if appropriate, a backend may implement.</p> 6616 <table> 6617 <colgroup> 6618 <col style="width: 48%" /> 6619 <col style="width: 30%" /> 6620 <col style="width: 20%" /> 6621 </colgroup> 6622 <thead> 6623 <tr class="header"> 6624 <th>key</th> 6625 <th>description</th> 6626 <th>example</th> 6627 </tr> 6628 </thead> 6629 <tbody> 6630 <tr class="odd"> 6631 <td>mode</td> 6632 <td>File type and mode: octal, unix style</td> 6633 <td>0100664</td> 6634 </tr> 6635 <tr class="even"> 6636 <td>uid</td> 6637 <td>User ID of owner: decimal number</td> 6638 <td>500</td> 6639 </tr> 6640 <tr class="odd"> 6641 <td>gid</td> 6642 <td>Group ID of owner: decimal number</td> 6643 <td>500</td> 6644 </tr> 6645 <tr class="even"> 6646 <td>rdev</td> 6647 <td>Device ID (if special file) => hexadecimal</td> 6648 <td>0</td> 6649 </tr> 6650 <tr class="odd"> 6651 <td>atime</td> 6652 <td>Time of last access: RFC 3339</td> 6653 <td>2006-01-02T15:04:05.999999999Z07:00</td> 6654 </tr> 6655 <tr class="even"> 6656 <td>mtime</td> 6657 <td>Time of last modification: RFC 3339</td> 6658 <td>2006-01-02T15:04:05.999999999Z07:00</td> 6659 </tr> 6660 <tr class="odd"> 6661 <td>btime</td> 6662 <td>Time of file creation (birth): RFC 3339</td> 6663 <td>2006-01-02T15:04:05.999999999Z07:00</td> 6664 </tr> 6665 <tr class="even"> 6666 <td>utime</td> 6667 <td>Time of file upload: RFC 3339</td> 6668 <td>2006-01-02T15:04:05.999999999Z07:00</td> 6669 </tr> 6670 <tr class="odd"> 6671 <td>cache-control</td> 6672 <td>Cache-Control header</td> 6673 <td>no-cache</td> 6674 </tr> 6675 <tr class="even"> 6676 <td>content-disposition</td> 6677 <td>Content-Disposition header</td> 6678 <td>inline</td> 6679 </tr> 6680 <tr class="odd"> 6681 <td>content-encoding</td> 6682 <td>Content-Encoding header</td> 6683 <td>gzip</td> 6684 </tr> 6685 <tr class="even"> 6686 <td>content-language</td> 6687 <td>Content-Language header</td> 6688 <td>en-US</td> 6689 </tr> 6690 <tr class="odd"> 6691 <td>content-type</td> 6692 <td>Content-Type header</td> 6693 <td>text/plain</td> 6694 </tr> 6695 </tbody> 6696 </table> 6697 <p>The metadata keys <code>mtime</code> and <code>content-type</code> will take precedence if supplied in the metadata over reading the <code>Content-Type</code> or modification time of the source object.</p> 6698 <p>Hashes are not included in system metadata as there is a well defined way of reading those already.</p> 6699 <h2 id="options-89">Options</h2> 6700 <p>Rclone has a number of options to control its behaviour.</p> 6701 <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> 6702 <h3 id="time-option">Time or duration options</h3> 6703 <p>TIME or DURATION options can be specified as a duration string or a time string.</p> 6704 <p>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". Default units are seconds or the following abbreviations are valid:</p> 6705 <ul> 6706 <li><code>ms</code> - Milliseconds</li> 6707 <li><code>s</code> - Seconds</li> 6708 <li><code>m</code> - Minutes</li> 6709 <li><code>h</code> - Hours</li> 6710 <li><code>d</code> - Days</li> 6711 <li><code>w</code> - Weeks</li> 6712 <li><code>M</code> - Months</li> 6713 <li><code>y</code> - Years</li> 6714 </ul> 6715 <p>These can also be specified as an absolute time in the following formats:</p> 6716 <ul> 6717 <li>RFC3339 - e.g. <code>2006-01-02T15:04:05Z</code> or <code>2006-01-02T15:04:05+07:00</code></li> 6718 <li>ISO8601 Date and time, local timezone - <code>2006-01-02T15:04:05</code></li> 6719 <li>ISO8601 Date and time, local timezone - <code>2006-01-02 15:04:05</code></li> 6720 <li>ISO8601 Date - <code>2006-01-02</code> (YYYY-MM-DD)</li> 6721 </ul> 6722 <h3 id="size-option">Size options</h3> 6723 <p>Options which use SIZE use KiB (multiples of 1024 bytes) by default. However, a suffix of <code>B</code> for Byte, <code>K</code> for KiB, <code>M</code> for MiB, <code>G</code> for GiB, <code>T</code> for TiB and <code>P</code> for PiB may be used. These are the binary units, e.g. 1, 2**10, 2**20, 2**30 respectively.</p> 6724 <h3 id="backup-dirdir">--backup-dir=DIR</h3> 6725 <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> 6726 <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> 6727 <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 without it being excluded by a filter rule.</p> 6728 <p>For example</p> 6729 <pre><code>rclone sync --interactive /path/to/local remote:current --backup-dir remote:old</code></pre> 6730 <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> 6731 <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> 6732 <p>See <code>--compare-dest</code> and <code>--copy-dest</code>.</p> 6733 <h3 id="bind-string">--bind string</h3> 6734 <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> 6735 <p>You can use <code>--bind 0.0.0.0</code> to force rclone to use IPv4 addresses and <code>--bind ::0</code> to force rclone to use IPv6 addresses.</p> 6736 <h3 id="bwlimitbandwidth_spec">--bwlimit=BANDWIDTH_SPEC</h3> 6737 <p>This option controls the bandwidth limit. For example</p> 6738 <pre><code>--bwlimit 10M</code></pre> 6739 <p>would mean limit the upload and download bandwidth to 10 MiB/s. <strong>NB</strong> this is <strong>bytes</strong> per second not <strong>bits</strong> per second. To use a single limit, specify the desired bandwidth in KiB/s, or use a suffix B|K|M|G|T|P. The default is <code>0</code> which means to not limit bandwidth.</p> 6740 <p>The upload and download bandwidth can be specified separately, as <code>--bwlimit UP:DOWN</code>, so</p> 6741 <pre><code>--bwlimit 10M:100k</code></pre> 6742 <p>would mean limit the upload bandwidth to 10 MiB/s and the download bandwidth to 100 KiB/s. Either limit can be "off" meaning no limit, so to just limit the upload bandwidth you would use</p> 6743 <pre><code>--bwlimit 10M:off</code></pre> 6744 <p>this would limit the upload bandwidth to 10 MiB/s but the download bandwidth would be unlimited.</p> 6745 <p>When specified as above the bandwidth limits last for the duration of run of the rclone binary.</p> 6746 <p>It is also possible to specify a "timetable" of limits, which will cause certain limits to be applied at certain times. To specify a timetable, format your entries as <code>WEEKDAY-HH:MM,BANDWIDTH WEEKDAY-HH:MM,BANDWIDTH...</code> where: <code>WEEKDAY</code> is optional element.</p> 6747 <ul> 6748 <li><code>BANDWIDTH</code> can be a single number, e.g.<code>100k</code> or a pair of numbers for upload:download, e.g.<code>10M:1M</code>.</li> 6749 <li><code>WEEKDAY</code> can be written as the whole word or only using the first 3 characters. It is optional.</li> 6750 <li><code>HH:MM</code> is an hour from 00:00 to 23:59.</li> 6751 </ul> 6752 <p>An example of a typical timetable to avoid link saturation during daytime working hours could be:</p> 6753 <p><code>--bwlimit "08:00,512k 12:00,10M 13:00,512k 18:00,30M 23:00,off"</code></p> 6754 <p>In this example, the transfer bandwidth will be set to 512 KiB/s at 8am every day. At noon, it will rise to 10 MiB/s, and drop back to 512 KiB/sec at 1pm. At 6pm, the bandwidth limit will be set to 30 MiB/s, and at 11pm it will be completely disabled (full speed). Anything between 11pm and 8am will remain unlimited.</p> 6755 <p>An example of timetable with <code>WEEKDAY</code> could be:</p> 6756 <p><code>--bwlimit "Mon-00:00,512 Fri-23:59,10M Sat-10:00,1M Sun-20:00,off"</code></p> 6757 <p>It means that, the transfer bandwidth will be set to 512 KiB/s on Monday. It will rise to 10 MiB/s before the end of Friday. At 10:00 on Saturday it will be set to 1 MiB/s. From 20:00 on Sunday it will be unlimited.</p> 6758 <p>Timeslots without <code>WEEKDAY</code> are extended to the whole week. So this example:</p> 6759 <p><code>--bwlimit "Mon-00:00,512 12:00,1M Sun-20:00,off"</code></p> 6760 <p>Is equivalent to this:</p> 6761 <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> 6762 <p>Bandwidth limit apply to the data transfer for all backends. For most backends the directory listing bandwidth is also included (exceptions being the non HTTP backends, <code>ftp</code>, <code>sftp</code> and <code>storj</code>).</p> 6763 <p>Note that the units are <strong>Byte/s</strong>, not <strong>bit/s</strong>. Typically connections are measured in bit/s - to convert divide by 8. For example, let's say you have a 10 Mbit/s connection and you wish rclone to use half of it - 5 Mbit/s. This is 5/8 = 0.625 MiB/s so you would use a <code>--bwlimit 0.625M</code> parameter for rclone.</p> 6764 <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> 6765 <pre><code>kill -SIGUSR2 $(pidof rclone)</code></pre> 6766 <p>If you configure rclone with a <a href="/rc">remote control</a> then you can use change the bwlimit dynamically:</p> 6767 <pre><code>rclone rc core/bwlimit rate=1M</code></pre> 6768 <h3 id="bwlimit-filebandwidth_spec">--bwlimit-file=BANDWIDTH_SPEC</h3> 6769 <p>This option controls per file bandwidth limit. For the options see the <code>--bwlimit</code> flag.</p> 6770 <p>For example use this to allow no transfers to be faster than 1 MiB/s</p> 6771 <pre><code>--bwlimit-file 1M</code></pre> 6772 <p>This can be used in conjunction with <code>--bwlimit</code>.</p> 6773 <p>Note that if a schedule is provided the file will use the schedule in effect at the start of the transfer.</p> 6774 <h3 id="buffer-sizesize">--buffer-size=SIZE</h3> 6775 <p>Use this sized buffer to speed up file transfers. Each <code>--transfer</code> will use this much memory for buffering.</p> 6776 <p>When using <code>mount</code> or <code>cmount</code> each open file descriptor will use this much memory for buffering. See the <a href="https://rclone.org/commands/rclone_mount/#file-buffering">mount</a> documentation for more details.</p> 6777 <p>Set to <code>0</code> to disable the buffering for the minimum memory usage.</p> 6778 <p>Note that the memory allocation of the buffers is influenced by the <a href="#use-mmap">--use-mmap</a> flag.</p> 6779 <h3 id="cache-dirdir">--cache-dir=DIR</h3> 6780 <p>Specify the directory rclone will use for caching, to override the default.</p> 6781 <p>Default value is depending on operating system: - Windows <code>%LocalAppData%\rclone</code>, if <code>LocalAppData</code> is defined. - macOS <code>$HOME/Library/Caches/rclone</code> if <code>HOME</code> is defined. - Unix <code>$XDG_CACHE_HOME/rclone</code> if <code>XDG_CACHE_HOME</code> is defined, else <code>$HOME/.cache/rclone</code> if <code>HOME</code> is defined. - Fallback (on all OS) to <code>$TMPDIR/rclone</code>, where <code>TMPDIR</code> is the value from <a href="#temp-dir-dir">--temp-dir</a>.</p> 6782 <p>You can use the <a href="https://rclone.org/commands/rclone_config_paths/">config paths</a> command to see the current value.</p> 6783 <p>Cache directory is heavily used by the <a href="https://rclone.org/commands/rclone_mount/#vfs-file-caching">VFS File Caching</a> mount feature, but also by <a href="https://rclone.org/commands/rclone_serve/">serve</a>, <a href="/gui">GUI</a> and other parts of rclone.</p> 6784 <h3 id="check-first">--check-first</h3> 6785 <p>If this flag is set then in a <code>sync</code>, <code>copy</code> or <code>move</code>, rclone will do all the checks to see whether files need to be transferred before doing any of the transfers. Normally rclone would start running transfers as soon as possible.</p> 6786 <p>This flag can be useful on IO limited systems where transfers interfere with checking.</p> 6787 <p>It can also be useful to ensure perfect ordering when using <code>--order-by</code>.</p> 6788 <p>If both <code>--check-first</code> and <code>--order-by</code> are set when doing <code>rclone move</code> then rclone will use the transfer thread to delete source files which don't need transferring. This will enable perfect ordering of the transfers and deletes but will cause the transfer stats to have more items in than expected.</p> 6789 <p>Using this flag can use more memory as it effectively sets <code>--max-backlog</code> to infinite. This means that all the info on the objects to transfer is held in memory before the transfers start.</p> 6790 <h3 id="checkersn">--checkers=N</h3> 6791 <p>Originally controlling just the number of file checkers to run in parallel, e.g. by <code>rclone copy</code>. Now a fairly universal parallelism control used by <code>rclone</code> in several places.</p> 6792 <p>Note: checkers do the equality checking of files during a sync. For some storage systems (e.g. S3, Swift, Dropbox) this can take a significant amount of time so they are run in parallel.</p> 6793 <p>The default is to run 8 checkers in parallel. However, in case of slow-reacting backends you may need to lower (rather than increase) this default by setting <code>--checkers</code> to 4 or less threads. This is especially advised if you are experiencing backend server crashes during file checking phase (e.g. on subsequent or top-up backups where little or no file copying is done and checking takes up most of the time). Increase this setting only with utmost care, while monitoring your server health and file checking throughput.</p> 6794 <h3 id="c---checksum">-c, --checksum</h3> 6795 <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> 6796 <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> 6797 <p>This is very useful when transferring between remotes which store the same hash type on the object, e.g. Drive and Swift. For details of which remotes support which hash type see the table in the <a href="https://rclone.org/overview/">overview section</a>.</p> 6798 <p>Eg <code>rclone --checksum sync s3:/bucket swift:/bucket</code> would run much quicker than without the <code>--checksum</code> flag.</p> 6799 <p>When using this flag, rclone won't update mtimes of remote files if they are incorrect as it would normally.</p> 6800 <h3 id="color-when">--color WHEN</h3> 6801 <p>Specify when colors (and other ANSI codes) should be added to the output.</p> 6802 <p><code>AUTO</code> (default) only allows ANSI codes when the output is a terminal</p> 6803 <p><code>NEVER</code> never allow ANSI codes</p> 6804 <p><code>ALWAYS</code> always add ANSI codes, regardless of the output format (terminal or file)</p> 6805 <h3 id="compare-destdir">--compare-dest=DIR</h3> 6806 <p>When using <code>sync</code>, <code>copy</code> or <code>move</code> DIR is checked in addition to the destination for files. If a file identical to the source is found that file is NOT copied from source. This is useful to copy just files that have changed since the last backup.</p> 6807 <p>You must use the same remote as the destination of the sync. The compare directory must not overlap the destination directory.</p> 6808 <p>See <code>--copy-dest</code> and <code>--backup-dir</code>.</p> 6809 <h3 id="configconfig_file">--config=CONFIG_FILE</h3> 6810 <p>Specify the location of the rclone configuration file, to override the default. E.g. <code>rclone config --config="rclone.conf"</code>.</p> 6811 <p>The exact default is a bit complex to describe, due to changes introduced through different versions of rclone while preserving backwards compatibility, but in most cases it is as simple as:</p> 6812 <ul> 6813 <li><code>%APPDATA%/rclone/rclone.conf</code> on Windows</li> 6814 <li><code>~/.config/rclone/rclone.conf</code> on other</li> 6815 </ul> 6816 <p>The complete logic is as follows: Rclone will look for an existing configuration file in any of the following locations, in priority order:</p> 6817 <ol type="1"> 6818 <li><code>rclone.conf</code> (in program directory, where rclone executable is)</li> 6819 <li><code>%APPDATA%/rclone/rclone.conf</code> (only on Windows)</li> 6820 <li><code>$XDG_CONFIG_HOME/rclone/rclone.conf</code> (on all systems, including Windows)</li> 6821 <li><code>~/.config/rclone/rclone.conf</code> (see below for explanation of ~ symbol)</li> 6822 <li><code>~/.rclone.conf</code></li> 6823 </ol> 6824 <p>If no existing configuration file is found, then a new one will be created in the following location:</p> 6825 <ul> 6826 <li>On Windows: Location 2 listed above, except in the unlikely event that <code>APPDATA</code> is not defined, then location 4 is used instead.</li> 6827 <li>On Unix: Location 3 if <code>XDG_CONFIG_HOME</code> is defined, else location 4.</li> 6828 <li>Fallback to location 5 (on all OS), when the rclone directory cannot be created, but if also a home directory was not found then path <code>.rclone.conf</code> relative to current working directory will be used as a final resort.</li> 6829 </ul> 6830 <p>The <code>~</code> symbol in paths above represent the home directory of the current user on any OS, and the value is defined as following:</p> 6831 <ul> 6832 <li>On Windows: <code>%HOME%</code> if defined, else <code>%USERPROFILE%</code>, or else <code>%HOMEDRIVE%\%HOMEPATH%</code>.</li> 6833 <li>On Unix: <code>$HOME</code> if defined, else by looking up current user in OS-specific user database (e.g. passwd file), or else use the result from shell command <code>cd && pwd</code>.</li> 6834 </ul> 6835 <p>If you run <code>rclone config file</code> you will see where the default location is for you.</p> 6836 <p>The fact that an existing file <code>rclone.conf</code> in the same directory as the rclone executable is always preferred, means that it is easy to run in "portable" mode by downloading rclone executable to a writable directory and then create an empty file <code>rclone.conf</code> in the same directory.</p> 6837 <p>If the location is set to empty string <code>""</code> or path to a file with name <code>notfound</code>, or the os null device represented by value <code>NUL</code> on Windows and <code>/dev/null</code> on Unix systems, then rclone will keep the config file in memory only.</p> 6838 <p>The file format is basic <a href="https://en.wikipedia.org/wiki/INI_file#Format">INI</a>: Sections of text, led by a <code>[section]</code> header and followed by <code>key=value</code> entries on separate lines. In rclone each remote is represented by its own section, where the section name defines the name of the remote. Options are specified as the <code>key=value</code> entries, where the key is the option name without the <code>--backend-</code> prefix, in lowercase and with <code>_</code> instead of <code>-</code>. E.g. option <code>--mega-hard-delete</code> corresponds to key <code>hard_delete</code>. Only backend options can be specified. A special, and required, key <code>type</code> identifies the <a href="https://rclone.org/overview/">storage system</a>, where the value is the internal lowercase name as returned by command <code>rclone help backends</code>. Comments are indicated by <code>;</code> or <code>#</code> at the beginning of a line.</p> 6839 <p>Example:</p> 6840 <pre><code>[megaremote] 6841 type = mega 6842 user = you@example.com 6843 pass = PDPcQVVjVtzFY-GTdDFozqBhTdsPg3qH</code></pre> 6844 <p>Note that passwords are in <a href="https://rclone.org/commands/rclone_obscure/">obscured</a> form. Also, many storage systems uses token-based authentication instead of passwords, and this requires additional steps. It is easier, and safer, to use the interactive command <code>rclone config</code> instead of manually editing the configuration file.</p> 6845 <p>The configuration file will typically contain login information, and should therefore have restricted permissions so that only the current user can read it. Rclone tries to ensure this when it writes the file. You may also choose to <a href="#configuration-encryption">encrypt</a> the file.</p> 6846 <p>When token-based authentication are used, the configuration file must be writable, because rclone needs to update the tokens inside it.</p> 6847 <p>To reduce risk of corrupting an existing configuration file, rclone will not write directly to it when saving changes. Instead it will first write to a new, temporary, file. If a configuration file already existed, it will (on Unix systems) try to mirror its permissions to the new file. Then it will rename the existing file to a temporary name as backup. Next, rclone will rename the new file to the correct name, before finally cleaning up by deleting the backup file.</p> 6848 <p>If the configuration file path used by rclone is a symbolic link, then this will be evaluated and rclone will write to the resolved path, instead of overwriting the symbolic link. Temporary files used in the process (described above) will be written to the same parent directory as that of the resolved configuration file, but if this directory is also a symbolic link it will not be resolved and the temporary files will be written to the location of the directory symbolic link.</p> 6849 <h3 id="contimeouttime">--contimeout=TIME</h3> 6850 <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> 6851 <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> 6852 <h3 id="copy-destdir">--copy-dest=DIR</h3> 6853 <p>When using <code>sync</code>, <code>copy</code> or <code>move</code> DIR is checked in addition to the destination for files. If a file identical to the source is found that file is server-side copied from DIR to the destination. This is useful for incremental backup.</p> 6854 <p>The remote in use must support server-side copy and you must use the same remote as the destination of the sync. The compare directory must not overlap the destination directory.</p> 6855 <p>See <code>--compare-dest</code> and <code>--backup-dir</code>.</p> 6856 <h3 id="dedupe-mode-mode">--dedupe-mode MODE</h3> 6857 <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>.<br /> 6858 See the dedupe command for more information as to what these options mean.</p> 6859 <h3 id="default-time-time">--default-time TIME</h3> 6860 <p>If a file or directory does have a modification time rclone can read then rclone will display this fixed time instead.</p> 6861 <p>The default is <code>2000-01-01 00:00:00 UTC</code>. This can be configured in any of the ways shown in <a href="#time-option">the time or duration options</a>.</p> 6862 <p>For example <code>--default-time 2020-06-01</code> to set the default time to the 1st of June 2020 or <code>--default-time 0s</code> to set the default time to the time rclone started up.</p> 6863 <h3 id="disable-featurefeature...">--disable FEATURE,FEATURE,...</h3> 6864 <p>This disables a comma separated list of optional features. For example to disable server-side move and server-side copy use:</p> 6865 <pre><code>--disable move,copy</code></pre> 6866 <p>The features can be put in any case.</p> 6867 <p>To see a list of which features can be disabled use:</p> 6868 <pre><code>--disable help</code></pre> 6869 <p>The features a remote has can be seen in JSON format with:</p> 6870 <pre><code>rclone backend features remote:</code></pre> 6871 <p>See the overview <a href="https://rclone.org/overview/#features">features</a> and <a href="https://rclone.org/overview/#optional-features">optional features</a> to get an idea of which feature does what.</p> 6872 <p>Note that some features can be set to <code>true</code> if they are <code>true</code>/<code>false</code> feature flag features by prefixing them with <code>!</code>. For example the <code>CaseInsensitive</code> feature can be forced to <code>false</code> with <code>--disable CaseInsensitive</code> and forced to <code>true</code> with <code>--disable '!CaseInsensitive'</code>. In general it isn't a good idea doing this but it may be useful in extremis.</p> 6873 <p>(Note that <code>!</code> is a shell command which you will need to escape with single quotes or a backslash on unix like platforms.)</p> 6874 <p>This flag can be useful for debugging and in exceptional circumstances (e.g. Google Drive limiting the total volume of Server Side Copies to 100 GiB/day).</p> 6875 <h3 id="disable-http2">--disable-http2</h3> 6876 <p>This stops rclone from trying to use HTTP/2 if available. This can sometimes speed up transfers due to a <a href="https://github.com/golang/go/issues/37373">problem in the Go standard library</a>.</p> 6877 <h3 id="dscp-value">--dscp VALUE</h3> 6878 <p>Specify a DSCP value or name to use in connections. This could help QoS system to identify traffic class. BE, EF, DF, LE, CSx and AFxx are allowed.</p> 6879 <p>See the description of <a href="https://en.wikipedia.org/wiki/Differentiated_services">differentiated services</a> to get an idea of this field. Setting this to 1 (LE) to identify the flow to SCAVENGER class can avoid occupying too much bandwidth in a network with DiffServ support (<a href="https://tools.ietf.org/html/rfc8622">RFC 8622</a>).</p> 6880 <p>For example, if you configured QoS on router to handle LE properly. Running:</p> 6881 <pre><code>rclone copy --dscp LE from:/from to:/to</code></pre> 6882 <p>would make the priority lower than usual internet flows.</p> 6883 <p>This option has no effect on Windows (see <a href="https://github.com/golang/go/issues/42728">golang/go#42728</a>).</p> 6884 <h3 id="n---dry-run">-n, --dry-run</h3> 6885 <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> 6886 <h3 id="expect-continue-timeouttime">--expect-continue-timeout=TIME</h3> 6887 <p>This specifies the amount of time to wait for a server's first response headers after fully writing the request headers if the request has an "Expect: 100-continue" header. Not all backends support using this.</p> 6888 <p>Zero means no timeout and causes the body to be sent immediately, without waiting for the server to approve. This time does not include the time to send the request header.</p> 6889 <p>The default is <code>1s</code>. Set to <code>0</code> to disable.</p> 6890 <h3 id="error-on-no-transfer">--error-on-no-transfer</h3> 6891 <p>By default, rclone will exit with return code 0 if there were no errors.</p> 6892 <p>This option allows rclone to return exit code 9 if no files were transferred between the source and destination. This allows using rclone in scripts, and triggering follow-on actions if data was copied, or skipping if not.</p> 6893 <p>NB: Enabling this option turns a usually non-fatal error into a potentially fatal one - please check and adjust your scripts accordingly!</p> 6894 <h3 id="fix-case">--fix-case</h3> 6895 <p>Normally, a sync to a case insensitive dest (such as macOS / Windows) will not result in a matching filename if the source and dest filenames have casing differences but are otherwise identical. For example, syncing <code>hello.txt</code> to <code>HELLO.txt</code> will normally result in the dest filename remaining <code>HELLO.txt</code>. If <code>--fix-case</code> is set, then <code>HELLO.txt</code> will be renamed to <code>hello.txt</code> to match the source.</p> 6896 <p>NB: - directory names with incorrect casing will also be fixed - <code>--fix-case</code> will be ignored if <code>--immutable</code> is set - using <code>--local-case-sensitive</code> instead is not advisable; it will cause <code>HELLO.txt</code> to get deleted! - the old dest filename must not be excluded by filters. Be especially careful with <a href="https://rclone.org/filtering/#files-from-read-list-of-source-file-names"><code>--files-from</code></a>, which does not respect <a href="https://rclone.org/filtering/#ignore-case-make-searches-case-insensitive"><code>--ignore-case</code></a>! - on remotes that do not support server-side move, <code>--fix-case</code> will require downloading the file and re-uploading it. To avoid this, do not use <code>--fix-case</code>.</p> 6897 <h3 id="fs-cache-expire-durationtime">--fs-cache-expire-duration=TIME</h3> 6898 <p>When using rclone via the API rclone caches created remotes for 5 minutes by default in the "fs cache". This means that if you do repeated actions on the same remote then rclone won't have to build it again from scratch, which makes it more efficient.</p> 6899 <p>This flag sets the time that the remotes are cached for. If you set it to <code>0</code> (or negative) then rclone won't cache the remotes at all.</p> 6900 <p>Note that if you use some flags, eg <code>--backup-dir</code> and if this is set to <code>0</code> rclone may build two remotes (one for the source or destination and one for the <code>--backup-dir</code> where it may have only built one before.</p> 6901 <h3 id="fs-cache-expire-intervaltime">--fs-cache-expire-interval=TIME</h3> 6902 <p>This controls how often rclone checks for cached remotes to expire. See the <code>--fs-cache-expire-duration</code> documentation above for more info. The default is 60s, set to 0 to disable expiry.</p> 6903 <h3 id="header">--header</h3> 6904 <p>Add an HTTP header for all transactions. The flag can be repeated to add multiple headers.</p> 6905 <p>If you want to add headers only for uploads use <code>--header-upload</code> and if you want to add headers only for downloads use <code>--header-download</code>.</p> 6906 <p>This flag is supported for all HTTP based backends even those not supported by <code>--header-upload</code> and <code>--header-download</code> so may be used as a workaround for those with care.</p> 6907 <pre><code>rclone ls remote:test --header "X-Rclone: Foo" --header "X-LetMeIn: Yes"</code></pre> 6908 <h3 id="header-download">--header-download</h3> 6909 <p>Add an HTTP header for all download transactions. The flag can be repeated to add multiple headers.</p> 6910 <pre><code>rclone sync --interactive s3:test/src ~/dst --header-download "X-Amz-Meta-Test: Foo" --header-download "X-Amz-Meta-Test2: Bar"</code></pre> 6911 <p>See the GitHub issue <a href="https://github.com/rclone/rclone/issues/59">here</a> for currently supported backends.</p> 6912 <h3 id="header-upload">--header-upload</h3> 6913 <p>Add an HTTP header for all upload transactions. The flag can be repeated to add multiple headers.</p> 6914 <pre><code>rclone sync --interactive ~/src s3:test/dst --header-upload "Content-Disposition: attachment; filename='cool.html'" --header-upload "X-Amz-Meta-Test: FooBar"</code></pre> 6915 <p>See the GitHub issue <a href="https://github.com/rclone/rclone/issues/59">here</a> for currently supported backends.</p> 6916 <h3 id="human-readable">--human-readable</h3> 6917 <p>Rclone commands output values for sizes (e.g. number of bytes) and counts (e.g. number of files) either as <em>raw</em> numbers, or in <em>human-readable</em> format.</p> 6918 <p>In human-readable format the values are scaled to larger units, indicated with a suffix shown after the value, and rounded to three decimals. Rclone consistently uses binary units (powers of 2) for sizes and decimal units (powers of 10) for counts. The unit prefix for size is according to IEC standard notation, e.g. <code>Ki</code> for kibi. Used with byte unit, <code>1 KiB</code> means 1024 Byte. In list type of output, only the unit prefix appended to the value (e.g. <code>9.762Ki</code>), while in more textual output the full unit is shown (e.g. <code>9.762 KiB</code>). For counts the SI standard notation is used, e.g. prefix <code>k</code> for kilo. Used with file counts, <code>1k</code> means 1000 files.</p> 6919 <p>The various <a href="https://rclone.org/commands/rclone_ls/">list</a> commands output raw numbers by default. Option <code>--human-readable</code> will make them output values in human-readable format instead (with the short unit prefix).</p> 6920 <p>The <a href="https://rclone.org/commands/rclone_about/">about</a> command outputs human-readable by default, with a command-specific option <code>--full</code> to output the raw numbers instead.</p> 6921 <p>Command <a href="https://rclone.org/commands/rclone_size/">size</a> outputs both human-readable and raw numbers in the same output.</p> 6922 <p>The <a href="https://rclone.org/commands/rclone_tree/">tree</a> command also considers <code>--human-readable</code>, but it will not use the exact same notation as the other commands: It rounds to one decimal, and uses single letter suffix, e.g. <code>K</code> instead of <code>Ki</code>. The reason for this is that it relies on an external library.</p> 6923 <p>The interactive command <a href="https://rclone.org/commands/rclone_ncdu/">ncdu</a> shows human-readable by default, and responds to key <code>u</code> for toggling human-readable format.</p> 6924 <h3 id="ignore-case-sync">--ignore-case-sync</h3> 6925 <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> 6926 <h3 id="ignore-checksum">--ignore-checksum</h3> 6927 <p>Normally rclone will check that the checksums of transferred files match, and give an error "corrupted on transfer" if they don't.</p> 6928 <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> 6929 <h3 id="ignore-existing">--ignore-existing</h3> 6930 <p>Using this option will make rclone unconditionally skip all files that exist on the destination, no matter the content of these files.</p> 6931 <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> 6932 <p>When performing a <code>move</code>/<code>moveto</code> command, this flag will leave skipped files in the source location unchanged when a file with the same name exists on the destination.</p> 6933 <h3 id="ignore-size">--ignore-size</h3> 6934 <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> 6935 <p>It will also cause rclone to skip verifying the sizes are the same after transfer.</p> 6936 <p>This can be useful for transferring files to and from OneDrive which occasionally misreports the size of image files (see <a href="https://github.com/rclone/rclone/issues/399">#399</a> for more info).</p> 6937 <h3 id="i---ignore-times">-I, --ignore-times</h3> 6938 <p>Using this option will cause rclone to unconditionally upload all files regardless of the state of files on the destination.</p> 6939 <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> 6940 <h3 id="immutable">--immutable</h3> 6941 <p>Treat source and destination files as immutable and disallow modification.</p> 6942 <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> 6943 <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> 6944 <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> 6945 <h3 id="inplace">--inplace</h3> 6946 <p>The <code>--inplace</code> flag changes the behaviour of rclone when uploading files to some backends (backends with the <code>PartialUploads</code> feature flag set) such as:</p> 6947 <ul> 6948 <li>local</li> 6949 <li>ftp</li> 6950 <li>sftp</li> 6951 </ul> 6952 <p>Without <code>--inplace</code> (the default) rclone will first upload to a temporary file with an extension like this, where <code>XXXXXX</code> represents a random string and <code>.partial</code> is <a href="#partial-suffix">--partial-suffix</a> value (<code>.partial</code> by default).</p> 6953 <pre><code>original-file-name.XXXXXX.partial</code></pre> 6954 <p>(rclone will make sure the final name is no longer than 100 characters by truncating the <code>original-file-name</code> part if necessary).</p> 6955 <p>When the upload is complete, rclone will rename the <code>.partial</code> file to the correct name, overwriting any existing file at that point. If the upload fails then the <code>.partial</code> file will be deleted.</p> 6956 <p>This prevents other users of the backend from seeing partially uploaded files in their new names and prevents overwriting the old file until the new one is completely uploaded.</p> 6957 <p>If the <code>--inplace</code> flag is supplied, rclone will upload directly to the final name without creating a <code>.partial</code> file.</p> 6958 <p>This means that an incomplete file will be visible in the directory listings while the upload is in progress and any existing files will be overwritten as soon as the upload starts. If the transfer fails then the file will be deleted. This can cause data loss of the existing file if the transfer fails.</p> 6959 <p>Note that on the local file system if you don't use <code>--inplace</code> hard links (Unix only) will be broken. And if you do use <code>--inplace</code> you won't be able to update in use executables.</p> 6960 <p>Note also that versions of rclone prior to v1.63.0 behave as if the <code>--inplace</code> flag is always supplied.</p> 6961 <h3 id="interactive">-i, --interactive</h3> 6962 <p>This flag can be used to tell rclone that you wish a manual confirmation before destructive operations.</p> 6963 <p>It is <strong>recommended</strong> that you use this flag while learning rclone especially with <code>rclone sync</code>.</p> 6964 <p>For example</p> 6965 <pre><code>$ rclone delete --interactive /tmp/dir 6966 rclone: delete "important-file.txt"? 6967 y) Yes, this is OK (default) 6968 n) No, skip this 6969 s) Skip all delete operations with no more questions 6970 !) Do all delete operations with no more questions 6971 q) Exit rclone now. 6972 y/n/s/!/q> n</code></pre> 6973 <p>The options mean</p> 6974 <ul> 6975 <li><code>y</code>: <strong>Yes</strong>, this operation should go ahead. You can also press Return for this to happen. You'll be asked every time unless you choose <code>s</code> or <code>!</code>.</li> 6976 <li><code>n</code>: <strong>No</strong>, do not do this operation. You'll be asked every time unless you choose <code>s</code> or <code>!</code>.</li> 6977 <li><code>s</code>: <strong>Skip</strong> all the following operations of this type with no more questions. This takes effect until rclone exits. If there are any different kind of operations you'll be prompted for them.</li> 6978 <li><code>!</code>: <strong>Do all</strong> the following operations with no more questions. Useful if you've decided that you don't mind rclone doing that kind of operation. This takes effect until rclone exits . If there are any different kind of operations you'll be prompted for them.</li> 6979 <li><code>q</code>: <strong>Quit</strong> rclone now, just in case!</li> 6980 </ul> 6981 <h3 id="leave-root">--leave-root</h3> 6982 <p>During rmdirs it will not remove root directory, even if it's empty.</p> 6983 <h3 id="log-filefile">--log-file=FILE</h3> 6984 <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> 6985 <p>If FILE exists then rclone will append to it.</p> 6986 <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> 6987 <h3 id="log-format-list">--log-format LIST</h3> 6988 <p>Comma separated list of log format options. Accepted options are <code>date</code>, <code>time</code>, <code>microseconds</code>, <code>pid</code>, <code>longfile</code>, <code>shortfile</code>, <code>UTC</code>. Any other keywords will be silently ignored. <code>pid</code> will tag log messages with process identifier which useful with <code>rclone mount --daemon</code>. Other accepted options are explained in the <a href="https://pkg.go.dev/log#pkg-constants">go documentation</a>. The default log format is "<code>date</code>,<code>time</code>".</p> 6989 <h3 id="log-level-level">--log-level LEVEL</h3> 6990 <p>This sets the log level for rclone. The default log level is <code>NOTICE</code>.</p> 6991 <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> 6992 <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> 6993 <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> 6994 <p><code>ERROR</code> is equivalent to <code>-q</code>. It only outputs error messages.</p> 6995 <h3 id="use-json-log">--use-json-log</h3> 6996 <p>This switches the log format to JSON for rclone. The fields of json log are level, msg, source, time.</p> 6997 <h3 id="low-level-retries-number">--low-level-retries NUMBER</h3> 6998 <p>This controls the number of low level retries rclone does.</p> 6999 <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> 7000 <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> 7001 <p>Disable low level retries with <code>--low-level-retries 1</code>.</p> 7002 <h3 id="max-backlogn">--max-backlog=N</h3> 7003 <p>This is the maximum allowable backlog of files in a sync/copy/move queued for being checked or transferred.</p> 7004 <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 KiB of memory when the backlog is in use.</p> 7005 <p>Setting this large allows rclone to calculate how many files are pending more accurately, give a more accurate estimated finish time and make <code>--order-by</code> work more accurately.</p> 7006 <p>Setting this small will make rclone more synchronous to the listings of the remote which may be desirable.</p> 7007 <p>Setting this to a negative number will make the backlog as large as possible.</p> 7008 <h3 id="max-deleten">--max-delete=N</h3> 7009 <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> 7010 <h3 id="max-delete-sizesize">--max-delete-size=SIZE</h3> 7011 <p>Rclone will stop deleting files when the total size of deletions has reached the size specified. It defaults to off.</p> 7012 <p>If that limit is exceeded then a fatal error will be generated and rclone will stop the operation in progress.</p> 7013 <h3 id="max-depthn">--max-depth=N</h3> 7014 <p>This modifies the recursion depth for all the commands except purge.</p> 7015 <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> 7016 <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> 7017 <p>You can use this command to disable recursion (with <code>--max-depth 1</code>).</p> 7018 <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> 7019 <h3 id="max-durationtime">--max-duration=TIME</h3> 7020 <p>Rclone will stop transferring when it has run for the duration specified. Defaults to off.</p> 7021 <p>When the limit is reached all transfers will stop immediately. Use <code>--cutoff-mode</code> to modify this behaviour.</p> 7022 <p>Rclone will exit with exit code 10 if the duration limit is reached.</p> 7023 <h3 id="max-transfersize">--max-transfer=SIZE</h3> 7024 <p>Rclone will stop transferring when it has reached the size specified. Defaults to off.</p> 7025 <p>When the limit is reached all transfers will stop immediately. Use <code>--cutoff-mode</code> to modify this behaviour.</p> 7026 <p>Rclone will exit with exit code 8 if the transfer limit is reached.</p> 7027 <h3 id="cutoff-modehardsoftcautious">--cutoff-mode=hard|soft|cautious</h3> 7028 <p>This modifies the behavior of <code>--max-transfer</code> and <code>--max-duration</code> Defaults to <code>--cutoff-mode=hard</code>.</p> 7029 <p>Specifying <code>--cutoff-mode=hard</code> will stop transferring immediately when Rclone reaches the limit.</p> 7030 <p>Specifying <code>--cutoff-mode=soft</code> will stop starting new transfers when Rclone reaches the limit.</p> 7031 <p>Specifying <code>--cutoff-mode=cautious</code> will try to prevent Rclone from reaching the limit. Only applicable for <code>--max-transfer</code></p> 7032 <h2 id="m---metadata">-M, --metadata</h2> 7033 <p>Setting this flag enables rclone to copy the metadata from the source to the destination. For local backends this is ownership, permissions, xattr etc. See the <a href="#metadata">metadata section</a> for more info.</p> 7034 <h3 id="metadata-mapper">--metadata-mapper SpaceSepList</h3> 7035 <p>If you supply the parameter <code>--metadata-mapper /path/to/program</code> then rclone will use that program to map metadata from source object to destination object.</p> 7036 <p>The argument to this flag should be a command with an optional space separated list of arguments. If one of the arguments has a space in then enclose it in <code>"</code>, if you want a literal <code>"</code> in an argument then enclose the argument in <code>"</code> and double the <code>"</code>. See <a href="https://godoc.org/encoding/csv">CSV encoding</a> for more info.</p> 7037 <pre><code>--metadata-mapper "python bin/test_metadata_mapper.py" 7038 --metadata-mapper 'python bin/test_metadata_mapper.py "argument with a space"' 7039 --metadata-mapper 'python bin/test_metadata_mapper.py "argument with ""two"" quotes"'</code></pre> 7040 <p>This uses a simple JSON based protocol with input on STDIN and output on STDOUT. This will be called for every file and directory copied and may be called concurrently.</p> 7041 <p>The program's job is to take a metadata blob on the input and turn it into a metadata blob on the output suitable for the destination backend.</p> 7042 <p>Input to the program (via STDIN) might look like this. This provides some context for the <code>Metadata</code> which may be important.</p> 7043 <ul> 7044 <li><code>SrcFs</code> is the config string for the remote that the object is currently on.</li> 7045 <li><code>SrcFsType</code> is the name of the source backend.</li> 7046 <li><code>DstFs</code> is the config string for the remote that the object is being copied to</li> 7047 <li><code>DstFsType</code> is the name of the destination backend.</li> 7048 <li><code>Remote</code> is the path of the object relative to the root.</li> 7049 <li><code>Size</code>, <code>MimeType</code>, <code>ModTime</code> are attributes of the object.</li> 7050 <li><code>IsDir</code> is <code>true</code> if this is a directory (not yet implemented).</li> 7051 <li><code>ID</code> is the source <code>ID</code> of the object if known.</li> 7052 <li><code>Metadata</code> is the backend specific metadata as described in the backend docs.</li> 7053 </ul> 7054 <div class="sourceCode" id="cb584"><pre class="sourceCode json"><code class="sourceCode json"><span id="cb584-1"><a href="#cb584-1" aria-hidden="true"></a><span class="fu">{</span></span> 7055 <span id="cb584-2"><a href="#cb584-2" aria-hidden="true"></a> <span class="dt">"SrcFs"</span><span class="fu">:</span> <span class="st">"gdrive:"</span><span class="fu">,</span></span> 7056 <span id="cb584-3"><a href="#cb584-3" aria-hidden="true"></a> <span class="dt">"SrcFsType"</span><span class="fu">:</span> <span class="st">"drive"</span><span class="fu">,</span></span> 7057 <span id="cb584-4"><a href="#cb584-4" aria-hidden="true"></a> <span class="dt">"DstFs"</span><span class="fu">:</span> <span class="st">"newdrive:user"</span><span class="fu">,</span></span> 7058 <span id="cb584-5"><a href="#cb584-5" aria-hidden="true"></a> <span class="dt">"DstFsType"</span><span class="fu">:</span> <span class="st">"onedrive"</span><span class="fu">,</span></span> 7059 <span id="cb584-6"><a href="#cb584-6" aria-hidden="true"></a> <span class="dt">"Remote"</span><span class="fu">:</span> <span class="st">"test.txt"</span><span class="fu">,</span></span> 7060 <span id="cb584-7"><a href="#cb584-7" aria-hidden="true"></a> <span class="dt">"Size"</span><span class="fu">:</span> <span class="dv">6</span><span class="fu">,</span></span> 7061 <span id="cb584-8"><a href="#cb584-8" aria-hidden="true"></a> <span class="dt">"MimeType"</span><span class="fu">:</span> <span class="st">"text/plain; charset=utf-8"</span><span class="fu">,</span></span> 7062 <span id="cb584-9"><a href="#cb584-9" aria-hidden="true"></a> <span class="dt">"ModTime"</span><span class="fu">:</span> <span class="st">"2022-10-11T17:53:10.286745272+01:00"</span><span class="fu">,</span></span> 7063 <span id="cb584-10"><a href="#cb584-10" aria-hidden="true"></a> <span class="dt">"IsDir"</span><span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span></span> 7064 <span id="cb584-11"><a href="#cb584-11" aria-hidden="true"></a> <span class="dt">"ID"</span><span class="fu">:</span> <span class="st">"xyz"</span><span class="fu">,</span></span> 7065 <span id="cb584-12"><a href="#cb584-12" aria-hidden="true"></a> <span class="dt">"Metadata"</span><span class="fu">:</span> <span class="fu">{</span></span> 7066 <span id="cb584-13"><a href="#cb584-13" aria-hidden="true"></a> <span class="dt">"btime"</span><span class="fu">:</span> <span class="st">"2022-10-11T16:53:11Z"</span><span class="fu">,</span></span> 7067 <span id="cb584-14"><a href="#cb584-14" aria-hidden="true"></a> <span class="dt">"content-type"</span><span class="fu">:</span> <span class="st">"text/plain; charset=utf-8"</span><span class="fu">,</span></span> 7068 <span id="cb584-15"><a href="#cb584-15" aria-hidden="true"></a> <span class="dt">"mtime"</span><span class="fu">:</span> <span class="st">"2022-10-11T17:53:10.286745272+01:00"</span><span class="fu">,</span></span> 7069 <span id="cb584-16"><a href="#cb584-16" aria-hidden="true"></a> <span class="dt">"owner"</span><span class="fu">:</span> <span class="st">"user1@domain1.com"</span><span class="fu">,</span></span> 7070 <span id="cb584-17"><a href="#cb584-17" aria-hidden="true"></a> <span class="dt">"permissions"</span><span class="fu">:</span> <span class="st">"..."</span><span class="fu">,</span></span> 7071 <span id="cb584-18"><a href="#cb584-18" aria-hidden="true"></a> <span class="dt">"description"</span><span class="fu">:</span> <span class="st">"my nice file"</span><span class="fu">,</span></span> 7072 <span id="cb584-19"><a href="#cb584-19" aria-hidden="true"></a> <span class="dt">"starred"</span><span class="fu">:</span> <span class="st">"false"</span></span> 7073 <span id="cb584-20"><a href="#cb584-20" aria-hidden="true"></a> <span class="fu">}</span></span> 7074 <span id="cb584-21"><a href="#cb584-21" aria-hidden="true"></a><span class="fu">}</span></span></code></pre></div> 7075 <p>The program should then modify the input as desired and send it to STDOUT. The returned <code>Metadata</code> field will be used in its entirety for the destination object. Any other fields will be ignored. Note in this example we translate user names and permissions and add something to the description:</p> 7076 <div class="sourceCode" id="cb585"><pre class="sourceCode json"><code class="sourceCode json"><span id="cb585-1"><a href="#cb585-1" aria-hidden="true"></a><span class="fu">{</span></span> 7077 <span id="cb585-2"><a href="#cb585-2" aria-hidden="true"></a> <span class="dt">"Metadata"</span><span class="fu">:</span> <span class="fu">{</span></span> 7078 <span id="cb585-3"><a href="#cb585-3" aria-hidden="true"></a> <span class="dt">"btime"</span><span class="fu">:</span> <span class="st">"2022-10-11T16:53:11Z"</span><span class="fu">,</span></span> 7079 <span id="cb585-4"><a href="#cb585-4" aria-hidden="true"></a> <span class="dt">"content-type"</span><span class="fu">:</span> <span class="st">"text/plain; charset=utf-8"</span><span class="fu">,</span></span> 7080 <span id="cb585-5"><a href="#cb585-5" aria-hidden="true"></a> <span class="dt">"mtime"</span><span class="fu">:</span> <span class="st">"2022-10-11T17:53:10.286745272+01:00"</span><span class="fu">,</span></span> 7081 <span id="cb585-6"><a href="#cb585-6" aria-hidden="true"></a> <span class="dt">"owner"</span><span class="fu">:</span> <span class="st">"user1@domain2.com"</span><span class="fu">,</span></span> 7082 <span id="cb585-7"><a href="#cb585-7" aria-hidden="true"></a> <span class="dt">"permissions"</span><span class="fu">:</span> <span class="st">"..."</span><span class="fu">,</span></span> 7083 <span id="cb585-8"><a href="#cb585-8" aria-hidden="true"></a> <span class="dt">"description"</span><span class="fu">:</span> <span class="st">"my nice file [migrated from domain1]"</span><span class="fu">,</span></span> 7084 <span id="cb585-9"><a href="#cb585-9" aria-hidden="true"></a> <span class="dt">"starred"</span><span class="fu">:</span> <span class="st">"false"</span></span> 7085 <span id="cb585-10"><a href="#cb585-10" aria-hidden="true"></a> <span class="fu">}</span></span> 7086 <span id="cb585-11"><a href="#cb585-11" aria-hidden="true"></a><span class="fu">}</span></span></code></pre></div> 7087 <p>Metadata can be removed here too.</p> 7088 <p>An example python program might look something like this to implement the above transformations.</p> 7089 <div class="sourceCode" id="cb586"><pre class="sourceCode python"><code class="sourceCode python"><span id="cb586-1"><a href="#cb586-1" aria-hidden="true"></a><span class="im">import</span> sys, json</span> 7090 <span id="cb586-2"><a href="#cb586-2" aria-hidden="true"></a></span> 7091 <span id="cb586-3"><a href="#cb586-3" aria-hidden="true"></a>i <span class="op">=</span> json.load(sys.stdin)</span> 7092 <span id="cb586-4"><a href="#cb586-4" aria-hidden="true"></a>metadata <span class="op">=</span> i[<span class="st">"Metadata"</span>]</span> 7093 <span id="cb586-5"><a href="#cb586-5" aria-hidden="true"></a><span class="co"># Add tag to description</span></span> 7094 <span id="cb586-6"><a href="#cb586-6" aria-hidden="true"></a><span class="cf">if</span> <span class="st">"description"</span> <span class="kw">in</span> metadata:</span> 7095 <span id="cb586-7"><a href="#cb586-7" aria-hidden="true"></a> metadata[<span class="st">"description"</span>] <span class="op">+=</span> <span class="st">" [migrated from domain1]"</span></span> 7096 <span id="cb586-8"><a href="#cb586-8" aria-hidden="true"></a><span class="cf">else</span>:</span> 7097 <span id="cb586-9"><a href="#cb586-9" aria-hidden="true"></a> metadata[<span class="st">"description"</span>] <span class="op">=</span> <span class="st">"[migrated from domain1]"</span></span> 7098 <span id="cb586-10"><a href="#cb586-10" aria-hidden="true"></a><span class="co"># Modify owner</span></span> 7099 <span id="cb586-11"><a href="#cb586-11" aria-hidden="true"></a><span class="cf">if</span> <span class="st">"owner"</span> <span class="kw">in</span> metadata:</span> 7100 <span id="cb586-12"><a href="#cb586-12" aria-hidden="true"></a> metadata[<span class="st">"owner"</span>] <span class="op">=</span> metadata[<span class="st">"owner"</span>].replace(<span class="st">"domain1.com"</span>, <span class="st">"domain2.com"</span>)</span> 7101 <span id="cb586-13"><a href="#cb586-13" aria-hidden="true"></a>o <span class="op">=</span> { <span class="st">"Metadata"</span>: metadata }</span> 7102 <span id="cb586-14"><a href="#cb586-14" aria-hidden="true"></a>json.dump(o, sys.stdout, indent<span class="op">=</span><span class="st">"</span><span class="ch">\t</span><span class="st">"</span>)</span></code></pre></div> 7103 <p>You can find this example (slightly expanded) in the rclone source code at <a href="https://github.com/rclone/rclone/blob/master/bin/test_metadata_mapper.py">bin/test_metadata_mapper.py</a>.</p> 7104 <p>If you want to see the input to the metadata mapper and the output returned from it in the log you can use <code>-vv --dump mapper</code>.</p> 7105 <p>See the <a href="#metadata">metadata section</a> for more info.</p> 7106 <h3 id="metadata-set-keyvalue">--metadata-set key=value</h3> 7107 <p>Add metadata <code>key</code> = <code>value</code> when uploading. This can be repeated as many times as required. See the <a href="#metadata">metadata section</a> for more info.</p> 7108 <h3 id="modify-windowtime">--modify-window=TIME</h3> 7109 <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> 7110 <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> 7111 <p>This command line flag allows you to override that computed default.</p> 7112 <h3 id="multi-thread-write-buffer-sizesize">--multi-thread-write-buffer-size=SIZE</h3> 7113 <p>When transferring with multiple threads, rclone will buffer SIZE bytes in memory before writing to disk for each thread.</p> 7114 <p>This can improve performance if the underlying filesystem does not deal well with a lot of small writes in different positions of the file, so if you see transfers being limited by disk write speed, you might want to experiment with different values. Specially for magnetic drives and remote file systems a higher value can be useful.</p> 7115 <p>Nevertheless, the default of <code>128k</code> should be fine for almost all use cases, so before changing it ensure that network is not really your bottleneck.</p> 7116 <p>As a final hint, size is not the only factor: block size (or similar concept) can have an impact. In one case, we observed that exact multiples of 16k performed much better than other values.</p> 7117 <h3 id="multi-thread-chunk-sizesizesuffix">--multi-thread-chunk-size=SizeSuffix</h3> 7118 <p>Normally the chunk size for multi thread transfers is set by the backend. However some backends such as <code>local</code> and <code>smb</code> (which implement <code>OpenWriterAt</code> but not <code>OpenChunkWriter</code>) don't have a natural chunk size.</p> 7119 <p>In this case the value of this option is used (default 64Mi).</p> 7120 <h3 id="multi-thread-cutoff">--multi-thread-cutoff=SIZE</h3> 7121 <p>When transferring files above SIZE to capable backends, rclone will use multiple threads to transfer the file (default 256M).</p> 7122 <p>Capable backends are marked in the <a href="https://rclone.org/overview/#optional-features">overview</a> as <code>MultithreadUpload</code>. (They need to implement either the <code>OpenWriterAt</code> or <code>OpenChunkWriter</code> internal interfaces). These include include, <code>local</code>, <code>s3</code>, <code>azureblob</code>, <code>b2</code>, <code>oracleobjectstorage</code> and <code>smb</code> at the time of writing.</p> 7123 <p>On the local disk, 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> 7124 <p>The number of threads used to transfer is controlled by <code>--multi-thread-streams</code>.</p> 7125 <p>Use <code>-vv</code> if you wish to see info about the threads.</p> 7126 <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 transfers 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> 7127 <p><strong>NB</strong> that this <strong>only</strong> works with supported backends as the destination but will work with any backend as the source.</p> 7128 <p><strong>NB</strong> that multi-thread copies are disabled for local to local copies as they are faster without unless <code>--multi-thread-streams</code> is set explicitly.</p> 7129 <p><strong>NB</strong> on Windows using multi-thread transfers to the local disk will cause the resulting files to be <a href="https://en.wikipedia.org/wiki/Sparse_file">sparse</a>. Use <code>--local-no-sparse</code> to disable sparse files (which may cause long delays at the start of transfers) or disable multi-thread transfers with <code>--multi-thread-streams 0</code></p> 7130 <h3 id="multi-thread-streamsn">--multi-thread-streams=N</h3> 7131 <p>When using multi thread transfers (see above <code>--multi-thread-cutoff</code>) this sets the number of streams to use. Set to <code>0</code> to disable multi thread transfers (Default 4).</p> 7132 <p>If the backend has a <code>--backend-upload-concurrency</code> setting (eg <code>--s3-upload-concurrency</code>) then this setting will be used as the number of transfers instead if it is larger than the value of <code>--multi-thread-streams</code> or <code>--multi-thread-streams</code> isn't set.</p> 7133 <h3 id="no-check-dest">--no-check-dest</h3> 7134 <p>The <code>--no-check-dest</code> can be used with <code>move</code> or <code>copy</code> and it causes rclone not to check the destination at all when copying files.</p> 7135 <p>This means that:</p> 7136 <ul> 7137 <li>the destination is not listed minimising the API calls</li> 7138 <li>files are always transferred</li> 7139 <li>this can cause duplicates on remotes which allow it (e.g. Google Drive)</li> 7140 <li><code>--retries 1</code> is recommended otherwise you'll transfer everything again on a retry</li> 7141 </ul> 7142 <p>This flag is useful to minimise the transactions if you know that none of the files are on the destination.</p> 7143 <p>This is a specialized flag which should be ignored by most users!</p> 7144 <h3 id="no-gzip-encoding">--no-gzip-encoding</h3> 7145 <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> 7146 <p>There is no need to set this in normal operation, and doing so will decrease the network transfer efficiency of rclone.</p> 7147 <h3 id="no-traverse">--no-traverse</h3> 7148 <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> 7149 <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> 7150 <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> 7151 <p>See <a href="https://rclone.org/commands/rclone_copy/">rclone copy</a> for an example of how to use it.</p> 7152 <h3 id="no-unicode-normalization">--no-unicode-normalization</h3> 7153 <p>Don't normalize unicode characters in filenames during the sync routine.</p> 7154 <p>Sometimes, an operating system will store filenames containing unicode parts in their decomposed form (particularly macOS). Some cloud storage systems will then recompose the unicode, resulting in duplicate files if the data is ever copied back to a local filesystem.</p> 7155 <p>Using this flag will disable that functionality, treating each unicode character as unique. For example, by default é and é will be normalized into the same character. With <code>--no-unicode-normalization</code> they will be treated as unique characters.</p> 7156 <h3 id="no-update-modtime">--no-update-modtime</h3> 7157 <p>When using this flag, rclone won't update modification times of remote files if they are incorrect as it would normally.</p> 7158 <p>This can be used if the remote is being synced with another tool also (e.g. the Google Drive client).</p> 7159 <h3 id="no-update-dir-modtime">--no-update-dir-modtime</h3> 7160 <p>When using this flag, rclone won't update modification times of remote directories if they are incorrect as it would normally.</p> 7161 <h3 id="order-by-string">--order-by string</h3> 7162 <p>The <code>--order-by</code> flag controls the order in which files in the backlog are processed in <code>rclone sync</code>, <code>rclone copy</code> and <code>rclone move</code>.</p> 7163 <p>The order by string is constructed like this. The first part describes what aspect is being measured:</p> 7164 <ul> 7165 <li><code>size</code> - order by the size of the files</li> 7166 <li><code>name</code> - order by the full path of the files</li> 7167 <li><code>modtime</code> - order by the modification date of the files</li> 7168 </ul> 7169 <p>This can have a modifier appended with a comma:</p> 7170 <ul> 7171 <li><code>ascending</code> or <code>asc</code> - order so that the smallest (or oldest) is processed first</li> 7172 <li><code>descending</code> or <code>desc</code> - order so that the largest (or newest) is processed first</li> 7173 <li><code>mixed</code> - order so that the smallest is processed first for some threads and the largest for others</li> 7174 </ul> 7175 <p>If the modifier is <code>mixed</code> then it can have an optional percentage (which defaults to <code>50</code>), e.g. <code>size,mixed,25</code> which means that 25% of the threads should be taking the smallest items and 75% the largest. The threads which take the smallest first will always take the smallest first and likewise the largest first threads. The <code>mixed</code> mode can be useful to minimise the transfer time when you are transferring a mixture of large and small files - the large files are guaranteed upload threads and bandwidth and the small files will be processed continuously.</p> 7176 <p>If no modifier is supplied then the order is <code>ascending</code>.</p> 7177 <p>For example</p> 7178 <ul> 7179 <li><code>--order-by size,desc</code> - send the largest files first</li> 7180 <li><code>--order-by modtime,ascending</code> - send the oldest files first</li> 7181 <li><code>--order-by name</code> - send the files with alphabetically by path first</li> 7182 </ul> 7183 <p>If the <code>--order-by</code> flag is not supplied or it is supplied with an empty string then the default ordering will be used which is as scanned. With <code>--checkers 1</code> this is mostly alphabetical, however with the default <code>--checkers 8</code> it is somewhat random.</p> 7184 <h4 id="limitations-3">Limitations</h4> 7185 <p>The <code>--order-by</code> flag does not do a separate pass over the data. This means that it may transfer some files out of the order specified if</p> 7186 <ul> 7187 <li>there are no files in the backlog or the source has not been fully scanned yet</li> 7188 <li>there are more than <a href="#max-backlog-n">--max-backlog</a> files in the backlog</li> 7189 </ul> 7190 <p>Rclone will do its best to transfer the best file it has so in practice this should not cause a problem. Think of <code>--order-by</code> as being more of a best efforts flag rather than a perfect ordering.</p> 7191 <p>If you want perfect ordering then you will need to specify <a href="#check-first">--check-first</a> which will find all the files which need transferring first before transferring any.</p> 7192 <h3 id="partial-suffix">--partial-suffix</h3> 7193 <p>When <a href="#inplace">--inplace</a> is not used, it causes rclone to use the <code>--partial-suffix</code> as suffix for temporary files.</p> 7194 <p>Suffix length limit is 16 characters.</p> 7195 <p>The default is <code>.partial</code>.</p> 7196 <h3 id="password-command-spaceseplist">--password-command SpaceSepList</h3> 7197 <p>This flag supplies a program which should supply the config password when run. This is an alternative to rclone prompting for the password or setting the <code>RCLONE_CONFIG_PASS</code> variable.</p> 7198 <p>The argument to this should be a command with a space separated list of arguments. If one of the arguments has a space in then enclose it in <code>"</code>, if you want a literal <code>"</code> in an argument then enclose the argument in <code>"</code> and double the <code>"</code>. See <a href="https://godoc.org/encoding/csv">CSV encoding</a> for more info.</p> 7199 <p>Eg</p> 7200 <pre><code>--password-command "echo hello" 7201 --password-command 'echo "hello with space"' 7202 --password-command 'echo "hello with ""quotes"" and space"'</code></pre> 7203 <p>See the <a href="#configuration-encryption">Configuration Encryption</a> for more info.</p> 7204 <p>See a <a href="https://github.com/rclone/rclone/wiki/Windows-Powershell-use-rclone-password-command-for-Config-file-password">Windows PowerShell example on the Wiki</a>.</p> 7205 <h3 id="p---progress">-P, --progress</h3> 7206 <p>This flag makes rclone update the stats in a static block in the terminal providing a realtime overview of the transfer.</p> 7207 <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> 7208 <p>Normally this is updated every 500mS but this period can be overridden with the <code>--stats</code> flag.</p> 7209 <p>This can be used with the <code>--stats-one-line</code> flag for a simpler display.</p> 7210 <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> 7211 <h3 id="progress-terminal-title">--progress-terminal-title</h3> 7212 <p>This flag, when used with <code>-P/--progress</code>, will print the string <code>ETA: %s</code> to the terminal title.</p> 7213 <h3 id="q---quiet">-q, --quiet</h3> 7214 <p>This flag will limit rclone's output to error messages only.</p> 7215 <h3 id="refresh-times">--refresh-times</h3> 7216 <p>The <code>--refresh-times</code> flag can be used to update modification times of existing files when they are out of sync on backends which don't support hashes.</p> 7217 <p>This is useful if you uploaded files with the incorrect timestamps and you now wish to correct them.</p> 7218 <p>This flag is <strong>only</strong> useful for destinations which don't support hashes (e.g. <code>crypt</code>).</p> 7219 <p>This can be used any of the sync commands <code>sync</code>, <code>copy</code> or <code>move</code>.</p> 7220 <p>To use this flag you will need to be doing a modification time sync (so not using <code>--size-only</code> or <code>--checksum</code>). The flag will have no effect when using <code>--size-only</code> or <code>--checksum</code>.</p> 7221 <p>If this flag is used when rclone comes to upload a file it will check to see if there is an existing file on the destination. If this file matches the source with size (and checksum if available) but has a differing timestamp then instead of re-uploading it, rclone will update the timestamp on the destination file. If the checksum does not match rclone will upload the new file. If the checksum is absent (e.g. on a <code>crypt</code> backend) then rclone will update the timestamp.</p> 7222 <p>Note that some remotes can't set the modification time without re-uploading the file so this flag is less useful on them.</p> 7223 <p>Normally if you are doing a modification time sync rclone will update modification times without <code>--refresh-times</code> provided that the remote supports checksums <strong>and</strong> the checksums match on the file. However if the checksums are absent then rclone will upload the file rather than setting the timestamp as this is the safe behaviour.</p> 7224 <h3 id="retries-int">--retries int</h3> 7225 <p>Retry the entire sync if it fails this many times it fails (default 3).</p> 7226 <p>Some remotes can be unreliable and a few retries help pick up the files which didn't get transferred because of errors.</p> 7227 <p>Disable retries with <code>--retries 1</code>.</p> 7228 <h3 id="retries-sleeptime">--retries-sleep=TIME</h3> 7229 <p>This sets the interval between each retry specified by <code>--retries</code></p> 7230 <p>The default is <code>0</code>. Use <code>0</code> to disable.</p> 7231 <h3 id="server-side-across-configs">--server-side-across-configs</h3> 7232 <p>Allow server-side operations (e.g. copy or move) to work across different configurations.</p> 7233 <p>This can be useful if you wish to do a server-side copy or move between two remotes which use the same backend but are configured differently.</p> 7234 <p>Note that this isn't enabled by default because it isn't easy for rclone to tell if it will work between any two configurations.</p> 7235 <h3 id="size-only">--size-only</h3> 7236 <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> 7237 <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> 7238 <h3 id="statstime">--stats=TIME</h3> 7239 <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> 7240 <p>This sets the interval.</p> 7241 <p>The default is <code>1m</code>. Use <code>0</code> to disable.</p> 7242 <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> 7243 <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> 7244 <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> 7245 <h3 id="stats-file-name-length-integer">--stats-file-name-length integer</h3> 7246 <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> 7247 <h3 id="stats-log-level-string">--stats-log-level string</h3> 7248 <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> 7249 <h3 id="stats-one-line">--stats-one-line</h3> 7250 <p>When this is specified, rclone condenses the stats into a single line showing the most important stats only.</p> 7251 <h3 id="stats-one-line-date">--stats-one-line-date</h3> 7252 <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> 7253 <h3 id="stats-one-line-date-format">--stats-one-line-date-format</h3> 7254 <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> 7255 <h3 id="stats-unitbitsbytes">--stats-unit=bits|bytes</h3> 7256 <p>By default, data transfer rates will be printed in bytes per second.</p> 7257 <p>This option allows the data rate to be printed in bits per second.</p> 7258 <p>Data transfer volume will still be reported in bytes.</p> 7259 <p>The rate is reported as a binary unit, not SI unit. So 1 Mbit/s equals 1,048,576 bit/s and not 1,000,000 bit/s.</p> 7260 <p>The default is <code>bytes</code>.</p> 7261 <h3 id="suffixsuffix">--suffix=SUFFIX</h3> 7262 <p>When using <code>sync</code>, <code>copy</code> or <code>move</code> any files which would have been overwritten or deleted will have the suffix added to them. If there is a file with the same path (after the suffix has been added), then it will be overwritten.</p> 7263 <p>The remote in use must support server-side move or copy and you must use the same remote as the destination of the sync.</p> 7264 <p>This is for use with files to add the suffix in the current directory or with <code>--backup-dir</code>. See <code>--backup-dir</code> for more info.</p> 7265 <p>For example</p> 7266 <pre><code>rclone copy --interactive /path/to/local/file remote:current --suffix .bak</code></pre> 7267 <p>will copy <code>/path/to/local</code> to <code>remote:current</code>, but for any files which would have been updated or deleted have .bak added.</p> 7268 <p>If using <code>rclone sync</code> with <code>--suffix</code> and without <code>--backup-dir</code> then it is recommended to put a filter rule in excluding the suffix otherwise the <code>sync</code> will delete the backup files.</p> 7269 <pre><code>rclone sync --interactive /path/to/local/file remote:current --suffix .bak --exclude "*.bak"</code></pre> 7270 <h3 id="suffix-keep-extension">--suffix-keep-extension</h3> 7271 <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> 7272 <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> 7273 <p>If a file has two (or more) extensions and the second (or subsequent) extension is recognised as a valid mime type, then the suffix will go before that extension. So <code>file.tar.gz</code> would be backed up to <code>file-2019-01-01.tar.gz</code> whereas <code>file.badextension.gz</code> would be backed up to <code>file.badextension-2019-01-01.gz</code>.</p> 7274 <h3 id="syslog">--syslog</h3> 7275 <p>On capable OSes (not Windows or Plan9) send all log output to syslog.</p> 7276 <p>This can be useful for running rclone in a script or <code>rclone mount</code>.</p> 7277 <h3 id="syslog-facility-string">--syslog-facility string</h3> 7278 <p>If using <code>--syslog</code> this sets the syslog facility (e.g. <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> 7279 <h3 id="temp-dirdir">--temp-dir=DIR</h3> 7280 <p>Specify the directory rclone will use for temporary files, to override the default. Make sure the directory exists and have accessible permissions.</p> 7281 <p>By default the operating system's temp directory will be used: - On Unix systems, <code>$TMPDIR</code> if non-empty, else <code>/tmp</code>. - On Windows, the first non-empty value from <code>%TMP%</code>, <code>%TEMP%</code>, <code>%USERPROFILE%</code>, or the Windows directory.</p> 7282 <p>When overriding the default with this option, the specified path will be set as value of environment variable <code>TMPDIR</code> on Unix systems and <code>TMP</code> and <code>TEMP</code> on Windows.</p> 7283 <p>You can use the <a href="https://rclone.org/commands/rclone_config_paths/">config paths</a> command to see the current value.</p> 7284 <h3 id="tpslimit-float">--tpslimit float</h3> 7285 <p>Limit transactions per second to this number. Default is 0 which is used to mean unlimited transactions per second.</p> 7286 <p>A transaction is roughly defined as an API call; its exact meaning will depend on the backend. For HTTP based backends it is an HTTP PUT/GET/POST/etc and its response. For FTP/SFTP it is a round trip transaction over TCP.</p> 7287 <p>For example, to limit rclone to 10 transactions per second use <code>--tpslimit 10</code>, or to 1 transaction every 2 seconds use <code>--tpslimit 0.5</code>.</p> 7288 <p>Use this when the number of transactions per second from rclone is causing a problem with the cloud storage provider (e.g. getting you banned or rate limited).</p> 7289 <p>This can be very useful for <code>rclone mount</code> to control the behaviour of applications using it.</p> 7290 <p>This limit applies to all HTTP based backends and to the FTP and SFTP backends. It does not apply to the local backend or the Storj backend.</p> 7291 <p>See also <code>--tpslimit-burst</code>.</p> 7292 <h3 id="tpslimit-burst-int">--tpslimit-burst int</h3> 7293 <p>Max burst of transactions for <code>--tpslimit</code> (default <code>1</code>).</p> 7294 <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> 7295 <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> 7296 <p>This may be used to increase performance of <code>--tpslimit</code> without changing the long term average number of transactions per second.</p> 7297 <h3 id="track-renames">--track-renames</h3> 7298 <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> 7299 <p>An rclone sync with <code>--track-renames</code> runs like a normal sync, but keeps track of objects which exist in the destination but not in the source (which would normally be deleted), and which objects exist in the source but not the destination (which would normally be transferred). These objects are then candidates for renaming.</p> 7300 <p>After the sync, rclone matches up the source only and destination only objects using the <code>--track-renames-strategy</code> specified and either renames the destination object or transfers the source and deletes the destination object. <code>--track-renames</code> is stateless like all of rclone's syncs.</p> 7301 <p>To use this flag the destination must support server-side copy or server-side move, and to use a hash based <code>--track-renames-strategy</code> (the default) the source and the destination must have a compatible hash.</p> 7302 <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.</p> 7303 <p>Encrypted destinations are not currently supported by <code>--track-renames</code> if <code>--track-renames-strategy</code> includes <code>hash</code>.</p> 7304 <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> 7305 <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> 7306 <h3 id="track-renames-strategy-hashmodtimeleafsize">--track-renames-strategy (hash,modtime,leaf,size)</h3> 7307 <p>This option changes the file matching criteria for <code>--track-renames</code>.</p> 7308 <p>The matching is controlled by a comma separated selection of these tokens:</p> 7309 <ul> 7310 <li><code>modtime</code> - the modification time of the file - not supported on all backends</li> 7311 <li><code>hash</code> - the hash of the file contents - not supported on all backends</li> 7312 <li><code>leaf</code> - the name of the file not including its directory name</li> 7313 <li><code>size</code> - the size of the file (this is always enabled)</li> 7314 </ul> 7315 <p>The default option is <code>hash</code>.</p> 7316 <p>Using <code>--track-renames-strategy modtime,leaf</code> would match files based on modification time, the leaf of the file name and the size only.</p> 7317 <p>Using <code>--track-renames-strategy modtime</code> or <code>leaf</code> can enable <code>--track-renames</code> support for encrypted destinations.</p> 7318 <p>Note that the <code>hash</code> strategy is not supported with encrypted destinations.</p> 7319 <h3 id="delete-beforeduringafter">--delete-(before,during,after)</h3> 7320 <p>This option allows you to specify when files on your destination are deleted when you sync folders.</p> 7321 <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> 7322 <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> 7323 <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> 7324 <h3 id="fast-list">--fast-list</h3> 7325 <p>When doing anything which involves a directory listing (e.g. <code>sync</code>, <code>copy</code>, <code>ls</code> - in fact nearly every command), rclone has different strategies to choose from.</p> 7326 <p>The basic strategy is to list one directory and processes it before using more directory lists to process any subdirectories. This is a mandatory backend feature, called <code>List</code>, which means it is supported by all backends. This strategy uses small amount of memory, and because it can be parallelised it is fast for operations involving processing of the list results.</p> 7327 <p>Some backends provide the support for an alternative strategy, where all files beneath a directory can be listed in one (or a small number) of transactions. Rclone supports this alternative strategy through an optional backend feature called <a href="https://rclone.org/overview/#listr"><code>ListR</code></a>. You can see in the storage system overview documentation's <a href="https://rclone.org/overview/#optional-features">optional features</a> section which backends it is enabled for (these tend to be the bucket-based ones, e.g. S3, B2, GCS, Swift). This strategy requires fewer transactions for highly recursive operations, which is important on backends where this is charged or heavily rate limited. It may be faster (due to fewer transactions) or slower (because it can't be parallelized) depending on different parameters, and may require more memory if rclone has to keep the whole listing in memory.</p> 7328 <p>Which listing strategy rclone picks for a given operation is complicated, but in general it tries to choose the best possible. It will prefer <code>ListR</code> in situations where it doesn't need to store the listed files in memory, e.g. for unlimited recursive <code>ls</code> command variants. In other situations it will prefer <code>List</code>, e.g. for <code>sync</code> and <code>copy</code>, where it needs to keep the listed files in memory, and is performing operations on them where parallelization may be a huge advantage.</p> 7329 <p>Rclone is not able to take all relevant parameters into account for deciding the best strategy, and therefore allows you to influence the choice in two ways: You can stop rclone from using <code>ListR</code> by disabling the feature, using the <a href="#disable-feature-feature">--disable</a> option (<code>--disable ListR</code>), or you can allow rclone to use <code>ListR</code> where it would normally choose not to do so due to higher memory usage, using the <code>--fast-list</code> option. Rclone should always produce identical results either way. Using <code>--disable ListR</code> or <code>--fast-list</code> on a remote which doesn't support <code>ListR</code> does nothing, rclone will just ignore it.</p> 7330 <p>A rule of thumb is that 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. Run some tests and compare before you decide, and if in doubt then just leave the default, let rclone decide, i.e. not use <code>--fast-list</code>.</p> 7331 <h3 id="timeouttime">--timeout=TIME</h3> 7332 <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> 7333 <p>The default is <code>5m</code>. Set to <code>0</code> to disable.</p> 7334 <h3 id="transfersn">--transfers=N</h3> 7335 <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> 7336 <p>The default is to run 4 file transfers in parallel.</p> 7337 <p>Look at --multi-thread-streams if you would like to control single file transfers.</p> 7338 <h3 id="u---update">-u, --update</h3> 7339 <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> 7340 <p>This can be useful in avoiding needless transfers when transferring to a remote which doesn't support modification times directly (or when using <code>--use-server-modtime</code> to avoid extra API calls) as it is more accurate than a <code>--size-only</code> check and faster than using <code>--checksum</code>. On such remotes (or when using <code>--use-server-modtime</code>) the time checked will be the uploaded time.</p> 7341 <p>If an existing destination file has a modification time older than the source file's, it will be updated if the sizes are different. If the sizes are the same, it will be updated if the checksum is different or not available.</p> 7342 <p>If an existing destination file has a modification time equal (within the computed modify window) to the source file's, it will be updated if the sizes are different. The checksum will not be checked in this case unless the <code>--checksum</code> flag is provided.</p> 7343 <p>In all other cases the file will not be updated.</p> 7344 <p>Consider using the <code>--modify-window</code> flag to compensate for time skews between the source and the backend, for backends that do not support mod times, and instead use uploaded times. However, if the backend does not support checksums, note that syncing or copying within the time skew window may still result in additional transfers for safety.</p> 7345 <h3 id="use-mmap">--use-mmap</h3> 7346 <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> 7347 <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> 7348 <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> 7349 <h3 id="use-server-modtime">--use-server-modtime</h3> 7350 <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> 7351 <p>Use this flag to disable the extra API call and rely instead on the server's modified time. In cases such as a local to remote sync using <code>--update</code>, knowing the local file is newer than the time it was last uploaded to the remote is sufficient. In those cases, this flag can speed up the process and reduce the number of API calls necessary.</p> 7352 <p>Using this flag on a sync operation without also using <code>--update</code> would cause all files modified at any time other than the last upload time to be uploaded again, which is probably not what you want.</p> 7353 <h3 id="v--vv---verbose">-v, -vv, --verbose</h3> 7354 <p>With <code>-v</code> rclone will tell you about each file that is transferred and a small number of significant events.</p> 7355 <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> 7356 <p>When setting verbosity as an environment variable, use <code>RCLONE_VERBOSE=1</code> or <code>RCLONE_VERBOSE=2</code> for <code>-v</code> and <code>-vv</code> respectively.</p> 7357 <h3 id="v---version">-V, --version</h3> 7358 <p>Prints the version number</p> 7359 <h2 id="ssltls-options">SSL/TLS options</h2> 7360 <p>The outgoing SSL/TLS connections rclone makes can be controlled with these options. For example this can be very useful with the HTTP or WebDAV backends. Rclone HTTP servers have their own set of configuration for SSL/TLS which you can find in their documentation.</p> 7361 <h3 id="ca-cert-stringarray">--ca-cert stringArray</h3> 7362 <p>This loads the PEM encoded certificate authority certificates and uses it to verify the certificates of the servers rclone connects to.</p> 7363 <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> 7364 <h3 id="client-cert-string">--client-cert string</h3> 7365 <p>This loads the PEM encoded client side certificate.</p> 7366 <p>This is used for <a href="https://en.wikipedia.org/wiki/Mutual_authentication">mutual TLS authentication</a>.</p> 7367 <p>The <code>--client-key</code> flag is required too when using this.</p> 7368 <h3 id="client-key-string">--client-key string</h3> 7369 <p>This loads the PEM encoded client side private key used for mutual TLS authentication. Used in conjunction with <code>--client-cert</code>.</p> 7370 <h3 id="no-check-certificatetruefalse">--no-check-certificate=true/false</h3> 7371 <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> 7372 <p>This option defaults to <code>false</code>.</p> 7373 <p><strong>This should be used only for testing.</strong></p> 7374 <h2 id="configuration-encryption">Configuration Encryption</h2> 7375 <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> 7376 <p>If you are in an environment where that isn't possible, you can add a password to your configuration. This means that you will have to supply the password every time you start rclone.</p> 7377 <p>To add a password to your rclone configuration, execute <code>rclone config</code>.</p> 7378 <pre><code>>rclone config 7379 Current remotes: 7380 7381 e) Edit existing remote 7382 n) New remote 7383 d) Delete remote 7384 s) Set configuration password 7385 q) Quit config 7386 e/n/d/s/q></code></pre> 7387 <p>Go into <code>s</code>, Set configuration password:</p> 7388 <pre><code>e/n/d/s/q> s 7389 Your configuration is not encrypted. 7390 If you add a password, you will protect your login information to cloud services. 7391 a) Add Password 7392 q) Quit to main menu 7393 a/q> a 7394 Enter NEW configuration password: 7395 password: 7396 Confirm NEW password: 7397 password: 7398 Password set 7399 Your configuration is encrypted. 7400 c) Change Password 7401 u) Unencrypt configuration 7402 q) Quit to main menu 7403 c/u/q></code></pre> 7404 <p>Your configuration is now encrypted, and every time you start rclone you will have to supply the password. See below for details. In the same menu, you can change the password or completely remove encryption from your configuration.</p> 7405 <p>There is no way to recover the configuration if you lose your password.</p> 7406 <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> 7407 <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> 7408 <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> 7409 <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> 7410 <pre><code>#!/bin/echo Source this file don't run it 7411 7412 read -s RCLONE_CONFIG_PASS 7413 export RCLONE_CONFIG_PASS</code></pre> 7414 <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> 7415 <p>An alternate means of supplying the password is to provide a script which will retrieve the password and print on standard output. This script should have a fully specified path name and not rely on any environment variables. The script is supplied either via <code>--password-command="..."</code> command line argument or via the <code>RCLONE_PASSWORD_COMMAND</code> environment variable.</p> 7416 <p>One useful example of this is using the <code>passwordstore</code> application to retrieve the password:</p> 7417 <pre><code>export RCLONE_PASSWORD_COMMAND="pass rclone/config"</code></pre> 7418 <p>If the <code>passwordstore</code> password manager holds the password for the rclone configuration, using the script method means the password is primarily protected by the <code>passwordstore</code> system, and is never embedded in the clear in scripts, nor available for examination using the standard commands available. It is quite possible with long running rclone sessions for copies of passwords to be innocently captured in log files or terminal scroll buffers, etc. Using the script method of supplying the password enhances the security of the config password considerably.</p> 7419 <p>If you are running rclone inside a script, unless you are using the <code>--password-command</code> method, you might want to disable password prompts. To do that, pass the parameter <code>--ask-password=false</code> to rclone. This will make rclone fail instead of asking for a password if <code>RCLONE_CONFIG_PASS</code> doesn't contain a valid password, and <code>--password-command</code> has not been supplied.</p> 7420 <p>Whenever running commands that may be affected by options in a configuration file, rclone will look for an existing file according to the rules described <a href="#config-config-file">above</a>, and load any it finds. If an encrypted file is found, this includes decrypting it, with the possible consequence of a password prompt. When executing a command line that you know are not actually using anything from such a configuration file, you can avoid it being loaded by overriding the location, e.g. with one of the documented special values for memory-only configuration. Since only backend options can be stored in configuration files, this is normally unnecessary for commands that do not operate on backends, e.g. <code>genautocomplete</code>. However, it will be relevant for commands that do operate on backends in general, but are used without referencing a stored remote, e.g. listing local filesystem paths, or <a href="#connection-strings">connection strings</a>: <code>rclone --config="" ls .</code></p> 7421 <h2 id="developer-options">Developer options</h2> 7422 <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 e.g. <code>--drive-test-option</code> - see the docs for the remote in question.</p> 7423 <h3 id="cpuprofilefile">--cpuprofile=FILE</h3> 7424 <p>Write CPU profile to file. This can be analysed with <code>go tool pprof</code>.</p> 7425 <h4 id="dump-flagflagflag">--dump flag,flag,flag</h4> 7426 <p>The <code>--dump</code> flag takes a comma separated list of flags to dump info about.</p> 7427 <p>Note that some headers including <code>Accept-Encoding</code> as shown may not be correct in the request and the response may not show <code>Content-Encoding</code> if the go standard libraries auto gzip encoding was in effect. In this case the body of the request will be gunzipped before showing it.</p> 7428 <p>The available flags are:</p> 7429 <h4 id="dump-headers">--dump headers</h4> 7430 <p>Dump HTTP headers with <code>Authorization:</code> lines removed. May still contain sensitive info. Can be very verbose. Useful for debugging only.</p> 7431 <p>Use <code>--dump auth</code> if you do want the <code>Authorization:</code> headers.</p> 7432 <h4 id="dump-bodies">--dump bodies</h4> 7433 <p>Dump HTTP headers and bodies - may contain sensitive info. Can be very verbose. Useful for debugging only.</p> 7434 <p>Note that the bodies are buffered in memory so don't use this for enormous files.</p> 7435 <h4 id="dump-requests">--dump requests</h4> 7436 <p>Like <code>--dump bodies</code> but dumps the request bodies and the response headers. Useful for debugging download problems.</p> 7437 <h4 id="dump-responses">--dump responses</h4> 7438 <p>Like <code>--dump bodies</code> but dumps the response bodies and the request headers. Useful for debugging upload problems.</p> 7439 <h4 id="dump-auth">--dump auth</h4> 7440 <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> 7441 <h4 id="dump-filters">--dump filters</h4> 7442 <p>Dump the filters to the output. Useful to see exactly what include and exclude options are filtering on.</p> 7443 <h4 id="dump-goroutines">--dump goroutines</h4> 7444 <p>This dumps a list of the running go-routines at the end of the command to standard output.</p> 7445 <h4 id="dump-openfiles">--dump openfiles</h4> 7446 <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> 7447 <h4 id="dump-mapper">--dump mapper</h4> 7448 <p>This shows the JSON blobs being sent to the program supplied with <code>--metadata-mapper</code> and received from it. It can be useful for debugging the metadata mapper interface.</p> 7449 <h3 id="memprofilefile">--memprofile=FILE</h3> 7450 <p>Write memory profile to file. This can be analysed with <code>go tool pprof</code>.</p> 7451 <h2 id="filtering">Filtering</h2> 7452 <p>For the filtering options</p> 7453 <ul> 7454 <li><code>--delete-excluded</code></li> 7455 <li><code>--filter</code></li> 7456 <li><code>--filter-from</code></li> 7457 <li><code>--exclude</code></li> 7458 <li><code>--exclude-from</code></li> 7459 <li><code>--exclude-if-present</code></li> 7460 <li><code>--include</code></li> 7461 <li><code>--include-from</code></li> 7462 <li><code>--files-from</code></li> 7463 <li><code>--files-from-raw</code></li> 7464 <li><code>--min-size</code></li> 7465 <li><code>--max-size</code></li> 7466 <li><code>--min-age</code></li> 7467 <li><code>--max-age</code></li> 7468 <li><code>--dump filters</code></li> 7469 <li><code>--metadata-include</code></li> 7470 <li><code>--metadata-include-from</code></li> 7471 <li><code>--metadata-exclude</code></li> 7472 <li><code>--metadata-exclude-from</code></li> 7473 <li><code>--metadata-filter</code></li> 7474 <li><code>--metadata-filter-from</code></li> 7475 </ul> 7476 <p>See the <a href="https://rclone.org/filtering/">filtering section</a>.</p> 7477 <h2 id="remote-control">Remote control</h2> 7478 <p>For the remote control options and for instructions on how to remote control rclone</p> 7479 <ul> 7480 <li><code>--rc</code></li> 7481 <li>and anything starting with <code>--rc-</code></li> 7482 </ul> 7483 <p>See <a href="https://rclone.org/rc/">the remote control section</a>.</p> 7484 <h2 id="logging">Logging</h2> 7485 <p>rclone has 4 levels of logging, <code>ERROR</code>, <code>NOTICE</code>, <code>INFO</code> and <code>DEBUG</code>.</p> 7486 <p>By default, rclone logs to standard error. This means you can redirect standard error and still see the normal output of rclone commands (e.g. <code>rclone ls</code>).</p> 7487 <p>By default, rclone will produce <code>Error</code> and <code>Notice</code> level messages.</p> 7488 <p>If you use the <code>-q</code> flag, rclone will only produce <code>Error</code> messages.</p> 7489 <p>If you use the <code>-v</code> flag, rclone will produce <code>Error</code>, <code>Notice</code> and <code>Info</code> messages.</p> 7490 <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> 7491 <p>You can also control the log levels with the <code>--log-level</code> flag.</p> 7492 <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> 7493 <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> 7494 <p>Rclone prefixes all log messages with their level in capitals, e.g. INFO which makes it easy to grep the log file for different kinds of information.</p> 7495 <h2 id="exit-code">Exit Code</h2> 7496 <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> 7497 <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> 7498 <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> 7499 <h3 id="list-of-exit-codes">List of exit codes</h3> 7500 <ul> 7501 <li><code>0</code> - success</li> 7502 <li><code>1</code> - Syntax or usage error</li> 7503 <li><code>2</code> - Error not otherwise categorised</li> 7504 <li><code>3</code> - Directory not found</li> 7505 <li><code>4</code> - File not found</li> 7506 <li><code>5</code> - Temporary error (one that more retries might fix) (Retry errors)</li> 7507 <li><code>6</code> - Less serious errors (like 461 errors from dropbox) (NoRetry errors)</li> 7508 <li><code>7</code> - Fatal error (one that more retries won't fix, like account suspended) (Fatal errors)</li> 7509 <li><code>8</code> - Transfer exceeded - limit set by --max-transfer reached</li> 7510 <li><code>9</code> - Operation successful, but no files transferred</li> 7511 <li><code>10</code> - Duration exceeded - limit set by --max-duration reached</li> 7512 </ul> 7513 <h2 id="environment-variables">Environment Variables</h2> 7514 <p>Rclone can be configured entirely using environment variables. These can be used to set defaults for options or config file entries.</p> 7515 <h3 id="options-90">Options</h3> 7516 <p>Every option in rclone can have its default set by environment variable.</p> 7517 <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> 7518 <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> 7519 <p>Or to always use the trash in drive <code>--drive-use-trash</code>, set <code>RCLONE_DRIVE_USE_TRASH=true</code>.</p> 7520 <p>Verbosity is slightly different, the environment variable equivalent of <code>--verbose</code> or <code>-v</code> is <code>RCLONE_VERBOSE=1</code>, or for <code>-vv</code>, <code>RCLONE_VERBOSE=2</code>.</p> 7521 <p>The same parser is used for the options and the environment variables so they take exactly the same form.</p> 7522 <p>The options set by environment variables can be seen with the <code>-vv</code> flag, e.g. <code>rclone version -vv</code>.</p> 7523 <h3 id="config-file">Config file</h3> 7524 <p>You can set defaults for values in the config file on an individual remote basis. The names of the config items are documented in the page for each backend.</p> 7525 <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. Note one implication here is the remote's name must be convertible into a valid environment variable name, so it can only contain letters, digits, or the <code>_</code> (underscore) character.</p> 7526 <p>For example, to configure an S3 remote named <code>mys3:</code> without a config file (using unix ways of setting environment variables):</p> 7527 <pre><code>$ export RCLONE_CONFIG_MYS3_TYPE=s3 7528 $ export RCLONE_CONFIG_MYS3_ACCESS_KEY_ID=XXX 7529 $ export RCLONE_CONFIG_MYS3_SECRET_ACCESS_KEY=XXX 7530 $ rclone lsd mys3: 7531 -1 2016-09-21 12:54:21 -1 my-bucket 7532 $ rclone listremotes | grep mys3 7533 mys3:</code></pre> 7534 <p>Note that if you want to create a remote using environment variables you must create the <code>..._TYPE</code> variable as above.</p> 7535 <p>Note that the name of a remote created using environment variable is case insensitive, in contrast to regular remotes stored in config file as documented <a href="#valid-remote-names">above</a>. You must write the name in uppercase in the environment variable, but as seen from example above it will be listed and can be accessed in lowercase, while you can also refer to the same remote in uppercase:</p> 7536 <pre><code>$ rclone lsd mys3: 7537 -1 2016-09-21 12:54:21 -1 my-bucket 7538 $ rclone lsd MYS3: 7539 -1 2016-09-21 12:54:21 -1 my-bucket</code></pre> 7540 <p>Note that you can only set the options of the immediate backend, so RCLONE_CONFIG_MYS3CRYPT_ACCESS_KEY_ID has no effect, if myS3Crypt is a crypt remote based on an S3 remote. However RCLONE_S3_ACCESS_KEY_ID will set the access key of all remotes using S3, including myS3Crypt.</p> 7541 <p>Note also that now rclone has <a href="#connection-strings">connection strings</a>, it is probably easier to use those instead which makes the above example</p> 7542 <pre><code>rclone lsd :s3,access_key_id=XXX,secret_access_key=XXX:</code></pre> 7543 <h3 id="precedence">Precedence</h3> 7544 <p>The various different methods of backend configuration are read in this order and the first one with a value is used.</p> 7545 <ul> 7546 <li>Parameters in connection strings, e.g. <code>myRemote,skip_links:</code></li> 7547 <li>Flag values as supplied on the command line, e.g. <code>--skip-links</code></li> 7548 <li>Remote specific environment vars, e.g. <code>RCLONE_CONFIG_MYREMOTE_SKIP_LINKS</code> (see above).</li> 7549 <li>Backend-specific environment vars, e.g. <code>RCLONE_LOCAL_SKIP_LINKS</code>.</li> 7550 <li>Backend generic environment vars, e.g. <code>RCLONE_SKIP_LINKS</code>.</li> 7551 <li>Config file, e.g. <code>skip_links = true</code>.</li> 7552 <li>Default values, e.g. <code>false</code> - these can't be changed.</li> 7553 </ul> 7554 <p>So if both <code>--skip-links</code> is supplied on the command line and an environment variable <code>RCLONE_LOCAL_SKIP_LINKS</code> is set, the command line flag will take preference.</p> 7555 <p>The backend configurations set by environment variables can be seen with the <code>-vv</code> flag, e.g. <code>rclone about myRemote: -vv</code>.</p> 7556 <p>For non backend configuration the order is as follows:</p> 7557 <ul> 7558 <li>Flag values as supplied on the command line, e.g. <code>--stats 5s</code>.</li> 7559 <li>Environment vars, e.g. <code>RCLONE_STATS=5s</code>.</li> 7560 <li>Default values, e.g. <code>1m</code> - these can't be changed.</li> 7561 </ul> 7562 <h3 id="other-environment-variables">Other environment variables</h3> 7563 <ul> 7564 <li><code>RCLONE_CONFIG_PASS</code> set to contain your config file password (see <a href="#configuration-encryption">Configuration Encryption</a> section)</li> 7565 <li><code>HTTP_PROXY</code>, <code>HTTPS_PROXY</code> and <code>NO_PROXY</code> (or the lowercase versions thereof). 7566 <ul> 7567 <li><code>HTTPS_PROXY</code> takes precedence over <code>HTTP_PROXY</code> for https requests.</li> 7568 <li>The environment values may be either a complete URL or a "host[:port]" for, in which case the "http" scheme is assumed.</li> 7569 </ul></li> 7570 <li><code>USER</code> and <code>LOGNAME</code> values are used as fallbacks for current username. The primary method for looking up username is OS-specific: Windows API on Windows, real user ID in /etc/passwd on Unix systems. In the documentation the current username is simply referred to as <code>$USER</code>.</li> 7571 <li><code>RCLONE_CONFIG_DIR</code> - rclone <strong>sets</strong> this variable for use in config files and sub processes to point to the directory holding the config file.</li> 7572 </ul> 7573 <p>The options set by environment variables can be seen with the <code>-vv</code> and <code>--log-level=DEBUG</code> flags, e.g. <code>rclone version -vv</code>.</p> 7574 <h1 id="configuring-rclone-on-a-remote-headless-machine">Configuring rclone on a remote / headless machine</h1> 7575 <p>Some of the configurations (those involving oauth2) require an Internet connected web browser.</p> 7576 <p>If you are trying to set rclone up on a remote or headless box with no browser available on it (e.g. a NAS or a server in a datacenter) then you will need to use an alternative means of configuration. There are two ways of doing it, described below.</p> 7577 <h2 id="configuring-using-rclone-authorize">Configuring using rclone authorize</h2> 7578 <p>On the headless box run <code>rclone</code> config but answer <code>N</code> to the <code>Use web browser to automatically authenticate?</code> question.</p> 7579 <pre><code>... 7580 Remote config 7581 Use web browser to automatically authenticate rclone with remote? 7582 * Say Y if the machine running rclone has a web browser you can use 7583 * Say N if running rclone on a (remote) machine without web browser access 7584 If not sure try Y. If Y failed, try N. 7585 y) Yes (default) 7586 n) No 7587 y/n> n 7588 For this to work, you will need rclone available on a machine that has 7589 a web browser available. 7590 7591 For more help and alternate methods see: https://rclone.org/remote_setup/ 7592 7593 Execute the following on the machine with the web browser (same rclone 7594 version recommended): 7595 7596 rclone authorize "dropbox" 7597 7598 Then paste the result below: 7599 result></code></pre> 7600 <p>Then on your main desktop machine</p> 7601 <pre><code>rclone authorize "dropbox" 7602 If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth 7603 Log in and authorize rclone for access 7604 Waiting for code... 7605 Got code 7606 Paste the following into your remote machine ---> 7607 SECRET_TOKEN 7608 <---End paste</code></pre> 7609 <p>Then back to the headless box, paste in the code</p> 7610 <pre><code>result> SECRET_TOKEN 7611 -------------------- 7612 [acd12] 7613 client_id = 7614 client_secret = 7615 token = SECRET_TOKEN 7616 -------------------- 7617 y) Yes this is OK 7618 e) Edit this remote 7619 d) Delete this remote 7620 y/e/d></code></pre> 7621 <h2 id="configuring-by-copying-the-config-file">Configuring by copying the config file</h2> 7622 <p>Rclone stores all of its config in a single configuration file. This can easily be copied to configure a remote rclone.</p> 7623 <p>So first configure rclone on your desktop machine with</p> 7624 <pre><code>rclone config</code></pre> 7625 <p>to set up the config file.</p> 7626 <p>Find the config file by running <code>rclone config file</code>, for example</p> 7627 <pre><code>$ rclone config file 7628 Configuration file is stored at: 7629 /home/user/.rclone.conf</code></pre> 7630 <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> 7631 <h2 id="configuring-using-ssh-tunnel">Configuring using SSH Tunnel</h2> 7632 <p>Linux and MacOS users can utilize SSH Tunnel to redirect the headless box port 53682 to local machine by using the following command:</p> 7633 <pre><code>ssh -L localhost:53682:localhost:53682 username@remote_server</code></pre> 7634 <p>Then on the headless box run <code>rclone</code> config and answer <code>Y</code> to the <code>Use web browser to automatically authenticate?</code> question.</p> 7635 <pre><code>... 7636 Remote config 7637 Use web browser to automatically authenticate rclone with remote? 7638 * Say Y if the machine running rclone has a web browser you can use 7639 * Say N if running rclone on a (remote) machine without web browser access 7640 If not sure try Y. If Y failed, try N. 7641 y) Yes (default) 7642 n) No 7643 y/n> y</code></pre> 7644 <p>Then copy and paste the auth url <code>http://127.0.0.1:53682/auth?state=xxxxxxxxxxxx</code> to the browser on your local machine, complete the auth and it is done.</p> 7645 <h1 id="filtering-includes-and-excludes">Filtering, includes and excludes</h1> 7646 <p>Filter flags determine which files rclone <code>sync</code>, <code>move</code>, <code>ls</code>, <code>lsl</code>, <code>md5sum</code>, <code>sha1sum</code>, <code>size</code>, <code>delete</code>, <code>check</code> and similar commands apply to.</p> 7647 <p>They are specified in terms of path/file name patterns; path/file lists; file age and size, or presence of a file in a directory. Bucket based remotes without the concept of directory apply filters to object key, age and size in an analogous way.</p> 7648 <p>Rclone <code>purge</code> does not obey filters.</p> 7649 <p>To test filters without risk of damage to data, apply them to <code>rclone ls</code>, or with the <code>--dry-run</code> and <code>-vv</code> flags.</p> 7650 <p>Rclone filter patterns can only be used in filter command line options, not in the specification of a remote.</p> 7651 <p>E.g. <code>rclone copy "remote:dir*.jpg" /path/to/dir</code> does not have a filter effect. <code>rclone copy remote:dir /path/to/dir --include "*.jpg"</code> does.</p> 7652 <p><strong>Important</strong> Avoid mixing any two of <code>--include...</code>, <code>--exclude...</code> or <code>--filter...</code> flags in an rclone command. The results might not be what you expect. Instead use a <code>--filter...</code> flag.</p> 7653 <h2 id="patterns-for-matching-pathfile-names">Patterns for matching path/file names</h2> 7654 <h3 id="patterns">Pattern syntax</h3> 7655 <p>Here is a formal definition of the pattern syntax, <a href="#examples">examples</a> are below.</p> 7656 <p>Rclone matching rules follow a glob style:</p> 7657 <pre><code>* matches any sequence of non-separator (/) characters 7658 ** matches any sequence of characters including / separators 7659 ? matches any single non-separator (/) character 7660 [ [ ! ] { character-range } ] 7661 character class (must be non-empty) 7662 { pattern-list } 7663 pattern alternatives 7664 {{ regexp }} 7665 regular expression to match 7666 c matches character c (c != *, **, ?, \, [, {, }) 7667 \c matches reserved character c (c = *, **, ?, \, [, {, }) or character class</code></pre> 7668 <p>character-range:</p> 7669 <pre><code>c matches character c (c != \, -, ]) 7670 \c matches reserved character c (c = \, -, ]) 7671 lo - hi matches character c for lo <= c <= hi</code></pre> 7672 <p>pattern-list:</p> 7673 <pre><code>pattern { , pattern } 7674 comma-separated (without spaces) patterns</code></pre> 7675 <p>character classes (see <a href="https://golang.org/pkg/regexp/syntax/">Go regular expression reference</a>) include:</p> 7676 <pre><code>Named character classes (e.g. [\d], [^\d], [\D], [^\D]) 7677 Perl character classes (e.g. \s, \S, \w, \W) 7678 ASCII character classes (e.g. [[:alnum:]], [[:alpha:]], [[:punct:]], [[:xdigit:]])</code></pre> 7679 <p>regexp for advanced users to insert a regular expression - see <a href="#regexp">below</a> for more info:</p> 7680 <pre><code>Any re2 regular expression not containing `}}`</code></pre> 7681 <p>If the filter 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 drive). If it does not start with <code>/</code> then it is matched starting at the <strong>end of the path/file name</strong> but it only matches a complete path element - it must match from a <code>/</code> separator or the beginning of the path/file.</p> 7682 <pre><code>file.jpg - matches "file.jpg" 7683 - matches "directory/file.jpg" 7684 - doesn't match "afile.jpg" 7685 - doesn't match "directory/afile.jpg" 7686 /file.jpg - matches "file.jpg" in the root directory of the remote 7687 - doesn't match "afile.jpg" 7688 - doesn't match "directory/file.jpg"</code></pre> 7689 <p>The top level of the remote might not be the top level of the drive.</p> 7690 <p>E.g. for a Microsoft Windows local directory structure</p> 7691 <pre><code>F: 7692 ├── bkp 7693 ├── data 7694 │ ├── excl 7695 │ │ ├── 123.jpg 7696 │ │ └── 456.jpg 7697 │ ├── incl 7698 │ │ └── document.pdf</code></pre> 7699 <p>To copy the contents of folder <code>data</code> into folder <code>bkp</code> excluding the contents of subfolder <code>excl</code>the following command treats <code>F:\data</code> and <code>F:\bkp</code> as top level for filtering.</p> 7700 <p><code>rclone copy F:\data\ F:\bkp\ --exclude=/excl/**</code></p> 7701 <p><strong>Important</strong> Use <code>/</code> in path/file name patterns and not <code>\</code> even if running on Microsoft Windows.</p> 7702 <p>Simple patterns are case sensitive unless the <code>--ignore-case</code> flag is used.</p> 7703 <p>Without <code>--ignore-case</code> (default)</p> 7704 <pre><code>potato - matches "potato" 7705 - doesn't match "POTATO"</code></pre> 7706 <p>With <code>--ignore-case</code></p> 7707 <pre><code>potato - matches "potato" 7708 - matches "POTATO"</code></pre> 7709 <h2 id="regexp">Using regular expressions in filter patterns</h2> 7710 <p>The syntax of filter patterns is glob style matching (like <code>bash</code> uses) to make things easy for users. However this does not provide absolute control over the matching, so for advanced users rclone also provides a regular expression syntax.</p> 7711 <p>The regular expressions used are as defined in the <a href="https://golang.org/pkg/regexp/syntax/">Go regular expression reference</a>. Regular expressions should be enclosed in <code>{{</code> <code>}}</code>. They will match only the last path segment if the glob doesn't start with <code>/</code> or the whole path name if it does. Note that rclone does not attempt to parse the supplied regular expression, meaning that using any regular expression filter will prevent rclone from using <a href="#directory_filter">directory filter rules</a>, as it will instead check every path against the supplied regular expression(s).</p> 7712 <p>Here is how the <code>{{regexp}}</code> is transformed into an full regular expression to match the entire path:</p> 7713 <pre><code>{{regexp}} becomes (^|/)(regexp)$ 7714 /{{regexp}} becomes ^(regexp)$</code></pre> 7715 <p>Regexp syntax can be mixed with glob syntax, for example</p> 7716 <pre><code>*.{{jpe?g}} to match file.jpg, file.jpeg but not file.png</code></pre> 7717 <p>You can also use regexp flags - to set case insensitive, for example</p> 7718 <pre><code>*.{{(?i)jpg}} to match file.jpg, file.JPG but not file.png</code></pre> 7719 <p>Be careful with wildcards in regular expressions - you don't want them to match path separators normally. To match any file name starting with <code>start</code> and ending with <code>end</code> write</p> 7720 <pre><code>{{start[^/]*end\.jpg}}</code></pre> 7721 <p>Not</p> 7722 <pre><code>{{start.*end\.jpg}}</code></pre> 7723 <p>Which will match a directory called <code>start</code> with a file called <code>end.jpg</code> in it as the <code>.*</code> will match <code>/</code> characters.</p> 7724 <p>Note that you can use <code>-vv --dump filters</code> to show the filter patterns in regexp format - rclone implements the glob patterns by transforming them into regular expressions.</p> 7725 <h2 id="examples">Filter pattern examples</h2> 7726 <table> 7727 <thead> 7728 <tr class="header"> 7729 <th>Description</th> 7730 <th>Pattern</th> 7731 <th>Matches</th> 7732 <th>Does not match</th> 7733 </tr> 7734 </thead> 7735 <tbody> 7736 <tr class="odd"> 7737 <td>Wildcard</td> 7738 <td><code>*.jpg</code></td> 7739 <td><code>/file.jpg</code></td> 7740 <td><code>/file.png</code></td> 7741 </tr> 7742 <tr class="even"> 7743 <td></td> 7744 <td></td> 7745 <td><code>/dir/file.jpg</code></td> 7746 <td><code>/dir/file.png</code></td> 7747 </tr> 7748 <tr class="odd"> 7749 <td>Rooted</td> 7750 <td><code>/*.jpg</code></td> 7751 <td><code>/file.jpg</code></td> 7752 <td><code>/file.png</code></td> 7753 </tr> 7754 <tr class="even"> 7755 <td></td> 7756 <td></td> 7757 <td><code>/file2.jpg</code></td> 7758 <td><code>/dir/file.jpg</code></td> 7759 </tr> 7760 <tr class="odd"> 7761 <td>Alternates</td> 7762 <td><code>*.{jpg,png}</code></td> 7763 <td><code>/file.jpg</code></td> 7764 <td><code>/file.gif</code></td> 7765 </tr> 7766 <tr class="even"> 7767 <td></td> 7768 <td></td> 7769 <td><code>/dir/file.png</code></td> 7770 <td><code>/dir/file.gif</code></td> 7771 </tr> 7772 <tr class="odd"> 7773 <td>Path Wildcard</td> 7774 <td><code>dir/**</code></td> 7775 <td><code>/dir/anyfile</code></td> 7776 <td><code>file.png</code></td> 7777 </tr> 7778 <tr class="even"> 7779 <td></td> 7780 <td></td> 7781 <td><code>/subdir/dir/subsubdir/anyfile</code></td> 7782 <td><code>/subdir/file.png</code></td> 7783 </tr> 7784 <tr class="odd"> 7785 <td>Any Char</td> 7786 <td><code>*.t?t</code></td> 7787 <td><code>/file.txt</code></td> 7788 <td><code>/file.qxt</code></td> 7789 </tr> 7790 <tr class="even"> 7791 <td></td> 7792 <td></td> 7793 <td><code>/dir/file.tzt</code></td> 7794 <td><code>/dir/file.png</code></td> 7795 </tr> 7796 <tr class="odd"> 7797 <td>Range</td> 7798 <td><code>*.[a-z]</code></td> 7799 <td><code>/file.a</code></td> 7800 <td><code>/file.0</code></td> 7801 </tr> 7802 <tr class="even"> 7803 <td></td> 7804 <td></td> 7805 <td><code>/dir/file.b</code></td> 7806 <td><code>/dir/file.1</code></td> 7807 </tr> 7808 <tr class="odd"> 7809 <td>Escape</td> 7810 <td><code>*.\?\?\?</code></td> 7811 <td><code>/file.???</code></td> 7812 <td><code>/file.abc</code></td> 7813 </tr> 7814 <tr class="even"> 7815 <td></td> 7816 <td></td> 7817 <td><code>/dir/file.???</code></td> 7818 <td><code>/dir/file.def</code></td> 7819 </tr> 7820 <tr class="odd"> 7821 <td>Class</td> 7822 <td><code>*.\d\d\d</code></td> 7823 <td><code>/file.012</code></td> 7824 <td><code>/file.abc</code></td> 7825 </tr> 7826 <tr class="even"> 7827 <td></td> 7828 <td></td> 7829 <td><code>/dir/file.345</code></td> 7830 <td><code>/dir/file.def</code></td> 7831 </tr> 7832 <tr class="odd"> 7833 <td>Regexp</td> 7834 <td><code>*.{{jpe?g}}</code></td> 7835 <td><code>/file.jpeg</code></td> 7836 <td><code>/file.png</code></td> 7837 </tr> 7838 <tr class="even"> 7839 <td></td> 7840 <td></td> 7841 <td><code>/dir/file.jpg</code></td> 7842 <td><code>/dir/file.jpeeg</code></td> 7843 </tr> 7844 <tr class="odd"> 7845 <td>Rooted Regexp</td> 7846 <td><code>/{{.*\.jpe?g}}</code></td> 7847 <td><code>/file.jpeg</code></td> 7848 <td><code>/file.png</code></td> 7849 </tr> 7850 <tr class="even"> 7851 <td></td> 7852 <td></td> 7853 <td><code>/file.jpg</code></td> 7854 <td><code>/dir/file.jpg</code></td> 7855 </tr> 7856 </tbody> 7857 </table> 7858 <h2 id="how-filter-rules-work">How filter rules are applied to files</h2> 7859 <p>Rclone path/file name filters are made up of one or more of the following flags:</p> 7860 <ul> 7861 <li><code>--include</code></li> 7862 <li><code>--include-from</code></li> 7863 <li><code>--exclude</code></li> 7864 <li><code>--exclude-from</code></li> 7865 <li><code>--filter</code></li> 7866 <li><code>--filter-from</code></li> 7867 </ul> 7868 <p>There can be more than one instance of individual flags.</p> 7869 <p>Rclone internally uses a combined list of all the include and exclude rules. The order in which rules are processed can influence the result of the filter.</p> 7870 <p>All flags of the same type are processed together in the order above, regardless of what order the different types of flags are included on the command line.</p> 7871 <p>Multiple instances of the same flag are processed from left to right according to their position in the command line.</p> 7872 <p>To mix up the order of processing includes and excludes use <code>--filter...</code> flags.</p> 7873 <p>Within <code>--include-from</code>, <code>--exclude-from</code> and <code>--filter-from</code> flags rules are processed from top to bottom of the referenced file.</p> 7874 <p>If there is an <code>--include</code> or <code>--include-from</code> flag specified, rclone implies a <code>- **</code> rule which it adds to the bottom of the internal rule list. Specifying a <code>+</code> rule with a <code>--filter...</code> flag does not imply that rule.</p> 7875 <p>Each path/file name passed through rclone is matched against the combined filter list. At first match to a rule the path/file name is included or excluded and no further filter rules are processed for that path/file.</p> 7876 <p>If rclone does not find a match, after testing against all rules (including the implied rule if appropriate), the path/file name is included.</p> 7877 <p>Any path/file included at that stage is processed by the rclone command.</p> 7878 <p><code>--files-from</code> and <code>--files-from-raw</code> flags over-ride and cannot be combined with other filter options.</p> 7879 <p>To see the internal combined rule list, in regular expression form, for a command add the <code>--dump filters</code> flag. Running an rclone command with <code>--dump filters</code> and <code>-vv</code> flags lists the internal filter elements and shows how they are applied to each source path/file. There is not currently a means provided to pass regular expression filter options into rclone directly though character class filter rules contain character classes. <a href="https://golang.org/pkg/regexp/syntax/">Go regular expression reference</a></p> 7880 <h3 id="directory_filter">How filter rules are applied to directories</h3> 7881 <p>Rclone commands are applied to path/file names not directories. The entire contents of a directory can be matched to a filter by the pattern <code>directory/*</code> or recursively by <code>directory/**</code>.</p> 7882 <p>Directory filter rules are defined with a closing <code>/</code> separator.</p> 7883 <p>E.g. <code>/directory/subdirectory/</code> is an rclone directory filter rule.</p> 7884 <p>Rclone commands can use directory filter rules to determine whether they recurse into subdirectories. This potentially optimises access to a remote by avoiding listing unnecessary directories. Whether optimisation is desirable depends on the specific filter rules and source remote content.</p> 7885 <p>If any <a href="#regexp">regular expression filters</a> are in use, then no directory recursion optimisation is possible, as rclone must check every path against the supplied regular expression(s).</p> 7886 <p>Directory recursion optimisation occurs if either:</p> 7887 <ul> 7888 <li><p>A source remote does not support the rclone <code>ListR</code> primitive. local, sftp, Microsoft OneDrive and WebDAV do not support <code>ListR</code>. Google Drive and most bucket type storage do. <a href="https://rclone.org/overview/#optional-features">Full list</a></p></li> 7889 <li><p>On other remotes (those that support <code>ListR</code>), if the rclone command is not naturally recursive, and provided it is not run with the <code>--fast-list</code> flag. <code>ls</code>, <code>lsf -R</code> and <code>size</code> are naturally recursive but <code>sync</code>, <code>copy</code> and <code>move</code> are not.</p></li> 7890 <li><p>Whenever the <code>--disable ListR</code> flag is applied to an rclone command.</p></li> 7891 </ul> 7892 <p>Rclone commands imply directory filter rules from path/file filter rules. To view the directory filter rules rclone has implied for a command specify the <code>--dump filters</code> flag.</p> 7893 <p>E.g. for an include rule</p> 7894 <pre><code>/a/*.jpg</code></pre> 7895 <p>Rclone implies the directory include rule</p> 7896 <pre><code>/a/</code></pre> 7897 <p>Directory filter rules specified in an rclone command can limit the scope of an rclone command but path/file filters still have to be specified.</p> 7898 <p>E.g. <code>rclone ls remote: --include /directory/</code> will not match any files. Because it is an <code>--include</code> option the <code>--exclude **</code> rule is implied, and the <code>/directory/</code> pattern serves only to optimise access to the remote by ignoring everything outside of that directory.</p> 7899 <p>E.g. <code>rclone ls remote: --filter-from filter-list.txt</code> with a file <code>filter-list.txt</code>:</p> 7900 <pre><code>- /dir1/ 7901 - /dir2/ 7902 + *.pdf 7903 - **</code></pre> 7904 <p>All files in directories <code>dir1</code> or <code>dir2</code> or their subdirectories are completely excluded from the listing. Only files of suffix <code>pdf</code> in the root of <code>remote:</code> or its subdirectories are listed. The <code>- **</code> rule prevents listing of any path/files not previously matched by the rules above.</p> 7905 <p>Option <code>exclude-if-present</code> creates a directory exclude rule based on the presence of a file in a directory and takes precedence over other rclone directory filter rules.</p> 7906 <p>When using pattern list syntax, if a pattern item contains either <code>/</code> or <code>**</code>, then rclone will not able to imply a directory filter rule from this pattern list.</p> 7907 <p>E.g. for an include rule</p> 7908 <pre><code>{dir1/**,dir2/**}</code></pre> 7909 <p>Rclone will match files below directories <code>dir1</code> or <code>dir2</code> only, but will not be able to use this filter to exclude a directory <code>dir3</code> from being traversed.</p> 7910 <p>Directory recursion optimisation may affect performance, but normally not the result. One exception to this is sync operations with option <code>--create-empty-src-dirs</code>, where any traversed empty directories will be created. With the pattern list example <code>{dir1/**,dir2/**}</code> above, this would create an empty directory <code>dir3</code> on destination (when it exists on source). Changing the filter to <code>{dir1,dir2}/**</code>, or splitting it into two include rules <code>--include dir1/** --include dir2/**</code>, will match the same files while also filtering directories, with the result that an empty directory <code>dir3</code> will no longer be created.</p> 7911 <h3 id="exclude---exclude-files-matching-pattern"><code>--exclude</code> - Exclude files matching pattern</h3> 7912 <p>Excludes path/file names from an rclone command based on a single exclude rule.</p> 7913 <p>This flag can be repeated. See above for the order filter flags are processed in.</p> 7914 <p><code>--exclude</code> should not be used with <code>--include</code>, <code>--include-from</code>, <code>--filter</code> or <code>--filter-from</code> flags.</p> 7915 <p><code>--exclude</code> has no effect when combined with <code>--files-from</code> or <code>--files-from-raw</code> flags.</p> 7916 <p>E.g. <code>rclone ls remote: --exclude *.bak</code> excludes all .bak files from listing.</p> 7917 <p>E.g. <code>rclone size remote: "--exclude /dir/**"</code> returns the total size of all files on <code>remote:</code> excluding those in root directory <code>dir</code> and sub directories.</p> 7918 <p>E.g. on Microsoft Windows <code>rclone ls remote: --exclude "*\[{JP,KR,HK}\]*"</code> lists the files in <code>remote:</code> without <code>[JP]</code> or <code>[KR]</code> or <code>[HK]</code> in their name. Quotes prevent the shell from interpreting the <code>\</code> characters.<code>\</code> characters escape the <code>[</code> and <code>]</code> so an rclone filter treats them literally rather than as a character-range. The <code>{</code> and <code>}</code> define an rclone pattern list. For other operating systems single quotes are required ie <code>rclone ls remote: --exclude '*\[{JP,KR,HK}\]*'</code></p> 7919 <h3 id="exclude-from---read-exclude-patterns-from-file"><code>--exclude-from</code> - Read exclude patterns from file</h3> 7920 <p>Excludes path/file names from an rclone command based on rules in a named file. The file contains a list of remarks and pattern rules.</p> 7921 <p>For an example <code>exclude-file.txt</code>:</p> 7922 <pre><code># a sample exclude rule file 7923 *.bak 7924 file2.jpg</code></pre> 7925 <p><code>rclone ls remote: --exclude-from exclude-file.txt</code> lists the files on <code>remote:</code> except those named <code>file2.jpg</code> or with a suffix <code>.bak</code>. That is equivalent to <code>rclone ls remote: --exclude file2.jpg --exclude "*.bak"</code>.</p> 7926 <p>This flag can be repeated. See above for the order filter flags are processed in.</p> 7927 <p>The <code>--exclude-from</code> flag is useful where multiple exclude filter rules are applied to an rclone command.</p> 7928 <p><code>--exclude-from</code> should not be used with <code>--include</code>, <code>--include-from</code>, <code>--filter</code> or <code>--filter-from</code> flags.</p> 7929 <p><code>--exclude-from</code> has no effect when combined with <code>--files-from</code> or <code>--files-from-raw</code> flags.</p> 7930 <p><code>--exclude-from</code> followed by <code>-</code> reads filter rules from standard input.</p> 7931 <h3 id="include---include-files-matching-pattern"><code>--include</code> - Include files matching pattern</h3> 7932 <p>Adds a single include rule based on path/file names to an rclone command.</p> 7933 <p>This flag can be repeated. See above for the order filter flags are processed in.</p> 7934 <p><code>--include</code> has no effect when combined with <code>--files-from</code> or <code>--files-from-raw</code> flags.</p> 7935 <p><code>--include</code> implies <code>--exclude **</code> at the end of an rclone internal filter list. Therefore if you mix <code>--include</code> and <code>--include-from</code> flags with <code>--exclude</code>, <code>--exclude-from</code>, <code>--filter</code> or <code>--filter-from</code>, you must use include rules for all the files you want in the include statement. For more flexibility use the <code>--filter-from</code> flag.</p> 7936 <p>E.g. <code>rclone ls remote: --include "*.{png,jpg}"</code> lists the files on <code>remote:</code> with suffix <code>.png</code> and <code>.jpg</code>. All other files are excluded.</p> 7937 <p>E.g. multiple rclone copy commands can be combined with <code>--include</code> and a pattern-list.</p> 7938 <pre><code>rclone copy /vol1/A remote:A 7939 rclone copy /vol1/B remote:B</code></pre> 7940 <p>is equivalent to:</p> 7941 <pre><code>rclone copy /vol1 remote: --include "{A,B}/**"</code></pre> 7942 <p>E.g. <code>rclone ls remote:/wheat --include "??[^[:punct:]]*"</code> lists the files <code>remote:</code> directory <code>wheat</code> (and subdirectories) whose third character is not punctuation. This example uses an <a href="https://golang.org/pkg/regexp/syntax/">ASCII character class</a>.</p> 7943 <h3 id="include-from---read-include-patterns-from-file"><code>--include-from</code> - Read include patterns from file</h3> 7944 <p>Adds path/file names to an rclone command based on rules in a named file. The file contains a list of remarks and pattern rules.</p> 7945 <p>For an example <code>include-file.txt</code>:</p> 7946 <pre><code># a sample include rule file 7947 *.jpg 7948 file2.avi</code></pre> 7949 <p><code>rclone ls remote: --include-from include-file.txt</code> lists the files on <code>remote:</code> with name <code>file2.avi</code> or suffix <code>.jpg</code>. That is equivalent to <code>rclone ls remote: --include file2.avi --include "*.jpg"</code>.</p> 7950 <p>This flag can be repeated. See above for the order filter flags are processed in.</p> 7951 <p>The <code>--include-from</code> flag is useful where multiple include filter rules are applied to an rclone command.</p> 7952 <p><code>--include-from</code> implies <code>--exclude **</code> at the end of an rclone internal filter list. Therefore if you mix <code>--include</code> and <code>--include-from</code> flags with <code>--exclude</code>, <code>--exclude-from</code>, <code>--filter</code> or <code>--filter-from</code>, you must use include rules for all the files you want in the include statement. For more flexibility use the <code>--filter-from</code> flag.</p> 7953 <p><code>--exclude-from</code> has no effect when combined with <code>--files-from</code> or <code>--files-from-raw</code> flags.</p> 7954 <p><code>--exclude-from</code> followed by <code>-</code> reads filter rules from standard input.</p> 7955 <h3 id="filter---add-a-file-filtering-rule"><code>--filter</code> - Add a file-filtering rule</h3> 7956 <p>Specifies path/file names to an rclone command, based on a single include or exclude rule, in <code>+</code> or <code>-</code> format.</p> 7957 <p>This flag can be repeated. See above for the order filter flags are processed in.</p> 7958 <p><code>--filter +</code> differs from <code>--include</code>. In the case of <code>--include</code> rclone implies an <code>--exclude *</code> rule which it adds to the bottom of the internal rule list. <code>--filter...+</code> does not imply that rule.</p> 7959 <p><code>--filter</code> has no effect when combined with <code>--files-from</code> or <code>--files-from-raw</code> flags.</p> 7960 <p><code>--filter</code> should not be used with <code>--include</code>, <code>--include-from</code>, <code>--exclude</code> or <code>--exclude-from</code> flags.</p> 7961 <p>E.g. <code>rclone ls remote: --filter "- *.bak"</code> excludes all <code>.bak</code> files from a list of <code>remote:</code>.</p> 7962 <h3 id="filter-from---read-filtering-patterns-from-a-file"><code>--filter-from</code> - Read filtering patterns from a file</h3> 7963 <p>Adds path/file names to an rclone command based on rules in a named file. The file contains a list of remarks and pattern rules. Include rules start with <code>+</code> and exclude rules with <code>-</code>. <code>!</code> clears existing rules. Rules are processed in the order they are defined.</p> 7964 <p>This flag can be repeated. See above for the order filter flags are processed in.</p> 7965 <p>Arrange the order of filter rules with the most restrictive first and work down.</p> 7966 <p>E.g. for <code>filter-file.txt</code>:</p> 7967 <pre><code># a sample filter rule file 7968 - secret*.jpg 7969 + *.jpg 7970 + *.png 7971 + file2.avi 7972 - /dir/Trash/** 7973 + /dir/** 7974 # exclude everything else 7975 - *</code></pre> 7976 <p><code>rclone ls remote: --filter-from filter-file.txt</code> lists the path/files on <code>remote:</code> including all <code>jpg</code> and <code>png</code> files, excluding any matching <code>secret*.jpg</code> and including <code>file2.avi</code>. It also includes everything in the directory <code>dir</code> at the root of <code>remote</code>, except <code>remote:dir/Trash</code> which it excludes. Everything else is excluded.</p> 7977 <p>E.g. for an alternative <code>filter-file.txt</code>:</p> 7978 <pre><code>- secret*.jpg 7979 + *.jpg 7980 + *.png 7981 + file2.avi 7982 - *</code></pre> 7983 <p>Files <code>file1.jpg</code>, <code>file3.png</code> and <code>file2.avi</code> are listed whilst <code>secret17.jpg</code> and files without the suffix <code>.jpg</code> or <code>.png</code> are excluded.</p> 7984 <p>E.g. for an alternative <code>filter-file.txt</code>:</p> 7985 <pre><code>+ *.jpg 7986 + *.gif 7987 ! 7988 + 42.doc 7989 - *</code></pre> 7990 <p>Only file 42.doc is listed. Prior rules are cleared by the <code>!</code>.</p> 7991 <h3 id="files-from---read-list-of-source-file-names"><code>--files-from</code> - Read list of source-file names</h3> 7992 <p>Adds path/files to an rclone command from a list in a named file. Rclone processes the path/file names in the order of the list, and no others.</p> 7993 <p>Other filter flags (<code>--include</code>, <code>--include-from</code>, <code>--exclude</code>, <code>--exclude-from</code>, <code>--filter</code> and <code>--filter-from</code>) are ignored when <code>--files-from</code> is used.</p> 7994 <p><code>--files-from</code> expects a list of files as its input. Leading or trailing whitespace is stripped from the input lines. Lines starting with <code>#</code> or <code>;</code> are ignored.</p> 7995 <p>Rclone commands with a <code>--files-from</code> flag traverse the remote, treating the names in <code>--files-from</code> as a set of filters.</p> 7996 <p>If the <code>--no-traverse</code> and <code>--files-from</code> flags are used together an rclone command does not traverse the remote. Instead it addresses each path/file named in the file individually. For each path/file name, that requires typically 1 API call. This can be efficient for a short <code>--files-from</code> list and a remote containing many files.</p> 7997 <p>Rclone commands do not error if any names in the <code>--files-from</code> file are missing from the source remote.</p> 7998 <p>The <code>--files-from</code> flag can be repeated in a single rclone command to read path/file names from more than one file. The files are read from left to right along the command line.</p> 7999 <p>Paths within the <code>--files-from</code> file are interpreted as starting with the root specified in the rclone command. Leading <code>/</code> separators are ignored. See <a href="#files-from-raw-read-list-of-source-file-names-without-any-processing">--files-from-raw</a> if you need the input to be processed in a raw manner.</p> 8000 <p>E.g. for a file <code>files-from.txt</code>:</p> 8001 <pre><code># comment 8002 file1.jpg 8003 subdir/file2.jpg</code></pre> 8004 <p><code>rclone copy --files-from files-from.txt /home/me/pics remote:pics</code> copies the following, if they exist, and only those files.</p> 8005 <pre><code>/home/me/pics/file1.jpg → remote:pics/file1.jpg 8006 /home/me/pics/subdir/file2.jpg → remote:pics/subdir/file2.jpg</code></pre> 8007 <p>E.g. to copy the following files referenced by their absolute paths:</p> 8008 <pre><code>/home/user1/42 8009 /home/user1/dir/ford 8010 /home/user2/prefect</code></pre> 8011 <p>First 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>, e.g.</p> 8012 <pre><code>user1/42 8013 user1/dir/ford 8014 user2/prefect</code></pre> 8015 <p>Then copy these to a remote:</p> 8016 <pre><code>rclone copy --files-from files-from.txt /home remote:backup</code></pre> 8017 <p>The three files are transferred as follows:</p> 8018 <pre><code>/home/user1/42 → remote:backup/user1/important 8019 /home/user1/dir/ford → remote:backup/user1/dir/file 8020 /home/user2/prefect → remote:backup/user2/stuff</code></pre> 8021 <p>Alternatively if <code>/</code> is chosen as root <code>files-from.txt</code> will be:</p> 8022 <pre><code>/home/user1/42 8023 /home/user1/dir/ford 8024 /home/user2/prefect</code></pre> 8025 <p>The copy command will be:</p> 8026 <pre><code>rclone copy --files-from files-from.txt / remote:backup</code></pre> 8027 <p>Then there will be an extra <code>home</code> directory on the remote:</p> 8028 <pre><code>/home/user1/42 → remote:backup/home/user1/42 8029 /home/user1/dir/ford → remote:backup/home/user1/dir/ford 8030 /home/user2/prefect → remote:backup/home/user2/prefect</code></pre> 8031 <h3 id="files-from-raw---read-list-of-source-file-names-without-any-processing"><code>--files-from-raw</code> - Read list of source-file names without any processing</h3> 8032 <p>This flag is the same as <code>--files-from</code> except that input is read in a raw manner. Lines with leading / trailing whitespace, and lines starting with <code>;</code> or <code>#</code> are read without any processing. <a href="https://rclone.org/commands/rclone_lsf/">rclone lsf</a> has a compatible format that can be used to export file lists from remotes for input to <code>--files-from-raw</code>.</p> 8033 <h3 id="ignore-case---make-searches-case-insensitive"><code>--ignore-case</code> - make searches case insensitive</h3> 8034 <p>By default, rclone filter patterns are case sensitive. The <code>--ignore-case</code> flag makes all of the filters patterns on the command line case insensitive.</p> 8035 <p>E.g. <code>--include "zaphod.txt"</code> does not match a file <code>Zaphod.txt</code>. With <code>--ignore-case</code> a match is made.</p> 8036 <h2 id="quoting-shell-metacharacters">Quoting shell metacharacters</h2> 8037 <p>Rclone commands with filter patterns containing shell metacharacters may not as work as expected in your shell and may require quoting.</p> 8038 <p>E.g. linux, OSX (<code>*</code> metacharacter)</p> 8039 <ul> 8040 <li><code>--include \*.jpg</code></li> 8041 <li><code>--include '*.jpg'</code></li> 8042 <li><code>--include='*.jpg'</code></li> 8043 </ul> 8044 <p>Microsoft Windows expansion is done by the command, not shell, so <code>--include *.jpg</code> does not require quoting.</p> 8045 <p>If the rclone error <code>Command .... needs .... arguments maximum: you provided .... non flag arguments:</code> is encountered, the cause is commonly spaces within the name of a remote or flag value. The fix then is to quote values containing spaces.</p> 8046 <h2 id="other-filters">Other filters</h2> 8047 <h3 id="min-size---dont-transfer-any-file-smaller-than-this"><code>--min-size</code> - Don't transfer any file smaller than this</h3> 8048 <p>Controls the minimum size file within the scope of an rclone command. Default units are <code>KiB</code> but abbreviations <code>K</code>, <code>M</code>, <code>G</code>, <code>T</code> or <code>P</code> are valid.</p> 8049 <p>E.g. <code>rclone ls remote: --min-size 50k</code> lists files on <code>remote:</code> of 50 KiB size or larger.</p> 8050 <p>See <a href="https://rclone.org/docs/#size-option">the size option docs</a> for more info.</p> 8051 <h3 id="max-size---dont-transfer-any-file-larger-than-this"><code>--max-size</code> - Don't transfer any file larger than this</h3> 8052 <p>Controls the maximum size file within the scope of an rclone command. Default units are <code>KiB</code> but abbreviations <code>K</code>, <code>M</code>, <code>G</code>, <code>T</code> or <code>P</code> are valid.</p> 8053 <p>E.g. <code>rclone ls remote: --max-size 1G</code> lists files on <code>remote:</code> of 1 GiB size or smaller.</p> 8054 <p>See <a href="https://rclone.org/docs/#size-option">the size option docs</a> for more info.</p> 8055 <h3 id="max-age---dont-transfer-any-file-older-than-this"><code>--max-age</code> - Don't transfer any file older than this</h3> 8056 <p>Controls the maximum age of files within the scope of an rclone command.</p> 8057 <p><code>--max-age</code> applies only to files and not to directories.</p> 8058 <p>E.g. <code>rclone ls remote: --max-age 2d</code> lists files on <code>remote:</code> of 2 days old or less.</p> 8059 <p>See <a href="https://rclone.org/docs/#time-option">the time option docs</a> for valid formats.</p> 8060 <h3 id="min-age---dont-transfer-any-file-younger-than-this"><code>--min-age</code> - Don't transfer any file younger than this</h3> 8061 <p>Controls the minimum age of files within the scope of an rclone command. (see <code>--max-age</code> for valid formats)</p> 8062 <p><code>--min-age</code> applies only to files and not to directories.</p> 8063 <p>E.g. <code>rclone ls remote: --min-age 2d</code> lists files on <code>remote:</code> of 2 days old or more.</p> 8064 <p>See <a href="https://rclone.org/docs/#time-option">the time option docs</a> for valid formats.</p> 8065 <h2 id="other-flags">Other flags</h2> 8066 <h3 id="delete-excluded---delete-files-on-dest-excluded-from-sync"><code>--delete-excluded</code> - Delete files on dest excluded from sync</h3> 8067 <p><strong>Important</strong> this flag is dangerous to your data - use with <code>--dry-run</code> and <code>-v</code> first.</p> 8068 <p>In conjunction with <code>rclone sync</code>, <code>--delete-excluded</code> deletes any files on the destination which are excluded from the command.</p> 8069 <p>E.g. the scope of <code>rclone sync --interactive A: B:</code> can be restricted:</p> 8070 <pre><code>rclone --min-size 50k --delete-excluded sync A: B:</code></pre> 8071 <p>All files on <code>B:</code> which are less than 50 KiB are deleted because they are excluded from the rclone sync command.</p> 8072 <h3 id="dump-filters---dump-the-filters-to-the-output"><code>--dump filters</code> - dump the filters to the output</h3> 8073 <p>Dumps the defined filters to standard output in regular expression format.</p> 8074 <p>Useful for debugging.</p> 8075 <h2 id="exclude-directory-based-on-a-file">Exclude directory based on a file</h2> 8076 <p>The <code>--exclude-if-present</code> flag controls whether a directory is within the scope of an rclone command based on the presence of a named file within it. The flag can be repeated to check for multiple file names, presence of any of them will exclude the directory.</p> 8077 <p>This flag has a priority over other filter flags.</p> 8078 <p>E.g. for the following directory structure:</p> 8079 <pre><code>dir1/file1 8080 dir1/dir2/file2 8081 dir1/dir2/dir3/file3 8082 dir1/dir2/dir3/.ignore</code></pre> 8083 <p>The command <code>rclone ls --exclude-if-present .ignore dir1</code> does not list <code>dir3</code>, <code>file3</code> or <code>.ignore</code>.</p> 8084 <h2 id="metadata">Metadata filters</h2> 8085 <p>The metadata filters work in a very similar way to the normal file name filters, except they match <a href="https://rclone.org/docs/#metadata">metadata</a> on the object.</p> 8086 <p>The metadata should be specified as <code>key=value</code> patterns. This may be wildcarded using the normal <a href="#patterns">filter patterns</a> or <a href="#regexp">regular expressions</a>.</p> 8087 <p>For example if you wished to list only local files with a mode of <code>100664</code> you could do that with:</p> 8088 <pre><code>rclone lsf -M --files-only --metadata-include "mode=100664" .</code></pre> 8089 <p>Or if you wished to show files with an <code>atime</code>, <code>mtime</code> or <code>btime</code> at a given date:</p> 8090 <pre><code>rclone lsf -M --files-only --metadata-include "[abm]time=2022-12-16*" .</code></pre> 8091 <p>Like file filtering, metadata filtering only applies to files not to directories.</p> 8092 <p>The filters can be applied using these flags.</p> 8093 <ul> 8094 <li><code>--metadata-include</code> - Include metadatas matching pattern</li> 8095 <li><code>--metadata-include-from</code> - Read metadata include patterns from file (use - to read from stdin)</li> 8096 <li><code>--metadata-exclude</code> - Exclude metadatas matching pattern</li> 8097 <li><code>--metadata-exclude-from</code> - Read metadata exclude patterns from file (use - to read from stdin)</li> 8098 <li><code>--metadata-filter</code> - Add a metadata filtering rule</li> 8099 <li><code>--metadata-filter-from</code> - Read metadata filtering patterns from a file (use - to read from stdin)</li> 8100 </ul> 8101 <p>Each flag can be repeated. See the section on <a href="#how-filter-rules-work">how filter rules are applied</a> for more details - these flags work in an identical way to the file name filtering flags, but instead of file name patterns have metadata patterns.</p> 8102 <h2 id="common-pitfalls">Common pitfalls</h2> 8103 <p>The most frequent filter support issues on the <a href="https://forum.rclone.org/">rclone forum</a> are:</p> 8104 <ul> 8105 <li>Not using paths relative to the root of the remote</li> 8106 <li>Not using <code>/</code> to match from the root of a remote</li> 8107 <li>Not using <code>**</code> to match the contents of a directory</li> 8108 </ul> 8109 <h1 id="gui-experimental">GUI (Experimental)</h1> 8110 <p>Rclone can serve a web based GUI (graphical user interface). This is somewhat experimental at the moment so things may be subject to change.</p> 8111 <p>Run this command in a terminal and rclone will download and then display the GUI in a web browser.</p> 8112 <pre><code>rclone rcd --rc-web-gui</code></pre> 8113 <p>This will produce logs like this and rclone needs to continue to run to serve the GUI:</p> 8114 <pre><code>2019/08/25 11:40:14 NOTICE: A new release for gui is present at https://github.com/rclone/rclone-webui-react/releases/download/v0.0.6/currentbuild.zip 8115 2019/08/25 11:40:14 NOTICE: Downloading webgui binary. Please wait. [Size: 3813937, Path : /home/USER/.cache/rclone/webgui/v0.0.6.zip] 8116 2019/08/25 11:40:16 NOTICE: Unzipping 8117 2019/08/25 11:40:16 NOTICE: Serving remote control on http://127.0.0.1:5572/</code></pre> 8118 <p>This assumes you are running rclone locally on your machine. It is possible to separate the rclone and the GUI - see below for details.</p> 8119 <p>If you wish to check for updates then you can add <code>--rc-web-gui-update</code> to the command line.</p> 8120 <p>If you find your GUI broken, you may force it to update by add <code>--rc-web-gui-force-update</code>.</p> 8121 <p>By default, rclone will open your browser. Add <code>--rc-web-gui-no-open-browser</code> to disable this feature.</p> 8122 <h2 id="using-the-gui">Using the GUI</h2> 8123 <p>Once the GUI opens, you will be looking at the dashboard which has an overall overview.</p> 8124 <p>On the left hand side you will see a series of view buttons you can click on:</p> 8125 <ul> 8126 <li>Dashboard - main overview</li> 8127 <li>Configs - examine and create new configurations</li> 8128 <li>Explorer - view, download and upload files to the cloud storage systems</li> 8129 <li>Backend - view or alter the backend config</li> 8130 <li>Log out</li> 8131 </ul> 8132 <p>(More docs and walkthrough video to come!)</p> 8133 <h2 id="how-it-works">How it works</h2> 8134 <p>When you run the <code>rclone rcd --rc-web-gui</code> this is what happens</p> 8135 <ul> 8136 <li>Rclone starts but only runs the remote control API ("rc").</li> 8137 <li>The API is bound to localhost with an auto-generated username and password.</li> 8138 <li>If the API bundle is missing then rclone will download it.</li> 8139 <li>rclone will start serving the files from the API bundle over the same port as the API</li> 8140 <li>rclone will open the browser with a <code>login_token</code> so it can log straight in.</li> 8141 </ul> 8142 <h2 id="advanced-use">Advanced use</h2> 8143 <p>The <code>rclone rcd</code> may use any of the <a href="https://rclone.org/rc/#supported-parameters">flags documented on the rc page</a>.</p> 8144 <p>The flag <code>--rc-web-gui</code> is shorthand for</p> 8145 <ul> 8146 <li>Download the web GUI if necessary</li> 8147 <li>Check we are using some authentication</li> 8148 <li><code>--rc-user gui</code></li> 8149 <li><code>--rc-pass <random password></code></li> 8150 <li><code>--rc-serve</code></li> 8151 </ul> 8152 <p>These flags can be overridden as desired.</p> 8153 <p>See also the <a href="https://rclone.org/commands/rclone_rcd/">rclone rcd documentation</a>.</p> 8154 <h3 id="example-running-a-public-gui">Example: Running a public GUI</h3> 8155 <p>For example the GUI could be served on a public port over SSL using an htpasswd file using the following flags:</p> 8156 <ul> 8157 <li><code>--rc-web-gui</code></li> 8158 <li><code>--rc-addr :443</code></li> 8159 <li><code>--rc-htpasswd /path/to/htpasswd</code></li> 8160 <li><code>--rc-cert /path/to/ssl.crt</code></li> 8161 <li><code>--rc-key /path/to/ssl.key</code></li> 8162 </ul> 8163 <h3 id="example-running-a-gui-behind-a-proxy">Example: Running a GUI behind a proxy</h3> 8164 <p>If you want to run the GUI behind a proxy at <code>/rclone</code> you could use these flags:</p> 8165 <ul> 8166 <li><code>--rc-web-gui</code></li> 8167 <li><code>--rc-baseurl rclone</code></li> 8168 <li><code>--rc-htpasswd /path/to/htpasswd</code></li> 8169 </ul> 8170 <p>Or instead of htpasswd if you just want a single user and password:</p> 8171 <ul> 8172 <li><code>--rc-user me</code></li> 8173 <li><code>--rc-pass mypassword</code></li> 8174 </ul> 8175 <h2 id="project">Project</h2> 8176 <p>The GUI is being developed in the: <a href="https://github.com/rclone/rclone-webui-react">rclone/rclone-webui-react repository</a>.</p> 8177 <p>Bug reports and contributions are very welcome :-)</p> 8178 <p>If you have questions then please ask them on the <a href="https://forum.rclone.org/">rclone forum</a>.</p> 8179 <h1 id="remote-controlling-rclone-with-its-api">Remote controlling rclone with its API</h1> 8180 <p>If rclone is run with the <code>--rc</code> flag then it starts an HTTP server which can be used to remote control rclone using its API.</p> 8181 <p>You can either use the <a href="#api-rc">rc</a> command to access the API or <a href="#api-http">use HTTP directly</a>.</p> 8182 <p>If you just want to run a remote control then see the <a href="https://rclone.org/commands/rclone_rcd/">rcd</a> command.</p> 8183 <h2 id="supported-parameters">Supported parameters</h2> 8184 <h3 id="rc">--rc</h3> 8185 <p>Flag to start the http server listen on remote requests</p> 8186 <h3 id="rc-addrip">--rc-addr=IP</h3> 8187 <p>IPaddress:Port or :Port to bind server to. (default "localhost:5572")</p> 8188 <h3 id="rc-certkey">--rc-cert=KEY</h3> 8189 <p>SSL PEM key (concatenation of certificate and CA certificate)</p> 8190 <h3 id="rc-client-capath">--rc-client-ca=PATH</h3> 8191 <p>Client certificate authority to verify clients with</p> 8192 <h3 id="rc-htpasswdpath">--rc-htpasswd=PATH</h3> 8193 <p>htpasswd file - if not provided no authentication is done</p> 8194 <h3 id="rc-keypath">--rc-key=PATH</h3> 8195 <p>SSL PEM Private key</p> 8196 <h3 id="rc-max-header-bytesvalue">--rc-max-header-bytes=VALUE</h3> 8197 <p>Maximum size of request header (default 4096)</p> 8198 <h3 id="rc-min-tls-versionvalue">--rc-min-tls-version=VALUE</h3> 8199 <p>The minimum TLS version that is acceptable. Valid values are "tls1.0", "tls1.1", "tls1.2" and "tls1.3" (default "tls1.0").</p> 8200 <h3 id="rc-uservalue">--rc-user=VALUE</h3> 8201 <p>User name for authentication.</p> 8202 <h3 id="rc-passvalue">--rc-pass=VALUE</h3> 8203 <p>Password for authentication.</p> 8204 <h3 id="rc-realmvalue">--rc-realm=VALUE</h3> 8205 <p>Realm for authentication (default "rclone")</p> 8206 <h3 id="rc-server-read-timeoutduration">--rc-server-read-timeout=DURATION</h3> 8207 <p>Timeout for server reading data (default 1h0m0s)</p> 8208 <h3 id="rc-server-write-timeoutduration">--rc-server-write-timeout=DURATION</h3> 8209 <p>Timeout for server writing data (default 1h0m0s)</p> 8210 <h3 id="rc-serve">--rc-serve</h3> 8211 <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> 8212 <p>Default Off.</p> 8213 <h3 id="rc-files-pathtodirectory">--rc-files /path/to/directory</h3> 8214 <p>Path to local files to serve on the HTTP server.</p> 8215 <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> 8216 <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> 8217 <p>Default Off.</p> 8218 <h3 id="rc-enable-metrics">--rc-enable-metrics</h3> 8219 <p>Enable OpenMetrics/Prometheus compatible endpoint at <code>/metrics</code>.</p> 8220 <p>Default Off.</p> 8221 <h3 id="rc-web-gui">--rc-web-gui</h3> 8222 <p>Set this flag to serve the default web gui on the same port as rclone.</p> 8223 <p>Default Off.</p> 8224 <h3 id="rc-allow-origin">--rc-allow-origin</h3> 8225 <p>Set the allowed Access-Control-Allow-Origin for rc requests.</p> 8226 <p>Can be used with --rc-web-gui if the rclone is running on different IP than the web-gui.</p> 8227 <p>Default is IP address on which rc is running.</p> 8228 <h3 id="rc-web-fetch-url">--rc-web-fetch-url</h3> 8229 <p>Set the URL to fetch the rclone-web-gui files from.</p> 8230 <p>Default https://api.github.com/repos/rclone/rclone-webui-react/releases/latest.</p> 8231 <h3 id="rc-web-gui-update">--rc-web-gui-update</h3> 8232 <p>Set this flag to check and update rclone-webui-react from the rc-web-fetch-url.</p> 8233 <p>Default Off.</p> 8234 <h3 id="rc-web-gui-force-update">--rc-web-gui-force-update</h3> 8235 <p>Set this flag to force update rclone-webui-react from the rc-web-fetch-url.</p> 8236 <p>Default Off.</p> 8237 <h3 id="rc-web-gui-no-open-browser">--rc-web-gui-no-open-browser</h3> 8238 <p>Set this flag to disable opening browser automatically when using web-gui.</p> 8239 <p>Default Off.</p> 8240 <h3 id="rc-job-expire-durationduration">--rc-job-expire-duration=DURATION</h3> 8241 <p>Expire finished async jobs older than DURATION (default 60s).</p> 8242 <h3 id="rc-job-expire-intervalduration">--rc-job-expire-interval=DURATION</h3> 8243 <p>Interval duration to check for expired async jobs (default 10s).</p> 8244 <h3 id="rc-no-auth">--rc-no-auth</h3> 8245 <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> 8246 <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> 8247 <p>Default Off.</p> 8248 <h3 id="rc-baseurl">--rc-baseurl</h3> 8249 <p>Prefix for URLs.</p> 8250 <p>Default is root</p> 8251 <h3 id="rc-template">--rc-template</h3> 8252 <p>User-specified template.</p> 8253 <h2 id="api-rc">Accessing the remote control via the rclone rc command</h2> 8254 <p>Rclone itself implements the remote control protocol in its <code>rclone rc</code> command.</p> 8255 <p>You can use it like this</p> 8256 <pre><code>$ rclone rc rc/noop param1=one param2=two 8257 { 8258 "param1": "one", 8259 "param2": "two" 8260 }</code></pre> 8261 <p>Run <code>rclone rc</code> on its own to see the help for the installed remote control commands.</p> 8262 <h2 id="json-input">JSON input</h2> 8263 <p><code>rclone rc</code> also supports a <code>--json</code> flag which can be used to send more complicated input parameters.</p> 8264 <pre><code>$ rclone rc --json '{ "p1": [1,"2",null,4], "p2": { "a":1, "b":2 } }' rc/noop 8265 { 8266 "p1": [ 8267 1, 8268 "2", 8269 null, 8270 4 8271 ], 8272 "p2": { 8273 "a": 1, 8274 "b": 2 8275 } 8276 }</code></pre> 8277 <p>If the parameter being passed is an object then it can be passed as a JSON string rather than using the <code>--json</code> flag which simplifies the command line.</p> 8278 <pre><code>rclone rc operations/list fs=/tmp remote=test opt='{"showHash": true}'</code></pre> 8279 <p>Rather than</p> 8280 <pre><code>rclone rc operations/list --json '{"fs": "/tmp", "remote": "test", "opt": {"showHash": true}}'</code></pre> 8281 <h2 id="special-parameters">Special parameters</h2> 8282 <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> 8283 <h3 id="running-asynchronous-jobs-with-_async-true">Running asynchronous jobs with _async = true</h3> 8284 <p>Each rc call is classified as a job and it is assigned its own id. By default jobs are executed immediately as they are created or synchronously.</p> 8285 <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> 8286 <p>It is recommended that potentially long running jobs, e.g. <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> 8287 <p>Starting a job with the <code>_async</code> flag:</p> 8288 <pre><code>$ rclone rc --json '{ "p1": [1,"2",null,4], "p2": { "a":1, "b":2 }, "_async": true }' rc/noop 8289 { 8290 "jobid": 2 8291 }</code></pre> 8292 <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> 8293 <pre><code>$ rclone rc --json '{ "jobid":2 }' job/status 8294 { 8295 "duration": 0.000124163, 8296 "endTime": "2018-10-27T11:38:07.911245881+01:00", 8297 "error": "", 8298 "finished": true, 8299 "id": 2, 8300 "output": { 8301 "_async": true, 8302 "p1": [ 8303 1, 8304 "2", 8305 null, 8306 4 8307 ], 8308 "p2": { 8309 "a": 1, 8310 "b": 2 8311 } 8312 }, 8313 "startTime": "2018-10-27T11:38:07.911121728+01:00", 8314 "success": true 8315 }</code></pre> 8316 <p><code>job/list</code> can be used to show the running or recently completed jobs</p> 8317 <pre><code>$ rclone rc job/list 8318 { 8319 "jobids": [ 8320 2 8321 ] 8322 }</code></pre> 8323 <h3 id="setting-config-flags-with-_config">Setting config flags with _config</h3> 8324 <p>If you wish to set config (the equivalent of the global flags) for the duration of an rc call only then pass in the <code>_config</code> parameter.</p> 8325 <p>This should be in the same format as the <code>config</code> key returned by <a href="#options-get">options/get</a>.</p> 8326 <p>For example, if you wished to run a sync with the <code>--checksum</code> parameter, you would pass this parameter in your JSON blob.</p> 8327 <pre><code>"_config":{"CheckSum": true}</code></pre> 8328 <p>If using <code>rclone rc</code> this could be passed as</p> 8329 <pre><code>rclone rc sync/sync ... _config='{"CheckSum": true}'</code></pre> 8330 <p>Any config parameters you don't set will inherit the global defaults which were set with command line flags or environment variables.</p> 8331 <p>Note that it is possible to set some values as strings or integers - see <a href="#data-types">data types</a> for more info. Here is an example setting the equivalent of <code>--buffer-size</code> in string or integer format.</p> 8332 <pre><code>"_config":{"BufferSize": "42M"} 8333 "_config":{"BufferSize": 44040192}</code></pre> 8334 <p>If you wish to check the <code>_config</code> assignment has worked properly then calling <code>options/local</code> will show what the value got set to.</p> 8335 <h3 id="setting-filter-flags-with-_filter">Setting filter flags with _filter</h3> 8336 <p>If you wish to set filters for the duration of an rc call only then pass in the <code>_filter</code> parameter.</p> 8337 <p>This should be in the same format as the <code>filter</code> key returned by <a href="#options-get">options/get</a>.</p> 8338 <p>For example, if you wished to run a sync with these flags</p> 8339 <pre><code>--max-size 1M --max-age 42s --include "a" --include "b"</code></pre> 8340 <p>you would pass this parameter in your JSON blob.</p> 8341 <pre><code>"_filter":{"MaxSize":"1M", "IncludeRule":["a","b"], "MaxAge":"42s"}</code></pre> 8342 <p>If using <code>rclone rc</code> this could be passed as</p> 8343 <pre><code>rclone rc ... _filter='{"MaxSize":"1M", "IncludeRule":["a","b"], "MaxAge":"42s"}'</code></pre> 8344 <p>Any filter parameters you don't set will inherit the global defaults which were set with command line flags or environment variables.</p> 8345 <p>Note that it is possible to set some values as strings or integers - see <a href="#data-types">data types</a> for more info. Here is an example setting the equivalent of <code>--buffer-size</code> in string or integer format.</p> 8346 <pre><code>"_filter":{"MinSize": "42M"} 8347 "_filter":{"MinSize": 44040192}</code></pre> 8348 <p>If you wish to check the <code>_filter</code> assignment has worked properly then calling <code>options/local</code> will show what the value got set to.</p> 8349 <h3 id="assigning-operations-to-groups-with-_group-value">Assigning operations to groups with _group = value</h3> 8350 <p>Each rc call has its own stats group for tracking its metrics. By default grouping is done by the composite group name from prefix <code>job/</code> and id of the job like so <code>job/1</code>.</p> 8351 <p>If <code>_group</code> has a value then stats for that request will be grouped under that value. This allows caller to group stats under their own name.</p> 8352 <p>Stats for specific group can be accessed by passing <code>group</code> to <code>core/stats</code>:</p> 8353 <pre><code>$ rclone rc --json '{ "group": "job/1" }' core/stats 8354 { 8355 "speed": 12345 8356 ... 8357 }</code></pre> 8358 <h2 id="data-types">Data types</h2> 8359 <p>When the API returns types, these will mostly be straight forward integer, string or boolean types.</p> 8360 <p>However some of the types returned by the <a href="#options-get">options/get</a> call and taken by the <a href="#options-set">options/set</a> calls as well as the <code>vfsOpt</code>, <code>mountOpt</code> and the <code>_config</code> parameters.</p> 8361 <ul> 8362 <li><code>Duration</code> - these are returned as an integer duration in nanoseconds. They may be set as an integer, or they may be set with time string, eg "5s". See the <a href="https://rclone.org/docs/#options">options section</a> for more info.</li> 8363 <li><code>Size</code> - these are returned as an integer number of bytes. They may be set as an integer or they may be set with a size suffix string, eg "10M". See the <a href="https://rclone.org/docs/#options">options section</a> for more info.</li> 8364 <li>Enumerated type (such as <code>CutoffMode</code>, <code>DumpFlags</code>, <code>LogLevel</code>, <code>VfsCacheMode</code> - these will be returned as an integer and may be set as an integer but more conveniently they can be set as a string, eg "HARD" for <code>CutoffMode</code> or <code>DEBUG</code> for <code>LogLevel</code>.</li> 8365 <li><code>BandwidthSpec</code> - this will be set and returned as a string, eg "1M".</li> 8366 </ul> 8367 <h2 id="specifying-remotes-to-work-on">Specifying remotes to work on</h2> 8368 <p>Remotes are specified with the <code>fs=</code>, <code>srcFs=</code>, <code>dstFs=</code> parameters depending on the command being used.</p> 8369 <p>The parameters can be a string as per the rest of rclone, eg <code>s3:bucket/path</code> or <code>:sftp:/my/dir</code>. They can also be specified as JSON blobs.</p> 8370 <p>If specifying a JSON blob it should be a object mapping strings to strings. These values will be used to configure the remote. There are 3 special values which may be set:</p> 8371 <ul> 8372 <li><code>type</code> - set to <code>type</code> to specify a remote called <code>:type:</code></li> 8373 <li><code>_name</code> - set to <code>name</code> to specify a remote called <code>name:</code></li> 8374 <li><code>_root</code> - sets the root of the remote - may be empty</li> 8375 </ul> 8376 <p>One of <code>_name</code> or <code>type</code> should normally be set. If the <code>local</code> backend is desired then <code>type</code> should be set to <code>local</code>. If <code>_root</code> isn't specified then it defaults to the root of the remote.</p> 8377 <p>For example this JSON is equivalent to <code>remote:/tmp</code></p> 8378 <pre><code>{ 8379 "_name": "remote", 8380 "_path": "/tmp" 8381 }</code></pre> 8382 <p>And this is equivalent to <code>:sftp,host='example.com':/tmp</code></p> 8383 <pre><code>{ 8384 "type": "sftp", 8385 "host": "example.com", 8386 "_path": "/tmp" 8387 }</code></pre> 8388 <p>And this is equivalent to <code>/tmp/dir</code></p> 8389 <pre><code>{ 8390 type = "local", 8391 _ path = "/tmp/dir" 8392 }</code></pre> 8393 <h2 id="supported-commands">Supported commands</h2> 8394 <h3 id="backend-command">backend/command: Runs a backend command.</h3> 8395 <p>This takes the following parameters:</p> 8396 <ul> 8397 <li>command - a string with the command name</li> 8398 <li>fs - a remote name string e.g. "drive:"</li> 8399 <li>arg - a list of arguments for the backend command</li> 8400 <li>opt - a map of string to string of options</li> 8401 </ul> 8402 <p>Returns:</p> 8403 <ul> 8404 <li>result - result from the backend command</li> 8405 </ul> 8406 <p>Example:</p> 8407 <pre><code>rclone rc backend/command command=noop fs=. -o echo=yes -o blue -a path1 -a path2</code></pre> 8408 <p>Returns</p> 8409 <pre><code>{ 8410 "result": { 8411 "arg": [ 8412 "path1", 8413 "path2" 8414 ], 8415 "name": "noop", 8416 "opt": { 8417 "blue": "", 8418 "echo": "yes" 8419 } 8420 } 8421 }</code></pre> 8422 <p>Note that this is the direct equivalent of using this "backend" command:</p> 8423 <pre><code>rclone backend noop . -o echo=yes -o blue path1 path2</code></pre> 8424 <p>Note that arguments must be preceded by the "-a" flag</p> 8425 <p>See the <a href="https://rclone.org/commands/rclone_backend/">backend</a> command for more information.</p> 8426 <p><strong>Authentication is required for this call.</strong></p> 8427 <h3 id="cache-expire">cache/expire: Purge a remote from cache</h3> 8428 <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> 8429 <p>Eg</p> 8430 <pre><code>rclone rc cache/expire remote=path/to/sub/folder/ 8431 rclone rc cache/expire remote=/ withData=true</code></pre> 8432 <h3 id="cache-fetch">cache/fetch: Fetch file chunks</h3> 8433 <p>Ensure the specified file chunks are cached on disk.</p> 8434 <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> 8435 <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> 8436 <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> 8437 <p>Any parameter with a key that starts with "file" can be used to specify files to fetch, e.g.</p> 8438 <pre><code>rclone rc cache/fetch chunks=0 file=hello file2=home/goodbye</code></pre> 8439 <p>File names will automatically be encrypted when the a crypt remote is used on top of the cache.</p> 8440 <h3 id="cache-stats">cache/stats: Get cache stats</h3> 8441 <p>Show statistics for the cache remote.</p> 8442 <h3 id="config-create">config/create: create the config for a remote.</h3> 8443 <p>This takes the following parameters:</p> 8444 <ul> 8445 <li>name - name of remote</li> 8446 <li>parameters - a map of { "key": "value" } pairs</li> 8447 <li>type - type of the new remote</li> 8448 <li>opt - a dictionary of options to control the configuration 8449 <ul> 8450 <li>obscure - declare passwords are plain and need obscuring</li> 8451 <li>noObscure - declare passwords are already obscured and don't need obscuring</li> 8452 <li>nonInteractive - don't interact with a user, return questions</li> 8453 <li>continue - continue the config process with an answer</li> 8454 <li>all - ask all the config questions not just the post config ones</li> 8455 <li>state - state to restart with - used with continue</li> 8456 <li>result - result to restart with - used with continue</li> 8457 </ul></li> 8458 </ul> 8459 <p>See the <a href="https://rclone.org/commands/rclone_config_create/">config create</a> command for more information on the above.</p> 8460 <p><strong>Authentication is required for this call.</strong></p> 8461 <h3 id="config-delete">config/delete: Delete a remote in the config file.</h3> 8462 <p>Parameters:</p> 8463 <ul> 8464 <li>name - name of remote to delete</li> 8465 </ul> 8466 <p>See the <a href="https://rclone.org/commands/rclone_config_delete/">config delete</a> command for more information on the above.</p> 8467 <p><strong>Authentication is required for this call.</strong></p> 8468 <h3 id="config-dump">config/dump: Dumps the config file.</h3> 8469 <p>Returns a JSON object: - key: value</p> 8470 <p>Where keys are remote names and values are the config parameters.</p> 8471 <p>See the <a href="https://rclone.org/commands/rclone_config_dump/">config dump</a> command for more information on the above.</p> 8472 <p><strong>Authentication is required for this call.</strong></p> 8473 <h3 id="config-get">config/get: Get a remote in the config file.</h3> 8474 <p>Parameters:</p> 8475 <ul> 8476 <li>name - name of remote to get</li> 8477 </ul> 8478 <p>See the <a href="https://rclone.org/commands/rclone_config_dump/">config dump</a> command for more information on the above.</p> 8479 <p><strong>Authentication is required for this call.</strong></p> 8480 <h3 id="config-listremotes">config/listremotes: Lists the remotes in the config file and defined in environment variables.</h3> 8481 <p>Returns - remotes - array of remote names</p> 8482 <p>See the <a href="https://rclone.org/commands/rclone_listremotes/">listremotes</a> command for more information on the above.</p> 8483 <p><strong>Authentication is required for this call.</strong></p> 8484 <h3 id="config-password">config/password: password the config for a remote.</h3> 8485 <p>This takes the following parameters:</p> 8486 <ul> 8487 <li>name - name of remote</li> 8488 <li>parameters - a map of { "key": "value" } pairs</li> 8489 </ul> 8490 <p>See the <a href="https://rclone.org/commands/rclone_config_password/">config password</a> command for more information on the above.</p> 8491 <p><strong>Authentication is required for this call.</strong></p> 8492 <h3 id="config-paths">config/paths: Reads the config file path and other important paths.</h3> 8493 <p>Returns a JSON object with the following keys:</p> 8494 <ul> 8495 <li>config: path to config file</li> 8496 <li>cache: path to root of cache directory</li> 8497 <li>temp: path to root of temporary directory</li> 8498 </ul> 8499 <p>Eg</p> 8500 <pre><code>{ 8501 "cache": "/home/USER/.cache/rclone", 8502 "config": "/home/USER/.rclone.conf", 8503 "temp": "/tmp" 8504 }</code></pre> 8505 <p>See the <a href="https://rclone.org/commands/rclone_config_paths/">config paths</a> command for more information on the above.</p> 8506 <p><strong>Authentication is required for this call.</strong></p> 8507 <h3 id="config-providers">config/providers: Shows how providers are configured in the config file.</h3> 8508 <p>Returns a JSON object: - providers - array of objects</p> 8509 <p>See the <a href="https://rclone.org/commands/rclone_config_providers/">config providers</a> command for more information on the above.</p> 8510 <p><strong>Authentication is required for this call.</strong></p> 8511 <h3 id="config-setpath">config/setpath: Set the path of the config file</h3> 8512 <p>Parameters:</p> 8513 <ul> 8514 <li>path - path to the config file to use</li> 8515 </ul> 8516 <p><strong>Authentication is required for this call.</strong></p> 8517 <h3 id="config-update">config/update: update the config for a remote.</h3> 8518 <p>This takes the following parameters:</p> 8519 <ul> 8520 <li>name - name of remote</li> 8521 <li>parameters - a map of { "key": "value" } pairs</li> 8522 <li>opt - a dictionary of options to control the configuration 8523 <ul> 8524 <li>obscure - declare passwords are plain and need obscuring</li> 8525 <li>noObscure - declare passwords are already obscured and don't need obscuring</li> 8526 <li>nonInteractive - don't interact with a user, return questions</li> 8527 <li>continue - continue the config process with an answer</li> 8528 <li>all - ask all the config questions not just the post config ones</li> 8529 <li>state - state to restart with - used with continue</li> 8530 <li>result - result to restart with - used with continue</li> 8531 </ul></li> 8532 </ul> 8533 <p>See the <a href="https://rclone.org/commands/rclone_config_update/">config update</a> command for more information on the above.</p> 8534 <p><strong>Authentication is required for this call.</strong></p> 8535 <h3 id="core-bwlimit">core/bwlimit: Set the bandwidth limit.</h3> 8536 <p>This sets the bandwidth limit to the string passed in. This should be a single bandwidth limit entry or a pair of upload:download bandwidth.</p> 8537 <p>Eg</p> 8538 <pre><code>rclone rc core/bwlimit rate=off 8539 { 8540 "bytesPerSecond": -1, 8541 "bytesPerSecondTx": -1, 8542 "bytesPerSecondRx": -1, 8543 "rate": "off" 8544 } 8545 rclone rc core/bwlimit rate=1M 8546 { 8547 "bytesPerSecond": 1048576, 8548 "bytesPerSecondTx": 1048576, 8549 "bytesPerSecondRx": 1048576, 8550 "rate": "1M" 8551 } 8552 rclone rc core/bwlimit rate=1M:100k 8553 { 8554 "bytesPerSecond": 1048576, 8555 "bytesPerSecondTx": 1048576, 8556 "bytesPerSecondRx": 131072, 8557 "rate": "1M" 8558 }</code></pre> 8559 <p>If the rate parameter is not supplied then the bandwidth is queried</p> 8560 <pre><code>rclone rc core/bwlimit 8561 { 8562 "bytesPerSecond": 1048576, 8563 "bytesPerSecondTx": 1048576, 8564 "bytesPerSecondRx": 1048576, 8565 "rate": "1M" 8566 }</code></pre> 8567 <p>The format of the parameter is exactly the same as passed to --bwlimit except only one bandwidth may be specified.</p> 8568 <p>In either case "rate" is returned as a human-readable string, and "bytesPerSecond" is returned as a number.</p> 8569 <h3 id="core-command">core/command: Run a rclone terminal command over rc.</h3> 8570 <p>This takes the following parameters:</p> 8571 <ul> 8572 <li>command - a string with the command name.</li> 8573 <li>arg - a list of arguments for the backend command.</li> 8574 <li>opt - a map of string to string of options.</li> 8575 <li>returnType - one of ("COMBINED_OUTPUT", "STREAM", "STREAM_ONLY_STDOUT", "STREAM_ONLY_STDERR"). 8576 <ul> 8577 <li>Defaults to "COMBINED_OUTPUT" if not set.</li> 8578 <li>The STREAM returnTypes will write the output to the body of the HTTP message.</li> 8579 <li>The COMBINED_OUTPUT will write the output to the "result" parameter.</li> 8580 </ul></li> 8581 </ul> 8582 <p>Returns:</p> 8583 <ul> 8584 <li>result - result from the backend command. 8585 <ul> 8586 <li>Only set when using returnType "COMBINED_OUTPUT".</li> 8587 </ul></li> 8588 <li>error - set if rclone exits with an error code.</li> 8589 <li>returnType - one of ("COMBINED_OUTPUT", "STREAM", "STREAM_ONLY_STDOUT", "STREAM_ONLY_STDERR").</li> 8590 </ul> 8591 <p>Example:</p> 8592 <pre><code>rclone rc core/command command=ls -a mydrive:/ -o max-depth=1 8593 rclone rc core/command -a ls -a mydrive:/ -o max-depth=1</code></pre> 8594 <p>Returns:</p> 8595 <pre><code>{ 8596 "error": false, 8597 "result": "<Raw command line output>" 8598 } 8599 8600 OR 8601 { 8602 "error": true, 8603 "result": "<Raw command line output>" 8604 } 8605 </code></pre> 8606 <p><strong>Authentication is required for this call.</strong></p> 8607 <h3 id="core-du">core/du: Returns disk usage of a locally attached disk.</h3> 8608 <p>This returns the disk usage for the local directory passed in as dir.</p> 8609 <p>If the directory is not passed in, it defaults to the directory pointed to by --cache-dir.</p> 8610 <ul> 8611 <li>dir - string (optional)</li> 8612 </ul> 8613 <p>Returns:</p> 8614 <pre><code>{ 8615 "dir": "/", 8616 "info": { 8617 "Available": 361769115648, 8618 "Free": 361785892864, 8619 "Total": 982141468672 8620 } 8621 }</code></pre> 8622 <h3 id="core-gc">core/gc: Runs a garbage collection.</h3> 8623 <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> 8624 <h3 id="core-group-list">core/group-list: Returns list of stats.</h3> 8625 <p>This returns list of stats groups currently in memory.</p> 8626 <p>Returns the following values:</p> 8627 <pre><code>{ 8628 "groups": an array of group names: 8629 [ 8630 "group1", 8631 "group2", 8632 ... 8633 ] 8634 }</code></pre> 8635 <h3 id="core-memstats">core/memstats: Returns the memory statistics</h3> 8636 <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> 8637 <p>The most interesting values for most people are:</p> 8638 <ul> 8639 <li>HeapAlloc - this is the amount of memory rclone is actually using</li> 8640 <li>HeapSys - this is the amount of memory rclone has obtained from the OS</li> 8641 <li>Sys - this is the total amount of memory requested from the OS 8642 <ul> 8643 <li>It is virtual memory so may include unused memory</li> 8644 </ul></li> 8645 </ul> 8646 <h3 id="core-obscure">core/obscure: Obscures a string passed in.</h3> 8647 <p>Pass a clear string and rclone will obscure it for the config file: - clear - string</p> 8648 <p>Returns: - obscured - string</p> 8649 <h3 id="core-pid">core/pid: Return PID of current process</h3> 8650 <p>This returns PID of current process. Useful for stopping rclone process.</p> 8651 <h3 id="core-quit">core/quit: Terminates the app.</h3> 8652 <p>(Optional) Pass an exit code to be used for terminating the app: - exitCode - int</p> 8653 <h3 id="core-stats">core/stats: Returns stats about current transfers.</h3> 8654 <p>This returns all available stats:</p> 8655 <pre><code>rclone rc core/stats</code></pre> 8656 <p>If group is not provided then summed up stats for all groups will be returned.</p> 8657 <p>Parameters</p> 8658 <ul> 8659 <li>group - name of the stats group (string)</li> 8660 </ul> 8661 <p>Returns the following values:</p> 8662 <pre><code>{ 8663 "bytes": total transferred bytes since the start of the group, 8664 "checks": number of files checked, 8665 "deletes" : number of files deleted, 8666 "elapsedTime": time in floating point seconds since rclone was started, 8667 "errors": number of errors, 8668 "eta": estimated time in seconds until the group completes, 8669 "fatalError": boolean whether there has been at least one fatal error, 8670 "lastError": last error string, 8671 "renames" : number of files renamed, 8672 "retryError": boolean showing whether there has been at least one non-NoRetryError, 8673 "serverSideCopies": number of server side copies done, 8674 "serverSideCopyBytes": number bytes server side copied, 8675 "serverSideMoves": number of server side moves done, 8676 "serverSideMoveBytes": number bytes server side moved, 8677 "speed": average speed in bytes per second since start of the group, 8678 "totalBytes": total number of bytes in the group, 8679 "totalChecks": total number of checks in the group, 8680 "totalTransfers": total number of transfers in the group, 8681 "transferTime" : total time spent on running jobs, 8682 "transfers": number of transferred files, 8683 "transferring": an array of currently active file transfers: 8684 [ 8685 { 8686 "bytes": total transferred bytes for this file, 8687 "eta": estimated time in seconds until file transfer completion 8688 "name": name of the file, 8689 "percentage": progress of the file transfer in percent, 8690 "speed": average speed over the whole transfer in bytes per second, 8691 "speedAvg": current speed in bytes per second as an exponentially weighted moving average, 8692 "size": size of the file in bytes 8693 } 8694 ], 8695 "checking": an array of names of currently active file checks 8696 [] 8697 }</code></pre> 8698 <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> 8699 <h3 id="core-stats-delete">core/stats-delete: Delete stats group.</h3> 8700 <p>This deletes entire stats group.</p> 8701 <p>Parameters</p> 8702 <ul> 8703 <li>group - name of the stats group (string)</li> 8704 </ul> 8705 <h3 id="core-stats-reset">core/stats-reset: Reset stats.</h3> 8706 <p>This clears counters, errors and finished transfers for all stats or specific stats group if group is provided.</p> 8707 <p>Parameters</p> 8708 <ul> 8709 <li>group - name of the stats group (string)</li> 8710 </ul> 8711 <h3 id="core-transferred">core/transferred: Returns stats about completed transfers.</h3> 8712 <p>This returns stats about completed transfers:</p> 8713 <pre><code>rclone rc core/transferred</code></pre> 8714 <p>If group is not provided then completed transfers for all groups will be returned.</p> 8715 <p>Note only the last 100 completed transfers are returned.</p> 8716 <p>Parameters</p> 8717 <ul> 8718 <li>group - name of the stats group (string)</li> 8719 </ul> 8720 <p>Returns the following values:</p> 8721 <pre><code>{ 8722 "transferred": an array of completed transfers (including failed ones): 8723 [ 8724 { 8725 "name": name of the file, 8726 "size": size of the file in bytes, 8727 "bytes": total transferred bytes for this file, 8728 "checked": if the transfer is only checked (skipped, deleted), 8729 "timestamp": integer representing millisecond unix epoch, 8730 "error": string description of the error (empty if successful), 8731 "jobid": id of the job that this transfer belongs to 8732 } 8733 ] 8734 }</code></pre> 8735 <h3 id="core-version">core/version: Shows the current version of rclone and the go runtime.</h3> 8736 <p>This shows the current version of go and the go runtime:</p> 8737 <ul> 8738 <li>version - rclone version, e.g. "v1.53.0"</li> 8739 <li>decomposed - version number as [major, minor, patch]</li> 8740 <li>isGit - boolean - true if this was compiled from the git version</li> 8741 <li>isBeta - boolean - true if this is a beta version</li> 8742 <li>os - OS in use as according to Go</li> 8743 <li>arch - cpu architecture in use according to Go</li> 8744 <li>goVersion - version of Go runtime in use</li> 8745 <li>linking - type of rclone executable (static or dynamic)</li> 8746 <li>goTags - space separated build tags or "none"</li> 8747 </ul> 8748 <h3 id="debug-set-block-profile-rate">debug/set-block-profile-rate: Set runtime.SetBlockProfileRate for blocking profiling.</h3> 8749 <p>SetBlockProfileRate controls the fraction of goroutine blocking events that are reported in the blocking profile. The profiler aims to sample an average of one blocking event per rate nanoseconds spent blocked.</p> 8750 <p>To include every blocking event in the profile, pass rate = 1. To turn off profiling entirely, pass rate <= 0.</p> 8751 <p>After calling this you can use this to see the blocking profile:</p> 8752 <pre><code>go tool pprof http://localhost:5572/debug/pprof/block</code></pre> 8753 <p>Parameters:</p> 8754 <ul> 8755 <li>rate - int</li> 8756 </ul> 8757 <h3 id="debug-set-gc-percent">debug/set-gc-percent: Call runtime/debug.SetGCPercent for setting the garbage collection target percentage.</h3> 8758 <p>SetGCPercent sets the garbage collection target percentage: a collection is triggered when the ratio of freshly allocated data to live data remaining after the previous collection reaches this percentage. SetGCPercent returns the previous setting. The initial setting is the value of the GOGC environment variable at startup, or 100 if the variable is not set.</p> 8759 <p>This setting may be effectively reduced in order to maintain a memory limit. A negative percentage effectively disables garbage collection, unless the memory limit is reached.</p> 8760 <p>See https://pkg.go.dev/runtime/debug#SetMemoryLimit for more details.</p> 8761 <p>Parameters:</p> 8762 <ul> 8763 <li>gc-percent - int</li> 8764 </ul> 8765 <h3 id="debug-set-mutex-profile-fraction">debug/set-mutex-profile-fraction: Set runtime.SetMutexProfileFraction for mutex profiling.</h3> 8766 <p>SetMutexProfileFraction controls the fraction of mutex contention events that are reported in the mutex profile. On average 1/rate events are reported. The previous rate is returned.</p> 8767 <p>To turn off profiling entirely, pass rate 0. To just read the current rate, pass rate < 0. (For n>1 the details of sampling may change.)</p> 8768 <p>Once this is set you can look use this to profile the mutex contention:</p> 8769 <pre><code>go tool pprof http://localhost:5572/debug/pprof/mutex</code></pre> 8770 <p>Parameters:</p> 8771 <ul> 8772 <li>rate - int</li> 8773 </ul> 8774 <p>Results:</p> 8775 <ul> 8776 <li>previousRate - int</li> 8777 </ul> 8778 <h3 id="debug-set-soft-memory-limit">debug/set-soft-memory-limit: Call runtime/debug.SetMemoryLimit for setting a soft memory limit for the runtime.</h3> 8779 <p>SetMemoryLimit provides the runtime with a soft memory limit.</p> 8780 <p>The runtime undertakes several processes to try to respect this memory limit, including adjustments to the frequency of garbage collections and returning memory to the underlying system more aggressively. This limit will be respected even if GOGC=off (or, if SetGCPercent(-1) is executed).</p> 8781 <p>The input limit is provided as bytes, and includes all memory mapped, managed, and not released by the Go runtime. Notably, it does not account for space used by the Go binary and memory external to Go, such as memory managed by the underlying system on behalf of the process, or memory managed by non-Go code inside the same process. Examples of excluded memory sources include: OS kernel memory held on behalf of the process, memory allocated by C code, and memory mapped by syscall.Mmap (because it is not managed by the Go runtime).</p> 8782 <p>A zero limit or a limit that's lower than the amount of memory used by the Go runtime may cause the garbage collector to run nearly continuously. However, the application may still make progress.</p> 8783 <p>The memory limit is always respected by the Go runtime, so to effectively disable this behavior, set the limit very high. math.MaxInt64 is the canonical value for disabling the limit, but values much greater than the available memory on the underlying system work just as well.</p> 8784 <p>See https://go.dev/doc/gc-guide for a detailed guide explaining the soft memory limit in more detail, as well as a variety of common use-cases and scenarios.</p> 8785 <p>SetMemoryLimit returns the previously set memory limit. A negative input does not adjust the limit, and allows for retrieval of the currently set memory limit.</p> 8786 <p>Parameters:</p> 8787 <ul> 8788 <li>mem-limit - int</li> 8789 </ul> 8790 <h3 id="fscache-clear">fscache/clear: Clear the Fs cache.</h3> 8791 <p>This clears the fs cache. This is where remotes created from backends are cached for a short while to make repeated rc calls more efficient.</p> 8792 <p>If you change the parameters of a backend then you may want to call this to clear an existing remote out of the cache before re-creating it.</p> 8793 <p><strong>Authentication is required for this call.</strong></p> 8794 <h3 id="fscache-entries">fscache/entries: Returns the number of entries in the fs cache.</h3> 8795 <p>This returns the number of entries in the fs cache.</p> 8796 <p>Returns - entries - number of items in the cache</p> 8797 <p><strong>Authentication is required for this call.</strong></p> 8798 <h3 id="job-list">job/list: Lists the IDs of the running jobs</h3> 8799 <p>Parameters: None.</p> 8800 <p>Results:</p> 8801 <ul> 8802 <li>executeId - string id of rclone executing (change after restart)</li> 8803 <li>jobids - array of integer job ids (starting at 1 on each restart)</li> 8804 </ul> 8805 <h3 id="job-status">job/status: Reads the status of the job ID</h3> 8806 <p>Parameters:</p> 8807 <ul> 8808 <li>jobid - id of the job (integer).</li> 8809 </ul> 8810 <p>Results:</p> 8811 <ul> 8812 <li>finished - boolean</li> 8813 <li>duration - time in seconds that the job ran for</li> 8814 <li>endTime - time the job finished (e.g. "2018-10-26T18:50:20.528746884+01:00")</li> 8815 <li>error - error from the job or empty string for no error</li> 8816 <li>finished - boolean whether the job has finished or not</li> 8817 <li>id - as passed in above</li> 8818 <li>startTime - time the job started (e.g. "2018-10-26T18:50:20.528336039+01:00")</li> 8819 <li>success - boolean - true for success false otherwise</li> 8820 <li>output - output of the job as would have been returned if called synchronously</li> 8821 <li>progress - output of the progress related to the underlying job</li> 8822 </ul> 8823 <h3 id="job-stop">job/stop: Stop the running job</h3> 8824 <p>Parameters:</p> 8825 <ul> 8826 <li>jobid - id of the job (integer).</li> 8827 </ul> 8828 <h3 id="job-stopgroup">job/stopgroup: Stop all running jobs in a group</h3> 8829 <p>Parameters:</p> 8830 <ul> 8831 <li>group - name of the group (string).</li> 8832 </ul> 8833 <h3 id="mount-listmounts">mount/listmounts: Show current mount points</h3> 8834 <p>This shows currently mounted points, which can be used for performing an unmount.</p> 8835 <p>This takes no parameters and returns</p> 8836 <ul> 8837 <li>mountPoints: list of current mount points</li> 8838 </ul> 8839 <p>Eg</p> 8840 <pre><code>rclone rc mount/listmounts</code></pre> 8841 <p><strong>Authentication is required for this call.</strong></p> 8842 <h3 id="mount-mount">mount/mount: Create a new mount point</h3> 8843 <p>rclone allows Linux, FreeBSD, macOS and Windows to mount any of Rclone's cloud storage systems as a file system with FUSE.</p> 8844 <p>If no mountType is provided, the priority is given as follows: 1. mount 2.cmount 3.mount2</p> 8845 <p>This takes the following parameters:</p> 8846 <ul> 8847 <li>fs - a remote path to be mounted (required)</li> 8848 <li>mountPoint: valid path on the local machine (required)</li> 8849 <li>mountType: one of the values (mount, cmount, mount2) specifies the mount implementation to use</li> 8850 <li>mountOpt: a JSON object with Mount options in.</li> 8851 <li>vfsOpt: a JSON object with VFS options in.</li> 8852 </ul> 8853 <p>Example:</p> 8854 <pre><code>rclone rc mount/mount fs=mydrive: mountPoint=/home/<user>/mountPoint 8855 rclone rc mount/mount fs=mydrive: mountPoint=/home/<user>/mountPoint mountType=mount 8856 rclone rc mount/mount fs=TestDrive: mountPoint=/mnt/tmp vfsOpt='{"CacheMode": 2}' mountOpt='{"AllowOther": true}'</code></pre> 8857 <p>The vfsOpt are as described in options/get and can be seen in the the "vfs" section when running and the mountOpt can be seen in the "mount" section:</p> 8858 <pre><code>rclone rc options/get</code></pre> 8859 <p><strong>Authentication is required for this call.</strong></p> 8860 <h3 id="mount-types">mount/types: Show all possible mount types</h3> 8861 <p>This shows all possible mount types and returns them as a list.</p> 8862 <p>This takes no parameters and returns</p> 8863 <ul> 8864 <li>mountTypes: list of mount types</li> 8865 </ul> 8866 <p>The mount types are strings like "mount", "mount2", "cmount" and can be passed to mount/mount as the mountType parameter.</p> 8867 <p>Eg</p> 8868 <pre><code>rclone rc mount/types</code></pre> 8869 <p><strong>Authentication is required for this call.</strong></p> 8870 <h3 id="mount-unmount">mount/unmount: Unmount selected active mount</h3> 8871 <p>rclone allows Linux, FreeBSD, macOS and Windows to mount any of Rclone's cloud storage systems as a file system with FUSE.</p> 8872 <p>This takes the following parameters:</p> 8873 <ul> 8874 <li>mountPoint: valid path on the local machine where the mount was created (required)</li> 8875 </ul> 8876 <p>Example:</p> 8877 <pre><code>rclone rc mount/unmount mountPoint=/home/<user>/mountPoint</code></pre> 8878 <p><strong>Authentication is required for this call.</strong></p> 8879 <h3 id="mount-unmountall">mount/unmountall: Unmount all active mounts</h3> 8880 <p>rclone allows Linux, FreeBSD, macOS and Windows to mount any of Rclone's cloud storage systems as a file system with FUSE.</p> 8881 <p>This takes no parameters and returns error if unmount does not succeed.</p> 8882 <p>Eg</p> 8883 <pre><code>rclone rc mount/unmountall</code></pre> 8884 <p><strong>Authentication is required for this call.</strong></p> 8885 <h3 id="operations-about">operations/about: Return the space used on the remote</h3> 8886 <p>This takes the following parameters:</p> 8887 <ul> 8888 <li>fs - a remote name string e.g. "drive:"</li> 8889 </ul> 8890 <p>The result is as returned from rclone about --json</p> 8891 <p>See the <a href="https://rclone.org/commands/rclone_about/">about</a> command for more information on the above.</p> 8892 <p><strong>Authentication is required for this call.</strong></p> 8893 <h3 id="operations-check">operations/check: check the source and destination are the same</h3> 8894 <p>Checks the files in the source and destination match. It compares sizes and hashes and logs a report of files that don't match. It doesn't alter the source or destination.</p> 8895 <p>This takes the following parameters:</p> 8896 <ul> 8897 <li>srcFs - a remote name string e.g. "drive:" for the source, "/" for local filesystem</li> 8898 <li>dstFs - a remote name string e.g. "drive2:" for the destination, "/" for local filesystem</li> 8899 <li>download - check by downloading rather than with hash</li> 8900 <li>checkFileHash - treat checkFileFs:checkFileRemote as a SUM file with hashes of given type</li> 8901 <li>checkFileFs - treat checkFileFs:checkFileRemote as a SUM file with hashes of given type</li> 8902 <li>checkFileRemote - treat checkFileFs:checkFileRemote as a SUM file with hashes of given type</li> 8903 <li>oneWay - check one way only, source files must exist on remote</li> 8904 <li>combined - make a combined report of changes (default false)</li> 8905 <li>missingOnSrc - report all files missing from the source (default true)</li> 8906 <li>missingOnDst - report all files missing from the destination (default true)</li> 8907 <li>match - report all matching files (default false)</li> 8908 <li>differ - report all non-matching files (default true)</li> 8909 <li>error - report all files with errors (hashing or reading) (default true)</li> 8910 </ul> 8911 <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> 8912 <p>If you supply the size-only global flag, it will only compare the sizes not the hashes as well. Use this for a quick check.</p> 8913 <p>If you supply the checkFileHash option with a valid hash name, the checkFileFs:checkFileRemote must point to a text file in the SUM format. This treats the checksum file as the source and dstFs as the destination. Note that srcFs is not used and should not be supplied in this case.</p> 8914 <p>Returns:</p> 8915 <ul> 8916 <li>success - true if no error, false otherwise</li> 8917 <li>status - textual summary of check, OK or text string</li> 8918 <li>hashType - hash used in check, may be missing</li> 8919 <li>combined - array of strings of combined report of changes</li> 8920 <li>missingOnSrc - array of strings of all files missing from the source</li> 8921 <li>missingOnDst - array of strings of all files missing from the destination</li> 8922 <li>match - array of strings of all matching files</li> 8923 <li>differ - array of strings of all non-matching files</li> 8924 <li>error - array of strings of all files with errors (hashing or reading)</li> 8925 </ul> 8926 <p><strong>Authentication is required for this call.</strong></p> 8927 <h3 id="operations-cleanup">operations/cleanup: Remove trashed files in the remote or path</h3> 8928 <p>This takes the following parameters:</p> 8929 <ul> 8930 <li>fs - a remote name string e.g. "drive:"</li> 8931 </ul> 8932 <p>See the <a href="https://rclone.org/commands/rclone_cleanup/">cleanup</a> command for more information on the above.</p> 8933 <p><strong>Authentication is required for this call.</strong></p> 8934 <h3 id="operations-copyfile">operations/copyfile: Copy a file from source remote to destination remote</h3> 8935 <p>This takes the following parameters:</p> 8936 <ul> 8937 <li>srcFs - a remote name string e.g. "drive:" for the source, "/" for local filesystem</li> 8938 <li>srcRemote - a path within that remote e.g. "file.txt" for the source</li> 8939 <li>dstFs - a remote name string e.g. "drive2:" for the destination, "/" for local filesystem</li> 8940 <li>dstRemote - a path within that remote e.g. "file2.txt" for the destination</li> 8941 </ul> 8942 <p><strong>Authentication is required for this call.</strong></p> 8943 <h3 id="operations-copyurl">operations/copyurl: Copy the URL to the object</h3> 8944 <p>This takes the following parameters:</p> 8945 <ul> 8946 <li>fs - a remote name string e.g. "drive:"</li> 8947 <li>remote - a path within that remote e.g. "dir"</li> 8948 <li>url - string, URL to read from</li> 8949 <li>autoFilename - boolean, set to true to retrieve destination file name from url</li> 8950 </ul> 8951 <p>See the <a href="https://rclone.org/commands/rclone_copyurl/">copyurl</a> command for more information on the above.</p> 8952 <p><strong>Authentication is required for this call.</strong></p> 8953 <h3 id="operations-delete">operations/delete: Remove files in the path</h3> 8954 <p>This takes the following parameters:</p> 8955 <ul> 8956 <li>fs - a remote name string e.g. "drive:"</li> 8957 </ul> 8958 <p>See the <a href="https://rclone.org/commands/rclone_delete/">delete</a> command for more information on the above.</p> 8959 <p><strong>Authentication is required for this call.</strong></p> 8960 <h3 id="operations-deletefile">operations/deletefile: Remove the single file pointed to</h3> 8961 <p>This takes the following parameters:</p> 8962 <ul> 8963 <li>fs - a remote name string e.g. "drive:"</li> 8964 <li>remote - a path within that remote e.g. "dir"</li> 8965 </ul> 8966 <p>See the <a href="https://rclone.org/commands/rclone_deletefile/">deletefile</a> command for more information on the above.</p> 8967 <p><strong>Authentication is required for this call.</strong></p> 8968 <h3 id="operations-fsinfo">operations/fsinfo: Return information about the remote</h3> 8969 <p>This takes the following parameters:</p> 8970 <ul> 8971 <li>fs - a remote name string e.g. "drive:"</li> 8972 </ul> 8973 <p>This returns info about the remote passed in;</p> 8974 <pre><code>{ 8975 // optional features and whether they are available or not 8976 "Features": { 8977 "About": true, 8978 "BucketBased": false, 8979 "BucketBasedRootOK": false, 8980 "CanHaveEmptyDirectories": true, 8981 "CaseInsensitive": false, 8982 "ChangeNotify": false, 8983 "CleanUp": false, 8984 "Command": true, 8985 "Copy": false, 8986 "DirCacheFlush": false, 8987 "DirMove": true, 8988 "Disconnect": false, 8989 "DuplicateFiles": false, 8990 "GetTier": false, 8991 "IsLocal": true, 8992 "ListR": false, 8993 "MergeDirs": false, 8994 "MetadataInfo": true, 8995 "Move": true, 8996 "OpenWriterAt": true, 8997 "PublicLink": false, 8998 "Purge": true, 8999 "PutStream": true, 9000 "PutUnchecked": false, 9001 "ReadMetadata": true, 9002 "ReadMimeType": false, 9003 "ServerSideAcrossConfigs": false, 9004 "SetTier": false, 9005 "SetWrapper": false, 9006 "Shutdown": false, 9007 "SlowHash": true, 9008 "SlowModTime": false, 9009 "UnWrap": false, 9010 "UserInfo": false, 9011 "UserMetadata": true, 9012 "WrapFs": false, 9013 "WriteMetadata": true, 9014 "WriteMimeType": false 9015 }, 9016 // Names of hashes available 9017 "Hashes": [ 9018 "md5", 9019 "sha1", 9020 "whirlpool", 9021 "crc32", 9022 "sha256", 9023 "dropbox", 9024 "mailru", 9025 "quickxor" 9026 ], 9027 "Name": "local", // Name as created 9028 "Precision": 1, // Precision of timestamps in ns 9029 "Root": "/", // Path as created 9030 "String": "Local file system at /", // how the remote will appear in logs 9031 // Information about the system metadata for this backend 9032 "MetadataInfo": { 9033 "System": { 9034 "atime": { 9035 "Help": "Time of last access", 9036 "Type": "RFC 3339", 9037 "Example": "2006-01-02T15:04:05.999999999Z07:00" 9038 }, 9039 "btime": { 9040 "Help": "Time of file birth (creation)", 9041 "Type": "RFC 3339", 9042 "Example": "2006-01-02T15:04:05.999999999Z07:00" 9043 }, 9044 "gid": { 9045 "Help": "Group ID of owner", 9046 "Type": "decimal number", 9047 "Example": "500" 9048 }, 9049 "mode": { 9050 "Help": "File type and mode", 9051 "Type": "octal, unix style", 9052 "Example": "0100664" 9053 }, 9054 "mtime": { 9055 "Help": "Time of last modification", 9056 "Type": "RFC 3339", 9057 "Example": "2006-01-02T15:04:05.999999999Z07:00" 9058 }, 9059 "rdev": { 9060 "Help": "Device ID (if special file)", 9061 "Type": "hexadecimal", 9062 "Example": "1abc" 9063 }, 9064 "uid": { 9065 "Help": "User ID of owner", 9066 "Type": "decimal number", 9067 "Example": "500" 9068 } 9069 }, 9070 "Help": "Textual help string\n" 9071 } 9072 }</code></pre> 9073 <p>This command does not have a command line equivalent so use this instead:</p> 9074 <pre><code>rclone rc --loopback operations/fsinfo fs=remote:</code></pre> 9075 <h3 id="operations-hashsum">operations/hashsum: Produces a hashsum file for all the objects in the path.</h3> 9076 <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> 9077 <p>This takes the following parameters:</p> 9078 <ul> 9079 <li>fs - a remote name string e.g. "drive:" for the source, "/" for local filesystem 9080 <ul> 9081 <li>this can point to a file and just that file will be returned in the listing.</li> 9082 </ul></li> 9083 <li>hashType - type of hash to be used</li> 9084 <li>download - check by downloading rather than with hash (boolean)</li> 9085 <li>base64 - output the hashes in base64 rather than hex (boolean)</li> 9086 </ul> 9087 <p>If you supply the download flag, it will download the data from the remote and create the hash on the fly. This can be useful for remotes that don't support the given hash or if you really want to check all the data.</p> 9088 <p>Note that if you wish to supply a checkfile to check hashes against the current files then you should use operations/check instead of operations/hashsum.</p> 9089 <p>Returns:</p> 9090 <ul> 9091 <li>hashsum - array of strings of the hashes</li> 9092 <li>hashType - type of hash used</li> 9093 </ul> 9094 <p>Example:</p> 9095 <pre><code>$ rclone rc --loopback operations/hashsum fs=bin hashType=MD5 download=true base64=true 9096 { 9097 "hashType": "md5", 9098 "hashsum": [ 9099 "WTSVLpuiXyJO_kGzJerRLg== backend-versions.sh", 9100 "v1b_OlWCJO9LtNq3EIKkNQ== bisect-go-rclone.sh", 9101 "VHbmHzHh4taXzgag8BAIKQ== bisect-rclone.sh", 9102 ] 9103 }</code></pre> 9104 <p>See the <a href="https://rclone.org/commands/rclone_hashsum/">hashsum</a> command for more information on the above.</p> 9105 <p><strong>Authentication is required for this call.</strong></p> 9106 <h3 id="operations-list">operations/list: List the given remote and path in JSON format</h3> 9107 <p>This takes the following parameters:</p> 9108 <ul> 9109 <li>fs - a remote name string e.g. "drive:"</li> 9110 <li>remote - a path within that remote e.g. "dir"</li> 9111 <li>opt - a dictionary of options to control the listing (optional) 9112 <ul> 9113 <li>recurse - If set recurse directories</li> 9114 <li>noModTime - If set return modification time</li> 9115 <li>showEncrypted - If set show decrypted names</li> 9116 <li>showOrigIDs - If set show the IDs for each item if known</li> 9117 <li>showHash - If set return a dictionary of hashes</li> 9118 <li>noMimeType - If set don't show mime types</li> 9119 <li>dirsOnly - If set only show directories</li> 9120 <li>filesOnly - If set only show files</li> 9121 <li>metadata - If set return metadata of objects also</li> 9122 <li>hashTypes - array of strings of hash types to show if showHash set</li> 9123 </ul></li> 9124 </ul> 9125 <p>Returns:</p> 9126 <ul> 9127 <li>list 9128 <ul> 9129 <li>This is an array of objects as described in the lsjson command</li> 9130 </ul></li> 9131 </ul> 9132 <p>See the <a href="https://rclone.org/commands/rclone_lsjson/">lsjson</a> command for more information on the above and examples.</p> 9133 <p><strong>Authentication is required for this call.</strong></p> 9134 <h3 id="operations-mkdir">operations/mkdir: Make a destination directory or container</h3> 9135 <p>This takes the following parameters:</p> 9136 <ul> 9137 <li>fs - a remote name string e.g. "drive:"</li> 9138 <li>remote - a path within that remote e.g. "dir"</li> 9139 </ul> 9140 <p>See the <a href="https://rclone.org/commands/rclone_mkdir/">mkdir</a> command for more information on the above.</p> 9141 <p><strong>Authentication is required for this call.</strong></p> 9142 <h3 id="operations-movefile">operations/movefile: Move a file from source remote to destination remote</h3> 9143 <p>This takes the following parameters:</p> 9144 <ul> 9145 <li>srcFs - a remote name string e.g. "drive:" for the source, "/" for local filesystem</li> 9146 <li>srcRemote - a path within that remote e.g. "file.txt" for the source</li> 9147 <li>dstFs - a remote name string e.g. "drive2:" for the destination, "/" for local filesystem</li> 9148 <li>dstRemote - a path within that remote e.g. "file2.txt" for the destination</li> 9149 </ul> 9150 <p><strong>Authentication is required for this call.</strong></p> 9151 <h3 id="operations-publiclink">operations/publiclink: Create or retrieve a public link to the given file or folder.</h3> 9152 <p>This takes the following parameters:</p> 9153 <ul> 9154 <li>fs - a remote name string e.g. "drive:"</li> 9155 <li>remote - a path within that remote e.g. "dir"</li> 9156 <li>unlink - boolean - if set removes the link rather than adding it (optional)</li> 9157 <li>expire - string - the expiry time of the link e.g. "1d" (optional)</li> 9158 </ul> 9159 <p>Returns:</p> 9160 <ul> 9161 <li>url - URL of the resource</li> 9162 </ul> 9163 <p>See the <a href="https://rclone.org/commands/rclone_link/">link</a> command for more information on the above.</p> 9164 <p><strong>Authentication is required for this call.</strong></p> 9165 <h3 id="operations-purge">operations/purge: Remove a directory or container and all of its contents</h3> 9166 <p>This takes the following parameters:</p> 9167 <ul> 9168 <li>fs - a remote name string e.g. "drive:"</li> 9169 <li>remote - a path within that remote e.g. "dir"</li> 9170 </ul> 9171 <p>See the <a href="https://rclone.org/commands/rclone_purge/">purge</a> command for more information on the above.</p> 9172 <p><strong>Authentication is required for this call.</strong></p> 9173 <h3 id="operations-rmdir">operations/rmdir: Remove an empty directory or container</h3> 9174 <p>This takes the following parameters:</p> 9175 <ul> 9176 <li>fs - a remote name string e.g. "drive:"</li> 9177 <li>remote - a path within that remote e.g. "dir"</li> 9178 </ul> 9179 <p>See the <a href="https://rclone.org/commands/rclone_rmdir/">rmdir</a> command for more information on the above.</p> 9180 <p><strong>Authentication is required for this call.</strong></p> 9181 <h3 id="operations-rmdirs">operations/rmdirs: Remove all the empty directories in the path</h3> 9182 <p>This takes the following parameters:</p> 9183 <ul> 9184 <li>fs - a remote name string e.g. "drive:"</li> 9185 <li>remote - a path within that remote e.g. "dir"</li> 9186 <li>leaveRoot - boolean, set to true not to delete the root</li> 9187 </ul> 9188 <p>See the <a href="https://rclone.org/commands/rclone_rmdirs/">rmdirs</a> command for more information on the above.</p> 9189 <p><strong>Authentication is required for this call.</strong></p> 9190 <h3 id="operations-settier">operations/settier: Changes storage tier or class on all files in the path</h3> 9191 <p>This takes the following parameters:</p> 9192 <ul> 9193 <li>fs - a remote name string e.g. "drive:"</li> 9194 </ul> 9195 <p>See the <a href="https://rclone.org/commands/rclone_settier/">settier</a> command for more information on the above.</p> 9196 <p><strong>Authentication is required for this call.</strong></p> 9197 <h3 id="operations-settierfile">operations/settierfile: Changes storage tier or class on the single file pointed to</h3> 9198 <p>This takes the following parameters:</p> 9199 <ul> 9200 <li>fs - a remote name string e.g. "drive:"</li> 9201 <li>remote - a path within that remote e.g. "dir"</li> 9202 </ul> 9203 <p>See the <a href="https://rclone.org/commands/rclone_settierfile/">settierfile</a> command for more information on the above.</p> 9204 <p><strong>Authentication is required for this call.</strong></p> 9205 <h3 id="operations-size">operations/size: Count the number of bytes and files in remote</h3> 9206 <p>This takes the following parameters:</p> 9207 <ul> 9208 <li>fs - a remote name string e.g. "drive:path/to/dir"</li> 9209 </ul> 9210 <p>Returns:</p> 9211 <ul> 9212 <li>count - number of files</li> 9213 <li>bytes - number of bytes in those files</li> 9214 </ul> 9215 <p>See the <a href="https://rclone.org/commands/rclone_size/">size</a> command for more information on the above.</p> 9216 <p><strong>Authentication is required for this call.</strong></p> 9217 <h3 id="operations-stat">operations/stat: Give information about the supplied file or directory</h3> 9218 <p>This takes the following parameters</p> 9219 <ul> 9220 <li>fs - a remote name string eg "drive:"</li> 9221 <li>remote - a path within that remote eg "dir"</li> 9222 <li>opt - a dictionary of options to control the listing (optional) 9223 <ul> 9224 <li>see operations/list for the options</li> 9225 </ul></li> 9226 </ul> 9227 <p>The result is</p> 9228 <ul> 9229 <li>item - an object as described in the lsjson command. Will be null if not found.</li> 9230 </ul> 9231 <p>Note that if you are only interested in files then it is much more efficient to set the filesOnly flag in the options.</p> 9232 <p>See the <a href="https://rclone.org/commands/rclone_lsjson/">lsjson</a> command for more information on the above and examples.</p> 9233 <p><strong>Authentication is required for this call.</strong></p> 9234 <h3 id="operations-uploadfile">operations/uploadfile: Upload file using multiform/form-data</h3> 9235 <p>This takes the following parameters:</p> 9236 <ul> 9237 <li>fs - a remote name string e.g. "drive:"</li> 9238 <li>remote - a path within that remote e.g. "dir"</li> 9239 <li>each part in body represents a file to be uploaded</li> 9240 </ul> 9241 <p>See the <a href="https://rclone.org/commands/rclone_uploadfile/">uploadfile</a> command for more information on the above.</p> 9242 <p><strong>Authentication is required for this call.</strong></p> 9243 <h3 id="options-blocks">options/blocks: List all the option blocks</h3> 9244 <p>Returns: - options - a list of the options block names</p> 9245 <h3 id="options-get">options/get: Get all the global options</h3> 9246 <p>Returns an object where keys are option block names and values are an object with the current option values in.</p> 9247 <p>Note that these are the global options which are unaffected by use of the _config and _filter parameters. If you wish to read the parameters set in _config then use options/config and for _filter use options/filter.</p> 9248 <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> 9249 <h3 id="options-local">options/local: Get the currently active config for this call</h3> 9250 <p>Returns an object with the keys "config" and "filter". The "config" key contains the local config and the "filter" key contains the local filters.</p> 9251 <p>Note that these are the local options specific to this rc call. If _config was not supplied then they will be the global options. Likewise with "_filter".</p> 9252 <p>This call is mostly useful for seeing if _config and _filter passing is working.</p> 9253 <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> 9254 <h3 id="options-set">options/set: Set an option</h3> 9255 <p>Parameters:</p> 9256 <ul> 9257 <li>option block name containing an object with 9258 <ul> 9259 <li>key: value</li> 9260 </ul></li> 9261 </ul> 9262 <p>Repeated as often as required.</p> 9263 <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> 9264 <p>For example:</p> 9265 <p>This sets DEBUG level logs (-vv) (these can be set by number or string)</p> 9266 <pre><code>rclone rc options/set --json '{"main": {"LogLevel": "DEBUG"}}' 9267 rclone rc options/set --json '{"main": {"LogLevel": 8}}'</code></pre> 9268 <p>And this sets INFO level logs (-v)</p> 9269 <pre><code>rclone rc options/set --json '{"main": {"LogLevel": "INFO"}}'</code></pre> 9270 <p>And this sets NOTICE level logs (normal without -v)</p> 9271 <pre><code>rclone rc options/set --json '{"main": {"LogLevel": "NOTICE"}}'</code></pre> 9272 <h3 id="pluginsctl-addPlugin">pluginsctl/addPlugin: Add a plugin using url</h3> 9273 <p>Used for adding a plugin to the webgui.</p> 9274 <p>This takes the following parameters:</p> 9275 <ul> 9276 <li>url - http url of the github repo where the plugin is hosted (http://github.com/rclone/rclone-webui-react).</li> 9277 </ul> 9278 <p>Example:</p> 9279 <p>rclone rc pluginsctl/addPlugin</p> 9280 <p><strong>Authentication is required for this call.</strong></p> 9281 <h3 id="pluginsctl-getPluginsForType">pluginsctl/getPluginsForType: Get plugins with type criteria</h3> 9282 <p>This shows all possible plugins by a mime type.</p> 9283 <p>This takes the following parameters:</p> 9284 <ul> 9285 <li>type - supported mime type by a loaded plugin e.g. (video/mp4, audio/mp3).</li> 9286 <li>pluginType - filter plugins based on their type e.g. (DASHBOARD, FILE_HANDLER, TERMINAL).</li> 9287 </ul> 9288 <p>Returns:</p> 9289 <ul> 9290 <li>loadedPlugins - list of current production plugins.</li> 9291 <li>testPlugins - list of temporarily loaded development plugins, usually running on a different server.</li> 9292 </ul> 9293 <p>Example:</p> 9294 <p>rclone rc pluginsctl/getPluginsForType type=video/mp4</p> 9295 <p><strong>Authentication is required for this call.</strong></p> 9296 <h3 id="pluginsctl-listPlugins">pluginsctl/listPlugins: Get the list of currently loaded plugins</h3> 9297 <p>This allows you to get the currently enabled plugins and their details.</p> 9298 <p>This takes no parameters and returns:</p> 9299 <ul> 9300 <li>loadedPlugins - list of current production plugins.</li> 9301 <li>testPlugins - list of temporarily loaded development plugins, usually running on a different server.</li> 9302 </ul> 9303 <p>E.g.</p> 9304 <p>rclone rc pluginsctl/listPlugins</p> 9305 <p><strong>Authentication is required for this call.</strong></p> 9306 <h3 id="pluginsctl-listTestPlugins">pluginsctl/listTestPlugins: Show currently loaded test plugins</h3> 9307 <p>Allows listing of test plugins with the rclone.test set to true in package.json of the plugin.</p> 9308 <p>This takes no parameters and returns:</p> 9309 <ul> 9310 <li>loadedTestPlugins - list of currently available test plugins.</li> 9311 </ul> 9312 <p>E.g.</p> 9313 <pre><code>rclone rc pluginsctl/listTestPlugins</code></pre> 9314 <p><strong>Authentication is required for this call.</strong></p> 9315 <h3 id="pluginsctl-removePlugin">pluginsctl/removePlugin: Remove a loaded plugin</h3> 9316 <p>This allows you to remove a plugin using it's name.</p> 9317 <p>This takes parameters:</p> 9318 <ul> 9319 <li>name - name of the plugin in the format <code>author</code>/<code>plugin_name</code>.</li> 9320 </ul> 9321 <p>E.g.</p> 9322 <p>rclone rc pluginsctl/removePlugin name=rclone/video-plugin</p> 9323 <p><strong>Authentication is required for this call.</strong></p> 9324 <h3 id="pluginsctl-removeTestPlugin">pluginsctl/removeTestPlugin: Remove a test plugin</h3> 9325 <p>This allows you to remove a plugin using it's name.</p> 9326 <p>This takes the following parameters:</p> 9327 <ul> 9328 <li>name - name of the plugin in the format <code>author</code>/<code>plugin_name</code>.</li> 9329 </ul> 9330 <p>Example:</p> 9331 <pre><code>rclone rc pluginsctl/removeTestPlugin name=rclone/rclone-webui-react</code></pre> 9332 <p><strong>Authentication is required for this call.</strong></p> 9333 <h3 id="rc-error">rc/error: This returns an error</h3> 9334 <p>This returns an error with the input as part of its error string. Useful for testing error handling.</p> 9335 <h3 id="rc-list">rc/list: List all the registered remote control commands</h3> 9336 <p>This lists all the registered remote control commands as a JSON map in the commands response.</p> 9337 <h3 id="rc-noop">rc/noop: Echo the input to the output parameters</h3> 9338 <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> 9339 <h3 id="rc-noopauth">rc/noopauth: Echo the input to the output parameters requiring auth</h3> 9340 <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> 9341 <p><strong>Authentication is required for this call.</strong></p> 9342 <h3 id="sync-bisync">sync/bisync: Perform bidirectional synchronization between two paths.</h3> 9343 <p>This takes the following parameters</p> 9344 <ul> 9345 <li>path1 - a remote directory string e.g. <code>drive:path1</code></li> 9346 <li>path2 - a remote directory string e.g. <code>drive:path2</code></li> 9347 <li>dryRun - dry-run mode</li> 9348 <li>resync - performs the resync run</li> 9349 <li>checkAccess - abort if RCLONE_TEST files are not found on both filesystems</li> 9350 <li>checkFilename - file name for checkAccess (default: RCLONE_TEST)</li> 9351 <li>maxDelete - abort sync if percentage of deleted files is above this threshold (default: 50)</li> 9352 <li>force - Bypass maxDelete safety check and run the sync</li> 9353 <li>checkSync - <code>true</code> by default, <code>false</code> disables comparison of final listings, <code>only</code> will skip sync, only compare listings from the last run</li> 9354 <li>createEmptySrcDirs - Sync creation and deletion of empty directories. (Not compatible with --remove-empty-dirs)</li> 9355 <li>removeEmptyDirs - remove empty directories at the final cleanup step</li> 9356 <li>filtersFile - read filtering patterns from a file</li> 9357 <li>ignoreListingChecksum - Do not use checksums for listings</li> 9358 <li>resilient - Allow future runs to retry after certain less-serious errors, instead of requiring resync. Use at your own risk!</li> 9359 <li>workdir - server directory for history files (default: <code>~/.cache/rclone/bisync</code>)</li> 9360 <li>backupdir1 - --backup-dir for Path1. Must be a non-overlapping path on the same remote.</li> 9361 <li>backupdir2 - --backup-dir for Path2. Must be a non-overlapping path on the same remote.</li> 9362 <li>noCleanup - retain working files</li> 9363 </ul> 9364 <p>See <a href="https://rclone.org/commands/rclone_bisync/">bisync command help</a> and <a href="https://rclone.org/bisync/">full bisync description</a> for more information.</p> 9365 <p><strong>Authentication is required for this call.</strong></p> 9366 <h3 id="sync-copy">sync/copy: copy a directory from source remote to destination remote</h3> 9367 <p>This takes the following parameters:</p> 9368 <ul> 9369 <li>srcFs - a remote name string e.g. "drive:src" for the source</li> 9370 <li>dstFs - a remote name string e.g. "drive:dst" for the destination</li> 9371 <li>createEmptySrcDirs - create empty src directories on destination if set</li> 9372 </ul> 9373 <p>See the <a href="https://rclone.org/commands/rclone_copy/">copy</a> command for more information on the above.</p> 9374 <p><strong>Authentication is required for this call.</strong></p> 9375 <h3 id="sync-move">sync/move: move a directory from source remote to destination remote</h3> 9376 <p>This takes the following parameters:</p> 9377 <ul> 9378 <li>srcFs - a remote name string e.g. "drive:src" for the source</li> 9379 <li>dstFs - a remote name string e.g. "drive:dst" for the destination</li> 9380 <li>createEmptySrcDirs - create empty src directories on destination if set</li> 9381 <li>deleteEmptySrcDirs - delete empty src directories if set</li> 9382 </ul> 9383 <p>See the <a href="https://rclone.org/commands/rclone_move/">move</a> command for more information on the above.</p> 9384 <p><strong>Authentication is required for this call.</strong></p> 9385 <h3 id="sync-sync">sync/sync: sync a directory from source remote to destination remote</h3> 9386 <p>This takes the following parameters:</p> 9387 <ul> 9388 <li>srcFs - a remote name string e.g. "drive:src" for the source</li> 9389 <li>dstFs - a remote name string e.g. "drive:dst" for the destination</li> 9390 <li>createEmptySrcDirs - create empty src directories on destination if set</li> 9391 </ul> 9392 <p>See the <a href="https://rclone.org/commands/rclone_sync/">sync</a> command for more information on the above.</p> 9393 <p><strong>Authentication is required for this call.</strong></p> 9394 <h3 id="vfs-forget">vfs/forget: Forget files or directories in the directory cache.</h3> 9395 <p>This forgets the paths in the directory cache causing them to be re-read from the remote when needed.</p> 9396 <p>If no paths are passed in then it will forget all the paths in the directory cache.</p> 9397 <pre><code>rclone rc vfs/forget</code></pre> 9398 <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, e.g.</p> 9399 <pre><code>rclone rc vfs/forget file=hello file2=goodbye dir=home/junk</code></pre> 9400 <p>This command takes an "fs" parameter. If this parameter is not supplied and if there is only one VFS in use then that VFS will be used. If there is more than one VFS in use then the "fs" parameter must be supplied.</p> 9401 <h3 id="vfs-list">vfs/list: List active VFSes.</h3> 9402 <p>This lists the active VFSes.</p> 9403 <p>It returns a list under the key "vfses" where the values are the VFS names that could be passed to the other VFS commands in the "fs" parameter.</p> 9404 <h3 id="vfs-poll-interval">vfs/poll-interval: Get the status or update the value of the poll-interval option.</h3> 9405 <p>Without any parameter given this returns the current status of the poll-interval setting.</p> 9406 <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> 9407 <pre><code>rclone rc vfs/poll-interval interval=5m</code></pre> 9408 <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> 9409 <p>The new poll-interval value will only be active when the timeout is not reached.</p> 9410 <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> 9411 <p>This command takes an "fs" parameter. If this parameter is not supplied and if there is only one VFS in use then that VFS will be used. If there is more than one VFS in use then the "fs" parameter must be supplied.</p> 9412 <h3 id="vfs-refresh">vfs/refresh: Refresh the directory cache.</h3> 9413 <p>This reads the directories for the specified paths and freshens the directory cache.</p> 9414 <p>If no paths are passed in then it will refresh the root directory.</p> 9415 <pre><code>rclone rc vfs/refresh</code></pre> 9416 <p>Otherwise pass directories in as dir=path. Any parameter key starting with dir will refresh that directory, e.g.</p> 9417 <pre><code>rclone rc vfs/refresh dir=home/junk dir2=data/misc</code></pre> 9418 <p>If the parameter recursive=true is given the whole directory tree will get refreshed. This refresh will use --fast-list if enabled.</p> 9419 <p>This command takes an "fs" parameter. If this parameter is not supplied and if there is only one VFS in use then that VFS will be used. If there is more than one VFS in use then the "fs" parameter must be supplied.</p> 9420 <h3 id="vfs-stats">vfs/stats: Stats for a VFS.</h3> 9421 <p>This returns stats for the selected VFS.</p> 9422 <pre><code>{ 9423 // Status of the disk cache - only present if --vfs-cache-mode > off 9424 "diskCache": { 9425 "bytesUsed": 0, 9426 "erroredFiles": 0, 9427 "files": 0, 9428 "hashType": 1, 9429 "outOfSpace": false, 9430 "path": "/home/user/.cache/rclone/vfs/local/mnt/a", 9431 "pathMeta": "/home/user/.cache/rclone/vfsMeta/local/mnt/a", 9432 "uploadsInProgress": 0, 9433 "uploadsQueued": 0 9434 }, 9435 "fs": "/mnt/a", 9436 "inUse": 1, 9437 // Status of the in memory metadata cache 9438 "metadataCache": { 9439 "dirs": 1, 9440 "files": 0 9441 }, 9442 // Options as returned by options/get 9443 "opt": { 9444 "CacheMaxAge": 3600000000000, 9445 // ... 9446 "WriteWait": 1000000000 9447 } 9448 }</code></pre> 9449 <p>This command takes an "fs" parameter. If this parameter is not supplied and if there is only one VFS in use then that VFS will be used. If there is more than one VFS in use then the "fs" parameter must be supplied.</p> 9450 <h2 id="api-http">Accessing the remote control via HTTP</h2> 9451 <p>Rclone implements a simple HTTP based protocol.</p> 9452 <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> 9453 <p>All calls must made using POST.</p> 9454 <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> 9455 <p>The response will be a JSON blob in the body of the response. This is formatted to be reasonably human-readable.</p> 9456 <h3 id="error-returns">Error returns</h3> 9457 <p>If an error occurs then there will be an HTTP error status (e.g. 500) and the body of the response will contain a JSON encoded error object, e.g.</p> 9458 <pre><code>{ 9459 "error": "Expecting string value for key \"remote\" (was float64)", 9460 "input": { 9461 "fs": "/tmp", 9462 "remote": 3 9463 }, 9464 "status": 400 9465 "path": "operations/rmdir", 9466 }</code></pre> 9467 <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> 9468 <h3 id="cors">CORS</h3> 9469 <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> 9470 <h3 id="using-post-with-url-parameters-only">Using POST with URL parameters only</h3> 9471 <pre><code>curl -X POST 'http://localhost:5572/rc/noop?potato=1&sausage=2'</code></pre> 9472 <p>Response</p> 9473 <pre><code>{ 9474 "potato": "1", 9475 "sausage": "2" 9476 }</code></pre> 9477 <p>Here is what an error response looks like:</p> 9478 <pre><code>curl -X POST 'http://localhost:5572/rc/error?potato=1&sausage=2'</code></pre> 9479 <pre><code>{ 9480 "error": "arbitrary error on input map[potato:1 sausage:2]", 9481 "input": { 9482 "potato": "1", 9483 "sausage": "2" 9484 } 9485 }</code></pre> 9486 <p>Note that curl doesn't return errors to the shell unless you use the <code>-f</code> option</p> 9487 <pre><code>$ curl -f -X POST 'http://localhost:5572/rc/error?potato=1&sausage=2' 9488 curl: (22) The requested URL returned error: 400 Bad Request 9489 $ echo $? 9490 22</code></pre> 9491 <h3 id="using-post-with-a-form">Using POST with a form</h3> 9492 <pre><code>curl --data "potato=1" --data "sausage=2" http://localhost:5572/rc/noop</code></pre> 9493 <p>Response</p> 9494 <pre><code>{ 9495 "potato": "1", 9496 "sausage": "2" 9497 }</code></pre> 9498 <p>Note that you can combine these with URL parameters too with the POST parameters taking precedence.</p> 9499 <pre><code>curl --data "potato=1" --data "sausage=2" "http://localhost:5572/rc/noop?rutabaga=3&sausage=4"</code></pre> 9500 <p>Response</p> 9501 <pre><code>{ 9502 "potato": "1", 9503 "rutabaga": "3", 9504 "sausage": "4" 9505 } 9506 </code></pre> 9507 <h3 id="using-post-with-a-json-blob">Using POST with a JSON blob</h3> 9508 <pre><code>curl -H "Content-Type: application/json" -X POST -d '{"potato":2,"sausage":1}' http://localhost:5572/rc/noop</code></pre> 9509 <p>response</p> 9510 <pre><code>{ 9511 "password": "xyz", 9512 "username": "xyz" 9513 }</code></pre> 9514 <p>This can be combined with URL parameters too if required. The JSON blob takes precedence.</p> 9515 <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> 9516 <pre><code>{ 9517 "potato": 2, 9518 "rutabaga": "3", 9519 "sausage": 1 9520 }</code></pre> 9521 <h2 id="debugging-rclone-with-pprof">Debugging rclone with pprof</h2> 9522 <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> 9523 <p>To use these, first <a href="https://golang.org/doc/install">install go</a>.</p> 9524 <h3 id="debugging-memory-use">Debugging memory use</h3> 9525 <p>To profile rclone's memory use you can run:</p> 9526 <pre><code>go tool pprof -web http://localhost:5572/debug/pprof/heap</code></pre> 9527 <p>This should open a page in your browser showing what is using what memory.</p> 9528 <p>You can also use the <code>-text</code> flag to produce a textual summary</p> 9529 <pre><code>$ go tool pprof -text http://localhost:5572/debug/pprof/heap 9530 Showing nodes accounting for 1537.03kB, 100% of 1537.03kB total 9531 flat flat% sum% cum cum% 9532 1024.03kB 66.62% 66.62% 1024.03kB 66.62% github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.addDecoderNode 9533 513kB 33.38% 100% 513kB 33.38% net/http.newBufioWriterSize 9534 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/cmd/all.init 9535 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/cmd/serve.init 9536 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/cmd/serve/restic.init 9537 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/vendor/golang.org/x/net/http2.init 9538 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.init 9539 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.init.0 9540 0 0% 100% 1024.03kB 66.62% main.init 9541 0 0% 100% 513kB 33.38% net/http.(*conn).readRequest 9542 0 0% 100% 513kB 33.38% net/http.(*conn).serve 9543 0 0% 100% 1024.03kB 66.62% runtime.main</code></pre> 9544 <h3 id="debugging-go-routine-leaks">Debugging go routine leaks</h3> 9545 <p>Memory leaks are most often caused by go routine leaks keeping memory alive which should have been garbage collected.</p> 9546 <p>See all active go routines using</p> 9547 <pre><code>curl http://localhost:5572/debug/pprof/goroutine?debug=1</code></pre> 9548 <p>Or go to http://localhost:5572/debug/pprof/goroutine?debug=1 in your browser.</p> 9549 <h3 id="other-profiles-to-look-at">Other profiles to look at</h3> 9550 <p>You can see a summary of profiles available at http://localhost:5572/debug/pprof/</p> 9551 <p>Here is how to use some of them:</p> 9552 <ul> 9553 <li>Memory: <code>go tool pprof http://localhost:5572/debug/pprof/heap</code></li> 9554 <li>Go routines: <code>curl http://localhost:5572/debug/pprof/goroutine?debug=1</code></li> 9555 <li>30-second CPU profile: <code>go tool pprof http://localhost:5572/debug/pprof/profile</code></li> 9556 <li>5-second execution trace: <code>wget http://localhost:5572/debug/pprof/trace?seconds=5</code></li> 9557 <li>Goroutine blocking profile 9558 <ul> 9559 <li>Enable first with: <code>rclone rc debug/set-block-profile-rate rate=1</code> (<a href="#debug-set-block-profile-rate">docs</a>)</li> 9560 <li><code>go tool pprof http://localhost:5572/debug/pprof/block</code></li> 9561 </ul></li> 9562 <li>Contended mutexes: 9563 <ul> 9564 <li>Enable first with: <code>rclone rc debug/set-mutex-profile-fraction rate=1</code> (<a href="#debug-set-mutex-profile-fraction">docs</a>)</li> 9565 <li><code>go tool pprof http://localhost:5572/debug/pprof/mutex</code></li> 9566 </ul></li> 9567 </ul> 9568 <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> 9569 <p>The profiling hook is <a href="https://stackoverflow.com/q/26545159/164234">zero overhead unless it is used</a>.</p> 9570 <h1 id="overview-of-cloud-storage-systems">Overview of cloud storage systems</h1> 9571 <p>Each cloud storage system is slightly different. Rclone attempts to provide a unified interface to them, but some underlying differences show through.</p> 9572 <h2 id="features-1">Features</h2> 9573 <p>Here is an overview of the major features of each cloud storage system.</p> 9574 <table> 9575 <thead> 9576 <tr class="header"> 9577 <th>Name</th> 9578 <th style="text-align: center;">Hash</th> 9579 <th style="text-align: center;">ModTime</th> 9580 <th style="text-align: center;">Case Insensitive</th> 9581 <th style="text-align: center;">Duplicate Files</th> 9582 <th style="text-align: center;">MIME Type</th> 9583 <th style="text-align: center;">Metadata</th> 9584 </tr> 9585 </thead> 9586 <tbody> 9587 <tr class="odd"> 9588 <td>1Fichier</td> 9589 <td style="text-align: center;">Whirlpool</td> 9590 <td style="text-align: center;">-</td> 9591 <td style="text-align: center;">No</td> 9592 <td style="text-align: center;">Yes</td> 9593 <td style="text-align: center;">R</td> 9594 <td style="text-align: center;">-</td> 9595 </tr> 9596 <tr class="even"> 9597 <td>Akamai Netstorage</td> 9598 <td style="text-align: center;">MD5, SHA256</td> 9599 <td style="text-align: center;">R/W</td> 9600 <td style="text-align: center;">No</td> 9601 <td style="text-align: center;">No</td> 9602 <td style="text-align: center;">R</td> 9603 <td style="text-align: center;">-</td> 9604 </tr> 9605 <tr class="odd"> 9606 <td>Amazon S3 (or S3 compatible)</td> 9607 <td style="text-align: center;">MD5</td> 9608 <td style="text-align: center;">R/W</td> 9609 <td style="text-align: center;">No</td> 9610 <td style="text-align: center;">No</td> 9611 <td style="text-align: center;">R/W</td> 9612 <td style="text-align: center;">RWU</td> 9613 </tr> 9614 <tr class="even"> 9615 <td>Backblaze B2</td> 9616 <td style="text-align: center;">SHA1</td> 9617 <td style="text-align: center;">R/W</td> 9618 <td style="text-align: center;">No</td> 9619 <td style="text-align: center;">No</td> 9620 <td style="text-align: center;">R/W</td> 9621 <td style="text-align: center;">-</td> 9622 </tr> 9623 <tr class="odd"> 9624 <td>Box</td> 9625 <td style="text-align: center;">SHA1</td> 9626 <td style="text-align: center;">R/W</td> 9627 <td style="text-align: center;">Yes</td> 9628 <td style="text-align: center;">No</td> 9629 <td style="text-align: center;">-</td> 9630 <td style="text-align: center;">-</td> 9631 </tr> 9632 <tr class="even"> 9633 <td>Citrix ShareFile</td> 9634 <td style="text-align: center;">MD5</td> 9635 <td style="text-align: center;">R/W</td> 9636 <td style="text-align: center;">Yes</td> 9637 <td style="text-align: center;">No</td> 9638 <td style="text-align: center;">-</td> 9639 <td style="text-align: center;">-</td> 9640 </tr> 9641 <tr class="odd"> 9642 <td>Dropbox</td> 9643 <td style="text-align: center;">DBHASH ¹</td> 9644 <td style="text-align: center;">R</td> 9645 <td style="text-align: center;">Yes</td> 9646 <td style="text-align: center;">No</td> 9647 <td style="text-align: center;">-</td> 9648 <td style="text-align: center;">-</td> 9649 </tr> 9650 <tr class="even"> 9651 <td>Enterprise File Fabric</td> 9652 <td style="text-align: center;">-</td> 9653 <td style="text-align: center;">R/W</td> 9654 <td style="text-align: center;">Yes</td> 9655 <td style="text-align: center;">No</td> 9656 <td style="text-align: center;">R/W</td> 9657 <td style="text-align: center;">-</td> 9658 </tr> 9659 <tr class="odd"> 9660 <td>FTP</td> 9661 <td style="text-align: center;">-</td> 9662 <td style="text-align: center;">R/W ¹⁰</td> 9663 <td style="text-align: center;">No</td> 9664 <td style="text-align: center;">No</td> 9665 <td style="text-align: center;">-</td> 9666 <td style="text-align: center;">-</td> 9667 </tr> 9668 <tr class="even"> 9669 <td>Google Cloud Storage</td> 9670 <td style="text-align: center;">MD5</td> 9671 <td style="text-align: center;">R/W</td> 9672 <td style="text-align: center;">No</td> 9673 <td style="text-align: center;">No</td> 9674 <td style="text-align: center;">R/W</td> 9675 <td style="text-align: center;">-</td> 9676 </tr> 9677 <tr class="odd"> 9678 <td>Google Drive</td> 9679 <td style="text-align: center;">MD5, SHA1, SHA256</td> 9680 <td style="text-align: center;">DR/W</td> 9681 <td style="text-align: center;">No</td> 9682 <td style="text-align: center;">Yes</td> 9683 <td style="text-align: center;">R/W</td> 9684 <td style="text-align: center;">DRWU</td> 9685 </tr> 9686 <tr class="even"> 9687 <td>Google Photos</td> 9688 <td style="text-align: center;">-</td> 9689 <td style="text-align: center;">-</td> 9690 <td style="text-align: center;">No</td> 9691 <td style="text-align: center;">Yes</td> 9692 <td style="text-align: center;">R</td> 9693 <td style="text-align: center;">-</td> 9694 </tr> 9695 <tr class="odd"> 9696 <td>HDFS</td> 9697 <td style="text-align: center;">-</td> 9698 <td style="text-align: center;">R/W</td> 9699 <td style="text-align: center;">No</td> 9700 <td style="text-align: center;">No</td> 9701 <td style="text-align: center;">-</td> 9702 <td style="text-align: center;">-</td> 9703 </tr> 9704 <tr class="even"> 9705 <td>HiDrive</td> 9706 <td style="text-align: center;">HiDrive ¹²</td> 9707 <td style="text-align: center;">R/W</td> 9708 <td style="text-align: center;">No</td> 9709 <td style="text-align: center;">No</td> 9710 <td style="text-align: center;">-</td> 9711 <td style="text-align: center;">-</td> 9712 </tr> 9713 <tr class="odd"> 9714 <td>HTTP</td> 9715 <td style="text-align: center;">-</td> 9716 <td style="text-align: center;">R</td> 9717 <td style="text-align: center;">No</td> 9718 <td style="text-align: center;">No</td> 9719 <td style="text-align: center;">R</td> 9720 <td style="text-align: center;">-</td> 9721 </tr> 9722 <tr class="even"> 9723 <td>Internet Archive</td> 9724 <td style="text-align: center;">MD5, SHA1, CRC32</td> 9725 <td style="text-align: center;">R/W ¹¹</td> 9726 <td style="text-align: center;">No</td> 9727 <td style="text-align: center;">No</td> 9728 <td style="text-align: center;">-</td> 9729 <td style="text-align: center;">RWU</td> 9730 </tr> 9731 <tr class="odd"> 9732 <td>Jottacloud</td> 9733 <td style="text-align: center;">MD5</td> 9734 <td style="text-align: center;">R/W</td> 9735 <td style="text-align: center;">Yes</td> 9736 <td style="text-align: center;">No</td> 9737 <td style="text-align: center;">R</td> 9738 <td style="text-align: center;">RW</td> 9739 </tr> 9740 <tr class="even"> 9741 <td>Koofr</td> 9742 <td style="text-align: center;">MD5</td> 9743 <td style="text-align: center;">-</td> 9744 <td style="text-align: center;">Yes</td> 9745 <td style="text-align: center;">No</td> 9746 <td style="text-align: center;">-</td> 9747 <td style="text-align: center;">-</td> 9748 </tr> 9749 <tr class="odd"> 9750 <td>Linkbox</td> 9751 <td style="text-align: center;">-</td> 9752 <td style="text-align: center;">R</td> 9753 <td style="text-align: center;">No</td> 9754 <td style="text-align: center;">No</td> 9755 <td style="text-align: center;">-</td> 9756 <td style="text-align: center;">-</td> 9757 </tr> 9758 <tr class="even"> 9759 <td>Mail.ru Cloud</td> 9760 <td style="text-align: center;">Mailru ⁶</td> 9761 <td style="text-align: center;">R/W</td> 9762 <td style="text-align: center;">Yes</td> 9763 <td style="text-align: center;">No</td> 9764 <td style="text-align: center;">-</td> 9765 <td style="text-align: center;">-</td> 9766 </tr> 9767 <tr class="odd"> 9768 <td>Mega</td> 9769 <td style="text-align: center;">-</td> 9770 <td style="text-align: center;">-</td> 9771 <td style="text-align: center;">No</td> 9772 <td style="text-align: center;">Yes</td> 9773 <td style="text-align: center;">-</td> 9774 <td style="text-align: center;">-</td> 9775 </tr> 9776 <tr class="even"> 9777 <td>Memory</td> 9778 <td style="text-align: center;">MD5</td> 9779 <td style="text-align: center;">R/W</td> 9780 <td style="text-align: center;">No</td> 9781 <td style="text-align: center;">No</td> 9782 <td style="text-align: center;">-</td> 9783 <td style="text-align: center;">-</td> 9784 </tr> 9785 <tr class="odd"> 9786 <td>Microsoft Azure Blob Storage</td> 9787 <td style="text-align: center;">MD5</td> 9788 <td style="text-align: center;">R/W</td> 9789 <td style="text-align: center;">No</td> 9790 <td style="text-align: center;">No</td> 9791 <td style="text-align: center;">R/W</td> 9792 <td style="text-align: center;">-</td> 9793 </tr> 9794 <tr class="even"> 9795 <td>Microsoft Azure Files Storage</td> 9796 <td style="text-align: center;">MD5</td> 9797 <td style="text-align: center;">R/W</td> 9798 <td style="text-align: center;">Yes</td> 9799 <td style="text-align: center;">No</td> 9800 <td style="text-align: center;">R/W</td> 9801 <td style="text-align: center;">-</td> 9802 </tr> 9803 <tr class="odd"> 9804 <td>Microsoft OneDrive</td> 9805 <td style="text-align: center;">QuickXorHash ⁵</td> 9806 <td style="text-align: center;">DR/W</td> 9807 <td style="text-align: center;">Yes</td> 9808 <td style="text-align: center;">No</td> 9809 <td style="text-align: center;">R</td> 9810 <td style="text-align: center;">DRW</td> 9811 </tr> 9812 <tr class="even"> 9813 <td>OpenDrive</td> 9814 <td style="text-align: center;">MD5</td> 9815 <td style="text-align: center;">R/W</td> 9816 <td style="text-align: center;">Yes</td> 9817 <td style="text-align: center;">Partial ⁸</td> 9818 <td style="text-align: center;">-</td> 9819 <td style="text-align: center;">-</td> 9820 </tr> 9821 <tr class="odd"> 9822 <td>OpenStack Swift</td> 9823 <td style="text-align: center;">MD5</td> 9824 <td style="text-align: center;">R/W</td> 9825 <td style="text-align: center;">No</td> 9826 <td style="text-align: center;">No</td> 9827 <td style="text-align: center;">R/W</td> 9828 <td style="text-align: center;">-</td> 9829 </tr> 9830 <tr class="even"> 9831 <td>Oracle Object Storage</td> 9832 <td style="text-align: center;">MD5</td> 9833 <td style="text-align: center;">R/W</td> 9834 <td style="text-align: center;">No</td> 9835 <td style="text-align: center;">No</td> 9836 <td style="text-align: center;">R/W</td> 9837 <td style="text-align: center;">-</td> 9838 </tr> 9839 <tr class="odd"> 9840 <td>pCloud</td> 9841 <td style="text-align: center;">MD5, SHA1 ⁷</td> 9842 <td style="text-align: center;">R</td> 9843 <td style="text-align: center;">No</td> 9844 <td style="text-align: center;">No</td> 9845 <td style="text-align: center;">W</td> 9846 <td style="text-align: center;">-</td> 9847 </tr> 9848 <tr class="even"> 9849 <td>PikPak</td> 9850 <td style="text-align: center;">MD5</td> 9851 <td style="text-align: center;">R</td> 9852 <td style="text-align: center;">No</td> 9853 <td style="text-align: center;">No</td> 9854 <td style="text-align: center;">R</td> 9855 <td style="text-align: center;">-</td> 9856 </tr> 9857 <tr class="odd"> 9858 <td>premiumize.me</td> 9859 <td style="text-align: center;">-</td> 9860 <td style="text-align: center;">-</td> 9861 <td style="text-align: center;">Yes</td> 9862 <td style="text-align: center;">No</td> 9863 <td style="text-align: center;">R</td> 9864 <td style="text-align: center;">-</td> 9865 </tr> 9866 <tr class="even"> 9867 <td>put.io</td> 9868 <td style="text-align: center;">CRC-32</td> 9869 <td style="text-align: center;">R/W</td> 9870 <td style="text-align: center;">No</td> 9871 <td style="text-align: center;">Yes</td> 9872 <td style="text-align: center;">R</td> 9873 <td style="text-align: center;">-</td> 9874 </tr> 9875 <tr class="odd"> 9876 <td>Proton Drive</td> 9877 <td style="text-align: center;">SHA1</td> 9878 <td style="text-align: center;">R/W</td> 9879 <td style="text-align: center;">No</td> 9880 <td style="text-align: center;">No</td> 9881 <td style="text-align: center;">R</td> 9882 <td style="text-align: center;">-</td> 9883 </tr> 9884 <tr class="even"> 9885 <td>QingStor</td> 9886 <td style="text-align: center;">MD5</td> 9887 <td style="text-align: center;">- ⁹</td> 9888 <td style="text-align: center;">No</td> 9889 <td style="text-align: center;">No</td> 9890 <td style="text-align: center;">R/W</td> 9891 <td style="text-align: center;">-</td> 9892 </tr> 9893 <tr class="odd"> 9894 <td>Quatrix by Maytech</td> 9895 <td style="text-align: center;">-</td> 9896 <td style="text-align: center;">R/W</td> 9897 <td style="text-align: center;">No</td> 9898 <td style="text-align: center;">No</td> 9899 <td style="text-align: center;">-</td> 9900 <td style="text-align: center;">-</td> 9901 </tr> 9902 <tr class="even"> 9903 <td>Seafile</td> 9904 <td style="text-align: center;">-</td> 9905 <td style="text-align: center;">-</td> 9906 <td style="text-align: center;">No</td> 9907 <td style="text-align: center;">No</td> 9908 <td style="text-align: center;">-</td> 9909 <td style="text-align: center;">-</td> 9910 </tr> 9911 <tr class="odd"> 9912 <td>SFTP</td> 9913 <td style="text-align: center;">MD5, SHA1 ²</td> 9914 <td style="text-align: center;">DR/W</td> 9915 <td style="text-align: center;">Depends</td> 9916 <td style="text-align: center;">No</td> 9917 <td style="text-align: center;">-</td> 9918 <td style="text-align: center;">-</td> 9919 </tr> 9920 <tr class="even"> 9921 <td>Sia</td> 9922 <td style="text-align: center;">-</td> 9923 <td style="text-align: center;">-</td> 9924 <td style="text-align: center;">No</td> 9925 <td style="text-align: center;">No</td> 9926 <td style="text-align: center;">-</td> 9927 <td style="text-align: center;">-</td> 9928 </tr> 9929 <tr class="odd"> 9930 <td>SMB</td> 9931 <td style="text-align: center;">-</td> 9932 <td style="text-align: center;">R/W</td> 9933 <td style="text-align: center;">Yes</td> 9934 <td style="text-align: center;">No</td> 9935 <td style="text-align: center;">-</td> 9936 <td style="text-align: center;">-</td> 9937 </tr> 9938 <tr class="even"> 9939 <td>SugarSync</td> 9940 <td style="text-align: center;">-</td> 9941 <td style="text-align: center;">-</td> 9942 <td style="text-align: center;">No</td> 9943 <td style="text-align: center;">No</td> 9944 <td style="text-align: center;">-</td> 9945 <td style="text-align: center;">-</td> 9946 </tr> 9947 <tr class="odd"> 9948 <td>Storj</td> 9949 <td style="text-align: center;">-</td> 9950 <td style="text-align: center;">R</td> 9951 <td style="text-align: center;">No</td> 9952 <td style="text-align: center;">No</td> 9953 <td style="text-align: center;">-</td> 9954 <td style="text-align: center;">-</td> 9955 </tr> 9956 <tr class="even"> 9957 <td>Uptobox</td> 9958 <td style="text-align: center;">-</td> 9959 <td style="text-align: center;">-</td> 9960 <td style="text-align: center;">No</td> 9961 <td style="text-align: center;">Yes</td> 9962 <td style="text-align: center;">-</td> 9963 <td style="text-align: center;">-</td> 9964 </tr> 9965 <tr class="odd"> 9966 <td>WebDAV</td> 9967 <td style="text-align: center;">MD5, SHA1 ³</td> 9968 <td style="text-align: center;">R ⁴</td> 9969 <td style="text-align: center;">Depends</td> 9970 <td style="text-align: center;">No</td> 9971 <td style="text-align: center;">-</td> 9972 <td style="text-align: center;">-</td> 9973 </tr> 9974 <tr class="even"> 9975 <td>Yandex Disk</td> 9976 <td style="text-align: center;">MD5</td> 9977 <td style="text-align: center;">R/W</td> 9978 <td style="text-align: center;">No</td> 9979 <td style="text-align: center;">No</td> 9980 <td style="text-align: center;">R</td> 9981 <td style="text-align: center;">-</td> 9982 </tr> 9983 <tr class="odd"> 9984 <td>Zoho WorkDrive</td> 9985 <td style="text-align: center;">-</td> 9986 <td style="text-align: center;">-</td> 9987 <td style="text-align: center;">No</td> 9988 <td style="text-align: center;">No</td> 9989 <td style="text-align: center;">-</td> 9990 <td style="text-align: center;">-</td> 9991 </tr> 9992 <tr class="even"> 9993 <td>The local filesystem</td> 9994 <td style="text-align: center;">All</td> 9995 <td style="text-align: center;">DR/W</td> 9996 <td style="text-align: center;">Depends</td> 9997 <td style="text-align: center;">No</td> 9998 <td style="text-align: center;">-</td> 9999 <td style="text-align: center;">DRWU</td> 10000 </tr> 10001 </tbody> 10002 </table> 10003 <p>¹ 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 4 MiB block SHA256s.</p> 10004 <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> 10005 <p>³ WebDAV supports hashes when used with Fastmail Files, Owncloud and Nextcloud only.</p> 10006 <p>⁴ WebDAV supports modtimes when used with Fastmail Files, Owncloud and Nextcloud only.</p> 10007 <p>⁵ <a href="https://docs.microsoft.com/en-us/onedrive/developer/code-snippets/quickxorhash">QuickXorHash</a> is Microsoft's own hash.</p> 10008 <p>⁶ Mail.ru uses its own modified SHA1 hash</p> 10009 <p>⁷ pCloud only supports SHA1 (not MD5) in its EU region</p> 10010 <p>⁸ Opendrive does not support creation of duplicate files using their web client interface or other stock clients, but the underlying storage platform has been determined to allow duplicate files, and it is possible to create them with <code>rclone</code>. It may be that this is a mistake or an unsupported feature.</p> 10011 <p>⁹ QingStor does not support SetModTime for objects bigger than 5 GiB.</p> 10012 <p>¹⁰ FTP supports modtimes for the major FTP servers, and also others if they advertised required protocol extensions. See <a href="https://rclone.org/ftp/#modification-times">this</a> for more details.</p> 10013 <p>¹¹ Internet Archive requires option <code>wait_archive</code> to be set to a non-zero value for full modtime support.</p> 10014 <p>¹² HiDrive supports <a href="https://static.hidrive.com/dev/0001">its own custom hash</a>. It combines SHA1 sums for each 4 KiB block hierarchically to a single top-level sum.</p> 10015 <h3 id="hash">Hash</h3> 10016 <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> 10017 <p>To use the verify checksums when transferring between cloud storage systems they must support a common hash type.</p> 10018 <h3 id="modtime">ModTime</h3> 10019 <p>Almost all cloud storage systems store some sort of timestamp on objects, but several of them not something that is appropriate to use for syncing. E.g. some backends will only write a timestamp that represents the time of the upload. To be relevant for syncing it should be able to store the modification time of the source object. If this is not the case, rclone will only check the file size by default, though can be configured to check the file hash (with the <code>--checksum</code> flag). Ideally it should also be possible to change the timestamp of an existing file without having to re-upload it.</p> 10020 <table> 10021 <colgroup> 10022 <col style="width: 27%" /> 10023 <col style="width: 72%" /> 10024 </colgroup> 10025 <thead> 10026 <tr class="header"> 10027 <th>Key</th> 10028 <th>Explanation</th> 10029 </tr> 10030 </thead> 10031 <tbody> 10032 <tr class="odd"> 10033 <td><code>-</code></td> 10034 <td>ModTimes not supported - times likely the upload time</td> 10035 </tr> 10036 <tr class="even"> 10037 <td><code>R</code></td> 10038 <td>ModTimes supported on files but can't be changed without re-upload</td> 10039 </tr> 10040 <tr class="odd"> 10041 <td><code>R/W</code></td> 10042 <td>Read and Write ModTimes fully supported on files</td> 10043 </tr> 10044 <tr class="even"> 10045 <td><code>DR</code></td> 10046 <td>ModTimes supported on files and directories but can't be changed without re-upload</td> 10047 </tr> 10048 <tr class="odd"> 10049 <td><code>DR/W</code></td> 10050 <td>Read and Write ModTimes fully supported on files and directories</td> 10051 </tr> 10052 </tbody> 10053 </table> 10054 <p>Storage systems with a <code>-</code> in the ModTime column, means the modification read on objects is not the modification time of the file when uploaded. It is most likely the time the file was uploaded, or possibly something else (like the time the picture was taken in Google Photos).</p> 10055 <p>Storage systems with a <code>R</code> (for read-only) in the ModTime column, means the it keeps modification times on objects, and updates them when uploading objects, but it does not support changing only the modification time (<code>SetModTime</code> operation) without re-uploading, possibly not even without deleting existing first. Some operations in rclone, such as <code>copy</code> and <code>sync</code> commands, will automatically check for <code>SetModTime</code> support and re-upload if necessary to keep the modification times in sync. Other commands will not work without <code>SetModTime</code> support, e.g. <code>touch</code> command on an existing file will fail, and changes to modification time only on a files in a <code>mount</code> will be silently ignored.</p> 10056 <p>Storage systems with <code>R/W</code> (for read/write) in the ModTime column, means they do also support modtime-only operations.</p> 10057 <p>Storage systems with <code>D</code> in the ModTime column means that the following symbols apply to directories as well as files.</p> 10058 <h3 id="case-insensitive">Case Insensitive</h3> 10059 <p>If a cloud storage systems is case sensitive then it is possible to have two files which differ only in case, e.g. <code>file.txt</code> and <code>FILE.txt</code>. If a cloud storage system is case insensitive then that isn't possible.</p> 10060 <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> 10061 <p>The local filesystem and SFTP may or may not be case sensitive depending on OS.</p> 10062 <ul> 10063 <li>Windows - usually case insensitive, though case is preserved</li> 10064 <li>OSX - usually case insensitive, though it is possible to format case sensitive</li> 10065 <li>Linux - usually case sensitive, but there are case insensitive file systems (e.g. FAT formatted USB keys)</li> 10066 </ul> 10067 <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> 10068 <h3 id="duplicate-files">Duplicate files</h3> 10069 <p>If a cloud storage system allows duplicate files then it can have two objects with the same name.</p> 10070 <p>This confuses rclone greatly when syncing - use the <code>rclone dedupe</code> command to rename or remove duplicates.</p> 10071 <h3 id="restricted-filenames">Restricted filenames</h3> 10072 <p>Some cloud storage systems might have restrictions on the characters that are usable in file or directory names. When <code>rclone</code> detects such a name during a file upload, it will transparently replace the restricted characters with similar looking Unicode characters. To handle the different sets of restricted characters for different backends, rclone uses something it calls <a href="#encoding">encoding</a>.</p> 10073 <p>This process is designed to avoid ambiguous file names as much as possible and allow to move files between many cloud storage systems transparently.</p> 10074 <p>The name shown by <code>rclone</code> to the user or during log output will only contain a minimal set of <a href="#restricted-characters">replaced characters</a> to ensure correct formatting and not necessarily the actual name used on the cloud storage.</p> 10075 <p>This transformation is reversed when downloading a file or parsing <code>rclone</code> arguments. For example, when uploading a file named <code>my file?.txt</code> to Onedrive, it will be displayed as <code>my file?.txt</code> on the console, but stored as <code>my file？.txt</code> to Onedrive (the <code>?</code> gets replaced by the similar looking <code>？</code> character, the so-called "fullwidth question mark"). The reverse transformation allows to read a file <code>unusual/name.txt</code> from Google Drive, by passing the name <code>unusual／name.txt</code> on the command line (the <code>/</code> needs to be replaced by the similar looking <code>／</code> character).</p> 10076 <h4 id="restricted-filenames-caveats">Caveats</h4> 10077 <p>The filename encoding system works well in most cases, at least where file names are written in English or similar languages. You might not even notice it: It just works. In some cases it may lead to issues, though. E.g. when file names are written in Chinese, or Japanese, where it is always the Unicode fullwidth variants of the punctuation marks that are used.</p> 10078 <p>On Windows, the characters <code>:</code>, <code>*</code> and <code>?</code> are examples of restricted characters. If these are used in filenames on a remote that supports it, Rclone will transparently convert them to their fullwidth Unicode variants <code>＊</code>, <code>？</code> and <code>：</code> when downloading to Windows, and back again when uploading. This way files with names that are not allowed on Windows can still be stored.</p> 10079 <p>However, if you have files on your Windows system originally with these same Unicode characters in their names, they will be included in the same conversion process. E.g. if you create a file in your Windows filesystem with name <code>Test：1.jpg</code>, where <code>：</code> is the Unicode fullwidth colon symbol, and use rclone to upload it to Google Drive, which supports regular <code>:</code> (halfwidth question mark), rclone will replace the fullwidth <code>:</code> with the halfwidth <code>:</code> and store the file as <code>Test:1.jpg</code> in Google Drive. Since both Windows and Google Drive allows the name <code>Test：1.jpg</code>, it would probably be better if rclone just kept the name as is in this case.</p> 10080 <p>With the opposite situation; if you have a file named <code>Test:1.jpg</code>, in your Google Drive, e.g. uploaded from a Linux system where <code>:</code> is valid in file names. Then later use rclone to copy this file to your Windows computer you will notice that on your local disk it gets renamed to <code>Test：1.jpg</code>. The original filename is not legal on Windows, due to the <code>:</code>, and rclone therefore renames it to make the copy possible. That is all good. However, this can also lead to an issue: If you already had a <em>different</em> file named <code>Test：1.jpg</code> on Windows, and then use rclone to copy either way. Rclone will then treat the file originally named <code>Test:1.jpg</code> on Google Drive and the file originally named <code>Test：1.jpg</code> on Windows as the same file, and replace the contents from one with the other.</p> 10081 <p>Its virtually impossible to handle all cases like these correctly in all situations, but by customizing the <a href="#encoding">encoding option</a>, changing the set of characters that rclone should convert, you should be able to create a configuration that works well for your specific situation. See also the <a href="https://rclone.org/overview/#encoding-example-windows">example</a> below.</p> 10082 <p>(Windows was used as an example of a file system with many restricted characters, and Google drive a storage system with few.)</p> 10083 <h4 id="restricted-characters">Default restricted characters</h4> 10084 <p>The table below shows the characters that are replaced by default.</p> 10085 <p>When a replacement character is found in a filename, this character will be escaped with the <code>‛</code> character to avoid ambiguous file names. (e.g. a file named <code>␀.txt</code> would shown as <code>‛␀.txt</code>)</p> 10086 <p>Each cloud storage backend can use a different set of characters, which will be specified in the documentation for each backend.</p> 10087 <table> 10088 <thead> 10089 <tr class="header"> 10090 <th>Character</th> 10091 <th style="text-align: center;">Value</th> 10092 <th style="text-align: center;">Replacement</th> 10093 </tr> 10094 </thead> 10095 <tbody> 10096 <tr class="odd"> 10097 <td>NUL</td> 10098 <td style="text-align: center;">0x00</td> 10099 <td style="text-align: center;">␀</td> 10100 </tr> 10101 <tr class="even"> 10102 <td>SOH</td> 10103 <td style="text-align: center;">0x01</td> 10104 <td style="text-align: center;">␁</td> 10105 </tr> 10106 <tr class="odd"> 10107 <td>STX</td> 10108 <td style="text-align: center;">0x02</td> 10109 <td style="text-align: center;">␂</td> 10110 </tr> 10111 <tr class="even"> 10112 <td>ETX</td> 10113 <td style="text-align: center;">0x03</td> 10114 <td style="text-align: center;">␃</td> 10115 </tr> 10116 <tr class="odd"> 10117 <td>EOT</td> 10118 <td style="text-align: center;">0x04</td> 10119 <td style="text-align: center;">␄</td> 10120 </tr> 10121 <tr class="even"> 10122 <td>ENQ</td> 10123 <td style="text-align: center;">0x05</td> 10124 <td style="text-align: center;">␅</td> 10125 </tr> 10126 <tr class="odd"> 10127 <td>ACK</td> 10128 <td style="text-align: center;">0x06</td> 10129 <td style="text-align: center;">␆</td> 10130 </tr> 10131 <tr class="even"> 10132 <td>BEL</td> 10133 <td style="text-align: center;">0x07</td> 10134 <td style="text-align: center;">␇</td> 10135 </tr> 10136 <tr class="odd"> 10137 <td>BS</td> 10138 <td style="text-align: center;">0x08</td> 10139 <td style="text-align: center;">␈</td> 10140 </tr> 10141 <tr class="even"> 10142 <td>HT</td> 10143 <td style="text-align: center;">0x09</td> 10144 <td style="text-align: center;">␉</td> 10145 </tr> 10146 <tr class="odd"> 10147 <td>LF</td> 10148 <td style="text-align: center;">0x0A</td> 10149 <td style="text-align: center;">␊</td> 10150 </tr> 10151 <tr class="even"> 10152 <td>VT</td> 10153 <td style="text-align: center;">0x0B</td> 10154 <td style="text-align: center;">␋</td> 10155 </tr> 10156 <tr class="odd"> 10157 <td>FF</td> 10158 <td style="text-align: center;">0x0C</td> 10159 <td style="text-align: center;">␌</td> 10160 </tr> 10161 <tr class="even"> 10162 <td>CR</td> 10163 <td style="text-align: center;">0x0D</td> 10164 <td style="text-align: center;">␍</td> 10165 </tr> 10166 <tr class="odd"> 10167 <td>SO</td> 10168 <td style="text-align: center;">0x0E</td> 10169 <td style="text-align: center;">␎</td> 10170 </tr> 10171 <tr class="even"> 10172 <td>SI</td> 10173 <td style="text-align: center;">0x0F</td> 10174 <td style="text-align: center;">␏</td> 10175 </tr> 10176 <tr class="odd"> 10177 <td>DLE</td> 10178 <td style="text-align: center;">0x10</td> 10179 <td style="text-align: center;">␐</td> 10180 </tr> 10181 <tr class="even"> 10182 <td>DC1</td> 10183 <td style="text-align: center;">0x11</td> 10184 <td style="text-align: center;">␑</td> 10185 </tr> 10186 <tr class="odd"> 10187 <td>DC2</td> 10188 <td style="text-align: center;">0x12</td> 10189 <td style="text-align: center;">␒</td> 10190 </tr> 10191 <tr class="even"> 10192 <td>DC3</td> 10193 <td style="text-align: center;">0x13</td> 10194 <td style="text-align: center;">␓</td> 10195 </tr> 10196 <tr class="odd"> 10197 <td>DC4</td> 10198 <td style="text-align: center;">0x14</td> 10199 <td style="text-align: center;">␔</td> 10200 </tr> 10201 <tr class="even"> 10202 <td>NAK</td> 10203 <td style="text-align: center;">0x15</td> 10204 <td style="text-align: center;">␕</td> 10205 </tr> 10206 <tr class="odd"> 10207 <td>SYN</td> 10208 <td style="text-align: center;">0x16</td> 10209 <td style="text-align: center;">␖</td> 10210 </tr> 10211 <tr class="even"> 10212 <td>ETB</td> 10213 <td style="text-align: center;">0x17</td> 10214 <td style="text-align: center;">␗</td> 10215 </tr> 10216 <tr class="odd"> 10217 <td>CAN</td> 10218 <td style="text-align: center;">0x18</td> 10219 <td style="text-align: center;">␘</td> 10220 </tr> 10221 <tr class="even"> 10222 <td>EM</td> 10223 <td style="text-align: center;">0x19</td> 10224 <td style="text-align: center;">␙</td> 10225 </tr> 10226 <tr class="odd"> 10227 <td>SUB</td> 10228 <td style="text-align: center;">0x1A</td> 10229 <td style="text-align: center;">␚</td> 10230 </tr> 10231 <tr class="even"> 10232 <td>ESC</td> 10233 <td style="text-align: center;">0x1B</td> 10234 <td style="text-align: center;">␛</td> 10235 </tr> 10236 <tr class="odd"> 10237 <td>FS</td> 10238 <td style="text-align: center;">0x1C</td> 10239 <td style="text-align: center;">␜</td> 10240 </tr> 10241 <tr class="even"> 10242 <td>GS</td> 10243 <td style="text-align: center;">0x1D</td> 10244 <td style="text-align: center;">␝</td> 10245 </tr> 10246 <tr class="odd"> 10247 <td>RS</td> 10248 <td style="text-align: center;">0x1E</td> 10249 <td style="text-align: center;">␞</td> 10250 </tr> 10251 <tr class="even"> 10252 <td>US</td> 10253 <td style="text-align: center;">0x1F</td> 10254 <td style="text-align: center;">␟</td> 10255 </tr> 10256 <tr class="odd"> 10257 <td>/</td> 10258 <td style="text-align: center;">0x2F</td> 10259 <td style="text-align: center;">／</td> 10260 </tr> 10261 <tr class="even"> 10262 <td>DEL</td> 10263 <td style="text-align: center;">0x7F</td> 10264 <td style="text-align: center;">␡</td> 10265 </tr> 10266 </tbody> 10267 </table> 10268 <p>The default encoding will also encode these file names as they are problematic with many cloud storage systems.</p> 10269 <table> 10270 <thead> 10271 <tr class="header"> 10272 <th>File name</th> 10273 <th style="text-align: center;">Replacement</th> 10274 </tr> 10275 </thead> 10276 <tbody> 10277 <tr class="odd"> 10278 <td>.</td> 10279 <td style="text-align: center;">．</td> 10280 </tr> 10281 <tr class="even"> 10282 <td>..</td> 10283 <td style="text-align: center;">．．</td> 10284 </tr> 10285 </tbody> 10286 </table> 10287 <h4 id="invalid-utf8">Invalid UTF-8 bytes</h4> 10288 <p>Some backends only support a sequence of well formed UTF-8 bytes as file or directory names.</p> 10289 <p>In this case all invalid UTF-8 bytes will be replaced with a quoted representation of the byte value to allow uploading a file to such a backend. For example, the invalid byte <code>0xFE</code> will be encoded as <code>‛FE</code>.</p> 10290 <p>A common source of invalid UTF-8 bytes are local filesystems, that store names in a different encoding than UTF-8 or UTF-16, like latin1. See the <a href="https://rclone.org/local/#filenames">local filenames</a> section for details.</p> 10291 <h4 id="encoding">Encoding option</h4> 10292 <p>Most backends have an encoding option, specified as a flag <code>--backend-encoding</code> where <code>backend</code> is the name of the backend, or as a config parameter <code>encoding</code> (you'll need to select the Advanced config in <code>rclone config</code> to see it).</p> 10293 <p>This will have default value which encodes and decodes characters in such a way as to preserve the maximum number of characters (see above).</p> 10294 <p>However this can be incorrect in some scenarios, for example if you have a Windows file system with Unicode fullwidth characters <code>＊</code>, <code>？</code> or <code>：</code>, that you want to remain as those characters on the remote rather than being translated to regular (halfwidth) <code>*</code>, <code>?</code> and <code>:</code>.</p> 10295 <p>The <code>--backend-encoding</code> flags allow you to change that. You can disable the encoding completely with <code>--backend-encoding None</code> or set <code>encoding = None</code> in the config file.</p> 10296 <p>Encoding takes a comma separated list of encodings. You can see the list of all possible values by passing an invalid value to this flag, e.g. <code>--local-encoding "help"</code>. The command <code>rclone help flags encoding</code> will show you the defaults for the backends.</p> 10297 <table> 10298 <colgroup> 10299 <col style="width: 31%" /> 10300 <col style="width: 34%" /> 10301 <col style="width: 34%" /> 10302 </colgroup> 10303 <thead> 10304 <tr class="header"> 10305 <th>Encoding</th> 10306 <th>Characters</th> 10307 <th>Encoded as</th> 10308 </tr> 10309 </thead> 10310 <tbody> 10311 <tr class="odd"> 10312 <td>Asterisk</td> 10313 <td><code>*</code></td> 10314 <td><code>＊</code></td> 10315 </tr> 10316 <tr class="even"> 10317 <td>BackQuote</td> 10318 <td><code>`</code></td> 10319 <td><code>｀</code></td> 10320 </tr> 10321 <tr class="odd"> 10322 <td>BackSlash</td> 10323 <td><code>\</code></td> 10324 <td><code>＼</code></td> 10325 </tr> 10326 <tr class="even"> 10327 <td>Colon</td> 10328 <td><code>:</code></td> 10329 <td><code>：</code></td> 10330 </tr> 10331 <tr class="odd"> 10332 <td>CrLf</td> 10333 <td>CR 0x0D, LF 0x0A</td> 10334 <td><code>␍</code>, <code>␊</code></td> 10335 </tr> 10336 <tr class="even"> 10337 <td>Ctl</td> 10338 <td>All control characters 0x00-0x1F</td> 10339 <td><code>␀␁␂␃␄␅␆␇␈␉␊␋␌␍␎␏␐␑␒␓␔␕␖␗␘␙␚␛␜␝␞␟</code></td> 10340 </tr> 10341 <tr class="odd"> 10342 <td>Del</td> 10343 <td>DEL 0x7F</td> 10344 <td><code>␡</code></td> 10345 </tr> 10346 <tr class="even"> 10347 <td>Dollar</td> 10348 <td><code>$</code></td> 10349 <td><code>＄</code></td> 10350 </tr> 10351 <tr class="odd"> 10352 <td>Dot</td> 10353 <td><code>.</code> or <code>..</code> as entire string</td> 10354 <td><code>．</code>, <code>．．</code></td> 10355 </tr> 10356 <tr class="even"> 10357 <td>DoubleQuote</td> 10358 <td><code>"</code></td> 10359 <td><code>＂</code></td> 10360 </tr> 10361 <tr class="odd"> 10362 <td>Hash</td> 10363 <td><code>#</code></td> 10364 <td><code>＃</code></td> 10365 </tr> 10366 <tr class="even"> 10367 <td>InvalidUtf8</td> 10368 <td>An invalid UTF-8 character (e.g. latin1)</td> 10369 <td><code>�</code></td> 10370 </tr> 10371 <tr class="odd"> 10372 <td>LeftCrLfHtVt</td> 10373 <td>CR 0x0D, LF 0x0A, HT 0x09, VT 0x0B on the left of a string</td> 10374 <td><code>␍</code>, <code>␊</code>, <code>␉</code>, <code>␋</code></td> 10375 </tr> 10376 <tr class="even"> 10377 <td>LeftPeriod</td> 10378 <td><code>.</code> on the left of a string</td> 10379 <td><code>.</code></td> 10380 </tr> 10381 <tr class="odd"> 10382 <td>LeftSpace</td> 10383 <td>SPACE on the left of a string</td> 10384 <td><code>␠</code></td> 10385 </tr> 10386 <tr class="even"> 10387 <td>LeftTilde</td> 10388 <td><code>~</code> on the left of a string</td> 10389 <td><code>～</code></td> 10390 </tr> 10391 <tr class="odd"> 10392 <td>LtGt</td> 10393 <td><code><</code>, <code>></code></td> 10394 <td><code>＜</code>, <code>＞</code></td> 10395 </tr> 10396 <tr class="even"> 10397 <td>None</td> 10398 <td>No characters are encoded</td> 10399 <td></td> 10400 </tr> 10401 <tr class="odd"> 10402 <td>Percent</td> 10403 <td><code>%</code></td> 10404 <td><code>％</code></td> 10405 </tr> 10406 <tr class="even"> 10407 <td>Pipe</td> 10408 <td>|</td> 10409 <td><code>｜</code></td> 10410 </tr> 10411 <tr class="odd"> 10412 <td>Question</td> 10413 <td><code>?</code></td> 10414 <td><code>？</code></td> 10415 </tr> 10416 <tr class="even"> 10417 <td>RightCrLfHtVt</td> 10418 <td>CR 0x0D, LF 0x0A, HT 0x09, VT 0x0B on the right of a string</td> 10419 <td><code>␍</code>, <code>␊</code>, <code>␉</code>, <code>␋</code></td> 10420 </tr> 10421 <tr class="odd"> 10422 <td>RightPeriod</td> 10423 <td><code>.</code> on the right of a string</td> 10424 <td><code>.</code></td> 10425 </tr> 10426 <tr class="even"> 10427 <td>RightSpace</td> 10428 <td>SPACE on the right of a string</td> 10429 <td><code>␠</code></td> 10430 </tr> 10431 <tr class="odd"> 10432 <td>Semicolon</td> 10433 <td><code>;</code></td> 10434 <td><code>；</code></td> 10435 </tr> 10436 <tr class="even"> 10437 <td>SingleQuote</td> 10438 <td><code>'</code></td> 10439 <td><code>＇</code></td> 10440 </tr> 10441 <tr class="odd"> 10442 <td>Slash</td> 10443 <td><code>/</code></td> 10444 <td><code>／</code></td> 10445 </tr> 10446 <tr class="even"> 10447 <td>SquareBracket</td> 10448 <td><code>[</code>, <code>]</code></td> 10449 <td><code>［</code>, <code>］</code></td> 10450 </tr> 10451 </tbody> 10452 </table> 10453 <h5 id="encoding-example-ftp">Encoding example: FTP</h5> 10454 <p>To take a specific example, the FTP backend's default encoding is</p> 10455 <pre><code>--ftp-encoding "Slash,Del,Ctl,RightSpace,Dot"</code></pre> 10456 <p>However, let's say the FTP server is running on Windows and can't have any of the invalid Windows characters in file names. You are backing up Linux servers to this FTP server which do have those characters in file names. So you would add the Windows set which are</p> 10457 <pre><code>Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot</code></pre> 10458 <p>to the existing ones, giving:</p> 10459 <pre><code>Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot,Del,RightSpace</code></pre> 10460 <p>This can be specified using the <code>--ftp-encoding</code> flag or using an <code>encoding</code> parameter in the config file.</p> 10461 <h5 id="encoding-example-windows">Encoding example: Windows</h5> 10462 <p>As a nother example, take a Windows system where there is a file with name <code>Test：1.jpg</code>, where <code>：</code> is the Unicode fullwidth colon symbol. When using rclone to copy this to a remote which supports <code>:</code>, the regular (halfwidth) colon (such as Google Drive), you will notice that the file gets renamed to <code>Test:1.jpg</code>.</p> 10463 <p>To avoid this you can change the set of characters rclone should convert for the local filesystem, using command-line argument <code>--local-encoding</code>. Rclone's default behavior on Windows corresponds to</p> 10464 <pre><code>--local-encoding "Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot"</code></pre> 10465 <p>If you want to use fullwidth characters <code>：</code>, <code>＊</code> and <code>？</code> in your filenames without rclone changing them when uploading to a remote, then set the same as the default value but without <code>Colon,Question,Asterisk</code>:</p> 10466 <pre><code>--local-encoding "Slash,LtGt,DoubleQuote,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot"</code></pre> 10467 <p>Alternatively, you can disable the conversion of any characters with <code>--local-encoding None</code>.</p> 10468 <p>Instead of using command-line argument <code>--local-encoding</code>, you may also set it as <a href="https://rclone.org/docs/#environment-variables">environment variable</a> <code>RCLONE_LOCAL_ENCODING</code>, or <a href="https://rclone.org/docs/#configure">configure</a> a remote of type <code>local</code> in your config, and set the <code>encoding</code> option there.</p> 10469 <p>The risk by doing this is that if you have a filename with the regular (halfwidth) <code>:</code>, <code>*</code> and <code>?</code> in your cloud storage, and you try to download it to your Windows filesystem, this will fail. These characters are not valid in filenames on Windows, and you have told rclone not to work around this by converting them to valid fullwidth variants.</p> 10470 <h3 id="mime-type">MIME Type</h3> 10471 <p>MIME types (also known as media types) classify types of documents using a simple text classification, e.g. <code>text/html</code> or <code>application/pdf</code>.</p> 10472 <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> 10473 <p>The MIME type can be important if you are serving files directly to HTTP from the storage system.</p> 10474 <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> 10475 <h3 id="metadata-1">Metadata</h3> 10476 <p>Backends may or may support reading or writing metadata. They may support reading and writing system metadata (metadata intrinsic to that backend) and/or user metadata (general purpose metadata).</p> 10477 <p>The levels of metadata support are</p> 10478 <table> 10479 <colgroup> 10480 <col style="width: 27%" /> 10481 <col style="width: 72%" /> 10482 </colgroup> 10483 <thead> 10484 <tr class="header"> 10485 <th>Key</th> 10486 <th>Explanation</th> 10487 </tr> 10488 </thead> 10489 <tbody> 10490 <tr class="odd"> 10491 <td><code>R</code></td> 10492 <td>Read only System Metadata on files only</td> 10493 </tr> 10494 <tr class="even"> 10495 <td><code>RW</code></td> 10496 <td>Read and write System Metadata on files only</td> 10497 </tr> 10498 <tr class="odd"> 10499 <td><code>RWU</code></td> 10500 <td>Read and write System Metadata and read and write User Metadata on files only</td> 10501 </tr> 10502 <tr class="even"> 10503 <td><code>DR</code></td> 10504 <td>Read only System Metadata on files and directories</td> 10505 </tr> 10506 <tr class="odd"> 10507 <td><code>DRW</code></td> 10508 <td>Read and write System Metadata on files and directories</td> 10509 </tr> 10510 <tr class="even"> 10511 <td><code>DRWU</code></td> 10512 <td>Read and write System Metadata and read and write User Metadata on files and directories</td> 10513 </tr> 10514 </tbody> 10515 </table> 10516 <p>See <a href="https://rclone.org/docs/#metadata">the metadata docs</a> for more info.</p> 10517 <h2 id="optional-features">Optional Features</h2> 10518 <p>All rclone remotes support a base command set. Other features depend upon backend-specific capabilities.</p> 10519 <table style="width:100%;"> 10520 <colgroup> 10521 <col style="width: 20%" /> 10522 <col style="width: 5%" /> 10523 <col style="width: 4%" /> 10524 <col style="width: 4%" /> 10525 <col style="width: 6%" /> 10526 <col style="width: 6%" /> 10527 <col style="width: 5%" /> 10528 <col style="width: 10%" /> 10529 <col style="width: 13%" /> 10530 <col style="width: 10%" /> 10531 <col style="width: 5%" /> 10532 <col style="width: 7%" /> 10533 </colgroup> 10534 <thead> 10535 <tr class="header"> 10536 <th>Name</th> 10537 <th style="text-align: center;">Purge</th> 10538 <th style="text-align: center;">Copy</th> 10539 <th style="text-align: center;">Move</th> 10540 <th style="text-align: center;">DirMove</th> 10541 <th style="text-align: center;">CleanUp</th> 10542 <th style="text-align: center;">ListR</th> 10543 <th style="text-align: center;">StreamUpload</th> 10544 <th style="text-align: left;">MultithreadUpload</th> 10545 <th style="text-align: center;">LinkSharing</th> 10546 <th style="text-align: center;">About</th> 10547 <th style="text-align: center;">EmptyDir</th> 10548 </tr> 10549 </thead> 10550 <tbody> 10551 <tr class="odd"> 10552 <td>1Fichier</td> 10553 <td style="text-align: center;">No</td> 10554 <td style="text-align: center;">Yes</td> 10555 <td style="text-align: center;">Yes</td> 10556 <td style="text-align: center;">No</td> 10557 <td style="text-align: center;">No</td> 10558 <td style="text-align: center;">No</td> 10559 <td style="text-align: center;">No</td> 10560 <td style="text-align: left;">No</td> 10561 <td style="text-align: center;">Yes</td> 10562 <td style="text-align: center;">No</td> 10563 <td style="text-align: center;">Yes</td> 10564 </tr> 10565 <tr class="even"> 10566 <td>Akamai Netstorage</td> 10567 <td style="text-align: center;">Yes</td> 10568 <td style="text-align: center;">No</td> 10569 <td style="text-align: center;">No</td> 10570 <td style="text-align: center;">No</td> 10571 <td style="text-align: center;">No</td> 10572 <td style="text-align: center;">Yes</td> 10573 <td style="text-align: center;">Yes</td> 10574 <td style="text-align: left;">No</td> 10575 <td style="text-align: center;">No</td> 10576 <td style="text-align: center;">No</td> 10577 <td style="text-align: center;">Yes</td> 10578 </tr> 10579 <tr class="odd"> 10580 <td>Amazon S3 (or S3 compatible)</td> 10581 <td style="text-align: center;">No</td> 10582 <td style="text-align: center;">Yes</td> 10583 <td style="text-align: center;">No</td> 10584 <td style="text-align: center;">No</td> 10585 <td style="text-align: center;">Yes</td> 10586 <td style="text-align: center;">Yes</td> 10587 <td style="text-align: center;">Yes</td> 10588 <td style="text-align: left;">Yes</td> 10589 <td style="text-align: center;">Yes</td> 10590 <td style="text-align: center;">No</td> 10591 <td style="text-align: center;">No</td> 10592 </tr> 10593 <tr class="even"> 10594 <td>Backblaze B2</td> 10595 <td style="text-align: center;">No</td> 10596 <td style="text-align: center;">Yes</td> 10597 <td style="text-align: center;">No</td> 10598 <td style="text-align: center;">No</td> 10599 <td style="text-align: center;">Yes</td> 10600 <td style="text-align: center;">Yes</td> 10601 <td style="text-align: center;">Yes</td> 10602 <td style="text-align: left;">Yes</td> 10603 <td style="text-align: center;">Yes</td> 10604 <td style="text-align: center;">No</td> 10605 <td style="text-align: center;">No</td> 10606 </tr> 10607 <tr class="odd"> 10608 <td>Box</td> 10609 <td style="text-align: center;">Yes</td> 10610 <td style="text-align: center;">Yes</td> 10611 <td style="text-align: center;">Yes</td> 10612 <td style="text-align: center;">Yes</td> 10613 <td style="text-align: center;">Yes</td> 10614 <td style="text-align: center;">No</td> 10615 <td style="text-align: center;">Yes</td> 10616 <td style="text-align: left;">No</td> 10617 <td style="text-align: center;">Yes</td> 10618 <td style="text-align: center;">Yes</td> 10619 <td style="text-align: center;">Yes</td> 10620 </tr> 10621 <tr class="even"> 10622 <td>Citrix ShareFile</td> 10623 <td style="text-align: center;">Yes</td> 10624 <td style="text-align: center;">Yes</td> 10625 <td style="text-align: center;">Yes</td> 10626 <td style="text-align: center;">Yes</td> 10627 <td style="text-align: center;">No</td> 10628 <td style="text-align: center;">No</td> 10629 <td style="text-align: center;">No</td> 10630 <td style="text-align: left;">No</td> 10631 <td style="text-align: center;">No</td> 10632 <td style="text-align: center;">No</td> 10633 <td style="text-align: center;">Yes</td> 10634 </tr> 10635 <tr class="odd"> 10636 <td>Dropbox</td> 10637 <td style="text-align: center;">Yes</td> 10638 <td style="text-align: center;">Yes</td> 10639 <td style="text-align: center;">Yes</td> 10640 <td style="text-align: center;">Yes</td> 10641 <td style="text-align: center;">No</td> 10642 <td style="text-align: center;">No</td> 10643 <td style="text-align: center;">Yes</td> 10644 <td style="text-align: left;">No</td> 10645 <td style="text-align: center;">Yes</td> 10646 <td style="text-align: center;">Yes</td> 10647 <td style="text-align: center;">Yes</td> 10648 </tr> 10649 <tr class="even"> 10650 <td>Enterprise File Fabric</td> 10651 <td style="text-align: center;">Yes</td> 10652 <td style="text-align: center;">Yes</td> 10653 <td style="text-align: center;">Yes</td> 10654 <td style="text-align: center;">Yes</td> 10655 <td style="text-align: center;">Yes</td> 10656 <td style="text-align: center;">No</td> 10657 <td style="text-align: center;">No</td> 10658 <td style="text-align: left;">No</td> 10659 <td style="text-align: center;">No</td> 10660 <td style="text-align: center;">No</td> 10661 <td style="text-align: center;">Yes</td> 10662 </tr> 10663 <tr class="odd"> 10664 <td>FTP</td> 10665 <td style="text-align: center;">No</td> 10666 <td style="text-align: center;">No</td> 10667 <td style="text-align: center;">Yes</td> 10668 <td style="text-align: center;">Yes</td> 10669 <td style="text-align: center;">No</td> 10670 <td style="text-align: center;">No</td> 10671 <td style="text-align: center;">Yes</td> 10672 <td style="text-align: left;">No</td> 10673 <td style="text-align: center;">No</td> 10674 <td style="text-align: center;">No</td> 10675 <td style="text-align: center;">Yes</td> 10676 </tr> 10677 <tr class="even"> 10678 <td>Google Cloud Storage</td> 10679 <td style="text-align: center;">Yes</td> 10680 <td style="text-align: center;">Yes</td> 10681 <td style="text-align: center;">No</td> 10682 <td style="text-align: center;">No</td> 10683 <td style="text-align: center;">No</td> 10684 <td style="text-align: center;">Yes</td> 10685 <td style="text-align: center;">Yes</td> 10686 <td style="text-align: left;">No</td> 10687 <td style="text-align: center;">No</td> 10688 <td style="text-align: center;">No</td> 10689 <td style="text-align: center;">No</td> 10690 </tr> 10691 <tr class="odd"> 10692 <td>Google Drive</td> 10693 <td style="text-align: center;">Yes</td> 10694 <td style="text-align: center;">Yes</td> 10695 <td style="text-align: center;">Yes</td> 10696 <td style="text-align: center;">Yes</td> 10697 <td style="text-align: center;">Yes</td> 10698 <td style="text-align: center;">Yes</td> 10699 <td style="text-align: center;">Yes</td> 10700 <td style="text-align: left;">No</td> 10701 <td style="text-align: center;">Yes</td> 10702 <td style="text-align: center;">Yes</td> 10703 <td style="text-align: center;">Yes</td> 10704 </tr> 10705 <tr class="even"> 10706 <td>Google Photos</td> 10707 <td style="text-align: center;">No</td> 10708 <td style="text-align: center;">No</td> 10709 <td style="text-align: center;">No</td> 10710 <td style="text-align: center;">No</td> 10711 <td style="text-align: center;">No</td> 10712 <td style="text-align: center;">No</td> 10713 <td style="text-align: center;">No</td> 10714 <td style="text-align: left;">No</td> 10715 <td style="text-align: center;">No</td> 10716 <td style="text-align: center;">No</td> 10717 <td style="text-align: center;">No</td> 10718 </tr> 10719 <tr class="odd"> 10720 <td>HDFS</td> 10721 <td style="text-align: center;">Yes</td> 10722 <td style="text-align: center;">No</td> 10723 <td style="text-align: center;">Yes</td> 10724 <td style="text-align: center;">Yes</td> 10725 <td style="text-align: center;">No</td> 10726 <td style="text-align: center;">No</td> 10727 <td style="text-align: center;">Yes</td> 10728 <td style="text-align: left;">No</td> 10729 <td style="text-align: center;">No</td> 10730 <td style="text-align: center;">Yes</td> 10731 <td style="text-align: center;">Yes</td> 10732 </tr> 10733 <tr class="even"> 10734 <td>HiDrive</td> 10735 <td style="text-align: center;">Yes</td> 10736 <td style="text-align: center;">Yes</td> 10737 <td style="text-align: center;">Yes</td> 10738 <td style="text-align: center;">Yes</td> 10739 <td style="text-align: center;">No</td> 10740 <td style="text-align: center;">No</td> 10741 <td style="text-align: center;">Yes</td> 10742 <td style="text-align: left;">No</td> 10743 <td style="text-align: center;">No</td> 10744 <td style="text-align: center;">No</td> 10745 <td style="text-align: center;">Yes</td> 10746 </tr> 10747 <tr class="odd"> 10748 <td>HTTP</td> 10749 <td style="text-align: center;">No</td> 10750 <td style="text-align: center;">No</td> 10751 <td style="text-align: center;">No</td> 10752 <td style="text-align: center;">No</td> 10753 <td style="text-align: center;">No</td> 10754 <td style="text-align: center;">No</td> 10755 <td style="text-align: center;">No</td> 10756 <td style="text-align: left;">No</td> 10757 <td style="text-align: center;">No</td> 10758 <td style="text-align: center;">No</td> 10759 <td style="text-align: center;">Yes</td> 10760 </tr> 10761 <tr class="even"> 10762 <td>ImageKit</td> 10763 <td style="text-align: center;">Yes</td> 10764 <td style="text-align: center;">Yes</td> 10765 <td style="text-align: center;">Yes</td> 10766 <td style="text-align: center;">No</td> 10767 <td style="text-align: center;">No</td> 10768 <td style="text-align: center;">No</td> 10769 <td style="text-align: center;">No</td> 10770 <td style="text-align: left;">No</td> 10771 <td style="text-align: center;">No</td> 10772 <td style="text-align: center;">No</td> 10773 <td style="text-align: center;">Yes</td> 10774 </tr> 10775 <tr class="odd"> 10776 <td>Internet Archive</td> 10777 <td style="text-align: center;">No</td> 10778 <td style="text-align: center;">Yes</td> 10779 <td style="text-align: center;">No</td> 10780 <td style="text-align: center;">No</td> 10781 <td style="text-align: center;">Yes</td> 10782 <td style="text-align: center;">Yes</td> 10783 <td style="text-align: center;">No</td> 10784 <td style="text-align: left;">No</td> 10785 <td style="text-align: center;">Yes</td> 10786 <td style="text-align: center;">Yes</td> 10787 <td style="text-align: center;">No</td> 10788 </tr> 10789 <tr class="even"> 10790 <td>Jottacloud</td> 10791 <td style="text-align: center;">Yes</td> 10792 <td style="text-align: center;">Yes</td> 10793 <td style="text-align: center;">Yes</td> 10794 <td style="text-align: center;">Yes</td> 10795 <td style="text-align: center;">Yes</td> 10796 <td style="text-align: center;">Yes</td> 10797 <td style="text-align: center;">No</td> 10798 <td style="text-align: left;">No</td> 10799 <td style="text-align: center;">Yes</td> 10800 <td style="text-align: center;">Yes</td> 10801 <td style="text-align: center;">Yes</td> 10802 </tr> 10803 <tr class="odd"> 10804 <td>Koofr</td> 10805 <td style="text-align: center;">Yes</td> 10806 <td style="text-align: center;">Yes</td> 10807 <td style="text-align: center;">Yes</td> 10808 <td style="text-align: center;">Yes</td> 10809 <td style="text-align: center;">No</td> 10810 <td style="text-align: center;">No</td> 10811 <td style="text-align: center;">Yes</td> 10812 <td style="text-align: left;">No</td> 10813 <td style="text-align: center;">Yes</td> 10814 <td style="text-align: center;">Yes</td> 10815 <td style="text-align: center;">Yes</td> 10816 </tr> 10817 <tr class="even"> 10818 <td>Mail.ru Cloud</td> 10819 <td style="text-align: center;">Yes</td> 10820 <td style="text-align: center;">Yes</td> 10821 <td style="text-align: center;">Yes</td> 10822 <td style="text-align: center;">Yes</td> 10823 <td style="text-align: center;">Yes</td> 10824 <td style="text-align: center;">No</td> 10825 <td style="text-align: center;">No</td> 10826 <td style="text-align: left;">No</td> 10827 <td style="text-align: center;">Yes</td> 10828 <td style="text-align: center;">Yes</td> 10829 <td style="text-align: center;">Yes</td> 10830 </tr> 10831 <tr class="odd"> 10832 <td>Mega</td> 10833 <td style="text-align: center;">Yes</td> 10834 <td style="text-align: center;">No</td> 10835 <td style="text-align: center;">Yes</td> 10836 <td style="text-align: center;">Yes</td> 10837 <td style="text-align: center;">Yes</td> 10838 <td style="text-align: center;">No</td> 10839 <td style="text-align: center;">No</td> 10840 <td style="text-align: left;">No</td> 10841 <td style="text-align: center;">Yes</td> 10842 <td style="text-align: center;">Yes</td> 10843 <td style="text-align: center;">Yes</td> 10844 </tr> 10845 <tr class="even"> 10846 <td>Memory</td> 10847 <td style="text-align: center;">No</td> 10848 <td style="text-align: center;">Yes</td> 10849 <td style="text-align: center;">No</td> 10850 <td style="text-align: center;">No</td> 10851 <td style="text-align: center;">No</td> 10852 <td style="text-align: center;">Yes</td> 10853 <td style="text-align: center;">Yes</td> 10854 <td style="text-align: left;">No</td> 10855 <td style="text-align: center;">No</td> 10856 <td style="text-align: center;">No</td> 10857 <td style="text-align: center;">No</td> 10858 </tr> 10859 <tr class="odd"> 10860 <td>Microsoft Azure Blob Storage</td> 10861 <td style="text-align: center;">Yes</td> 10862 <td style="text-align: center;">Yes</td> 10863 <td style="text-align: center;">No</td> 10864 <td style="text-align: center;">No</td> 10865 <td style="text-align: center;">No</td> 10866 <td style="text-align: center;">Yes</td> 10867 <td style="text-align: center;">Yes</td> 10868 <td style="text-align: left;">Yes</td> 10869 <td style="text-align: center;">No</td> 10870 <td style="text-align: center;">No</td> 10871 <td style="text-align: center;">No</td> 10872 </tr> 10873 <tr class="even"> 10874 <td>Microsoft Azure Files Storage</td> 10875 <td style="text-align: center;">No</td> 10876 <td style="text-align: center;">Yes</td> 10877 <td style="text-align: center;">Yes</td> 10878 <td style="text-align: center;">Yes</td> 10879 <td style="text-align: center;">No</td> 10880 <td style="text-align: center;">No</td> 10881 <td style="text-align: center;">Yes</td> 10882 <td style="text-align: left;">Yes</td> 10883 <td style="text-align: center;">No</td> 10884 <td style="text-align: center;">Yes</td> 10885 <td style="text-align: center;">Yes</td> 10886 </tr> 10887 <tr class="odd"> 10888 <td>Microsoft OneDrive</td> 10889 <td style="text-align: center;">Yes</td> 10890 <td style="text-align: center;">Yes</td> 10891 <td style="text-align: center;">Yes</td> 10892 <td style="text-align: center;">Yes</td> 10893 <td style="text-align: center;">Yes</td> 10894 <td style="text-align: center;">Yes ⁵</td> 10895 <td style="text-align: center;">No</td> 10896 <td style="text-align: left;">No</td> 10897 <td style="text-align: center;">Yes</td> 10898 <td style="text-align: center;">Yes</td> 10899 <td style="text-align: center;">Yes</td> 10900 </tr> 10901 <tr class="even"> 10902 <td>OpenDrive</td> 10903 <td style="text-align: center;">Yes</td> 10904 <td style="text-align: center;">Yes</td> 10905 <td style="text-align: center;">Yes</td> 10906 <td style="text-align: center;">Yes</td> 10907 <td style="text-align: center;">No</td> 10908 <td style="text-align: center;">No</td> 10909 <td style="text-align: center;">No</td> 10910 <td style="text-align: left;">No</td> 10911 <td style="text-align: center;">No</td> 10912 <td style="text-align: center;">No</td> 10913 <td style="text-align: center;">Yes</td> 10914 </tr> 10915 <tr class="odd"> 10916 <td>OpenStack Swift</td> 10917 <td style="text-align: center;">Yes ¹</td> 10918 <td style="text-align: center;">Yes</td> 10919 <td style="text-align: center;">No</td> 10920 <td style="text-align: center;">No</td> 10921 <td style="text-align: center;">No</td> 10922 <td style="text-align: center;">Yes</td> 10923 <td style="text-align: center;">Yes</td> 10924 <td style="text-align: left;">No</td> 10925 <td style="text-align: center;">No</td> 10926 <td style="text-align: center;">Yes</td> 10927 <td style="text-align: center;">No</td> 10928 </tr> 10929 <tr class="even"> 10930 <td>Oracle Object Storage</td> 10931 <td style="text-align: center;">No</td> 10932 <td style="text-align: center;">Yes</td> 10933 <td style="text-align: center;">No</td> 10934 <td style="text-align: center;">No</td> 10935 <td style="text-align: center;">Yes</td> 10936 <td style="text-align: center;">Yes</td> 10937 <td style="text-align: center;">Yes</td> 10938 <td style="text-align: left;">Yes</td> 10939 <td style="text-align: center;">No</td> 10940 <td style="text-align: center;">No</td> 10941 <td style="text-align: center;">No</td> 10942 </tr> 10943 <tr class="odd"> 10944 <td>pCloud</td> 10945 <td style="text-align: center;">Yes</td> 10946 <td style="text-align: center;">Yes</td> 10947 <td style="text-align: center;">Yes</td> 10948 <td style="text-align: center;">Yes</td> 10949 <td style="text-align: center;">Yes</td> 10950 <td style="text-align: center;">No</td> 10951 <td style="text-align: center;">No</td> 10952 <td style="text-align: left;">No</td> 10953 <td style="text-align: center;">Yes</td> 10954 <td style="text-align: center;">Yes</td> 10955 <td style="text-align: center;">Yes</td> 10956 </tr> 10957 <tr class="even"> 10958 <td>PikPak</td> 10959 <td style="text-align: center;">Yes</td> 10960 <td style="text-align: center;">Yes</td> 10961 <td style="text-align: center;">Yes</td> 10962 <td style="text-align: center;">Yes</td> 10963 <td style="text-align: center;">Yes</td> 10964 <td style="text-align: center;">No</td> 10965 <td style="text-align: center;">No</td> 10966 <td style="text-align: left;">No</td> 10967 <td style="text-align: center;">Yes</td> 10968 <td style="text-align: center;">Yes</td> 10969 <td style="text-align: center;">Yes</td> 10970 </tr> 10971 <tr class="odd"> 10972 <td>premiumize.me</td> 10973 <td style="text-align: center;">Yes</td> 10974 <td style="text-align: center;">No</td> 10975 <td style="text-align: center;">Yes</td> 10976 <td style="text-align: center;">Yes</td> 10977 <td style="text-align: center;">No</td> 10978 <td style="text-align: center;">No</td> 10979 <td style="text-align: center;">No</td> 10980 <td style="text-align: left;">No</td> 10981 <td style="text-align: center;">Yes</td> 10982 <td style="text-align: center;">Yes</td> 10983 <td style="text-align: center;">Yes</td> 10984 </tr> 10985 <tr class="even"> 10986 <td>put.io</td> 10987 <td style="text-align: center;">Yes</td> 10988 <td style="text-align: center;">No</td> 10989 <td style="text-align: center;">Yes</td> 10990 <td style="text-align: center;">Yes</td> 10991 <td style="text-align: center;">Yes</td> 10992 <td style="text-align: center;">No</td> 10993 <td style="text-align: center;">Yes</td> 10994 <td style="text-align: left;">No</td> 10995 <td style="text-align: center;">No</td> 10996 <td style="text-align: center;">Yes</td> 10997 <td style="text-align: center;">Yes</td> 10998 </tr> 10999 <tr class="odd"> 11000 <td>Proton Drive</td> 11001 <td style="text-align: center;">Yes</td> 11002 <td style="text-align: center;">No</td> 11003 <td style="text-align: center;">Yes</td> 11004 <td style="text-align: center;">Yes</td> 11005 <td style="text-align: center;">Yes</td> 11006 <td style="text-align: center;">No</td> 11007 <td style="text-align: center;">No</td> 11008 <td style="text-align: left;">No</td> 11009 <td style="text-align: center;">No</td> 11010 <td style="text-align: center;">Yes</td> 11011 <td style="text-align: center;">Yes</td> 11012 </tr> 11013 <tr class="even"> 11014 <td>QingStor</td> 11015 <td style="text-align: center;">No</td> 11016 <td style="text-align: center;">Yes</td> 11017 <td style="text-align: center;">No</td> 11018 <td style="text-align: center;">No</td> 11019 <td style="text-align: center;">Yes</td> 11020 <td style="text-align: center;">Yes</td> 11021 <td style="text-align: center;">No</td> 11022 <td style="text-align: left;">No</td> 11023 <td style="text-align: center;">No</td> 11024 <td style="text-align: center;">No</td> 11025 <td style="text-align: center;">No</td> 11026 </tr> 11027 <tr class="odd"> 11028 <td>Quatrix by Maytech</td> 11029 <td style="text-align: center;">Yes</td> 11030 <td style="text-align: center;">Yes</td> 11031 <td style="text-align: center;">Yes</td> 11032 <td style="text-align: center;">Yes</td> 11033 <td style="text-align: center;">No</td> 11034 <td style="text-align: center;">No</td> 11035 <td style="text-align: center;">No</td> 11036 <td style="text-align: left;">No</td> 11037 <td style="text-align: center;">No</td> 11038 <td style="text-align: center;">Yes</td> 11039 <td style="text-align: center;">Yes</td> 11040 </tr> 11041 <tr class="even"> 11042 <td>Seafile</td> 11043 <td style="text-align: center;">Yes</td> 11044 <td style="text-align: center;">Yes</td> 11045 <td style="text-align: center;">Yes</td> 11046 <td style="text-align: center;">Yes</td> 11047 <td style="text-align: center;">Yes</td> 11048 <td style="text-align: center;">Yes</td> 11049 <td style="text-align: center;">Yes</td> 11050 <td style="text-align: left;">No</td> 11051 <td style="text-align: center;">Yes</td> 11052 <td style="text-align: center;">Yes</td> 11053 <td style="text-align: center;">Yes</td> 11054 </tr> 11055 <tr class="odd"> 11056 <td>SFTP</td> 11057 <td style="text-align: center;">No</td> 11058 <td style="text-align: center;">Yes ⁴</td> 11059 <td style="text-align: center;">Yes</td> 11060 <td style="text-align: center;">Yes</td> 11061 <td style="text-align: center;">No</td> 11062 <td style="text-align: center;">No</td> 11063 <td style="text-align: center;">Yes</td> 11064 <td style="text-align: left;">No</td> 11065 <td style="text-align: center;">No</td> 11066 <td style="text-align: center;">Yes</td> 11067 <td style="text-align: center;">Yes</td> 11068 </tr> 11069 <tr class="even"> 11070 <td>Sia</td> 11071 <td style="text-align: center;">No</td> 11072 <td style="text-align: center;">No</td> 11073 <td style="text-align: center;">No</td> 11074 <td style="text-align: center;">No</td> 11075 <td style="text-align: center;">No</td> 11076 <td style="text-align: center;">No</td> 11077 <td style="text-align: center;">Yes</td> 11078 <td style="text-align: left;">No</td> 11079 <td style="text-align: center;">No</td> 11080 <td style="text-align: center;">No</td> 11081 <td style="text-align: center;">Yes</td> 11082 </tr> 11083 <tr class="odd"> 11084 <td>SMB</td> 11085 <td style="text-align: center;">No</td> 11086 <td style="text-align: center;">No</td> 11087 <td style="text-align: center;">Yes</td> 11088 <td style="text-align: center;">Yes</td> 11089 <td style="text-align: center;">No</td> 11090 <td style="text-align: center;">No</td> 11091 <td style="text-align: center;">Yes</td> 11092 <td style="text-align: left;">Yes</td> 11093 <td style="text-align: center;">No</td> 11094 <td style="text-align: center;">No</td> 11095 <td style="text-align: center;">Yes</td> 11096 </tr> 11097 <tr class="even"> 11098 <td>SugarSync</td> 11099 <td style="text-align: center;">Yes</td> 11100 <td style="text-align: center;">Yes</td> 11101 <td style="text-align: center;">Yes</td> 11102 <td style="text-align: center;">Yes</td> 11103 <td style="text-align: center;">No</td> 11104 <td style="text-align: center;">No</td> 11105 <td style="text-align: center;">Yes</td> 11106 <td style="text-align: left;">No</td> 11107 <td style="text-align: center;">Yes</td> 11108 <td style="text-align: center;">No</td> 11109 <td style="text-align: center;">Yes</td> 11110 </tr> 11111 <tr class="odd"> 11112 <td>Storj</td> 11113 <td style="text-align: center;">Yes ²</td> 11114 <td style="text-align: center;">Yes</td> 11115 <td style="text-align: center;">Yes</td> 11116 <td style="text-align: center;">No</td> 11117 <td style="text-align: center;">No</td> 11118 <td style="text-align: center;">Yes</td> 11119 <td style="text-align: center;">Yes</td> 11120 <td style="text-align: left;">No</td> 11121 <td style="text-align: center;">Yes</td> 11122 <td style="text-align: center;">No</td> 11123 <td style="text-align: center;">No</td> 11124 </tr> 11125 <tr class="even"> 11126 <td>Uptobox</td> 11127 <td style="text-align: center;">No</td> 11128 <td style="text-align: center;">Yes</td> 11129 <td style="text-align: center;">Yes</td> 11130 <td style="text-align: center;">Yes</td> 11131 <td style="text-align: center;">No</td> 11132 <td style="text-align: center;">No</td> 11133 <td style="text-align: center;">No</td> 11134 <td style="text-align: left;">No</td> 11135 <td style="text-align: center;">No</td> 11136 <td style="text-align: center;">No</td> 11137 <td style="text-align: center;">No</td> 11138 </tr> 11139 <tr class="odd"> 11140 <td>WebDAV</td> 11141 <td style="text-align: center;">Yes</td> 11142 <td style="text-align: center;">Yes</td> 11143 <td style="text-align: center;">Yes</td> 11144 <td style="text-align: center;">Yes</td> 11145 <td style="text-align: center;">No</td> 11146 <td style="text-align: center;">No</td> 11147 <td style="text-align: center;">Yes ³</td> 11148 <td style="text-align: left;">No</td> 11149 <td style="text-align: center;">No</td> 11150 <td style="text-align: center;">Yes</td> 11151 <td style="text-align: center;">Yes</td> 11152 </tr> 11153 <tr class="even"> 11154 <td>Yandex Disk</td> 11155 <td style="text-align: center;">Yes</td> 11156 <td style="text-align: center;">Yes</td> 11157 <td style="text-align: center;">Yes</td> 11158 <td style="text-align: center;">Yes</td> 11159 <td style="text-align: center;">Yes</td> 11160 <td style="text-align: center;">No</td> 11161 <td style="text-align: center;">Yes</td> 11162 <td style="text-align: left;">No</td> 11163 <td style="text-align: center;">Yes</td> 11164 <td style="text-align: center;">Yes</td> 11165 <td style="text-align: center;">Yes</td> 11166 </tr> 11167 <tr class="odd"> 11168 <td>Zoho WorkDrive</td> 11169 <td style="text-align: center;">Yes</td> 11170 <td style="text-align: center;">Yes</td> 11171 <td style="text-align: center;">Yes</td> 11172 <td style="text-align: center;">Yes</td> 11173 <td style="text-align: center;">No</td> 11174 <td style="text-align: center;">No</td> 11175 <td style="text-align: center;">No</td> 11176 <td style="text-align: left;">No</td> 11177 <td style="text-align: center;">No</td> 11178 <td style="text-align: center;">Yes</td> 11179 <td style="text-align: center;">Yes</td> 11180 </tr> 11181 <tr class="even"> 11182 <td>The local filesystem</td> 11183 <td style="text-align: center;">No</td> 11184 <td style="text-align: center;">No</td> 11185 <td style="text-align: center;">Yes</td> 11186 <td style="text-align: center;">Yes</td> 11187 <td style="text-align: center;">No</td> 11188 <td style="text-align: center;">No</td> 11189 <td style="text-align: center;">Yes</td> 11190 <td style="text-align: left;">Yes</td> 11191 <td style="text-align: center;">No</td> 11192 <td style="text-align: center;">Yes</td> 11193 <td style="text-align: center;">Yes</td> 11194 </tr> 11195 </tbody> 11196 </table> 11197 <p>¹ Note Swift implements this in order to delete directory markers but it doesn't actually have a quicker way of deleting files other than deleting them individually.</p> 11198 <p>² Storj implements this efficiently only for entire buckets. If purging a directory inside a bucket, files are deleted individually.</p> 11199 <p>³ StreamUpload is not supported with Nextcloud</p> 11200 <p>⁴ Use the <code>--sftp-copy-is-hardlink</code> flag to enable.</p> 11201 <p>⁵ Use the <code>--onedrive-delta</code> flag to enable.</p> 11202 <h3 id="purge">Purge</h3> 11203 <p>This deletes a directory quicker than just deleting all the files in the directory.</p> 11204 <h3 id="copy">Copy</h3> 11205 <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> 11206 <p>If the server doesn't support <code>Copy</code> directly then for copy operations the file is downloaded then re-uploaded.</p> 11207 <h3 id="move">Move</h3> 11208 <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> 11209 <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> 11210 <h3 id="dirmove">DirMove</h3> 11211 <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> 11212 <h3 id="cleanup">CleanUp</h3> 11213 <p>This is used for emptying the trash for a remote by <code>rclone cleanup</code>.</p> 11214 <p>If the server can't do <code>CleanUp</code> then <code>rclone cleanup</code> will return an error.</p> 11215 <p>‡‡ Note that while Box implements this it has to delete every file individually so it will be slower than emptying the trash via the WebUI</p> 11216 <h3 id="listr">ListR</h3> 11217 <p>The remote supports a recursive list to list all the contents beneath a directory quickly. This enables the <code>--fast-list</code> flag to work. See the <a href="https://rclone.org/docs/#fast-list">rclone docs</a> for more details.</p> 11218 <h3 id="streamupload">StreamUpload</h3> 11219 <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> 11220 <h3 id="multithreadupload">MultithreadUpload</h3> 11221 <p>Some remotes allow transfers to the remote to be sent as chunks in parallel. If this is supported then rclone will use multi-thread copying to transfer files much faster.</p> 11222 <h3 id="linksharing">LinkSharing</h3> 11223 <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> 11224 <h3 id="about-1">About</h3> 11225 <p>Rclone <code>about</code> prints quota information for a remote. Typical output includes bytes used, free, quota and in trash.</p> 11226 <p>If a remote lacks about capability <code>rclone about remote:</code>returns an error.</p> 11227 <p>Backends without about capability cannot determine free space for an rclone mount, or use policy <code>mfs</code> (most free space) as a member of an rclone union remote.</p> 11228 <p>See <a href="https://rclone.org/commands/rclone_about/">rclone about command</a></p> 11229 <h3 id="emptydir">EmptyDir</h3> 11230 <p>The remote supports empty directories. See <a href="https://rclone.org/bugs/#limitations">Limitations</a> for details. Most Object/Bucket-based remotes do not support this.</p> 11231 <h1 id="global-flags">Global Flags</h1> 11232 <p>This describes the global flags available to every rclone command split into groups.</p> 11233 <h2 id="copy-1">Copy</h2> 11234 <p>Flags for anything which can Copy a file.</p> 11235 <pre><code> --check-first Do all the checks before starting transfers 11236 -c, --checksum Check for changes with size & checksum (if available, or fallback to size only). 11237 --compare-dest stringArray Include additional comma separated server-side paths during comparison 11238 --copy-dest stringArray Implies --compare-dest but also copies files from paths into destination 11239 --cutoff-mode HARD|SOFT|CAUTIOUS Mode to stop transfers when reaching the max transfer limit HARD|SOFT|CAUTIOUS (default HARD) 11240 --ignore-case-sync Ignore case when synchronizing 11241 --ignore-checksum Skip post copy check of checksums 11242 --ignore-existing Skip all files that exist on destination 11243 --ignore-size Ignore size when skipping use modtime or checksum 11244 -I, --ignore-times Don't skip items that match size and time - transfer all unconditionally 11245 --immutable Do not modify files, fail if existing files have been modified 11246 --inplace Download directly to destination file instead of atomic download to temp/rename 11247 --max-backlog int Maximum number of objects in sync or check backlog (default 10000) 11248 --max-duration Duration Maximum duration rclone will transfer data for (default 0s) 11249 --max-transfer SizeSuffix Maximum size of data to transfer (default off) 11250 -M, --metadata If set, preserve metadata when copying objects 11251 --modify-window Duration Max time diff to be considered the same (default 1ns) 11252 --multi-thread-chunk-size SizeSuffix Chunk size for multi-thread downloads / uploads, if not set by filesystem (default 64Mi) 11253 --multi-thread-cutoff SizeSuffix Use multi-thread downloads for files above this size (default 256Mi) 11254 --multi-thread-streams int Number of streams to use for multi-thread downloads (default 4) 11255 --multi-thread-write-buffer-size SizeSuffix In memory buffer size for writing when in multi-thread mode (default 128Ki) 11256 --no-check-dest Don't check the destination, copy regardless 11257 --no-traverse Don't traverse destination file system on copy 11258 --no-update-dir-modtime Don't update directory modification times 11259 --no-update-modtime Don't update destination modtime if files identical 11260 --order-by string Instructions on how to order the transfers, e.g. 'size,descending' 11261 --partial-suffix string Add partial-suffix to temporary file name when --inplace is not used (default ".partial") 11262 --refresh-times Refresh the modtime of remote files 11263 --server-side-across-configs Allow server-side operations (e.g. copy) to work across different configs 11264 --size-only Skip based on size only, not modtime or checksum 11265 --streaming-upload-cutoff SizeSuffix Cutoff for switching to chunked upload if file size is unknown, upload starts after reaching cutoff or when file ends (default 100Ki) 11266 -u, --update Skip files that are newer on the destination</code></pre> 11267 <h2 id="sync">Sync</h2> 11268 <p>Flags just used for <code>rclone sync</code>.</p> 11269 <pre><code> --backup-dir string Make backups into hierarchy based in DIR 11270 --delete-after When synchronizing, delete files on destination after transferring (default) 11271 --delete-before When synchronizing, delete files on destination before transferring 11272 --delete-during When synchronizing, delete files during transfer 11273 --fix-case Force rename of case insensitive dest to match source 11274 --ignore-errors Delete even if there are I/O errors 11275 --max-delete int When synchronizing, limit the number of deletes (default -1) 11276 --max-delete-size SizeSuffix When synchronizing, limit the total size of deletes (default off) 11277 --suffix string Suffix to add to changed files 11278 --suffix-keep-extension Preserve the extension when using --suffix 11279 --track-renames When synchronizing, track file renames and do a server-side move if possible 11280 --track-renames-strategy string Strategies to use when synchronizing using track-renames hash|modtime|leaf (default "hash")</code></pre> 11281 <h2 id="important">Important</h2> 11282 <p>Important flags useful for most commands.</p> 11283 <pre><code> -n, --dry-run Do a trial run with no permanent changes 11284 -i, --interactive Enable interactive mode 11285 -v, --verbose count Print lots more stuff (repeat for more)</code></pre> 11286 <h2 id="check">Check</h2> 11287 <p>Flags used for <code>rclone check</code>.</p> 11288 <pre><code> --max-backlog int Maximum number of objects in sync or check backlog (default 10000)</code></pre> 11289 <h2 id="networking">Networking</h2> 11290 <p>General networking and HTTP stuff.</p> 11291 <pre><code> --bind string Local address to bind to for outgoing connections, IPv4, IPv6 or name 11292 --bwlimit BwTimetable Bandwidth limit in KiB/s, or use suffix B|K|M|G|T|P or a full timetable 11293 --bwlimit-file BwTimetable Bandwidth limit per file in KiB/s, or use suffix B|K|M|G|T|P or a full timetable 11294 --ca-cert stringArray CA certificate used to verify servers 11295 --client-cert string Client SSL certificate (PEM) for mutual TLS auth 11296 --client-key string Client SSL private key (PEM) for mutual TLS auth 11297 --contimeout Duration Connect timeout (default 1m0s) 11298 --disable-http-keep-alives Disable HTTP keep-alives and use each connection once. 11299 --disable-http2 Disable HTTP/2 in the global transport 11300 --dscp string Set DSCP value to connections, value or name, e.g. CS1, LE, DF, AF21 11301 --expect-continue-timeout Duration Timeout when using expect / 100-continue in HTTP (default 1s) 11302 --header stringArray Set HTTP header for all transactions 11303 --header-download stringArray Set HTTP header for download transactions 11304 --header-upload stringArray Set HTTP header for upload transactions 11305 --no-check-certificate Do not verify the server SSL certificate (insecure) 11306 --no-gzip-encoding Don't set Accept-Encoding: gzip 11307 --timeout Duration IO idle timeout (default 5m0s) 11308 --tpslimit float Limit HTTP transactions per second to this 11309 --tpslimit-burst int Max burst of transactions for --tpslimit (default 1) 11310 --use-cookies Enable session cookiejar 11311 --user-agent string Set the user-agent to a specified string (default "rclone/v1.66.0")</code></pre> 11312 <h2 id="performance">Performance</h2> 11313 <p>Flags helpful for increasing performance.</p> 11314 <pre><code> --buffer-size SizeSuffix In memory buffer size when reading files for each --transfer (default 16Mi) 11315 --checkers int Number of checkers to run in parallel (default 8) 11316 --transfers int Number of file transfers to run in parallel (default 4)</code></pre> 11317 <h2 id="config">Config</h2> 11318 <p>General configuration of rclone.</p> 11319 <pre><code> --ask-password Allow prompt for password for encrypted configuration (default true) 11320 --auto-confirm If enabled, do not request console confirmation 11321 --cache-dir string Directory rclone will use for caching (default "$HOME/.cache/rclone") 11322 --color AUTO|NEVER|ALWAYS When to show colors (and other ANSI codes) AUTO|NEVER|ALWAYS (default AUTO) 11323 --config string Config file (default "$HOME/.config/rclone/rclone.conf") 11324 --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) 11325 --disable string Disable a comma separated list of features (use --disable help to see a list) 11326 -n, --dry-run Do a trial run with no permanent changes 11327 --error-on-no-transfer Sets exit code 9 if no files are transferred, useful in scripts 11328 --fs-cache-expire-duration Duration Cache remotes for this long (0 to disable caching) (default 5m0s) 11329 --fs-cache-expire-interval Duration Interval to check for expired remotes (default 1m0s) 11330 --human-readable Print numbers in a human-readable format, sizes with suffix Ki|Mi|Gi|Ti|Pi 11331 -i, --interactive Enable interactive mode 11332 --kv-lock-time Duration Maximum time to keep key-value database locked by process (default 1s) 11333 --low-level-retries int Number of low level retries to do (default 10) 11334 --no-console Hide console window (supported on Windows only) 11335 --no-unicode-normalization Don't normalize unicode characters in filenames 11336 --password-command SpaceSepList Command for supplying password for encrypted configuration 11337 --retries int Retry operations this many times if they fail (default 3) 11338 --retries-sleep Duration Interval between retrying operations if they fail, e.g. 500ms, 60s, 5m (0 to disable) (default 0s) 11339 --temp-dir string Directory rclone will use for temporary files (default "/tmp") 11340 --use-mmap Use mmap allocator (see docs) 11341 --use-server-modtime Use server modified time instead of object metadata</code></pre> 11342 <h2 id="debugging">Debugging</h2> 11343 <p>Flags for developers.</p> 11344 <pre><code> --cpuprofile string Write cpu profile to file 11345 --dump DumpFlags List of items to dump from: headers, bodies, requests, responses, auth, filters, goroutines, openfiles, mapper 11346 --dump-bodies Dump HTTP headers and bodies - may contain sensitive info 11347 --dump-headers Dump HTTP headers - may contain sensitive info 11348 --memprofile string Write memory profile to file</code></pre> 11349 <h2 id="filter">Filter</h2> 11350 <p>Flags for filtering directory listings.</p> 11351 <pre><code> --delete-excluded Delete files on dest excluded from sync 11352 --exclude stringArray Exclude files matching pattern 11353 --exclude-from stringArray Read file exclude patterns from file (use - to read from stdin) 11354 --exclude-if-present stringArray Exclude directories if filename is present 11355 --files-from stringArray Read list of source-file names from file (use - to read from stdin) 11356 --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) 11357 -f, --filter stringArray Add a file filtering rule 11358 --filter-from stringArray Read file filtering patterns from a file (use - to read from stdin) 11359 --ignore-case Ignore case in filters (case insensitive) 11360 --include stringArray Include files matching pattern 11361 --include-from stringArray Read file include patterns from file (use - to read from stdin) 11362 --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) 11363 --max-depth int If set limits the recursion depth to this (default -1) 11364 --max-size SizeSuffix Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off) 11365 --metadata-exclude stringArray Exclude metadatas matching pattern 11366 --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) 11367 --metadata-filter stringArray Add a metadata filtering rule 11368 --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) 11369 --metadata-include stringArray Include metadatas matching pattern 11370 --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) 11371 --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) 11372 --min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre> 11373 <h2 id="listing">Listing</h2> 11374 <p>Flags for listing directories.</p> 11375 <pre><code> --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z) 11376 --fast-list Use recursive list if available; uses more memory but fewer transactions</code></pre> 11377 <h2 id="logging-1">Logging</h2> 11378 <p>Logging and statistics.</p> 11379 <pre><code> --log-file string Log everything to this file 11380 --log-format string Comma separated list of log format options (default "date,time") 11381 --log-level LogLevel Log level DEBUG|INFO|NOTICE|ERROR (default NOTICE) 11382 --log-systemd Activate systemd integration for the logger 11383 --max-stats-groups int Maximum number of stats groups to keep in memory, on max oldest is discarded (default 1000) 11384 -P, --progress Show progress during transfer 11385 --progress-terminal-title Show progress on the terminal title (requires -P/--progress) 11386 -q, --quiet Print as little stuff as possible 11387 --stats Duration Interval between printing stats, e.g. 500ms, 60s, 5m (0 to disable) (default 1m0s) 11388 --stats-file-name-length int Max file name length in stats (0 for no limit) (default 45) 11389 --stats-log-level LogLevel Log level to show --stats output DEBUG|INFO|NOTICE|ERROR (default INFO) 11390 --stats-one-line Make the stats fit on one line 11391 --stats-one-line-date Enable --stats-one-line and add current date/time prefix 11392 --stats-one-line-date-format string Enable --stats-one-line-date and use custom formatted date: Enclose date string in double quotes ("), see https://golang.org/pkg/time/#Time.Format 11393 --stats-unit string Show data rate in stats as either 'bits' or 'bytes' per second (default "bytes") 11394 --syslog Use Syslog for logging 11395 --syslog-facility string Facility for syslog, e.g. KERN,USER,... (default "DAEMON") 11396 --use-json-log Use json log format 11397 -v, --verbose count Print lots more stuff (repeat for more)</code></pre> 11398 <h2 id="metadata-2">Metadata</h2> 11399 <p>Flags to control metadata.</p> 11400 <pre><code> -M, --metadata If set, preserve metadata when copying objects 11401 --metadata-exclude stringArray Exclude metadatas matching pattern 11402 --metadata-exclude-from stringArray Read metadata exclude patterns from file (use - to read from stdin) 11403 --metadata-filter stringArray Add a metadata filtering rule 11404 --metadata-filter-from stringArray Read metadata filtering patterns from a file (use - to read from stdin) 11405 --metadata-include stringArray Include metadatas matching pattern 11406 --metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin) 11407 --metadata-mapper SpaceSepList Program to run to transforming metadata before upload 11408 --metadata-set stringArray Add metadata key=value when uploading</code></pre> 11409 <h2 id="rc-1">RC</h2> 11410 <p>Flags to control the Remote Control API.</p> 11411 <pre><code> --rc Enable the remote control server 11412 --rc-addr stringArray IPaddress:Port or :Port to bind server to (default [localhost:5572]) 11413 --rc-allow-origin string Origin which cross-domain request (CORS) can be executed from 11414 --rc-baseurl string Prefix for URLs - leave blank for root 11415 --rc-cert string TLS PEM key (concatenation of certificate and CA certificate) 11416 --rc-client-ca string Client certificate authority to verify clients with 11417 --rc-enable-metrics Enable prometheus metrics on /metrics 11418 --rc-files string Path to local files to serve on the HTTP server 11419 --rc-htpasswd string A htpasswd file - if not provided no authentication is done 11420 --rc-job-expire-duration Duration Expire finished async jobs older than this value (default 1m0s) 11421 --rc-job-expire-interval Duration Interval to check for expired async jobs (default 10s) 11422 --rc-key string TLS PEM Private key 11423 --rc-max-header-bytes int Maximum size of request header (default 4096) 11424 --rc-min-tls-version string Minimum TLS version that is acceptable (default "tls1.0") 11425 --rc-no-auth Don't require auth for certain methods 11426 --rc-pass string Password for authentication 11427 --rc-realm string Realm for authentication 11428 --rc-salt string Password hashing salt (default "dlPL2MqE") 11429 --rc-serve Enable the serving of remote objects 11430 --rc-server-read-timeout Duration Timeout for server reading data (default 1h0m0s) 11431 --rc-server-write-timeout Duration Timeout for server writing data (default 1h0m0s) 11432 --rc-template string User-specified template 11433 --rc-user string User name for authentication 11434 --rc-web-fetch-url string URL to fetch the releases for webgui (default "https://api.github.com/repos/rclone/rclone-webui-react/releases/latest") 11435 --rc-web-gui Launch WebGUI on localhost 11436 --rc-web-gui-force-update Force update to latest version of web gui 11437 --rc-web-gui-no-open-browser Don't open the browser automatically 11438 --rc-web-gui-update Check and update to latest version of web gui</code></pre> 11439 <h2 id="backend">Backend</h2> 11440 <p>Backend only flags. These can be set in the config file also.</p> 11441 <pre><code> --alias-description string Description of the remote 11442 --alias-remote string Remote or path to alias 11443 --azureblob-access-tier string Access tier of blob: hot, cool, cold or archive 11444 --azureblob-account string Azure Storage Account Name 11445 --azureblob-archive-tier-delete Delete archive tier blobs before overwriting 11446 --azureblob-chunk-size SizeSuffix Upload chunk size (default 4Mi) 11447 --azureblob-client-certificate-password string Password for the certificate file (optional) (obscured) 11448 --azureblob-client-certificate-path string Path to a PEM or PKCS12 certificate file including the private key 11449 --azureblob-client-id string The ID of the client in use 11450 --azureblob-client-secret string One of the service principal's client secrets 11451 --azureblob-client-send-certificate-chain Send the certificate chain when using certificate auth 11452 --azureblob-delete-snapshots string Set to specify how to deal with snapshots on blob deletion 11453 --azureblob-description string Description of the remote 11454 --azureblob-directory-markers Upload an empty object with a trailing slash when a new directory is created 11455 --azureblob-disable-checksum Don't store MD5 checksum with object metadata 11456 --azureblob-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8) 11457 --azureblob-endpoint string Endpoint for the service 11458 --azureblob-env-auth Read credentials from runtime (environment variables, CLI or MSI) 11459 --azureblob-key string Storage Account Shared Key 11460 --azureblob-list-chunk int Size of blob list (default 5000) 11461 --azureblob-msi-client-id string Object ID of the user-assigned MSI to use, if any 11462 --azureblob-msi-mi-res-id string Azure resource ID of the user-assigned MSI to use, if any 11463 --azureblob-msi-object-id string Object ID of the user-assigned MSI to use, if any 11464 --azureblob-no-check-container If set, don't attempt to check the container exists or create it 11465 --azureblob-no-head-object If set, do not do HEAD before GET when getting objects 11466 --azureblob-password string The user's password (obscured) 11467 --azureblob-public-access string Public access level of a container: blob or container 11468 --azureblob-sas-url string SAS URL for container level access only 11469 --azureblob-service-principal-file string Path to file containing credentials for use with a service principal 11470 --azureblob-tenant string ID of the service principal's tenant. Also called its directory ID 11471 --azureblob-upload-concurrency int Concurrency for multipart uploads (default 16) 11472 --azureblob-upload-cutoff string Cutoff for switching to chunked upload (<= 256 MiB) (deprecated) 11473 --azureblob-use-emulator Uses local storage emulator if provided as 'true' 11474 --azureblob-use-msi Use a managed service identity to authenticate (only works in Azure) 11475 --azureblob-username string User name (usually an email address) 11476 --azurefiles-account string Azure Storage Account Name 11477 --azurefiles-chunk-size SizeSuffix Upload chunk size (default 4Mi) 11478 --azurefiles-client-certificate-password string Password for the certificate file (optional) (obscured) 11479 --azurefiles-client-certificate-path string Path to a PEM or PKCS12 certificate file including the private key 11480 --azurefiles-client-id string The ID of the client in use 11481 --azurefiles-client-secret string One of the service principal's client secrets 11482 --azurefiles-client-send-certificate-chain Send the certificate chain when using certificate auth 11483 --azurefiles-connection-string string Azure Files Connection String 11484 --azurefiles-description string Description of the remote 11485 --azurefiles-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8,Dot) 11486 --azurefiles-endpoint string Endpoint for the service 11487 --azurefiles-env-auth Read credentials from runtime (environment variables, CLI or MSI) 11488 --azurefiles-key string Storage Account Shared Key 11489 --azurefiles-max-stream-size SizeSuffix Max size for streamed files (default 10Gi) 11490 --azurefiles-msi-client-id string Object ID of the user-assigned MSI to use, if any 11491 --azurefiles-msi-mi-res-id string Azure resource ID of the user-assigned MSI to use, if any 11492 --azurefiles-msi-object-id string Object ID of the user-assigned MSI to use, if any 11493 --azurefiles-password string The user's password (obscured) 11494 --azurefiles-sas-url string SAS URL 11495 --azurefiles-service-principal-file string Path to file containing credentials for use with a service principal 11496 --azurefiles-share-name string Azure Files Share Name 11497 --azurefiles-tenant string ID of the service principal's tenant. Also called its directory ID 11498 --azurefiles-upload-concurrency int Concurrency for multipart uploads (default 16) 11499 --azurefiles-use-msi Use a managed service identity to authenticate (only works in Azure) 11500 --azurefiles-username string User name (usually an email address) 11501 --b2-account string Account ID or Application Key ID 11502 --b2-chunk-size SizeSuffix Upload chunk size (default 96Mi) 11503 --b2-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4Gi) 11504 --b2-description string Description of the remote 11505 --b2-disable-checksum Disable checksums for large (> upload cutoff) files 11506 --b2-download-auth-duration Duration Time before the public link authorization token will expire in s or suffix ms|s|m|h|d (default 1w) 11507 --b2-download-url string Custom endpoint for downloads 11508 --b2-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) 11509 --b2-endpoint string Endpoint for the service 11510 --b2-hard-delete Permanently delete files on remote removal, otherwise hide files 11511 --b2-key string Application Key 11512 --b2-lifecycle int Set the number of days deleted files should be kept when creating a bucket 11513 --b2-test-mode string A flag string for X-Bz-Test-Mode header for debugging 11514 --b2-upload-concurrency int Concurrency for multipart uploads (default 4) 11515 --b2-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200Mi) 11516 --b2-version-at Time Show file versions as they were at the specified time (default off) 11517 --b2-versions Include old versions in directory listings 11518 --box-access-token string Box App Primary Access Token 11519 --box-auth-url string Auth server URL 11520 --box-box-config-file string Box App config.json location 11521 --box-box-sub-type string (default "user") 11522 --box-client-id string OAuth Client Id 11523 --box-client-secret string OAuth Client Secret 11524 --box-commit-retries int Max number of times to try committing a multipart file (default 100) 11525 --box-description string Description of the remote 11526 --box-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot) 11527 --box-impersonate string Impersonate this user ID when using a service account 11528 --box-list-chunk int Size of listing chunk 1-1000 (default 1000) 11529 --box-owned-by string Only show items owned by the login (email address) passed in 11530 --box-root-folder-id string Fill in for rclone to use a non root folder as its starting point 11531 --box-token string OAuth Access Token as a JSON blob 11532 --box-token-url string Token server url 11533 --box-upload-cutoff SizeSuffix Cutoff for switching to multipart upload (>= 50 MiB) (default 50Mi) 11534 --cache-chunk-clean-interval Duration How often should the cache perform cleanups of the chunk storage (default 1m0s) 11535 --cache-chunk-no-memory Disable the in-memory cache for storing chunks during streaming 11536 --cache-chunk-path string Directory to cache chunk files (default "$HOME/.cache/rclone/cache-backend") 11537 --cache-chunk-size SizeSuffix The size of a chunk (partial file data) (default 5Mi) 11538 --cache-chunk-total-size SizeSuffix The total size that the chunks can take up on the local disk (default 10Gi) 11539 --cache-db-path string Directory to store file structure metadata DB (default "$HOME/.cache/rclone/cache-backend") 11540 --cache-db-purge Clear all the cached data for this remote on start 11541 --cache-db-wait-time Duration How long to wait for the DB to be available - 0 is unlimited (default 1s) 11542 --cache-description string Description of the remote 11543 --cache-info-age Duration How long to cache file structure information (directory listings, file size, times, etc.) (default 6h0m0s) 11544 --cache-plex-insecure string Skip all certificate verification when connecting to the Plex server 11545 --cache-plex-password string The password of the Plex user (obscured) 11546 --cache-plex-url string The URL of the Plex server 11547 --cache-plex-username string The username of the Plex user 11548 --cache-read-retries int How many times to retry a read from a cache storage (default 10) 11549 --cache-remote string Remote to cache 11550 --cache-rps int Limits the number of requests per second to the source FS (-1 to disable) (default -1) 11551 --cache-tmp-upload-path string Directory to keep temporary files until they are uploaded 11552 --cache-tmp-wait-time Duration How long should files be stored in local cache before being uploaded (default 15s) 11553 --cache-workers int How many workers should run in parallel to download chunks (default 4) 11554 --cache-writes Cache file data on writes through the FS 11555 --chunker-chunk-size SizeSuffix Files larger than chunk size will be split in chunks (default 2Gi) 11556 --chunker-description string Description of the remote 11557 --chunker-fail-hard Choose how chunker should handle files with missing or invalid chunks 11558 --chunker-hash-type string Choose how chunker handles hash sums (default "md5") 11559 --chunker-remote string Remote to chunk/unchunk 11560 --combine-description string Description of the remote 11561 --combine-upstreams SpaceSepList Upstreams for combining 11562 --compress-description string Description of the remote 11563 --compress-level int GZIP compression level (-2 to 9) (default -1) 11564 --compress-mode string Compression mode (default "gzip") 11565 --compress-ram-cache-limit SizeSuffix Some remotes don't allow the upload of files with unknown size (default 20Mi) 11566 --compress-remote string Remote to compress 11567 -L, --copy-links Follow symlinks and copy the pointed to item 11568 --crypt-description string Description of the remote 11569 --crypt-directory-name-encryption Option to either encrypt directory names or leave them intact (default true) 11570 --crypt-filename-encoding string How to encode the encrypted filename to text string (default "base32") 11571 --crypt-filename-encryption string How to encrypt the filenames (default "standard") 11572 --crypt-no-data-encryption Option to either encrypt file data or leave it unencrypted 11573 --crypt-pass-bad-blocks If set this will pass bad blocks through as all 0 11574 --crypt-password string Password or pass phrase for encryption (obscured) 11575 --crypt-password2 string Password or pass phrase for salt (obscured) 11576 --crypt-remote string Remote to encrypt/decrypt 11577 --crypt-server-side-across-configs Deprecated: use --server-side-across-configs instead 11578 --crypt-show-mapping For all files listed show how the names encrypt 11579 --crypt-strict-names If set, this will raise an error when crypt comes across a filename that can't be decrypted 11580 --crypt-suffix string If this is set it will override the default suffix of ".bin" (default ".bin") 11581 --drive-acknowledge-abuse Set to allow files which return cannotDownloadAbusiveFile to be downloaded 11582 --drive-allow-import-name-change Allow the filetype to change when uploading Google docs 11583 --drive-auth-owner-only Only consider files owned by the authenticated user 11584 --drive-auth-url string Auth server URL 11585 --drive-chunk-size SizeSuffix Upload chunk size (default 8Mi) 11586 --drive-client-id string Google Application Client Id 11587 --drive-client-secret string OAuth Client Secret 11588 --drive-copy-shortcut-content Server side copy contents of shortcuts instead of the shortcut 11589 --drive-description string Description of the remote 11590 --drive-disable-http2 Disable drive using http2 (default true) 11591 --drive-encoding Encoding The encoding for the backend (default InvalidUtf8) 11592 --drive-env-auth Get IAM credentials from runtime (environment variables or instance meta data if no env vars) 11593 --drive-export-formats string Comma separated list of preferred formats for downloading Google docs (default "docx,xlsx,pptx,svg") 11594 --drive-fast-list-bug-fix Work around a bug in Google Drive listing (default true) 11595 --drive-formats string Deprecated: See export_formats 11596 --drive-impersonate string Impersonate this user when using a service account 11597 --drive-import-formats string Comma separated list of preferred formats for uploading Google docs 11598 --drive-keep-revision-forever Keep new head revision of each file forever 11599 --drive-list-chunk int Size of listing chunk 100-1000, 0 to disable (default 1000) 11600 --drive-metadata-labels Bits Control whether labels should be read or written in metadata (default off) 11601 --drive-metadata-owner Bits Control whether owner should be read or written in metadata (default read) 11602 --drive-metadata-permissions Bits Control whether permissions should be read or written in metadata (default off) 11603 --drive-pacer-burst int Number of API calls to allow without sleeping (default 100) 11604 --drive-pacer-min-sleep Duration Minimum time to sleep between API calls (default 100ms) 11605 --drive-resource-key string Resource key for accessing a link-shared file 11606 --drive-root-folder-id string ID of the root folder 11607 --drive-scope string Comma separated list of scopes that rclone should use when requesting access from drive 11608 --drive-server-side-across-configs Deprecated: use --server-side-across-configs instead 11609 --drive-service-account-credentials string Service Account Credentials JSON blob 11610 --drive-service-account-file string Service Account Credentials JSON file path 11611 --drive-shared-with-me Only show files that are shared with me 11612 --drive-show-all-gdocs Show all Google Docs including non-exportable ones in listings 11613 --drive-size-as-quota Show sizes as storage quota usage, not actual size 11614 --drive-skip-checksum-gphotos Skip checksums on Google photos and videos only 11615 --drive-skip-dangling-shortcuts If set skip dangling shortcut files 11616 --drive-skip-gdocs Skip google documents in all listings 11617 --drive-skip-shortcuts If set skip shortcut files 11618 --drive-starred-only Only show files that are starred 11619 --drive-stop-on-download-limit Make download limit errors be fatal 11620 --drive-stop-on-upload-limit Make upload limit errors be fatal 11621 --drive-team-drive string ID of the Shared Drive (Team Drive) 11622 --drive-token string OAuth Access Token as a JSON blob 11623 --drive-token-url string Token server url 11624 --drive-trashed-only Only show files that are in the trash 11625 --drive-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 8Mi) 11626 --drive-use-created-date Use file created date instead of modified date 11627 --drive-use-shared-date Use date file was shared instead of modified date 11628 --drive-use-trash Send files to the trash instead of deleting permanently (default true) 11629 --drive-v2-download-min-size SizeSuffix If Object's are greater, use drive v2 API to download (default off) 11630 --dropbox-auth-url string Auth server URL 11631 --dropbox-batch-commit-timeout Duration Max time to wait for a batch to finish committing (default 10m0s) 11632 --dropbox-batch-mode string Upload file batching sync|async|off (default "sync") 11633 --dropbox-batch-size int Max number of files in upload batch 11634 --dropbox-batch-timeout Duration Max time to allow an idle upload batch before uploading (default 0s) 11635 --dropbox-chunk-size SizeSuffix Upload chunk size (< 150Mi) (default 48Mi) 11636 --dropbox-client-id string OAuth Client Id 11637 --dropbox-client-secret string OAuth Client Secret 11638 --dropbox-description string Description of the remote 11639 --dropbox-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot) 11640 --dropbox-impersonate string Impersonate this user when using a business account 11641 --dropbox-pacer-min-sleep Duration Minimum time to sleep between API calls (default 10ms) 11642 --dropbox-shared-files Instructs rclone to work on individual shared files 11643 --dropbox-shared-folders Instructs rclone to work on shared folders 11644 --dropbox-token string OAuth Access Token as a JSON blob 11645 --dropbox-token-url string Token server url 11646 --fichier-api-key string Your API Key, get it from https://1fichier.com/console/params.pl 11647 --fichier-cdn Set if you wish to use CDN download links 11648 --fichier-description string Description of the remote 11649 --fichier-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot) 11650 --fichier-file-password string If you want to download a shared file that is password protected, add this parameter (obscured) 11651 --fichier-folder-password string If you want to list the files in a shared folder that is password protected, add this parameter (obscured) 11652 --fichier-shared-folder string If you want to download a shared folder, add this parameter 11653 --filefabric-description string Description of the remote 11654 --filefabric-encoding Encoding The encoding for the backend (default Slash,Del,Ctl,InvalidUtf8,Dot) 11655 --filefabric-permanent-token string Permanent Authentication Token 11656 --filefabric-root-folder-id string ID of the root folder 11657 --filefabric-token string Session Token 11658 --filefabric-token-expiry string Token expiry time 11659 --filefabric-url string URL of the Enterprise File Fabric to connect to 11660 --filefabric-version string Version read from the file fabric 11661 --ftp-ask-password Allow asking for FTP password when needed 11662 --ftp-close-timeout Duration Maximum time to wait for a response to close (default 1m0s) 11663 --ftp-concurrency int Maximum number of FTP simultaneous connections, 0 for unlimited 11664 --ftp-description string Description of the remote 11665 --ftp-disable-epsv Disable using EPSV even if server advertises support 11666 --ftp-disable-mlsd Disable using MLSD even if server advertises support 11667 --ftp-disable-tls13 Disable TLS 1.3 (workaround for FTP servers with buggy TLS) 11668 --ftp-disable-utf8 Disable using UTF-8 even if server advertises support 11669 --ftp-encoding Encoding The encoding for the backend (default Slash,Del,Ctl,RightSpace,Dot) 11670 --ftp-explicit-tls Use Explicit FTPS (FTP over TLS) 11671 --ftp-force-list-hidden Use LIST -a to force listing of hidden files and folders. This will disable the use of MLSD 11672 --ftp-host string FTP host to connect to 11673 --ftp-idle-timeout Duration Max time before closing idle connections (default 1m0s) 11674 --ftp-no-check-certificate Do not verify the TLS certificate of the server 11675 --ftp-pass string FTP password (obscured) 11676 --ftp-port int FTP port number (default 21) 11677 --ftp-shut-timeout Duration Maximum time to wait for data connection closing status (default 1m0s) 11678 --ftp-socks-proxy string Socks 5 proxy host 11679 --ftp-tls Use Implicit FTPS (FTP over TLS) 11680 --ftp-tls-cache-size int Size of TLS session cache for all control and data connections (default 32) 11681 --ftp-user string FTP username (default "$USER") 11682 --ftp-writing-mdtm Use MDTM to set modification time (VsFtpd quirk) 11683 --gcs-anonymous Access public buckets and objects without credentials 11684 --gcs-auth-url string Auth server URL 11685 --gcs-bucket-acl string Access Control List for new buckets 11686 --gcs-bucket-policy-only Access checks should use bucket-level IAM policies 11687 --gcs-client-id string OAuth Client Id 11688 --gcs-client-secret string OAuth Client Secret 11689 --gcs-decompress If set this will decompress gzip encoded objects 11690 --gcs-description string Description of the remote 11691 --gcs-directory-markers Upload an empty object with a trailing slash when a new directory is created 11692 --gcs-encoding Encoding The encoding for the backend (default Slash,CrLf,InvalidUtf8,Dot) 11693 --gcs-endpoint string Endpoint for the service 11694 --gcs-env-auth Get GCP IAM credentials from runtime (environment variables or instance meta data if no env vars) 11695 --gcs-location string Location for the newly created buckets 11696 --gcs-no-check-bucket If set, don't attempt to check the bucket exists or create it 11697 --gcs-object-acl string Access Control List for new objects 11698 --gcs-project-number string Project number 11699 --gcs-service-account-file string Service Account Credentials JSON file path 11700 --gcs-storage-class string The storage class to use when storing objects in Google Cloud Storage 11701 --gcs-token string OAuth Access Token as a JSON blob 11702 --gcs-token-url string Token server url 11703 --gcs-user-project string User project 11704 --gphotos-auth-url string Auth server URL 11705 --gphotos-batch-commit-timeout Duration Max time to wait for a batch to finish committing (default 10m0s) 11706 --gphotos-batch-mode string Upload file batching sync|async|off (default "sync") 11707 --gphotos-batch-size int Max number of files in upload batch 11708 --gphotos-batch-timeout Duration Max time to allow an idle upload batch before uploading (default 0s) 11709 --gphotos-client-id string OAuth Client Id 11710 --gphotos-client-secret string OAuth Client Secret 11711 --gphotos-description string Description of the remote 11712 --gphotos-encoding Encoding The encoding for the backend (default Slash,CrLf,InvalidUtf8,Dot) 11713 --gphotos-include-archived Also view and download archived media 11714 --gphotos-read-only Set to make the Google Photos backend read only 11715 --gphotos-read-size Set to read the size of media items 11716 --gphotos-start-year int Year limits the photos to be downloaded to those which are uploaded after the given year (default 2000) 11717 --gphotos-token string OAuth Access Token as a JSON blob 11718 --gphotos-token-url string Token server url 11719 --hasher-auto-size SizeSuffix Auto-update checksum for files smaller than this size (disabled by default) 11720 --hasher-description string Description of the remote 11721 --hasher-hashes CommaSepList Comma separated list of supported checksum types (default md5,sha1) 11722 --hasher-max-age Duration Maximum time to keep checksums in cache (0 = no cache, off = cache forever) (default off) 11723 --hasher-remote string Remote to cache checksums for (e.g. myRemote:path) 11724 --hdfs-data-transfer-protection string Kerberos data transfer protection: authentication|integrity|privacy 11725 --hdfs-description string Description of the remote 11726 --hdfs-encoding Encoding The encoding for the backend (default Slash,Colon,Del,Ctl,InvalidUtf8,Dot) 11727 --hdfs-namenode CommaSepList Hadoop name nodes and ports 11728 --hdfs-service-principal-name string Kerberos service principal name for the namenode 11729 --hdfs-username string Hadoop user name 11730 --hidrive-auth-url string Auth server URL 11731 --hidrive-chunk-size SizeSuffix Chunksize for chunked uploads (default 48Mi) 11732 --hidrive-client-id string OAuth Client Id 11733 --hidrive-client-secret string OAuth Client Secret 11734 --hidrive-description string Description of the remote 11735 --hidrive-disable-fetching-member-count Do not fetch number of objects in directories unless it is absolutely necessary 11736 --hidrive-encoding Encoding The encoding for the backend (default Slash,Dot) 11737 --hidrive-endpoint string Endpoint for the service (default "https://api.hidrive.strato.com/2.1") 11738 --hidrive-root-prefix string The root/parent folder for all paths (default "/") 11739 --hidrive-scope-access string Access permissions that rclone should use when requesting access from HiDrive (default "rw") 11740 --hidrive-scope-role string User-level that rclone should use when requesting access from HiDrive (default "user") 11741 --hidrive-token string OAuth Access Token as a JSON blob 11742 --hidrive-token-url string Token server url 11743 --hidrive-upload-concurrency int Concurrency for chunked uploads (default 4) 11744 --hidrive-upload-cutoff SizeSuffix Cutoff/Threshold for chunked uploads (default 96Mi) 11745 --http-description string Description of the remote 11746 --http-headers CommaSepList Set HTTP headers for all transactions 11747 --http-no-head Don't use HEAD requests 11748 --http-no-slash Set this if the site doesn't end directories with / 11749 --http-url string URL of HTTP host to connect to 11750 --imagekit-description string Description of the remote 11751 --imagekit-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Dollar,Question,Hash,Percent,BackSlash,Del,Ctl,InvalidUtf8,Dot,SquareBracket) 11752 --imagekit-endpoint string You can find your ImageKit.io URL endpoint in your [dashboard](https://imagekit.io/dashboard/developer/api-keys) 11753 --imagekit-only-signed Restrict unsigned image URLs If you have configured Restrict unsigned image URLs in your dashboard settings, set this to true 11754 --imagekit-private-key string You can find your ImageKit.io private key in your [dashboard](https://imagekit.io/dashboard/developer/api-keys) 11755 --imagekit-public-key string You can find your ImageKit.io public key in your [dashboard](https://imagekit.io/dashboard/developer/api-keys) 11756 --imagekit-upload-tags string Tags to add to the uploaded files, e.g. "tag1,tag2" 11757 --imagekit-versions Include old versions in directory listings 11758 --internetarchive-access-key-id string IAS3 Access Key 11759 --internetarchive-description string Description of the remote 11760 --internetarchive-disable-checksum Don't ask the server to test against MD5 checksum calculated by rclone (default true) 11761 --internetarchive-encoding Encoding The encoding for the backend (default Slash,LtGt,CrLf,Del,Ctl,InvalidUtf8,Dot) 11762 --internetarchive-endpoint string IAS3 Endpoint (default "https://s3.us.archive.org") 11763 --internetarchive-front-endpoint string Host of InternetArchive Frontend (default "https://archive.org") 11764 --internetarchive-secret-access-key string IAS3 Secret Key (password) 11765 --internetarchive-wait-archive Duration Timeout for waiting the server's processing tasks (specifically archive and book_op) to finish (default 0s) 11766 --jottacloud-auth-url string Auth server URL 11767 --jottacloud-client-id string OAuth Client Id 11768 --jottacloud-client-secret string OAuth Client Secret 11769 --jottacloud-description string Description of the remote 11770 --jottacloud-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot) 11771 --jottacloud-hard-delete Delete files permanently rather than putting them into the trash 11772 --jottacloud-md5-memory-limit SizeSuffix Files bigger than this will be cached on disk to calculate the MD5 if required (default 10Mi) 11773 --jottacloud-no-versions Avoid server side versioning by deleting files and recreating files instead of overwriting them 11774 --jottacloud-token string OAuth Access Token as a JSON blob 11775 --jottacloud-token-url string Token server url 11776 --jottacloud-trashed-only Only show files that are in the trash 11777 --jottacloud-upload-resume-limit SizeSuffix Files bigger than this can be resumed if the upload fail's (default 10Mi) 11778 --koofr-description string Description of the remote 11779 --koofr-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) 11780 --koofr-endpoint string The Koofr API endpoint to use 11781 --koofr-mountid string Mount ID of the mount to use 11782 --koofr-password string Your password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password) (obscured) 11783 --koofr-provider string Choose your storage provider 11784 --koofr-setmtime Does the backend support setting modification time (default true) 11785 --koofr-user string Your user name 11786 --linkbox-description string Description of the remote 11787 --linkbox-token string Token from https://www.linkbox.to/admin/account 11788 -l, --links Translate symlinks to/from regular files with a '.rclonelink' extension 11789 --local-case-insensitive Force the filesystem to report itself as case insensitive 11790 --local-case-sensitive Force the filesystem to report itself as case sensitive 11791 --local-description string Description of the remote 11792 --local-encoding Encoding The encoding for the backend (default Slash,Dot) 11793 --local-no-check-updated Don't check to see if the files change during upload 11794 --local-no-preallocate Disable preallocation of disk space for transferred files 11795 --local-no-set-modtime Disable setting modtime 11796 --local-no-sparse Disable sparse files for multi-thread downloads 11797 --local-nounc Disable UNC (long path names) conversion on Windows 11798 --local-unicode-normalization Apply unicode NFC normalization to paths and filenames 11799 --local-zero-size-links Assume the Stat size of links is zero (and read them instead) (deprecated) 11800 --mailru-auth-url string Auth server URL 11801 --mailru-check-hash What should copy do if file checksum is mismatched or invalid (default true) 11802 --mailru-client-id string OAuth Client Id 11803 --mailru-client-secret string OAuth Client Secret 11804 --mailru-description string Description of the remote 11805 --mailru-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot) 11806 --mailru-pass string Password (obscured) 11807 --mailru-speedup-enable Skip full upload if there is another file with same data hash (default true) 11808 --mailru-speedup-file-patterns string Comma separated list of file name patterns eligible for speedup (put by hash) (default "*.mkv,*.avi,*.mp4,*.mp3,*.zip,*.gz,*.rar,*.pdf") 11809 --mailru-speedup-max-disk SizeSuffix This option allows you to disable speedup (put by hash) for large files (default 3Gi) 11810 --mailru-speedup-max-memory SizeSuffix Files larger than the size given below will always be hashed on disk (default 32Mi) 11811 --mailru-token string OAuth Access Token as a JSON blob 11812 --mailru-token-url string Token server url 11813 --mailru-user string User name (usually email) 11814 --mega-debug Output more debug from Mega 11815 --mega-description string Description of the remote 11816 --mega-encoding Encoding The encoding for the backend (default Slash,InvalidUtf8,Dot) 11817 --mega-hard-delete Delete files permanently rather than putting them into the trash 11818 --mega-pass string Password (obscured) 11819 --mega-use-https Use HTTPS for transfers 11820 --mega-user string User name 11821 --memory-description string Description of the remote 11822 --netstorage-account string Set the NetStorage account name 11823 --netstorage-description string Description of the remote 11824 --netstorage-host string Domain+path of NetStorage host to connect to 11825 --netstorage-protocol string Select between HTTP or HTTPS protocol (default "https") 11826 --netstorage-secret string Set the NetStorage account secret/G2O key for authentication (obscured) 11827 -x, --one-file-system Don't cross filesystem boundaries (unix/macOS only) 11828 --onedrive-access-scopes SpaceSepList Set scopes to be requested by rclone (default Files.Read Files.ReadWrite Files.Read.All Files.ReadWrite.All Sites.Read.All offline_access) 11829 --onedrive-auth-url string Auth server URL 11830 --onedrive-av-override Allows download of files the server thinks has a virus 11831 --onedrive-chunk-size SizeSuffix Chunk size to upload files with - must be multiple of 320k (327,680 bytes) (default 10Mi) 11832 --onedrive-client-id string OAuth Client Id 11833 --onedrive-client-secret string OAuth Client Secret 11834 --onedrive-delta If set rclone will use delta listing to implement recursive listings 11835 --onedrive-description string Description of the remote 11836 --onedrive-drive-id string The ID of the drive to use 11837 --onedrive-drive-type string The type of the drive (personal | business | documentLibrary) 11838 --onedrive-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot) 11839 --onedrive-expose-onenote-files Set to make OneNote files show up in directory listings 11840 --onedrive-hash-type string Specify the hash in use for the backend (default "auto") 11841 --onedrive-link-password string Set the password for links created by the link command 11842 --onedrive-link-scope string Set the scope of the links created by the link command (default "anonymous") 11843 --onedrive-link-type string Set the type of the links created by the link command (default "view") 11844 --onedrive-list-chunk int Size of listing chunk (default 1000) 11845 --onedrive-metadata-permissions Bits Control whether permissions should be read or written in metadata (default off) 11846 --onedrive-no-versions Remove all versions on modifying operations 11847 --onedrive-region string Choose national cloud region for OneDrive (default "global") 11848 --onedrive-root-folder-id string ID of the root folder 11849 --onedrive-server-side-across-configs Deprecated: use --server-side-across-configs instead 11850 --onedrive-token string OAuth Access Token as a JSON blob 11851 --onedrive-token-url string Token server url 11852 --oos-attempt-resume-upload If true attempt to resume previously started multipart upload for the object 11853 --oos-chunk-size SizeSuffix Chunk size to use for uploading (default 5Mi) 11854 --oos-compartment string Object storage compartment OCID 11855 --oos-config-file string Path to OCI config file (default "~/.oci/config") 11856 --oos-config-profile string Profile name inside the oci config file (default "Default") 11857 --oos-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4.656Gi) 11858 --oos-copy-timeout Duration Timeout for copy (default 1m0s) 11859 --oos-description string Description of the remote 11860 --oos-disable-checksum Don't store MD5 checksum with object metadata 11861 --oos-encoding Encoding The encoding for the backend (default Slash,InvalidUtf8,Dot) 11862 --oos-endpoint string Endpoint for Object storage API 11863 --oos-leave-parts-on-error If true avoid calling abort upload on a failure, leaving all successfully uploaded parts for manual recovery 11864 --oos-max-upload-parts int Maximum number of parts in a multipart upload (default 10000) 11865 --oos-namespace string Object storage namespace 11866 --oos-no-check-bucket If set, don't attempt to check the bucket exists or create it 11867 --oos-provider string Choose your Auth Provider (default "env_auth") 11868 --oos-region string Object storage Region 11869 --oos-sse-customer-algorithm string If using SSE-C, the optional header that specifies "AES256" as the encryption algorithm 11870 --oos-sse-customer-key string To use SSE-C, the optional header that specifies the base64-encoded 256-bit encryption key to use to 11871 --oos-sse-customer-key-file string To use SSE-C, a file containing the base64-encoded string of the AES-256 encryption key associated 11872 --oos-sse-customer-key-sha256 string If using SSE-C, The optional header that specifies the base64-encoded SHA256 hash of the encryption 11873 --oos-sse-kms-key-id string if using your own master key in vault, this header specifies the 11874 --oos-storage-tier string The storage class to use when storing new objects in storage. https://docs.oracle.com/en-us/iaas/Content/Object/Concepts/understandingstoragetiers.htm (default "Standard") 11875 --oos-upload-concurrency int Concurrency for multipart uploads (default 10) 11876 --oos-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200Mi) 11877 --opendrive-chunk-size SizeSuffix Files will be uploaded in chunks this size (default 10Mi) 11878 --opendrive-description string Description of the remote 11879 --opendrive-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,LeftSpace,LeftCrLfHtVt,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot) 11880 --opendrive-password string Password (obscured) 11881 --opendrive-username string Username 11882 --pcloud-auth-url string Auth server URL 11883 --pcloud-client-id string OAuth Client Id 11884 --pcloud-client-secret string OAuth Client Secret 11885 --pcloud-description string Description of the remote 11886 --pcloud-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) 11887 --pcloud-hostname string Hostname to connect to (default "api.pcloud.com") 11888 --pcloud-password string Your pcloud password (obscured) 11889 --pcloud-root-folder-id string Fill in for rclone to use a non root folder as its starting point (default "d0") 11890 --pcloud-token string OAuth Access Token as a JSON blob 11891 --pcloud-token-url string Token server url 11892 --pcloud-username string Your pcloud username 11893 --pikpak-auth-url string Auth server URL 11894 --pikpak-client-id string OAuth Client Id 11895 --pikpak-client-secret string OAuth Client Secret 11896 --pikpak-description string Description of the remote 11897 --pikpak-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,RightSpace,RightPeriod,InvalidUtf8,Dot) 11898 --pikpak-hash-memory-limit SizeSuffix Files bigger than this will be cached on disk to calculate hash if required (default 10Mi) 11899 --pikpak-pass string Pikpak password (obscured) 11900 --pikpak-root-folder-id string ID of the root folder 11901 --pikpak-token string OAuth Access Token as a JSON blob 11902 --pikpak-token-url string Token server url 11903 --pikpak-trashed-only Only show files that are in the trash 11904 --pikpak-use-trash Send files to the trash instead of deleting permanently (default true) 11905 --pikpak-user string Pikpak username 11906 --premiumizeme-auth-url string Auth server URL 11907 --premiumizeme-client-id string OAuth Client Id 11908 --premiumizeme-client-secret string OAuth Client Secret 11909 --premiumizeme-description string Description of the remote 11910 --premiumizeme-encoding Encoding The encoding for the backend (default Slash,DoubleQuote,BackSlash,Del,Ctl,InvalidUtf8,Dot) 11911 --premiumizeme-token string OAuth Access Token as a JSON blob 11912 --premiumizeme-token-url string Token server url 11913 --protondrive-2fa string The 2FA code 11914 --protondrive-app-version string The app version string (default "macos-drive@1.0.0-alpha.1+rclone") 11915 --protondrive-description string Description of the remote 11916 --protondrive-enable-caching Caches the files and folders metadata to reduce API calls (default true) 11917 --protondrive-encoding Encoding The encoding for the backend (default Slash,LeftSpace,RightSpace,InvalidUtf8,Dot) 11918 --protondrive-mailbox-password string The mailbox password of your two-password proton account (obscured) 11919 --protondrive-original-file-size Return the file size before encryption (default true) 11920 --protondrive-password string The password of your proton account (obscured) 11921 --protondrive-replace-existing-draft Create a new revision when filename conflict is detected 11922 --protondrive-username string The username of your proton account 11923 --putio-auth-url string Auth server URL 11924 --putio-client-id string OAuth Client Id 11925 --putio-client-secret string OAuth Client Secret 11926 --putio-description string Description of the remote 11927 --putio-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) 11928 --putio-token string OAuth Access Token as a JSON blob 11929 --putio-token-url string Token server url 11930 --qingstor-access-key-id string QingStor Access Key ID 11931 --qingstor-chunk-size SizeSuffix Chunk size to use for uploading (default 4Mi) 11932 --qingstor-connection-retries int Number of connection retries (default 3) 11933 --qingstor-description string Description of the remote 11934 --qingstor-encoding Encoding The encoding for the backend (default Slash,Ctl,InvalidUtf8) 11935 --qingstor-endpoint string Enter an endpoint URL to connection QingStor API 11936 --qingstor-env-auth Get QingStor credentials from runtime 11937 --qingstor-secret-access-key string QingStor Secret Access Key (password) 11938 --qingstor-upload-concurrency int Concurrency for multipart uploads (default 1) 11939 --qingstor-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200Mi) 11940 --qingstor-zone string Zone to connect to 11941 --quatrix-api-key string API key for accessing Quatrix account 11942 --quatrix-description string Description of the remote 11943 --quatrix-effective-upload-time string Wanted upload time for one chunk (default "4s") 11944 --quatrix-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) 11945 --quatrix-hard-delete Delete files permanently rather than putting them into the trash 11946 --quatrix-host string Host name of Quatrix account 11947 --quatrix-maximal-summary-chunk-size SizeSuffix The maximal summary for all chunks. It should not be less than 'transfers'*'minimal_chunk_size' (default 95.367Mi) 11948 --quatrix-minimal-chunk-size SizeSuffix The minimal size for one chunk (default 9.537Mi) 11949 --quatrix-skip-project-folders Skip project folders in operations 11950 --s3-access-key-id string AWS Access Key ID 11951 --s3-acl string Canned ACL used when creating buckets and storing or copying objects 11952 --s3-bucket-acl string Canned ACL used when creating buckets 11953 --s3-chunk-size SizeSuffix Chunk size to use for uploading (default 5Mi) 11954 --s3-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4.656Gi) 11955 --s3-decompress If set this will decompress gzip encoded objects 11956 --s3-description string Description of the remote 11957 --s3-directory-markers Upload an empty object with a trailing slash when a new directory is created 11958 --s3-disable-checksum Don't store MD5 checksum with object metadata 11959 --s3-disable-http2 Disable usage of http2 for S3 backends 11960 --s3-download-url string Custom endpoint for downloads 11961 --s3-encoding Encoding The encoding for the backend (default Slash,InvalidUtf8,Dot) 11962 --s3-endpoint string Endpoint for S3 API 11963 --s3-env-auth Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars) 11964 --s3-force-path-style If true use path style access if false use virtual hosted style (default true) 11965 --s3-leave-parts-on-error If true avoid calling abort upload on a failure, leaving all successfully uploaded parts on S3 for manual recovery 11966 --s3-list-chunk int Size of listing chunk (response list for each ListObject S3 request) (default 1000) 11967 --s3-list-url-encode Tristate Whether to url encode listings: true/false/unset (default unset) 11968 --s3-list-version int Version of ListObjects to use: 1,2 or 0 for auto 11969 --s3-location-constraint string Location constraint - must be set to match the Region 11970 --s3-max-upload-parts int Maximum number of parts in a multipart upload (default 10000) 11971 --s3-might-gzip Tristate Set this if the backend might gzip objects (default unset) 11972 --s3-no-check-bucket If set, don't attempt to check the bucket exists or create it 11973 --s3-no-head If set, don't HEAD uploaded objects to check integrity 11974 --s3-no-head-object If set, do not do HEAD before GET when getting objects 11975 --s3-no-system-metadata Suppress setting and reading of system metadata 11976 --s3-profile string Profile to use in the shared credentials file 11977 --s3-provider string Choose your S3 provider 11978 --s3-region string Region to connect to 11979 --s3-requester-pays Enables requester pays option when interacting with S3 bucket 11980 --s3-secret-access-key string AWS Secret Access Key (password) 11981 --s3-server-side-encryption string The server-side encryption algorithm used when storing this object in S3 11982 --s3-session-token string An AWS session token 11983 --s3-shared-credentials-file string Path to the shared credentials file 11984 --s3-sse-customer-algorithm string If using SSE-C, the server-side encryption algorithm used when storing this object in S3 11985 --s3-sse-customer-key string To use SSE-C you may provide the secret encryption key used to encrypt/decrypt your data 11986 --s3-sse-customer-key-base64 string If using SSE-C you must provide the secret encryption key encoded in base64 format to encrypt/decrypt your data 11987 --s3-sse-customer-key-md5 string If using SSE-C you may provide the secret encryption key MD5 checksum (optional) 11988 --s3-sse-kms-key-id string If using KMS ID you must provide the ARN of Key 11989 --s3-storage-class string The storage class to use when storing new objects in S3 11990 --s3-sts-endpoint string Endpoint for STS 11991 --s3-upload-concurrency int Concurrency for multipart uploads and copies (default 4) 11992 --s3-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200Mi) 11993 --s3-use-accelerate-endpoint If true use the AWS S3 accelerated endpoint 11994 --s3-use-accept-encoding-gzip Accept-Encoding: gzip Whether to send Accept-Encoding: gzip header (default unset) 11995 --s3-use-already-exists Tristate Set if rclone should report BucketAlreadyExists errors on bucket creation (default unset) 11996 --s3-use-dual-stack If true use AWS S3 dual-stack endpoint (IPv6 support) 11997 --s3-use-multipart-etag Tristate Whether to use ETag in multipart uploads for verification (default unset) 11998 --s3-use-multipart-uploads Tristate Set if rclone should use multipart uploads (default unset) 11999 --s3-use-presigned-request Whether to use a presigned request or PutObject for single part uploads 12000 --s3-v2-auth If true use v2 authentication 12001 --s3-version-at Time Show file versions as they were at the specified time (default off) 12002 --s3-version-deleted Show deleted file markers when using versions 12003 --s3-versions Include old versions in directory listings 12004 --seafile-2fa Two-factor authentication ('true' if the account has 2FA enabled) 12005 --seafile-create-library Should rclone create a library if it doesn't exist 12006 --seafile-description string Description of the remote 12007 --seafile-encoding Encoding The encoding for the backend (default Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8) 12008 --seafile-library string Name of the library 12009 --seafile-library-key string Library password (for encrypted libraries only) (obscured) 12010 --seafile-pass string Password (obscured) 12011 --seafile-url string URL of seafile host to connect to 12012 --seafile-user string User name (usually email address) 12013 --sftp-ask-password Allow asking for SFTP password when needed 12014 --sftp-chunk-size SizeSuffix Upload and download chunk size (default 32Ki) 12015 --sftp-ciphers SpaceSepList Space separated list of ciphers to be used for session encryption, ordered by preference 12016 --sftp-concurrency int The maximum number of outstanding requests for one file (default 64) 12017 --sftp-copy-is-hardlink Set to enable server side copies using hardlinks 12018 --sftp-description string Description of the remote 12019 --sftp-disable-concurrent-reads If set don't use concurrent reads 12020 --sftp-disable-concurrent-writes If set don't use concurrent writes 12021 --sftp-disable-hashcheck Disable the execution of SSH commands to determine if remote file hashing is available 12022 --sftp-host string SSH host to connect to 12023 --sftp-host-key-algorithms SpaceSepList Space separated list of host key algorithms, ordered by preference 12024 --sftp-idle-timeout Duration Max time before closing idle connections (default 1m0s) 12025 --sftp-key-exchange SpaceSepList Space separated list of key exchange algorithms, ordered by preference 12026 --sftp-key-file string Path to PEM-encoded private key file 12027 --sftp-key-file-pass string The passphrase to decrypt the PEM-encoded private key file (obscured) 12028 --sftp-key-pem string Raw PEM-encoded private key 12029 --sftp-key-use-agent When set forces the usage of the ssh-agent 12030 --sftp-known-hosts-file string Optional path to known_hosts file 12031 --sftp-macs SpaceSepList Space separated list of MACs (message authentication code) algorithms, ordered by preference 12032 --sftp-md5sum-command string The command used to read md5 hashes 12033 --sftp-pass string SSH password, leave blank to use ssh-agent (obscured) 12034 --sftp-path-override string Override path used by SSH shell commands 12035 --sftp-port int SSH port number (default 22) 12036 --sftp-pubkey-file string Optional path to public key file 12037 --sftp-server-command string Specifies the path or command to run a sftp server on the remote host 12038 --sftp-set-env SpaceSepList Environment variables to pass to sftp and commands 12039 --sftp-set-modtime Set the modified time on the remote if set (default true) 12040 --sftp-sha1sum-command string The command used to read sha1 hashes 12041 --sftp-shell-type string The type of SSH shell on remote server, if any 12042 --sftp-skip-links Set to skip any symlinks and any other non regular files 12043 --sftp-socks-proxy string Socks 5 proxy host 12044 --sftp-ssh SpaceSepList Path and arguments to external ssh binary 12045 --sftp-subsystem string Specifies the SSH2 subsystem on the remote host (default "sftp") 12046 --sftp-use-fstat If set use fstat instead of stat 12047 --sftp-use-insecure-cipher Enable the use of insecure ciphers and key exchange methods 12048 --sftp-user string SSH username (default "$USER") 12049 --sharefile-auth-url string Auth server URL 12050 --sharefile-chunk-size SizeSuffix Upload chunk size (default 64Mi) 12051 --sharefile-client-id string OAuth Client Id 12052 --sharefile-client-secret string OAuth Client Secret 12053 --sharefile-description string Description of the remote 12054 --sharefile-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot) 12055 --sharefile-endpoint string Endpoint for API calls 12056 --sharefile-root-folder-id string ID of the root folder 12057 --sharefile-token string OAuth Access Token as a JSON blob 12058 --sharefile-token-url string Token server url 12059 --sharefile-upload-cutoff SizeSuffix Cutoff for switching to multipart upload (default 128Mi) 12060 --sia-api-password string Sia Daemon API Password (obscured) 12061 --sia-api-url string Sia daemon API URL, like http://sia.daemon.host:9980 (default "http://127.0.0.1:9980") 12062 --sia-description string Description of the remote 12063 --sia-encoding Encoding The encoding for the backend (default Slash,Question,Hash,Percent,Del,Ctl,InvalidUtf8,Dot) 12064 --sia-user-agent string Siad User Agent (default "Sia-Agent") 12065 --skip-links Don't warn about skipped symlinks 12066 --smb-case-insensitive Whether the server is configured to be case-insensitive (default true) 12067 --smb-description string Description of the remote 12068 --smb-domain string Domain name for NTLM authentication (default "WORKGROUP") 12069 --smb-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot) 12070 --smb-hide-special-share Hide special shares (e.g. print$) which users aren't supposed to access (default true) 12071 --smb-host string SMB server hostname to connect to 12072 --smb-idle-timeout Duration Max time before closing idle connections (default 1m0s) 12073 --smb-pass string SMB password (obscured) 12074 --smb-port int SMB port number (default 445) 12075 --smb-spn string Service principal name 12076 --smb-user string SMB username (default "$USER") 12077 --storj-access-grant string Access grant 12078 --storj-api-key string API key 12079 --storj-description string Description of the remote 12080 --storj-passphrase string Encryption passphrase 12081 --storj-provider string Choose an authentication method (default "existing") 12082 --storj-satellite-address string Satellite address (default "us1.storj.io") 12083 --sugarsync-access-key-id string Sugarsync Access Key ID 12084 --sugarsync-app-id string Sugarsync App ID 12085 --sugarsync-authorization string Sugarsync authorization 12086 --sugarsync-authorization-expiry string Sugarsync authorization expiry 12087 --sugarsync-deleted-id string Sugarsync deleted folder id 12088 --sugarsync-description string Description of the remote 12089 --sugarsync-encoding Encoding The encoding for the backend (default Slash,Ctl,InvalidUtf8,Dot) 12090 --sugarsync-hard-delete Permanently delete files if true 12091 --sugarsync-private-access-key string Sugarsync Private Access Key 12092 --sugarsync-refresh-token string Sugarsync refresh token 12093 --sugarsync-root-id string Sugarsync root id 12094 --sugarsync-user string Sugarsync user 12095 --swift-application-credential-id string Application Credential ID (OS_APPLICATION_CREDENTIAL_ID) 12096 --swift-application-credential-name string Application Credential Name (OS_APPLICATION_CREDENTIAL_NAME) 12097 --swift-application-credential-secret string Application Credential Secret (OS_APPLICATION_CREDENTIAL_SECRET) 12098 --swift-auth string Authentication URL for server (OS_AUTH_URL) 12099 --swift-auth-token string Auth Token from alternate authentication - optional (OS_AUTH_TOKEN) 12100 --swift-auth-version int AuthVersion - optional - set to (1,2,3) if your auth URL has no version (ST_AUTH_VERSION) 12101 --swift-chunk-size SizeSuffix Above this size files will be chunked into a _segments container (default 5Gi) 12102 --swift-description string Description of the remote 12103 --swift-domain string User domain - optional (v3 auth) (OS_USER_DOMAIN_NAME) 12104 --swift-encoding Encoding The encoding for the backend (default Slash,InvalidUtf8) 12105 --swift-endpoint-type string Endpoint type to choose from the service catalogue (OS_ENDPOINT_TYPE) (default "public") 12106 --swift-env-auth Get swift credentials from environment variables in standard OpenStack form 12107 --swift-key string API key or password (OS_PASSWORD) 12108 --swift-leave-parts-on-error If true avoid calling abort upload on a failure 12109 --swift-no-chunk Don't chunk files during streaming upload 12110 --swift-no-large-objects Disable support for static and dynamic large objects 12111 --swift-region string Region name - optional (OS_REGION_NAME) 12112 --swift-storage-policy string The storage policy to use when creating a new container 12113 --swift-storage-url string Storage URL - optional (OS_STORAGE_URL) 12114 --swift-tenant string Tenant name - optional for v1 auth, this or tenant_id required otherwise (OS_TENANT_NAME or OS_PROJECT_NAME) 12115 --swift-tenant-domain string Tenant domain - optional (v3 auth) (OS_PROJECT_DOMAIN_NAME) 12116 --swift-tenant-id string Tenant ID - optional for v1 auth, this or tenant required otherwise (OS_TENANT_ID) 12117 --swift-user string User name to log in (OS_USERNAME) 12118 --swift-user-id string User ID to log in - optional - most swift systems use user and leave this blank (v3 auth) (OS_USER_ID) 12119 --union-action-policy string Policy to choose upstream on ACTION category (default "epall") 12120 --union-cache-time int Cache time of usage and free space (in seconds) (default 120) 12121 --union-create-policy string Policy to choose upstream on CREATE category (default "epmfs") 12122 --union-description string Description of the remote 12123 --union-min-free-space SizeSuffix Minimum viable free space for lfs/eplfs policies (default 1Gi) 12124 --union-search-policy string Policy to choose upstream on SEARCH category (default "ff") 12125 --union-upstreams string List of space separated upstreams 12126 --uptobox-access-token string Your access token 12127 --uptobox-description string Description of the remote 12128 --uptobox-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,BackQuote,Del,Ctl,LeftSpace,InvalidUtf8,Dot) 12129 --uptobox-private Set to make uploaded files private 12130 --webdav-bearer-token string Bearer token instead of user/pass (e.g. a Macaroon) 12131 --webdav-bearer-token-command string Command to run to get a bearer token 12132 --webdav-description string Description of the remote 12133 --webdav-encoding string The encoding for the backend 12134 --webdav-headers CommaSepList Set HTTP headers for all transactions 12135 --webdav-nextcloud-chunk-size SizeSuffix Nextcloud upload chunk size (default 10Mi) 12136 --webdav-owncloud-exclude-shares Exclude ownCloud shares 12137 --webdav-pacer-min-sleep Duration Minimum time to sleep between API calls (default 10ms) 12138 --webdav-pass string Password (obscured) 12139 --webdav-url string URL of http host to connect to 12140 --webdav-user string User name 12141 --webdav-vendor string Name of the WebDAV site/service/software you are using 12142 --yandex-auth-url string Auth server URL 12143 --yandex-client-id string OAuth Client Id 12144 --yandex-client-secret string OAuth Client Secret 12145 --yandex-description string Description of the remote 12146 --yandex-encoding Encoding The encoding for the backend (default Slash,Del,Ctl,InvalidUtf8,Dot) 12147 --yandex-hard-delete Delete files permanently rather than putting them into the trash 12148 --yandex-token string OAuth Access Token as a JSON blob 12149 --yandex-token-url string Token server url 12150 --zoho-auth-url string Auth server URL 12151 --zoho-client-id string OAuth Client Id 12152 --zoho-client-secret string OAuth Client Secret 12153 --zoho-description string Description of the remote 12154 --zoho-encoding Encoding The encoding for the backend (default Del,Ctl,InvalidUtf8) 12155 --zoho-region string Zoho region to connect to 12156 --zoho-token string OAuth Access Token as a JSON blob 12157 --zoho-token-url string Token server url</code></pre> 12158 <h1 id="docker-volume-plugin">Docker Volume Plugin</h1> 12159 <h2 id="introduction">Introduction</h2> 12160 <p>Docker 1.9 has added support for creating <a href="https://docs.docker.com/storage/volumes/">named volumes</a> via <a href="https://docs.docker.com/engine/reference/commandline/volume_create/">command-line interface</a> and mounting them in containers as a way to share data between them. Since Docker 1.10 you can create named volumes with <a href="https://docs.docker.com/compose/">Docker Compose</a> by descriptions in <a href="https://docs.docker.com/compose/compose-file/compose-file-v2/#volume-configuration-reference">docker-compose.yml</a> files for use by container groups on a single host. As of Docker 1.12 volumes are supported by <a href="https://docs.docker.com/engine/swarm/key-concepts/">Docker Swarm</a> included with Docker Engine and created from descriptions in <a href="https://docs.docker.com/compose/compose-file/compose-file-v3/#volume-configuration-reference">swarm compose v3</a> files for use with <em>swarm stacks</em> across multiple cluster nodes.</p> 12161 <p><a href="https://docs.docker.com/engine/extend/plugins_volume/">Docker Volume Plugins</a> augment the default <code>local</code> volume driver included in Docker with stateful volumes shared across containers and hosts. Unlike local volumes, your data will <em>not</em> be deleted when such volume is removed. Plugins can run managed by the docker daemon, as a native system service (under systemd, <em>sysv</em> or <em>upstart</em>) or as a standalone executable. Rclone can run as docker volume plugin in all these modes. It interacts with the local docker daemon via <a href="https://docs.docker.com/engine/extend/plugin_api/">plugin API</a> and handles mounting of remote file systems into docker containers so it must run on the same host as the docker daemon or on every Swarm node.</p> 12162 <h2 id="getting-started">Getting started</h2> 12163 <p>In the first example we will use the <a href="https://rclone.org/sftp/">SFTP</a> rclone volume with Docker engine on a standalone Ubuntu machine.</p> 12164 <p>Start from <a href="https://docs.docker.com/engine/install/">installing Docker</a> on the host.</p> 12165 <p>The <em>FUSE</em> driver is a prerequisite for rclone mounting and should be installed on host:</p> 12166 <pre><code>sudo apt-get -y install fuse</code></pre> 12167 <p>Create two directories required by rclone docker plugin:</p> 12168 <pre><code>sudo mkdir -p /var/lib/docker-plugins/rclone/config 12169 sudo mkdir -p /var/lib/docker-plugins/rclone/cache</code></pre> 12170 <p>Install the managed rclone docker plugin for your architecture (here <code>amd64</code>):</p> 12171 <pre><code>docker plugin install rclone/docker-volume-rclone:amd64 args="-v" --alias rclone --grant-all-permissions 12172 docker plugin list</code></pre> 12173 <p>Create your <a href="https://rclone.org/sftp/#standard-options">SFTP volume</a>:</p> 12174 <pre><code>docker volume create firstvolume -d rclone -o type=sftp -o sftp-host=_hostname_ -o sftp-user=_username_ -o sftp-pass=_password_ -o allow-other=true</code></pre> 12175 <p>Note that since all options are static, you don't even have to run <code>rclone config</code> or create the <code>rclone.conf</code> file (but the <code>config</code> directory should still be present). In the simplest case you can use <code>localhost</code> as <em>hostname</em> and your SSH credentials as <em>username</em> and <em>password</em>. You can also change the remote path to your home directory on the host, for example <code>-o path=/home/username</code>.</p> 12176 <p>Time to create a test container and mount the volume into it:</p> 12177 <pre><code>docker run --rm -it -v firstvolume:/mnt --workdir /mnt ubuntu:latest bash</code></pre> 12178 <p>If all goes well, you will enter the new container and change right to the mounted SFTP remote. You can type <code>ls</code> to list the mounted directory or otherwise play with it. Type <code>exit</code> when you are done. The container will stop but the volume will stay, ready to be reused. When it's not needed anymore, remove it:</p> 12179 <pre><code>docker volume list 12180 docker volume remove firstvolume</code></pre> 12181 <p>Now let us try <strong>something more elaborate</strong>: <a href="https://rclone.org/drive/">Google Drive</a> volume on multi-node Docker Swarm.</p> 12182 <p>You should start from installing Docker and FUSE, creating plugin directories and installing rclone plugin on <em>every</em> swarm node. Then <a href="https://docs.docker.com/engine/swarm/swarm-mode/">setup the Swarm</a>.</p> 12183 <p>Google Drive volumes need an access token which can be setup via web browser and will be periodically renewed by rclone. The managed plugin cannot run a browser so we will use a technique similar to the <a href="https://rclone.org/remote_setup/">rclone setup on a headless box</a>.</p> 12184 <p>Run <a href="https://rclone.org/commands/rclone_config_create/">rclone config</a> on <em>another</em> machine equipped with <em>web browser</em> and graphical user interface. Create the <a href="https://rclone.org/drive/#standard-options">Google Drive remote</a>. When done, transfer the resulting <code>rclone.conf</code> to the Swarm cluster and save as <code>/var/lib/docker-plugins/rclone/config/rclone.conf</code> on <em>every</em> node. By default this location is accessible only to the root user so you will need appropriate privileges. The resulting config will look like this:</p> 12185 <pre><code>[gdrive] 12186 type = drive 12187 scope = drive 12188 drive_id = 1234567... 12189 root_folder_id = 0Abcd... 12190 token = {"access_token":...}</code></pre> 12191 <p>Now create the file named <code>example.yml</code> with a swarm stack description like this:</p> 12192 <pre><code>version: '3' 12193 services: 12194 heimdall: 12195 image: linuxserver/heimdall:latest 12196 ports: [8080:80] 12197 volumes: [configdata:/config] 12198 volumes: 12199 configdata: 12200 driver: rclone 12201 driver_opts: 12202 remote: 'gdrive:heimdall' 12203 allow_other: 'true' 12204 vfs_cache_mode: full 12205 poll_interval: 0</code></pre> 12206 <p>and run the stack:</p> 12207 <pre><code>docker stack deploy example -c ./example.yml</code></pre> 12208 <p>After a few seconds docker will spread the parsed stack description over cluster, create the <code>example_heimdall</code> service on port <em>8080</em>, run service containers on one or more cluster nodes and request the <code>example_configdata</code> volume from rclone plugins on the node hosts. You can use the following commands to confirm results:</p> 12209 <pre><code>docker service ls 12210 docker service ps example_heimdall 12211 docker volume ls</code></pre> 12212 <p>Point your browser to <code>http://cluster.host.address:8080</code> and play with the service. Stop it with <code>docker stack remove example</code> when you are done. Note that the <code>example_configdata</code> volume(s) created on demand at the cluster nodes will not be automatically removed together with the stack but stay for future reuse. You can remove them manually by invoking the <code>docker volume remove example_configdata</code> command on every node.</p> 12213 <h2 id="creating-volumes-via-cli">Creating Volumes via CLI</h2> 12214 <p>Volumes can be created with <a href="https://docs.docker.com/engine/reference/commandline/volume_create/">docker volume create</a>. Here are a few examples:</p> 12215 <pre><code>docker volume create vol1 -d rclone -o remote=storj: -o vfs-cache-mode=full 12216 docker volume create vol2 -d rclone -o remote=:storj,access_grant=xxx:heimdall 12217 docker volume create vol3 -d rclone -o type=storj -o path=heimdall -o storj-access-grant=xxx -o poll-interval=0</code></pre> 12218 <p>Note the <code>-d rclone</code> flag that tells docker to request volume from the rclone driver. This works even if you installed managed driver by its full name <code>rclone/docker-volume-rclone</code> because you provided the <code>--alias rclone</code> option.</p> 12219 <p>Volumes can be inspected as follows:</p> 12220 <pre><code>docker volume list 12221 docker volume inspect vol1</code></pre> 12222 <h2 id="volume-configuration">Volume Configuration</h2> 12223 <p>Rclone flags and volume options are set via the <code>-o</code> flag to the <code>docker volume create</code> command. They include backend-specific parameters as well as mount and <em>VFS</em> options. Also there are a few special <code>-o</code> options: <code>remote</code>, <code>fs</code>, <code>type</code>, <code>path</code>, <code>mount-type</code> and <code>persist</code>.</p> 12224 <p><code>remote</code> determines an existing remote name from the config file, with trailing colon and optionally with a remote path. See the full syntax in the <a href="https://rclone.org/docs/#syntax-of-remote-paths">rclone documentation</a>. This option can be aliased as <code>fs</code> to prevent confusion with the <em>remote</em> parameter of such backends as <em>crypt</em> or <em>alias</em>.</p> 12225 <p>The <code>remote=:backend:dir/subdir</code> syntax can be used to create <a href="https://rclone.org/docs/#backend-path-to-dir">on-the-fly (config-less) remotes</a>, while the <code>type</code> and <code>path</code> options provide a simpler alternative for this. Using two split options</p> 12226 <pre><code>-o type=backend -o path=dir/subdir</code></pre> 12227 <p>is equivalent to the combined syntax</p> 12228 <pre><code>-o remote=:backend:dir/subdir</code></pre> 12229 <p>but is arguably easier to parameterize in scripts. The <code>path</code> part is optional.</p> 12230 <p><a href="https://rclone.org/commands/rclone_serve_docker/#options">Mount and VFS options</a> as well as <a href="https://rclone.org/flags/#backend-flags">backend parameters</a> are named like their twin command-line flags without the <code>--</code> CLI prefix. Optionally you can use underscores instead of dashes in option names. For example, <code>--vfs-cache-mode full</code> becomes <code>-o vfs-cache-mode=full</code> or <code>-o vfs_cache_mode=full</code>. Boolean CLI flags without value will gain the <code>true</code> value, e.g. <code>--allow-other</code> becomes <code>-o allow-other=true</code> or <code>-o allow_other=true</code>.</p> 12231 <p>Please note that you can provide parameters only for the backend immediately referenced by the backend type of mounted <code>remote</code>. If this is a wrapping backend like <em>alias, chunker or crypt</em>, you cannot provide options for the referred to remote or backend. This limitation is imposed by the rclone connection string parser. The only workaround is to feed plugin with <code>rclone.conf</code> or configure plugin arguments (see below).</p> 12232 <h2 id="special-volume-options">Special Volume Options</h2> 12233 <p><code>mount-type</code> determines the mount method and in general can be one of: <code>mount</code>, <code>cmount</code>, or <code>mount2</code>. This can be aliased as <code>mount_type</code>. It should be noted that the managed rclone docker plugin currently does not support the <code>cmount</code> method and <code>mount2</code> is rarely needed. This option defaults to the first found method, which is usually <code>mount</code> so you generally won't need it.</p> 12234 <p><code>persist</code> is a reserved boolean (true/false) option. In future it will allow to persist on-the-fly remotes in the plugin <code>rclone.conf</code> file.</p> 12235 <h2 id="connection-strings-1">Connection Strings</h2> 12236 <p>The <code>remote</code> value can be extended with <a href="https://rclone.org/docs/#connection-strings">connection strings</a> as an alternative way to supply backend parameters. This is equivalent to the <code>-o</code> backend options with one <em>syntactic difference</em>. Inside connection string the backend prefix must be dropped from parameter names but in the <code>-o param=value</code> array it must be present. For instance, compare the following option array</p> 12237 <pre><code>-o remote=:sftp:/home -o sftp-host=localhost</code></pre> 12238 <p>with equivalent connection string:</p> 12239 <pre><code>-o remote=:sftp,host=localhost:/home</code></pre> 12240 <p>This difference exists because flag options <code>-o key=val</code> include not only backend parameters but also mount/VFS flags and possibly other settings. Also it allows to discriminate the <code>remote</code> option from the <code>crypt-remote</code> (or similarly named backend parameters) and arguably simplifies scripting due to clearer value substitution.</p> 12241 <h2 id="using-with-swarm-or-compose">Using with Swarm or Compose</h2> 12242 <p>Both <em>Docker Swarm</em> and <em>Docker Compose</em> use <a href="http://yaml.org/spec/1.2/spec.html">YAML</a>-formatted text files to describe groups (stacks) of containers, their properties, networks and volumes. <em>Compose</em> uses the <a href="https://docs.docker.com/compose/compose-file/compose-file-v2/#volume-configuration-reference">compose v2</a> format, <em>Swarm</em> uses the <a href="https://docs.docker.com/compose/compose-file/compose-file-v3/#volume-configuration-reference">compose v3</a> format. They are mostly similar, differences are explained in the <a href="https://docs.docker.com/compose/compose-file/compose-versioning/#upgrading">docker documentation</a>.</p> 12243 <p>Volumes are described by the children of the top-level <code>volumes:</code> node. Each of them should be named after its volume and have at least two elements, the self-explanatory <code>driver: rclone</code> value and the <code>driver_opts:</code> structure playing the same role as <code>-o key=val</code> CLI flags:</p> 12244 <pre><code>volumes: 12245 volume_name_1: 12246 driver: rclone 12247 driver_opts: 12248 remote: 'gdrive:' 12249 allow_other: 'true' 12250 vfs_cache_mode: full 12251 token: '{"type": "borrower", "expires": "2021-12-31"}' 12252 poll_interval: 0</code></pre> 12253 <p>Notice a few important details: - YAML prefers <code>_</code> in option names instead of <code>-</code>. - YAML treats single and double quotes interchangeably. Simple strings and integers can be left unquoted. - Boolean values must be quoted like <code>'true'</code> or <code>"false"</code> because these two words are reserved by YAML. - The filesystem string is keyed with <code>remote</code> (or with <code>fs</code>). Normally you can omit quotes here, but if the string ends with colon, you <strong>must</strong> quote it like <code>remote: "storage_box:"</code>. - YAML is picky about surrounding braces in values as this is in fact another <a href="http://yaml.org/spec/1.2/spec.html#id2790832">syntax for key/value mappings</a>. For example, JSON access tokens usually contain double quotes and surrounding braces, so you must put them in single quotes.</p> 12254 <h2 id="installing-as-managed-plugin">Installing as Managed Plugin</h2> 12255 <p>Docker daemon can install plugins from an image registry and run them managed. We maintain the <a href="https://hub.docker.com/p/rclone/docker-volume-rclone/">docker-volume-rclone</a> plugin image on <a href="https://hub.docker.com">Docker Hub</a>.</p> 12256 <p>Rclone volume plugin requires <strong>Docker Engine >= 19.03.15</strong></p> 12257 <p>The plugin requires presence of two directories on the host before it can be installed. Note that plugin will <strong>not</strong> create them automatically. By default they must exist on host at the following locations (though you can tweak the paths): - <code>/var/lib/docker-plugins/rclone/config</code> is reserved for the <code>rclone.conf</code> config file and <strong>must</strong> exist even if it's empty and the config file is not present. - <code>/var/lib/docker-plugins/rclone/cache</code> holds the plugin state file as well as optional VFS caches.</p> 12258 <p>You can <a href="https://docs.docker.com/engine/reference/commandline/plugin_install/">install managed plugin</a> with default settings as follows:</p> 12259 <pre><code>docker plugin install rclone/docker-volume-rclone:amd64 --grant-all-permissions --alias rclone</code></pre> 12260 <p>The <code>:amd64</code> part of the image specification after colon is called a <em>tag</em>. Usually you will want to install the latest plugin for your architecture. In this case the tag will just name it, like <code>amd64</code> above. The following plugin architectures are currently available: - <code>amd64</code> - <code>arm64</code> - <code>arm-v7</code></p> 12261 <p>Sometimes you might want a concrete plugin version, not the latest one. Then you should use image tag in the form <code>:ARCHITECTURE-VERSION</code>. For example, to install plugin version <code>v1.56.2</code> on architecture <code>arm64</code> you will use tag <code>arm64-1.56.2</code> (note the removed <code>v</code>) so the full image specification becomes <code>rclone/docker-volume-rclone:arm64-1.56.2</code>.</p> 12262 <p>We also provide the <code>latest</code> plugin tag, but since docker does not support multi-architecture plugins as of the time of this writing, this tag is currently an <strong>alias for <code>amd64</code></strong>. By convention the <code>latest</code> tag is the default one and can be omitted, thus both <code>rclone/docker-volume-rclone:latest</code> and just <code>rclone/docker-volume-rclone</code> will refer to the latest plugin release for the <code>amd64</code> platform.</p> 12263 <p>Also the <code>amd64</code> part can be omitted from the versioned rclone plugin tags. For example, rclone image reference <code>rclone/docker-volume-rclone:amd64-1.56.2</code> can be abbreviated as <code>rclone/docker-volume-rclone:1.56.2</code> for convenience. However, for non-intel architectures you still have to use the full tag as <code>amd64</code> or <code>latest</code> will fail to start.</p> 12264 <p>Managed plugin is in fact a special container running in a namespace separate from normal docker containers. Inside it runs the <code>rclone serve docker</code> command. The config and cache directories are bind-mounted into the container at start. The docker daemon connects to a unix socket created by the command inside the container. The command creates on-demand remote mounts right inside, then docker machinery propagates them through kernel mount namespaces and bind-mounts into requesting user containers.</p> 12265 <p>You can tweak a few plugin settings after installation when it's disabled (not in use), for instance:</p> 12266 <pre><code>docker plugin disable rclone 12267 docker plugin set rclone RCLONE_VERBOSE=2 config=/etc/rclone args="--vfs-cache-mode=writes --allow-other" 12268 docker plugin enable rclone 12269 docker plugin inspect rclone</code></pre> 12270 <p>Note that if docker refuses to disable the plugin, you should find and remove all active volumes connected with it as well as containers and swarm services that use them. This is rather tedious so please carefully plan in advance.</p> 12271 <p>You can tweak the following settings: <code>args</code>, <code>config</code>, <code>cache</code>, <code>HTTP_PROXY</code>, <code>HTTPS_PROXY</code>, <code>NO_PROXY</code> and <code>RCLONE_VERBOSE</code>. It's <em>your</em> task to keep plugin settings in sync across swarm cluster nodes.</p> 12272 <p><code>args</code> sets command-line arguments for the <code>rclone serve docker</code> command (<em>none</em> by default). Arguments should be separated by space so you will normally want to put them in quotes on the <a href="https://docs.docker.com/engine/reference/commandline/plugin_set/">docker plugin set</a> command line. Both <a href="https://rclone.org/commands/rclone_serve_docker/#options">serve docker flags</a> and <a href="https://rclone.org/flags/">generic rclone flags</a> are supported, including backend parameters that will be used as defaults for volume creation. Note that plugin will fail (due to <a href="https://github.com/moby/moby/blob/v20.10.7/plugin/v2/plugin.go#L195">this docker bug</a>) if the <code>args</code> value is empty. Use e.g. <code>args="-v"</code> as a workaround.</p> 12273 <p><code>config=/host/dir</code> sets alternative host location for the config directory. Plugin will look for <code>rclone.conf</code> here. It's not an error if the config file is not present but the directory must exist. Please note that plugin can periodically rewrite the config file, for example when it renews storage access tokens. Keep this in mind and try to avoid races between the plugin and other instances of rclone on the host that might try to change the config simultaneously resulting in corrupted <code>rclone.conf</code>. You can also put stuff like private key files for SFTP remotes in this directory. Just note that it's bind-mounted inside the plugin container at the predefined path <code>/data/config</code>. For example, if your key file is named <code>sftp-box1.key</code> on the host, the corresponding volume config option should read <code>-o sftp-key-file=/data/config/sftp-box1.key</code>.</p> 12274 <p><code>cache=/host/dir</code> sets alternative host location for the <em>cache</em> directory. The plugin will keep VFS caches here. Also it will create and maintain the <code>docker-plugin.state</code> file in this directory. When the plugin is restarted or reinstalled, it will look in this file to recreate any volumes that existed previously. However, they will not be re-mounted into consuming containers after restart. Usually this is not a problem as the docker daemon normally will restart affected user containers after failures, daemon restarts or host reboots.</p> 12275 <p><code>RCLONE_VERBOSE</code> sets plugin verbosity from <code>0</code> (errors only, by default) to <code>2</code> (debugging). Verbosity can be also tweaked via <code>args="-v [-v] ..."</code>. Since arguments are more generic, you will rarely need this setting. The plugin output by default feeds the docker daemon log on local host. Log entries are reflected as <em>errors</em> in the docker log but retain their actual level assigned by rclone in the encapsulated message string.</p> 12276 <p><code>HTTP_PROXY</code>, <code>HTTPS_PROXY</code>, <code>NO_PROXY</code> customize the plugin proxy settings.</p> 12277 <p>You can set custom plugin options right when you install it, <em>in one go</em>:</p> 12278 <pre><code>docker plugin remove rclone 12279 docker plugin install rclone/docker-volume-rclone:amd64 \ 12280 --alias rclone --grant-all-permissions \ 12281 args="-v --allow-other" config=/etc/rclone 12282 docker plugin inspect rclone</code></pre> 12283 <h2 id="healthchecks">Healthchecks</h2> 12284 <p>The docker plugin volume protocol doesn't provide a way for plugins to inform the docker daemon that a volume is (un-)available. As a workaround you can setup a healthcheck to verify that the mount is responding, for example:</p> 12285 <pre><code>services: 12286 my_service: 12287 image: my_image 12288 healthcheck: 12289 test: ls /path/to/rclone/mount || exit 1 12290 interval: 1m 12291 timeout: 15s 12292 retries: 3 12293 start_period: 15s</code></pre> 12294 <h2 id="running-plugin-under-systemd">Running Plugin under Systemd</h2> 12295 <p>In most cases you should prefer managed mode. Moreover, MacOS and Windows do not support native Docker plugins. Please use managed mode on these systems. Proceed further only if you are on Linux.</p> 12296 <p>First, <a href="https://rclone.org/install/">install rclone</a>. You can just run it (type <code>rclone serve docker</code> and hit enter) for the test.</p> 12297 <p>Install <em>FUSE</em>:</p> 12298 <pre><code>sudo apt-get -y install fuse</code></pre> 12299 <p>Download two systemd configuration files: <a href="https://raw.githubusercontent.com/rclone/rclone/master/contrib/docker-plugin/systemd/docker-volume-rclone.service">docker-volume-rclone.service</a> and <a href="https://raw.githubusercontent.com/rclone/rclone/master/contrib/docker-plugin/systemd/docker-volume-rclone.socket">docker-volume-rclone.socket</a>.</p> 12300 <p>Put them to the <code>/etc/systemd/system/</code> directory:</p> 12301 <pre><code>cp docker-volume-plugin.service /etc/systemd/system/ 12302 cp docker-volume-plugin.socket /etc/systemd/system/</code></pre> 12303 <p>Please note that all commands in this section must be run as <em>root</em> but we omit <code>sudo</code> prefix for brevity. Now create directories required by the service:</p> 12304 <pre><code>mkdir -p /var/lib/docker-volumes/rclone 12305 mkdir -p /var/lib/docker-plugins/rclone/config 12306 mkdir -p /var/lib/docker-plugins/rclone/cache</code></pre> 12307 <p>Run the docker plugin service in the socket activated mode:</p> 12308 <pre><code>systemctl daemon-reload 12309 systemctl start docker-volume-rclone.service 12310 systemctl enable docker-volume-rclone.socket 12311 systemctl start docker-volume-rclone.socket 12312 systemctl restart docker</code></pre> 12313 <p>Or run the service directly: - run <code>systemctl daemon-reload</code> to let systemd pick up new config - run <code>systemctl enable docker-volume-rclone.service</code> to make the new service start automatically when you power on your machine. - run <code>systemctl start docker-volume-rclone.service</code> to start the service now. - run <code>systemctl restart docker</code> to restart docker daemon and let it detect the new plugin socket. Note that this step is not needed in managed mode where docker knows about plugin state changes.</p> 12314 <p>The two methods are equivalent from the user perspective, but I personally prefer socket activation.</p> 12315 <h2 id="troubleshooting">Troubleshooting</h2> 12316 <p>You can <a href="https://docs.docker.com/engine/extend/#debugging-plugins">see managed plugin settings</a> with</p> 12317 <pre><code>docker plugin list 12318 docker plugin inspect rclone</code></pre> 12319 <p>Note that docker (including latest 20.10.7) will not show actual values of <code>args</code>, just the defaults.</p> 12320 <p>Use <code>journalctl --unit docker</code> to see managed plugin output as part of the docker daemon log. Note that docker reflects plugin lines as <em>errors</em> but their actual level can be seen from encapsulated message string.</p> 12321 <p>You will usually install the latest version of managed plugin for your platform. Use the following commands to print the actual installed version:</p> 12322 <pre><code>PLUGID=$(docker plugin list --no-trunc | awk '/rclone/{print$1}') 12323 sudo runc --root /run/docker/runtime-runc/plugins.moby exec $PLUGID rclone version</code></pre> 12324 <p>You can even use <code>runc</code> to run shell inside the plugin container:</p> 12325 <pre><code>sudo runc --root /run/docker/runtime-runc/plugins.moby exec --tty $PLUGID bash</code></pre> 12326 <p>Also you can use curl to check the plugin socket connectivity:</p> 12327 <pre><code>docker plugin list --no-trunc 12328 PLUGID=123abc... 12329 sudo curl -H Content-Type:application/json -XPOST -d {} --unix-socket /run/docker/plugins/$PLUGID/rclone.sock http://localhost/Plugin.Activate</code></pre> 12330 <p>though this is rarely needed.</p> 12331 <h2 id="caveats">Caveats</h2> 12332 <p>Finally I'd like to mention a <em>caveat with updating volume settings</em>. Docker CLI does not have a dedicated command like <code>docker volume update</code>. It may be tempting to invoke <code>docker volume create</code> with updated options on existing volume, but there is a gotcha. The command will do nothing, it won't even return an error. I hope that docker maintainers will fix this some day. In the meantime be aware that you must remove your volume before recreating it with new settings:</p> 12333 <pre><code>docker volume remove my_vol 12334 docker volume create my_vol -d rclone -o opt1=new_val1 ...</code></pre> 12335 <p>and verify that settings did update:</p> 12336 <pre><code>docker volume list 12337 docker volume inspect my_vol</code></pre> 12338 <p>If docker refuses to remove the volume, you should find containers or swarm services that use it and stop them first.</p> 12339 <h2 id="bisync">Bisync</h2> 12340 <p><code>bisync</code> is <strong>in beta</strong> and is considered an <strong>advanced command</strong>, so use with care. Make sure you have read and understood the entire <a href="https://rclone.org/bisync">manual</a> (especially the <a href="#limitations">Limitations</a> section) before using, or data loss can result. Questions can be asked in the <a href="https://forum.rclone.org/">Rclone Forum</a>.</p> 12341 <h2 id="getting-started">Getting started</h2> 12342 <ul> 12343 <li><a href="https://rclone.org/install/">Install rclone</a> and setup your remotes.</li> 12344 <li>Bisync will create its working directory at <code>~/.cache/rclone/bisync</code> on Linux, <code>/Users/yourusername/Library/Caches/rclone/bisync</code> on Mac, or <code>C:\Users\MyLogin\AppData\Local\rclone\bisync</code> on Windows. Make sure that this location is writable.</li> 12345 <li>Run bisync with the <code>--resync</code> flag, specifying the paths to the local and remote sync directory roots.</li> 12346 <li>For successive sync runs, leave off the <code>--resync</code> flag. (<strong>Important!</strong>)</li> 12347 <li>Consider using a <a href="#filtering">filters file</a> for excluding unnecessary files and directories from the sync.</li> 12348 <li>Consider setting up the <a href="#check-access">--check-access</a> feature for safety.</li> 12349 <li>On Linux or Mac, consider setting up a <a href="#cron">crontab entry</a>. bisync can safely run in concurrent cron jobs thanks to lock files it maintains.</li> 12350 </ul> 12351 <p>For example, your first command might look like this:</p> 12352 <pre><code>rclone bisync remote1:path1 remote2:path2 --create-empty-src-dirs --compare size,modtime,checksum --slow-hash-sync-only --resilient -MvP --drive-skip-gdocs --fix-case --resync --dry-run</code></pre> 12353 <p>If all looks good, run it again without <code>--dry-run</code>. After that, remove <code>--resync</code> as well.</p> 12354 <p>Here is a typical run log (with timestamps removed for clarity):</p> 12355 <pre><code>rclone bisync /testdir/path1/ /testdir/path2/ --verbose 12356 INFO : Synching Path1 "/testdir/path1/" with Path2 "/testdir/path2/" 12357 INFO : Path1 checking for diffs 12358 INFO : - Path1 File is new - file11.txt 12359 INFO : - Path1 File is newer - file2.txt 12360 INFO : - Path1 File is newer - file5.txt 12361 INFO : - Path1 File is newer - file7.txt 12362 INFO : - Path1 File was deleted - file4.txt 12363 INFO : - Path1 File was deleted - file6.txt 12364 INFO : - Path1 File was deleted - file8.txt 12365 INFO : Path1: 7 changes: 1 new, 3 newer, 0 older, 3 deleted 12366 INFO : Path2 checking for diffs 12367 INFO : - Path2 File is new - file10.txt 12368 INFO : - Path2 File is newer - file1.txt 12369 INFO : - Path2 File is newer - file5.txt 12370 INFO : - Path2 File is newer - file6.txt 12371 INFO : - Path2 File was deleted - file3.txt 12372 INFO : - Path2 File was deleted - file7.txt 12373 INFO : - Path2 File was deleted - file8.txt 12374 INFO : Path2: 7 changes: 1 new, 3 newer, 0 older, 3 deleted 12375 INFO : Applying changes 12376 INFO : - Path1 Queue copy to Path2 - /testdir/path2/file11.txt 12377 INFO : - Path1 Queue copy to Path2 - /testdir/path2/file2.txt 12378 INFO : - Path2 Queue delete - /testdir/path2/file4.txt 12379 NOTICE: - WARNING New or changed in both paths - file5.txt 12380 NOTICE: - Path1 Renaming Path1 copy - /testdir/path1/file5.txt..path1 12381 NOTICE: - Path1 Queue copy to Path2 - /testdir/path2/file5.txt..path1 12382 NOTICE: - Path2 Renaming Path2 copy - /testdir/path2/file5.txt..path2 12383 NOTICE: - Path2 Queue copy to Path1 - /testdir/path1/file5.txt..path2 12384 INFO : - Path2 Queue copy to Path1 - /testdir/path1/file6.txt 12385 INFO : - Path1 Queue copy to Path2 - /testdir/path2/file7.txt 12386 INFO : - Path2 Queue copy to Path1 - /testdir/path1/file1.txt 12387 INFO : - Path2 Queue copy to Path1 - /testdir/path1/file10.txt 12388 INFO : - Path1 Queue delete - /testdir/path1/file3.txt 12389 INFO : - Path2 Do queued copies to - Path1 12390 INFO : - Path1 Do queued copies to - Path2 12391 INFO : - Do queued deletes on - Path1 12392 INFO : - Do queued deletes on - Path2 12393 INFO : Updating listings 12394 INFO : Validating listings for Path1 "/testdir/path1/" vs Path2 "/testdir/path2/" 12395 INFO : Bisync successful</code></pre> 12396 <h2 id="command-line-syntax">Command line syntax</h2> 12397 <pre><code>$ rclone bisync --help 12398 Usage: 12399 rclone bisync remote1:path1 remote2:path2 [flags] 12400 12401 Positional arguments: 12402 Path1, Path2 Local path, or remote storage with ':' plus optional path. 12403 Type 'rclone listremotes' for list of configured remotes. 12404 12405 Optional Flags: 12406 --backup-dir1 string --backup-dir for Path1. Must be a non-overlapping path on the same remote. 12407 --backup-dir2 string --backup-dir for Path2. Must be a non-overlapping path on the same remote. 12408 --check-access Ensure expected RCLONE_TEST files are found on both Path1 and Path2 filesystems, else abort. 12409 --check-filename string Filename for --check-access (default: RCLONE_TEST) 12410 --check-sync string Controls comparison of final listings: true|false|only (default: true) (default "true") 12411 --compare string Comma-separated list of bisync-specific compare options ex. 'size,modtime,checksum' (default: 'size,modtime') 12412 --conflict-loser ConflictLoserAction Action to take on the loser of a sync conflict (when there is a winner) or on both files (when there is no winner): , num, pathname, delete (default: num) 12413 --conflict-resolve string Automatically resolve conflicts by preferring the version that is: none, path1, path2, newer, older, larger, smaller (default: none) (default "none") 12414 --conflict-suffix string Suffix to use when renaming a --conflict-loser. Can be either one string or two comma-separated strings to assign different suffixes to Path1/Path2. (default: 'conflict') 12415 --create-empty-src-dirs Sync creation and deletion of empty directories. (Not compatible with --remove-empty-dirs) 12416 --download-hash Compute hash by downloading when otherwise unavailable. (warning: may be slow and use lots of data!) 12417 --filters-file string Read filtering patterns from a file 12418 --force Bypass --max-delete safety check and run the sync. Consider using with --verbose 12419 -h, --help help for bisync 12420 --ignore-listing-checksum Do not use checksums for listings (add --ignore-checksum to additionally skip post-copy checksum checks) 12421 --max-lock Duration Consider lock files older than this to be expired (default: 0 (never expire)) (minimum: 2m) (default 0s) 12422 --no-cleanup Retain working files (useful for troubleshooting and testing). 12423 --no-slow-hash Ignore listing checksums only on backends where they are slow 12424 --recover Automatically recover from interruptions without requiring --resync. 12425 --remove-empty-dirs Remove ALL empty directories at the final cleanup step. 12426 --resilient Allow future runs to retry after certain less-serious errors, instead of requiring --resync. Use at your own risk! 12427 -1, --resync Performs the resync run. Equivalent to --resync-mode path1. Consider using --verbose or --dry-run first. 12428 --resync-mode string During resync, prefer the version that is: path1, path2, newer, older, larger, smaller (default: path1 if --resync, otherwise none for no resync.) (default "none") 12429 --retries int Retry operations this many times if they fail (requires --resilient). (default 3) 12430 --retries-sleep Duration Interval between retrying operations if they fail, e.g. 500ms, 60s, 5m (0 to disable) (default 0s) 12431 --slow-hash-sync-only Ignore slow checksums for listings and deltas, but still consider them during sync calls. 12432 --workdir string Use custom working dir - useful for testing. (default: {WORKDIR}) 12433 --max-delete PERCENT Safety check on maximum percentage of deleted files allowed. If exceeded, the bisync run will abort. (default: 50%) 12434 -n, --dry-run Go through the motions - No files are copied/deleted. 12435 -v, --verbose Increases logging verbosity. May be specified more than once for more details.</code></pre> 12436 <p>Arbitrary rclone flags may be specified on the <a href="https://rclone.org/commands/rclone_bisync/">bisync command line</a>, for example <code>rclone bisync ./testdir/path1/ gdrive:testdir/path2/ --drive-skip-gdocs -v -v --timeout 10s</code> Note that interactions of various rclone flags with bisync process flow has not been fully tested yet.</p> 12437 <h3 id="paths">Paths</h3> 12438 <p>Path1 and Path2 arguments may be references to any mix of local directory paths (absolute or relative), UNC paths (<code>//server/share/path</code>), Windows drive paths (with a drive letter and <code>:</code>) or configured <a href="https://rclone.org/docs/#syntax-of-remote-paths">remotes</a> with optional subdirectory paths. Cloud references are distinguished by having a <code>:</code> in the argument (see <a href="#windows">Windows support</a> below).</p> 12439 <p>Path1 and Path2 are treated equally, in that neither has priority for file changes (except during <a href="#resync"><code>--resync</code></a>), and access efficiency does not change whether a remote is on Path1 or Path2.</p> 12440 <p>The listings in bisync working directory (default: <code>~/.cache/rclone/bisync</code>) are named based on the Path1 and Path2 arguments so that separate syncs to individual directories within the tree may be set up, e.g.: <code>path_to_local_tree..dropbox_subdir.lst</code>.</p> 12441 <p>Any empty directories after the sync on both the Path1 and Path2 filesystems are not deleted by default, unless <code>--create-empty-src-dirs</code> is specified. If the <code>--remove-empty-dirs</code> flag is specified, then both paths will have ALL empty directories purged as the last step in the process.</p> 12442 <h2 id="command-line-flags">Command-line flags</h2> 12443 <h3 id="resync">--resync</h3> 12444 <p>This will effectively make both Path1 and Path2 filesystems contain a matching superset of all files. By default, Path2 files that do not exist in Path1 will be copied to Path1, and the process will then copy the Path1 tree to Path2.</p> 12445 <p>The <code>--resync</code> sequence is roughly equivalent to the following (but see <a href="#resync-mode"><code>--resync-mode</code></a> for other options):</p> 12446 <pre><code>rclone copy Path2 Path1 --ignore-existing [--create-empty-src-dirs] 12447 rclone copy Path1 Path2 [--create-empty-src-dirs]</code></pre> 12448 <p>The base directories on both Path1 and Path2 filesystems must exist or bisync will fail. This is required for safety - that bisync can verify that both paths are valid.</p> 12449 <p>When using <code>--resync</code>, a newer version of a file on the Path2 filesystem will (by default) be overwritten by the Path1 filesystem version. (Note that this is <a href="https://github.com/rclone/rclone/issues/5681#issuecomment-938761815">NOT entirely symmetrical</a>, and more symmetrical options can be specified with the <a href="#resync-mode"><code>--resync-mode</code></a> flag.) Carefully evaluate deltas using <a href="https://rclone.org/flags/#non-backend-flags">--dry-run</a>.</p> 12450 <p>For a resync run, one of the paths may be empty (no files in the path tree). The resync run should result in files on both paths, else a normal non-resync run will fail.</p> 12451 <p>For a non-resync run, either path being empty (no files in the tree) fails with <code>Empty current PathN listing. Cannot sync to an empty directory: X.pathN.lst</code> This is a safety check that an unexpected empty path does not result in deleting <strong>everything</strong> in the other path.</p> 12452 <p>Note that <code>--resync</code> implies <code>--resync-mode path1</code> unless a different <a href="#resync-mode"><code>--resync-mode</code></a> is explicitly specified. It is not necessary to use both the <code>--resync</code> and <code>--resync-mode</code> flags -- either one is sufficient without the other.</p> 12453 <p><strong>Note:</strong> <code>--resync</code> (including <code>--resync-mode</code>) should only be used under three specific (rare) circumstances: 1. It is your <em>first</em> bisync run (between these two paths) 2. You've just made changes to your bisync settings (such as editing the contents of your <code>--filters-file</code>) 3. There was an error on the prior run, and as a result, bisync now requires <code>--resync</code> to recover</p> 12454 <p>The rest of the time, you should <em>omit</em> <code>--resync</code>. The reason is because <code>--resync</code> will only <em>copy</em> (not <em>sync</em>) each side to the other. Therefore, if you included <code>--resync</code> for every bisync run, it would never be possible to delete a file -- the deleted file would always keep reappearing at the end of every run (because it's being copied from the other side where it still exists). Similarly, renaming a file would always result in a duplicate copy (both old and new name) on both sides.</p> 12455 <p>If you find that frequent interruptions from #3 are an issue, rather than automatically running <code>--resync</code>, the recommended alternative is to use the <a href="#resilient"><code>--resilient</code></a>, <a href="#recover"><code>--recover</code></a>, and <a href="#conflict-resolve"><code>--conflict-resolve</code></a> flags, (along with <a href="#graceful-shutdown">Graceful Shutdown</a> mode, when needed) for a very robust "set-it-and-forget-it" bisync setup that can automatically bounce back from almost any interruption it might encounter. Consider adding something like the following:</p> 12456 <pre><code>--resilient --recover --max-lock 2m --conflict-resolve newer</code></pre> 12457 <h3 id="resync-mode">--resync-mode CHOICE</h3> 12458 <p>In the event that a file differs on both sides during a <code>--resync</code>, <code>--resync-mode</code> controls which version will overwrite the other. The supported options are similar to <a href="#conflict-resolve"><code>--conflict-resolve</code></a>. For all of the following options, the version that is kept is referred to as the "winner", and the version that is overwritten (deleted) is referred to as the "loser". The options are named after the "winner":</p> 12459 <ul> 12460 <li><code>path1</code> - (the default) - the version from Path1 is unconditionally considered the winner (regardless of <code>modtime</code> and <code>size</code>, if any). This can be useful if one side is more trusted or up-to-date than the other, at the time of the <code>--resync</code>.</li> 12461 <li><code>path2</code> - same as <code>path1</code>, except the path2 version is considered the winner.</li> 12462 <li><code>newer</code> - the newer file (by <code>modtime</code>) is considered the winner, regardless of which side it came from. This may result in having a mix of some winners from Path1, and some winners from Path2. (The implementation is analogous to running <code>rclone copy --update</code> in both directions.)</li> 12463 <li><code>older</code> - same as <code>newer</code>, except the older file is considered the winner, and the newer file is considered the loser.</li> 12464 <li><code>larger</code> - the larger file (by <code>size</code>) is considered the winner (regardless of <code>modtime</code>, if any). This can be a useful option for remotes without <code>modtime</code> support, or with the kinds of files (such as logs) that tend to grow but not shrink, over time.</li> 12465 <li><code>smaller</code> - the smaller file (by <code>size</code>) is considered the winner (regardless of <code>modtime</code>, if any).</li> 12466 </ul> 12467 <p>For all of the above options, note the following: - If either of the underlying remotes lacks support for the chosen method, it will be ignored and will fall back to the default of <code>path1</code>. (For example, if <code>--resync-mode newer</code> is set, but one of the paths uses a remote that doesn't support <code>modtime</code>.) - If a winner can't be determined because the chosen method's attribute is missing or equal, it will be ignored, and bisync will instead try to determine whether the files differ by looking at the other <code>--compare</code> methods in effect. (For example, if <code>--resync-mode newer</code> is set, but the Path1 and Path2 modtimes are identical, bisync will compare the sizes.) If bisync concludes that they differ, preference is given to whichever is the "source" at that moment. (In practice, this gives a slight advantage to Path2, as the 2to1 copy comes before the 1to2 copy.) If the files <em>do not</em> differ, nothing is copied (as both sides are already correct). - These options apply only to files that exist on both sides (with the same name and relative path). Files that exist <em>only</em> on one side and not the other are <em>always</em> copied to the other, during <code>--resync</code> (this is one of the main differences between resync and non-resync runs.). - <code>--conflict-resolve</code>, <code>--conflict-loser</code>, and <code>--conflict-suffix</code> do not apply during <code>--resync</code>, and unlike these flags, nothing is renamed during <code>--resync</code>. When a file differs on both sides during <code>--resync</code>, one version always overwrites the other (much like in <code>rclone copy</code>.) (Consider using <a href="#backup-dir1-and-backup-dir2"><code>--backup-dir</code></a> to retain a backup of the losing version.) - Unlike for <code>--conflict-resolve</code>, <code>--resync-mode none</code> is not a valid option (or rather, it will be interpreted as "no resync", unless <code>--resync</code> has also been specified, in which case it will be ignored.) - Winners and losers are decided at the individual file-level only (there is not currently an option to pick an entire winning directory atomically, although the <code>path1</code> and <code>path2</code> options typically produce a similar result.) - To maintain backward-compatibility, the <code>--resync</code> flag implies <code>--resync-mode path1</code> unless a different <code>--resync-mode</code> is explicitly specified. Similarly, all <code>--resync-mode</code> options (except <code>none</code>) imply <code>--resync</code>, so it is not necessary to use both the <code>--resync</code> and <code>--resync-mode</code> flags simultaneously -- either one is sufficient without the other.</p> 12468 <h3 id="check-access">--check-access</h3> 12469 <p>Access check files are an additional safety measure against data loss. bisync will ensure it can find matching <code>RCLONE_TEST</code> files in the same places in the Path1 and Path2 filesystems. <code>RCLONE_TEST</code> files are not generated automatically. For <code>--check-access</code> to succeed, you must first either: <strong>A)</strong> Place one or more <code>RCLONE_TEST</code> files in both systems, or <strong>B)</strong> Set <code>--check-filename</code> to a filename already in use in various locations throughout your sync'd fileset. Recommended methods for <strong>A)</strong> include: * <code>rclone touch Path1/RCLONE_TEST</code> (create a new file) * <code>rclone copyto Path1/RCLONE_TEST Path2/RCLONE_TEST</code> (copy an existing file) * <code>rclone copy Path1/RCLONE_TEST Path2/RCLONE_TEST --include "RCLONE_TEST"</code> (copy multiple files at once, recursively) * create the files manually (outside of rclone) * run <code>bisync</code> once <em>without</em> <code>--check-access</code> to set matching files on both filesystems will also work, but is not preferred, due to potential for user error (you are temporarily disabling the safety feature).</p> 12470 <p>Note that <code>--check-access</code> is still enforced on <code>--resync</code>, so <code>bisync --resync --check-access</code> will not work as a method of initially setting the files (this is to ensure that bisync can't <a href="https://forum.rclone.org/t/bisync-bugs-and-feature-requests/37636#:~:text=3.%20%2D%2Dcheck%2Daccess%20doesn%27t%20always%20fail%20when%20it%20should">inadvertently circumvent its own safety switch</a>.)</p> 12471 <p>Time stamps and file contents for <code>RCLONE_TEST</code> files are not important, just the names and locations. If you have symbolic links in your sync tree it is recommended to place <code>RCLONE_TEST</code> files in the linked-to directory tree to protect against bisync assuming a bunch of deleted files if the linked-to tree should not be accessible. See also the <a href="--check-filename">--check-filename</a> flag.</p> 12472 <h3 id="check-filename">--check-filename</h3> 12473 <p>Name of the file(s) used in access health validation. The default <code>--check-filename</code> is <code>RCLONE_TEST</code>. One or more files having this filename must exist, synchronized between your source and destination filesets, in order for <code>--check-access</code> to succeed. See <a href="#check-access">--check-access</a> for additional details.</p> 12474 <h3 id="compare">--compare</h3> 12475 <p>As of <code>v1.66</code>, bisync fully supports comparing based on any combination of size, modtime, and checksum (lifting the prior restriction on backends without modtime support.)</p> 12476 <p>By default (without the <code>--compare</code> flag), bisync inherits the same comparison options as <code>sync</code> (that is: <code>size</code> and <code>modtime</code> by default, unless modified with flags such as <a href="https://rclone.org/docs/#c-checksum"><code>--checksum</code></a> or <a href="/docs/#size-only"><code>--size-only</code></a>.)</p> 12477 <p>If the <code>--compare</code> flag is set, it will override these defaults. This can be useful if you wish to compare based on combinations not currently supported in <code>sync</code>, such as comparing all three of <code>size</code> AND <code>modtime</code> AND <code>checksum</code> simultaneously (or just <code>modtime</code> AND <code>checksum</code>).</p> 12478 <p><code>--compare</code> takes a comma-separated list, with the currently supported values being <code>size</code>, <code>modtime</code>, and <code>checksum</code>. For example, if you want to compare size and checksum, but not modtime, you would do:</p> 12479 <pre><code>--compare size,checksum</code></pre> 12480 <p>Or if you want to compare all three:</p> 12481 <pre><code>--compare size,modtime,checksum</code></pre> 12482 <p><code>--compare</code> overrides any conflicting flags. For example, if you set the conflicting flags <code>--compare checksum --size-only</code>, <code>--size-only</code> will be ignored, and bisync will compare checksum and not size. To avoid confusion, it is recommended to use <em>either</em> <code>--compare</code> or the normal <code>sync</code> flags, but not both.</p> 12483 <p>If <code>--compare</code> includes <code>checksum</code> and both remotes support checksums but have no hash types in common with each other, checksums will be considered <em>only</em> for comparisons within the same side (to determine what has changed since the prior sync), but not for comparisons against the opposite side. If one side supports checksums and the other does not, checksums will only be considered on the side that supports them.</p> 12484 <p>When comparing with <code>checksum</code> and/or <code>size</code> without <code>modtime</code>, bisync cannot determine whether a file is <code>newer</code> or <code>older</code> -- only whether it is <code>changed</code> or <code>unchanged</code>. (If it is <code>changed</code> on both sides, bisync still does the standard equality-check to avoid declaring a sync conflict unless it absolutely has to.)</p> 12485 <p>It is recommended to do a <code>--resync</code> when changing <code>--compare</code> settings, as otherwise your prior listing files may not contain the attributes you wish to compare (for example, they will not have stored checksums if you were not previously comparing checksums.)</p> 12486 <h3 id="ignore-listing-checksum">--ignore-listing-checksum</h3> 12487 <p>When <code>--checksum</code> or <code>--compare checksum</code> is set, bisync will retrieve (or generate) checksums (for backends that support them) when creating the listings for both paths, and store the checksums in the listing files. <code>--ignore-listing-checksum</code> will disable this behavior, which may speed things up considerably, especially on backends (such as <a href="https://rclone.org/local/">local</a>) where hashes must be computed on the fly instead of retrieved. Please note the following:</p> 12488 <ul> 12489 <li>As of <code>v1.66</code>, <code>--ignore-listing-checksum</code> is now automatically set when neither <code>--checksum</code> nor <code>--compare checksum</code> are in use (as the checksums would not be used for anything.)</li> 12490 <li><code>--ignore-listing-checksum</code> is NOT the same as <a href="https://rclone.org/docs/#ignore-checksum"><code>--ignore-checksum</code></a>, and you may wish to use one or the other, or both. In a nutshell: <code>--ignore-listing-checksum</code> controls whether checksums are considered when scanning for diffs, while <code>--ignore-checksum</code> controls whether checksums are considered during the copy/sync operations that follow, if there ARE diffs.</li> 12491 <li>Unless <code>--ignore-listing-checksum</code> is passed, bisync currently computes hashes for one path <em>even when there's no common hash with the other path</em> (for example, a <a href="https://rclone.org/crypt/#modification-times-and-hashes">crypt</a> remote.) This can still be beneficial, as the hashes will still be used to detect changes within the same side (if <code>--checksum</code> or <code>--compare checksum</code> is set), even if they can't be used to compare against the opposite side.</li> 12492 <li>If you wish to ignore listing checksums <em>only</em> on remotes where they are slow to compute, consider using <a href="#no-slow-hash"><code>--no-slow-hash</code></a> (or <a href="#slow-hash-sync-only"><code>--slow-hash-sync-only</code></a>) instead of <code>--ignore-listing-checksum</code>.</li> 12493 <li>If <code>--ignore-listing-checksum</code> is used simultaneously with <code>--compare checksum</code> (or <code>--checksum</code>), checksums will be ignored for bisync deltas, but still considered during the sync operations that follow (if deltas are detected based on modtime and/or size.)</li> 12494 </ul> 12495 <h3 id="no-slow-hash">--no-slow-hash</h3> 12496 <p>On some remotes (notably <code>local</code>), checksums can dramatically slow down a bisync run, because hashes cannot be stored and need to be computed in real-time when they are requested. On other remotes (such as <code>drive</code>), they add practically no time at all. The <code>--no-slow-hash</code> flag will automatically skip checksums on remotes where they are slow, while still comparing them on others (assuming <a href="#compare"><code>--compare</code></a> includes <code>checksum</code>.) This can be useful when one of your bisync paths is slow but you still want to check checksums on the other, for a more robust sync.</p> 12497 <h3 id="slow-hash-sync-only">--slow-hash-sync-only</h3> 12498 <p>Same as <a href="#no-slow-hash"><code>--no-slow-hash</code></a>, except slow hashes are still considered during sync calls. They are still NOT considered for determining deltas, nor or they included in listings. They are also skipped during <code>--resync</code>. The main use case for this flag is when you have a large number of files, but relatively few of them change from run to run -- so you don't want to check your entire tree every time (it would take too long), but you still want to consider checksums for the smaller group of files for which a <code>modtime</code> or <code>size</code> change was detected. Keep in mind that this speed savings comes with a safety trade-off: if a file's content were to change without a change to its <code>modtime</code> or <code>size</code>, bisync would not detect it, and it would not be synced.</p> 12499 <p><code>--slow-hash-sync-only</code> is only useful if both remotes share a common hash type (if they don't, bisync will automatically fall back to <code>--no-slow-hash</code>.) Both <code>--no-slow-hash</code> and <code>--slow-hash-sync-only</code> have no effect without <code>--compare checksum</code> (or <code>--checksum</code>).</p> 12500 <h3 id="download-hash">--download-hash</h3> 12501 <p>If <code>--download-hash</code> is set, bisync will use best efforts to obtain an MD5 checksum by downloading and computing on-the-fly, when checksums are not otherwise available (for example, a remote that doesn't support them.) Note that since rclone has to download the entire file, this may dramatically slow down your bisync runs, and is also likely to use a lot of data, so it is probably not practical for bisync paths with a large total file size. However, it can be a good option for syncing small-but-important files with maximum accuracy (for example, a source code repo on a <code>crypt</code> remote.) An additional advantage over methods like <a href="https://rclone.org/commands/rclone_cryptcheck/"><code>cryptcheck</code></a> is that the original file is not required for comparison (for example, <code>--download-hash</code> can be used to bisync two different crypt remotes with different passwords.)</p> 12502 <p>When <code>--download-hash</code> is set, bisync still looks for more efficient checksums first, and falls back to downloading only when none are found. It takes priority over conflicting flags such as <code>--no-slow-hash</code>. <code>--download-hash</code> is not suitable for <a href="#gdocs">Google Docs</a> and other files of unknown size, as their checksums would change from run to run (due to small variances in the internals of the generated export file.) Therefore, bisync automatically skips <code>--download-hash</code> for files with a size less than 0.</p> 12503 <p>See also: <a href="https://rclone.org/hasher/"><code>Hasher</code></a> backend, <a href="https://rclone.org/commands/rclone_cryptcheck/"><code>cryptcheck</code></a> command, <a href="https://rclone.org/commands/rclone_check/"><code>rclone check --download</code></a> option, <a href="https://rclone.org/commands/rclone_md5sum/"><code>md5sum</code></a> command</p> 12504 <h3 id="max-delete">--max-delete</h3> 12505 <p>As a safety check, if greater than the <code>--max-delete</code> percent of files were deleted on either the Path1 or Path2 filesystem, then bisync will abort with a warning message, without making any changes. The default <code>--max-delete</code> is <code>50%</code>. One way to trigger this limit is to rename a directory that contains more than half of your files. This will appear to bisync as a bunch of deleted files and a bunch of new files. This safety check is intended to block bisync from deleting all of the files on both filesystems due to a temporary network access issue, or if the user had inadvertently deleted the files on one side or the other. To force the sync, either set a different delete percentage limit, e.g. <code>--max-delete 75</code> (allows up to 75% deletion), or use <code>--force</code> to bypass the check.</p> 12506 <p>Also see the <a href="#all-files-changed">all files changed</a> check.</p> 12507 <h3 id="filters-file">--filters-file</h3> 12508 <p>By using rclone filter features you can exclude file types or directory sub-trees from the sync. See the <a href="#filtering">bisync filters</a> section and generic <a href="https://rclone.org/filtering/#filter-from-read-filtering-patterns-from-a-file">--filter-from</a> documentation. An <a href="#example-filters-file">example filters file</a> contains filters for non-allowed files for synching with Dropbox.</p> 12509 <p>If you make changes to your filters file then bisync requires a run with <code>--resync</code>. This is a safety feature, which prevents existing files on the Path1 and/or Path2 side from seeming to disappear from view (since they are excluded in the new listings), which would fool bisync into seeing them as deleted (as compared to the prior run listings), and then bisync would proceed to delete them for real.</p> 12510 <p>To block this from happening, bisync calculates an MD5 hash of the filters file and stores the hash in a <code>.md5</code> file in the same place as your filters file. On the next run with <code>--filters-file</code> set, bisync re-calculates the MD5 hash of the current filters file and compares it to the hash stored in the <code>.md5</code> file. If they don't match, the run aborts with a critical error and thus forces you to do a <code>--resync</code>, likely avoiding a disaster.</p> 12511 <h3 id="conflict-resolve">--conflict-resolve CHOICE</h3> 12512 <p>In bisync, a "conflict" is a file that is <em>new</em> or <em>changed</em> on <em>both sides</em> (relative to the prior run) AND is <em>not currently identical</em> on both sides. <code>--conflict-resolve</code> controls how bisync handles such a scenario. The currently supported options are:</p> 12513 <ul> 12514 <li><code>none</code> - (the default) - do not attempt to pick a winner, keep and rename both files according to <a href="#conflict-loser"><code>--conflict-loser</code></a> and <a href="#conflict-suffix"><code>--conflict-suffix</code></a> settings. For example, with the default settings, <code>file.txt</code> on Path1 is renamed <code>file.txt.conflict1</code> and <code>file.txt</code> on Path2 is renamed <code>file.txt.conflict2</code>. Both are copied to the opposite path during the run, so both sides end up with a copy of both files. (As <code>none</code> is the default, it is not necessary to specify <code>--conflict-resolve none</code> -- you can just omit the flag.)</li> 12515 <li><code>newer</code> - the newer file (by <code>modtime</code>) is considered the winner and is copied without renaming. The older file (the "loser") is handled according to <code>--conflict-loser</code> and <code>--conflict-suffix</code> settings (either renamed or deleted.) For example, if <code>file.txt</code> on Path1 is newer than <code>file.txt</code> on Path2, the result on both sides (with other default settings) will be <code>file.txt</code> (winner from Path1) and <code>file.txt.conflict1</code> (loser from Path2).</li> 12516 <li><code>older</code> - same as <code>newer</code>, except the older file is considered the winner, and the newer file is considered the loser.</li> 12517 <li><code>larger</code> - the larger file (by <code>size</code>) is considered the winner (regardless of <code>modtime</code>, if any).</li> 12518 <li><code>smaller</code> - the smaller file (by <code>size</code>) is considered the winner (regardless of <code>modtime</code>, if any).</li> 12519 <li><code>path1</code> - the version from Path1 is unconditionally considered the winner (regardless of <code>modtime</code> and <code>size</code>, if any). This can be useful if one side is usually more trusted or up-to-date than the other.</li> 12520 <li><code>path2</code> - same as <code>path1</code>, except the path2 version is considered the winner.</li> 12521 </ul> 12522 <p>For all of the above options, note the following: - If either of the underlying remotes lacks support for the chosen method, it will be ignored and fall back to <code>none</code>. (For example, if <code>--conflict-resolve newer</code> is set, but one of the paths uses a remote that doesn't support <code>modtime</code>.) - If a winner can't be determined because the chosen method's attribute is missing or equal, it will be ignored and fall back to <code>none</code>. (For example, if <code>--conflict-resolve newer</code> is set, but the Path1 and Path2 modtimes are identical, even if the sizes may differ.) - If the file's content is currently identical on both sides, it is not considered a "conflict", even if new or changed on both sides since the prior sync. (For example, if you made a change on one side and then synced it to the other side by other means.) Therefore, none of the conflict resolution flags apply in this scenario. - The conflict resolution flags do not apply during a <code>--resync</code>, as there is no "prior run" to speak of (but see <a href="#resync-mode"><code>--resync-mode</code></a> for similar options.)</p> 12523 <h3 id="conflict-loser">--conflict-loser CHOICE</h3> 12524 <p><code>--conflict-loser</code> determines what happens to the "loser" of a sync conflict (when <a href="#conflict-resolve"><code>--conflict-resolve</code></a> determines a winner) or to both files (when there is no winner.) The currently supported options are:</p> 12525 <ul> 12526 <li><code>num</code> - (the default) - auto-number the conflicts by automatically appending the next available number to the <code>--conflict-suffix</code>, in chronological order. For example, with the default settings, the first conflict for <code>file.txt</code> will be renamed <code>file.txt.conflict1</code>. If <code>file.txt.conflict1</code> already exists, <code>file.txt.conflict2</code> will be used instead (etc., up to a maximum of 9223372036854775807 conflicts.)</li> 12527 <li><code>pathname</code> - rename the conflicts according to which side they came from, which was the default behavior prior to <code>v1.66</code>. For example, with <code>--conflict-suffix path</code>, <code>file.txt</code> from Path1 will be renamed <code>file.txt.path1</code>, and <code>file.txt</code> from Path2 will be renamed <code>file.txt.path2</code>. If two non-identical suffixes are provided (ex. <code>--conflict-suffix cloud,local</code>), the trailing digit is omitted. Importantly, note that with <code>pathname</code>, there is no auto-numbering beyond <code>2</code>, so if <code>file.txt.path2</code> somehow already exists, it will be overwritten. Using a dynamic date variable in your <code>--conflict-suffix</code> (see below) is one possible way to avoid this. Note also that conflicts-of-conflicts are possible, if the original conflict is not manually resolved -- for example, if for some reason you edited <code>file.txt.path1</code> on both sides, and those edits were different, the result would be <code>file.txt.path1.path1</code> and <code>file.txt.path1.path2</code> (in addition to <code>file.txt.path2</code>.)</li> 12528 <li><code>delete</code> - keep the winner only and delete the loser, instead of renaming it. If a winner cannot be determined (see <code>--conflict-resolve</code> for details on how this could happen), <code>delete</code> is ignored and the default <code>num</code> is used instead (i.e. both versions are kept and renamed, and neither is deleted.) <code>delete</code> is inherently the most destructive option, so use it only with care.</li> 12529 </ul> 12530 <p>For all of the above options, note that if a winner cannot be determined (see <code>--conflict-resolve</code> for details on how this could happen), or if <code>--conflict-resolve</code> is not in use, <em>both</em> files will be renamed.</p> 12531 <h3 id="conflict-suffix">--conflict-suffix STRING[,STRING]</h3> 12532 <p><code>--conflict-suffix</code> controls the suffix that is appended when bisync renames a <a href="#conflict-loser"><code>--conflict-loser</code></a> (default: <code>conflict</code>). <code>--conflict-suffix</code> will accept either one string or two comma-separated strings to assign different suffixes to Path1 vs. Path2. This may be helpful later in identifying the source of the conflict. (For example, <code>--conflict-suffix dropboxconflict,laptopconflict</code>)</p> 12533 <p>With <code>--conflict-loser num</code>, a number is always appended to the suffix. With <code>--conflict-loser pathname</code>, a number is appended only when one suffix is specified (or when two identical suffixes are specified.) i.e. with <code>--conflict-loser pathname</code>, all of the following would produce exactly the same result:</p> 12534 <pre><code>--conflict-suffix path 12535 --conflict-suffix path,path 12536 --conflict-suffix path1,path2</code></pre> 12537 <p>Suffixes may be as short as 1 character. By default, the suffix is appended after any other extensions (ex. <code>file.jpg.conflict1</code>), however, this can be changed with the <a href="https://rclone.org/docs/#suffix-keep-extension"><code>--suffix-keep-extension</code></a> flag (i.e. to instead result in <code>file.conflict1.jpg</code>).</p> 12538 <p><code>--conflict-suffix</code> supports several <em>dynamic date variables</em> when enclosed in curly braces as globs. This can be helpful to track the date and/or time that each conflict was handled by bisync. For example:</p> 12539 <pre><code>--conflict-suffix {DateOnly}-conflict 12540 // result: myfile.txt.2006-01-02-conflict1</code></pre> 12541 <p>All of the formats described <a href="https://pkg.go.dev/time#pkg-constants">here</a> and <a href="https://pkg.go.dev/time#example-Time.Format">here</a> are supported, but take care to ensure that your chosen format does not use any characters that are illegal on your remotes (for example, macOS does not allow colons in filenames, and slashes are also best avoided as they are often interpreted as directory separators.) To address this particular issue, an additional <code>{MacFriendlyTime}</code> (or just <code>{mac}</code>) option is supported, which results in <code>2006-01-02 0304PM</code>.</p> 12542 <p>Note that <code>--conflict-suffix</code> is entirely separate from rclone's main <a href="https://rclone.org/docs/#suffix-suffix"><code>--sufix</code></a> flag. This is intentional, as users may wish to use both flags simultaneously, if also using <a href="#backup-dir1-and-backup-dir2"><code>--backup-dir</code></a>.</p> 12543 <p>Finally, note that the default in bisync prior to <code>v1.66</code> was to rename conflicts with <code>..path1</code> and <code>..path2</code> (with two periods, and <code>path</code> instead of <code>conflict</code>.) Bisync now defaults to a single dot instead of a double dot, but additional dots can be added by including them in the specified suffix string. For example, for behavior equivalent to the previous default, use:</p> 12544 <pre><code>[--conflict-resolve none] --conflict-loser pathname --conflict-suffix .path</code></pre> 12545 <h3 id="check-sync">--check-sync</h3> 12546 <p>Enabled by default, the check-sync function checks that all of the same files exist in both the Path1 and Path2 history listings. This <em>check-sync</em> integrity check is performed at the end of the sync run by default. Any untrapped failing copy/deletes between the two paths might result in differences between the two listings and in the untracked file content differences between the two paths. A resync run would correct the error.</p> 12547 <p>Note that the default-enabled integrity check locally executes a load of both the final Path1 and Path2 listings, and thus adds to the run time of a sync. Using <code>--check-sync=false</code> will disable it and may significantly reduce the sync run times for very large numbers of files.</p> 12548 <p>The check may be run manually with <code>--check-sync=only</code>. It runs only the integrity check and terminates without actually synching.</p> 12549 <p>Note that currently, <code>--check-sync</code> <strong>only checks listing snapshots and NOT the actual files on the remotes.</strong> Note also that the listing snapshots will not know about any changes that happened during or after the latest bisync run, as those will be discovered on the next run. Therefore, while listings should always match <em>each other</em> at the end of a bisync run, it is <em>expected</em> that they will not match the underlying remotes, nor will the remotes match each other, if there were changes during or after the run. This is normal, and any differences will be detected and synced on the next run.</p> 12550 <p>For a robust integrity check of the current state of the remotes (as opposed to just their listing snapshots), consider using <a href="commands/rclone_check/"><code>check</code></a> (or <a href="https://rclone.org/commands/rclone_cryptcheck/"><code>cryptcheck</code></a>, if at least one path is a <code>crypt</code> remote) instead of <code>--check-sync</code>, keeping in mind that differences are expected if files changed during or after your last bisync run.</p> 12551 <p>For example, a possible sequence could look like this:</p> 12552 <ol type="1"> 12553 <li>Normally scheduled bisync run:</li> 12554 </ol> 12555 <pre><code>rclone bisync Path1 Path2 -MPc --check-access --max-delete 10 --filters-file /path/to/filters.txt -v --no-cleanup --ignore-listing-checksum --disable ListR --checkers=16 --drive-pacer-min-sleep=10ms --create-empty-src-dirs --resilient</code></pre> 12556 <ol start="2" type="1"> 12557 <li>Periodic independent integrity check (perhaps scheduled nightly or weekly):</li> 12558 </ol> 12559 <pre><code>rclone check -MvPc Path1 Path2 --filter-from /path/to/filters.txt</code></pre> 12560 <ol start="3" type="1"> 12561 <li>If diffs are found, you have some choices to correct them. If one side is more up-to-date and you want to make the other side match it, you could run:</li> 12562 </ol> 12563 <pre><code>rclone sync Path1 Path2 --filter-from /path/to/filters.txt --create-empty-src-dirs -MPc -v</code></pre> 12564 <p>(or switch Path1 and Path2 to make Path2 the source-of-truth)</p> 12565 <p>Or, if neither side is totally up-to-date, you could run a <code>--resync</code> to bring them back into agreement (but remember that this could cause deleted files to re-appear.)</p> 12566 <p>*Note also that <code>rclone check</code> does not currently include empty directories, so if you want to know if any empty directories are out of sync, consider alternatively running the above <code>rclone sync</code> command with <code>--dry-run</code> added.</p> 12567 <p>See also: <a href="#concurrent-modifications">Concurrent modifications</a>, <a href="#resilient"><code>--resilient</code></a></p> 12568 <h3 id="resilient">--resilient</h3> 12569 <p><strong><em>Caution: this is an experimental feature. Use at your own risk!</em></strong></p> 12570 <p>By default, most errors or interruptions will cause bisync to abort and require <a href="#resync"><code>--resync</code></a> to recover. This is a safety feature, to prevent bisync from running again until a user checks things out. However, in some cases, bisync can go too far and enforce a lockout when one isn't actually necessary, like for certain less-serious errors that might resolve themselves on the next run. When <code>--resilient</code> is specified, bisync tries its best to recover and self-correct, and only requires <code>--resync</code> as a last resort when a human's involvement is absolutely necessary. The intended use case is for running bisync as a background process (such as via scheduled <a href="#cron">cron</a>).</p> 12571 <p>When using <code>--resilient</code> mode, bisync will still report the error and abort, however it will not lock out future runs -- allowing the possibility of retrying at the next normally scheduled time, without requiring a <code>--resync</code> first. Examples of such retryable errors include access test failures, missing listing files, and filter change detections. These safety features will still prevent the <em>current</em> run from proceeding -- the difference is that if conditions have improved by the time of the <em>next</em> run, that next run will be allowed to proceed. Certain more serious errors will still enforce a <code>--resync</code> lockout, even in <code>--resilient</code> mode, to prevent data loss.</p> 12572 <p>Behavior of <code>--resilient</code> may change in a future version. (See also: <a href="#recover"><code>--recover</code></a>, <a href="#max-lock"><code>--max-lock</code></a>, <a href="#graceful-shutdown">Graceful Shutdown</a>)</p> 12573 <h3 id="recover">--recover</h3> 12574 <p>If <code>--recover</code> is set, in the event of a sudden interruption or other un-graceful shutdown, bisync will attempt to automatically recover on the next run, instead of requiring <code>--resync</code>. Bisync is able to recover robustly by keeping one "backup" listing at all times, representing the state of both paths after the last known successful sync. Bisync can then compare the current state with this snapshot to determine which changes it needs to retry. Changes that were synced after this snapshot (during the run that was later interrupted) will appear to bisync as if they are "new or changed on both sides", but in most cases this is not a problem, as bisync will simply do its usual "equality check" and learn that no action needs to be taken on these files, since they are already identical on both sides.</p> 12575 <p>In the rare event that a file is synced successfully during a run that later aborts, and then that same file changes AGAIN before the next run, bisync will think it is a sync conflict, and handle it accordingly. (From bisync's perspective, the file has changed on both sides since the last trusted sync, and the files on either side are not currently identical.) Therefore, <code>--recover</code> carries with it a slightly increased chance of having conflicts -- though in practice this is pretty rare, as the conditions required to cause it are quite specific. This risk can be reduced by using bisync's <a href="#graceful-shutdown">"Graceful Shutdown"</a> mode (triggered by sending <code>SIGINT</code> or <code>Ctrl+C</code>), when you have the choice, instead of forcing a sudden termination.</p> 12576 <p><code>--recover</code> and <code>--resilient</code> are similar, but distinct -- the main difference is that <code>--resilient</code> is about <em>retrying</em>, while <code>--recover</code> is about <em>recovering</em>. Most users will probably want both. <code>--resilient</code> allows retrying when bisync has chosen to abort itself due to safety features such as failing <code>--check-access</code> or detecting a filter change. <code>--resilient</code> does not cover external interruptions such as a user shutting down their computer in the middle of a sync -- that is what <code>--recover</code> is for.</p> 12577 <h3 id="max-lock">--max-lock</h3> 12578 <p>Bisync uses <a href="#lock-file">lock files</a> as a safety feature to prevent interference from other bisync runs while it is running. Bisync normally removes these lock files at the end of a run, but if bisync is abruptly interrupted, these files will be left behind. By default, they will lock out all future runs, until the user has a chance to manually check things out and remove the lock. As an alternative, <code>--max-lock</code> can be used to make them automatically expire after a certain period of time, so that future runs are not locked out forever, and auto-recovery is possible. <code>--max-lock</code> can be any duration <code>2m</code> or greater (or <code>0</code> to disable). If set, lock files older than this will be considered "expired", and future runs will be allowed to disregard them and proceed. (Note that the <code>--max-lock</code> duration must be set by the process that left the lock file -- not the later one interpreting it.)</p> 12579 <p>If set, bisync will also "renew" these lock files every <code>--max-lock minus one minute</code> throughout a run, for extra safety. (For example, with <code>--max-lock 5m</code>, bisync would renew the lock file (for another 5 minutes) every 4 minutes until the run has completed.) In other words, it should not be possible for a lock file to pass its expiration time while the process that created it is still running -- and you can therefore be reasonably sure that any <em>expired</em> lock file you may find was left there by an interrupted run, not one that is still running and just taking awhile.</p> 12580 <p>If <code>--max-lock</code> is <code>0</code> or not set, the default is that lock files will never expire, and will block future runs (of these same two bisync paths) indefinitely.</p> 12581 <p>For maximum resilience from disruptions, consider setting a relatively short duration like <code>--max-lock 2m</code> along with <a href="#resilient"><code>--resilient</code></a> and <a href="#recover"><code>--recover</code></a>, and a relatively frequent <a href="#cron">cron schedule</a>. The result will be a very robust "set-it-and-forget-it" bisync run that can automatically bounce back from almost any interruption it might encounter, without requiring the user to get involved and run a <code>--resync</code>. (See also: <a href="#graceful-shutdown">Graceful Shutdown</a> mode)</p> 12582 <h3 id="backup-dir1-and---backup-dir2">--backup-dir1 and --backup-dir2</h3> 12583 <p>As of <code>v1.66</code>, <a href="https://rclone.org/docs/#backup-dir-dir"><code>--backup-dir</code></a> is supported in bisync. Because <code>--backup-dir</code> must be a non-overlapping path on the same remote, Bisync has introduced new <code>--backup-dir1</code> and <code>--backup-dir2</code> flags to support separate backup-dirs for <code>Path1</code> and <code>Path2</code> (bisyncing between different remotes with <code>--backup-dir</code> would not otherwise be possible.) <code>--backup-dir1</code> and <code>--backup-dir2</code> can use different remotes from each other, but <code>--backup-dir1</code> must use the same remote as <code>Path1</code>, and <code>--backup-dir2</code> must use the same remote as <code>Path2</code>. Each backup directory must not overlap its respective bisync Path without being excluded by a filter rule.</p> 12584 <p>The standard <code>--backup-dir</code> will also work, if both paths use the same remote (but note that deleted files from both paths would be mixed together in the same dir). If either <code>--backup-dir1</code> and <code>--backup-dir2</code> are set, they will override <code>--backup-dir</code>.</p> 12585 <p>Example:</p> 12586 <pre><code>rclone bisync /Users/someuser/some/local/path/Bisync gdrive:Bisync --backup-dir1 /Users/someuser/some/local/path/BackupDir --backup-dir2 gdrive:BackupDir --suffix -2023-08-26 --suffix-keep-extension --check-access --max-delete 10 --filters-file /Users/someuser/some/local/path/bisync_filters.txt --no-cleanup --ignore-listing-checksum --checkers=16 --drive-pacer-min-sleep=10ms --create-empty-src-dirs --resilient -MvP --drive-skip-gdocs --fix-case</code></pre> 12587 <p>In this example, if the user deletes a file in <code>/Users/someuser/some/local/path/Bisync</code>, bisync will propagate the delete to the other side by moving the corresponding file from <code>gdrive:Bisync</code> to <code>gdrive:BackupDir</code>. If the user deletes a file from <code>gdrive:Bisync</code>, bisync moves it from <code>/Users/someuser/some/local/path/Bisync</code> to <code>/Users/someuser/some/local/path/BackupDir</code>.</p> 12588 <p>In the event of a <a href="#conflict-loser">rename due to a sync conflict</a>, the rename is not considered a delete, unless a previous conflict with the same name already exists and would get overwritten.</p> 12589 <p>See also: <a href="https://rclone.org/docs/#suffix-suffix"><code>--suffix</code></a>, <a href="https://rclone.org/docs/#suffix-keep-extension"><code>--suffix-keep-extension</code></a></p> 12590 <h2 id="operation">Operation</h2> 12591 <h3 id="runtime-flow-details">Runtime flow details</h3> 12592 <p>bisync retains the listings of the <code>Path1</code> and <code>Path2</code> filesystems from the prior run. On each successive run it will:</p> 12593 <ul> 12594 <li>list files on <code>path1</code> and <code>path2</code>, and check for changes on each side. Changes include <code>New</code>, <code>Newer</code>, <code>Older</code>, and <code>Deleted</code> files.</li> 12595 <li>Propagate changes on <code>path1</code> to <code>path2</code>, and vice-versa.</li> 12596 </ul> 12597 <h3 id="safety-measures">Safety measures</h3> 12598 <ul> 12599 <li>Lock file prevents multiple simultaneous runs when taking a while. This can be particularly useful if bisync is run by cron scheduler.</li> 12600 <li>Handle change conflicts non-destructively by creating <code>.conflict1</code>, <code>.conflict2</code>, etc. file versions, according to <a href="#conflict-resolve"><code>--conflict-resolve</code></a>, <a href="#conflict-loser"><code>--conflict-loser</code></a>, and <a href="#conflict-suffix"><code>--conflict-suffix</code></a> settings.</li> 12601 <li>File system access health check using <code>RCLONE_TEST</code> files (see the <code>--check-access</code> flag).</li> 12602 <li>Abort on excessive deletes - protects against a failed listing being interpreted as all the files were deleted. See the <code>--max-delete</code> and <code>--force</code> flags.</li> 12603 <li>If something evil happens, bisync goes into a safe state to block damage by later runs. (See <a href="#error-handling">Error Handling</a>)</li> 12604 </ul> 12605 <h3 id="normal-sync-checks">Normal sync checks</h3> 12606 <table> 12607 <colgroup> 12608 <col style="width: 12%" /> 12609 <col style="width: 40%" /> 12610 <col style="width: 22%" /> 12611 <col style="width: 25%" /> 12612 </colgroup> 12613 <thead> 12614 <tr class="header"> 12615 <th>Type</th> 12616 <th>Description</th> 12617 <th>Result</th> 12618 <th>Implementation</th> 12619 </tr> 12620 </thead> 12621 <tbody> 12622 <tr class="odd"> 12623 <td>Path2 new</td> 12624 <td>File is new on Path2, does not exist on Path1</td> 12625 <td>Path2 version survives</td> 12626 <td><code>rclone copy</code> Path2 to Path1</td> 12627 </tr> 12628 <tr class="even"> 12629 <td>Path2 newer</td> 12630 <td>File is newer on Path2, unchanged on Path1</td> 12631 <td>Path2 version survives</td> 12632 <td><code>rclone copy</code> Path2 to Path1</td> 12633 </tr> 12634 <tr class="odd"> 12635 <td>Path2 deleted</td> 12636 <td>File is deleted on Path2, unchanged on Path1</td> 12637 <td>File is deleted</td> 12638 <td><code>rclone delete</code> Path1</td> 12639 </tr> 12640 <tr class="even"> 12641 <td>Path1 new</td> 12642 <td>File is new on Path1, does not exist on Path2</td> 12643 <td>Path1 version survives</td> 12644 <td><code>rclone copy</code> Path1 to Path2</td> 12645 </tr> 12646 <tr class="odd"> 12647 <td>Path1 newer</td> 12648 <td>File is newer on Path1, unchanged on Path2</td> 12649 <td>Path1 version survives</td> 12650 <td><code>rclone copy</code> Path1 to Path2</td> 12651 </tr> 12652 <tr class="even"> 12653 <td>Path1 older</td> 12654 <td>File is older on Path1, unchanged on Path2</td> 12655 <td><em>Path1 version survives</em></td> 12656 <td><code>rclone copy</code> Path1 to Path2</td> 12657 </tr> 12658 <tr class="odd"> 12659 <td>Path2 older</td> 12660 <td>File is older on Path2, unchanged on Path1</td> 12661 <td><em>Path2 version survives</em></td> 12662 <td><code>rclone copy</code> Path2 to Path1</td> 12663 </tr> 12664 <tr class="even"> 12665 <td>Path1 deleted</td> 12666 <td>File no longer exists on Path1</td> 12667 <td>File is deleted</td> 12668 <td><code>rclone delete</code> Path2</td> 12669 </tr> 12670 </tbody> 12671 </table> 12672 <h3 id="unusual-sync-checks">Unusual sync checks</h3> 12673 <table> 12674 <colgroup> 12675 <col style="width: 24%" /> 12676 <col style="width: 30%" /> 12677 <col style="width: 27%" /> 12678 <col style="width: 17%" /> 12679 </colgroup> 12680 <thead> 12681 <tr class="header"> 12682 <th>Type</th> 12683 <th>Description</th> 12684 <th>Result</th> 12685 <th>Implementation</th> 12686 </tr> 12687 </thead> 12688 <tbody> 12689 <tr class="odd"> 12690 <td>Path1 new/changed AND Path2 new/changed AND Path1 == Path2</td> 12691 <td>File is new/changed on Path1 AND new/changed on Path2 AND Path1 version is currently identical to Path2</td> 12692 <td>No change</td> 12693 <td>None</td> 12694 </tr> 12695 <tr class="even"> 12696 <td>Path1 new AND Path2 new</td> 12697 <td>File is new on Path1 AND new on Path2 (and Path1 version is NOT identical to Path2)</td> 12698 <td>Conflicts handled according to <a href="#conflict-resolve"><code>--conflict-resolve</code></a> & <a href="#conflict-loser"><code>--conflict-loser</code></a> settings</td> 12699 <td>default: <code>rclone copy</code> renamed <code>Path2.conflict2</code> file to Path1, <code>rclone copy</code> renamed <code>Path1.conflict1</code> file to Path2</td> 12700 </tr> 12701 <tr class="odd"> 12702 <td>Path2 newer AND Path1 changed</td> 12703 <td>File is newer on Path2 AND also changed (newer/older/size) on Path1 (and Path1 version is NOT identical to Path2)</td> 12704 <td>Conflicts handled according to <a href="#conflict-resolve"><code>--conflict-resolve</code></a> & <a href="#conflict-loser"><code>--conflict-loser</code></a> settings</td> 12705 <td>default: <code>rclone copy</code> renamed <code>Path2.conflict2</code> file to Path1, <code>rclone copy</code> renamed <code>Path1.conflict1</code> file to Path2</td> 12706 </tr> 12707 <tr class="even"> 12708 <td>Path2 newer AND Path1 deleted</td> 12709 <td>File is newer on Path2 AND also deleted on Path1</td> 12710 <td>Path2 version survives</td> 12711 <td><code>rclone copy</code> Path2 to Path1</td> 12712 </tr> 12713 <tr class="odd"> 12714 <td>Path2 deleted AND Path1 changed</td> 12715 <td>File is deleted on Path2 AND changed (newer/older/size) on Path1</td> 12716 <td>Path1 version survives</td> 12717 <td><code>rclone copy</code> Path1 to Path2</td> 12718 </tr> 12719 <tr class="even"> 12720 <td>Path1 deleted AND Path2 changed</td> 12721 <td>File is deleted on Path1 AND changed (newer/older/size) on Path2</td> 12722 <td>Path2 version survives</td> 12723 <td><code>rclone copy</code> Path2 to Path1</td> 12724 </tr> 12725 </tbody> 12726 </table> 12727 <p>As of <code>rclone v1.64</code>, bisync is now better at detecting <em>false positive</em> sync conflicts, which would previously have resulted in unnecessary renames and duplicates. Now, when bisync comes to a file that it wants to rename (because it is new/changed on both sides), it first checks whether the Path1 and Path2 versions are currently <em>identical</em> (using the same underlying function as <a href="commands/rclone_check/"><code>check</code></a>.) If bisync concludes that the files are identical, it will skip them and move on. Otherwise, it will create renamed duplicates, as before. This behavior also <a href="https://forum.rclone.org/t/bisync-bugs-and-feature-requests/37636#:~:text=Renamed%20directories">improves the experience of renaming directories</a>, as a <code>--resync</code> is no longer required, so long as the same change has been made on both sides.</p> 12728 <h3 id="all-files-changed">All files changed check</h3> 12729 <p>If <em>all</em> prior existing files on either of the filesystems have changed (e.g. timestamps have changed due to changing the system's timezone) then bisync will abort without making any changes. Any new files are not considered for this check. You could use <code>--force</code> to force the sync (whichever side has the changed timestamp files wins). Alternately, a <code>--resync</code> may be used (Path1 versions will be pushed to Path2). Consider the situation carefully and perhaps use <code>--dry-run</code> before you commit to the changes.</p> 12730 <h3 id="modification-times">Modification times</h3> 12731 <p>By default, bisync compares files by modification time and size. If you or your application should change the content of a file without changing the modification time and size, then bisync will <em>not</em> notice the change, and thus will not copy it to the other side. As an alternative, consider comparing by checksum (if your remotes support it). See <a href="#compare"><code>--compare</code></a> for details.</p> 12732 <h3 id="error-handling">Error handling</h3> 12733 <p>Certain bisync critical errors, such as file copy/move failing, will result in a bisync lockout of following runs. The lockout is asserted because the sync status and history of the Path1 and Path2 filesystems cannot be trusted, so it is safer to block any further changes until someone checks things out. The recovery is to do a <code>--resync</code> again.</p> 12734 <p>It is recommended to use <code>--resync --dry-run --verbose</code> initially and <em>carefully</em> review what changes will be made before running the <code>--resync</code> without <code>--dry-run</code>.</p> 12735 <p>Most of these events come up due to an error status from an internal call. On such a critical error the <code>{...}.path1.lst</code> and <code>{...}.path2.lst</code> listing files are renamed to extension <code>.lst-err</code>, which blocks any future bisync runs (since the normal <code>.lst</code> files are not found). Bisync keeps them under <code>bisync</code> subdirectory of the rclone cache directory, typically at <code>${HOME}/.cache/rclone/bisync/</code> on Linux.</p> 12736 <p>Some errors are considered temporary and re-running the bisync is not blocked. The <em>critical return</em> blocks further bisync runs.</p> 12737 <p>See also: <a href="#resilient"><code>--resilient</code></a>, <a href="#recover"><code>--recover</code></a>, <a href="#max-lock"><code>--max-lock</code></a>, <a href="#graceful-shutdown">Graceful Shutdown</a></p> 12738 <h3 id="lock-file">Lock file</h3> 12739 <p>When bisync is running, a lock file is created in the bisync working directory, typically at <code>~/.cache/rclone/bisync/PATH1..PATH2.lck</code> on Linux. If bisync should crash or hang, the lock file will remain in place and block any further runs of bisync <em>for the same paths</em>. Delete the lock file as part of debugging the situation. The lock file effectively blocks follow-on (e.g., scheduled by <em>cron</em>) runs when the prior invocation is taking a long time. The lock file contains <em>PID</em> of the blocking process, which may help in debug. Lock files can be set to automatically expire after a certain amount of time, using the <a href="#max-lock"><code>--max-lock</code></a> flag.</p> 12740 <p><strong>Note</strong> that while concurrent bisync runs are allowed, <em>be very cautious</em> that there is no overlap in the trees being synched between concurrent runs, lest there be replicated files, deleted files and general mayhem.</p> 12741 <h3 id="return-codes">Return codes</h3> 12742 <p><code>rclone bisync</code> returns the following codes to calling program: - <code>0</code> on a successful run, - <code>1</code> for a non-critical failing run (a rerun may be successful), - <code>2</code> for a critically aborted run (requires a <code>--resync</code> to recover).</p> 12743 <h3 id="graceful-shutdown">Graceful Shutdown</h3> 12744 <p>Bisync has a "Graceful Shutdown" mode which is activated by sending <code>SIGINT</code> or pressing <code>Ctrl+C</code> during a run. Once triggered, bisync will use best efforts to exit cleanly before the timer runs out. If bisync is in the middle of transferring files, it will attempt to cleanly empty its queue by finishing what it has started but not taking more. If it cannot do so within 30 seconds, it will cancel the in-progress transfers at that point and then give itself a maximum of 60 seconds to wrap up, save its state for next time, and exit. With the <code>-vP</code> flags you will see constant status updates and a final confirmation of whether or not the graceful shutdown was successful.</p> 12745 <p>At any point during the "Graceful Shutdown" sequence, a second <code>SIGINT</code> or <code>Ctrl+C</code> will trigger an immediate, un-graceful exit, which will leave things in a messier state. Usually a robust recovery will still be possible if using <a href="#recover"><code>--recover</code></a> mode, otherwise you will need to do a <code>--resync</code>.</p> 12746 <p>If you plan to use Graceful Shutdown mode, it is recommended to use <a href="#resilient"><code>--resilient</code></a> and <a href="#recover"><code>--recover</code></a>, and it is important to NOT use <a href="https://rclone.org/docs/#inplace"><code>--inplace</code></a>, otherwise you risk leaving partially-written files on one side, which may be confused for real files on the next run. Note also that in the event of an abrupt interruption, a <a href="#lock-file">lock file</a> will be left behind to block concurrent runs. You will need to delete it before you can proceed with the next run (or wait for it to expire on its own, if using <code>--max-lock</code>.)</p> 12747 <h2 id="limitations-4">Limitations</h2> 12748 <h3 id="supported-backends">Supported backends</h3> 12749 <p>Bisync is considered <em>BETA</em> and has been tested with the following backends: - Local filesystem - Google Drive - Dropbox - OneDrive - S3 - SFTP - Yandex Disk - Crypt</p> 12750 <p>It has not been fully tested with other services yet. If it works, or sorta works, please let us know and we'll update the list. Run the test suite to check for proper operation as described below.</p> 12751 <p>The first release of <code>rclone bisync</code> required both underlying backends to support modification times, and refused to run otherwise. This limitation has been lifted as of <code>v1.66</code>, as bisync now supports comparing checksum and/or size instead of (or in addition to) modtime. See <a href="#compare"><code>--compare</code></a> for details.</p> 12752 <h3 id="concurrent-modifications">Concurrent modifications</h3> 12753 <p>When using <strong>Local, FTP or SFTP</strong> remotes with <a href="https://rclone.org/docs/#inplace"><code>--inplace</code></a>, rclone does not create <em>temporary</em> files at the destination when copying, and thus if the connection is lost the created file may be corrupt, which will likely propagate back to the original path on the next sync, resulting in data loss. It is therefore recommended to <em>omit</em> <code>--inplace</code>.</p> 12754 <p>Files that <strong>change during</strong> a bisync run may result in data loss. Prior to <code>rclone v1.66</code>, this was commonly seen in highly dynamic environments, where the filesystem was getting hammered by running processes during the sync. As of <code>rclone v1.66</code>, bisync was redesigned to use a "snapshot" model, greatly reducing the risks from changes during a sync. Changes that are not detected during the current sync will now be detected during the following sync, and will no longer cause the entire run to throw a critical error. There is additionally a mechanism to mark files as needing to be internally rechecked next time, for added safety. It should therefore no longer be necessary to sync only at quiet times -- however, note that an error can still occur if a file happens to change at the exact moment it's being read/written by bisync (same as would happen in <code>rclone sync</code>.) (See also: <a href="https://rclone.org/docs/#ignore-checksum"><code>--ignore-checksum</code></a>, <a href="https://rclone.org/local/#local-no-check-updated"><code>--local-no-check-updated</code></a>)</p> 12755 <h3 id="empty-directories">Empty directories</h3> 12756 <p>By default, new/deleted empty directories on one path are <em>not</em> propagated to the other side. This is because bisync (and rclone) natively works on files, not directories. However, this can be changed with the <code>--create-empty-src-dirs</code> flag, which works in much the same way as in <a href="https://rclone.org/commands/rclone_sync/"><code>sync</code></a> and <a href="https://rclone.org/commands/rclone_copy/"><code>copy</code></a>. When used, empty directories created or deleted on one side will also be created or deleted on the other side. The following should be noted: * <code>--create-empty-src-dirs</code> is not compatible with <code>--remove-empty-dirs</code>. Use only one or the other (or neither). * It is not recommended to switch back and forth between <code>--create-empty-src-dirs</code> and the default (no <code>--create-empty-src-dirs</code>) without running <code>--resync</code>. This is because it may appear as though all directories (not just the empty ones) were created/deleted, when actually you've just toggled between making them visible/invisible to bisync. It looks scarier than it is, but it's still probably best to stick to one or the other, and use <code>--resync</code> when you need to switch.</p> 12757 <h3 id="renamed-directories">Renamed directories</h3> 12758 <p>By default, renaming a folder on the Path1 side results in deleting all files on the Path2 side and then copying all files again from Path1 to Path2. Bisync sees this as all files in the old directory name as deleted and all files in the new directory name as new.</p> 12759 <p>A recommended solution is to use <a href="https://rclone.org/docs/#track-renames"><code>--track-renames</code></a>, which is now supported in bisync as of <code>rclone v1.66</code>. Note that <code>--track-renames</code> is not available during <code>--resync</code>, as <code>--resync</code> does not delete anything (<code>--track-renames</code> only supports <code>sync</code>, not <code>copy</code>.)</p> 12760 <p>Otherwise, the most effective and efficient method of renaming a directory is to rename it to the same name on both sides. (As of <code>rclone v1.64</code>, a <code>--resync</code> is no longer required after doing so, as bisync will automatically detect that Path1 and Path2 are in agreement.)</p> 12761 <h3 id="fast-list-used-by-default"><code>--fast-list</code> used by default</h3> 12762 <p>Unlike most other rclone commands, bisync uses <a href="https://rclone.org/docs/#fast-list"><code>--fast-list</code></a> by default, for backends that support it. In many cases this is desirable, however, there are some scenarios in which bisync could be faster <em>without</em> <code>--fast-list</code>, and there is also a <a href="https://github.com/rclone/rclone/commit/cbf3d4356135814921382dd3285d859d15d0aa77">known issue concerning Google Drive users with many empty directories</a>. For now, the recommended way to avoid using <code>--fast-list</code> is to add <code>--disable ListR</code> to all bisync commands. The default behavior may change in a future version.</p> 12763 <h3 id="case-sensitivity">Case (and unicode) sensitivity</h3> 12764 <p>As of <code>v1.66</code>, case and unicode form differences no longer cause critical errors, and normalization (when comparing between filesystems) is handled according to the same flags and defaults as <code>rclone sync</code>. See the following options (all of which are supported by bisync) to control this behavior more granularly: - <a href="https://rclone.org/docs/#fix-case"><code>--fix-case</code></a> - <a href="https://rclone.org/docs/#ignore-case-sync"><code>--ignore-case-sync</code></a> - <a href="https://rclone.org/docs/#no-unicode-normalization"><code>--no-unicode-normalization</code></a> - <a href="https://rclone.org/local/#local-unicode-normalization"><code>--local-unicode-normalization</code></a> and <a href="https://rclone.org/local/#local-case-sensitive"><code>--local-case-sensitive</code></a> (caution: these are normally not what you want.)</p> 12765 <p>Note that in the (probably rare) event that <code>--fix-case</code> is used AND a file is new/changed on both sides AND the checksums match AND the filename case does not match, the Path1 filename is considered the winner, for the purposes of <code>--fix-case</code> (Path2 will be renamed to match it).</p> 12766 <h2 id="windows">Windows support</h2> 12767 <p>Bisync has been tested on Windows 8.1, Windows 10 Pro 64-bit and on Windows GitHub runners.</p> 12768 <p>Drive letters are allowed, including drive letters mapped to network drives (<code>rclone bisync J:\localsync GDrive:</code>). If a drive letter is omitted, the shell current drive is the default. Drive letters are a single character follows by <code>:</code>, so cloud names must be more than one character long.</p> 12769 <p>Absolute paths (with or without a drive letter), and relative paths (with or without a drive letter) are supported.</p> 12770 <p>Working directory is created at <code>C:\Users\MyLogin\AppData\Local\rclone\bisync</code>.</p> 12771 <p>Note that bisync output may show a mix of forward <code>/</code> and back <code>\</code> slashes.</p> 12772 <p>Be careful of case independent directory and file naming on Windows vs. case dependent Linux</p> 12773 <h2 id="filtering">Filtering</h2> 12774 <p>See <a href="https://rclone.org/filtering/">filtering documentation</a> for how filter rules are written and interpreted.</p> 12775 <p>Bisync's <a href="#filters-file"><code>--filters-file</code></a> flag slightly extends the rclone's <a href="https://rclone.org/filtering/#filter-from-read-filtering-patterns-from-a-file">--filter-from</a> filtering mechanism. For a given bisync run you may provide <em>only one</em> <code>--filters-file</code>. The <code>--include*</code>, <code>--exclude*</code>, and <code>--filter</code> flags are also supported.</p> 12776 <h3 id="how-to-filter-directories">How to filter directories</h3> 12777 <p>Filtering portions of the directory tree is a critical feature for synching.</p> 12778 <p>Examples of directory trees (always beneath the Path1/Path2 root level) you may want to exclude from your sync: - Directory trees containing only software build intermediate files. - Directory trees containing application temporary files and data such as the Windows <code>C:\Users\MyLogin\AppData\</code> tree. - Directory trees containing files that are large, less important, or are getting thrashed continuously by ongoing processes.</p> 12779 <p>On the other hand, there may be only select directories that you actually want to sync, and exclude all others. See the <a href="#include-filters">Example include-style filters for Windows user directories</a> below.</p> 12780 <h3 id="filters-file-writing-guidelines">Filters file writing guidelines</h3> 12781 <ol type="1"> 12782 <li>Begin with excluding directory trees: 12783 <ul> 12784 <li>e.g. `- /AppData/`</li> 12785 <li><code>**</code> on the end is not necessary. Once a given directory level is excluded then everything beneath it won't be looked at by rclone.</li> 12786 <li>Exclude such directories that are unneeded, are big, dynamically thrashed, or where there may be access permission issues.</li> 12787 <li>Excluding such dirs first will make rclone operations (much) faster.</li> 12788 <li>Specific files may also be excluded, as with the Dropbox exclusions example below.</li> 12789 </ul></li> 12790 <li>Decide if it's easier (or cleaner) to: 12791 <ul> 12792 <li>Include select directories and therefore <em>exclude everything else</em> -- or --</li> 12793 <li>Exclude select directories and therefore <em>include everything else</em></li> 12794 </ul></li> 12795 <li>Include select directories: 12796 <ul> 12797 <li>Add lines like: `+ /Documents/PersonalFiles/**` to select which directories to include in the sync.</li> 12798 <li><code>**</code> on the end specifies to include the full depth of the specified tree.</li> 12799 <li>With Include-style filters, files at the Path1/Path2 root are not included. They may be included with `+ /*`.</li> 12800 <li>Place RCLONE_TEST files within these included directory trees. They will only be looked for in these directory trees.</li> 12801 <li>Finish by excluding everything else by adding `- **` at the end of the filters file.</li> 12802 <li>Disregard step 4.</li> 12803 </ul></li> 12804 <li>Exclude select directories: 12805 <ul> 12806 <li>Add more lines like in step 1. For example: <code>-/Desktop/tempfiles/</code>, or `- /testdir/<code>. Again, a</code>**` on the end is not necessary.</li> 12807 <li>Do <em>not</em> add a `- **` in the file. Without this line, everything will be included that has not been explicitly excluded.</li> 12808 <li>Disregard step 3.</li> 12809 </ul></li> 12810 </ol> 12811 <p>A few rules for the syntax of a filter file expanding on <a href="https://rclone.org/filtering/">filtering documentation</a>:</p> 12812 <ul> 12813 <li>Lines may start with spaces and tabs - rclone strips leading whitespace.</li> 12814 <li>If the first non-whitespace character is a <code>#</code> then the line is a comment and will be ignored.</li> 12815 <li>Blank lines are ignored.</li> 12816 <li>The first non-whitespace character on a filter line must be a <code>+</code> or <code>-</code>.</li> 12817 <li>Exactly 1 space is allowed between the <code>+/-</code> and the path term.</li> 12818 <li>Only forward slashes (<code>/</code>) are used in path terms, even on Windows.</li> 12819 <li>The rest of the line is taken as the path term. Trailing whitespace is taken literally, and probably is an error.</li> 12820 </ul> 12821 <h3 id="include-filters">Example include-style filters for Windows user directories</h3> 12822 <p>This Windows <em>include-style</em> example is based on the sync root (Path1) set to <code>C:\Users\MyLogin</code>. The strategy is to select specific directories to be synched with a network drive (Path2).</p> 12823 <ul> 12824 <li>`- /AppData/` excludes an entire tree of Windows stored stuff that need not be synched. In my case, AppData has >11 GB of stuff I don't care about, and there are some subdirectories beneath AppData that are not accessible to my user login, resulting in bisync critical aborts.</li> 12825 <li>Windows creates cache files starting with both upper and lowercase <code>NTUSER</code> at <code>C:\Users\MyLogin</code>. These files may be dynamic, locked, and are generally <em>don't care</em>.</li> 12826 <li>There are just a few directories with <em>my</em> data that I do want synched, in the form of `+ /<path><code>. By selecting only the directory trees I want to avoid the dozen plus directories that various apps make at</code>C:`.</li> 12827 <li>Include files in the root of the sync point, <code>C:\Users\MyLogin</code>, by adding the `+ /*` line.</li> 12828 <li>This is an Include-style filters file, therefore it ends with `- **` which excludes everything not explicitly included.</li> 12829 </ul> 12830 <pre><code>- /AppData/ 12831 - NTUSER* 12832 - ntuser* 12833 + /Documents/Family/** 12834 + /Documents/Sketchup/** 12835 + /Documents/Microcapture_Photo/** 12836 + /Documents/Microcapture_Video/** 12837 + /Desktop/** 12838 + /Pictures/** 12839 + /* 12840 - **</code></pre> 12841 <p>Note also that Windows implements several "library" links such as <code>C:\Users\MyLogin\My Documents\My Music</code> pointing to <code>C:\Users\MyLogin\Music</code>. rclone sees these as links, so you must add <code>--links</code> to the bisync command line if you which to follow these links. I find that I get permission errors in trying to follow the links, so I don't include the rclone <code>--links</code> flag, but then you get lots of <code>Can't follow symlink…</code> noise from rclone about not following the links. This noise can be quashed by adding <code>--quiet</code> to the bisync command line.</p> 12842 <h2 id="exclude-filters">Example exclude-style filters files for use with Dropbox</h2> 12843 <ul> 12844 <li>Dropbox disallows synching the listed temporary and configuration/data files. The `- <filename>` filters exclude these files where ever they may occur in the sync tree. Consider adding similar exclusions for file types you don't need to sync, such as core dump and software build files.</li> 12845 <li>bisync testing creates <code>/testdir/</code> at the top level of the sync tree, and usually deletes the tree after the test. If a normal sync should run while the <code>/testdir/</code> tree exists the <code>--check-access</code> phase may fail due to unbalanced RCLONE_TEST files. The `- /testdir/` filter blocks this tree from being synched. You don't need this exclusion if you are not doing bisync development testing.</li> 12846 <li>Everything else beneath the Path1/Path2 root will be synched.</li> 12847 <li>RCLONE_TEST files may be placed anywhere within the tree, including the root.</li> 12848 </ul> 12849 <h3 id="example-filters-file">Example filters file for Dropbox</h3> 12850 <pre><code># Filter file for use with bisync 12851 # See https://rclone.org/filtering/ for filtering rules 12852 # NOTICE: If you make changes to this file you MUST do a --resync run. 12853 # Run with --dry-run to see what changes will be made. 12854 12855 # Dropbox won't sync some files so filter them away here. 12856 # See https://help.dropbox.com/installs-integrations/sync-uploads/files-not-syncing 12857 - .dropbox.attr 12858 - ~*.tmp 12859 - ~$* 12860 - .~* 12861 - desktop.ini 12862 - .dropbox 12863 12864 # Used for bisync testing, so excluded from normal runs 12865 - /testdir/ 12866 12867 # Other example filters 12868 #- /TiBU/ 12869 #- /Photos/</code></pre> 12870 <h3 id="how---check-access-handles-filters">How --check-access handles filters</h3> 12871 <p>At the start of a bisync run, listings are gathered for Path1 and Path2 while using the user's <code>--filters-file</code>. During the check access phase, bisync scans these listings for <code>RCLONE_TEST</code> files. Any <code>RCLONE_TEST</code> files hidden by the <code>--filters-file</code> are <em>not</em> in the listings and thus not checked during the check access phase.</p> 12872 <h2 id="troubleshooting">Troubleshooting</h2> 12873 <h3 id="reading-bisync-logs">Reading bisync logs</h3> 12874 <p>Here are two normal runs. The first one has a newer file on the remote. The second has no deltas between local and remote.</p> 12875 <pre><code>2021/05/16 00:24:38 INFO : Synching Path1 "/path/to/local/tree/" with Path2 "dropbox:/" 12876 2021/05/16 00:24:38 INFO : Path1 checking for diffs 12877 2021/05/16 00:24:38 INFO : - Path1 File is new - file.txt 12878 2021/05/16 00:24:38 INFO : Path1: 1 changes: 1 new, 0 newer, 0 older, 0 deleted 12879 2021/05/16 00:24:38 INFO : Path2 checking for diffs 12880 2021/05/16 00:24:38 INFO : Applying changes 12881 2021/05/16 00:24:38 INFO : - Path1 Queue copy to Path2 - dropbox:/file.txt 12882 2021/05/16 00:24:38 INFO : - Path1 Do queued copies to - Path2 12883 2021/05/16 00:24:38 INFO : Updating listings 12884 2021/05/16 00:24:38 INFO : Validating listings for Path1 "/path/to/local/tree/" vs Path2 "dropbox:/" 12885 2021/05/16 00:24:38 INFO : Bisync successful 12886 12887 2021/05/16 00:36:52 INFO : Synching Path1 "/path/to/local/tree/" with Path2 "dropbox:/" 12888 2021/05/16 00:36:52 INFO : Path1 checking for diffs 12889 2021/05/16 00:36:52 INFO : Path2 checking for diffs 12890 2021/05/16 00:36:52 INFO : No changes found 12891 2021/05/16 00:36:52 INFO : Updating listings 12892 2021/05/16 00:36:52 INFO : Validating listings for Path1 "/path/to/local/tree/" vs Path2 "dropbox:/" 12893 2021/05/16 00:36:52 INFO : Bisync successful</code></pre> 12894 <h3 id="dry-run-oddity">Dry run oddity</h3> 12895 <p>The <code>--dry-run</code> messages may indicate that it would try to delete some files. For example, if a file is new on Path2 and does not exist on Path1 then it would normally be copied to Path1, but with <code>--dry-run</code> enabled those copies don't happen, which leads to the attempted delete on Path2, blocked again by --dry-run: <code>... Not deleting as --dry-run</code>.</p> 12896 <p>This whole confusing situation is an artifact of the <code>--dry-run</code> flag. Scrutinize the proposed deletes carefully, and if the files would have been copied to Path1 then the threatened deletes on Path2 may be disregarded.</p> 12897 <h3 id="retries">Retries</h3> 12898 <p>Rclone has built-in retries. If you run with <code>--verbose</code> you'll see error and retry messages such as shown below. This is usually not a bug. If at the end of the run, you see <code>Bisync successful</code> and not <code>Bisync critical error</code> or <code>Bisync aborted</code> then the run was successful, and you can ignore the error messages.</p> 12899 <p>The following run shows an intermittent fail. Lines <em>5</em> and _6- are low-level messages. Line <em>6</em> is a bubbled-up <em>warning</em> message, conveying the error. Rclone normally retries failing commands, so there may be numerous such messages in the log.</p> 12900 <p>Since there are no final error/warning messages on line <em>7</em>, rclone has recovered from failure after a retry, and the overall sync was successful.</p> 12901 <pre><code>1: 2021/05/14 00:44:12 INFO : Synching Path1 "/path/to/local/tree" with Path2 "dropbox:" 12902 2: 2021/05/14 00:44:12 INFO : Path1 checking for diffs 12903 3: 2021/05/14 00:44:12 INFO : Path2 checking for diffs 12904 4: 2021/05/14 00:44:12 INFO : Path2: 113 changes: 22 new, 0 newer, 0 older, 91 deleted 12905 5: 2021/05/14 00:44:12 ERROR : /path/to/local/tree/objects/af: error listing: unexpected end of JSON input 12906 6: 2021/05/14 00:44:12 NOTICE: WARNING listing try 1 failed. - dropbox: 12907 7: 2021/05/14 00:44:12 INFO : Bisync successful</code></pre> 12908 <p>This log shows a <em>Critical failure</em> which requires a <code>--resync</code> to recover from. See the <a href="#error-handling">Runtime Error Handling</a> section.</p> 12909 <pre><code>2021/05/12 00:49:40 INFO : Google drive root '': Waiting for checks to finish 12910 2021/05/12 00:49:40 INFO : Google drive root '': Waiting for transfers to finish 12911 2021/05/12 00:49:40 INFO : Google drive root '': not deleting files as there were IO errors 12912 2021/05/12 00:49:40 ERROR : Attempt 3/3 failed with 3 errors and: not deleting files as there were IO errors 12913 2021/05/12 00:49:40 ERROR : Failed to sync: not deleting files as there were IO errors 12914 2021/05/12 00:49:40 NOTICE: WARNING rclone sync try 3 failed. - /path/to/local/tree/ 12915 2021/05/12 00:49:40 ERROR : Bisync aborted. Must run --resync to recover.</code></pre> 12916 <h3 id="denied-downloads-of-infected-or-abusive-files">Denied downloads of "infected" or "abusive" files</h3> 12917 <p>Google Drive has a filter for certain file types (<code>.exe</code>, <code>.apk</code>, et cetera) that by default cannot be copied from Google Drive to the local filesystem. If you are having problems, run with <code>--verbose</code> to see specifically which files are generating complaints. If the error is <code>This file has been identified as malware or spam and cannot be downloaded</code>, consider using the flag <a href="https://rclone.org/drive/#drive-acknowledge-abuse">--drive-acknowledge-abuse</a>.</p> 12918 <h3 id="gdocs">Google Docs (and other files of unknown size)</h3> 12919 <p>As of <code>v1.66</code>, <a href="https://rclone.org/drive/#import-export-of-google-documents">Google Docs</a> (including Google Sheets, Slides, etc.) are now supported in bisync, subject to the same options, defaults, and limitations as in <code>rclone sync</code>. When bisyncing drive with non-drive backends, the drive -> non-drive direction is controlled by <a href="https://rclone.org/drive/#drive-export-formats"><code>--drive-export-formats</code></a> (default <code>"docx,xlsx,pptx,svg"</code>) and the non-drive -> drive direction is controlled by <a href="https://rclone.org/drive/#drive-import-formats"><code>--drive-import-formats</code></a> (default none.)</p> 12920 <p>For example, with the default export/import formats, a Google Sheet on the drive side will be synced to an <code>.xlsx</code> file on the non-drive side. In the reverse direction, <code>.xlsx</code> files with filenames that match an existing Google Sheet will be synced to that Google Sheet, while <code>.xlsx</code> files that do NOT match an existing Google Sheet will be copied to drive as normal <code>.xlsx</code> files (without conversion to Sheets, although the Google Drive web browser UI may still give you the option to open it as one.)</p> 12921 <p>If <code>--drive-import-formats</code> is set (it's not, by default), then all of the specified formats will be converted to Google Docs, if there is no existing Google Doc with a matching name. Caution: such conversion can be quite lossy, and in most cases it's probably not what you want!</p> 12922 <p>To bisync Google Docs as URL shortcut links (in a manner similar to "Drive for Desktop"), use: <code>--drive-export-formats url</code> (or <a href="https://rclone.org/drive/#exportformats:~:text=available%20Google%20Documents.-,Extension,macOS,-Standard%20options">alternatives</a>.)</p> 12923 <p>Note that these link files cannot be edited on the non-drive side -- you will get errors if you try to sync an edited link file back to drive. They CAN be deleted (it will result in deleting the corresponding Google Doc.) If you create a <code>.url</code> file on the non-drive side that does not match an existing Google Doc, bisyncing it will just result in copying the literal <code>.url</code> file over to drive (no Google Doc will be created.) So, as a general rule of thumb, think of them as read-only placeholders on the non-drive side, and make all your changes on the drive side.</p> 12924 <p>Likewise, even with other export-formats, it is best to only move/rename Google Docs on the drive side. This is because otherwise, bisync will interpret this as a file deleted and another created, and accordingly, it will delete the Google Doc and create a new file at the new path. (Whether or not that new file is a Google Doc depends on <code>--drive-import-formats</code>.)</p> 12925 <p>Lastly, take note that all Google Docs on the drive side have a size of <code>-1</code> and no checksum. Therefore, they cannot be reliably synced with the <code>--checksum</code> or <code>--size-only</code> flags. (To be exact: they will still get created/deleted, and bisync's delta engine will notice changes and queue them for syncing, but the underlying sync function will consider them identical and skip them.) To work around this, use the default (modtime and size) instead of <code>--checksum</code> or <code>--size-only</code>.</p> 12926 <p>To ignore Google Docs entirely, use <a href="https://rclone.org/drive/#drive-skip-gdocs"><code>--drive-skip-gdocs</code></a>.</p> 12927 <h2 id="usage-examples">Usage examples</h2> 12928 <h3 id="cron">Cron</h3> 12929 <p>Rclone does not yet have a built-in capability to monitor the local file system for changes and must be blindly run periodically. On Windows this can be done using a <em>Task Scheduler</em>, on Linux you can use <em>Cron</em> which is described below.</p> 12930 <p>The 1st example runs a sync every 5 minutes between a local directory and an OwnCloud server, with output logged to a runlog file:</p> 12931 <pre><code># Minute (0-59) 12932 # Hour (0-23) 12933 # Day of Month (1-31) 12934 # Month (1-12 or Jan-Dec) 12935 # Day of Week (0-6 or Sun-Sat) 12936 # Command 12937 */5 * * * * /path/to/rclone bisync /local/files MyCloud: --check-access --filters-file /path/to/bysync-filters.txt --log-file /path/to//bisync.log</code></pre> 12938 <p>See <a href="https://www.man7.org/linux/man-pages/man1/crontab.1p.html#INPUT_FILES">crontab syntax</a> for the details of crontab time interval expressions.</p> 12939 <p>If you run <code>rclone bisync</code> as a cron job, redirect stdout/stderr to a file. The 2nd example runs a sync to Dropbox every hour and logs all stdout (via the <code>>></code>) and stderr (via <code>2>&1</code>) to a log file.</p> 12940 <pre><code>0 * * * * /path/to/rclone bisync /path/to/local/dropbox Dropbox: --check-access --filters-file /home/user/filters.txt >> /path/to/logs/dropbox-run.log 2>&1</code></pre> 12941 <h3 id="sharing-an-encrypted-folder-tree-between-hosts">Sharing an encrypted folder tree between hosts</h3> 12942 <p>bisync can keep a local folder in sync with a cloud service, but what if you have some highly sensitive files to be synched?</p> 12943 <p>Usage of a cloud service is for exchanging both routine and sensitive personal files between one's home network, one's personal notebook when on the road, and with one's work computer. The routine data is not sensitive. For the sensitive data, configure an rclone <a href="https://rclone.org/crypt/">crypt remote</a> to point to a subdirectory within the local disk tree that is bisync'd to Dropbox, and then set up an bisync for this local crypt directory to a directory outside of the main sync tree.</p> 12944 <h3 id="linux-server-setup">Linux server setup</h3> 12945 <ul> 12946 <li><code>/path/to/DBoxroot</code> is the root of my local sync tree. There are numerous subdirectories.</li> 12947 <li><code>/path/to/DBoxroot/crypt</code> is the root subdirectory for files that are encrypted. This local directory target is setup as an rclone crypt remote named <code>Dropcrypt:</code>. See <a href="#rclone-conf-snippet">rclone.conf</a> snippet below.</li> 12948 <li><code>/path/to/my/unencrypted/files</code> is the root of my sensitive files - not encrypted, not within the tree synched to Dropbox.</li> 12949 <li>To sync my local unencrypted files with the encrypted Dropbox versions I manually run <code>bisync /path/to/my/unencrypted/files DropCrypt:</code>. This step could be bundled into a script to run before and after the full Dropbox tree sync in the last step, thus actively keeping the sensitive files in sync.</li> 12950 <li><code>bisync /path/to/DBoxroot Dropbox:</code> runs periodically via cron, keeping my full local sync tree in sync with Dropbox.</li> 12951 </ul> 12952 <h3 id="windows-notebook-setup">Windows notebook setup</h3> 12953 <ul> 12954 <li>The Dropbox client runs keeping the local tree <code>C:\Users\MyLogin\Dropbox</code> always in sync with Dropbox. I could have used <code>rclone bisync</code> instead.</li> 12955 <li>A separate directory tree at <code>C:\Users\MyLogin\Documents\DropLocal</code> hosts the tree of unencrypted files/folders.</li> 12956 <li>To sync my local unencrypted files with the encrypted Dropbox versions I manually run the following command: <code>rclone bisync C:\Users\MyLogin\Documents\DropLocal Dropcrypt:</code>.</li> 12957 <li>The Dropbox client then syncs the changes with Dropbox.</li> 12958 </ul> 12959 <h3 id="rclone-conf-snippet">rclone.conf snippet</h3> 12960 <pre><code>[Dropbox] 12961 type = dropbox 12962 ... 12963 12964 [Dropcrypt] 12965 type = crypt 12966 remote = /path/to/DBoxroot/crypt # on the Linux server 12967 remote = C:\Users\MyLogin\Dropbox\crypt # on the Windows notebook 12968 filename_encryption = standard 12969 directory_name_encryption = true 12970 password = ... 12971 ...</code></pre> 12972 <h2 id="testing">Testing</h2> 12973 <p>You should read this section only if you are developing for rclone. You need to have rclone source code locally to work with bisync tests.</p> 12974 <p>Bisync has a dedicated test framework implemented in the <code>bisync_test.go</code> file located in the rclone source tree. The test suite is based on the <code>go test</code> command. Series of tests are stored in subdirectories below the <code>cmd/bisync/testdata</code> directory. Individual tests can be invoked by their directory name, e.g. <code>go test . -case basic -remote local -remote2 gdrive: -v</code></p> 12975 <p>Tests will make a temporary folder on remote and purge it afterwards. If during test run there are intermittent errors and rclone retries, these errors will be captured and flagged as invalid MISCOMPAREs. Rerunning the test will let it pass. Consider such failures as noise.</p> 12976 <h3 id="test-command-syntax">Test command syntax</h3> 12977 <pre><code>usage: go test ./cmd/bisync [options...] 12978 12979 Options: 12980 -case NAME Name(s) of the test case(s) to run. Multiple names should 12981 be separated by commas. You can remove the `test_` prefix 12982 and replace `_` by `-` in test name for convenience. 12983 If not `all`, the name(s) should map to a directory under 12984 `./cmd/bisync/testdata`. 12985 Use `all` to run all tests (default: all) 12986 -remote PATH1 `local` or name of cloud service with `:` (default: local) 12987 -remote2 PATH2 `local` or name of cloud service with `:` (default: local) 12988 -no-compare Disable comparing test results with the golden directory 12989 (default: compare) 12990 -no-cleanup Disable cleanup of Path1 and Path2 testdirs. 12991 Useful for troubleshooting. (default: cleanup) 12992 -golden Store results in the golden directory (default: false) 12993 This flag can be used with multiple tests. 12994 -debug Print debug messages 12995 -stop-at NUM Stop test after given step number. (default: run to the end) 12996 Implies `-no-compare` and `-no-cleanup`, if the test really 12997 ends prematurely. Only meaningful for a single test case. 12998 -refresh-times Force refreshing the target modtime, useful for Dropbox 12999 (default: false) 13000 -verbose Run tests verbosely</code></pre> 13001 <p>Note: unlike rclone flags which must be prefixed by double dash (<code>--</code>), the test command flags can be equally prefixed by a single <code>-</code> or double dash.</p> 13002 <h3 id="running-tests">Running tests</h3> 13003 <ul> 13004 <li><code>go test . -case basic -remote local -remote2 local</code> runs the <code>test_basic</code> test case using only the local filesystem, synching one local directory with another local directory. Test script output is to the console, while commands within scenario.txt have their output sent to the <code>.../workdir/test.log</code> file, which is finally compared to the golden copy.</li> 13005 <li>The first argument after <code>go test</code> should be a relative name of the directory containing bisync source code. If you run tests right from there, the argument will be <code>.</code> (current directory) as in most examples below. If you run bisync tests from the rclone source directory, the command should be <code>go test ./cmd/bisync ...</code>.</li> 13006 <li>The test engine will mangle rclone output to ensure comparability with golden listings and logs.</li> 13007 <li>Test scenarios are located in <code>./cmd/bisync/testdata</code>. The test <code>-case</code> argument should match the full name of a subdirectory under that directory. Every test subdirectory name on disk must start with <code>test_</code>, this prefix can be omitted on command line for brevity. Also, underscores in the name can be replaced by dashes for convenience.</li> 13008 <li><code>go test . -remote local -remote2 local -case all</code> runs all tests.</li> 13009 <li>Path1 and Path2 may either be the keyword <code>local</code> or may be names of configured cloud services. <code>go test . -remote gdrive: -remote2 dropbox: -case basic</code> will run the test between these two services, without transferring any files to the local filesystem.</li> 13010 <li>Test run stdout and stderr console output may be directed to a file, e.g. <code>go test . -remote gdrive: -remote2 local -case all > runlog.txt 2>&1</code></li> 13011 </ul> 13012 <h3 id="test-execution-flow">Test execution flow</h3> 13013 <ol type="1"> 13014 <li>The base setup in the <code>initial</code> directory of the testcase is applied on the Path1 and Path2 filesystems (via rclone copy the initial directory to Path1, then rclone sync Path1 to Path2).</li> 13015 <li>The commands in the scenario.txt file are applied, with output directed to the <code>test.log</code> file in the test working directory. Typically, the first actual command in the <code>scenario.txt</code> file is to do a <code>--resync</code>, which establishes the baseline <code>{...}.path1.lst</code> and <code>{...}.path2.lst</code> files in the test working directory (<code>.../workdir/</code> relative to the temporary test directory). Various commands and listing snapshots are done within the test.</li> 13016 <li>Finally, the contents of the test working directory are compared to the contents of the testcase's golden directory.</li> 13017 </ol> 13018 <h3 id="notes-about-testing">Notes about testing</h3> 13019 <ul> 13020 <li>Test cases are in individual directories beneath <code>./cmd/bisync/testdata</code>. A command line reference to a test is understood to reference a directory beneath <code>testdata</code>. For example, <code>go test ./cmd/bisync -case dry-run -remote gdrive: -remote2 local</code> refers to the test case in <code>./cmd/bisync/testdata/test_dry_run</code>.</li> 13021 <li>The test working directory is located at <code>.../workdir</code> relative to a temporary test directory, usually under <code>/tmp</code> on Linux.</li> 13022 <li>The local test sync tree is created at a temporary directory named like <code>bisync.XXX</code> under system temporary directory.</li> 13023 <li>The remote test sync tree is located at a temporary directory under <code><remote:>/bisync.XXX/</code>.</li> 13024 <li><code>path1</code> and/or <code>path2</code> subdirectories are created in a temporary directory under the respective local or cloud test remote.</li> 13025 <li>By default, the Path1 and Path2 test dirs and workdir will be deleted after each test run. The <code>-no-cleanup</code> flag disables purging these directories when validating and debugging a given test. These directories will be flushed before running another test, independent of the <code>-no-cleanup</code> usage.</li> 13026 <li>You will likely want to add `- /testdir/<code>to your normal bisync</code>--filters-file<code>so that normal syncs do not attempt to sync the test temporary directories, which may have</code>RCLONE_TEST<code>miscompares in some testcases which would otherwise trip the</code>--check-access<code>system. The</code>--check-access<code>mechanism is hard-coded to ignore</code>RCLONE_TEST<code>files beneath</code>bisync/testdata`, so the test cases may reside on the synched tree even if there are check file mismatches in the test tree.</li> 13027 <li>Some Dropbox tests can fail, notably printing the following message: <code>src and dst identical but can't set mod time without deleting and re-uploading</code> This is expected and happens due to the way Dropbox handles modification times. You should use the <code>-refresh-times</code> test flag to make up for this.</li> 13028 <li>If Dropbox tests hit request limit for you and print error message <code>too_many_requests/...: Too many requests or write operations.</code> then follow the <a href="https://rclone.org/dropbox/#get-your-own-dropbox-app-id">Dropbox App ID instructions</a>.</li> 13029 </ul> 13030 <h3 id="updating-golden-results">Updating golden results</h3> 13031 <p>Sometimes even a slight change in the bisync source can cause little changes spread around many log files. Updating them manually would be a nightmare.</p> 13032 <p>The <code>-golden</code> flag will store the <code>test.log</code> and <code>*.lst</code> listings from each test case into respective golden directories. Golden results will automatically contain generic strings instead of local or cloud paths which means that they should match when run with a different cloud service.</p> 13033 <p>Your normal workflow might be as follows: 1. Git-clone the rclone sources locally 2. Modify bisync source and check that it builds 3. Run the whole test suite <code>go test ./cmd/bisync -remote local</code> 4. If some tests show log difference, recheck them individually, e.g.: <code>go test ./cmd/bisync -remote local -case basic</code> 5. If you are convinced with the difference, goldenize all tests at once: <code>go test ./cmd/bisync -remote local -golden</code> 6. Use word diff: <code>git diff --word-diff ./cmd/bisync/testdata/</code>. Please note that normal line-level diff is generally useless here. 7. Check the difference <em>carefully</em>! 8. Commit the change (<code>git commit</code>) <em>only</em> if you are sure. If unsure, save your code changes then wipe the log diffs from git: <code>git reset [--hard]</code>.</p> 13034 <h3 id="structure-of-test-scenarios">Structure of test scenarios</h3> 13035 <ul> 13036 <li><code><testname>/initial/</code> contains a tree of files that will be set as the initial condition on both Path1 and Path2 testdirs.</li> 13037 <li><code><testname>/modfiles/</code> contains files that will be used to modify the Path1 and/or Path2 filesystems.</li> 13038 <li><code><testname>/golden/</code> contains the expected content of the test working directory (<code>workdir</code>) at the completion of the testcase.</li> 13039 <li><code><testname>/scenario.txt</code> contains the body of the test, in the form of various commands to modify files, run bisync, and snapshot listings. Output from these commands is captured to <code>.../workdir/test.log</code> for comparison to the golden files.</li> 13040 </ul> 13041 <h3 id="supported-test-commands">Supported test commands</h3> 13042 <ul> 13043 <li><code>test <some message></code> Print the line to the console and to the <code>test.log</code>: <code>test sync is working correctly with options x, y, z</code></li> 13044 <li><code>copy-listings <prefix></code> Save a copy of all <code>.lst</code> listings in the test working directory with the specified prefix: <code>save-listings exclude-pass-run</code></li> 13045 <li><code>move-listings <prefix></code> Similar to <code>copy-listings</code> but removes the source</li> 13046 <li><code>purge-children <dir></code> This will delete all child files and purge all child subdirs under given directory but keep the parent intact. This behavior is important for tests with Google Drive because removing and re-creating the parent would change its ID.</li> 13047 <li><code>delete-file <file></code> Delete a single file.</li> 13048 <li><code>delete-glob <dir> <pattern></code> Delete a group of files located one level deep in the given directory with names matching a given glob pattern.</li> 13049 <li><code>touch-glob YYYY-MM-DD <dir> <pattern></code> Change modification time on a group of files.</li> 13050 <li><code>touch-copy YYYY-MM-DD <source-file> <dest-dir></code> Change file modification time then copy it to destination.</li> 13051 <li><code>copy-file <source-file> <dest-dir></code> Copy a single file to given directory.</li> 13052 <li><code>copy-as <source-file> <dest-file></code> Similar to above but destination must include both directory and the new file name at destination.</li> 13053 <li><code>copy-dir <src> <dst></code> and <code>sync-dir <src> <dst></code> Copy/sync a directory. Equivalent of <code>rclone copy</code> and <code>rclone sync</code>.</li> 13054 <li><code>list-dirs <dir></code> Equivalent to <code>rclone lsf -R --dirs-only <dir></code></li> 13055 <li><code>bisync [options]</code> Runs bisync against <code>-remote</code> and <code>-remote2</code>.</li> 13056 </ul> 13057 <h3 id="supported-substitution-terms">Supported substitution terms</h3> 13058 <ul> 13059 <li><code>{testdir/}</code> - the root dir of the testcase</li> 13060 <li><code>{datadir/}</code> - the <code>modfiles</code> dir under the testcase root</li> 13061 <li><code>{workdir/}</code> - the temporary test working directory</li> 13062 <li><code>{path1/}</code> - the root of the Path1 test directory tree</li> 13063 <li><code>{path2/}</code> - the root of the Path2 test directory tree</li> 13064 <li><code>{session}</code> - base name of the test listings</li> 13065 <li><code>{/}</code> - OS-specific path separator</li> 13066 <li><code>{spc}</code>, <code>{tab}</code>, <code>{eol}</code> - whitespace</li> 13067 <li><code>{chr:HH}</code> - raw byte with given hexadecimal code</li> 13068 </ul> 13069 <p>Substitution results of the terms named like <code>{dir/}</code> will end with <code>/</code> (or backslash on Windows), so it is not necessary to include slash in the usage, for example <code>delete-file {path1/}file1.txt</code>.</p> 13070 <h2 id="benchmarks">Benchmarks</h2> 13071 <p><em>This section is work in progress.</em></p> 13072 <p>Here are a few data points for scale, execution times, and memory usage.</p> 13073 <p>The first set of data was taken between a local disk to Dropbox. The <a href="https://speedtest.net">speedtest.net</a> download speed was ~170 Mbps, and upload speed was ~10 Mbps. 500 files (~9.5 MB each) had been already synched. 50 files were added in a new directory, each ~9.5 MB, ~475 MB total.</p> 13074 <table> 13075 <colgroup> 13076 <col style="width: 33%" /> 13077 <col style="width: 50%" /> 13078 <col style="width: 16%" /> 13079 </colgroup> 13080 <thead> 13081 <tr class="header"> 13082 <th>Change</th> 13083 <th>Operations and times</th> 13084 <th>Overall run time</th> 13085 </tr> 13086 </thead> 13087 <tbody> 13088 <tr class="odd"> 13089 <td>500 files synched (nothing to move)</td> 13090 <td>1x listings for Path1 & Path2</td> 13091 <td>1.5 sec</td> 13092 </tr> 13093 <tr class="even"> 13094 <td>500 files synched with --check-access</td> 13095 <td>1x listings for Path1 & Path2</td> 13096 <td>1.5 sec</td> 13097 </tr> 13098 <tr class="odd"> 13099 <td>50 new files on remote</td> 13100 <td>Queued 50 copies down: 27 sec</td> 13101 <td>29 sec</td> 13102 </tr> 13103 <tr class="even"> 13104 <td>Moved local dir</td> 13105 <td>Queued 50 copies up: 410 sec, 50 deletes up: 9 sec</td> 13106 <td>421 sec</td> 13107 </tr> 13108 <tr class="odd"> 13109 <td>Moved remote dir</td> 13110 <td>Queued 50 copies down: 31 sec, 50 deletes down: <1 sec</td> 13111 <td>33 sec</td> 13112 </tr> 13113 <tr class="even"> 13114 <td>Delete local dir</td> 13115 <td>Queued 50 deletes up: 9 sec</td> 13116 <td>13 sec</td> 13117 </tr> 13118 </tbody> 13119 </table> 13120 <p>This next data is from a user's application. They had ~400GB of data over 1.96 million files being sync'ed between a Windows local disk and some remote cloud. The file full path length was on average 35 characters (which factors into load time and RAM required).</p> 13121 <ul> 13122 <li>Loading the prior listing into memory (1.96 million files, listing file size 140 MB) took ~30 sec and occupied about 1 GB of RAM.</li> 13123 <li>Getting a fresh listing of the local file system (producing the 140 MB output file) took about XXX sec.</li> 13124 <li>Getting a fresh listing of the remote file system (producing the 140 MB output file) took about XXX sec. The network download speed was measured at XXX Mb/s.</li> 13125 <li>Once the prior and current Path1 and Path2 listings were loaded (a total of four to be loaded, two at a time), determining the deltas was pretty quick (a few seconds for this test case), and the transfer time for any files to be copied was dominated by the network bandwidth.</li> 13126 </ul> 13127 <h2 id="references">References</h2> 13128 <p>rclone's bisync implementation was derived from the <a href="https://github.com/cjnaz/rclonesync-V2">rclonesync-V2</a> project, including documentation and test mechanisms, with <span class="citation" data-cites="cjnaz">[@cjnaz]</span>(https://github.com/cjnaz)'s full support and encouragement.</p> 13129 <p><code>rclone bisync</code> is similar in nature to a range of other projects:</p> 13130 <ul> 13131 <li><a href="https://github.com/bcpierce00/unison">unison</a></li> 13132 <li><a href="https://github.com/syncthing/syncthing">syncthing</a></li> 13133 <li><a href="https://github.com/cjnaz/rclonesync-V2">cjnaz/rclonesync</a></li> 13134 <li><a href="https://github.com/ConorWilliams/rsinc">ConorWilliams/rsinc</a></li> 13135 <li><a href="https://github.com/Jwink3101/syncrclone">jwink3101/syncrclone</a></li> 13136 <li><a href="https://github.com/DavideRossi/upback">DavideRossi/upback</a></li> 13137 </ul> 13138 <p>Bisync adopts the differential synchronization technique, which is based on keeping history of changes performed by both synchronizing sides. See the <em>Dual Shadow Method</em> section in <a href="https://neil.fraser.name/writing/sync/">Neil Fraser's article</a>.</p> 13139 <p>Also note a number of academic publications by <a href="http://www.cis.upenn.edu/%7Ebcpierce/papers/index.shtml#File%20Synchronization">Benjamin Pierce</a> about <em>Unison</em> and synchronization in general.</p> 13140 <h2 id="changelog">Changelog</h2> 13141 <h3 id="v1.66"><code>v1.66</code></h3> 13142 <ul> 13143 <li>Copies and deletes are now handled in one operation instead of two</li> 13144 <li><code>--track-renames</code> and <code>--backup-dir</code> are now supported</li> 13145 <li>Partial uploads known issue on <code>local</code>/<code>ftp</code>/<code>sftp</code> has been resolved (unless using <code>--inplace</code>)</li> 13146 <li>Final listings are now generated from sync results, to avoid needing to re-list</li> 13147 <li>Bisync is now much more resilient to changes that happen during a bisync run, and far less prone to critical errors / undetected changes</li> 13148 <li>Bisync is now capable of rolling a file listing back in cases of uncertainty, essentially marking the file as needing to be rechecked next time.</li> 13149 <li>A few basic terminal colors are now supported, controllable with <a href="https://rclone.org/docs/#color-when"><code>--color</code></a> (<code>AUTO</code>|<code>NEVER</code>|<code>ALWAYS</code>)</li> 13150 <li>Initial listing snapshots of Path1 and Path2 are now generated concurrently, using the same "march" infrastructure as <code>check</code> and <code>sync</code>, for performance improvements and less <a href="https://forum.rclone.org/t/bisync-bugs-and-feature-requests/37636#:~:text=4.%20Listings%20should%20alternate%20between%20paths%20to%20minimize%20errors">risk of error</a>.</li> 13151 <li>Fixed handling of unicode normalization and case insensitivity, support for <a href="https://rclone.org/docs/#fix-case"><code>--fix-case</code></a>, <a href="/docs/#ignore-case-sync"><code>--ignore-case-sync</code></a>, <a href="/docs/#no-unicode-normalization"><code>--no-unicode-normalization</code></a></li> 13152 <li><code>--resync</code> is now much more efficient (especially for users of <code>--create-empty-src-dirs</code>)</li> 13153 <li>Google Docs (and other files of unknown size) are now supported (with the same options as in <code>sync</code>)</li> 13154 <li>Equality checks before a sync conflict rename now fall back to <code>cryptcheck</code> (when possible) or <code>--download</code>, instead of of <code>--size-only</code>, when <code>check</code> is not available.</li> 13155 <li>Bisync no longer fails to find the correct listing file when configs are overridden with backend-specific flags.</li> 13156 <li>Bisync now fully supports comparing based on any combination of size, modtime, and checksum, lifting the prior restriction on backends without modtime support.</li> 13157 <li>Bisync now supports a "Graceful Shutdown" mode to cleanly cancel a run early without requiring <code>--resync</code>.</li> 13158 <li>New <code>--recover</code> flag allows robust recovery in the event of interruptions, without requiring <code>--resync</code>.</li> 13159 <li>A new <code>--max-lock</code> setting allows lock files to automatically renew and expire, for better automatic recovery when a run is interrupted.</li> 13160 <li>Bisync now supports auto-resolving sync conflicts and customizing rename behavior with new <a href="#conflict-resolve"><code>--conflict-resolve</code></a>, <a href="#conflict-loser"><code>--conflict-loser</code></a>, and <a href="#conflict-suffix"><code>--conflict-suffix</code></a> flags.</li> 13161 <li>A new <a href="#resync-mode"><code>--resync-mode</code></a> flag allows more control over which version of a file gets kept during a <code>--resync</code>.</li> 13162 <li>Bisync now supports <a href="https://rclone.org/docs/#retries-int"><code>--retries</code></a> and <a href="/docs/#retries-sleep-time"><code>--retries-sleep</code></a> (when <a href="#resilient"><code>--resilient</code></a> is set.)</li> 13163 </ul> 13164 <h3 id="v1.64"><code>v1.64</code></h3> 13165 <ul> 13166 <li>Fixed an <a href="https://forum.rclone.org/t/bisync-bugs-and-feature-requests/37636#:~:text=1.%20Dry%20runs%20are%20not%20completely%20dry">issue</a> causing dry runs to inadvertently commit filter changes</li> 13167 <li>Fixed an <a href="https://forum.rclone.org/t/bisync-bugs-and-feature-requests/37636#:~:text=2.%20%2D%2Dresync%20deletes%20data%2C%20contrary%20to%20docs">issue</a> causing <code>--resync</code> to erroneously delete empty folders and duplicate files unique to Path2</li> 13168 <li><code>--check-access</code> is now enforced during <code>--resync</code>, preventing data loss in <a href="https://forum.rclone.org/t/bisync-bugs-and-feature-requests/37636#:~:text=%2D%2Dcheck%2Daccess%20doesn%27t%20always%20fail%20when%20it%20should">certain user error scenarios</a></li> 13169 <li>Fixed an <a href="https://forum.rclone.org/t/bisync-bugs-and-feature-requests/37636#:~:text=5.%20Bisync%20reads%20files%20in%20excluded%20directories%20during%20delete%20operations">issue</a> causing bisync to consider more files than necessary due to overbroad filters during delete operations</li> 13170 <li><a href="https://forum.rclone.org/t/bisync-bugs-and-feature-requests/37636#:~:text=1.%20Identical%20files%20should%20be%20left%20alone%2C%20even%20if%20new/newer/changed%20on%20both%20sides">Improved detection of false positive change conflicts</a> (identical files are now left alone instead of renamed)</li> 13171 <li>Added <a href="https://forum.rclone.org/t/bisync-bugs-and-feature-requests/37636#:~:text=3.%20Bisync%20should%20create/delete%20empty%20directories%20as%20sync%20does%2C%20when%20%2D%2Dcreate%2Dempty%2Dsrc%2Ddirs%20is%20passed">support for <code>--create-empty-src-dirs</code></a></li> 13172 <li>Added experimental <code>--resilient</code> mode to allow <a href="https://forum.rclone.org/t/bisync-bugs-and-feature-requests/37636#:~:text=2.%20Bisync%20should%20be%20more%20resilient%20to%20self%2Dcorrectable%20errors">recovery from self-correctable errors</a></li> 13173 <li>Added <a href="https://forum.rclone.org/t/bisync-bugs-and-feature-requests/37636#:~:text=6.%20%2D%2Dignore%2Dchecksum%20should%20be%20split%20into%20two%20flags%20for%20separate%20purposes">new <code>--ignore-listing-checksum</code> flag</a> to distinguish from <code>--ignore-checksum</code></li> 13174 <li><a href="https://forum.rclone.org/t/bisync-bugs-and-feature-requests/37636#:~:text=6.%20Deletes%20take%20several%20times%20longer%20than%20copies">Performance improvements</a> for large remotes</li> 13175 <li>Documentation and testing improvements</li> 13176 </ul> 13177 <h1 id="release-signing">Release signing</h1> 13178 <p>The hashes of the binary artefacts of the rclone release are signed with a public PGP/GPG key. This can be verified manually as described below.</p> 13179 <p>The same mechanism is also used by <a href="https://rclone.org/commands/rclone_selfupdate/">rclone selfupdate</a> to verify that the release has not been tampered with before the new update is installed. This checks the SHA256 hash and the signature with a public key compiled into the rclone binary.</p> 13180 <h2 id="release-signing-key">Release signing key</h2> 13181 <p>You may obtain the release signing key from:</p> 13182 <ul> 13183 <li>From <a href="/KEYS">KEYS</a> on this website - this file contains all past signing keys also.</li> 13184 <li>The git repository hosted on GitHub - https://github.com/rclone/rclone/blob/master/docs/content/KEYS</li> 13185 <li><code>gpg --keyserver hkps://keys.openpgp.org --search nick@craig-wood.com</code></li> 13186 <li><code>gpg --keyserver hkps://keyserver.ubuntu.com --search nick@craig-wood.com</code></li> 13187 <li>https://www.craig-wood.com/nick/pub/pgp-key.txt</li> 13188 </ul> 13189 <p>After importing the key, verify that the fingerprint of one of the keys matches: <code>FBF737ECE9F8AB18604BD2AC93935E02FF3B54FA</code> as this key is used for signing.</p> 13190 <p>We recommend that you cross-check the fingerprint shown above through the domains listed below. By cross-checking the integrity of the fingerprint across multiple domains you can be confident that you obtained the correct key.</p> 13191 <ul> 13192 <li>The <a href="https://github.com/rclone/rclone/blob/master/docs/content/release_signing.md">source for this page on GitHub</a>.</li> 13193 <li>Through DNS <code>dig key.rclone.org txt</code></li> 13194 </ul> 13195 <p>If you find anything that doesn't not match, please contact the developers at once.</p> 13196 <h2 id="how-to-verify-the-release">How to verify the release</h2> 13197 <p>In the release directory you will see the release files and some files called <code>MD5SUMS</code>, <code>SHA1SUMS</code> and <code>SHA256SUMS</code>.</p> 13198 <pre><code>$ rclone lsf --http-url https://downloads.rclone.org/v1.63.1 :http: 13199 MD5SUMS 13200 SHA1SUMS 13201 SHA256SUMS 13202 rclone-v1.63.1-freebsd-386.zip 13203 rclone-v1.63.1-freebsd-amd64.zip 13204 ... 13205 rclone-v1.63.1-windows-arm64.zip 13206 rclone-v1.63.1.tar.gz 13207 version.txt</code></pre> 13208 <p>The <code>MD5SUMS</code>, <code>SHA1SUMS</code> and <code>SHA256SUMS</code> contain hashes of the binary files in the release directory along with a signature.</p> 13209 <p>For example:</p> 13210 <pre><code>$ rclone cat --http-url https://downloads.rclone.org/v1.63.1 :http:SHA256SUMS 13211 -----BEGIN PGP SIGNED MESSAGE----- 13212 Hash: SHA1 13213 13214 f6d1b2d7477475ce681bdce8cb56f7870f174cb6b2a9ac5d7b3764296ea4a113 rclone-v1.63.1-freebsd-386.zip 13215 7266febec1f01a25d6575de51c44ddf749071a4950a6384e4164954dff7ac37e rclone-v1.63.1-freebsd-amd64.zip 13216 ... 13217 66ca083757fb22198309b73879831ed2b42309892394bf193ff95c75dff69c73 rclone-v1.63.1-windows-amd64.zip 13218 bbb47c16882b6c5f2e8c1b04229378e28f68734c613321ef0ea2263760f74cd0 rclone-v1.63.1-windows-arm64.zip 13219 -----BEGIN PGP SIGNATURE----- 13220 13221 iF0EARECAB0WIQT79zfs6firGGBL0qyTk14C/ztU+gUCZLVKJQAKCRCTk14C/ztU 13222 +pZuAJ0XJ+QWLP/3jCtkmgcgc4KAwd/rrwCcCRZQ7E+oye1FPY46HOVzCFU3L7g= 13223 =8qrL 13224 -----END PGP SIGNATURE-----</code></pre> 13225 <h3 id="download-the-files">Download the files</h3> 13226 <p>The first step is to download the binary and SUMs file and verify that the SUMs you have downloaded match. Here we download <code>rclone-v1.63.1-windows-amd64.zip</code> - choose the binary (or binaries) appropriate to your architecture. We've also chosen the <code>SHA256SUMS</code> as these are the most secure. You could verify the other types of hash also for extra security. <code>rclone selfupdate</code> verifies just the <code>SHA256SUMS</code>.</p> 13227 <pre><code>$ mkdir /tmp/check 13228 $ cd /tmp/check 13229 $ rclone copy --http-url https://downloads.rclone.org/v1.63.1 :http:SHA256SUMS . 13230 $ rclone copy --http-url https://downloads.rclone.org/v1.63.1 :http:rclone-v1.63.1-windows-amd64.zip .</code></pre> 13231 <h3 id="verify-the-signatures">Verify the signatures</h3> 13232 <p>First verify the signatures on the SHA256 file.</p> 13233 <p>Import the key. See above for ways to verify this key is correct.</p> 13234 <pre><code>$ gpg --keyserver keyserver.ubuntu.com --receive-keys FBF737ECE9F8AB18604BD2AC93935E02FF3B54FA 13235 gpg: key 93935E02FF3B54FA: public key "Nick Craig-Wood <nick@craig-wood.com>" imported 13236 gpg: Total number processed: 1 13237 gpg: imported: 1</code></pre> 13238 <p>Then check the signature:</p> 13239 <pre><code>$ gpg --verify SHA256SUMS 13240 gpg: Signature made Mon 17 Jul 2023 15:03:17 BST 13241 gpg: using DSA key FBF737ECE9F8AB18604BD2AC93935E02FF3B54FA 13242 gpg: Good signature from "Nick Craig-Wood <nick@craig-wood.com>" [ultimate]</code></pre> 13243 <p>Verify the signature was good and is using the fingerprint shown above.</p> 13244 <p>Repeat for <code>MD5SUMS</code> and <code>SHA1SUMS</code> if desired.</p> 13245 <h3 id="verify-the-hashes">Verify the hashes</h3> 13246 <p>Now that we know the signatures on the hashes are OK we can verify the binaries match the hashes, completing the verification.</p> 13247 <pre><code>$ sha256sum -c SHA256SUMS 2>&1 | grep OK 13248 rclone-v1.63.1-windows-amd64.zip: OK</code></pre> 13249 <p>Or do the check with rclone</p> 13250 <pre><code>$ rclone hashsum sha256 -C SHA256SUMS rclone-v1.63.1-windows-amd64.zip 13251 2023/09/11 10:53:58 NOTICE: SHA256SUMS: improperly formatted checksum line 0 13252 2023/09/11 10:53:58 NOTICE: SHA256SUMS: improperly formatted checksum line 1 13253 2023/09/11 10:53:58 NOTICE: SHA256SUMS: improperly formatted checksum line 49 13254 2023/09/11 10:53:58 NOTICE: SHA256SUMS: 4 warning(s) suppressed... 13255 = rclone-v1.63.1-windows-amd64.zip 13256 2023/09/11 10:53:58 NOTICE: Local file system at /tmp/check: 0 differences found 13257 2023/09/11 10:53:58 NOTICE: Local file system at /tmp/check: 1 matching files</code></pre> 13258 <h3 id="verify-signatures-and-hashes-together">Verify signatures and hashes together</h3> 13259 <p>You can verify the signatures and hashes in one command line like this:</p> 13260 <pre><code>$ gpg --decrypt SHA256SUMS | sha256sum -c --ignore-missing 13261 gpg: Signature made Mon 17 Jul 2023 15:03:17 BST 13262 gpg: using DSA key FBF737ECE9F8AB18604BD2AC93935E02FF3B54FA 13263 gpg: Good signature from "Nick Craig-Wood <nick@craig-wood.com>" [ultimate] 13264 gpg: aka "Nick Craig-Wood <nick@memset.com>" [unknown] 13265 rclone-v1.63.1-windows-amd64.zip: OK</code></pre> 13266 <h1 id="fichier">1Fichier</h1> 13267 <p>This is a backend for the <a href="https://1fichier.com">1fichier</a> cloud storage service. Note that a Premium subscription is required to use the API.</p> 13268 <p>Paths are specified as <code>remote:path</code></p> 13269 <p>Paths may be as deep as required, e.g. <code>remote:directory/subdirectory</code>.</p> 13270 <h2 id="configuration">Configuration</h2> 13271 <p>The initial setup for 1Fichier involves getting the API key from the website which you need to do in your browser.</p> 13272 <p>Here is an example of how to make a remote called <code>remote</code>. First run:</p> 13273 <pre><code> rclone config</code></pre> 13274 <p>This will guide you through an interactive setup process:</p> 13275 <pre><code>No remotes found, make a new one? 13276 n) New remote 13277 s) Set configuration password 13278 q) Quit config 13279 n/s/q> n 13280 name> remote 13281 Type of storage to configure. 13282 Enter a string value. Press Enter for the default (""). 13283 Choose a number from below, or type in your own value 13284 [snip] 13285 XX / 1Fichier 13286 \ "fichier" 13287 [snip] 13288 Storage> fichier 13289 ** See help for fichier backend at: https://rclone.org/fichier/ ** 13290 13291 Your API Key, get it from https://1fichier.com/console/params.pl 13292 Enter a string value. Press Enter for the default (""). 13293 api_key> example_key 13294 13295 Edit advanced config? (y/n) 13296 y) Yes 13297 n) No 13298 y/n> 13299 Remote config 13300 -------------------- 13301 [remote] 13302 type = fichier 13303 api_key = example_key 13304 -------------------- 13305 y) Yes this is OK 13306 e) Edit this remote 13307 d) Delete this remote 13308 y/e/d> y</code></pre> 13309 <p>Once configured you can then use <code>rclone</code> like this,</p> 13310 <p>List directories in top level of your 1Fichier account</p> 13311 <pre><code>rclone lsd remote:</code></pre> 13312 <p>List all the files in your 1Fichier account</p> 13313 <pre><code>rclone ls remote:</code></pre> 13314 <p>To copy a local directory to a 1Fichier directory called backup</p> 13315 <pre><code>rclone copy /home/source remote:backup</code></pre> 13316 <h3 id="modification-times-and-hashes">Modification times and hashes</h3> 13317 <p>1Fichier does not support modification times. It supports the Whirlpool hash algorithm.</p> 13318 <h3 id="duplicated-files">Duplicated files</h3> 13319 <p>1Fichier can have two files with exactly the same name and path (unlike a normal file system).</p> 13320 <p>Duplicated files cause problems with the syncing and you will see messages in the log about duplicates.</p> 13321 <h3 id="restricted-filename-characters">Restricted filename characters</h3> 13322 <p>In addition to the <a href="https://rclone.org/overview/#restricted-characters">default restricted characters set</a> the following characters are also replaced:</p> 13323 <table> 13324 <thead> 13325 <tr class="header"> 13326 <th>Character</th> 13327 <th style="text-align: center;">Value</th> 13328 <th style="text-align: center;">Replacement</th> 13329 </tr> 13330 </thead> 13331 <tbody> 13332 <tr class="odd"> 13333 <td>\</td> 13334 <td style="text-align: center;">0x5C</td> 13335 <td style="text-align: center;">＼</td> 13336 </tr> 13337 <tr class="even"> 13338 <td><</td> 13339 <td style="text-align: center;">0x3C</td> 13340 <td style="text-align: center;">＜</td> 13341 </tr> 13342 <tr class="odd"> 13343 <td>></td> 13344 <td style="text-align: center;">0x3E</td> 13345 <td style="text-align: center;">＞</td> 13346 </tr> 13347 <tr class="even"> 13348 <td>"</td> 13349 <td style="text-align: center;">0x22</td> 13350 <td style="text-align: center;">＂</td> 13351 </tr> 13352 <tr class="odd"> 13353 <td>$</td> 13354 <td style="text-align: center;">0x24</td> 13355 <td style="text-align: center;">＄</td> 13356 </tr> 13357 <tr class="even"> 13358 <td>`</td> 13359 <td style="text-align: center;">0x60</td> 13360 <td style="text-align: center;">｀</td> 13361 </tr> 13362 <tr class="odd"> 13363 <td>'</td> 13364 <td style="text-align: center;">0x27</td> 13365 <td style="text-align: center;">＇</td> 13366 </tr> 13367 </tbody> 13368 </table> 13369 <p>File names can also not start or end with the following characters. These only get replaced if they are the first or last character in the name:</p> 13370 <table> 13371 <thead> 13372 <tr class="header"> 13373 <th>Character</th> 13374 <th style="text-align: center;">Value</th> 13375 <th style="text-align: center;">Replacement</th> 13376 </tr> 13377 </thead> 13378 <tbody> 13379 <tr class="odd"> 13380 <td>SP</td> 13381 <td style="text-align: center;">0x20</td> 13382 <td style="text-align: center;">␠</td> 13383 </tr> 13384 </tbody> 13385 </table> 13386 <p>Invalid UTF-8 bytes will also be <a href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they can't be used in JSON strings.</p> 13387 <h3 id="standard-options">Standard options</h3> 13388 <p>Here are the Standard options specific to fichier (1Fichier).</p> 13389 <h4 id="fichier-api-key">--fichier-api-key</h4> 13390 <p>Your API Key, get it from https://1fichier.com/console/params.pl.</p> 13391 <p>Properties:</p> 13392 <ul> 13393 <li>Config: api_key</li> 13394 <li>Env Var: RCLONE_FICHIER_API_KEY</li> 13395 <li>Type: string</li> 13396 <li>Required: false</li> 13397 </ul> 13398 <h3 id="advanced-options">Advanced options</h3> 13399 <p>Here are the Advanced options specific to fichier (1Fichier).</p> 13400 <h4 id="fichier-shared-folder">--fichier-shared-folder</h4> 13401 <p>If you want to download a shared folder, add this parameter.</p> 13402 <p>Properties:</p> 13403 <ul> 13404 <li>Config: shared_folder</li> 13405 <li>Env Var: RCLONE_FICHIER_SHARED_FOLDER</li> 13406 <li>Type: string</li> 13407 <li>Required: false</li> 13408 </ul> 13409 <h4 id="fichier-file-password">--fichier-file-password</h4> 13410 <p>If you want to download a shared file that is password protected, add this parameter.</p> 13411 <p><strong>NB</strong> Input to this must be obscured - see <a href="https://rclone.org/commands/rclone_obscure/">rclone obscure</a>.</p> 13412 <p>Properties:</p> 13413 <ul> 13414 <li>Config: file_password</li> 13415 <li>Env Var: RCLONE_FICHIER_FILE_PASSWORD</li> 13416 <li>Type: string</li> 13417 <li>Required: false</li> 13418 </ul> 13419 <h4 id="fichier-folder-password">--fichier-folder-password</h4> 13420 <p>If you want to list the files in a shared folder that is password protected, add this parameter.</p> 13421 <p><strong>NB</strong> Input to this must be obscured - see <a href="https://rclone.org/commands/rclone_obscure/">rclone obscure</a>.</p> 13422 <p>Properties:</p> 13423 <ul> 13424 <li>Config: folder_password</li> 13425 <li>Env Var: RCLONE_FICHIER_FOLDER_PASSWORD</li> 13426 <li>Type: string</li> 13427 <li>Required: false</li> 13428 </ul> 13429 <h4 id="fichier-cdn">--fichier-cdn</h4> 13430 <p>Set if you wish to use CDN download links.</p> 13431 <p>Properties:</p> 13432 <ul> 13433 <li>Config: cdn</li> 13434 <li>Env Var: RCLONE_FICHIER_CDN</li> 13435 <li>Type: bool</li> 13436 <li>Default: false</li> 13437 </ul> 13438 <h4 id="fichier-encoding">--fichier-encoding</h4> 13439 <p>The encoding for the backend.</p> 13440 <p>See the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 13441 <p>Properties:</p> 13442 <ul> 13443 <li>Config: encoding</li> 13444 <li>Env Var: RCLONE_FICHIER_ENCODING</li> 13445 <li>Type: Encoding</li> 13446 <li>Default: Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot</li> 13447 </ul> 13448 <h4 id="fichier-description">--fichier-description</h4> 13449 <p>Description of the remote</p> 13450 <p>Properties:</p> 13451 <ul> 13452 <li>Config: description</li> 13453 <li>Env Var: RCLONE_FICHIER_DESCRIPTION</li> 13454 <li>Type: string</li> 13455 <li>Required: false</li> 13456 </ul> 13457 <h2 id="limitations-5">Limitations</h2> 13458 <p><code>rclone about</code> is not supported by the 1Fichier backend. Backends without this capability cannot determine free space for an rclone mount or use policy <code>mfs</code> (most free space) as a member of an rclone union remote.</p> 13459 <p>See <a href="https://rclone.org/overview/#optional-features">List of backends that do not support rclone about</a> and <a href="https://rclone.org/commands/rclone_about/">rclone about</a></p> 13460 <h1 id="alias">Alias</h1> 13461 <p>The <code>alias</code> remote provides a new name for another remote.</p> 13462 <p>Paths may be as deep as required or a local path, e.g. <code>remote:directory/subdirectory</code> or <code>/directory/subdirectory</code>.</p> 13463 <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> 13464 <p>Subfolders can be used in target remote. Assume an alias remote named <code>backup</code> with the target <code>mydrive:private/backup</code>. Invoking <code>rclone mkdir backup:desktop</code> is exactly the same as invoking <code>rclone mkdir mydrive:private/backup/desktop</code>.</p> 13465 <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> 13466 <p>The target remote can also be a <a href="https://rclone.org/docs/#connection-strings">connection string</a>. This can be used to modify the config of a remote for different uses, e.g. the alias <code>myDriveTrash</code> with the target remote <code>myDrive,trashed_only:</code> can be used to only show the trashed files in <code>myDrive</code>.</p> 13467 <h2 id="configuration-1">Configuration</h2> 13468 <p>Here is an example of how to make an alias called <code>remote</code> for local folder. First run:</p> 13469 <pre><code> rclone config</code></pre> 13470 <p>This will guide you through an interactive setup process:</p> 13471 <pre><code>No remotes found, make a new one? 13472 n) New remote 13473 s) Set configuration password 13474 q) Quit config 13475 n/s/q> n 13476 name> remote 13477 Type of storage to configure. 13478 Choose a number from below, or type in your own value 13479 [snip] 13480 XX / Alias for an existing remote 13481 \ "alias" 13482 [snip] 13483 Storage> alias 13484 Remote or path to alias. 13485 Can be "myremote:path/to/dir", "myremote:bucket", "myremote:" or "/local/path". 13486 remote> /mnt/storage/backup 13487 Remote config 13488 -------------------- 13489 [remote] 13490 remote = /mnt/storage/backup 13491 -------------------- 13492 y) Yes this is OK 13493 e) Edit this remote 13494 d) Delete this remote 13495 y/e/d> y 13496 Current remotes: 13497 13498 Name Type 13499 ==== ==== 13500 remote alias 13501 13502 e) Edit existing remote 13503 n) New remote 13504 d) Delete remote 13505 r) Rename remote 13506 c) Copy remote 13507 s) Set configuration password 13508 q) Quit config 13509 e/n/d/r/c/s/q> q</code></pre> 13510 <p>Once configured you can then use <code>rclone</code> like this,</p> 13511 <p>List directories in top level in <code>/mnt/storage/backup</code></p> 13512 <pre><code>rclone lsd remote:</code></pre> 13513 <p>List all the files in <code>/mnt/storage/backup</code></p> 13514 <pre><code>rclone ls remote:</code></pre> 13515 <p>Copy another local directory to the alias directory called source</p> 13516 <pre><code>rclone copy /home/source remote:source</code></pre> 13517 <h3 id="standard-options-1">Standard options</h3> 13518 <p>Here are the Standard options specific to alias (Alias for an existing remote).</p> 13519 <h4 id="alias-remote">--alias-remote</h4> 13520 <p>Remote or path to alias.</p> 13521 <p>Can be "myremote:path/to/dir", "myremote:bucket", "myremote:" or "/local/path".</p> 13522 <p>Properties:</p> 13523 <ul> 13524 <li>Config: remote</li> 13525 <li>Env Var: RCLONE_ALIAS_REMOTE</li> 13526 <li>Type: string</li> 13527 <li>Required: true</li> 13528 </ul> 13529 <h3 id="advanced-options-1">Advanced options</h3> 13530 <p>Here are the Advanced options specific to alias (Alias for an existing remote).</p> 13531 <h4 id="alias-description">--alias-description</h4> 13532 <p>Description of the remote</p> 13533 <p>Properties:</p> 13534 <ul> 13535 <li>Config: description</li> 13536 <li>Env Var: RCLONE_ALIAS_DESCRIPTION</li> 13537 <li>Type: string</li> 13538 <li>Required: false</li> 13539 </ul> 13540 <h1 id="amazon-s3-storage-providers">Amazon S3 Storage Providers</h1> 13541 <p>The S3 backend can be used with a number of different providers:</p> 13542 <ul> 13543 <li>AWS S3</li> 13544 <li>Alibaba Cloud (Aliyun) Object Storage System (OSS)</li> 13545 <li>Ceph</li> 13546 <li>China Mobile Ecloud Elastic Object Storage (EOS)</li> 13547 <li>Cloudflare R2</li> 13548 <li>Arvan Cloud Object Storage (AOS)</li> 13549 <li>DigitalOcean Spaces</li> 13550 <li>Dreamhost</li> 13551 <li>GCS</li> 13552 <li>Huawei OBS</li> 13553 <li>IBM COS S3</li> 13554 <li>IDrive e2</li> 13555 <li>IONOS Cloud</li> 13556 <li>Leviia Object Storage</li> 13557 <li>Liara Object Storage</li> 13558 <li>Linode Object Storage</li> 13559 <li>Minio</li> 13560 <li>Petabox</li> 13561 <li>Qiniu Cloud Object Storage (Kodo)</li> 13562 <li>RackCorp Object Storage</li> 13563 <li>Rclone Serve S3</li> 13564 <li>Scaleway</li> 13565 <li>Seagate Lyve Cloud</li> 13566 <li>SeaweedFS</li> 13567 <li>StackPath</li> 13568 <li>Storj</li> 13569 <li>Synology C2 Object Storage</li> 13570 <li>Tencent Cloud Object Storage (COS)</li> 13571 <li>Wasabi</li> 13572 </ul> 13573 <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, e.g. <code>remote:bucket/path/to/dir</code>.</p> 13574 <p>Once you have made a remote (see the provider specific section above) you can use it like this:</p> 13575 <p>See all buckets</p> 13576 <pre><code>rclone lsd remote:</code></pre> 13577 <p>Make a new bucket</p> 13578 <pre><code>rclone mkdir remote:bucket</code></pre> 13579 <p>List the contents of a bucket</p> 13580 <pre><code>rclone ls remote:bucket</code></pre> 13581 <p>Sync <code>/home/local/directory</code> to the remote bucket, deleting any excess files in the bucket.</p> 13582 <pre><code>rclone sync --interactive /home/local/directory remote:bucket</code></pre> 13583 <h2 id="configuration-2">Configuration</h2> 13584 <p>Here is an example of making an s3 configuration for the AWS S3 provider. Most applies to the other providers as well, any differences are described <a href="#providers">below</a>.</p> 13585 <p>First run</p> 13586 <pre><code>rclone config</code></pre> 13587 <p>This will guide you through an interactive setup process.</p> 13588 <pre><code>No remotes found, make a new one? 13589 n) New remote 13590 s) Set configuration password 13591 q) Quit config 13592 n/s/q> n 13593 name> remote 13594 Type of storage to configure. 13595 Choose a number from below, or type in your own value 13596 [snip] 13597 XX / Amazon S3 Compliant Storage Providers including AWS, ... 13598 \ "s3" 13599 [snip] 13600 Storage> s3 13601 Choose your S3 provider. 13602 Choose a number from below, or type in your own value 13603 1 / Amazon Web Services (AWS) S3 13604 \ "AWS" 13605 2 / Ceph Object Storage 13606 \ "Ceph" 13607 3 / DigitalOcean Spaces 13608 \ "DigitalOcean" 13609 4 / Dreamhost DreamObjects 13610 \ "Dreamhost" 13611 5 / IBM COS S3 13612 \ "IBMCOS" 13613 6 / Minio Object Storage 13614 \ "Minio" 13615 7 / Wasabi Object Storage 13616 \ "Wasabi" 13617 8 / Any other S3 compatible provider 13618 \ "Other" 13619 provider> 1 13620 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. 13621 Choose a number from below, or type in your own value 13622 1 / Enter AWS credentials in the next step 13623 \ "false" 13624 2 / Get AWS credentials from the environment (env vars or IAM) 13625 \ "true" 13626 env_auth> 1 13627 AWS Access Key ID - leave blank for anonymous access or runtime credentials. 13628 access_key_id> XXX 13629 AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials. 13630 secret_access_key> YYY 13631 Region to connect to. 13632 Choose a number from below, or type in your own value 13633 / The default endpoint - a good choice if you are unsure. 13634 1 | US Region, Northern Virginia, or Pacific Northwest. 13635 | Leave location constraint empty. 13636 \ "us-east-1" 13637 / US East (Ohio) Region 13638 2 | Needs location constraint us-east-2. 13639 \ "us-east-2" 13640 / US West (Oregon) Region 13641 3 | Needs location constraint us-west-2. 13642 \ "us-west-2" 13643 / US West (Northern California) Region 13644 4 | Needs location constraint us-west-1. 13645 \ "us-west-1" 13646 / Canada (Central) Region 13647 5 | Needs location constraint ca-central-1. 13648 \ "ca-central-1" 13649 / EU (Ireland) Region 13650 6 | Needs location constraint EU or eu-west-1. 13651 \ "eu-west-1" 13652 / EU (London) Region 13653 7 | Needs location constraint eu-west-2. 13654 \ "eu-west-2" 13655 / EU (Frankfurt) Region 13656 8 | Needs location constraint eu-central-1. 13657 \ "eu-central-1" 13658 / Asia Pacific (Singapore) Region 13659 9 | Needs location constraint ap-southeast-1. 13660 \ "ap-southeast-1" 13661 / Asia Pacific (Sydney) Region 13662 10 | Needs location constraint ap-southeast-2. 13663 \ "ap-southeast-2" 13664 / Asia Pacific (Tokyo) Region 13665 11 | Needs location constraint ap-northeast-1. 13666 \ "ap-northeast-1" 13667 / Asia Pacific (Seoul) 13668 12 | Needs location constraint ap-northeast-2. 13669 \ "ap-northeast-2" 13670 / Asia Pacific (Mumbai) 13671 13 | Needs location constraint ap-south-1. 13672 \ "ap-south-1" 13673 / Asia Pacific (Hong Kong) Region 13674 14 | Needs location constraint ap-east-1. 13675 \ "ap-east-1" 13676 / South America (Sao Paulo) Region 13677 15 | Needs location constraint sa-east-1. 13678 \ "sa-east-1" 13679 region> 1 13680 Endpoint for S3 API. 13681 Leave blank if using AWS to use the default endpoint for the region. 13682 endpoint> 13683 Location constraint - must be set to match the Region. Used when creating buckets only. 13684 Choose a number from below, or type in your own value 13685 1 / Empty for US Region, Northern Virginia, or Pacific Northwest. 13686 \ "" 13687 2 / US East (Ohio) Region. 13688 \ "us-east-2" 13689 3 / US West (Oregon) Region. 13690 \ "us-west-2" 13691 4 / US West (Northern California) Region. 13692 \ "us-west-1" 13693 5 / Canada (Central) Region. 13694 \ "ca-central-1" 13695 6 / EU (Ireland) Region. 13696 \ "eu-west-1" 13697 7 / EU (London) Region. 13698 \ "eu-west-2" 13699 8 / EU Region. 13700 \ "EU" 13701 9 / Asia Pacific (Singapore) Region. 13702 \ "ap-southeast-1" 13703 10 / Asia Pacific (Sydney) Region. 13704 \ "ap-southeast-2" 13705 11 / Asia Pacific (Tokyo) Region. 13706 \ "ap-northeast-1" 13707 12 / Asia Pacific (Seoul) 13708 \ "ap-northeast-2" 13709 13 / Asia Pacific (Mumbai) 13710 \ "ap-south-1" 13711 14 / Asia Pacific (Hong Kong) 13712 \ "ap-east-1" 13713 15 / South America (Sao Paulo) Region. 13714 \ "sa-east-1" 13715 location_constraint> 1 13716 Canned ACL used when creating buckets and/or storing objects in S3. 13717 For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl 13718 Choose a number from below, or type in your own value 13719 1 / Owner gets FULL_CONTROL. No one else has access rights (default). 13720 \ "private" 13721 2 / Owner gets FULL_CONTROL. The AllUsers group gets READ access. 13722 \ "public-read" 13723 / Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. 13724 3 | Granting this on a bucket is generally not recommended. 13725 \ "public-read-write" 13726 4 / Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access. 13727 \ "authenticated-read" 13728 / Object owner gets FULL_CONTROL. Bucket owner gets READ access. 13729 5 | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it. 13730 \ "bucket-owner-read" 13731 / Both the object owner and the bucket owner get FULL_CONTROL over the object. 13732 6 | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it. 13733 \ "bucket-owner-full-control" 13734 acl> 1 13735 The server-side encryption algorithm used when storing this object in S3. 13736 Choose a number from below, or type in your own value 13737 1 / None 13738 \ "" 13739 2 / AES256 13740 \ "AES256" 13741 server_side_encryption> 1 13742 The storage class to use when storing objects in S3. 13743 Choose a number from below, or type in your own value 13744 1 / Default 13745 \ "" 13746 2 / Standard storage class 13747 \ "STANDARD" 13748 3 / Reduced redundancy storage class 13749 \ "REDUCED_REDUNDANCY" 13750 4 / Standard Infrequent Access storage class 13751 \ "STANDARD_IA" 13752 5 / One Zone Infrequent Access storage class 13753 \ "ONEZONE_IA" 13754 6 / Glacier storage class 13755 \ "GLACIER" 13756 7 / Glacier Deep Archive storage class 13757 \ "DEEP_ARCHIVE" 13758 8 / Intelligent-Tiering storage class 13759 \ "INTELLIGENT_TIERING" 13760 9 / Glacier Instant Retrieval storage class 13761 \ "GLACIER_IR" 13762 storage_class> 1 13763 Remote config 13764 -------------------- 13765 [remote] 13766 type = s3 13767 provider = AWS 13768 env_auth = false 13769 access_key_id = XXX 13770 secret_access_key = YYY 13771 region = us-east-1 13772 endpoint = 13773 location_constraint = 13774 acl = private 13775 server_side_encryption = 13776 storage_class = 13777 -------------------- 13778 y) Yes this is OK 13779 e) Edit this remote 13780 d) Delete this remote 13781 y/e/d></code></pre> 13782 <h3 id="modification-times-and-hashes-1">Modification times and hashes</h3> 13783 <h4 id="modification-times-1">Modification times</h4> 13784 <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> 13785 <p>If the modification time needs to be updated rclone will attempt to perform a server side copy to update the modification if the object can be copied in a single part. In the case the object is larger than 5Gb or is in Glacier or Glacier Deep Archive storage the object will be uploaded rather than copied.</p> 13786 <p>Note that reading this from the object takes an additional <code>HEAD</code> request as the metadata isn't returned in object listings.</p> 13787 <h4 id="hashes">Hashes</h4> 13788 <p>For small objects which weren't uploaded as multipart uploads (objects sized below <code>--s3-upload-cutoff</code> if uploaded with rclone) rclone uses the <code>ETag:</code> header as an MD5 checksum.</p> 13789 <p>However for objects which were uploaded as multipart uploads or with server side encryption (SSE-AWS or SSE-C) the <code>ETag</code> header is no longer the MD5 sum of the data, so rclone adds an additional piece of metadata <code>X-Amz-Meta-Md5chksum</code> which is a base64 encoded MD5 hash (in the same format as is required for <code>Content-MD5</code>). You can use base64 -d and hexdump to check this value manually:</p> 13790 <pre><code>echo 'VWTGdNx3LyXQDfA0e2Edxw==' | base64 -d | hexdump</code></pre> 13791 <p>or you can use <code>rclone check</code> to verify the hashes are OK.</p> 13792 <p>For large objects, calculating this hash can take some time so the addition of this hash can be disabled with <code>--s3-disable-checksum</code>. This will mean that these objects do not have an MD5 checksum.</p> 13793 <p>Note that reading this from the object takes an additional <code>HEAD</code> request as the metadata isn't returned in object listings.</p> 13794 <h3 id="reducing-costs">Reducing costs</h3> 13795 <h4 id="avoiding-head-requests-to-read-the-modification-time">Avoiding HEAD requests to read the modification time</h4> 13796 <p>By default, rclone will use the modification time of objects stored in S3 for syncing. This is stored in object metadata which unfortunately takes an extra HEAD request to read which can be expensive (in time and money).</p> 13797 <p>The modification time is used by default for all operations that require checking the time a file was last updated. It allows rclone to treat the remote more like a true filesystem, but it is inefficient on S3 because it requires an extra API call to retrieve the metadata.</p> 13798 <p>The extra API calls can be avoided when syncing (using <code>rclone sync</code> or <code>rclone copy</code>) in a few different ways, each with its own tradeoffs.</p> 13799 <ul> 13800 <li><code>--size-only</code> 13801 <ul> 13802 <li>Only checks the size of files.</li> 13803 <li>Uses no extra transactions.</li> 13804 <li>If the file doesn't change size then rclone won't detect it has changed.</li> 13805 <li><code>rclone sync --size-only /path/to/source s3:bucket</code></li> 13806 </ul></li> 13807 <li><code>--checksum</code> 13808 <ul> 13809 <li>Checks the size and MD5 checksum of files.</li> 13810 <li>Uses no extra transactions.</li> 13811 <li>The most accurate detection of changes possible.</li> 13812 <li>Will cause the source to read an MD5 checksum which, if it is a local disk, will cause lots of disk activity.</li> 13813 <li>If the source and destination are both S3 this is the <strong>recommended</strong> flag to use for maximum efficiency.</li> 13814 <li><code>rclone sync --checksum /path/to/source s3:bucket</code></li> 13815 </ul></li> 13816 <li><code>--update --use-server-modtime</code> 13817 <ul> 13818 <li>Uses no extra transactions.</li> 13819 <li>Modification time becomes the time the object was uploaded.</li> 13820 <li>For many operations this is sufficient to determine if it needs uploading.</li> 13821 <li>Using <code>--update</code> along with <code>--use-server-modtime</code>, avoids the extra API call and uploads files whose local modification time is newer than the time it was last uploaded.</li> 13822 <li>Files created with timestamps in the past will be missed by the sync.</li> 13823 <li><code>rclone sync --update --use-server-modtime /path/to/source s3:bucket</code></li> 13824 </ul></li> 13825 </ul> 13826 <p>These flags can and should be used in combination with <code>--fast-list</code> - see below.</p> 13827 <p>If using <code>rclone mount</code> or any command using the VFS (eg <code>rclone serve</code>) commands then you might want to consider using the VFS flag <code>--no-modtime</code> which will stop rclone reading the modification time for every object. You could also use <code>--use-server-modtime</code> if you are happy with the modification times of the objects being the time of upload.</p> 13828 <h4 id="avoiding-get-requests-to-read-directory-listings">Avoiding GET requests to read directory listings</h4> 13829 <p>Rclone's default directory traversal is to process each directory individually. This takes one API call per directory. Using the <code>--fast-list</code> flag will read all info about the objects into memory first using a smaller number of API calls (one per 1000 objects). See the <a href="https://rclone.org/docs/#fast-list">rclone docs</a> for more details.</p> 13830 <pre><code>rclone sync --fast-list --checksum /path/to/source s3:bucket</code></pre> 13831 <p><code>--fast-list</code> trades off API transactions for memory use. As a rough guide rclone uses 1k of memory per object stored, so using <code>--fast-list</code> on a sync of a million objects will use roughly 1 GiB of RAM.</p> 13832 <p>If you are only copying a small number of files into a big repository then using <code>--no-traverse</code> is a good idea. This finds objects directly instead of through directory listings. You can do a "top-up" sync very cheaply by using <code>--max-age</code> and <code>--no-traverse</code> to copy only recent files, eg</p> 13833 <pre><code>rclone copy --max-age 24h --no-traverse /path/to/source s3:bucket</code></pre> 13834 <p>You'd then do a full <code>rclone sync</code> less often.</p> 13835 <p>Note that <code>--fast-list</code> isn't required in the top-up sync.</p> 13836 <h4 id="avoiding-head-requests-after-put">Avoiding HEAD requests after PUT</h4> 13837 <p>By default, rclone will HEAD every object it uploads. It does this to check the object got uploaded correctly.</p> 13838 <p>You can disable this with the <a href="#s3-no-head">--s3-no-head</a> option - see there for more details.</p> 13839 <p>Setting this flag increases the chance for undetected upload failures.</p> 13840 <h3 id="versions">Versions</h3> 13841 <p>When bucket versioning is enabled (this can be done with rclone with the <a href="#versioning"><code>rclone backend versioning</code></a> command) when rclone uploads a new version of a file it creates a <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/Versioning.html">new version of it</a> Likewise when you delete a file, the old version will be marked hidden and still be available.</p> 13842 <p>Old versions of files, where available, are visible using the <a href="#s3-versions"><code>--s3-versions</code></a> flag.</p> 13843 <p>It is also possible to view a bucket as it was at a certain point in time, using the <a href="#s3-version-at"><code>--s3-version-at</code></a> flag. This will show the file versions as they were at that time, showing files that have been deleted afterwards, and hiding files that were created since.</p> 13844 <p>If you wish to remove all the old versions then you can use the <a href="#cleanup-hidden"><code>rclone backend cleanup-hidden remote:bucket</code></a> command which will delete all the old hidden versions of files, leaving the current ones intact. You can also supply a path and only old versions under that path will be deleted, e.g. <code>rclone backend cleanup-hidden remote:bucket/path/to/stuff</code>.</p> 13845 <p>When you <code>purge</code> a bucket, the current and the old versions will be deleted then the bucket will be deleted.</p> 13846 <p>However <code>delete</code> will cause the current versions of the files to become hidden old versions.</p> 13847 <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> 13848 <p>Show current version and all the versions with <code>--s3-versions</code> flag.</p> 13849 <pre><code>$ rclone -q ls s3:cleanup-test 13850 9 one.txt 13851 13852 $ rclone -q --s3-versions ls s3:cleanup-test 13853 9 one.txt 13854 8 one-v2016-07-04-141032-000.txt 13855 16 one-v2016-07-04-141003-000.txt 13856 15 one-v2016-07-02-155621-000.txt</code></pre> 13857 <p>Retrieve an old version</p> 13858 <pre><code>$ rclone -q --s3-versions copy s3:cleanup-test/one-v2016-07-04-141003-000.txt /tmp 13859 13860 $ ls -l /tmp/one-v2016-07-04-141003-000.txt 13861 -rw-rw-r-- 1 ncw ncw 16 Jul 2 17:46 /tmp/one-v2016-07-04-141003-000.txt</code></pre> 13862 <p>Clean up all the old versions and show that they've gone.</p> 13863 <pre><code>$ rclone -q backend cleanup-hidden s3:cleanup-test 13864 13865 $ rclone -q ls s3:cleanup-test 13866 9 one.txt 13867 13868 $ rclone -q --s3-versions ls s3:cleanup-test 13869 9 one.txt</code></pre> 13870 <h4 id="versions-naming-caveat">Versions naming caveat</h4> 13871 <p>When using <code>--s3-versions</code> flag rclone is relying on the file name to work out whether the objects are versions or not. Versions' names are created by inserting timestamp between file name and its extension.</p> 13872 <pre><code> 9 file.txt 13873 8 file-v2023-07-17-161032-000.txt 13874 16 file-v2023-06-15-141003-000.txt</code></pre> 13875 <p>If there are real files present with the same names as versions, then behaviour of <code>--s3-versions</code> can be unpredictable.</p> 13876 <h3 id="cleanup-1">Cleanup</h3> 13877 <p>If you run <code>rclone cleanup s3:bucket</code> then it will remove all pending multipart uploads older than 24 hours. You can use the <code>--interactive</code>/<code>i</code> or <code>--dry-run</code> flag to see exactly what it will do. If you want more control over the expiry date then run <code>rclone backend cleanup s3:bucket -o max-age=1h</code> to expire all uploads older than one hour. You can use <code>rclone backend list-multipart-uploads s3:bucket</code> to see the pending multipart uploads.</p> 13878 <h3 id="restricted-filename-characters-1">Restricted filename characters</h3> 13879 <p>S3 allows any valid UTF-8 string as a key.</p> 13880 <p>Invalid UTF-8 bytes will be <a href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they can't be used in XML.</p> 13881 <p>The following characters are replaced since these are problematic when dealing with the REST API:</p> 13882 <table> 13883 <thead> 13884 <tr class="header"> 13885 <th>Character</th> 13886 <th style="text-align: center;">Value</th> 13887 <th style="text-align: center;">Replacement</th> 13888 </tr> 13889 </thead> 13890 <tbody> 13891 <tr class="odd"> 13892 <td>NUL</td> 13893 <td style="text-align: center;">0x00</td> 13894 <td style="text-align: center;">␀</td> 13895 </tr> 13896 <tr class="even"> 13897 <td>/</td> 13898 <td style="text-align: center;">0x2F</td> 13899 <td style="text-align: center;">／</td> 13900 </tr> 13901 </tbody> 13902 </table> 13903 <p>The encoding will also encode these file names as they don't seem to work with the SDK properly:</p> 13904 <table> 13905 <thead> 13906 <tr class="header"> 13907 <th>File name</th> 13908 <th style="text-align: center;">Replacement</th> 13909 </tr> 13910 </thead> 13911 <tbody> 13912 <tr class="odd"> 13913 <td>.</td> 13914 <td style="text-align: center;">．</td> 13915 </tr> 13916 <tr class="even"> 13917 <td>..</td> 13918 <td style="text-align: center;">．．</td> 13919 </tr> 13920 </tbody> 13921 </table> 13922 <h3 id="multipart-uploads">Multipart uploads</h3> 13923 <p>rclone supports multipart uploads with S3 which means that it can upload files bigger than 5 GiB.</p> 13924 <p>Note that files uploaded <em>both</em> with multipart upload <em>and</em> through crypt remotes do not have MD5 sums.</p> 13925 <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 5 GiB and a minimum of 0 (ie always upload multipart files).</p> 13926 <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> 13927 <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> 13928 <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> 13929 <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> 13930 <h3 id="buckets-and-regions">Buckets and Regions</h3> 13931 <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> 13932 <h3 id="authentication-5">Authentication</h3> 13933 <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> 13934 <p>The different authentication methods are tried in this order:</p> 13935 <ul> 13936 <li>Directly in the rclone configuration file (<code>env_auth = false</code> in the config file): 13937 <ul> 13938 <li><code>access_key_id</code> and <code>secret_access_key</code> are required.</li> 13939 <li><code>session_token</code> can be optionally set when using AWS STS.</li> 13940 </ul></li> 13941 <li>Runtime configuration (<code>env_auth = true</code> in the config file): 13942 <ul> 13943 <li>Export the following environment variables before running <code>rclone</code>: 13944 <ul> 13945 <li>Access Key ID: <code>AWS_ACCESS_KEY_ID</code> or <code>AWS_ACCESS_KEY</code></li> 13946 <li>Secret Access Key: <code>AWS_SECRET_ACCESS_KEY</code> or <code>AWS_SECRET_KEY</code></li> 13947 <li>Session Token: <code>AWS_SESSION_TOKEN</code> (optional)</li> 13948 </ul></li> 13949 <li>Or, use a <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html">named profile</a>: 13950 <ul> 13951 <li>Profile files are standard files used by AWS CLI tools</li> 13952 <li>By default it will use the profile in your home directory (e.g. <code>~/.aws/credentials</code> on unix based systems) file and the "default" profile, to change set these environment variables: 13953 <ul> 13954 <li><code>AWS_SHARED_CREDENTIALS_FILE</code> to control which file.</li> 13955 <li><code>AWS_PROFILE</code> to control which profile to use.</li> 13956 </ul></li> 13957 </ul></li> 13958 <li>Or, run <code>rclone</code> in an ECS task with an IAM role (AWS only).</li> 13959 <li>Or, run <code>rclone</code> on an EC2 instance with an IAM role (AWS only).</li> 13960 <li>Or, run <code>rclone</code> in an EKS pod with an IAM role that is associated with a service account (AWS only).</li> 13961 </ul></li> 13962 </ul> 13963 <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> 13964 <h3 id="s3-permissions">S3 Permissions</h3> 13965 <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> 13966 <ul> 13967 <li><code>ListBucket</code></li> 13968 <li><code>DeleteObject</code></li> 13969 <li><code>GetObject</code></li> 13970 <li><code>PutObject</code></li> 13971 <li><code>PutObjectACL</code></li> 13972 <li><code>CreateBucket</code> (unless using <a href="#s3-no-check-bucket">s3-no-check-bucket</a>)</li> 13973 </ul> 13974 <p>When using the <code>lsd</code> subcommand, the <code>ListAllMyBuckets</code> permission is required.</p> 13975 <p>Example policy:</p> 13976 <pre><code>{ 13977 "Version": "2012-10-17", 13978 "Statement": [ 13979 { 13980 "Effect": "Allow", 13981 "Principal": { 13982 "AWS": "arn:aws:iam::USER_SID:user/USER_NAME" 13983 }, 13984 "Action": [ 13985 "s3:ListBucket", 13986 "s3:DeleteObject", 13987 "s3:GetObject", 13988 "s3:PutObject", 13989 "s3:PutObjectAcl" 13990 ], 13991 "Resource": [ 13992 "arn:aws:s3:::BUCKET_NAME/*", 13993 "arn:aws:s3:::BUCKET_NAME" 13994 ] 13995 }, 13996 { 13997 "Effect": "Allow", 13998 "Action": "s3:ListAllMyBuckets", 13999 "Resource": "arn:aws:s3:::*" 14000 } 14001 ] 14002 }</code></pre> 14003 <p>Notes on above:</p> 14004 <ol type="1"> 14005 <li>This is a policy that can be used when creating bucket. It assumes that <code>USER_NAME</code> has been created.</li> 14006 <li>The Resource entry must include both resource ARNs, as one implies the bucket and the other implies the bucket's objects.</li> 14007 <li>When using <a href="#s3-no-check-bucket">s3-no-check-bucket</a> and the bucket already exsits, the <code>"arn:aws:s3:::BUCKET_NAME"</code> doesn't have to be included.</li> 14008 </ol> 14009 <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> 14010 <h3 id="key-management-system-kms">Key Management System (KMS)</h3> 14011 <p>If you are using server-side encryption with KMS then you must make sure rclone is configured with <code>server_side_encryption = aws:kms</code> otherwise you will find you can't transfer small objects - these will create checksum errors.</p> 14012 <h3 id="glacier-and-glacier-deep-archive">Glacier and Glacier Deep Archive</h3> 14013 <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> 14014 <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> 14015 <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> 14016 <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> 14017 <h3 id="object-lock-enabled-s3-bucket">Object-lock enabled S3 bucket</h3> 14018 <p>According to AWS's <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-overview.html#object-lock-permission">documentation on S3 Object Lock</a>:</p> 14019 <blockquote> 14020 <p>If you configure a default retention period on a bucket, requests to upload objects in such a bucket must include the Content-MD5 header.</p> 14021 </blockquote> 14022 <p>As mentioned in the <a href="#modification-times-and-hashes">Modification times and hashes</a> section, small files that are not uploaded as multipart, use a different tag, causing the upload to fail. A simple solution is to set the <code>--s3-upload-cutoff 0</code> and force all the files to be uploaded as multipart.</p> 14023 <h3 id="standard-options-2">Standard options</h3> 14024 <p>Here are the Standard options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, GCS, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Minio, Netease, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, StackPath, Storj, Synology, TencentCOS, Wasabi, Qiniu and others).</p> 14025 <h4 id="s3-provider">--s3-provider</h4> 14026 <p>Choose your S3 provider.</p> 14027 <p>Properties:</p> 14028 <ul> 14029 <li>Config: provider</li> 14030 <li>Env Var: RCLONE_S3_PROVIDER</li> 14031 <li>Type: string</li> 14032 <li>Required: false</li> 14033 <li>Examples: 14034 <ul> 14035 <li>"AWS" 14036 <ul> 14037 <li>Amazon Web Services (AWS) S3</li> 14038 </ul></li> 14039 <li>"Alibaba" 14040 <ul> 14041 <li>Alibaba Cloud Object Storage System (OSS) formerly Aliyun</li> 14042 </ul></li> 14043 <li>"ArvanCloud" 14044 <ul> 14045 <li>Arvan Cloud Object Storage (AOS)</li> 14046 </ul></li> 14047 <li>"Ceph" 14048 <ul> 14049 <li>Ceph Object Storage</li> 14050 </ul></li> 14051 <li>"ChinaMobile" 14052 <ul> 14053 <li>China Mobile Ecloud Elastic Object Storage (EOS)</li> 14054 </ul></li> 14055 <li>"Cloudflare" 14056 <ul> 14057 <li>Cloudflare R2 Storage</li> 14058 </ul></li> 14059 <li>"DigitalOcean" 14060 <ul> 14061 <li>DigitalOcean Spaces</li> 14062 </ul></li> 14063 <li>"Dreamhost" 14064 <ul> 14065 <li>Dreamhost DreamObjects</li> 14066 </ul></li> 14067 <li>"GCS" 14068 <ul> 14069 <li>Google Cloud Storage</li> 14070 </ul></li> 14071 <li>"HuaweiOBS" 14072 <ul> 14073 <li>Huawei Object Storage Service</li> 14074 </ul></li> 14075 <li>"IBMCOS" 14076 <ul> 14077 <li>IBM COS S3</li> 14078 </ul></li> 14079 <li>"IDrive" 14080 <ul> 14081 <li>IDrive e2</li> 14082 </ul></li> 14083 <li>"IONOS" 14084 <ul> 14085 <li>IONOS Cloud</li> 14086 </ul></li> 14087 <li>"LyveCloud" 14088 <ul> 14089 <li>Seagate Lyve Cloud</li> 14090 </ul></li> 14091 <li>"Leviia" 14092 <ul> 14093 <li>Leviia Object Storage</li> 14094 </ul></li> 14095 <li>"Liara" 14096 <ul> 14097 <li>Liara Object Storage</li> 14098 </ul></li> 14099 <li>"Linode" 14100 <ul> 14101 <li>Linode Object Storage</li> 14102 </ul></li> 14103 <li>"Minio" 14104 <ul> 14105 <li>Minio Object Storage</li> 14106 </ul></li> 14107 <li>"Netease" 14108 <ul> 14109 <li>Netease Object Storage (NOS)</li> 14110 </ul></li> 14111 <li>"Petabox" 14112 <ul> 14113 <li>Petabox Object Storage</li> 14114 </ul></li> 14115 <li>"RackCorp" 14116 <ul> 14117 <li>RackCorp Object Storage</li> 14118 </ul></li> 14119 <li>"Rclone" 14120 <ul> 14121 <li>Rclone S3 Server</li> 14122 </ul></li> 14123 <li>"Scaleway" 14124 <ul> 14125 <li>Scaleway Object Storage</li> 14126 </ul></li> 14127 <li>"SeaweedFS" 14128 <ul> 14129 <li>SeaweedFS S3</li> 14130 </ul></li> 14131 <li>"StackPath" 14132 <ul> 14133 <li>StackPath Object Storage</li> 14134 </ul></li> 14135 <li>"Storj" 14136 <ul> 14137 <li>Storj (S3 Compatible Gateway)</li> 14138 </ul></li> 14139 <li>"Synology" 14140 <ul> 14141 <li>Synology C2 Object Storage</li> 14142 </ul></li> 14143 <li>"TencentCOS" 14144 <ul> 14145 <li>Tencent Cloud Object Storage (COS)</li> 14146 </ul></li> 14147 <li>"Wasabi" 14148 <ul> 14149 <li>Wasabi Object Storage</li> 14150 </ul></li> 14151 <li>"Qiniu" 14152 <ul> 14153 <li>Qiniu Object Storage (Kodo)</li> 14154 </ul></li> 14155 <li>"Other" 14156 <ul> 14157 <li>Any other S3 compatible provider</li> 14158 </ul></li> 14159 </ul></li> 14160 </ul> 14161 <h4 id="s3-env-auth">--s3-env-auth</h4> 14162 <p>Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).</p> 14163 <p>Only applies if access_key_id and secret_access_key is blank.</p> 14164 <p>Properties:</p> 14165 <ul> 14166 <li>Config: env_auth</li> 14167 <li>Env Var: RCLONE_S3_ENV_AUTH</li> 14168 <li>Type: bool</li> 14169 <li>Default: false</li> 14170 <li>Examples: 14171 <ul> 14172 <li>"false" 14173 <ul> 14174 <li>Enter AWS credentials in the next step.</li> 14175 </ul></li> 14176 <li>"true" 14177 <ul> 14178 <li>Get AWS credentials from the environment (env vars or IAM).</li> 14179 </ul></li> 14180 </ul></li> 14181 </ul> 14182 <h4 id="s3-access-key-id">--s3-access-key-id</h4> 14183 <p>AWS Access Key ID.</p> 14184 <p>Leave blank for anonymous access or runtime credentials.</p> 14185 <p>Properties:</p> 14186 <ul> 14187 <li>Config: access_key_id</li> 14188 <li>Env Var: RCLONE_S3_ACCESS_KEY_ID</li> 14189 <li>Type: string</li> 14190 <li>Required: false</li> 14191 </ul> 14192 <h4 id="s3-secret-access-key">--s3-secret-access-key</h4> 14193 <p>AWS Secret Access Key (password).</p> 14194 <p>Leave blank for anonymous access or runtime credentials.</p> 14195 <p>Properties:</p> 14196 <ul> 14197 <li>Config: secret_access_key</li> 14198 <li>Env Var: RCLONE_S3_SECRET_ACCESS_KEY</li> 14199 <li>Type: string</li> 14200 <li>Required: false</li> 14201 </ul> 14202 <h4 id="s3-region">--s3-region</h4> 14203 <p>Region to connect to.</p> 14204 <p>Properties:</p> 14205 <ul> 14206 <li>Config: region</li> 14207 <li>Env Var: RCLONE_S3_REGION</li> 14208 <li>Provider: AWS</li> 14209 <li>Type: string</li> 14210 <li>Required: false</li> 14211 <li>Examples: 14212 <ul> 14213 <li>"us-east-1" 14214 <ul> 14215 <li>The default endpoint - a good choice if you are unsure.</li> 14216 <li>US Region, Northern Virginia, or Pacific Northwest.</li> 14217 <li>Leave location constraint empty.</li> 14218 </ul></li> 14219 <li>"us-east-2" 14220 <ul> 14221 <li>US East (Ohio) Region.</li> 14222 <li>Needs location constraint us-east-2.</li> 14223 </ul></li> 14224 <li>"us-west-1" 14225 <ul> 14226 <li>US West (Northern California) Region.</li> 14227 <li>Needs location constraint us-west-1.</li> 14228 </ul></li> 14229 <li>"us-west-2" 14230 <ul> 14231 <li>US West (Oregon) Region.</li> 14232 <li>Needs location constraint us-west-2.</li> 14233 </ul></li> 14234 <li>"ca-central-1" 14235 <ul> 14236 <li>Canada (Central) Region.</li> 14237 <li>Needs location constraint ca-central-1.</li> 14238 </ul></li> 14239 <li>"eu-west-1" 14240 <ul> 14241 <li>EU (Ireland) Region.</li> 14242 <li>Needs location constraint EU or eu-west-1.</li> 14243 </ul></li> 14244 <li>"eu-west-2" 14245 <ul> 14246 <li>EU (London) Region.</li> 14247 <li>Needs location constraint eu-west-2.</li> 14248 </ul></li> 14249 <li>"eu-west-3" 14250 <ul> 14251 <li>EU (Paris) Region.</li> 14252 <li>Needs location constraint eu-west-3.</li> 14253 </ul></li> 14254 <li>"eu-north-1" 14255 <ul> 14256 <li>EU (Stockholm) Region.</li> 14257 <li>Needs location constraint eu-north-1.</li> 14258 </ul></li> 14259 <li>"eu-south-1" 14260 <ul> 14261 <li>EU (Milan) Region.</li> 14262 <li>Needs location constraint eu-south-1.</li> 14263 </ul></li> 14264 <li>"eu-central-1" 14265 <ul> 14266 <li>EU (Frankfurt) Region.</li> 14267 <li>Needs location constraint eu-central-1.</li> 14268 </ul></li> 14269 <li>"ap-southeast-1" 14270 <ul> 14271 <li>Asia Pacific (Singapore) Region.</li> 14272 <li>Needs location constraint ap-southeast-1.</li> 14273 </ul></li> 14274 <li>"ap-southeast-2" 14275 <ul> 14276 <li>Asia Pacific (Sydney) Region.</li> 14277 <li>Needs location constraint ap-southeast-2.</li> 14278 </ul></li> 14279 <li>"ap-northeast-1" 14280 <ul> 14281 <li>Asia Pacific (Tokyo) Region.</li> 14282 <li>Needs location constraint ap-northeast-1.</li> 14283 </ul></li> 14284 <li>"ap-northeast-2" 14285 <ul> 14286 <li>Asia Pacific (Seoul).</li> 14287 <li>Needs location constraint ap-northeast-2.</li> 14288 </ul></li> 14289 <li>"ap-northeast-3" 14290 <ul> 14291 <li>Asia Pacific (Osaka-Local).</li> 14292 <li>Needs location constraint ap-northeast-3.</li> 14293 </ul></li> 14294 <li>"ap-south-1" 14295 <ul> 14296 <li>Asia Pacific (Mumbai).</li> 14297 <li>Needs location constraint ap-south-1.</li> 14298 </ul></li> 14299 <li>"ap-east-1" 14300 <ul> 14301 <li>Asia Pacific (Hong Kong) Region.</li> 14302 <li>Needs location constraint ap-east-1.</li> 14303 </ul></li> 14304 <li>"sa-east-1" 14305 <ul> 14306 <li>South America (Sao Paulo) Region.</li> 14307 <li>Needs location constraint sa-east-1.</li> 14308 </ul></li> 14309 <li>"me-south-1" 14310 <ul> 14311 <li>Middle East (Bahrain) Region.</li> 14312 <li>Needs location constraint me-south-1.</li> 14313 </ul></li> 14314 <li>"af-south-1" 14315 <ul> 14316 <li>Africa (Cape Town) Region.</li> 14317 <li>Needs location constraint af-south-1.</li> 14318 </ul></li> 14319 <li>"cn-north-1" 14320 <ul> 14321 <li>China (Beijing) Region.</li> 14322 <li>Needs location constraint cn-north-1.</li> 14323 </ul></li> 14324 <li>"cn-northwest-1" 14325 <ul> 14326 <li>China (Ningxia) Region.</li> 14327 <li>Needs location constraint cn-northwest-1.</li> 14328 </ul></li> 14329 <li>"us-gov-east-1" 14330 <ul> 14331 <li>AWS GovCloud (US-East) Region.</li> 14332 <li>Needs location constraint us-gov-east-1.</li> 14333 </ul></li> 14334 <li>"us-gov-west-1" 14335 <ul> 14336 <li>AWS GovCloud (US) Region.</li> 14337 <li>Needs location constraint us-gov-west-1.</li> 14338 </ul></li> 14339 </ul></li> 14340 </ul> 14341 <h4 id="s3-endpoint">--s3-endpoint</h4> 14342 <p>Endpoint for S3 API.</p> 14343 <p>Leave blank if using AWS to use the default endpoint for the region.</p> 14344 <p>Properties:</p> 14345 <ul> 14346 <li>Config: endpoint</li> 14347 <li>Env Var: RCLONE_S3_ENDPOINT</li> 14348 <li>Provider: AWS</li> 14349 <li>Type: string</li> 14350 <li>Required: false</li> 14351 </ul> 14352 <h4 id="s3-location-constraint">--s3-location-constraint</h4> 14353 <p>Location constraint - must be set to match the Region.</p> 14354 <p>Used when creating buckets only.</p> 14355 <p>Properties:</p> 14356 <ul> 14357 <li>Config: location_constraint</li> 14358 <li>Env Var: RCLONE_S3_LOCATION_CONSTRAINT</li> 14359 <li>Provider: AWS</li> 14360 <li>Type: string</li> 14361 <li>Required: false</li> 14362 <li>Examples: 14363 <ul> 14364 <li>"" 14365 <ul> 14366 <li>Empty for US Region, Northern Virginia, or Pacific Northwest</li> 14367 </ul></li> 14368 <li>"us-east-2" 14369 <ul> 14370 <li>US East (Ohio) Region</li> 14371 </ul></li> 14372 <li>"us-west-1" 14373 <ul> 14374 <li>US West (Northern California) Region</li> 14375 </ul></li> 14376 <li>"us-west-2" 14377 <ul> 14378 <li>US West (Oregon) Region</li> 14379 </ul></li> 14380 <li>"ca-central-1" 14381 <ul> 14382 <li>Canada (Central) Region</li> 14383 </ul></li> 14384 <li>"eu-west-1" 14385 <ul> 14386 <li>EU (Ireland) Region</li> 14387 </ul></li> 14388 <li>"eu-west-2" 14389 <ul> 14390 <li>EU (London) Region</li> 14391 </ul></li> 14392 <li>"eu-west-3" 14393 <ul> 14394 <li>EU (Paris) Region</li> 14395 </ul></li> 14396 <li>"eu-north-1" 14397 <ul> 14398 <li>EU (Stockholm) Region</li> 14399 </ul></li> 14400 <li>"eu-south-1" 14401 <ul> 14402 <li>EU (Milan) Region</li> 14403 </ul></li> 14404 <li>"EU" 14405 <ul> 14406 <li>EU Region</li> 14407 </ul></li> 14408 <li>"ap-southeast-1" 14409 <ul> 14410 <li>Asia Pacific (Singapore) Region</li> 14411 </ul></li> 14412 <li>"ap-southeast-2" 14413 <ul> 14414 <li>Asia Pacific (Sydney) Region</li> 14415 </ul></li> 14416 <li>"ap-northeast-1" 14417 <ul> 14418 <li>Asia Pacific (Tokyo) Region</li> 14419 </ul></li> 14420 <li>"ap-northeast-2" 14421 <ul> 14422 <li>Asia Pacific (Seoul) Region</li> 14423 </ul></li> 14424 <li>"ap-northeast-3" 14425 <ul> 14426 <li>Asia Pacific (Osaka-Local) Region</li> 14427 </ul></li> 14428 <li>"ap-south-1" 14429 <ul> 14430 <li>Asia Pacific (Mumbai) Region</li> 14431 </ul></li> 14432 <li>"ap-east-1" 14433 <ul> 14434 <li>Asia Pacific (Hong Kong) Region</li> 14435 </ul></li> 14436 <li>"sa-east-1" 14437 <ul> 14438 <li>South America (Sao Paulo) Region</li> 14439 </ul></li> 14440 <li>"me-south-1" 14441 <ul> 14442 <li>Middle East (Bahrain) Region</li> 14443 </ul></li> 14444 <li>"af-south-1" 14445 <ul> 14446 <li>Africa (Cape Town) Region</li> 14447 </ul></li> 14448 <li>"cn-north-1" 14449 <ul> 14450 <li>China (Beijing) Region</li> 14451 </ul></li> 14452 <li>"cn-northwest-1" 14453 <ul> 14454 <li>China (Ningxia) Region</li> 14455 </ul></li> 14456 <li>"us-gov-east-1" 14457 <ul> 14458 <li>AWS GovCloud (US-East) Region</li> 14459 </ul></li> 14460 <li>"us-gov-west-1" 14461 <ul> 14462 <li>AWS GovCloud (US) Region</li> 14463 </ul></li> 14464 </ul></li> 14465 </ul> 14466 <h4 id="s3-acl">--s3-acl</h4> 14467 <p>Canned ACL used when creating buckets and storing or copying objects.</p> 14468 <p>This ACL is used for creating objects and if bucket_acl isn't set, for creating buckets too.</p> 14469 <p>For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl</p> 14470 <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> 14471 <p>If the acl is an empty string then no X-Amz-Acl: header is added and the default (private) will be used.</p> 14472 <p>Properties:</p> 14473 <ul> 14474 <li>Config: acl</li> 14475 <li>Env Var: RCLONE_S3_ACL</li> 14476 <li>Provider: !Storj,Synology,Cloudflare</li> 14477 <li>Type: string</li> 14478 <li>Required: false</li> 14479 <li>Examples: 14480 <ul> 14481 <li>"default" 14482 <ul> 14483 <li>Owner gets Full_CONTROL.</li> 14484 <li>No one else has access rights (default).</li> 14485 </ul></li> 14486 <li>"private" 14487 <ul> 14488 <li>Owner gets FULL_CONTROL.</li> 14489 <li>No one else has access rights (default).</li> 14490 </ul></li> 14491 <li>"public-read" 14492 <ul> 14493 <li>Owner gets FULL_CONTROL.</li> 14494 <li>The AllUsers group gets READ access.</li> 14495 </ul></li> 14496 <li>"public-read-write" 14497 <ul> 14498 <li>Owner gets FULL_CONTROL.</li> 14499 <li>The AllUsers group gets READ and WRITE access.</li> 14500 <li>Granting this on a bucket is generally not recommended.</li> 14501 </ul></li> 14502 <li>"authenticated-read" 14503 <ul> 14504 <li>Owner gets FULL_CONTROL.</li> 14505 <li>The AuthenticatedUsers group gets READ access.</li> 14506 </ul></li> 14507 <li>"bucket-owner-read" 14508 <ul> 14509 <li>Object owner gets FULL_CONTROL.</li> 14510 <li>Bucket owner gets READ access.</li> 14511 <li>If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.</li> 14512 </ul></li> 14513 <li>"bucket-owner-full-control" 14514 <ul> 14515 <li>Both the object owner and the bucket owner get FULL_CONTROL over the object.</li> 14516 <li>If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.</li> 14517 </ul></li> 14518 <li>"private" 14519 <ul> 14520 <li>Owner gets FULL_CONTROL.</li> 14521 <li>No one else has access rights (default).</li> 14522 <li>This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On-Premise COS.</li> 14523 </ul></li> 14524 <li>"public-read" 14525 <ul> 14526 <li>Owner gets FULL_CONTROL.</li> 14527 <li>The AllUsers group gets READ access.</li> 14528 <li>This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On-Premise IBM COS.</li> 14529 </ul></li> 14530 <li>"public-read-write" 14531 <ul> 14532 <li>Owner gets FULL_CONTROL.</li> 14533 <li>The AllUsers group gets READ and WRITE access.</li> 14534 <li>This acl is available on IBM Cloud (Infra), On-Premise IBM COS.</li> 14535 </ul></li> 14536 <li>"authenticated-read" 14537 <ul> 14538 <li>Owner gets FULL_CONTROL.</li> 14539 <li>The AuthenticatedUsers group gets READ access.</li> 14540 <li>Not supported on Buckets.</li> 14541 <li>This acl is available on IBM Cloud (Infra) and On-Premise IBM COS.</li> 14542 </ul></li> 14543 </ul></li> 14544 </ul> 14545 <h4 id="s3-server-side-encryption">--s3-server-side-encryption</h4> 14546 <p>The server-side encryption algorithm used when storing this object in S3.</p> 14547 <p>Properties:</p> 14548 <ul> 14549 <li>Config: server_side_encryption</li> 14550 <li>Env Var: RCLONE_S3_SERVER_SIDE_ENCRYPTION</li> 14551 <li>Provider: AWS,Ceph,ChinaMobile,Minio</li> 14552 <li>Type: string</li> 14553 <li>Required: false</li> 14554 <li>Examples: 14555 <ul> 14556 <li>"" 14557 <ul> 14558 <li>None</li> 14559 </ul></li> 14560 <li>"AES256" 14561 <ul> 14562 <li>AES256</li> 14563 </ul></li> 14564 <li>"aws:kms" 14565 <ul> 14566 <li>aws:kms</li> 14567 </ul></li> 14568 </ul></li> 14569 </ul> 14570 <h4 id="s3-sse-kms-key-id">--s3-sse-kms-key-id</h4> 14571 <p>If using KMS ID you must provide the ARN of Key.</p> 14572 <p>Properties:</p> 14573 <ul> 14574 <li>Config: sse_kms_key_id</li> 14575 <li>Env Var: RCLONE_S3_SSE_KMS_KEY_ID</li> 14576 <li>Provider: AWS,Ceph,Minio</li> 14577 <li>Type: string</li> 14578 <li>Required: false</li> 14579 <li>Examples: 14580 <ul> 14581 <li>"" 14582 <ul> 14583 <li>None</li> 14584 </ul></li> 14585 <li>"arn:aws:kms:us-east-1:*" 14586 <ul> 14587 <li>arn:aws:kms:*</li> 14588 </ul></li> 14589 </ul></li> 14590 </ul> 14591 <h4 id="s3-storage-class">--s3-storage-class</h4> 14592 <p>The storage class to use when storing new objects in S3.</p> 14593 <p>Properties:</p> 14594 <ul> 14595 <li>Config: storage_class</li> 14596 <li>Env Var: RCLONE_S3_STORAGE_CLASS</li> 14597 <li>Provider: AWS</li> 14598 <li>Type: string</li> 14599 <li>Required: false</li> 14600 <li>Examples: 14601 <ul> 14602 <li>"" 14603 <ul> 14604 <li>Default</li> 14605 </ul></li> 14606 <li>"STANDARD" 14607 <ul> 14608 <li>Standard storage class</li> 14609 </ul></li> 14610 <li>"REDUCED_REDUNDANCY" 14611 <ul> 14612 <li>Reduced redundancy storage class</li> 14613 </ul></li> 14614 <li>"STANDARD_IA" 14615 <ul> 14616 <li>Standard Infrequent Access storage class</li> 14617 </ul></li> 14618 <li>"ONEZONE_IA" 14619 <ul> 14620 <li>One Zone Infrequent Access storage class</li> 14621 </ul></li> 14622 <li>"GLACIER" 14623 <ul> 14624 <li>Glacier storage class</li> 14625 </ul></li> 14626 <li>"DEEP_ARCHIVE" 14627 <ul> 14628 <li>Glacier Deep Archive storage class</li> 14629 </ul></li> 14630 <li>"INTELLIGENT_TIERING" 14631 <ul> 14632 <li>Intelligent-Tiering storage class</li> 14633 </ul></li> 14634 <li>"GLACIER_IR" 14635 <ul> 14636 <li>Glacier Instant Retrieval storage class</li> 14637 </ul></li> 14638 </ul></li> 14639 </ul> 14640 <h3 id="advanced-options-2">Advanced options</h3> 14641 <p>Here are the Advanced options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, GCS, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Minio, Netease, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, StackPath, Storj, Synology, TencentCOS, Wasabi, Qiniu and others).</p> 14642 <h4 id="s3-bucket-acl">--s3-bucket-acl</h4> 14643 <p>Canned ACL used when creating buckets.</p> 14644 <p>For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl</p> 14645 <p>Note that this ACL is applied when only when creating buckets. If it isn't set then "acl" is used instead.</p> 14646 <p>If the "acl" and "bucket_acl" are empty strings then no X-Amz-Acl: header is added and the default (private) will be used.</p> 14647 <p>Properties:</p> 14648 <ul> 14649 <li>Config: bucket_acl</li> 14650 <li>Env Var: RCLONE_S3_BUCKET_ACL</li> 14651 <li>Type: string</li> 14652 <li>Required: false</li> 14653 <li>Examples: 14654 <ul> 14655 <li>"private" 14656 <ul> 14657 <li>Owner gets FULL_CONTROL.</li> 14658 <li>No one else has access rights (default).</li> 14659 </ul></li> 14660 <li>"public-read" 14661 <ul> 14662 <li>Owner gets FULL_CONTROL.</li> 14663 <li>The AllUsers group gets READ access.</li> 14664 </ul></li> 14665 <li>"public-read-write" 14666 <ul> 14667 <li>Owner gets FULL_CONTROL.</li> 14668 <li>The AllUsers group gets READ and WRITE access.</li> 14669 <li>Granting this on a bucket is generally not recommended.</li> 14670 </ul></li> 14671 <li>"authenticated-read" 14672 <ul> 14673 <li>Owner gets FULL_CONTROL.</li> 14674 <li>The AuthenticatedUsers group gets READ access.</li> 14675 </ul></li> 14676 </ul></li> 14677 </ul> 14678 <h4 id="s3-requester-pays">--s3-requester-pays</h4> 14679 <p>Enables requester pays option when interacting with S3 bucket.</p> 14680 <p>Properties:</p> 14681 <ul> 14682 <li>Config: requester_pays</li> 14683 <li>Env Var: RCLONE_S3_REQUESTER_PAYS</li> 14684 <li>Provider: AWS</li> 14685 <li>Type: bool</li> 14686 <li>Default: false</li> 14687 </ul> 14688 <h4 id="s3-sse-customer-algorithm">--s3-sse-customer-algorithm</h4> 14689 <p>If using SSE-C, the server-side encryption algorithm used when storing this object in S3.</p> 14690 <p>Properties:</p> 14691 <ul> 14692 <li>Config: sse_customer_algorithm</li> 14693 <li>Env Var: RCLONE_S3_SSE_CUSTOMER_ALGORITHM</li> 14694 <li>Provider: AWS,Ceph,ChinaMobile,Minio</li> 14695 <li>Type: string</li> 14696 <li>Required: false</li> 14697 <li>Examples: 14698 <ul> 14699 <li>"" 14700 <ul> 14701 <li>None</li> 14702 </ul></li> 14703 <li>"AES256" 14704 <ul> 14705 <li>AES256</li> 14706 </ul></li> 14707 </ul></li> 14708 </ul> 14709 <h4 id="s3-sse-customer-key">--s3-sse-customer-key</h4> 14710 <p>To use SSE-C you may provide the secret encryption key used to encrypt/decrypt your data.</p> 14711 <p>Alternatively you can provide --sse-customer-key-base64.</p> 14712 <p>Properties:</p> 14713 <ul> 14714 <li>Config: sse_customer_key</li> 14715 <li>Env Var: RCLONE_S3_SSE_CUSTOMER_KEY</li> 14716 <li>Provider: AWS,Ceph,ChinaMobile,Minio</li> 14717 <li>Type: string</li> 14718 <li>Required: false</li> 14719 <li>Examples: 14720 <ul> 14721 <li>"" 14722 <ul> 14723 <li>None</li> 14724 </ul></li> 14725 </ul></li> 14726 </ul> 14727 <h4 id="s3-sse-customer-key-base64">--s3-sse-customer-key-base64</h4> 14728 <p>If using SSE-C you must provide the secret encryption key encoded in base64 format to encrypt/decrypt your data.</p> 14729 <p>Alternatively you can provide --sse-customer-key.</p> 14730 <p>Properties:</p> 14731 <ul> 14732 <li>Config: sse_customer_key_base64</li> 14733 <li>Env Var: RCLONE_S3_SSE_CUSTOMER_KEY_BASE64</li> 14734 <li>Provider: AWS,Ceph,ChinaMobile,Minio</li> 14735 <li>Type: string</li> 14736 <li>Required: false</li> 14737 <li>Examples: 14738 <ul> 14739 <li>"" 14740 <ul> 14741 <li>None</li> 14742 </ul></li> 14743 </ul></li> 14744 </ul> 14745 <h4 id="s3-sse-customer-key-md5">--s3-sse-customer-key-md5</h4> 14746 <p>If using SSE-C you may provide the secret encryption key MD5 checksum (optional).</p> 14747 <p>If you leave it blank, this is calculated automatically from the sse_customer_key provided.</p> 14748 <p>Properties:</p> 14749 <ul> 14750 <li>Config: sse_customer_key_md5</li> 14751 <li>Env Var: RCLONE_S3_SSE_CUSTOMER_KEY_MD5</li> 14752 <li>Provider: AWS,Ceph,ChinaMobile,Minio</li> 14753 <li>Type: string</li> 14754 <li>Required: false</li> 14755 <li>Examples: 14756 <ul> 14757 <li>"" 14758 <ul> 14759 <li>None</li> 14760 </ul></li> 14761 </ul></li> 14762 </ul> 14763 <h4 id="s3-upload-cutoff">--s3-upload-cutoff</h4> 14764 <p>Cutoff for switching to chunked upload.</p> 14765 <p>Any files larger than this will be uploaded in chunks of chunk_size. The minimum is 0 and the maximum is 5 GiB.</p> 14766 <p>Properties:</p> 14767 <ul> 14768 <li>Config: upload_cutoff</li> 14769 <li>Env Var: RCLONE_S3_UPLOAD_CUTOFF</li> 14770 <li>Type: SizeSuffix</li> 14771 <li>Default: 200Mi</li> 14772 </ul> 14773 <h4 id="s3-chunk-size">--s3-chunk-size</h4> 14774 <p>Chunk size to use for uploading.</p> 14775 <p>When uploading files larger than upload_cutoff or files with unknown size (e.g. from "rclone rcat" or uploaded with "rclone mount" or google photos or google docs) they will be uploaded as multipart uploads using this chunk size.</p> 14776 <p>Note that "--s3-upload-concurrency" chunks of this size are buffered in memory per transfer.</p> 14777 <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> 14778 <p>Rclone will automatically increase the chunk size when uploading a large file of known size to stay below the 10,000 chunks limit.</p> 14779 <p>Files of unknown size are uploaded with the configured chunk_size. Since the default chunk size is 5 MiB and there can be at most 10,000 chunks, this means that by default the maximum size of a file you can stream upload is 48 GiB. If you wish to stream upload larger files then you will need to increase chunk_size.</p> 14780 <p>Increasing the chunk size decreases the accuracy of the progress statistics displayed with "-P" flag. Rclone treats chunk as sent when it's buffered by the AWS SDK, when in fact it may still be uploading. A bigger chunk size means a bigger AWS SDK buffer and progress reporting more deviating from the truth.</p> 14781 <p>Properties:</p> 14782 <ul> 14783 <li>Config: chunk_size</li> 14784 <li>Env Var: RCLONE_S3_CHUNK_SIZE</li> 14785 <li>Type: SizeSuffix</li> 14786 <li>Default: 5Mi</li> 14787 </ul> 14788 <h4 id="s3-max-upload-parts">--s3-max-upload-parts</h4> 14789 <p>Maximum number of parts in a multipart upload.</p> 14790 <p>This option defines the maximum number of multipart chunks to use when doing a multipart upload.</p> 14791 <p>This can be useful if a service does not support the AWS S3 specification of 10,000 chunks.</p> 14792 <p>Rclone will automatically increase the chunk size when uploading a large file of a known size to stay below this number of chunks limit.</p> 14793 <p>Properties:</p> 14794 <ul> 14795 <li>Config: max_upload_parts</li> 14796 <li>Env Var: RCLONE_S3_MAX_UPLOAD_PARTS</li> 14797 <li>Type: int</li> 14798 <li>Default: 10000</li> 14799 </ul> 14800 <h4 id="s3-copy-cutoff">--s3-copy-cutoff</h4> 14801 <p>Cutoff for switching to multipart copy.</p> 14802 <p>Any files larger than this that need to be server-side copied will be copied in chunks of this size.</p> 14803 <p>The minimum is 0 and the maximum is 5 GiB.</p> 14804 <p>Properties:</p> 14805 <ul> 14806 <li>Config: copy_cutoff</li> 14807 <li>Env Var: RCLONE_S3_COPY_CUTOFF</li> 14808 <li>Type: SizeSuffix</li> 14809 <li>Default: 4.656Gi</li> 14810 </ul> 14811 <h4 id="s3-disable-checksum">--s3-disable-checksum</h4> 14812 <p>Don't store MD5 checksum with object metadata.</p> 14813 <p>Normally rclone will calculate the MD5 checksum of the input before uploading it so it can add it to metadata on the object. This is great for data integrity checking but can cause long delays for large files to start uploading.</p> 14814 <p>Properties:</p> 14815 <ul> 14816 <li>Config: disable_checksum</li> 14817 <li>Env Var: RCLONE_S3_DISABLE_CHECKSUM</li> 14818 <li>Type: bool</li> 14819 <li>Default: false</li> 14820 </ul> 14821 <h4 id="s3-shared-credentials-file">--s3-shared-credentials-file</h4> 14822 <p>Path to the shared credentials file.</p> 14823 <p>If env_auth = true then rclone can use a shared credentials file.</p> 14824 <p>If this variable is empty rclone will look for the "AWS_SHARED_CREDENTIALS_FILE" env variable. If the env value is empty it will default to the current user's home directory.</p> 14825 <pre><code>Linux/OSX: "$HOME/.aws/credentials" 14826 Windows: "%USERPROFILE%\.aws\credentials"</code></pre> 14827 <p>Properties:</p> 14828 <ul> 14829 <li>Config: shared_credentials_file</li> 14830 <li>Env Var: RCLONE_S3_SHARED_CREDENTIALS_FILE</li> 14831 <li>Type: string</li> 14832 <li>Required: false</li> 14833 </ul> 14834 <h4 id="s3-profile">--s3-profile</h4> 14835 <p>Profile to use in the shared credentials file.</p> 14836 <p>If env_auth = true then rclone can use a shared credentials file. This variable controls which profile is used in that file.</p> 14837 <p>If empty it will default to the environment variable "AWS_PROFILE" or "default" if that environment variable is also not set.</p> 14838 <p>Properties:</p> 14839 <ul> 14840 <li>Config: profile</li> 14841 <li>Env Var: RCLONE_S3_PROFILE</li> 14842 <li>Type: string</li> 14843 <li>Required: false</li> 14844 </ul> 14845 <h4 id="s3-session-token">--s3-session-token</h4> 14846 <p>An AWS session token.</p> 14847 <p>Properties:</p> 14848 <ul> 14849 <li>Config: session_token</li> 14850 <li>Env Var: RCLONE_S3_SESSION_TOKEN</li> 14851 <li>Type: string</li> 14852 <li>Required: false</li> 14853 </ul> 14854 <h4 id="s3-upload-concurrency">--s3-upload-concurrency</h4> 14855 <p>Concurrency for multipart uploads and copies.</p> 14856 <p>This is the number of chunks of the same file that are uploaded concurrently for multipart uploads and copies.</p> 14857 <p>If you are uploading small numbers of large files over high-speed links and these uploads do not fully utilize your bandwidth, then increasing this may help to speed up the transfers.</p> 14858 <p>Properties:</p> 14859 <ul> 14860 <li>Config: upload_concurrency</li> 14861 <li>Env Var: RCLONE_S3_UPLOAD_CONCURRENCY</li> 14862 <li>Type: int</li> 14863 <li>Default: 4</li> 14864 </ul> 14865 <h4 id="s3-force-path-style">--s3-force-path-style</h4> 14866 <p>If true use path style access if false use virtual hosted style.</p> 14867 <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> 14868 <p>Some providers (e.g. AWS, Aliyun OSS, Netease COS, or Tencent COS) require this set to false - rclone will do this automatically based on the provider setting.</p> 14869 <p>Properties:</p> 14870 <ul> 14871 <li>Config: force_path_style</li> 14872 <li>Env Var: RCLONE_S3_FORCE_PATH_STYLE</li> 14873 <li>Type: bool</li> 14874 <li>Default: true</li> 14875 </ul> 14876 <h4 id="s3-v2-auth">--s3-v2-auth</h4> 14877 <p>If true use v2 authentication.</p> 14878 <p>If this is false (the default) then rclone will use v4 authentication. If it is set then rclone will use v2 authentication.</p> 14879 <p>Use this only if v4 signatures don't work, e.g. pre Jewel/v10 CEPH.</p> 14880 <p>Properties:</p> 14881 <ul> 14882 <li>Config: v2_auth</li> 14883 <li>Env Var: RCLONE_S3_V2_AUTH</li> 14884 <li>Type: bool</li> 14885 <li>Default: false</li> 14886 </ul> 14887 <h4 id="s3-use-dual-stack">--s3-use-dual-stack</h4> 14888 <p>If true use AWS S3 dual-stack endpoint (IPv6 support).</p> 14889 <p>See <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/dual-stack-endpoints.html">AWS Docs on Dualstack Endpoints</a></p> 14890 <p>Properties:</p> 14891 <ul> 14892 <li>Config: use_dual_stack</li> 14893 <li>Env Var: RCLONE_S3_USE_DUAL_STACK</li> 14894 <li>Type: bool</li> 14895 <li>Default: false</li> 14896 </ul> 14897 <h4 id="s3-use-accelerate-endpoint">--s3-use-accelerate-endpoint</h4> 14898 <p>If true use the AWS S3 accelerated endpoint.</p> 14899 <p>See: <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration-examples.html">AWS S3 Transfer acceleration</a></p> 14900 <p>Properties:</p> 14901 <ul> 14902 <li>Config: use_accelerate_endpoint</li> 14903 <li>Env Var: RCLONE_S3_USE_ACCELERATE_ENDPOINT</li> 14904 <li>Provider: AWS</li> 14905 <li>Type: bool</li> 14906 <li>Default: false</li> 14907 </ul> 14908 <h4 id="s3-leave-parts-on-error">--s3-leave-parts-on-error</h4> 14909 <p>If true avoid calling abort upload on a failure, leaving all successfully uploaded parts on S3 for manual recovery.</p> 14910 <p>It should be set to true for resuming uploads across different sessions.</p> 14911 <p>WARNING: Storing parts of an incomplete multipart upload counts towards space usage on S3 and will add additional costs if not cleaned up.</p> 14912 <p>Properties:</p> 14913 <ul> 14914 <li>Config: leave_parts_on_error</li> 14915 <li>Env Var: RCLONE_S3_LEAVE_PARTS_ON_ERROR</li> 14916 <li>Provider: AWS</li> 14917 <li>Type: bool</li> 14918 <li>Default: false</li> 14919 </ul> 14920 <h4 id="s3-list-chunk">--s3-list-chunk</h4> 14921 <p>Size of listing chunk (response list for each ListObject S3 request).</p> 14922 <p>This option is also known as "MaxKeys", "max-items", or "page-size" from the AWS S3 specification. Most services truncate the response list to 1000 objects even if requested more than that. In AWS S3 this is a global maximum and cannot be changed, see <a href="https://docs.aws.amazon.com/cli/latest/reference/s3/ls.html">AWS S3</a>. In Ceph, this can be increased with the "rgw list buckets max chunk" option.</p> 14923 <p>Properties:</p> 14924 <ul> 14925 <li>Config: list_chunk</li> 14926 <li>Env Var: RCLONE_S3_LIST_CHUNK</li> 14927 <li>Type: int</li> 14928 <li>Default: 1000</li> 14929 </ul> 14930 <h4 id="s3-list-version">--s3-list-version</h4> 14931 <p>Version of ListObjects to use: 1,2 or 0 for auto.</p> 14932 <p>When S3 originally launched it only provided the ListObjects call to enumerate objects in a bucket.</p> 14933 <p>However in May 2016 the ListObjectsV2 call was introduced. This is much higher performance and should be used if at all possible.</p> 14934 <p>If set to the default, 0, rclone will guess according to the provider set which list objects method to call. If it guesses wrong, then it may be set manually here.</p> 14935 <p>Properties:</p> 14936 <ul> 14937 <li>Config: list_version</li> 14938 <li>Env Var: RCLONE_S3_LIST_VERSION</li> 14939 <li>Type: int</li> 14940 <li>Default: 0</li> 14941 </ul> 14942 <h4 id="s3-list-url-encode">--s3-list-url-encode</h4> 14943 <p>Whether to url encode listings: true/false/unset</p> 14944 <p>Some providers support URL encoding listings and where this is available this is more reliable when using control characters in file names. If this is set to unset (the default) then rclone will choose according to the provider setting what to apply, but you can override rclone's choice here.</p> 14945 <p>Properties:</p> 14946 <ul> 14947 <li>Config: list_url_encode</li> 14948 <li>Env Var: RCLONE_S3_LIST_URL_ENCODE</li> 14949 <li>Type: Tristate</li> 14950 <li>Default: unset</li> 14951 </ul> 14952 <h4 id="s3-no-check-bucket">--s3-no-check-bucket</h4> 14953 <p>If set, don't attempt to check the bucket exists or create it.</p> 14954 <p>This can be useful when trying to minimise the number of transactions rclone does if you know the bucket exists already.</p> 14955 <p>It can also be needed if the user you are using does not have bucket creation permissions. Before v1.52.0 this would have passed silently due to a bug.</p> 14956 <p>Properties:</p> 14957 <ul> 14958 <li>Config: no_check_bucket</li> 14959 <li>Env Var: RCLONE_S3_NO_CHECK_BUCKET</li> 14960 <li>Type: bool</li> 14961 <li>Default: false</li> 14962 </ul> 14963 <h4 id="s3-no-head">--s3-no-head</h4> 14964 <p>If set, don't HEAD uploaded objects to check integrity.</p> 14965 <p>This can be useful when trying to minimise the number of transactions rclone does.</p> 14966 <p>Setting it means that if rclone receives a 200 OK message after uploading an object with PUT then it will assume that it got uploaded properly.</p> 14967 <p>In particular it will assume:</p> 14968 <ul> 14969 <li>the metadata, including modtime, storage class and content type was as uploaded</li> 14970 <li>the size was as uploaded</li> 14971 </ul> 14972 <p>It reads the following items from the response for a single part PUT:</p> 14973 <ul> 14974 <li>the MD5SUM</li> 14975 <li>The uploaded date</li> 14976 </ul> 14977 <p>For multipart uploads these items aren't read.</p> 14978 <p>If an source object of unknown length is uploaded then rclone <strong>will</strong> do a HEAD request.</p> 14979 <p>Setting this flag increases the chance for undetected upload failures, in particular an incorrect size, so it isn't recommended for normal operation. In practice the chance of an undetected upload failure is very small even with this flag.</p> 14980 <p>Properties:</p> 14981 <ul> 14982 <li>Config: no_head</li> 14983 <li>Env Var: RCLONE_S3_NO_HEAD</li> 14984 <li>Type: bool</li> 14985 <li>Default: false</li> 14986 </ul> 14987 <h4 id="s3-no-head-object">--s3-no-head-object</h4> 14988 <p>If set, do not do HEAD before GET when getting objects.</p> 14989 <p>Properties:</p> 14990 <ul> 14991 <li>Config: no_head_object</li> 14992 <li>Env Var: RCLONE_S3_NO_HEAD_OBJECT</li> 14993 <li>Type: bool</li> 14994 <li>Default: false</li> 14995 </ul> 14996 <h4 id="s3-encoding">--s3-encoding</h4> 14997 <p>The encoding for the backend.</p> 14998 <p>See the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 14999 <p>Properties:</p> 15000 <ul> 15001 <li>Config: encoding</li> 15002 <li>Env Var: RCLONE_S3_ENCODING</li> 15003 <li>Type: Encoding</li> 15004 <li>Default: Slash,InvalidUtf8,Dot</li> 15005 </ul> 15006 <h4 id="s3-memory-pool-flush-time">--s3-memory-pool-flush-time</h4> 15007 <p>How often internal memory buffer pools will be flushed. (no longer used)</p> 15008 <p>Properties:</p> 15009 <ul> 15010 <li>Config: memory_pool_flush_time</li> 15011 <li>Env Var: RCLONE_S3_MEMORY_POOL_FLUSH_TIME</li> 15012 <li>Type: Duration</li> 15013 <li>Default: 1m0s</li> 15014 </ul> 15015 <h4 id="s3-memory-pool-use-mmap">--s3-memory-pool-use-mmap</h4> 15016 <p>Whether to use mmap buffers in internal memory pool. (no longer used)</p> 15017 <p>Properties:</p> 15018 <ul> 15019 <li>Config: memory_pool_use_mmap</li> 15020 <li>Env Var: RCLONE_S3_MEMORY_POOL_USE_MMAP</li> 15021 <li>Type: bool</li> 15022 <li>Default: false</li> 15023 </ul> 15024 <h4 id="s3-disable-http2">--s3-disable-http2</h4> 15025 <p>Disable usage of http2 for S3 backends.</p> 15026 <p>There is currently an unsolved issue with the s3 (specifically minio) backend and HTTP/2. HTTP/2 is enabled by default for the s3 backend but can be disabled here. When the issue is solved this flag will be removed.</p> 15027 <p>See: https://github.com/rclone/rclone/issues/4673, https://github.com/rclone/rclone/issues/3631</p> 15028 <p>Properties:</p> 15029 <ul> 15030 <li>Config: disable_http2</li> 15031 <li>Env Var: RCLONE_S3_DISABLE_HTTP2</li> 15032 <li>Type: bool</li> 15033 <li>Default: false</li> 15034 </ul> 15035 <h4 id="s3-download-url">--s3-download-url</h4> 15036 <p>Custom endpoint for downloads. This is usually set to a CloudFront CDN URL as AWS S3 offers cheaper egress for data downloaded through the CloudFront network.</p> 15037 <p>Properties:</p> 15038 <ul> 15039 <li>Config: download_url</li> 15040 <li>Env Var: RCLONE_S3_DOWNLOAD_URL</li> 15041 <li>Type: string</li> 15042 <li>Required: false</li> 15043 </ul> 15044 <h4 id="s3-directory-markers">--s3-directory-markers</h4> 15045 <p>Upload an empty object with a trailing slash when a new directory is created</p> 15046 <p>Empty folders are unsupported for bucket based remotes, this option creates an empty object ending with "/", to persist the folder.</p> 15047 <p>Properties:</p> 15048 <ul> 15049 <li>Config: directory_markers</li> 15050 <li>Env Var: RCLONE_S3_DIRECTORY_MARKERS</li> 15051 <li>Type: bool</li> 15052 <li>Default: false</li> 15053 </ul> 15054 <h4 id="s3-use-multipart-etag">--s3-use-multipart-etag</h4> 15055 <p>Whether to use ETag in multipart uploads for verification</p> 15056 <p>This should be true, false or left unset to use the default for the provider.</p> 15057 <p>Properties:</p> 15058 <ul> 15059 <li>Config: use_multipart_etag</li> 15060 <li>Env Var: RCLONE_S3_USE_MULTIPART_ETAG</li> 15061 <li>Type: Tristate</li> 15062 <li>Default: unset</li> 15063 </ul> 15064 <h4 id="s3-use-presigned-request">--s3-use-presigned-request</h4> 15065 <p>Whether to use a presigned request or PutObject for single part uploads</p> 15066 <p>If this is false rclone will use PutObject from the AWS SDK to upload an object.</p> 15067 <p>Versions of rclone < 1.59 use presigned requests to upload a single part object and setting this flag to true will re-enable that functionality. This shouldn't be necessary except in exceptional circumstances or for testing.</p> 15068 <p>Properties:</p> 15069 <ul> 15070 <li>Config: use_presigned_request</li> 15071 <li>Env Var: RCLONE_S3_USE_PRESIGNED_REQUEST</li> 15072 <li>Type: bool</li> 15073 <li>Default: false</li> 15074 </ul> 15075 <h4 id="s3-versions">--s3-versions</h4> 15076 <p>Include old versions in directory listings.</p> 15077 <p>Properties:</p> 15078 <ul> 15079 <li>Config: versions</li> 15080 <li>Env Var: RCLONE_S3_VERSIONS</li> 15081 <li>Type: bool</li> 15082 <li>Default: false</li> 15083 </ul> 15084 <h4 id="s3-version-at">--s3-version-at</h4> 15085 <p>Show file versions as they were at the specified time.</p> 15086 <p>The parameter should be a date, "2006-01-02", datetime "2006-01-02 15:04:05" or a duration for that long ago, eg "100d" or "1h".</p> 15087 <p>Note that when using this no file write operations are permitted, so you can't upload files or delete them.</p> 15088 <p>See <a href="https://rclone.org/docs/#time-option">the time option docs</a> for valid formats.</p> 15089 <p>Properties:</p> 15090 <ul> 15091 <li>Config: version_at</li> 15092 <li>Env Var: RCLONE_S3_VERSION_AT</li> 15093 <li>Type: Time</li> 15094 <li>Default: off</li> 15095 </ul> 15096 <h4 id="s3-version-deleted">--s3-version-deleted</h4> 15097 <p>Show deleted file markers when using versions.</p> 15098 <p>This shows deleted file markers in the listing when using versions. These will appear as 0 size files. The only operation which can be performed on them is deletion.</p> 15099 <p>Deleting a delete marker will reveal the previous version.</p> 15100 <p>Deleted files will always show with a timestamp.</p> 15101 <p>Properties:</p> 15102 <ul> 15103 <li>Config: version_deleted</li> 15104 <li>Env Var: RCLONE_S3_VERSION_DELETED</li> 15105 <li>Type: bool</li> 15106 <li>Default: false</li> 15107 </ul> 15108 <h4 id="s3-decompress">--s3-decompress</h4> 15109 <p>If set this will decompress gzip encoded objects.</p> 15110 <p>It is possible to upload objects to S3 with "Content-Encoding: gzip" set. Normally rclone will download these files as compressed objects.</p> 15111 <p>If this flag is set then rclone will decompress these files with "Content-Encoding: gzip" as they are received. This means that rclone can't check the size and hash but the file contents will be decompressed.</p> 15112 <p>Properties:</p> 15113 <ul> 15114 <li>Config: decompress</li> 15115 <li>Env Var: RCLONE_S3_DECOMPRESS</li> 15116 <li>Type: bool</li> 15117 <li>Default: false</li> 15118 </ul> 15119 <h4 id="s3-might-gzip">--s3-might-gzip</h4> 15120 <p>Set this if the backend might gzip objects.</p> 15121 <p>Normally providers will not alter objects when they are downloaded. If an object was not uploaded with <code>Content-Encoding: gzip</code> then it won't be set on download.</p> 15122 <p>However some providers may gzip objects even if they weren't uploaded with <code>Content-Encoding: gzip</code> (eg Cloudflare).</p> 15123 <p>A symptom of this would be receiving errors like</p> 15124 <pre><code>ERROR corrupted on transfer: sizes differ NNN vs MMM</code></pre> 15125 <p>If you set this flag and rclone downloads an object with Content-Encoding: gzip set and chunked transfer encoding, then rclone will decompress the object on the fly.</p> 15126 <p>If this is set to unset (the default) then rclone will choose according to the provider setting what to apply, but you can override rclone's choice here.</p> 15127 <p>Properties:</p> 15128 <ul> 15129 <li>Config: might_gzip</li> 15130 <li>Env Var: RCLONE_S3_MIGHT_GZIP</li> 15131 <li>Type: Tristate</li> 15132 <li>Default: unset</li> 15133 </ul> 15134 <h4 id="s3-use-accept-encoding-gzip">--s3-use-accept-encoding-gzip</h4> 15135 <p>Whether to send <code>Accept-Encoding: gzip</code> header.</p> 15136 <p>By default, rclone will append <code>Accept-Encoding: gzip</code> to the request to download compressed objects whenever possible.</p> 15137 <p>However some providers such as Google Cloud Storage may alter the HTTP headers, breaking the signature of the request.</p> 15138 <p>A symptom of this would be receiving errors like</p> 15139 <pre><code>SignatureDoesNotMatch: The request signature we calculated does not match the signature you provided.</code></pre> 15140 <p>In this case, you might want to try disabling this option.</p> 15141 <p>Properties:</p> 15142 <ul> 15143 <li>Config: use_accept_encoding_gzip</li> 15144 <li>Env Var: RCLONE_S3_USE_ACCEPT_ENCODING_GZIP</li> 15145 <li>Type: Tristate</li> 15146 <li>Default: unset</li> 15147 </ul> 15148 <h4 id="s3-no-system-metadata">--s3-no-system-metadata</h4> 15149 <p>Suppress setting and reading of system metadata</p> 15150 <p>Properties:</p> 15151 <ul> 15152 <li>Config: no_system_metadata</li> 15153 <li>Env Var: RCLONE_S3_NO_SYSTEM_METADATA</li> 15154 <li>Type: bool</li> 15155 <li>Default: false</li> 15156 </ul> 15157 <h4 id="s3-sts-endpoint">--s3-sts-endpoint</h4> 15158 <p>Endpoint for STS.</p> 15159 <p>Leave blank if using AWS to use the default endpoint for the region.</p> 15160 <p>Properties:</p> 15161 <ul> 15162 <li>Config: sts_endpoint</li> 15163 <li>Env Var: RCLONE_S3_STS_ENDPOINT</li> 15164 <li>Provider: AWS</li> 15165 <li>Type: string</li> 15166 <li>Required: false</li> 15167 </ul> 15168 <h4 id="s3-use-already-exists">--s3-use-already-exists</h4> 15169 <p>Set if rclone should report BucketAlreadyExists errors on bucket creation.</p> 15170 <p>At some point during the evolution of the s3 protocol, AWS started returning an <code>AlreadyOwnedByYou</code> error when attempting to create a bucket that the user already owned, rather than a <code>BucketAlreadyExists</code> error.</p> 15171 <p>Unfortunately exactly what has been implemented by s3 clones is a little inconsistent, some return <code>AlreadyOwnedByYou</code>, some return <code>BucketAlreadyExists</code> and some return no error at all.</p> 15172 <p>This is important to rclone because it ensures the bucket exists by creating it on quite a lot of operations (unless <code>--s3-no-check-bucket</code> is used).</p> 15173 <p>If rclone knows the provider can return <code>AlreadyOwnedByYou</code> or returns no error then it can report <code>BucketAlreadyExists</code> errors when the user attempts to create a bucket not owned by them. Otherwise rclone ignores the <code>BucketAlreadyExists</code> error which can lead to confusion.</p> 15174 <p>This should be automatically set correctly for all providers rclone knows about - please make a bug report if not.</p> 15175 <p>Properties:</p> 15176 <ul> 15177 <li>Config: use_already_exists</li> 15178 <li>Env Var: RCLONE_S3_USE_ALREADY_EXISTS</li> 15179 <li>Type: Tristate</li> 15180 <li>Default: unset</li> 15181 </ul> 15182 <h4 id="s3-use-multipart-uploads">--s3-use-multipart-uploads</h4> 15183 <p>Set if rclone should use multipart uploads.</p> 15184 <p>You can change this if you want to disable the use of multipart uploads. This shouldn't be necessary in normal operation.</p> 15185 <p>This should be automatically set correctly for all providers rclone knows about - please make a bug report if not.</p> 15186 <p>Properties:</p> 15187 <ul> 15188 <li>Config: use_multipart_uploads</li> 15189 <li>Env Var: RCLONE_S3_USE_MULTIPART_UPLOADS</li> 15190 <li>Type: Tristate</li> 15191 <li>Default: unset</li> 15192 </ul> 15193 <h4 id="s3-description">--s3-description</h4> 15194 <p>Description of the remote</p> 15195 <p>Properties:</p> 15196 <ul> 15197 <li>Config: description</li> 15198 <li>Env Var: RCLONE_S3_DESCRIPTION</li> 15199 <li>Type: string</li> 15200 <li>Required: false</li> 15201 </ul> 15202 <h3 id="metadata-3">Metadata</h3> 15203 <p>User metadata is stored as x-amz-meta- keys. S3 metadata keys are case insensitive and are always returned in lower case.</p> 15204 <p>Here are the possible system metadata items for the s3 backend.</p> 15205 <table> 15206 <colgroup> 15207 <col style="width: 15%" /> 15208 <col style="width: 15%" /> 15209 <col style="width: 15%" /> 15210 <col style="width: 23%" /> 15211 <col style="width: 28%" /> 15212 </colgroup> 15213 <thead> 15214 <tr class="header"> 15215 <th>Name</th> 15216 <th>Help</th> 15217 <th>Type</th> 15218 <th>Example</th> 15219 <th>Read Only</th> 15220 </tr> 15221 </thead> 15222 <tbody> 15223 <tr class="odd"> 15224 <td>btime</td> 15225 <td>Time of file birth (creation) read from Last-Modified header</td> 15226 <td>RFC 3339</td> 15227 <td>2006-01-02T15:04:05.999999999Z07:00</td> 15228 <td><strong>Y</strong></td> 15229 </tr> 15230 <tr class="even"> 15231 <td>cache-control</td> 15232 <td>Cache-Control header</td> 15233 <td>string</td> 15234 <td>no-cache</td> 15235 <td>N</td> 15236 </tr> 15237 <tr class="odd"> 15238 <td>content-disposition</td> 15239 <td>Content-Disposition header</td> 15240 <td>string</td> 15241 <td>inline</td> 15242 <td>N</td> 15243 </tr> 15244 <tr class="even"> 15245 <td>content-encoding</td> 15246 <td>Content-Encoding header</td> 15247 <td>string</td> 15248 <td>gzip</td> 15249 <td>N</td> 15250 </tr> 15251 <tr class="odd"> 15252 <td>content-language</td> 15253 <td>Content-Language header</td> 15254 <td>string</td> 15255 <td>en-US</td> 15256 <td>N</td> 15257 </tr> 15258 <tr class="even"> 15259 <td>content-type</td> 15260 <td>Content-Type header</td> 15261 <td>string</td> 15262 <td>text/plain</td> 15263 <td>N</td> 15264 </tr> 15265 <tr class="odd"> 15266 <td>mtime</td> 15267 <td>Time of last modification, read from rclone metadata</td> 15268 <td>RFC 3339</td> 15269 <td>2006-01-02T15:04:05.999999999Z07:00</td> 15270 <td>N</td> 15271 </tr> 15272 <tr class="even"> 15273 <td>tier</td> 15274 <td>Tier of the object</td> 15275 <td>string</td> 15276 <td>GLACIER</td> 15277 <td><strong>Y</strong></td> 15278 </tr> 15279 </tbody> 15280 </table> 15281 <p>See the <a href="https://rclone.org/docs/#metadata">metadata</a> docs for more info.</p> 15282 <h2 id="backend-commands">Backend commands</h2> 15283 <p>Here are the commands specific to the s3 backend.</p> 15284 <p>Run them with</p> 15285 <pre><code>rclone backend COMMAND remote:</code></pre> 15286 <p>The help below will explain what arguments each command takes.</p> 15287 <p>See the <a href="https://rclone.org/commands/rclone_backend/">backend</a> command for more info on how to pass options and arguments.</p> 15288 <p>These can be run on a running backend using the rc command <a href="https://rclone.org/rc/#backend-command">backend/command</a>.</p> 15289 <h3 id="restore">restore</h3> 15290 <p>Restore objects from GLACIER to normal storage</p> 15291 <pre><code>rclone backend restore remote: [options] [<arguments>+]</code></pre> 15292 <p>This command can be used to restore one or more objects from GLACIER to normal storage.</p> 15293 <p>Usage Examples:</p> 15294 <pre><code>rclone backend restore s3:bucket/path/to/object -o priority=PRIORITY -o lifetime=DAYS 15295 rclone backend restore s3:bucket/path/to/directory -o priority=PRIORITY -o lifetime=DAYS 15296 rclone backend restore s3:bucket -o priority=PRIORITY -o lifetime=DAYS</code></pre> 15297 <p>This flag also obeys the filters. Test first with --interactive/-i or --dry-run flags</p> 15298 <pre><code>rclone --interactive backend restore --include "*.txt" s3:bucket/path -o priority=Standard -o lifetime=1</code></pre> 15299 <p>All the objects shown will be marked for restore, then</p> 15300 <pre><code>rclone backend restore --include "*.txt" s3:bucket/path -o priority=Standard -o lifetime=1</code></pre> 15301 <p>It returns a list of status dictionaries with Remote and Status keys. The Status will be OK if it was successful or an error message if not.</p> 15302 <pre><code>[ 15303 { 15304 "Status": "OK", 15305 "Remote": "test.txt" 15306 }, 15307 { 15308 "Status": "OK", 15309 "Remote": "test/file4.txt" 15310 } 15311 ]</code></pre> 15312 <p>Options:</p> 15313 <ul> 15314 <li>"description": The optional description for the job.</li> 15315 <li>"lifetime": Lifetime of the active copy in days</li> 15316 <li>"priority": Priority of restore: Standard|Expedited|Bulk</li> 15317 </ul> 15318 <h3 id="restore-status">restore-status</h3> 15319 <p>Show the restore status for objects being restored from GLACIER to normal storage</p> 15320 <pre><code>rclone backend restore-status remote: [options] [<arguments>+]</code></pre> 15321 <p>This command can be used to show the status for objects being restored from GLACIER to normal storage.</p> 15322 <p>Usage Examples:</p> 15323 <pre><code>rclone backend restore-status s3:bucket/path/to/object 15324 rclone backend restore-status s3:bucket/path/to/directory 15325 rclone backend restore-status -o all s3:bucket/path/to/directory</code></pre> 15326 <p>This command does not obey the filters.</p> 15327 <p>It returns a list of status dictionaries.</p> 15328 <pre><code>[ 15329 { 15330 "Remote": "file.txt", 15331 "VersionID": null, 15332 "RestoreStatus": { 15333 "IsRestoreInProgress": true, 15334 "RestoreExpiryDate": "2023-09-06T12:29:19+01:00" 15335 }, 15336 "StorageClass": "GLACIER" 15337 }, 15338 { 15339 "Remote": "test.pdf", 15340 "VersionID": null, 15341 "RestoreStatus": { 15342 "IsRestoreInProgress": false, 15343 "RestoreExpiryDate": "2023-09-06T12:29:19+01:00" 15344 }, 15345 "StorageClass": "DEEP_ARCHIVE" 15346 } 15347 ]</code></pre> 15348 <p>Options:</p> 15349 <ul> 15350 <li>"all": if set then show all objects, not just ones with restore status</li> 15351 </ul> 15352 <h3 id="list-multipart-uploads">list-multipart-uploads</h3> 15353 <p>List the unfinished multipart uploads</p> 15354 <pre><code>rclone backend list-multipart-uploads remote: [options] [<arguments>+]</code></pre> 15355 <p>This command lists the unfinished multipart uploads in JSON format.</p> 15356 <pre><code>rclone backend list-multipart s3:bucket/path/to/object</code></pre> 15357 <p>It returns a dictionary of buckets with values as lists of unfinished multipart uploads.</p> 15358 <p>You can call it with no bucket in which case it lists all bucket, with a bucket or with a bucket and path.</p> 15359 <pre><code>{ 15360 "rclone": [ 15361 { 15362 "Initiated": "2020-06-26T14:20:36Z", 15363 "Initiator": { 15364 "DisplayName": "XXX", 15365 "ID": "arn:aws:iam::XXX:user/XXX" 15366 }, 15367 "Key": "KEY", 15368 "Owner": { 15369 "DisplayName": null, 15370 "ID": "XXX" 15371 }, 15372 "StorageClass": "STANDARD", 15373 "UploadId": "XXX" 15374 } 15375 ], 15376 "rclone-1000files": [], 15377 "rclone-dst": [] 15378 }</code></pre> 15379 <h3 id="cleanup-2">cleanup</h3> 15380 <p>Remove unfinished multipart uploads.</p> 15381 <pre><code>rclone backend cleanup remote: [options] [<arguments>+]</code></pre> 15382 <p>This command removes unfinished multipart uploads of age greater than max-age which defaults to 24 hours.</p> 15383 <p>Note that you can use --interactive/-i or --dry-run with this command to see what it would do.</p> 15384 <pre><code>rclone backend cleanup s3:bucket/path/to/object 15385 rclone backend cleanup -o max-age=7w s3:bucket/path/to/object</code></pre> 15386 <p>Durations are parsed as per the rest of rclone, 2h, 7d, 7w etc.</p> 15387 <p>Options:</p> 15388 <ul> 15389 <li>"max-age": Max age of upload to delete</li> 15390 </ul> 15391 <h3 id="cleanup-hidden">cleanup-hidden</h3> 15392 <p>Remove old versions of files.</p> 15393 <pre><code>rclone backend cleanup-hidden remote: [options] [<arguments>+]</code></pre> 15394 <p>This command removes any old hidden versions of files on a versions enabled bucket.</p> 15395 <p>Note that you can use --interactive/-i or --dry-run with this command to see what it would do.</p> 15396 <pre><code>rclone backend cleanup-hidden s3:bucket/path/to/dir</code></pre> 15397 <h3 id="versioning">versioning</h3> 15398 <p>Set/get versioning support for a bucket.</p> 15399 <pre><code>rclone backend versioning remote: [options] [<arguments>+]</code></pre> 15400 <p>This command sets versioning support if a parameter is passed and then returns the current versioning status for the bucket supplied.</p> 15401 <pre><code>rclone backend versioning s3:bucket # read status only 15402 rclone backend versioning s3:bucket Enabled 15403 rclone backend versioning s3:bucket Suspended</code></pre> 15404 <p>It may return "Enabled", "Suspended" or "Unversioned". Note that once versioning has been enabled the status can't be set back to "Unversioned".</p> 15405 <h3 id="set">set</h3> 15406 <p>Set command for updating the config parameters.</p> 15407 <pre><code>rclone backend set remote: [options] [<arguments>+]</code></pre> 15408 <p>This set command can be used to update the config parameters for a running s3 backend.</p> 15409 <p>Usage Examples:</p> 15410 <pre><code>rclone backend set s3: [-o opt_name=opt_value] [-o opt_name2=opt_value2] 15411 rclone rc backend/command command=set fs=s3: [-o opt_name=opt_value] [-o opt_name2=opt_value2] 15412 rclone rc backend/command command=set fs=s3: -o session_token=X -o access_key_id=X -o secret_access_key=X</code></pre> 15413 <p>The option keys are named as they are in the config file.</p> 15414 <p>This rebuilds the connection to the s3 backend when it is called with the new parameters. Only new parameters need be passed as the values will default to those currently in use.</p> 15415 <p>It doesn't return anything.</p> 15416 <h3 id="anonymous-access-to-public-buckets">Anonymous access to public buckets</h3> 15417 <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> 15418 <pre><code>[anons3] 15419 type = s3 15420 provider = AWS 15421 env_auth = false 15422 access_key_id = 15423 secret_access_key = 15424 region = us-east-1 15425 endpoint = 15426 location_constraint = 15427 acl = private 15428 server_side_encryption = 15429 storage_class =</code></pre> 15430 <p>Then use it as normal with the name of the public bucket, e.g.</p> 15431 <pre><code>rclone lsd anons3:1000genomes</code></pre> 15432 <p>You will be able to list and copy data but not upload it.</p> 15433 <h2 id="providers-1">Providers</h2> 15434 <h3 id="aws-s3">AWS S3</h3> 15435 <p>This is the provider used as main example and described in the <a href="#configuration">configuration</a> section above.</p> 15436 <h3 id="aws-snowball-edge">AWS Snowball Edge</h3> 15437 <p><a href="https://aws.amazon.com/snowball/">AWS Snowball</a> is a hardware appliance used for transferring bulk data back to AWS. Its main software interface is S3 object storage.</p> 15438 <p>To use rclone with AWS Snowball Edge devices, configure as standard for an 'S3 Compatible Service'.</p> 15439 <p>If using rclone pre v1.59 be sure to set <code>upload_cutoff = 0</code> otherwise you will run into authentication header issues as the snowball device does not support query parameter based authentication.</p> 15440 <p>With rclone v1.59 or later setting <code>upload_cutoff</code> should not be necessary.</p> 15441 <p>eg.</p> 15442 <pre><code>[snowball] 15443 type = s3 15444 provider = Other 15445 access_key_id = YOUR_ACCESS_KEY 15446 secret_access_key = YOUR_SECRET_KEY 15447 endpoint = http://[IP of Snowball]:8080 15448 upload_cutoff = 0</code></pre> 15449 <h3 id="ceph">Ceph</h3> 15450 <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> 15451 <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> 15452 <pre><code>[ceph] 15453 type = s3 15454 provider = Ceph 15455 env_auth = false 15456 access_key_id = XXX 15457 secret_access_key = YYY 15458 region = 15459 endpoint = https://ceph.endpoint.example.com 15460 location_constraint = 15461 acl = 15462 server_side_encryption = 15463 storage_class =</code></pre> 15464 <p>If you are using an older version of CEPH (e.g. 10.2.x Jewel) and a version of rclone before v1.59 then you may need to supply the parameter <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> 15465 <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> 15466 <p>Eg the dump from Ceph looks something like this (irrelevant keys removed).</p> 15467 <pre><code>{ 15468 "user_id": "xxx", 15469 "display_name": "xxxx", 15470 "keys": [ 15471 { 15472 "user": "xxx", 15473 "access_key": "xxxxxx", 15474 "secret_key": "xxxxxx\/xxxx" 15475 } 15476 ], 15477 }</code></pre> 15478 <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> 15479 <h3 id="cloudflare-r2">Cloudflare R2</h3> 15480 <p><a href="https://blog.cloudflare.com/r2-open-beta/">Cloudflare R2</a> Storage allows developers to store large amounts of unstructured data without the costly egress bandwidth fees associated with typical cloud storage services.</p> 15481 <p>Here is an example of making a Cloudflare R2 configuration. First run:</p> 15482 <pre><code>rclone config</code></pre> 15483 <p>This will guide you through an interactive setup process.</p> 15484 <p>Note that all buckets are private, and all are stored in the same "auto" region. It is necessary to use Cloudflare workers to share the content of a bucket publicly.</p> 15485 <pre><code>No remotes found, make a new one? 15486 n) New remote 15487 s) Set configuration password 15488 q) Quit config 15489 n/s/q> n 15490 name> r2 15491 Option Storage. 15492 Type of storage to configure. 15493 Choose a number from below, or type in your own value. 15494 ... 15495 XX / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, China Mobile, Cloudflare, ArvanCloud, DigitalOcean, Dreamhost, Huawei OBS, IBM COS, Lyve Cloud, Minio, Netease, RackCorp, Scaleway, SeaweedFS, StackPath, Storj, Synology, Tencent COS and Wasabi 15496 \ (s3) 15497 ... 15498 Storage> s3 15499 Option provider. 15500 Choose your S3 provider. 15501 Choose a number from below, or type in your own value. 15502 Press Enter to leave empty. 15503 ... 15504 XX / Cloudflare R2 Storage 15505 \ (Cloudflare) 15506 ... 15507 provider> Cloudflare 15508 Option env_auth. 15509 Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). 15510 Only applies if access_key_id and secret_access_key is blank. 15511 Choose a number from below, or type in your own boolean value (true or false). 15512 Press Enter for the default (false). 15513 1 / Enter AWS credentials in the next step. 15514 \ (false) 15515 2 / Get AWS credentials from the environment (env vars or IAM). 15516 \ (true) 15517 env_auth> 1 15518 Option access_key_id. 15519 AWS Access Key ID. 15520 Leave blank for anonymous access or runtime credentials. 15521 Enter a value. Press Enter to leave empty. 15522 access_key_id> ACCESS_KEY 15523 Option secret_access_key. 15524 AWS Secret Access Key (password). 15525 Leave blank for anonymous access or runtime credentials. 15526 Enter a value. Press Enter to leave empty. 15527 secret_access_key> SECRET_ACCESS_KEY 15528 Option region. 15529 Region to connect to. 15530 Choose a number from below, or type in your own value. 15531 Press Enter to leave empty. 15532 1 / R2 buckets are automatically distributed across Cloudflare's data centers for low latency. 15533 \ (auto) 15534 region> 1 15535 Option endpoint. 15536 Endpoint for S3 API. 15537 Required when using an S3 clone. 15538 Enter a value. Press Enter to leave empty. 15539 endpoint> https://ACCOUNT_ID.r2.cloudflarestorage.com 15540 Edit advanced config? 15541 y) Yes 15542 n) No (default) 15543 y/n> n 15544 -------------------- 15545 y) Yes this is OK (default) 15546 e) Edit this remote 15547 d) Delete this remote 15548 y/e/d> y</code></pre> 15549 <p>This will leave your config looking something like:</p> 15550 <pre><code>[r2] 15551 type = s3 15552 provider = Cloudflare 15553 access_key_id = ACCESS_KEY 15554 secret_access_key = SECRET_ACCESS_KEY 15555 region = auto 15556 endpoint = https://ACCOUNT_ID.r2.cloudflarestorage.com 15557 acl = private</code></pre> 15558 <p>Now run <code>rclone lsf r2:</code> to see your buckets and <code>rclone lsf r2:bucket</code> to look within a bucket.</p> 15559 <h3 id="dreamhost">Dreamhost</h3> 15560 <p>Dreamhost <a href="https://www.dreamhost.com/cloud/storage/">DreamObjects</a> is an object storage system based on CEPH.</p> 15561 <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> 15562 <pre><code>[dreamobjects] 15563 type = s3 15564 provider = DreamHost 15565 env_auth = false 15566 access_key_id = your_access_key 15567 secret_access_key = your_secret_key 15568 region = 15569 endpoint = objects-us-west-1.dream.io 15570 location_constraint = 15571 acl = private 15572 server_side_encryption = 15573 storage_class =</code></pre> 15574 <h3 id="google-cloud-storage">Google Cloud Storage</h3> 15575 <p><a href="https://cloud.google.com/storage/docs">GoogleCloudStorage</a> is an <a href="https://cloud.google.com/storage/docs/interoperability">S3-interoperable</a> object storage service from Google Cloud Platform.</p> 15576 <p>To connect to Google Cloud Storage you will need an access key and secret key. These can be retrieved by creating an <a href="https://cloud.google.com/storage/docs/authentication/managing-hmackeys">HMAC key</a>.</p> 15577 <pre><code>[gs] 15578 type = s3 15579 provider = GCS 15580 access_key_id = your_access_key 15581 secret_access_key = your_secret_key 15582 endpoint = https://storage.googleapis.com</code></pre> 15583 <p><strong>Note</strong> that <code>--s3-versions</code> does not work with GCS when it needs to do directory paging. Rclone will return the error:</p> 15584 <pre><code>s3 protocol error: received versions listing with IsTruncated set with no NextKeyMarker</code></pre> 15585 <p>This is Google bug <a href="https://issuetracker.google.com/u/0/issues/312292516">#312292516</a>.</p> 15586 <h3 id="digitalocean-spaces">DigitalOcean Spaces</h3> 15587 <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> 15588 <p>To connect to DigitalOcean Spaces you will need an access key and secret key. These can be retrieved on the "<a href="https://cloud.digitalocean.com/settings/api/tokens">Applications & API</a>" page of the DigitalOcean control panel. They will be needed when prompted by <code>rclone config</code> for your <code>access_key_id</code> and <code>secret_access_key</code>.</p> 15589 <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> 15590 <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> 15591 <pre><code>Storage> s3 15592 env_auth> 1 15593 access_key_id> YOUR_ACCESS_KEY 15594 secret_access_key> YOUR_SECRET_KEY 15595 region> 15596 endpoint> nyc3.digitaloceanspaces.com 15597 location_constraint> 15598 acl> 15599 storage_class></code></pre> 15600 <p>The resulting configuration file should look like:</p> 15601 <pre><code>[spaces] 15602 type = s3 15603 provider = DigitalOcean 15604 env_auth = false 15605 access_key_id = YOUR_ACCESS_KEY 15606 secret_access_key = YOUR_SECRET_KEY 15607 region = 15608 endpoint = nyc3.digitaloceanspaces.com 15609 location_constraint = 15610 acl = 15611 server_side_encryption = 15612 storage_class =</code></pre> 15613 <p>Once configured, you can create a new Space and begin copying files. For example:</p> 15614 <pre><code>rclone mkdir spaces:my-new-space 15615 rclone copy /path/to/files spaces:my-new-space</code></pre> 15616 <h3 id="huawei-obs">Huawei OBS</h3> 15617 <p>Object Storage Service (OBS) provides stable, secure, efficient, and easy-to-use cloud storage that lets you store virtually any volume of unstructured data in any format and access it from anywhere.</p> 15618 <p>OBS provides an S3 interface, you can copy and modify the following configuration and add it to your rclone configuration file.</p> 15619 <pre><code>[obs] 15620 type = s3 15621 provider = HuaweiOBS 15622 access_key_id = your-access-key-id 15623 secret_access_key = your-secret-access-key 15624 region = af-south-1 15625 endpoint = obs.af-south-1.myhuaweicloud.com 15626 acl = private</code></pre> 15627 <p>Or you can also configure via the interactive command line:</p> 15628 <pre><code>No remotes found, make a new one? 15629 n) New remote 15630 s) Set configuration password 15631 q) Quit config 15632 n/s/q> n 15633 name> obs 15634 Option Storage. 15635 Type of storage to configure. 15636 Choose a number from below, or type in your own value. 15637 [snip] 15638 XX / Amazon S3 Compliant Storage Providers including AWS, ... 15639 \ (s3) 15640 [snip] 15641 Storage> s3 15642 Option provider. 15643 Choose your S3 provider. 15644 Choose a number from below, or type in your own value. 15645 Press Enter to leave empty. 15646 [snip] 15647 9 / Huawei Object Storage Service 15648 \ (HuaweiOBS) 15649 [snip] 15650 provider> 9 15651 Option env_auth. 15652 Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). 15653 Only applies if access_key_id and secret_access_key is blank. 15654 Choose a number from below, or type in your own boolean value (true or false). 15655 Press Enter for the default (false). 15656 1 / Enter AWS credentials in the next step. 15657 \ (false) 15658 2 / Get AWS credentials from the environment (env vars or IAM). 15659 \ (true) 15660 env_auth> 1 15661 Option access_key_id. 15662 AWS Access Key ID. 15663 Leave blank for anonymous access or runtime credentials. 15664 Enter a value. Press Enter to leave empty. 15665 access_key_id> your-access-key-id 15666 Option secret_access_key. 15667 AWS Secret Access Key (password). 15668 Leave blank for anonymous access or runtime credentials. 15669 Enter a value. Press Enter to leave empty. 15670 secret_access_key> your-secret-access-key 15671 Option region. 15672 Region to connect to. 15673 Choose a number from below, or type in your own value. 15674 Press Enter to leave empty. 15675 1 / AF-Johannesburg 15676 \ (af-south-1) 15677 2 / AP-Bangkok 15678 \ (ap-southeast-2) 15679 [snip] 15680 region> 1 15681 Option endpoint. 15682 Endpoint for OBS API. 15683 Choose a number from below, or type in your own value. 15684 Press Enter to leave empty. 15685 1 / AF-Johannesburg 15686 \ (obs.af-south-1.myhuaweicloud.com) 15687 2 / AP-Bangkok 15688 \ (obs.ap-southeast-2.myhuaweicloud.com) 15689 [snip] 15690 endpoint> 1 15691 Option acl. 15692 Canned ACL used when creating buckets and storing or copying objects. 15693 This ACL is used for creating objects and if bucket_acl isn't set, for creating buckets too. 15694 For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl 15695 Note that this ACL is applied when server-side copying objects as S3 15696 doesn't copy the ACL from the source but rather writes a fresh one. 15697 Choose a number from below, or type in your own value. 15698 Press Enter to leave empty. 15699 / Owner gets FULL_CONTROL. 15700 1 | No one else has access rights (default). 15701 \ (private) 15702 [snip] 15703 acl> 1 15704 Edit advanced config? 15705 y) Yes 15706 n) No (default) 15707 y/n> 15708 -------------------- 15709 [obs] 15710 type = s3 15711 provider = HuaweiOBS 15712 access_key_id = your-access-key-id 15713 secret_access_key = your-secret-access-key 15714 region = af-south-1 15715 endpoint = obs.af-south-1.myhuaweicloud.com 15716 acl = private 15717 -------------------- 15718 y) Yes this is OK (default) 15719 e) Edit this remote 15720 d) Delete this remote 15721 y/e/d> y 15722 Current remotes: 15723 15724 Name Type 15725 ==== ==== 15726 obs s3 15727 15728 e) Edit existing remote 15729 n) New remote 15730 d) Delete remote 15731 r) Rename remote 15732 c) Copy remote 15733 s) Set configuration password 15734 q) Quit config 15735 e/n/d/r/c/s/q> q</code></pre> 15736 <h3 id="ibm-cos-s3">IBM COS (S3)</h3> 15737 <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> 15738 <p>To configure access to IBM COS S3, follow the steps below:</p> 15739 <ol type="1"> 15740 <li>Run rclone config and select n for a new remote.</li> 15741 </ol> 15742 <pre><code> 2018/02/14 14:13:11 NOTICE: Config file "C:\\Users\\a\\.config\\rclone\\rclone.conf" not found - using defaults 15743 No remotes found, make a new one? 15744 n) New remote 15745 s) Set configuration password 15746 q) Quit config 15747 n/s/q> n</code></pre> 15748 <ol start="2" type="1"> 15749 <li>Enter the name for the configuration</li> 15750 </ol> 15751 <pre><code> name> <YOUR NAME></code></pre> 15752 <ol start="3" type="1"> 15753 <li>Select "s3" storage.</li> 15754 </ol> 15755 <pre><code>Choose a number from below, or type in your own value 15756 [snip] 15757 XX / Amazon S3 Compliant Storage Providers including AWS, ... 15758 \ "s3" 15759 [snip] 15760 Storage> s3</code></pre> 15761 <ol start="4" type="1"> 15762 <li>Select IBM COS as the S3 Storage Provider.</li> 15763 </ol> 15764 <pre><code>Choose the S3 provider. 15765 Choose a number from below, or type in your own value 15766 1 / Choose this option to configure Storage to AWS S3 15767 \ "AWS" 15768 2 / Choose this option to configure Storage to Ceph Systems 15769 \ "Ceph" 15770 3 / Choose this option to configure Storage to Dreamhost 15771 \ "Dreamhost" 15772 4 / Choose this option to the configure Storage to IBM COS S3 15773 \ "IBMCOS" 15774 5 / Choose this option to the configure Storage to Minio 15775 \ "Minio" 15776 Provider>4</code></pre> 15777 <ol start="5" type="1"> 15778 <li>Enter the Access Key and Secret.</li> 15779 </ol> 15780 <pre><code> AWS Access Key ID - leave blank for anonymous access or runtime credentials. 15781 access_key_id> <> 15782 AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials. 15783 secret_access_key> <></code></pre> 15784 <ol start="6" type="1"> 15785 <li>Specify the endpoint for IBM COS. For Public IBM COS, choose from the option below. For On Premise IBM COS, enter an endpoint address.</li> 15786 </ol> 15787 <pre><code> Endpoint for IBM COS S3 API. 15788 Specify if using an IBM COS On Premise. 15789 Choose a number from below, or type in your own value 15790 1 / US Cross Region Endpoint 15791 \ "s3-api.us-geo.objectstorage.softlayer.net" 15792 2 / US Cross Region Dallas Endpoint 15793 \ "s3-api.dal.us-geo.objectstorage.softlayer.net" 15794 3 / US Cross Region Washington DC Endpoint 15795 \ "s3-api.wdc-us-geo.objectstorage.softlayer.net" 15796 4 / US Cross Region San Jose Endpoint 15797 \ "s3-api.sjc-us-geo.objectstorage.softlayer.net" 15798 5 / US Cross Region Private Endpoint 15799 \ "s3-api.us-geo.objectstorage.service.networklayer.com" 15800 6 / US Cross Region Dallas Private Endpoint 15801 \ "s3-api.dal-us-geo.objectstorage.service.networklayer.com" 15802 7 / US Cross Region Washington DC Private Endpoint 15803 \ "s3-api.wdc-us-geo.objectstorage.service.networklayer.com" 15804 8 / US Cross Region San Jose Private Endpoint 15805 \ "s3-api.sjc-us-geo.objectstorage.service.networklayer.com" 15806 9 / US Region East Endpoint 15807 \ "s3.us-east.objectstorage.softlayer.net" 15808 10 / US Region East Private Endpoint 15809 \ "s3.us-east.objectstorage.service.networklayer.com" 15810 11 / US Region South Endpoint 15811 [snip] 15812 34 / Toronto Single Site Private Endpoint 15813 \ "s3.tor01.objectstorage.service.networklayer.com" 15814 endpoint>1</code></pre> 15815 <ol start="7" type="1"> 15816 <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> 15817 </ol> 15818 <pre><code> 1 / US Cross Region Standard 15819 \ "us-standard" 15820 2 / US Cross Region Vault 15821 \ "us-vault" 15822 3 / US Cross Region Cold 15823 \ "us-cold" 15824 4 / US Cross Region Flex 15825 \ "us-flex" 15826 5 / US East Region Standard 15827 \ "us-east-standard" 15828 6 / US East Region Vault 15829 \ "us-east-vault" 15830 7 / US East Region Cold 15831 \ "us-east-cold" 15832 8 / US East Region Flex 15833 \ "us-east-flex" 15834 9 / US South Region Standard 15835 \ "us-south-standard" 15836 10 / US South Region Vault 15837 \ "us-south-vault" 15838 [snip] 15839 32 / Toronto Flex 15840 \ "tor01-flex" 15841 location_constraint>1</code></pre> 15842 <ol start="9" type="1"> 15843 <li>Specify a canned ACL. IBM Cloud (Storage) supports "public-read" and "private". IBM Cloud(Infra) supports all the canned ACLs. On-Premise COS supports all the canned ACLs.</li> 15844 </ol> 15845 <pre><code>Canned ACL used when creating buckets and/or storing objects in S3. 15846 For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl 15847 Choose a number from below, or type in your own value 15848 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 15849 \ "private" 15850 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 15851 \ "public-read" 15852 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 15853 \ "public-read-write" 15854 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 15855 \ "authenticated-read" 15856 acl> 1</code></pre> 15857 <ol start="12" type="1"> 15858 <li>Review the displayed configuration and accept to save the "remote" then quit. The config file should look like this</li> 15859 </ol> 15860 <pre><code> [xxx] 15861 type = s3 15862 Provider = IBMCOS 15863 access_key_id = xxx 15864 secret_access_key = yyy 15865 endpoint = s3-api.us-geo.objectstorage.softlayer.net 15866 location_constraint = us-standard 15867 acl = private</code></pre> 15868 <ol start="13" type="1"> 15869 <li>Execute rclone commands</li> 15870 </ol> 15871 <pre><code> 1) Create a bucket. 15872 rclone mkdir IBM-COS-XREGION:newbucket 15873 2) List available buckets. 15874 rclone lsd IBM-COS-XREGION: 15875 -1 2017-11-08 21:16:22 -1 test 15876 -1 2018-02-14 20:16:39 -1 newbucket 15877 3) List contents of a bucket. 15878 rclone ls IBM-COS-XREGION:newbucket 15879 18685952 test.exe 15880 4) Copy a file from local to remote. 15881 rclone copy /Users/file.txt IBM-COS-XREGION:newbucket 15882 5) Copy a file from remote to local. 15883 rclone copy IBM-COS-XREGION:newbucket/file.txt . 15884 6) Delete a file on remote. 15885 rclone delete IBM-COS-XREGION:newbucket/file.txt</code></pre> 15886 <h3 id="idrive-e2">IDrive e2</h3> 15887 <p>Here is an example of making an <a href="https://www.idrive.com/e2/">IDrive e2</a> configuration. First run:</p> 15888 <pre><code>rclone config</code></pre> 15889 <p>This will guide you through an interactive setup process.</p> 15890 <pre><code>No remotes found, make a new one? 15891 n) New remote 15892 s) Set configuration password 15893 q) Quit config 15894 n/s/q> n 15895 15896 Enter name for new remote. 15897 name> e2 15898 15899 Option Storage. 15900 Type of storage to configure. 15901 Choose a number from below, or type in your own value. 15902 [snip] 15903 XX / Amazon S3 Compliant Storage Providers including AWS, ... 15904 \ (s3) 15905 [snip] 15906 Storage> s3 15907 15908 Option provider. 15909 Choose your S3 provider. 15910 Choose a number from below, or type in your own value. 15911 Press Enter to leave empty. 15912 [snip] 15913 XX / IDrive e2 15914 \ (IDrive) 15915 [snip] 15916 provider> IDrive 15917 15918 Option env_auth. 15919 Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). 15920 Only applies if access_key_id and secret_access_key is blank. 15921 Choose a number from below, or type in your own boolean value (true or false). 15922 Press Enter for the default (false). 15923 1 / Enter AWS credentials in the next step. 15924 \ (false) 15925 2 / Get AWS credentials from the environment (env vars or IAM). 15926 \ (true) 15927 env_auth> 15928 15929 Option access_key_id. 15930 AWS Access Key ID. 15931 Leave blank for anonymous access or runtime credentials. 15932 Enter a value. Press Enter to leave empty. 15933 access_key_id> YOUR_ACCESS_KEY 15934 15935 Option secret_access_key. 15936 AWS Secret Access Key (password). 15937 Leave blank for anonymous access or runtime credentials. 15938 Enter a value. Press Enter to leave empty. 15939 secret_access_key> YOUR_SECRET_KEY 15940 15941 Option acl. 15942 Canned ACL used when creating buckets and storing or copying objects. 15943 This ACL is used for creating objects and if bucket_acl isn't set, for creating buckets too. 15944 For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl 15945 Note that this ACL is applied when server-side copying objects as S3 15946 doesn't copy the ACL from the source but rather writes a fresh one. 15947 Choose a number from below, or type in your own value. 15948 Press Enter to leave empty. 15949 / Owner gets FULL_CONTROL. 15950 1 | No one else has access rights (default). 15951 \ (private) 15952 / Owner gets FULL_CONTROL. 15953 2 | The AllUsers group gets READ access. 15954 \ (public-read) 15955 / Owner gets FULL_CONTROL. 15956 3 | The AllUsers group gets READ and WRITE access. 15957 | Granting this on a bucket is generally not recommended. 15958 \ (public-read-write) 15959 / Owner gets FULL_CONTROL. 15960 4 | The AuthenticatedUsers group gets READ access. 15961 \ (authenticated-read) 15962 / Object owner gets FULL_CONTROL. 15963 5 | Bucket owner gets READ access. 15964 | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it. 15965 \ (bucket-owner-read) 15966 / Both the object owner and the bucket owner get FULL_CONTROL over the object. 15967 6 | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it. 15968 \ (bucket-owner-full-control) 15969 acl> 15970 15971 Edit advanced config? 15972 y) Yes 15973 n) No (default) 15974 y/n> 15975 15976 Configuration complete. 15977 Options: 15978 - type: s3 15979 - provider: IDrive 15980 - access_key_id: YOUR_ACCESS_KEY 15981 - secret_access_key: YOUR_SECRET_KEY 15982 - endpoint: q9d9.la12.idrivee2-5.com 15983 Keep this "e2" remote? 15984 y) Yes this is OK (default) 15985 e) Edit this remote 15986 d) Delete this remote 15987 y/e/d> y</code></pre> 15988 <h3 id="ionos">IONOS Cloud</h3> 15989 <p><a href="https://cloud.ionos.com/storage/object-storage">IONOS S3 Object Storage</a> is a service offered by IONOS for storing and accessing unstructured data. To connect to the service, you will need an access key and a secret key. These can be found in the <a href="https://dcd.ionos.com/">Data Center Designer</a>, by selecting <strong>Manager resources</strong> > <strong>Object Storage Key Manager</strong>.</p> 15990 <p>Here is an example of a configuration. First, run <code>rclone config</code>. This will walk you through an interactive setup process. Type <code>n</code> to add the new remote, and then enter a name:</p> 15991 <pre><code>Enter name for new remote. 15992 name> ionos-fra</code></pre> 15993 <p>Type <code>s3</code> to choose the connection type:</p> 15994 <pre><code>Option Storage. 15995 Type of storage to configure. 15996 Choose a number from below, or type in your own value. 15997 [snip] 15998 XX / Amazon S3 Compliant Storage Providers including AWS, ... 15999 \ (s3) 16000 [snip] 16001 Storage> s3</code></pre> 16002 <p>Type <code>IONOS</code>:</p> 16003 <pre><code>Option provider. 16004 Choose your S3 provider. 16005 Choose a number from below, or type in your own value. 16006 Press Enter to leave empty. 16007 [snip] 16008 XX / IONOS Cloud 16009 \ (IONOS) 16010 [snip] 16011 provider> IONOS</code></pre> 16012 <p>Press Enter to choose the default option <code>Enter AWS credentials in the next step</code>:</p> 16013 <pre><code>Option env_auth. 16014 Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). 16015 Only applies if access_key_id and secret_access_key is blank. 16016 Choose a number from below, or type in your own boolean value (true or false). 16017 Press Enter for the default (false). 16018 1 / Enter AWS credentials in the next step. 16019 \ (false) 16020 2 / Get AWS credentials from the environment (env vars or IAM). 16021 \ (true) 16022 env_auth></code></pre> 16023 <p>Enter your Access Key and Secret key. These can be retrieved in the <a href="https://dcd.ionos.com/">Data Center Designer</a>, click on the menu “Manager resources” / "Object Storage Key Manager".</p> 16024 <pre><code>Option access_key_id. 16025 AWS Access Key ID. 16026 Leave blank for anonymous access or runtime credentials. 16027 Enter a value. Press Enter to leave empty. 16028 access_key_id> YOUR_ACCESS_KEY 16029 16030 Option secret_access_key. 16031 AWS Secret Access Key (password). 16032 Leave blank for anonymous access or runtime credentials. 16033 Enter a value. Press Enter to leave empty. 16034 secret_access_key> YOUR_SECRET_KEY</code></pre> 16035 <p>Choose the region where your bucket is located:</p> 16036 <pre><code>Option region. 16037 Region where your bucket will be created and your data stored. 16038 Choose a number from below, or type in your own value. 16039 Press Enter to leave empty. 16040 1 / Frankfurt, Germany 16041 \ (de) 16042 2 / Berlin, Germany 16043 \ (eu-central-2) 16044 3 / Logrono, Spain 16045 \ (eu-south-2) 16046 region> 2</code></pre> 16047 <p>Choose the endpoint from the same region:</p> 16048 <pre><code>Option endpoint. 16049 Endpoint for IONOS S3 Object Storage. 16050 Specify the endpoint from the same region. 16051 Choose a number from below, or type in your own value. 16052 Press Enter to leave empty. 16053 1 / Frankfurt, Germany 16054 \ (s3-eu-central-1.ionoscloud.com) 16055 2 / Berlin, Germany 16056 \ (s3-eu-central-2.ionoscloud.com) 16057 3 / Logrono, Spain 16058 \ (s3-eu-south-2.ionoscloud.com) 16059 endpoint> 1</code></pre> 16060 <p>Press Enter to choose the default option or choose the desired ACL setting:</p> 16061 <pre><code>Option acl. 16062 Canned ACL used when creating buckets and storing or copying objects. 16063 This ACL is used for creating objects and if bucket_acl isn't set, for creating buckets too. 16064 For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl 16065 Note that this ACL is applied when server-side copying objects as S3 16066 doesn't copy the ACL from the source but rather writes a fresh one. 16067 Choose a number from below, or type in your own value. 16068 Press Enter to leave empty. 16069 / Owner gets FULL_CONTROL. 16070 1 | No one else has access rights (default). 16071 \ (private) 16072 / Owner gets FULL_CONTROL. 16073 [snip] 16074 acl></code></pre> 16075 <p>Press Enter to skip the advanced config:</p> 16076 <pre><code>Edit advanced config? 16077 y) Yes 16078 n) No (default) 16079 y/n></code></pre> 16080 <p>Press Enter to save the configuration, and then <code>q</code> to quit the configuration process:</p> 16081 <pre><code>Configuration complete. 16082 Options: 16083 - type: s3 16084 - provider: IONOS 16085 - access_key_id: YOUR_ACCESS_KEY 16086 - secret_access_key: YOUR_SECRET_KEY 16087 - endpoint: s3-eu-central-1.ionoscloud.com 16088 Keep this "ionos-fra" remote? 16089 y) Yes this is OK (default) 16090 e) Edit this remote 16091 d) Delete this remote 16092 y/e/d> y</code></pre> 16093 <p>Done! Now you can try some commands (for macOS, use <code>./rclone</code> instead of <code>rclone</code>).</p> 16094 <ol type="1"> 16095 <li>Create a bucket (the name must be unique within the whole IONOS S3)</li> 16096 </ol> 16097 <pre><code>rclone mkdir ionos-fra:my-bucket</code></pre> 16098 <ol start="2" type="1"> 16099 <li>List available buckets</li> 16100 </ol> 16101 <pre><code>rclone lsd ionos-fra:</code></pre> 16102 <ol start="4" type="1"> 16103 <li>Copy a file from local to remote</li> 16104 </ol> 16105 <pre><code>rclone copy /Users/file.txt ionos-fra:my-bucket</code></pre> 16106 <ol start="3" type="1"> 16107 <li>List contents of a bucket</li> 16108 </ol> 16109 <pre><code>rclone ls ionos-fra:my-bucket</code></pre> 16110 <ol start="5" type="1"> 16111 <li>Copy a file from remote to local</li> 16112 </ol> 16113 <pre><code>rclone copy ionos-fra:my-bucket/file.txt</code></pre> 16114 <h3 id="minio">Minio</h3> 16115 <p><a href="https://minio.io/">Minio</a> is an object storage server built for cloud application developers and devops.</p> 16116 <p>It is very easy to install and provides an S3 compatible server which can be used by rclone.</p> 16117 <p>To use it, install Minio following the instructions <a href="https://docs.minio.io/docs/minio-quickstart-guide">here</a>.</p> 16118 <p>When it configures itself Minio will print something like this</p> 16119 <pre><code>Endpoint: http://192.168.1.106:9000 http://172.23.0.1:9000 16120 AccessKey: USWUXHGYZQYFYFFIT3RE 16121 SecretKey: MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 16122 Region: us-east-1 16123 SQS ARNs: arn:minio:sqs:us-east-1:1:redis arn:minio:sqs:us-east-1:2:redis 16124 16125 Browser Access: 16126 http://192.168.1.106:9000 http://172.23.0.1:9000 16127 16128 Command-line Access: https://docs.minio.io/docs/minio-client-quickstart-guide 16129 $ mc config host add myminio http://192.168.1.106:9000 USWUXHGYZQYFYFFIT3RE MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 16130 16131 Object API (Amazon S3 compatible): 16132 Go: https://docs.minio.io/docs/golang-client-quickstart-guide 16133 Java: https://docs.minio.io/docs/java-client-quickstart-guide 16134 Python: https://docs.minio.io/docs/python-client-quickstart-guide 16135 JavaScript: https://docs.minio.io/docs/javascript-client-quickstart-guide 16136 .NET: https://docs.minio.io/docs/dotnet-client-quickstart-guide 16137 16138 Drive Capacity: 26 GiB Free, 165 GiB Total</code></pre> 16139 <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> 16140 <pre><code>env_auth> 1 16141 access_key_id> USWUXHGYZQYFYFFIT3RE 16142 secret_access_key> MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 16143 region> us-east-1 16144 endpoint> http://192.168.1.106:9000 16145 location_constraint> 16146 server_side_encryption></code></pre> 16147 <p>Which makes the config file look like this</p> 16148 <pre><code>[minio] 16149 type = s3 16150 provider = Minio 16151 env_auth = false 16152 access_key_id = USWUXHGYZQYFYFFIT3RE 16153 secret_access_key = MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 16154 region = us-east-1 16155 endpoint = http://192.168.1.106:9000 16156 location_constraint = 16157 server_side_encryption =</code></pre> 16158 <p>So once set up, for example, to copy files into a bucket</p> 16159 <pre><code>rclone copy /path/to/files minio:bucket</code></pre> 16160 <h3 id="qiniu">Qiniu Cloud Object Storage (Kodo)</h3> 16161 <p><a href="https://www.qiniu.com/en/products/kodo">Qiniu Cloud Object Storage (Kodo)</a>, a completely independent-researched core technology which is proven by repeated customer experience has occupied absolute leading market leader position. Kodo can be widely applied to mass data management.</p> 16162 <p>To configure access to Qiniu Kodo, follow the steps below:</p> 16163 <ol type="1"> 16164 <li>Run <code>rclone config</code> and select <code>n</code> for a new remote.</li> 16165 </ol> 16166 <pre><code>rclone config 16167 No remotes found, make a new one? 16168 n) New remote 16169 s) Set configuration password 16170 q) Quit config 16171 n/s/q> n</code></pre> 16172 <ol start="2" type="1"> 16173 <li>Give the name of the configuration. For example, name it 'qiniu'.</li> 16174 </ol> 16175 <pre><code>name> qiniu</code></pre> 16176 <ol start="3" type="1"> 16177 <li>Select <code>s3</code> storage.</li> 16178 </ol> 16179 <pre><code>Choose a number from below, or type in your own value 16180 [snip] 16181 XX / Amazon S3 Compliant Storage Providers including AWS, ... 16182 \ (s3) 16183 [snip] 16184 Storage> s3</code></pre> 16185 <ol start="4" type="1"> 16186 <li>Select <code>Qiniu</code> provider.</li> 16187 </ol> 16188 <pre><code>Choose a number from below, or type in your own value 16189 1 / Amazon Web Services (AWS) S3 16190 \ "AWS" 16191 [snip] 16192 22 / Qiniu Object Storage (Kodo) 16193 \ (Qiniu) 16194 [snip] 16195 provider> Qiniu</code></pre> 16196 <ol start="5" type="1"> 16197 <li>Enter your SecretId and SecretKey of Qiniu Kodo.</li> 16198 </ol> 16199 <pre><code>Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). 16200 Only applies if access_key_id and secret_access_key is blank. 16201 Enter a boolean value (true or false). Press Enter for the default ("false"). 16202 Choose a number from below, or type in your own value 16203 1 / Enter AWS credentials in the next step 16204 \ "false" 16205 2 / Get AWS credentials from the environment (env vars or IAM) 16206 \ "true" 16207 env_auth> 1 16208 AWS Access Key ID. 16209 Leave blank for anonymous access or runtime credentials. 16210 Enter a string value. Press Enter for the default (""). 16211 access_key_id> AKIDxxxxxxxxxx 16212 AWS Secret Access Key (password) 16213 Leave blank for anonymous access or runtime credentials. 16214 Enter a string value. Press Enter for the default (""). 16215 secret_access_key> xxxxxxxxxxx</code></pre> 16216 <ol start="6" type="1"> 16217 <li>Select endpoint for Qiniu Kodo. This is the standard endpoint for different region.</li> 16218 </ol> 16219 <pre><code> / The default endpoint - a good choice if you are unsure. 16220 1 | East China Region 1. 16221 | Needs location constraint cn-east-1. 16222 \ (cn-east-1) 16223 / East China Region 2. 16224 2 | Needs location constraint cn-east-2. 16225 \ (cn-east-2) 16226 / North China Region 1. 16227 3 | Needs location constraint cn-north-1. 16228 \ (cn-north-1) 16229 / South China Region 1. 16230 4 | Needs location constraint cn-south-1. 16231 \ (cn-south-1) 16232 / North America Region. 16233 5 | Needs location constraint us-north-1. 16234 \ (us-north-1) 16235 / Southeast Asia Region 1. 16236 6 | Needs location constraint ap-southeast-1. 16237 \ (ap-southeast-1) 16238 / Northeast Asia Region 1. 16239 7 | Needs location constraint ap-northeast-1. 16240 \ (ap-northeast-1) 16241 [snip] 16242 endpoint> 1 16243 16244 Option endpoint. 16245 Endpoint for Qiniu Object Storage. 16246 Choose a number from below, or type in your own value. 16247 Press Enter to leave empty. 16248 1 / East China Endpoint 1 16249 \ (s3-cn-east-1.qiniucs.com) 16250 2 / East China Endpoint 2 16251 \ (s3-cn-east-2.qiniucs.com) 16252 3 / North China Endpoint 1 16253 \ (s3-cn-north-1.qiniucs.com) 16254 4 / South China Endpoint 1 16255 \ (s3-cn-south-1.qiniucs.com) 16256 5 / North America Endpoint 1 16257 \ (s3-us-north-1.qiniucs.com) 16258 6 / Southeast Asia Endpoint 1 16259 \ (s3-ap-southeast-1.qiniucs.com) 16260 7 / Northeast Asia Endpoint 1 16261 \ (s3-ap-northeast-1.qiniucs.com) 16262 endpoint> 1 16263 16264 Option location_constraint. 16265 Location constraint - must be set to match the Region. 16266 Used when creating buckets only. 16267 Choose a number from below, or type in your own value. 16268 Press Enter to leave empty. 16269 1 / East China Region 1 16270 \ (cn-east-1) 16271 2 / East China Region 2 16272 \ (cn-east-2) 16273 3 / North China Region 1 16274 \ (cn-north-1) 16275 4 / South China Region 1 16276 \ (cn-south-1) 16277 5 / North America Region 1 16278 \ (us-north-1) 16279 6 / Southeast Asia Region 1 16280 \ (ap-southeast-1) 16281 7 / Northeast Asia Region 1 16282 \ (ap-northeast-1) 16283 location_constraint> 1</code></pre> 16284 <ol start="7" type="1"> 16285 <li>Choose acl and storage class.</li> 16286 </ol> 16287 <pre><code>Note that this ACL is applied when server-side copying objects as S3 16288 doesn't copy the ACL from the source but rather writes a fresh one. 16289 Enter a string value. Press Enter for the default (""). 16290 Choose a number from below, or type in your own value 16291 / Owner gets FULL_CONTROL. 16292 1 | No one else has access rights (default). 16293 \ (private) 16294 / Owner gets FULL_CONTROL. 16295 2 | The AllUsers group gets READ access. 16296 \ (public-read) 16297 [snip] 16298 acl> 2 16299 The storage class to use when storing new objects in Tencent COS. 16300 Enter a string value. Press Enter for the default (""). 16301 Choose a number from below, or type in your own value 16302 1 / Standard storage class 16303 \ (STANDARD) 16304 2 / Infrequent access storage mode 16305 \ (LINE) 16306 3 / Archive storage mode 16307 \ (GLACIER) 16308 4 / Deep archive storage mode 16309 \ (DEEP_ARCHIVE) 16310 [snip] 16311 storage_class> 1 16312 Edit advanced config? (y/n) 16313 y) Yes 16314 n) No (default) 16315 y/n> n 16316 Remote config 16317 -------------------- 16318 [qiniu] 16319 - type: s3 16320 - provider: Qiniu 16321 - access_key_id: xxx 16322 - secret_access_key: xxx 16323 - region: cn-east-1 16324 - endpoint: s3-cn-east-1.qiniucs.com 16325 - location_constraint: cn-east-1 16326 - acl: public-read 16327 - storage_class: STANDARD 16328 -------------------- 16329 y) Yes this is OK (default) 16330 e) Edit this remote 16331 d) Delete this remote 16332 y/e/d> y 16333 Current remotes: 16334 16335 Name Type 16336 ==== ==== 16337 qiniu s3</code></pre> 16338 <h3 id="RackCorp">RackCorp</h3> 16339 <p><a href="https://www.rackcorp.com/storage/s3storage">RackCorp Object Storage</a> is an S3 compatible object storage platform from your friendly cloud provider RackCorp. The service is fast, reliable, well priced and located in many strategic locations unserviced by others, to ensure you can maintain data sovereignty.</p> 16340 <p>Before you can use RackCorp Object Storage, you'll need to "<a href="https://www.rackcorp.com/signup">sign up</a>" for an account on our "<a href="https://portal.rackcorp.com">portal</a>". Next you can create an <code>access key</code>, a <code>secret key</code> and <code>buckets</code>, in your location of choice with ease. These details are required for the next steps of configuration, when <code>rclone config</code> asks for your <code>access_key_id</code> and <code>secret_access_key</code>.</p> 16341 <p>Your config should end up looking a bit like this:</p> 16342 <pre><code>[RCS3-demo-config] 16343 type = s3 16344 provider = RackCorp 16345 env_auth = true 16346 access_key_id = YOURACCESSKEY 16347 secret_access_key = YOURSECRETACCESSKEY 16348 region = au-nsw 16349 endpoint = s3.rackcorp.com 16350 location_constraint = au-nsw</code></pre> 16351 <h3 id="rclone">Rclone Serve S3</h3> 16352 <p>Rclone can serve any remote over the S3 protocol. For details see the <a href="https://rclone.org/commands/rclone_serve_http/">rclone serve s3</a> documentation.</p> 16353 <p>For example, to serve <code>remote:path</code> over s3, run the server like this:</p> 16354 <pre><code>rclone serve s3 --auth-key ACCESS_KEY_ID,SECRET_ACCESS_KEY remote:path</code></pre> 16355 <p>This will be compatible with an rclone remote which is defined like this:</p> 16356 <pre><code>[serves3] 16357 type = s3 16358 provider = Rclone 16359 endpoint = http://127.0.0.1:8080/ 16360 access_key_id = ACCESS_KEY_ID 16361 secret_access_key = SECRET_ACCESS_KEY 16362 use_multipart_uploads = false</code></pre> 16363 <p>Note that setting <code>disable_multipart_uploads = true</code> is to work around <a href="https://rclone.org/commands/rclone_serve_http/#bugs">a bug</a> which will be fixed in due course.</p> 16364 <h3 id="scaleway">Scaleway</h3> 16365 <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> 16366 <p>Scaleway provides an S3 interface which can be configured for use with rclone like this:</p> 16367 <pre><code>[scaleway] 16368 type = s3 16369 provider = Scaleway 16370 env_auth = false 16371 endpoint = s3.nl-ams.scw.cloud 16372 access_key_id = SCWXXXXXXXXXXXXXX 16373 secret_access_key = 1111111-2222-3333-44444-55555555555555 16374 region = nl-ams 16375 location_constraint = 16376 acl = private 16377 server_side_encryption = 16378 storage_class =</code></pre> 16379 <p><a href="https://www.online.net/en/storage/c14-cold-storage">C14 Cold Storage</a> is the low-cost S3 Glacier alternative from Scaleway and it works the same way as on S3 by accepting the "GLACIER" <code>storage_class</code>. So you can configure your remote with the <code>storage_class = GLACIER</code> option to upload directly to C14. Don't forget that in this state you can't read files back after, you will need to restore them to "STANDARD" storage_class first before being able to read them (see "restore" section above)</p> 16380 <h3 id="lyve">Seagate Lyve Cloud</h3> 16381 <p><a href="https://www.seagate.com/gb/en/services/cloud/storage/">Seagate Lyve Cloud</a> is an S3 compatible object storage platform from <a href="https://seagate.com/">Seagate</a> intended for enterprise use.</p> 16382 <p>Here is a config run through for a remote called <code>remote</code> - you may choose a different name of course. Note that to create an access key and secret key you will need to create a service account first.</p> 16383 <pre><code>$ rclone config 16384 No remotes found, make a new one? 16385 n) New remote 16386 s) Set configuration password 16387 q) Quit config 16388 n/s/q> n 16389 name> remote</code></pre> 16390 <p>Choose <code>s3</code> backend</p> 16391 <pre><code>Type of storage to configure. 16392 Choose a number from below, or type in your own value. 16393 [snip] 16394 XX / Amazon S3 Compliant Storage Providers including AWS, ... 16395 \ (s3) 16396 [snip] 16397 Storage> s3</code></pre> 16398 <p>Choose <code>LyveCloud</code> as S3 provider</p> 16399 <pre><code>Choose your S3 provider. 16400 Choose a number from below, or type in your own value. 16401 Press Enter to leave empty. 16402 [snip] 16403 XX / Seagate Lyve Cloud 16404 \ (LyveCloud) 16405 [snip] 16406 provider> LyveCloud</code></pre> 16407 <p>Take the default (just press enter) to enter access key and secret in the config file.</p> 16408 <pre><code>Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). 16409 Only applies if access_key_id and secret_access_key is blank. 16410 Choose a number from below, or type in your own boolean value (true or false). 16411 Press Enter for the default (false). 16412 1 / Enter AWS credentials in the next step. 16413 \ (false) 16414 2 / Get AWS credentials from the environment (env vars or IAM). 16415 \ (true) 16416 env_auth></code></pre> 16417 <pre><code>AWS Access Key ID. 16418 Leave blank for anonymous access or runtime credentials. 16419 Enter a value. Press Enter to leave empty. 16420 access_key_id> XXX</code></pre> 16421 <pre><code>AWS Secret Access Key (password). 16422 Leave blank for anonymous access or runtime credentials. 16423 Enter a value. Press Enter to leave empty. 16424 secret_access_key> YYY</code></pre> 16425 <p>Leave region blank</p> 16426 <pre><code>Region to connect to. 16427 Leave blank if you are using an S3 clone and you don't have a region. 16428 Choose a number from below, or type in your own value. 16429 Press Enter to leave empty. 16430 / Use this if unsure. 16431 1 | Will use v4 signatures and an empty region. 16432 \ () 16433 / Use this only if v4 signatures don't work. 16434 2 | E.g. pre Jewel/v10 CEPH. 16435 \ (other-v2-signature) 16436 region></code></pre> 16437 <p>Choose an endpoint from the list</p> 16438 <pre><code>Endpoint for S3 API. 16439 Required when using an S3 clone. 16440 Choose a number from below, or type in your own value. 16441 Press Enter to leave empty. 16442 1 / Seagate Lyve Cloud US East 1 (Virginia) 16443 \ (s3.us-east-1.lyvecloud.seagate.com) 16444 2 / Seagate Lyve Cloud US West 1 (California) 16445 \ (s3.us-west-1.lyvecloud.seagate.com) 16446 3 / Seagate Lyve Cloud AP Southeast 1 (Singapore) 16447 \ (s3.ap-southeast-1.lyvecloud.seagate.com) 16448 endpoint> 1</code></pre> 16449 <p>Leave location constraint blank</p> 16450 <pre><code>Location constraint - must be set to match the Region. 16451 Leave blank if not sure. Used when creating buckets only. 16452 Enter a value. Press Enter to leave empty. 16453 location_constraint></code></pre> 16454 <p>Choose default ACL (<code>private</code>).</p> 16455 <pre><code>Canned ACL used when creating buckets and storing or copying objects. 16456 This ACL is used for creating objects and if bucket_acl isn't set, for creating buckets too. 16457 For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl 16458 Note that this ACL is applied when server-side copying objects as S3 16459 doesn't copy the ACL from the source but rather writes a fresh one. 16460 Choose a number from below, or type in your own value. 16461 Press Enter to leave empty. 16462 / Owner gets FULL_CONTROL. 16463 1 | No one else has access rights (default). 16464 \ (private) 16465 [snip] 16466 acl></code></pre> 16467 <p>And the config file should end up looking like this:</p> 16468 <pre><code>[remote] 16469 type = s3 16470 provider = LyveCloud 16471 access_key_id = XXX 16472 secret_access_key = YYY 16473 endpoint = s3.us-east-1.lyvecloud.seagate.com</code></pre> 16474 <h3 id="seaweedfs">SeaweedFS</h3> 16475 <p><a href="https://github.com/chrislusf/seaweedfs/">SeaweedFS</a> is a distributed storage system for blobs, objects, files, and data lake, with O(1) disk seek and a scalable file metadata store. It has an S3 compatible object storage interface. SeaweedFS can also act as a <a href="https://github.com/chrislusf/seaweedfs/wiki/Gateway-to-Remote-Object-Storage">gateway to remote S3 compatible object store</a> to cache data and metadata with asynchronous write back, for fast local speed and minimize access cost.</p> 16476 <p>Assuming the SeaweedFS are configured with <code>weed shell</code> as such:</p> 16477 <pre><code>> s3.bucket.create -name foo 16478 > s3.configure -access_key=any -secret_key=any -buckets=foo -user=me -actions=Read,Write,List,Tagging,Admin -apply 16479 { 16480 "identities": [ 16481 { 16482 "name": "me", 16483 "credentials": [ 16484 { 16485 "accessKey": "any", 16486 "secretKey": "any" 16487 } 16488 ], 16489 "actions": [ 16490 "Read:foo", 16491 "Write:foo", 16492 "List:foo", 16493 "Tagging:foo", 16494 "Admin:foo" 16495 ] 16496 } 16497 ] 16498 }</code></pre> 16499 <p>To use rclone with SeaweedFS, above configuration should end up with something like this in your config:</p> 16500 <pre><code>[seaweedfs_s3] 16501 type = s3 16502 provider = SeaweedFS 16503 access_key_id = any 16504 secret_access_key = any 16505 endpoint = localhost:8333</code></pre> 16506 <p>So once set up, for example to copy files into a bucket</p> 16507 <pre><code>rclone copy /path/to/files seaweedfs_s3:foo</code></pre> 16508 <h3 id="wasabi">Wasabi</h3> 16509 <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> 16510 <p>Wasabi provides an S3 interface which can be configured for use with rclone like this.</p> 16511 <pre><code>No remotes found, make a new one? 16512 n) New remote 16513 s) Set configuration password 16514 n/s> n 16515 name> wasabi 16516 Type of storage to configure. 16517 Choose a number from below, or type in your own value 16518 [snip] 16519 XX / Amazon S3 (also Dreamhost, Ceph, ChinaMobile, ArvanCloud, Minio, Liara) 16520 \ "s3" 16521 [snip] 16522 Storage> s3 16523 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. 16524 Choose a number from below, or type in your own value 16525 1 / Enter AWS credentials in the next step 16526 \ "false" 16527 2 / Get AWS credentials from the environment (env vars or IAM) 16528 \ "true" 16529 env_auth> 1 16530 AWS Access Key ID - leave blank for anonymous access or runtime credentials. 16531 access_key_id> YOURACCESSKEY 16532 AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials. 16533 secret_access_key> YOURSECRETACCESSKEY 16534 Region to connect to. 16535 Choose a number from below, or type in your own value 16536 / The default endpoint - a good choice if you are unsure. 16537 1 | US Region, Northern Virginia, or Pacific Northwest. 16538 | Leave location constraint empty. 16539 \ "us-east-1" 16540 [snip] 16541 region> us-east-1 16542 Endpoint for S3 API. 16543 Leave blank if using AWS to use the default endpoint for the region. 16544 Specify if using an S3 clone such as Ceph. 16545 endpoint> s3.wasabisys.com 16546 Location constraint - must be set to match the Region. Used when creating buckets only. 16547 Choose a number from below, or type in your own value 16548 1 / Empty for US Region, Northern Virginia, or Pacific Northwest. 16549 \ "" 16550 [snip] 16551 location_constraint> 16552 Canned ACL used when creating buckets and/or storing objects in S3. 16553 For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl 16554 Choose a number from below, or type in your own value 16555 1 / Owner gets FULL_CONTROL. No one else has access rights (default). 16556 \ "private" 16557 [snip] 16558 acl> 16559 The server-side encryption algorithm used when storing this object in S3. 16560 Choose a number from below, or type in your own value 16561 1 / None 16562 \ "" 16563 2 / AES256 16564 \ "AES256" 16565 server_side_encryption> 16566 The storage class to use when storing objects in S3. 16567 Choose a number from below, or type in your own value 16568 1 / Default 16569 \ "" 16570 2 / Standard storage class 16571 \ "STANDARD" 16572 3 / Reduced redundancy storage class 16573 \ "REDUCED_REDUNDANCY" 16574 4 / Standard Infrequent Access storage class 16575 \ "STANDARD_IA" 16576 storage_class> 16577 Remote config 16578 -------------------- 16579 [wasabi] 16580 env_auth = false 16581 access_key_id = YOURACCESSKEY 16582 secret_access_key = YOURSECRETACCESSKEY 16583 region = us-east-1 16584 endpoint = s3.wasabisys.com 16585 location_constraint = 16586 acl = 16587 server_side_encryption = 16588 storage_class = 16589 -------------------- 16590 y) Yes this is OK 16591 e) Edit this remote 16592 d) Delete this remote 16593 y/e/d> y</code></pre> 16594 <p>This will leave the config file looking like this.</p> 16595 <pre><code>[wasabi] 16596 type = s3 16597 provider = Wasabi 16598 env_auth = false 16599 access_key_id = YOURACCESSKEY 16600 secret_access_key = YOURSECRETACCESSKEY 16601 region = 16602 endpoint = s3.wasabisys.com 16603 location_constraint = 16604 acl = 16605 server_side_encryption = 16606 storage_class =</code></pre> 16607 <h3 id="alibaba-oss">Alibaba OSS</h3> 16608 <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> 16609 <pre><code>rclone config</code></pre> 16610 <p>This will guide you through an interactive setup process.</p> 16611 <pre><code>No remotes found, make a new one? 16612 n) New remote 16613 s) Set configuration password 16614 q) Quit config 16615 n/s/q> n 16616 name> oss 16617 Type of storage to configure. 16618 Enter a string value. Press Enter for the default (""). 16619 Choose a number from below, or type in your own value 16620 [snip] 16621 XX / Amazon S3 Compliant Storage Providers including AWS, ... 16622 \ "s3" 16623 [snip] 16624 Storage> s3 16625 Choose your S3 provider. 16626 Enter a string value. Press Enter for the default (""). 16627 Choose a number from below, or type in your own value 16628 1 / Amazon Web Services (AWS) S3 16629 \ "AWS" 16630 2 / Alibaba Cloud Object Storage System (OSS) formerly Aliyun 16631 \ "Alibaba" 16632 3 / Ceph Object Storage 16633 \ "Ceph" 16634 [snip] 16635 provider> Alibaba 16636 Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). 16637 Only applies if access_key_id and secret_access_key is blank. 16638 Enter a boolean value (true or false). Press Enter for the default ("false"). 16639 Choose a number from below, or type in your own value 16640 1 / Enter AWS credentials in the next step 16641 \ "false" 16642 2 / Get AWS credentials from the environment (env vars or IAM) 16643 \ "true" 16644 env_auth> 1 16645 AWS Access Key ID. 16646 Leave blank for anonymous access or runtime credentials. 16647 Enter a string value. Press Enter for the default (""). 16648 access_key_id> accesskeyid 16649 AWS Secret Access Key (password) 16650 Leave blank for anonymous access or runtime credentials. 16651 Enter a string value. Press Enter for the default (""). 16652 secret_access_key> secretaccesskey 16653 Endpoint for OSS API. 16654 Enter a string value. Press Enter for the default (""). 16655 Choose a number from below, or type in your own value 16656 1 / East China 1 (Hangzhou) 16657 \ "oss-cn-hangzhou.aliyuncs.com" 16658 2 / East China 2 (Shanghai) 16659 \ "oss-cn-shanghai.aliyuncs.com" 16660 3 / North China 1 (Qingdao) 16661 \ "oss-cn-qingdao.aliyuncs.com" 16662 [snip] 16663 endpoint> 1 16664 Canned ACL used when creating buckets and storing or copying objects. 16665 16666 Note that this ACL is applied when server-side copying objects as S3 16667 doesn't copy the ACL from the source but rather writes a fresh one. 16668 Enter a string value. Press Enter for the default (""). 16669 Choose a number from below, or type in your own value 16670 1 / Owner gets FULL_CONTROL. No one else has access rights (default). 16671 \ "private" 16672 2 / Owner gets FULL_CONTROL. The AllUsers group gets READ access. 16673 \ "public-read" 16674 / Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. 16675 [snip] 16676 acl> 1 16677 The storage class to use when storing new objects in OSS. 16678 Enter a string value. Press Enter for the default (""). 16679 Choose a number from below, or type in your own value 16680 1 / Default 16681 \ "" 16682 2 / Standard storage class 16683 \ "STANDARD" 16684 3 / Archive storage mode. 16685 \ "GLACIER" 16686 4 / Infrequent access storage mode. 16687 \ "STANDARD_IA" 16688 storage_class> 1 16689 Edit advanced config? (y/n) 16690 y) Yes 16691 n) No 16692 y/n> n 16693 Remote config 16694 -------------------- 16695 [oss] 16696 type = s3 16697 provider = Alibaba 16698 env_auth = false 16699 access_key_id = accesskeyid 16700 secret_access_key = secretaccesskey 16701 endpoint = oss-cn-hangzhou.aliyuncs.com 16702 acl = private 16703 storage_class = Standard 16704 -------------------- 16705 y) Yes this is OK 16706 e) Edit this remote 16707 d) Delete this remote 16708 y/e/d> y</code></pre> 16709 <h3 id="china-mobile-ecloud-eos">China Mobile Ecloud Elastic Object Storage (EOS)</h3> 16710 <p>Here is an example of making an <a href="https:///ecloud.10086.cn/home/product-introduction/eos/">China Mobile Ecloud Elastic Object Storage (EOS)</a> configuration. First run:</p> 16711 <pre><code>rclone config</code></pre> 16712 <p>This will guide you through an interactive setup process.</p> 16713 <pre><code>No remotes found, make a new one? 16714 n) New remote 16715 s) Set configuration password 16716 q) Quit config 16717 n/s/q> n 16718 name> ChinaMobile 16719 Option Storage. 16720 Type of storage to configure. 16721 Choose a number from below, or type in your own value. 16722 ... 16723 XX / Amazon S3 Compliant Storage Providers including AWS, ... 16724 \ (s3) 16725 ... 16726 Storage> s3 16727 Option provider. 16728 Choose your S3 provider. 16729 Choose a number from below, or type in your own value. 16730 Press Enter to leave empty. 16731 ... 16732 4 / China Mobile Ecloud Elastic Object Storage (EOS) 16733 \ (ChinaMobile) 16734 ... 16735 provider> ChinaMobile 16736 Option env_auth. 16737 Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). 16738 Only applies if access_key_id and secret_access_key is blank. 16739 Choose a number from below, or type in your own boolean value (true or false). 16740 Press Enter for the default (false). 16741 1 / Enter AWS credentials in the next step. 16742 \ (false) 16743 2 / Get AWS credentials from the environment (env vars or IAM). 16744 \ (true) 16745 env_auth> 16746 Option access_key_id. 16747 AWS Access Key ID. 16748 Leave blank for anonymous access or runtime credentials. 16749 Enter a value. Press Enter to leave empty. 16750 access_key_id> accesskeyid 16751 Option secret_access_key. 16752 AWS Secret Access Key (password). 16753 Leave blank for anonymous access or runtime credentials. 16754 Enter a value. Press Enter to leave empty. 16755 secret_access_key> secretaccesskey 16756 Option endpoint. 16757 Endpoint for China Mobile Ecloud Elastic Object Storage (EOS) API. 16758 Choose a number from below, or type in your own value. 16759 Press Enter to leave empty. 16760 / The default endpoint - a good choice if you are unsure. 16761 1 | East China (Suzhou) 16762 \ (eos-wuxi-1.cmecloud.cn) 16763 2 / East China (Jinan) 16764 \ (eos-jinan-1.cmecloud.cn) 16765 3 / East China (Hangzhou) 16766 \ (eos-ningbo-1.cmecloud.cn) 16767 4 / East China (Shanghai-1) 16768 \ (eos-shanghai-1.cmecloud.cn) 16769 5 / Central China (Zhengzhou) 16770 \ (eos-zhengzhou-1.cmecloud.cn) 16771 6 / Central China (Changsha-1) 16772 \ (eos-hunan-1.cmecloud.cn) 16773 7 / Central China (Changsha-2) 16774 \ (eos-zhuzhou-1.cmecloud.cn) 16775 8 / South China (Guangzhou-2) 16776 \ (eos-guangzhou-1.cmecloud.cn) 16777 9 / South China (Guangzhou-3) 16778 \ (eos-dongguan-1.cmecloud.cn) 16779 10 / North China (Beijing-1) 16780 \ (eos-beijing-1.cmecloud.cn) 16781 11 / North China (Beijing-2) 16782 \ (eos-beijing-2.cmecloud.cn) 16783 12 / North China (Beijing-3) 16784 \ (eos-beijing-4.cmecloud.cn) 16785 13 / North China (Huhehaote) 16786 \ (eos-huhehaote-1.cmecloud.cn) 16787 14 / Southwest China (Chengdu) 16788 \ (eos-chengdu-1.cmecloud.cn) 16789 15 / Southwest China (Chongqing) 16790 \ (eos-chongqing-1.cmecloud.cn) 16791 16 / Southwest China (Guiyang) 16792 \ (eos-guiyang-1.cmecloud.cn) 16793 17 / Nouthwest China (Xian) 16794 \ (eos-xian-1.cmecloud.cn) 16795 18 / Yunnan China (Kunming) 16796 \ (eos-yunnan.cmecloud.cn) 16797 19 / Yunnan China (Kunming-2) 16798 \ (eos-yunnan-2.cmecloud.cn) 16799 20 / Tianjin China (Tianjin) 16800 \ (eos-tianjin-1.cmecloud.cn) 16801 21 / Jilin China (Changchun) 16802 \ (eos-jilin-1.cmecloud.cn) 16803 22 / Hubei China (Xiangyan) 16804 \ (eos-hubei-1.cmecloud.cn) 16805 23 / Jiangxi China (Nanchang) 16806 \ (eos-jiangxi-1.cmecloud.cn) 16807 24 / Gansu China (Lanzhou) 16808 \ (eos-gansu-1.cmecloud.cn) 16809 25 / Shanxi China (Taiyuan) 16810 \ (eos-shanxi-1.cmecloud.cn) 16811 26 / Liaoning China (Shenyang) 16812 \ (eos-liaoning-1.cmecloud.cn) 16813 27 / Hebei China (Shijiazhuang) 16814 \ (eos-hebei-1.cmecloud.cn) 16815 28 / Fujian China (Xiamen) 16816 \ (eos-fujian-1.cmecloud.cn) 16817 29 / Guangxi China (Nanning) 16818 \ (eos-guangxi-1.cmecloud.cn) 16819 30 / Anhui China (Huainan) 16820 \ (eos-anhui-1.cmecloud.cn) 16821 endpoint> 1 16822 Option location_constraint. 16823 Location constraint - must match endpoint. 16824 Used when creating buckets only. 16825 Choose a number from below, or type in your own value. 16826 Press Enter to leave empty. 16827 1 / East China (Suzhou) 16828 \ (wuxi1) 16829 2 / East China (Jinan) 16830 \ (jinan1) 16831 3 / East China (Hangzhou) 16832 \ (ningbo1) 16833 4 / East China (Shanghai-1) 16834 \ (shanghai1) 16835 5 / Central China (Zhengzhou) 16836 \ (zhengzhou1) 16837 6 / Central China (Changsha-1) 16838 \ (hunan1) 16839 7 / Central China (Changsha-2) 16840 \ (zhuzhou1) 16841 8 / South China (Guangzhou-2) 16842 \ (guangzhou1) 16843 9 / South China (Guangzhou-3) 16844 \ (dongguan1) 16845 10 / North China (Beijing-1) 16846 \ (beijing1) 16847 11 / North China (Beijing-2) 16848 \ (beijing2) 16849 12 / North China (Beijing-3) 16850 \ (beijing4) 16851 13 / North China (Huhehaote) 16852 \ (huhehaote1) 16853 14 / Southwest China (Chengdu) 16854 \ (chengdu1) 16855 15 / Southwest China (Chongqing) 16856 \ (chongqing1) 16857 16 / Southwest China (Guiyang) 16858 \ (guiyang1) 16859 17 / Nouthwest China (Xian) 16860 \ (xian1) 16861 18 / Yunnan China (Kunming) 16862 \ (yunnan) 16863 19 / Yunnan China (Kunming-2) 16864 \ (yunnan2) 16865 20 / Tianjin China (Tianjin) 16866 \ (tianjin1) 16867 21 / Jilin China (Changchun) 16868 \ (jilin1) 16869 22 / Hubei China (Xiangyan) 16870 \ (hubei1) 16871 23 / Jiangxi China (Nanchang) 16872 \ (jiangxi1) 16873 24 / Gansu China (Lanzhou) 16874 \ (gansu1) 16875 25 / Shanxi China (Taiyuan) 16876 \ (shanxi1) 16877 26 / Liaoning China (Shenyang) 16878 \ (liaoning1) 16879 27 / Hebei China (Shijiazhuang) 16880 \ (hebei1) 16881 28 / Fujian China (Xiamen) 16882 \ (fujian1) 16883 29 / Guangxi China (Nanning) 16884 \ (guangxi1) 16885 30 / Anhui China (Huainan) 16886 \ (anhui1) 16887 location_constraint> 1 16888 Option acl. 16889 Canned ACL used when creating buckets and storing or copying objects. 16890 This ACL is used for creating objects and if bucket_acl isn't set, for creating buckets too. 16891 For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl 16892 Note that this ACL is applied when server-side copying objects as S3 16893 doesn't copy the ACL from the source but rather writes a fresh one. 16894 Choose a number from below, or type in your own value. 16895 Press Enter to leave empty. 16896 / Owner gets FULL_CONTROL. 16897 1 | No one else has access rights (default). 16898 \ (private) 16899 / Owner gets FULL_CONTROL. 16900 2 | The AllUsers group gets READ access. 16901 \ (public-read) 16902 / Owner gets FULL_CONTROL. 16903 3 | The AllUsers group gets READ and WRITE access. 16904 | Granting this on a bucket is generally not recommended. 16905 \ (public-read-write) 16906 / Owner gets FULL_CONTROL. 16907 4 | The AuthenticatedUsers group gets READ access. 16908 \ (authenticated-read) 16909 / Object owner gets FULL_CONTROL. 16910 acl> private 16911 Option server_side_encryption. 16912 The server-side encryption algorithm used when storing this object in S3. 16913 Choose a number from below, or type in your own value. 16914 Press Enter to leave empty. 16915 1 / None 16916 \ () 16917 2 / AES256 16918 \ (AES256) 16919 server_side_encryption> 16920 Option storage_class. 16921 The storage class to use when storing new objects in ChinaMobile. 16922 Choose a number from below, or type in your own value. 16923 Press Enter to leave empty. 16924 1 / Default 16925 \ () 16926 2 / Standard storage class 16927 \ (STANDARD) 16928 3 / Archive storage mode 16929 \ (GLACIER) 16930 4 / Infrequent access storage mode 16931 \ (STANDARD_IA) 16932 storage_class> 16933 Edit advanced config? 16934 y) Yes 16935 n) No (default) 16936 y/n> n 16937 -------------------- 16938 [ChinaMobile] 16939 type = s3 16940 provider = ChinaMobile 16941 access_key_id = accesskeyid 16942 secret_access_key = secretaccesskey 16943 endpoint = eos-wuxi-1.cmecloud.cn 16944 location_constraint = wuxi1 16945 acl = private 16946 -------------------- 16947 y) Yes this is OK (default) 16948 e) Edit this remote 16949 d) Delete this remote 16950 y/e/d> y</code></pre> 16951 <h3 id="leviia">Leviia Cloud Object Storage</h3> 16952 <p><a href="https://www.leviia.com/object-storage/">Leviia Object Storage</a>, backup and secure your data in a 100% French cloud, independent of GAFAM..</p> 16953 <p>To configure access to Leviia, follow the steps below:</p> 16954 <ol type="1"> 16955 <li>Run <code>rclone config</code> and select <code>n</code> for a new remote.</li> 16956 </ol> 16957 <pre><code>rclone config 16958 No remotes found, make a new one? 16959 n) New remote 16960 s) Set configuration password 16961 q) Quit config 16962 n/s/q> n</code></pre> 16963 <ol start="2" type="1"> 16964 <li>Give the name of the configuration. For example, name it 'leviia'.</li> 16965 </ol> 16966 <pre><code>name> leviia</code></pre> 16967 <ol start="3" type="1"> 16968 <li>Select <code>s3</code> storage.</li> 16969 </ol> 16970 <pre><code>Choose a number from below, or type in your own value 16971 [snip] 16972 XX / Amazon S3 Compliant Storage Providers including AWS, ... 16973 \ (s3) 16974 [snip] 16975 Storage> s3</code></pre> 16976 <ol start="4" type="1"> 16977 <li>Select <code>Leviia</code> provider.</li> 16978 </ol> 16979 <pre><code>Choose a number from below, or type in your own value 16980 1 / Amazon Web Services (AWS) S3 16981 \ "AWS" 16982 [snip] 16983 15 / Leviia Object Storage 16984 \ (Leviia) 16985 [snip] 16986 provider> Leviia</code></pre> 16987 <ol start="5" type="1"> 16988 <li>Enter your SecretId and SecretKey of Leviia.</li> 16989 </ol> 16990 <pre><code>Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). 16991 Only applies if access_key_id and secret_access_key is blank. 16992 Enter a boolean value (true or false). Press Enter for the default ("false"). 16993 Choose a number from below, or type in your own value 16994 1 / Enter AWS credentials in the next step 16995 \ "false" 16996 2 / Get AWS credentials from the environment (env vars or IAM) 16997 \ "true" 16998 env_auth> 1 16999 AWS Access Key ID. 17000 Leave blank for anonymous access or runtime credentials. 17001 Enter a string value. Press Enter for the default (""). 17002 access_key_id> ZnIx.xxxxxxxxxxxxxxx 17003 AWS Secret Access Key (password) 17004 Leave blank for anonymous access or runtime credentials. 17005 Enter a string value. Press Enter for the default (""). 17006 secret_access_key> xxxxxxxxxxx</code></pre> 17007 <ol start="6" type="1"> 17008 <li>Select endpoint for Leviia.</li> 17009 </ol> 17010 <pre><code> / The default endpoint 17011 1 | Leviia. 17012 \ (s3.leviia.com) 17013 [snip] 17014 endpoint> 1</code></pre> 17015 <ol start="7" type="1"> 17016 <li>Choose acl.</li> 17017 </ol> 17018 <pre><code>Note that this ACL is applied when server-side copying objects as S3 17019 doesn't copy the ACL from the source but rather writes a fresh one. 17020 Enter a string value. Press Enter for the default (""). 17021 Choose a number from below, or type in your own value 17022 / Owner gets FULL_CONTROL. 17023 1 | No one else has access rights (default). 17024 \ (private) 17025 / Owner gets FULL_CONTROL. 17026 2 | The AllUsers group gets READ access. 17027 \ (public-read) 17028 [snip] 17029 acl> 1 17030 Edit advanced config? (y/n) 17031 y) Yes 17032 n) No (default) 17033 y/n> n 17034 Remote config 17035 -------------------- 17036 [leviia] 17037 - type: s3 17038 - provider: Leviia 17039 - access_key_id: ZnIx.xxxxxxx 17040 - secret_access_key: xxxxxxxx 17041 - endpoint: s3.leviia.com 17042 - acl: private 17043 -------------------- 17044 y) Yes this is OK (default) 17045 e) Edit this remote 17046 d) Delete this remote 17047 y/e/d> y 17048 Current remotes: 17049 17050 Name Type 17051 ==== ==== 17052 leviia s3</code></pre> 17053 <h3 id="liara-cloud">Liara</h3> 17054 <p>Here is an example of making a <a href="https://liara.ir/landing/object-storage">Liara Object Storage</a> configuration. First run:</p> 17055 <pre><code>rclone config</code></pre> 17056 <p>This will guide you through an interactive setup process.</p> 17057 <pre><code>No remotes found, make a new one? 17058 n) New remote 17059 s) Set configuration password 17060 n/s> n 17061 name> Liara 17062 Type of storage to configure. 17063 Choose a number from below, or type in your own value 17064 [snip] 17065 XX / Amazon S3 (also Dreamhost, Ceph, ChinaMobile, ArvanCloud, Liara, Minio) 17066 \ "s3" 17067 [snip] 17068 Storage> s3 17069 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. 17070 Choose a number from below, or type in your own value 17071 1 / Enter AWS credentials in the next step 17072 \ "false" 17073 2 / Get AWS credentials from the environment (env vars or IAM) 17074 \ "true" 17075 env_auth> 1 17076 AWS Access Key ID - leave blank for anonymous access or runtime credentials. 17077 access_key_id> YOURACCESSKEY 17078 AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials. 17079 secret_access_key> YOURSECRETACCESSKEY 17080 Region to connect to. 17081 Choose a number from below, or type in your own value 17082 / The default endpoint 17083 1 | US Region, Northern Virginia, or Pacific Northwest. 17084 | Leave location constraint empty. 17085 \ "us-east-1" 17086 [snip] 17087 region> 17088 Endpoint for S3 API. 17089 Leave blank if using Liara to use the default endpoint for the region. 17090 Specify if using an S3 clone such as Ceph. 17091 endpoint> storage.iran.liara.space 17092 Canned ACL used when creating buckets and/or storing objects in S3. 17093 For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl 17094 Choose a number from below, or type in your own value 17095 1 / Owner gets FULL_CONTROL. No one else has access rights (default). 17096 \ "private" 17097 [snip] 17098 acl> 17099 The server-side encryption algorithm used when storing this object in S3. 17100 Choose a number from below, or type in your own value 17101 1 / None 17102 \ "" 17103 2 / AES256 17104 \ "AES256" 17105 server_side_encryption> 17106 The storage class to use when storing objects in S3. 17107 Choose a number from below, or type in your own value 17108 1 / Default 17109 \ "" 17110 2 / Standard storage class 17111 \ "STANDARD" 17112 storage_class> 17113 Remote config 17114 -------------------- 17115 [Liara] 17116 env_auth = false 17117 access_key_id = YOURACCESSKEY 17118 secret_access_key = YOURSECRETACCESSKEY 17119 endpoint = storage.iran.liara.space 17120 location_constraint = 17121 acl = 17122 server_side_encryption = 17123 storage_class = 17124 -------------------- 17125 y) Yes this is OK 17126 e) Edit this remote 17127 d) Delete this remote 17128 y/e/d> y</code></pre> 17129 <p>This will leave the config file looking like this.</p> 17130 <pre><code>[Liara] 17131 type = s3 17132 provider = Liara 17133 env_auth = false 17134 access_key_id = YOURACCESSKEY 17135 secret_access_key = YOURSECRETACCESSKEY 17136 region = 17137 endpoint = storage.iran.liara.space 17138 location_constraint = 17139 acl = 17140 server_side_encryption = 17141 storage_class =</code></pre> 17142 <h3 id="linode">Linode</h3> 17143 <p>Here is an example of making a <a href="https://www.linode.com/products/object-storage/">Linode Object Storage</a> configuration. First run:</p> 17144 <pre><code>rclone config</code></pre> 17145 <p>This will guide you through an interactive setup process.</p> 17146 <pre><code>No remotes found, make a new one? 17147 n) New remote 17148 s) Set configuration password 17149 q) Quit config 17150 n/s/q> n 17151 17152 Enter name for new remote. 17153 name> linode 17154 17155 Option Storage. 17156 Type of storage to configure. 17157 Choose a number from below, or type in your own value. 17158 [snip] 17159 XX / Amazon S3 Compliant Storage Providers including AWS, ...Linode, ...and others 17160 \ (s3) 17161 [snip] 17162 Storage> s3 17163 17164 Option provider. 17165 Choose your S3 provider. 17166 Choose a number from below, or type in your own value. 17167 Press Enter to leave empty. 17168 [snip] 17169 XX / Linode Object Storage 17170 \ (Linode) 17171 [snip] 17172 provider> Linode 17173 17174 Option env_auth. 17175 Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). 17176 Only applies if access_key_id and secret_access_key is blank. 17177 Choose a number from below, or type in your own boolean value (true or false). 17178 Press Enter for the default (false). 17179 1 / Enter AWS credentials in the next step. 17180 \ (false) 17181 2 / Get AWS credentials from the environment (env vars or IAM). 17182 \ (true) 17183 env_auth> 17184 17185 Option access_key_id. 17186 AWS Access Key ID. 17187 Leave blank for anonymous access or runtime credentials. 17188 Enter a value. Press Enter to leave empty. 17189 access_key_id> ACCESS_KEY 17190 17191 Option secret_access_key. 17192 AWS Secret Access Key (password). 17193 Leave blank for anonymous access or runtime credentials. 17194 Enter a value. Press Enter to leave empty. 17195 secret_access_key> SECRET_ACCESS_KEY 17196 17197 Option endpoint. 17198 Endpoint for Linode Object Storage API. 17199 Choose a number from below, or type in your own value. 17200 Press Enter to leave empty. 17201 1 / Atlanta, GA (USA), us-southeast-1 17202 \ (us-southeast-1.linodeobjects.com) 17203 2 / Chicago, IL (USA), us-ord-1 17204 \ (us-ord-1.linodeobjects.com) 17205 3 / Frankfurt (Germany), eu-central-1 17206 \ (eu-central-1.linodeobjects.com) 17207 4 / Milan (Italy), it-mil-1 17208 \ (it-mil-1.linodeobjects.com) 17209 5 / Newark, NJ (USA), us-east-1 17210 \ (us-east-1.linodeobjects.com) 17211 6 / Paris (France), fr-par-1 17212 \ (fr-par-1.linodeobjects.com) 17213 7 / Seattle, WA (USA), us-sea-1 17214 \ (us-sea-1.linodeobjects.com) 17215 8 / Singapore ap-south-1 17216 \ (ap-south-1.linodeobjects.com) 17217 9 / Stockholm (Sweden), se-sto-1 17218 \ (se-sto-1.linodeobjects.com) 17219 10 / Washington, DC, (USA), us-iad-1 17220 \ (us-iad-1.linodeobjects.com) 17221 endpoint> 3 17222 17223 Option acl. 17224 Canned ACL used when creating buckets and storing or copying objects. 17225 This ACL is used for creating objects and if bucket_acl isn't set, for creating buckets too. 17226 For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl 17227 Note that this ACL is applied when server-side copying objects as S3 17228 doesn't copy the ACL from the source but rather writes a fresh one. 17229 If the acl is an empty string then no X-Amz-Acl: header is added and 17230 the default (private) will be used. 17231 Choose a number from below, or type in your own value. 17232 Press Enter to leave empty. 17233 / Owner gets FULL_CONTROL. 17234 1 | No one else has access rights (default). 17235 \ (private) 17236 [snip] 17237 acl> 17238 17239 Edit advanced config? 17240 y) Yes 17241 n) No (default) 17242 y/n> n 17243 17244 Configuration complete. 17245 Options: 17246 - type: s3 17247 - provider: Linode 17248 - access_key_id: ACCESS_KEY 17249 - secret_access_key: SECRET_ACCESS_KEY 17250 - endpoint: eu-central-1.linodeobjects.com 17251 Keep this "linode" remote? 17252 y) Yes this is OK (default) 17253 e) Edit this remote 17254 d) Delete this remote 17255 y/e/d> y</code></pre> 17256 <p>This will leave the config file looking like this.</p> 17257 <pre><code>[linode] 17258 type = s3 17259 provider = Linode 17260 access_key_id = ACCESS_KEY 17261 secret_access_key = SECRET_ACCESS_KEY 17262 endpoint = eu-central-1.linodeobjects.com</code></pre> 17263 <h3 id="arvan-cloud">ArvanCloud</h3> 17264 <p><a href="https://www.arvancloud.com/en/products/cloud-storage">ArvanCloud</a> ArvanCloud Object Storage goes beyond the limited traditional file storage. It gives you access to backup and archived files and allows sharing. Files like profile image in the app, images sent by users or scanned documents can be stored securely and easily in our Object Storage service.</p> 17265 <p>ArvanCloud provides an S3 interface which can be configured for use with rclone like this.</p> 17266 <pre><code>No remotes found, make a new one? 17267 n) New remote 17268 s) Set configuration password 17269 n/s> n 17270 name> ArvanCloud 17271 Type of storage to configure. 17272 Choose a number from below, or type in your own value 17273 [snip] 17274 XX / Amazon S3 (also Dreamhost, Ceph, ChinaMobile, ArvanCloud, Liara, Minio) 17275 \ "s3" 17276 [snip] 17277 Storage> s3 17278 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. 17279 Choose a number from below, or type in your own value 17280 1 / Enter AWS credentials in the next step 17281 \ "false" 17282 2 / Get AWS credentials from the environment (env vars or IAM) 17283 \ "true" 17284 env_auth> 1 17285 AWS Access Key ID - leave blank for anonymous access or runtime credentials. 17286 access_key_id> YOURACCESSKEY 17287 AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials. 17288 secret_access_key> YOURSECRETACCESSKEY 17289 Region to connect to. 17290 Choose a number from below, or type in your own value 17291 / The default endpoint - a good choice if you are unsure. 17292 1 | US Region, Northern Virginia, or Pacific Northwest. 17293 | Leave location constraint empty. 17294 \ "us-east-1" 17295 [snip] 17296 region> 17297 Endpoint for S3 API. 17298 Leave blank if using ArvanCloud to use the default endpoint for the region. 17299 Specify if using an S3 clone such as Ceph. 17300 endpoint> s3.arvanstorage.com 17301 Location constraint - must be set to match the Region. Used when creating buckets only. 17302 Choose a number from below, or type in your own value 17303 1 / Empty for Iran-Tehran Region. 17304 \ "" 17305 [snip] 17306 location_constraint> 17307 Canned ACL used when creating buckets and/or storing objects in S3. 17308 For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl 17309 Choose a number from below, or type in your own value 17310 1 / Owner gets FULL_CONTROL. No one else has access rights (default). 17311 \ "private" 17312 [snip] 17313 acl> 17314 The server-side encryption algorithm used when storing this object in S3. 17315 Choose a number from below, or type in your own value 17316 1 / None 17317 \ "" 17318 2 / AES256 17319 \ "AES256" 17320 server_side_encryption> 17321 The storage class to use when storing objects in S3. 17322 Choose a number from below, or type in your own value 17323 1 / Default 17324 \ "" 17325 2 / Standard storage class 17326 \ "STANDARD" 17327 storage_class> 17328 Remote config 17329 -------------------- 17330 [ArvanCloud] 17331 env_auth = false 17332 access_key_id = YOURACCESSKEY 17333 secret_access_key = YOURSECRETACCESSKEY 17334 region = ir-thr-at1 17335 endpoint = s3.arvanstorage.com 17336 location_constraint = 17337 acl = 17338 server_side_encryption = 17339 storage_class = 17340 -------------------- 17341 y) Yes this is OK 17342 e) Edit this remote 17343 d) Delete this remote 17344 y/e/d> y</code></pre> 17345 <p>This will leave the config file looking like this.</p> 17346 <pre><code>[ArvanCloud] 17347 type = s3 17348 provider = ArvanCloud 17349 env_auth = false 17350 access_key_id = YOURACCESSKEY 17351 secret_access_key = YOURSECRETACCESSKEY 17352 region = 17353 endpoint = s3.arvanstorage.com 17354 location_constraint = 17355 acl = 17356 server_side_encryption = 17357 storage_class =</code></pre> 17358 <h3 id="tencent-cos">Tencent COS</h3> 17359 <p><a href="https://intl.cloud.tencent.com/product/cos">Tencent Cloud Object Storage (COS)</a> is a distributed storage service offered by Tencent Cloud for unstructured data. It is secure, stable, massive, convenient, low-delay and low-cost.</p> 17360 <p>To configure access to Tencent COS, follow the steps below:</p> 17361 <ol type="1"> 17362 <li>Run <code>rclone config</code> and select <code>n</code> for a new remote.</li> 17363 </ol> 17364 <pre><code>rclone config 17365 No remotes found, make a new one? 17366 n) New remote 17367 s) Set configuration password 17368 q) Quit config 17369 n/s/q> n</code></pre> 17370 <ol start="2" type="1"> 17371 <li>Give the name of the configuration. For example, name it 'cos'.</li> 17372 </ol> 17373 <pre><code>name> cos</code></pre> 17374 <ol start="3" type="1"> 17375 <li>Select <code>s3</code> storage.</li> 17376 </ol> 17377 <pre><code>Choose a number from below, or type in your own value 17378 [snip] 17379 XX / Amazon S3 Compliant Storage Providers including AWS, ... 17380 \ "s3" 17381 [snip] 17382 Storage> s3</code></pre> 17383 <ol start="4" type="1"> 17384 <li>Select <code>TencentCOS</code> provider.</li> 17385 </ol> 17386 <pre><code>Choose a number from below, or type in your own value 17387 1 / Amazon Web Services (AWS) S3 17388 \ "AWS" 17389 [snip] 17390 11 / Tencent Cloud Object Storage (COS) 17391 \ "TencentCOS" 17392 [snip] 17393 provider> TencentCOS</code></pre> 17394 <ol start="5" type="1"> 17395 <li>Enter your SecretId and SecretKey of Tencent Cloud.</li> 17396 </ol> 17397 <pre><code>Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). 17398 Only applies if access_key_id and secret_access_key is blank. 17399 Enter a boolean value (true or false). Press Enter for the default ("false"). 17400 Choose a number from below, or type in your own value 17401 1 / Enter AWS credentials in the next step 17402 \ "false" 17403 2 / Get AWS credentials from the environment (env vars or IAM) 17404 \ "true" 17405 env_auth> 1 17406 AWS Access Key ID. 17407 Leave blank for anonymous access or runtime credentials. 17408 Enter a string value. Press Enter for the default (""). 17409 access_key_id> AKIDxxxxxxxxxx 17410 AWS Secret Access Key (password) 17411 Leave blank for anonymous access or runtime credentials. 17412 Enter a string value. Press Enter for the default (""). 17413 secret_access_key> xxxxxxxxxxx</code></pre> 17414 <ol start="6" type="1"> 17415 <li>Select endpoint for Tencent COS. This is the standard endpoint for different region.</li> 17416 </ol> 17417 <pre><code> 1 / Beijing Region. 17418 \ "cos.ap-beijing.myqcloud.com" 17419 2 / Nanjing Region. 17420 \ "cos.ap-nanjing.myqcloud.com" 17421 3 / Shanghai Region. 17422 \ "cos.ap-shanghai.myqcloud.com" 17423 4 / Guangzhou Region. 17424 \ "cos.ap-guangzhou.myqcloud.com" 17425 [snip] 17426 endpoint> 4</code></pre> 17427 <ol start="7" type="1"> 17428 <li>Choose acl and storage class.</li> 17429 </ol> 17430 <pre><code>Note that this ACL is applied when server-side copying objects as S3 17431 doesn't copy the ACL from the source but rather writes a fresh one. 17432 Enter a string value. Press Enter for the default (""). 17433 Choose a number from below, or type in your own value 17434 1 / Owner gets Full_CONTROL. No one else has access rights (default). 17435 \ "default" 17436 [snip] 17437 acl> 1 17438 The storage class to use when storing new objects in Tencent COS. 17439 Enter a string value. Press Enter for the default (""). 17440 Choose a number from below, or type in your own value 17441 1 / Default 17442 \ "" 17443 [snip] 17444 storage_class> 1 17445 Edit advanced config? (y/n) 17446 y) Yes 17447 n) No (default) 17448 y/n> n 17449 Remote config 17450 -------------------- 17451 [cos] 17452 type = s3 17453 provider = TencentCOS 17454 env_auth = false 17455 access_key_id = xxx 17456 secret_access_key = xxx 17457 endpoint = cos.ap-guangzhou.myqcloud.com 17458 acl = default 17459 -------------------- 17460 y) Yes this is OK (default) 17461 e) Edit this remote 17462 d) Delete this remote 17463 y/e/d> y 17464 Current remotes: 17465 17466 Name Type 17467 ==== ==== 17468 cos s3</code></pre> 17469 <h3 id="netease-nos">Netease NOS</h3> 17470 <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> 17471 <h3 id="petabox">Petabox</h3> 17472 <p>Here is an example of making a <a href="https://petabox.io/">Petabox</a> configuration. First run:</p> 17473 <div class="sourceCode" id="cb946"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb946-1"><a href="#cb946-1" aria-hidden="true"></a><span class="ex">rclone</span> config</span></code></pre></div> 17474 <p>This will guide you through an interactive setup process.</p> 17475 <pre><code>No remotes found, make a new one? 17476 n) New remote 17477 s) Set configuration password 17478 n/s> n 17479 17480 Enter name for new remote. 17481 name> My Petabox Storage 17482 17483 Option Storage. 17484 Type of storage to configure. 17485 Choose a number from below, or type in your own value. 17486 [snip] 17487 XX / Amazon S3 Compliant Storage Providers including AWS, ... 17488 \ "s3" 17489 [snip] 17490 Storage> s3 17491 17492 Option provider. 17493 Choose your S3 provider. 17494 Choose a number from below, or type in your own value. 17495 Press Enter to leave empty. 17496 [snip] 17497 XX / Petabox Object Storage 17498 \ (Petabox) 17499 [snip] 17500 provider> Petabox 17501 17502 Option env_auth. 17503 Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). 17504 Only applies if access_key_id and secret_access_key is blank. 17505 Choose a number from below, or type in your own boolean value (true or false). 17506 Press Enter for the default (false). 17507 1 / Enter AWS credentials in the next step. 17508 \ (false) 17509 2 / Get AWS credentials from the environment (env vars or IAM). 17510 \ (true) 17511 env_auth> 1 17512 17513 Option access_key_id. 17514 AWS Access Key ID. 17515 Leave blank for anonymous access or runtime credentials. 17516 Enter a value. Press Enter to leave empty. 17517 access_key_id> YOUR_ACCESS_KEY_ID 17518 17519 Option secret_access_key. 17520 AWS Secret Access Key (password). 17521 Leave blank for anonymous access or runtime credentials. 17522 Enter a value. Press Enter to leave empty. 17523 secret_access_key> YOUR_SECRET_ACCESS_KEY 17524 17525 Option region. 17526 Region where your bucket will be created and your data stored. 17527 Choose a number from below, or type in your own value. 17528 Press Enter to leave empty. 17529 1 / US East (N. Virginia) 17530 \ (us-east-1) 17531 2 / Europe (Frankfurt) 17532 \ (eu-central-1) 17533 3 / Asia Pacific (Singapore) 17534 \ (ap-southeast-1) 17535 4 / Middle East (Bahrain) 17536 \ (me-south-1) 17537 5 / South America (São Paulo) 17538 \ (sa-east-1) 17539 region> 1 17540 17541 Option endpoint. 17542 Endpoint for Petabox S3 Object Storage. 17543 Specify the endpoint from the same region. 17544 Choose a number from below, or type in your own value. 17545 1 / US East (N. Virginia) 17546 \ (s3.petabox.io) 17547 2 / US East (N. Virginia) 17548 \ (s3.us-east-1.petabox.io) 17549 3 / Europe (Frankfurt) 17550 \ (s3.eu-central-1.petabox.io) 17551 4 / Asia Pacific (Singapore) 17552 \ (s3.ap-southeast-1.petabox.io) 17553 5 / Middle East (Bahrain) 17554 \ (s3.me-south-1.petabox.io) 17555 6 / South America (São Paulo) 17556 \ (s3.sa-east-1.petabox.io) 17557 endpoint> 1 17558 17559 Option acl. 17560 Canned ACL used when creating buckets and storing or copying objects. 17561 This ACL is used for creating objects and if bucket_acl isn't set, for creating buckets too. 17562 For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl 17563 Note that this ACL is applied when server-side copying objects as S3 17564 doesn't copy the ACL from the source but rather writes a fresh one. 17565 If the acl is an empty string then no X-Amz-Acl: header is added and 17566 the default (private) will be used. 17567 Choose a number from below, or type in your own value. 17568 Press Enter to leave empty. 17569 / Owner gets FULL_CONTROL. 17570 1 | No one else has access rights (default). 17571 \ (private) 17572 / Owner gets FULL_CONTROL. 17573 2 | The AllUsers group gets READ access. 17574 \ (public-read) 17575 / Owner gets FULL_CONTROL. 17576 3 | The AllUsers group gets READ and WRITE access. 17577 | Granting this on a bucket is generally not recommended. 17578 \ (public-read-write) 17579 / Owner gets FULL_CONTROL. 17580 4 | The AuthenticatedUsers group gets READ access. 17581 \ (authenticated-read) 17582 / Object owner gets FULL_CONTROL. 17583 5 | Bucket owner gets READ access. 17584 | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it. 17585 \ (bucket-owner-read) 17586 / Both the object owner and the bucket owner get FULL_CONTROL over the object. 17587 6 | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it. 17588 \ (bucket-owner-full-control) 17589 acl> 1 17590 17591 Edit advanced config? 17592 y) Yes 17593 n) No (default) 17594 y/n> No 17595 17596 Configuration complete. 17597 Options: 17598 - type: s3 17599 - provider: Petabox 17600 - access_key_id: YOUR_ACCESS_KEY_ID 17601 - secret_access_key: YOUR_SECRET_ACCESS_KEY 17602 - region: us-east-1 17603 - endpoint: s3.petabox.io 17604 Keep this "My Petabox Storage" remote? 17605 y) Yes this is OK (default) 17606 e) Edit this remote 17607 d) Delete this remote 17608 y/e/d> y</code></pre> 17609 <p>This will leave the config file looking like this.</p> 17610 <pre><code>[My Petabox Storage] 17611 type = s3 17612 provider = Petabox 17613 access_key_id = YOUR_ACCESS_KEY_ID 17614 secret_access_key = YOUR_SECRET_ACCESS_KEY 17615 region = us-east-1 17616 endpoint = s3.petabox.io</code></pre> 17617 <h3 id="storj">Storj</h3> 17618 <p>Storj is a decentralized cloud storage which can be used through its native protocol or an S3 compatible gateway.</p> 17619 <p>The S3 compatible gateway is configured using <code>rclone config</code> with a type of <code>s3</code> and with a provider name of <code>Storj</code>. Here is an example run of the configurator.</p> 17620 <pre><code>Type of storage to configure. 17621 Storage> s3 17622 Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). 17623 Only applies if access_key_id and secret_access_key is blank. 17624 Choose a number from below, or type in your own boolean value (true or false). 17625 Press Enter for the default (false). 17626 1 / Enter AWS credentials in the next step. 17627 \ (false) 17628 2 / Get AWS credentials from the environment (env vars or IAM). 17629 \ (true) 17630 env_auth> 1 17631 Option access_key_id. 17632 AWS Access Key ID. 17633 Leave blank for anonymous access or runtime credentials. 17634 Enter a value. Press Enter to leave empty. 17635 access_key_id> XXXX (as shown when creating the access grant) 17636 Option secret_access_key. 17637 AWS Secret Access Key (password). 17638 Leave blank for anonymous access or runtime credentials. 17639 Enter a value. Press Enter to leave empty. 17640 secret_access_key> XXXX (as shown when creating the access grant) 17641 Option endpoint. 17642 Endpoint of the Shared Gateway. 17643 Choose a number from below, or type in your own value. 17644 Press Enter to leave empty. 17645 1 / EU1 Shared Gateway 17646 \ (gateway.eu1.storjshare.io) 17647 2 / US1 Shared Gateway 17648 \ (gateway.us1.storjshare.io) 17649 3 / Asia-Pacific Shared Gateway 17650 \ (gateway.ap1.storjshare.io) 17651 endpoint> 1 (as shown when creating the access grant) 17652 Edit advanced config? 17653 y) Yes 17654 n) No (default) 17655 y/n> n</code></pre> 17656 <p>Note that s3 credentials are generated when you <a href="https://docs.storj.io/dcs/api-reference/s3-compatible-gateway#usage">create an access grant</a>.</p> 17657 <h4 id="backend-quirks">Backend quirks</h4> 17658 <ul> 17659 <li><code>--chunk-size</code> is forced to be 64 MiB or greater. This will use more memory than the default of 5 MiB.</li> 17660 <li>Server side copy is disabled as it isn't currently supported in the gateway.</li> 17661 <li>GetTier and SetTier are not supported.</li> 17662 </ul> 17663 <h4 id="backend-bugs">Backend bugs</h4> 17664 <p>Due to <a href="https://github.com/storj/gateway-mt/issues/39">issue #39</a> uploading multipart files via the S3 gateway causes them to lose their metadata. For rclone's purpose this means that the modification time is not stored, nor is any MD5SUM (if one is available from the source).</p> 17665 <p>This has the following consequences:</p> 17666 <ul> 17667 <li>Using <code>rclone rcat</code> will fail as the medatada doesn't match after upload</li> 17668 <li>Uploading files with <code>rclone mount</code> will fail for the same reason 17669 <ul> 17670 <li>This can worked around by using <code>--vfs-cache-mode writes</code> or <code>--vfs-cache-mode full</code> or setting <code>--s3-upload-cutoff</code> large</li> 17671 </ul></li> 17672 <li>Files uploaded via a multipart upload won't have their modtimes 17673 <ul> 17674 <li>This will mean that <code>rclone sync</code> will likely keep trying to upload files bigger than <code>--s3-upload-cutoff</code></li> 17675 <li>This can be worked around with <code>--checksum</code> or <code>--size-only</code> or setting <code>--s3-upload-cutoff</code> large</li> 17676 <li>The maximum value for <code>--s3-upload-cutoff</code> is 5GiB though</li> 17677 </ul></li> 17678 </ul> 17679 <p>One general purpose workaround is to set <code>--s3-upload-cutoff 5G</code>. This means that rclone will upload files smaller than 5GiB as single parts. Note that this can be set in the config file with <code>upload_cutoff = 5G</code> or configured in the advanced settings. If you regularly transfer files larger than 5G then using <code>--checksum</code> or <code>--size-only</code> in <code>rclone sync</code> is the recommended workaround.</p> 17680 <h4 id="comparison-with-the-native-protocol">Comparison with the native protocol</h4> 17681 <p>Use the <a href="/storj">the native protocol</a> to take advantage of client-side encryption as well as to achieve the best possible download performance. Uploads will be erasure-coded locally, thus a 1gb upload will result in 2.68gb of data being uploaded to storage nodes across the network.</p> 17682 <p>Use this backend and the S3 compatible Hosted Gateway to increase upload performance and reduce the load on your systems and network. Uploads will be encrypted and erasure-coded server-side, thus a 1GB upload will result in only in 1GB of data being uploaded to storage nodes across the network.</p> 17683 <p>For more detailed comparison please check the documentation of the <a href="/storj">storj</a> backend.</p> 17684 <h2 id="limitations-6">Limitations</h2> 17685 <p><code>rclone about</code> is not supported by the S3 backend. Backends without this capability cannot determine free space for an rclone mount or use policy <code>mfs</code> (most free space) as a member of an rclone union remote.</p> 17686 <p>See <a href="https://rclone.org/overview/#optional-features">List of backends that do not support rclone about</a> and <a href="https://rclone.org/commands/rclone_about/">rclone about</a></p> 17687 <h3 id="synology-c2">Synology C2 Object Storage</h3> 17688 <p><a href="https://c2.synology.com/en-global/object-storage/overview">Synology C2 Object Storage</a> provides a secure, S3-compatible, and cost-effective cloud storage solution without API request, download fees, and deletion penalty.</p> 17689 <p>The S3 compatible gateway is configured using <code>rclone config</code> with a type of <code>s3</code> and with a provider name of <code>Synology</code>. Here is an example run of the configurator.</p> 17690 <p>First run:</p> 17691 <pre><code>rclone config</code></pre> 17692 <p>This will guide you through an interactive setup process.</p> 17693 <pre><code>No remotes found, make a new one? 17694 n) New remote 17695 s) Set configuration password 17696 q) Quit config 17697 17698 n/s/q> n 17699 17700 Enter name for new remote.1 17701 name> syno 17702 17703 Type of storage to configure. 17704 Enter a string value. Press Enter for the default (""). 17705 Choose a number from below, or type in your own value 17706 17707 XX / Amazon S3 Compliant Storage Providers including AWS, ... 17708 \ "s3" 17709 17710 Storage> s3 17711 17712 Choose your S3 provider. 17713 Enter a string value. Press Enter for the default (""). 17714 Choose a number from below, or type in your own value 17715 24 / Synology C2 Object Storage 17716 \ (Synology) 17717 17718 provider> Synology 17719 17720 Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). 17721 Only applies if access_key_id and secret_access_key is blank. 17722 Enter a boolean value (true or false). Press Enter for the default ("false"). 17723 Choose a number from below, or type in your own value 17724 1 / Enter AWS credentials in the next step 17725 \ "false" 17726 2 / Get AWS credentials from the environment (env vars or IAM) 17727 \ "true" 17728 17729 env_auth> 1 17730 17731 AWS Access Key ID. 17732 Leave blank for anonymous access or runtime credentials. 17733 Enter a string value. Press Enter for the default (""). 17734 17735 access_key_id> accesskeyid 17736 17737 AWS Secret Access Key (password) 17738 Leave blank for anonymous access or runtime credentials. 17739 Enter a string value. Press Enter for the default (""). 17740 17741 secret_access_key> secretaccesskey 17742 17743 Region where your data stored. 17744 Choose a number from below, or type in your own value. 17745 Press Enter to leave empty. 17746 1 / Europe Region 1 17747 \ (eu-001) 17748 2 / Europe Region 2 17749 \ (eu-002) 17750 3 / US Region 1 17751 \ (us-001) 17752 4 / US Region 2 17753 \ (us-002) 17754 5 / Asia (Taiwan) 17755 \ (tw-001) 17756 17757 region > 1 17758 17759 Option endpoint. 17760 Endpoint for Synology C2 Object Storage API. 17761 Choose a number from below, or type in your own value. 17762 Press Enter to leave empty. 17763 1 / EU Endpoint 1 17764 \ (eu-001.s3.synologyc2.net) 17765 2 / US Endpoint 1 17766 \ (us-001.s3.synologyc2.net) 17767 3 / TW Endpoint 1 17768 \ (tw-001.s3.synologyc2.net) 17769 17770 endpoint> 1 17771 17772 Option location_constraint. 17773 Location constraint - must be set to match the Region. 17774 Leave blank if not sure. Used when creating buckets only. 17775 Enter a value. Press Enter to leave empty. 17776 location_constraint> 17777 17778 Edit advanced config? (y/n) 17779 y) Yes 17780 n) No 17781 y/n> y 17782 17783 Option no_check_bucket. 17784 If set, don't attempt to check the bucket exists or create it. 17785 This can be useful when trying to minimise the number of transactions 17786 rclone does if you know the bucket exists already. 17787 It can also be needed if the user you are using does not have bucket 17788 creation permissions. Before v1.52.0 this would have passed silently 17789 due to a bug. 17790 Enter a boolean value (true or false). Press Enter for the default (true). 17791 17792 no_check_bucket> true 17793 17794 Configuration complete. 17795 Options: 17796 - type: s3 17797 - provider: Synology 17798 - region: eu-001 17799 - endpoint: eu-001.s3.synologyc2.net 17800 - no_check_bucket: true 17801 Keep this "syno" remote? 17802 y) Yes this is OK (default) 17803 e) Edit this remote 17804 d) Delete this remote 17805 17806 y/e/d> y 17807 17808 # Backblaze B2 17809 17810 B2 is [Backblaze's cloud storage system](https://www.backblaze.com/b2/). 17811 17812 Paths are specified as `remote:bucket` (or `remote:` for the `lsd` 17813 command.) You may put subdirectories in too, e.g. `remote:bucket/path/to/dir`. 17814 17815 ## Configuration 17816 17817 Here is an example of making a b2 configuration. First run 17818 17819 rclone config 17820 17821 This will guide you through an interactive setup process. To authenticate 17822 you will either need your Account ID (a short hex number) and Master 17823 Application Key (a long hex number) OR an Application Key, which is the 17824 recommended method. See below for further details on generating and using 17825 an Application Key. 17826 </code></pre> 17827 <p>No remotes found, make a new one? n) New remote q) Quit config n/q> n name> remote Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Backblaze B2 "b2" [snip] Storage> b2 Account ID or Application Key ID account> 123456789abc Application Key key> 0123456789abcdef0123456789abcdef0123456789 Endpoint for the service - leave blank normally. endpoint> Remote config -------------------- [remote] account = 123456789abc key = 0123456789abcdef0123456789abcdef0123456789 endpoint = -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y</p> 17828 <pre><code> 17829 This remote is called `remote` and can now be used like this 17830 17831 See all buckets 17832 17833 rclone lsd remote: 17834 17835 Create a new bucket 17836 17837 rclone mkdir remote:bucket 17838 17839 List the contents of a bucket 17840 17841 rclone ls remote:bucket 17842 17843 Sync `/home/local/directory` to the remote bucket, deleting any 17844 excess files in the bucket. 17845 17846 rclone sync --interactive /home/local/directory remote:bucket 17847 17848 ### Application Keys 17849 17850 B2 supports multiple [Application Keys for different access permission 17851 to B2 Buckets](https://www.backblaze.com/b2/docs/application_keys.html). 17852 17853 You can use these with rclone too; you will need to use rclone version 1.43 17854 or later. 17855 17856 Follow Backblaze's docs to create an Application Key with the required 17857 permission and add the `applicationKeyId` as the `account` and the 17858 `Application Key` itself as the `key`. 17859 17860 Note that you must put the _applicationKeyId_ as the `account` – you 17861 can't use the master Account ID. If you try then B2 will return 401 17862 errors. 17863 17864 ### --fast-list 17865 17866 This remote supports `--fast-list` which allows you to use fewer 17867 transactions in exchange for more memory. See the [rclone 17868 docs](https://rclone.org/docs/#fast-list) for more details. 17869 17870 ### Modification times 17871 17872 The modification time is stored as metadata on the object as 17873 `X-Bz-Info-src_last_modified_millis` as milliseconds since 1970-01-01 17874 in the Backblaze standard. Other tools should be able to use this as 17875 a modified time. 17876 17877 Modified times are used in syncing and are fully supported. Note that 17878 if a modification time needs to be updated on an object then it will 17879 create a new version of the object. 17880 17881 ### Restricted filename characters 17882 17883 In addition to the [default restricted characters set](https://rclone.org/overview/#restricted-characters) 17884 the following characters are also replaced: 17885 17886 | Character | Value | Replacement | 17887 | --------- |:-----:|:-----------:| 17888 | \ | 0x5C | ＼ | 17889 17890 Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8), 17891 as they can't be used in JSON strings. 17892 17893 Note that in 2020-05 Backblaze started allowing \ characters in file 17894 names. Rclone hasn't changed its encoding as this could cause syncs to 17895 re-transfer files. If you want rclone not to replace \ then see the 17896 `--b2-encoding` flag below and remove the `BackSlash` from the 17897 string. This can be set in the config. 17898 17899 ### SHA1 checksums 17900 17901 The SHA1 checksums of the files are checked on upload and download and 17902 will be used in the syncing process. 17903 17904 Large files (bigger than the limit in `--b2-upload-cutoff`) which are 17905 uploaded in chunks will store their SHA1 on the object as 17906 `X-Bz-Info-large_file_sha1` as recommended by Backblaze. 17907 17908 For a large file to be uploaded with an SHA1 checksum, the source 17909 needs to support SHA1 checksums. The local disk supports SHA1 17910 checksums so large file transfers from local disk will have an SHA1. 17911 See [the overview](https://rclone.org/overview/#features) for exactly which remotes 17912 support SHA1. 17913 17914 Sources which don't support SHA1, in particular `crypt` will upload 17915 large files without SHA1 checksums. This may be fixed in the future 17916 (see [#1767](https://github.com/rclone/rclone/issues/1767)). 17917 17918 Files sizes below `--b2-upload-cutoff` will always have an SHA1 17919 regardless of the source. 17920 17921 ### Transfers 17922 17923 Backblaze recommends that you do lots of transfers simultaneously for 17924 maximum speed. In tests from my SSD equipped laptop the optimum 17925 setting is about `--transfers 32` though higher numbers may be used 17926 for a slight speed improvement. The optimum number for you may vary 17927 depending on your hardware, how big the files are, how much you want 17928 to load your computer, etc. The default of `--transfers 4` is 17929 definitely too low for Backblaze B2 though. 17930 17931 Note that uploading big files (bigger than 200 MiB by default) will use 17932 a 96 MiB RAM buffer by default. There can be at most `--transfers` of 17933 these in use at any moment, so this sets the upper limit on the memory 17934 used. 17935 17936 ### Versions 17937 17938 When rclone uploads a new version of a file it creates a [new version 17939 of it](https://www.backblaze.com/b2/docs/file_versions.html). 17940 Likewise when you delete a file, the old version will be marked hidden 17941 and still be available. Conversely, you may opt in to a "hard delete" 17942 of files with the `--b2-hard-delete` flag which would permanently remove 17943 the file instead of hiding it. 17944 17945 Old versions of files, where available, are visible using the 17946 `--b2-versions` flag. 17947 17948 It is also possible to view a bucket as it was at a certain point in time, 17949 using the `--b2-version-at` flag. This will show the file versions as they 17950 were at that time, showing files that have been deleted afterwards, and 17951 hiding files that were created since. 17952 17953 If you wish to remove all the old versions then you can use the 17954 `rclone cleanup remote:bucket` command which will delete all the old 17955 versions of files, leaving the current ones intact. You can also 17956 supply a path and only old versions under that path will be deleted, 17957 e.g. `rclone cleanup remote:bucket/path/to/stuff`. 17958 17959 Note that `cleanup` will remove partially uploaded files from the bucket 17960 if they are more than a day old. 17961 17962 When you `purge` a bucket, the current and the old versions will be 17963 deleted then the bucket will be deleted. 17964 17965 However `delete` will cause the current versions of the files to 17966 become hidden old versions. 17967 17968 Here is a session showing the listing and retrieval of an old 17969 version followed by a `cleanup` of the old versions. 17970 17971 Show current version and all the versions with `--b2-versions` flag. 17972 </code></pre> 17973 <p>$ rclone -q ls b2:cleanup-test 9 one.txt</p> 17974 <p>$ rclone -q --b2-versions ls b2:cleanup-test 9 one.txt 8 one-v2016-07-04-141032-000.txt 16 one-v2016-07-04-141003-000.txt 15 one-v2016-07-02-155621-000.txt</p> 17975 <pre><code> 17976 Retrieve an old version 17977 </code></pre> 17978 <p>$ rclone -q --b2-versions copy b2:cleanup-test/one-v2016-07-04-141003-000.txt /tmp</p> 17979 <p>$ ls -l /tmp/one-v2016-07-04-141003-000.txt -rw-rw-r-- 1 ncw ncw 16 Jul 2 17:46 /tmp/one-v2016-07-04-141003-000.txt</p> 17980 <pre><code> 17981 Clean up all the old versions and show that they've gone. 17982 </code></pre> 17983 <p>$ rclone -q cleanup b2:cleanup-test</p> 17984 <p>$ rclone -q ls b2:cleanup-test 9 one.txt</p> 17985 <p>$ rclone -q --b2-versions ls b2:cleanup-test 9 one.txt</p> 17986 <pre><code> 17987 #### Versions naming caveat 17988 17989 When using `--b2-versions` flag rclone is relying on the file name 17990 to work out whether the objects are versions or not. Versions' names 17991 are created by inserting timestamp between file name and its extension.</code></pre> 17992 <pre><code> 9 file.txt 17993 8 file-v2023-07-17-161032-000.txt 17994 16 file-v2023-06-15-141003-000.txt</code></pre> 17995 <pre><code>If there are real files present with the same names as versions, then 17996 behaviour of `--b2-versions` can be unpredictable. 17997 17998 ### Data usage 17999 18000 It is useful to know how many requests are sent to the server in different scenarios. 18001 18002 All copy commands send the following 4 requests: 18003 </code></pre> 18004 <p>/b2api/v1/b2_authorize_account /b2api/v1/b2_create_bucket /b2api/v1/b2_list_buckets /b2api/v1/b2_list_file_names</p> 18005 <pre><code> 18006 The `b2_list_file_names` request will be sent once for every 1k files 18007 in the remote path, providing the checksum and modification time of 18008 the listed files. As of version 1.33 issue 18009 [#818](https://github.com/rclone/rclone/issues/818) causes extra requests 18010 to be sent when using B2 with Crypt. When a copy operation does not 18011 require any files to be uploaded, no more requests will be sent. 18012 18013 Uploading files that do not require chunking, will send 2 requests per 18014 file upload: 18015 </code></pre> 18016 <p>/b2api/v1/b2_get_upload_url /b2api/v1/b2_upload_file/</p> 18017 <pre><code> 18018 Uploading files requiring chunking, will send 2 requests (one each to 18019 start and finish the upload) and another 2 requests for each chunk: 18020 </code></pre> 18021 <p>/b2api/v1/b2_start_large_file /b2api/v1/b2_get_upload_part_url /b2api/v1/b2_upload_part/ /b2api/v1/b2_finish_large_file</p> 18022 <pre><code> 18023 #### Versions 18024 18025 Versions can be viewed with the `--b2-versions` flag. When it is set 18026 rclone will show and act on older versions of files. For example 18027 18028 Listing without `--b2-versions` 18029 </code></pre> 18030 <p>$ rclone -q ls b2:cleanup-test 9 one.txt</p> 18031 <pre><code> 18032 And with 18033 </code></pre> 18034 <p>$ rclone -q --b2-versions ls b2:cleanup-test 9 one.txt 8 one-v2016-07-04-141032-000.txt 16 one-v2016-07-04-141003-000.txt 15 one-v2016-07-02-155621-000.txt</p> 18035 <pre><code> 18036 Showing that the current version is unchanged but older versions can 18037 be seen. These have the UTC date that they were uploaded to the 18038 server to the nearest millisecond appended to them. 18039 18040 Note that when using `--b2-versions` no file write operations are 18041 permitted, so you can't upload files or delete them. 18042 18043 ### B2 and rclone link 18044 18045 Rclone supports generating file share links for private B2 buckets. 18046 They can either be for a file for example: 18047 </code></pre> 18048 <p>./rclone link B2:bucket/path/to/file.txt https://f002.backblazeb2.com/file/bucket/path/to/file.txt?Authorization=xxxxxxxx</p> 18049 <pre><code> 18050 or if run on a directory you will get: 18051 </code></pre> 18052 <p>./rclone link B2:bucket/path https://f002.backblazeb2.com/file/bucket/path?Authorization=xxxxxxxx</p> 18053 <pre><code> 18054 you can then use the authorization token (the part of the url from the 18055 `?Authorization=` on) on any file path under that directory. For example: 18056 </code></pre> 18057 <p>https://f002.backblazeb2.com/file/bucket/path/to/file1?Authorization=xxxxxxxx https://f002.backblazeb2.com/file/bucket/path/file2?Authorization=xxxxxxxx https://f002.backblazeb2.com/file/bucket/path/folder/file3?Authorization=xxxxxxxx</p> 18058 <pre><code> 18059 18060 ### Standard options 18061 18062 Here are the Standard options specific to b2 (Backblaze B2). 18063 18064 #### --b2-account 18065 18066 Account ID or Application Key ID. 18067 18068 Properties: 18069 18070 - Config: account 18071 - Env Var: RCLONE_B2_ACCOUNT 18072 - Type: string 18073 - Required: true 18074 18075 #### --b2-key 18076 18077 Application Key. 18078 18079 Properties: 18080 18081 - Config: key 18082 - Env Var: RCLONE_B2_KEY 18083 - Type: string 18084 - Required: true 18085 18086 #### --b2-hard-delete 18087 18088 Permanently delete files on remote removal, otherwise hide files. 18089 18090 Properties: 18091 18092 - Config: hard_delete 18093 - Env Var: RCLONE_B2_HARD_DELETE 18094 - Type: bool 18095 - Default: false 18096 18097 ### Advanced options 18098 18099 Here are the Advanced options specific to b2 (Backblaze B2). 18100 18101 #### --b2-endpoint 18102 18103 Endpoint for the service. 18104 18105 Leave blank normally. 18106 18107 Properties: 18108 18109 - Config: endpoint 18110 - Env Var: RCLONE_B2_ENDPOINT 18111 - Type: string 18112 - Required: false 18113 18114 #### --b2-test-mode 18115 18116 A flag string for X-Bz-Test-Mode header for debugging. 18117 18118 This is for debugging purposes only. Setting it to one of the strings 18119 below will cause b2 to return specific errors: 18120 18121 * "fail_some_uploads" 18122 * "expire_some_account_authorization_tokens" 18123 * "force_cap_exceeded" 18124 18125 These will be set in the "X-Bz-Test-Mode" header which is documented 18126 in the [b2 integrations checklist](https://www.backblaze.com/b2/docs/integration_checklist.html). 18127 18128 Properties: 18129 18130 - Config: test_mode 18131 - Env Var: RCLONE_B2_TEST_MODE 18132 - Type: string 18133 - Required: false 18134 18135 #### --b2-versions 18136 18137 Include old versions in directory listings. 18138 18139 Note that when using this no file write operations are permitted, 18140 so you can't upload files or delete them. 18141 18142 Properties: 18143 18144 - Config: versions 18145 - Env Var: RCLONE_B2_VERSIONS 18146 - Type: bool 18147 - Default: false 18148 18149 #### --b2-version-at 18150 18151 Show file versions as they were at the specified time. 18152 18153 Note that when using this no file write operations are permitted, 18154 so you can't upload files or delete them. 18155 18156 Properties: 18157 18158 - Config: version_at 18159 - Env Var: RCLONE_B2_VERSION_AT 18160 - Type: Time 18161 - Default: off 18162 18163 #### --b2-upload-cutoff 18164 18165 Cutoff for switching to chunked upload. 18166 18167 Files above this size will be uploaded in chunks of "--b2-chunk-size". 18168 18169 This value should be set no larger than 4.657 GiB (== 5 GB). 18170 18171 Properties: 18172 18173 - Config: upload_cutoff 18174 - Env Var: RCLONE_B2_UPLOAD_CUTOFF 18175 - Type: SizeSuffix 18176 - Default: 200Mi 18177 18178 #### --b2-copy-cutoff 18179 18180 Cutoff for switching to multipart copy. 18181 18182 Any files larger than this that need to be server-side copied will be 18183 copied in chunks of this size. 18184 18185 The minimum is 0 and the maximum is 4.6 GiB. 18186 18187 Properties: 18188 18189 - Config: copy_cutoff 18190 - Env Var: RCLONE_B2_COPY_CUTOFF 18191 - Type: SizeSuffix 18192 - Default: 4Gi 18193 18194 #### --b2-chunk-size 18195 18196 Upload chunk size. 18197 18198 When uploading large files, chunk the file into this size. 18199 18200 Must fit in memory. These chunks are buffered in memory and there 18201 might a maximum of "--transfers" chunks in progress at once. 18202 18203 5,000,000 Bytes is the minimum size. 18204 18205 Properties: 18206 18207 - Config: chunk_size 18208 - Env Var: RCLONE_B2_CHUNK_SIZE 18209 - Type: SizeSuffix 18210 - Default: 96Mi 18211 18212 #### --b2-upload-concurrency 18213 18214 Concurrency for multipart uploads. 18215 18216 This is the number of chunks of the same file that are uploaded 18217 concurrently. 18218 18219 Note that chunks are stored in memory and there may be up to 18220 "--transfers" * "--b2-upload-concurrency" chunks stored at once 18221 in memory. 18222 18223 Properties: 18224 18225 - Config: upload_concurrency 18226 - Env Var: RCLONE_B2_UPLOAD_CONCURRENCY 18227 - Type: int 18228 - Default: 4 18229 18230 #### --b2-disable-checksum 18231 18232 Disable checksums for large (> upload cutoff) files. 18233 18234 Normally rclone will calculate the SHA1 checksum of the input before 18235 uploading it so it can add it to metadata on the object. This is great 18236 for data integrity checking but can cause long delays for large files 18237 to start uploading. 18238 18239 Properties: 18240 18241 - Config: disable_checksum 18242 - Env Var: RCLONE_B2_DISABLE_CHECKSUM 18243 - Type: bool 18244 - Default: false 18245 18246 #### --b2-download-url 18247 18248 Custom endpoint for downloads. 18249 18250 This is usually set to a Cloudflare CDN URL as Backblaze offers 18251 free egress for data downloaded through the Cloudflare network. 18252 Rclone works with private buckets by sending an "Authorization" header. 18253 If the custom endpoint rewrites the requests for authentication, 18254 e.g., in Cloudflare Workers, this header needs to be handled properly. 18255 Leave blank if you want to use the endpoint provided by Backblaze. 18256 18257 The URL provided here SHOULD have the protocol and SHOULD NOT have 18258 a trailing slash or specify the /file/bucket subpath as rclone will 18259 request files with "{download_url}/file/{bucket_name}/{path}". 18260 18261 Example: 18262 > https://mysubdomain.mydomain.tld 18263 (No trailing "/", "file" or "bucket") 18264 18265 Properties: 18266 18267 - Config: download_url 18268 - Env Var: RCLONE_B2_DOWNLOAD_URL 18269 - Type: string 18270 - Required: false 18271 18272 #### --b2-download-auth-duration 18273 18274 Time before the public link authorization token will expire in s or suffix ms|s|m|h|d. 18275 18276 This is used in combination with "rclone link" for making files 18277 accessible to the public and sets the duration before the download 18278 authorization token will expire. 18279 18280 The minimum value is 1 second. The maximum value is one week. 18281 18282 Properties: 18283 18284 - Config: download_auth_duration 18285 - Env Var: RCLONE_B2_DOWNLOAD_AUTH_DURATION 18286 - Type: Duration 18287 - Default: 1w 18288 18289 #### --b2-memory-pool-flush-time 18290 18291 How often internal memory buffer pools will be flushed. (no longer used) 18292 18293 Properties: 18294 18295 - Config: memory_pool_flush_time 18296 - Env Var: RCLONE_B2_MEMORY_POOL_FLUSH_TIME 18297 - Type: Duration 18298 - Default: 1m0s 18299 18300 #### --b2-memory-pool-use-mmap 18301 18302 Whether to use mmap buffers in internal memory pool. (no longer used) 18303 18304 Properties: 18305 18306 - Config: memory_pool_use_mmap 18307 - Env Var: RCLONE_B2_MEMORY_POOL_USE_MMAP 18308 - Type: bool 18309 - Default: false 18310 18311 #### --b2-lifecycle 18312 18313 Set the number of days deleted files should be kept when creating a bucket. 18314 18315 On bucket creation, this parameter is used to create a lifecycle rule 18316 for the entire bucket. 18317 18318 If lifecycle is 0 (the default) it does not create a lifecycle rule so 18319 the default B2 behaviour applies. This is to create versions of files 18320 on delete and overwrite and to keep them indefinitely. 18321 18322 If lifecycle is >0 then it creates a single rule setting the number of 18323 days before a file that is deleted or overwritten is deleted 18324 permanently. This is known as daysFromHidingToDeleting in the b2 docs. 18325 18326 The minimum value for this parameter is 1 day. 18327 18328 You can also enable hard_delete in the config also which will mean 18329 deletions won't cause versions but overwrites will still cause 18330 versions to be made. 18331 18332 See: [rclone backend lifecycle](#lifecycle) for setting lifecycles after bucket creation. 18333 18334 18335 Properties: 18336 18337 - Config: lifecycle 18338 - Env Var: RCLONE_B2_LIFECYCLE 18339 - Type: int 18340 - Default: 0 18341 18342 #### --b2-encoding 18343 18344 The encoding for the backend. 18345 18346 See the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. 18347 18348 Properties: 18349 18350 - Config: encoding 18351 - Env Var: RCLONE_B2_ENCODING 18352 - Type: Encoding 18353 - Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot 18354 18355 #### --b2-description 18356 18357 Description of the remote 18358 18359 Properties: 18360 18361 - Config: description 18362 - Env Var: RCLONE_B2_DESCRIPTION 18363 - Type: string 18364 - Required: false 18365 18366 ## Backend commands 18367 18368 Here are the commands specific to the b2 backend. 18369 18370 Run them with 18371 18372 rclone backend COMMAND remote: 18373 18374 The help below will explain what arguments each command takes. 18375 18376 See the [backend](https://rclone.org/commands/rclone_backend/) command for more 18377 info on how to pass options and arguments. 18378 18379 These can be run on a running backend using the rc command 18380 [backend/command](https://rclone.org/rc/#backend-command). 18381 18382 ### lifecycle 18383 18384 Read or set the lifecycle for a bucket 18385 18386 rclone backend lifecycle remote: [options] [<arguments>+] 18387 18388 This command can be used to read or set the lifecycle for a bucket. 18389 18390 Usage Examples: 18391 18392 To show the current lifecycle rules: 18393 18394 rclone backend lifecycle b2:bucket 18395 18396 This will dump something like this showing the lifecycle rules. 18397 18398 [ 18399 { 18400 "daysFromHidingToDeleting": 1, 18401 "daysFromUploadingToHiding": null, 18402 "fileNamePrefix": "" 18403 } 18404 ] 18405 18406 If there are no lifecycle rules (the default) then it will just return []. 18407 18408 To reset the current lifecycle rules: 18409 18410 rclone backend lifecycle b2:bucket -o daysFromHidingToDeleting=30 18411 rclone backend lifecycle b2:bucket -o daysFromUploadingToHiding=5 -o daysFromHidingToDeleting=1 18412 18413 This will run and then print the new lifecycle rules as above. 18414 18415 Rclone only lets you set lifecycles for the whole bucket with the 18416 fileNamePrefix = "". 18417 18418 You can't disable versioning with B2. The best you can do is to set 18419 the daysFromHidingToDeleting to 1 day. You can enable hard_delete in 18420 the config also which will mean deletions won't cause versions but 18421 overwrites will still cause versions to be made. 18422 18423 rclone backend lifecycle b2:bucket -o daysFromHidingToDeleting=1 18424 18425 See: https://www.backblaze.com/docs/cloud-storage-lifecycle-rules 18426 18427 18428 Options: 18429 18430 - "daysFromHidingToDeleting": After a file has been hidden for this many days it is deleted. 0 is off. 18431 - "daysFromUploadingToHiding": This many days after uploading a file is hidden 18432 18433 18434 18435 ## Limitations 18436 18437 `rclone about` is not supported by the B2 backend. Backends without 18438 this capability cannot determine free space for an rclone mount or 18439 use policy `mfs` (most free space) as a member of an rclone union 18440 remote. 18441 18442 See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features) and [rclone about](https://rclone.org/commands/rclone_about/) 18443 18444 # Box 18445 18446 Paths are specified as `remote:path` 18447 18448 Paths may be as deep as required, e.g. `remote:directory/subdirectory`. 18449 18450 The initial setup for Box involves getting a token from Box which you 18451 can do either in your browser, or with a config.json downloaded from Box 18452 to use JWT authentication. `rclone config` walks you through it. 18453 18454 ## Configuration 18455 18456 Here is an example of how to make a remote called `remote`. First run: 18457 18458 rclone config 18459 18460 This will guide you through an interactive setup process: 18461 </code></pre> 18462 <p>No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n name> remote Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Box "box" [snip] Storage> box Box App Client Id - leave blank normally. client_id> Box App Client Secret - leave blank normally. client_secret> Box App config.json location Leave blank normally. Enter a string value. Press Enter for the default (""). box_config_file> Box App Primary Access Token Leave blank normally. Enter a string value. Press Enter for the default (""). access_token></p> 18463 <p>Enter a string value. Press Enter for the default ("user"). Choose a number from below, or type in your own value 1 / Rclone should act on behalf of a user "user" 2 / Rclone should act on behalf of a service account "enterprise" box_sub_type> Remote config Use web browser to automatically authenticate rclone with remote? * Say Y if the machine running rclone has a web browser you can use * Say N if running rclone on a (remote) machine without web browser access If not sure try Y. If Y failed, try N. y) Yes n) No y/n> y If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth Log in and authorize rclone for access Waiting for code... Got code -------------------- [remote] client_id = client_secret = token = {"access_token":"XXX","token_type":"bearer","refresh_token":"XXX","expiry":"XXX"} -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y</p> 18464 <pre><code> 18465 See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a 18466 machine with no Internet browser available. 18467 18468 Note that rclone runs a webserver on your local machine to collect the 18469 token as returned from Box. This only runs from the moment it opens 18470 your browser to the moment you get back the verification code. This 18471 is on `http://127.0.0.1:53682/` and this it may require you to unblock 18472 it temporarily if you are running a host firewall. 18473 18474 Once configured you can then use `rclone` like this, 18475 18476 List directories in top level of your Box 18477 18478 rclone lsd remote: 18479 18480 List all the files in your Box 18481 18482 rclone ls remote: 18483 18484 To copy a local directory to an Box directory called backup 18485 18486 rclone copy /home/source remote:backup 18487 18488 ### Using rclone with an Enterprise account with SSO 18489 18490 If you have an "Enterprise" account type with Box with single sign on 18491 (SSO), you need to create a password to use Box with rclone. This can 18492 be done at your Enterprise Box account by going to Settings, "Account" 18493 Tab, and then set the password in the "Authentication" field. 18494 18495 Once you have done this, you can setup your Enterprise Box account 18496 using the same procedure detailed above in the, using the password you 18497 have just set. 18498 18499 ### Invalid refresh token 18500 18501 According to the [box docs](https://developer.box.com/v2.0/docs/oauth-20#section-6-using-the-access-and-refresh-tokens): 18502 18503 > Each refresh_token is valid for one use in 60 days. 18504 18505 This means that if you 18506 18507 * Don't use the box remote for 60 days 18508 * Copy the config file with a box refresh token in and use it in two places 18509 * Get an error on a token refresh 18510 18511 then rclone will return an error which includes the text `Invalid 18512 refresh token`. 18513 18514 To fix this you will need to use oauth2 again to update the refresh 18515 token. You can use the methods in [the remote setup 18516 docs](https://rclone.org/remote_setup/), bearing in mind that if you use the copy the 18517 config file method, you should not use that remote on the computer you 18518 did the authentication on. 18519 18520 Here is how to do it. 18521 </code></pre> 18522 <p>$ rclone config Current remotes:</p> 18523 <p>Name Type ==== ==== remote box</p> 18524 <ol start="5" type="a"> 18525 <li>Edit existing remote</li> 18526 <li>New remote</li> 18527 <li>Delete remote</li> 18528 <li>Rename remote</li> 18529 <li>Copy remote</li> 18530 <li>Set configuration password</li> 18531 <li>Quit config e/n/d/r/c/s/q> e Choose a number from below, or type in an existing value 1 > remote remote> remote -------------------- [remote] type = box token = {"access_token":"XXX","token_type":"bearer","refresh_token":"XXX","expiry":"2017-07-08T23:40:08.059167677+01:00"} -------------------- Edit remote Value "client_id" = "" Edit? (y/n)></li> 18532 <li>Yes</li> 18533 <li>No y/n> n Value "client_secret" = "" Edit? (y/n)></li> 18534 <li>Yes</li> 18535 <li>No y/n> n Remote config Already have a token - refresh?</li> 18536 <li>Yes</li> 18537 <li>No y/n> y Use web browser to automatically authenticate rclone with remote?</li> 18538 </ol> 18539 <ul> 18540 <li>Say Y if the machine running rclone has a web browser you can use</li> 18541 <li>Say N if running rclone on a (remote) machine without web browser access If not sure try Y. If Y failed, try N.</li> 18542 </ul> 18543 <ol start="25" type="a"> 18544 <li>Yes</li> 18545 <li>No y/n> y If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth Log in and authorize rclone for access Waiting for code... Got code -------------------- [remote] type = box token = {"access_token":"YYY","token_type":"bearer","refresh_token":"YYY","expiry":"2017-07-23T12:22:29.259137901+01:00"} --------------------</li> 18546 <li>Yes this is OK</li> 18547 <li>Edit this remote</li> 18548 <li>Delete this remote y/e/d> y</li> 18549 </ol> 18550 <pre><code> 18551 ### Modification times and hashes 18552 18553 Box allows modification times to be set on objects accurate to 1 18554 second. These will be used to detect whether objects need syncing or 18555 not. 18556 18557 Box supports SHA1 type hashes, so you can use the `--checksum` 18558 flag. 18559 18560 ### Restricted filename characters 18561 18562 In addition to the [default restricted characters set](https://rclone.org/overview/#restricted-characters) 18563 the following characters are also replaced: 18564 18565 | Character | Value | Replacement | 18566 | --------- |:-----:|:-----------:| 18567 | \ | 0x5C | ＼ | 18568 18569 File names can also not end with the following characters. 18570 These only get replaced if they are the last character in the name: 18571 18572 | Character | Value | Replacement | 18573 | --------- |:-----:|:-----------:| 18574 | SP | 0x20 | ␠ | 18575 18576 Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8), 18577 as they can't be used in JSON strings. 18578 18579 ### Transfers 18580 18581 For files above 50 MiB rclone will use a chunked transfer. Rclone will 18582 upload up to `--transfers` chunks at the same time (shared among all 18583 the multipart uploads). Chunks are buffered in memory and are 18584 normally 8 MiB so increasing `--transfers` will increase memory use. 18585 18586 ### Deleting files 18587 18588 Depending on the enterprise settings for your user, the item will 18589 either be actually deleted from Box or moved to the trash. 18590 18591 Emptying the trash is supported via the rclone however cleanup command 18592 however this deletes every trashed file and folder individually so it 18593 may take a very long time. 18594 Emptying the trash via the WebUI does not have this limitation 18595 so it is advised to empty the trash via the WebUI. 18596 18597 ### Root folder ID 18598 18599 You can set the `root_folder_id` for rclone. This is the directory 18600 (identified by its `Folder ID`) that rclone considers to be the root 18601 of your Box drive. 18602 18603 Normally you will leave this blank and rclone will determine the 18604 correct root to use itself. 18605 18606 However you can set this to restrict rclone to a specific folder 18607 hierarchy. 18608 18609 In order to do this you will have to find the `Folder ID` of the 18610 directory you wish rclone to display. This will be the last segment 18611 of the URL when you open the relevant folder in the Box web 18612 interface. 18613 18614 So if the folder you want rclone to use has a URL which looks like 18615 `https://app.box.com/folder/11xxxxxxxxx8` 18616 in the browser, then you use `11xxxxxxxxx8` as 18617 the `root_folder_id` in the config. 18618 18619 18620 ### Standard options 18621 18622 Here are the Standard options specific to box (Box). 18623 18624 #### --box-client-id 18625 18626 OAuth Client Id. 18627 18628 Leave blank normally. 18629 18630 Properties: 18631 18632 - Config: client_id 18633 - Env Var: RCLONE_BOX_CLIENT_ID 18634 - Type: string 18635 - Required: false 18636 18637 #### --box-client-secret 18638 18639 OAuth Client Secret. 18640 18641 Leave blank normally. 18642 18643 Properties: 18644 18645 - Config: client_secret 18646 - Env Var: RCLONE_BOX_CLIENT_SECRET 18647 - Type: string 18648 - Required: false 18649 18650 #### --box-box-config-file 18651 18652 Box App config.json location 18653 18654 Leave blank normally. 18655 18656 Leading `~` will be expanded in the file name as will environment variables such as `${RCLONE_CONFIG_DIR}`. 18657 18658 Properties: 18659 18660 - Config: box_config_file 18661 - Env Var: RCLONE_BOX_BOX_CONFIG_FILE 18662 - Type: string 18663 - Required: false 18664 18665 #### --box-access-token 18666 18667 Box App Primary Access Token 18668 18669 Leave blank normally. 18670 18671 Properties: 18672 18673 - Config: access_token 18674 - Env Var: RCLONE_BOX_ACCESS_TOKEN 18675 - Type: string 18676 - Required: false 18677 18678 #### --box-box-sub-type 18679 18680 18681 18682 Properties: 18683 18684 - Config: box_sub_type 18685 - Env Var: RCLONE_BOX_BOX_SUB_TYPE 18686 - Type: string 18687 - Default: "user" 18688 - Examples: 18689 - "user" 18690 - Rclone should act on behalf of a user. 18691 - "enterprise" 18692 - Rclone should act on behalf of a service account. 18693 18694 ### Advanced options 18695 18696 Here are the Advanced options specific to box (Box). 18697 18698 #### --box-token 18699 18700 OAuth Access Token as a JSON blob. 18701 18702 Properties: 18703 18704 - Config: token 18705 - Env Var: RCLONE_BOX_TOKEN 18706 - Type: string 18707 - Required: false 18708 18709 #### --box-auth-url 18710 18711 Auth server URL. 18712 18713 Leave blank to use the provider defaults. 18714 18715 Properties: 18716 18717 - Config: auth_url 18718 - Env Var: RCLONE_BOX_AUTH_URL 18719 - Type: string 18720 - Required: false 18721 18722 #### --box-token-url 18723 18724 Token server url. 18725 18726 Leave blank to use the provider defaults. 18727 18728 Properties: 18729 18730 - Config: token_url 18731 - Env Var: RCLONE_BOX_TOKEN_URL 18732 - Type: string 18733 - Required: false 18734 18735 #### --box-root-folder-id 18736 18737 Fill in for rclone to use a non root folder as its starting point. 18738 18739 Properties: 18740 18741 - Config: root_folder_id 18742 - Env Var: RCLONE_BOX_ROOT_FOLDER_ID 18743 - Type: string 18744 - Default: "0" 18745 18746 #### --box-upload-cutoff 18747 18748 Cutoff for switching to multipart upload (>= 50 MiB). 18749 18750 Properties: 18751 18752 - Config: upload_cutoff 18753 - Env Var: RCLONE_BOX_UPLOAD_CUTOFF 18754 - Type: SizeSuffix 18755 - Default: 50Mi 18756 18757 #### --box-commit-retries 18758 18759 Max number of times to try committing a multipart file. 18760 18761 Properties: 18762 18763 - Config: commit_retries 18764 - Env Var: RCLONE_BOX_COMMIT_RETRIES 18765 - Type: int 18766 - Default: 100 18767 18768 #### --box-list-chunk 18769 18770 Size of listing chunk 1-1000. 18771 18772 Properties: 18773 18774 - Config: list_chunk 18775 - Env Var: RCLONE_BOX_LIST_CHUNK 18776 - Type: int 18777 - Default: 1000 18778 18779 #### --box-owned-by 18780 18781 Only show items owned by the login (email address) passed in. 18782 18783 Properties: 18784 18785 - Config: owned_by 18786 - Env Var: RCLONE_BOX_OWNED_BY 18787 - Type: string 18788 - Required: false 18789 18790 #### --box-impersonate 18791 18792 Impersonate this user ID when using a service account. 18793 18794 Setting this flag allows rclone, when using a JWT service account, to 18795 act on behalf of another user by setting the as-user header. 18796 18797 The user ID is the Box identifier for a user. User IDs can found for 18798 any user via the GET /users endpoint, which is only available to 18799 admins, or by calling the GET /users/me endpoint with an authenticated 18800 user session. 18801 18802 See: https://developer.box.com/guides/authentication/jwt/as-user/ 18803 18804 18805 Properties: 18806 18807 - Config: impersonate 18808 - Env Var: RCLONE_BOX_IMPERSONATE 18809 - Type: string 18810 - Required: false 18811 18812 #### --box-encoding 18813 18814 The encoding for the backend. 18815 18816 See the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. 18817 18818 Properties: 18819 18820 - Config: encoding 18821 - Env Var: RCLONE_BOX_ENCODING 18822 - Type: Encoding 18823 - Default: Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot 18824 18825 #### --box-description 18826 18827 Description of the remote 18828 18829 Properties: 18830 18831 - Config: description 18832 - Env Var: RCLONE_BOX_DESCRIPTION 18833 - Type: string 18834 - Required: false 18835 18836 18837 18838 ## Limitations 18839 18840 Note that Box is case insensitive so you can't have a file called 18841 "Hello.doc" and one called "hello.doc". 18842 18843 Box file names can't have the `\` character in. rclone maps this to 18844 and from an identical looking unicode equivalent `＼` (U+FF3C Fullwidth 18845 Reverse Solidus). 18846 18847 Box only supports filenames up to 255 characters in length. 18848 18849 Box has [API rate limits](https://developer.box.com/guides/api-calls/permissions-and-errors/rate-limits/) that sometimes reduce the speed of rclone. 18850 18851 `rclone about` is not supported by the Box backend. Backends without 18852 this capability cannot determine free space for an rclone mount or 18853 use policy `mfs` (most free space) as a member of an rclone union 18854 remote. 18855 18856 See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features) and [rclone about](https://rclone.org/commands/rclone_about/) 18857 18858 ## Get your own Box App ID 18859 18860 Here is how to create your own Box App ID for rclone: 18861 18862 1. Go to the [Box Developer Console](https://app.box.com/developers/console) 18863 and login, then click `My Apps` on the sidebar. Click `Create New App` 18864 and select `Custom App`. 18865 18866 2. In the first screen on the box that pops up, you can pretty much enter 18867 whatever you want. The `App Name` can be whatever. For `Purpose` choose 18868 automation to avoid having to fill out anything else. Click `Next`. 18869 18870 3. In the second screen of the creation screen, select 18871 `User Authentication (OAuth 2.0)`. Then click `Create App`. 18872 18873 4. You should now be on the `Configuration` tab of your new app. If not, 18874 click on it at the top of the webpage. Copy down `Client ID` 18875 and `Client Secret`, you'll need those for rclone. 18876 18877 5. Under "OAuth 2.0 Redirect URI", add `http://127.0.0.1:53682/` 18878 18879 6. For `Application Scopes`, select `Read all files and folders stored in Box` 18880 and `Write all files and folders stored in box` (assuming you want to do both). 18881 Leave others unchecked. Click `Save Changes` at the top right. 18882 18883 # Cache 18884 18885 The `cache` remote wraps another existing remote and stores file structure 18886 and its data for long running tasks like `rclone mount`. 18887 18888 ## Status 18889 18890 The cache backend code is working but it currently doesn't 18891 have a maintainer so there are [outstanding bugs](https://github.com/rclone/rclone/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3A%22Remote%3A+Cache%22) which aren't getting fixed. 18892 18893 The cache backend is due to be phased out in favour of the VFS caching 18894 layer eventually which is more tightly integrated into rclone. 18895 18896 Until this happens we recommend only using the cache backend if you 18897 find you can't work without it. There are many docs online describing 18898 the use of the cache backend to minimize API hits and by-and-large 18899 these are out of date and the cache backend isn't needed in those 18900 scenarios any more. 18901 18902 ## Configuration 18903 18904 To get started you just need to have an existing remote which can be configured 18905 with `cache`. 18906 18907 Here is an example of how to make a remote called `test-cache`. First run: 18908 18909 rclone config 18910 18911 This will guide you through an interactive setup process: 18912 </code></pre> 18913 <p>No remotes found, make a new one? n) New remote r) Rename remote c) Copy remote s) Set configuration password q) Quit config n/r/c/s/q> n name> test-cache Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Cache a remote "cache" [snip] Storage> cache Remote to cache. Normally should contain a ':' and a path, e.g. "myremote:path/to/dir", "myremote:bucket" or maybe "myremote:" (not recommended). remote> local:/test Optional: The URL of the Plex server plex_url> http://127.0.0.1:32400 Optional: The username of the Plex user plex_username> dummyusername Optional: The password of the Plex user y) Yes type in my own password g) Generate random password n) No leave this optional password blank y/g/n> y Enter the password: password: Confirm the password: password: The size of a chunk. Lower value good for slow connections but can affect seamless reading. Default: 5M Choose a number from below, or type in your own value 1 / 1 MiB "1M" 2 / 5 MiB "5M" 3 / 10 MiB "10M" chunk_size> 2 How much time should object info (file size, file hashes, etc.) be stored in cache. Use a very high value if you don't plan on changing the source FS from outside the cache. Accepted units are: "s", "m", "h". Default: 5m Choose a number from below, or type in your own value 1 / 1 hour "1h" 2 / 24 hours "24h" 3 / 24 hours "48h" info_age> 2 The maximum size of stored chunks. When the storage grows beyond this size, the oldest chunks will be deleted. Default: 10G Choose a number from below, or type in your own value 1 / 500 MiB "500M" 2 / 1 GiB "1G" 3 / 10 GiB "10G" chunk_total_size> 3 Remote config -------------------- [test-cache] remote = local:/test plex_url = http://127.0.0.1:32400 plex_username = dummyusername plex_password = *** ENCRYPTED *** chunk_size = 5M info_age = 48h chunk_total_size = 10G</p> 18914 <pre><code> 18915 You can then use it like this, 18916 18917 List directories in top level of your drive 18918 18919 rclone lsd test-cache: 18920 18921 List all the files in your drive 18922 18923 rclone ls test-cache: 18924 18925 To start a cached mount 18926 18927 rclone mount --allow-other test-cache: /var/tmp/test-cache 18928 18929 ### Write Features ### 18930 18931 ### Offline uploading ### 18932 18933 In an effort to make writing through cache more reliable, the backend 18934 now supports this feature which can be activated by specifying a 18935 `cache-tmp-upload-path`. 18936 18937 A files goes through these states when using this feature: 18938 18939 1. An upload is started (usually by copying a file on the cache remote) 18940 2. When the copy to the temporary location is complete the file is part 18941 of the cached remote and looks and behaves like any other file (reading included) 18942 3. After `cache-tmp-wait-time` passes and the file is next in line, `rclone move` 18943 is used to move the file to the cloud provider 18944 4. Reading the file still works during the upload but most modifications on it will be prohibited 18945 5. Once the move is complete the file is unlocked for modifications as it 18946 becomes as any other regular file 18947 6. If the file is being read through `cache` when it's actually 18948 deleted from the temporary path then `cache` will simply swap the source 18949 to the cloud provider without interrupting the reading (small blip can happen though) 18950 18951 Files are uploaded in sequence and only one file is uploaded at a time. 18952 Uploads will be stored in a queue and be processed based on the order they were added. 18953 The queue and the temporary storage is persistent across restarts but 18954 can be cleared on startup with the `--cache-db-purge` flag. 18955 18956 ### Write Support ### 18957 18958 Writes are supported through `cache`. 18959 One caveat is that a mounted cache remote does not add any retry or fallback 18960 mechanism to the upload operation. This will depend on the implementation 18961 of the wrapped remote. Consider using `Offline uploading` for reliable writes. 18962 18963 One special case is covered with `cache-writes` which will cache the file 18964 data at the same time as the upload when it is enabled making it available 18965 from the cache store immediately once the upload is finished. 18966 18967 ### Read Features ### 18968 18969 #### Multiple connections #### 18970 18971 To counter the high latency between a local PC where rclone is running 18972 and cloud providers, the cache remote can split multiple requests to the 18973 cloud provider for smaller file chunks and combines them together locally 18974 where they can be available almost immediately before the reader usually 18975 needs them. 18976 18977 This is similar to buffering when media files are played online. Rclone 18978 will stay around the current marker but always try its best to stay ahead 18979 and prepare the data before. 18980 18981 #### Plex Integration #### 18982 18983 There is a direct integration with Plex which allows cache to detect during reading 18984 if the file is in playback or not. This helps cache to adapt how it queries 18985 the cloud provider depending on what is needed for. 18986 18987 Scans will have a minimum amount of workers (1) while in a confirmed playback cache 18988 will deploy the configured number of workers. 18989 18990 This integration opens the doorway to additional performance improvements 18991 which will be explored in the near future. 18992 18993 **Note:** If Plex options are not configured, `cache` will function with its 18994 configured options without adapting any of its settings. 18995 18996 How to enable? Run `rclone config` and add all the Plex options (endpoint, username 18997 and password) in your remote and it will be automatically enabled. 18998 18999 Affected settings: 19000 - `cache-workers`: _Configured value_ during confirmed playback or _1_ all the other times 19001 19002 ##### Certificate Validation ##### 19003 19004 When the Plex server is configured to only accept secure connections, it is 19005 possible to use `.plex.direct` URLs to ensure certificate validation succeeds. 19006 These URLs are used by Plex internally to connect to the Plex server securely. 19007 19008 The format for these URLs is the following: 19009 19010 `https://ip-with-dots-replaced.server-hash.plex.direct:32400/` 19011 19012 The `ip-with-dots-replaced` part can be any IPv4 address, where the dots 19013 have been replaced with dashes, e.g. `127.0.0.1` becomes `127-0-0-1`. 19014 19015 To get the `server-hash` part, the easiest way is to visit 19016 19017 https://plex.tv/api/resources?includeHttps=1&X-Plex-Token=your-plex-token 19018 19019 This page will list all the available Plex servers for your account 19020 with at least one `.plex.direct` link for each. Copy one URL and replace 19021 the IP address with the desired address. This can be used as the 19022 `plex_url` value. 19023 19024 ### Known issues ### 19025 19026 #### Mount and --dir-cache-time #### 19027 19028 --dir-cache-time controls the first layer of directory caching which works at the mount layer. 19029 Being an independent caching mechanism from the `cache` backend, it will manage its own entries 19030 based on the configured time. 19031 19032 To avoid getting in a scenario where dir cache has obsolete data and cache would have the correct 19033 one, try to set `--dir-cache-time` to a lower time than `--cache-info-age`. Default values are 19034 already configured in this way. 19035 19036 #### Windows support - Experimental #### 19037 19038 There are a couple of issues with Windows `mount` functionality that still require some investigations. 19039 It should be considered as experimental thus far as fixes come in for this OS. 19040 19041 Most of the issues seem to be related to the difference between filesystems 19042 on Linux flavors and Windows as cache is heavily dependent on them. 19043 19044 Any reports or feedback on how cache behaves on this OS is greatly appreciated. 19045 19046 - https://github.com/rclone/rclone/issues/1935 19047 - https://github.com/rclone/rclone/issues/1907 19048 - https://github.com/rclone/rclone/issues/1834 19049 19050 #### Risk of throttling #### 19051 19052 Future iterations of the cache backend will make use of the pooling functionality 19053 of the cloud provider to synchronize and at the same time make writing through it 19054 more tolerant to failures. 19055 19056 There are a couple of enhancements in track to add these but in the meantime 19057 there is a valid concern that the expiring cache listings can lead to cloud provider 19058 throttles or bans due to repeated queries on it for very large mounts. 19059 19060 Some recommendations: 19061 - don't use a very small interval for entry information (`--cache-info-age`) 19062 - while writes aren't yet optimised, you can still write through `cache` which gives you the advantage 19063 of adding the file in the cache at the same time if configured to do so. 19064 19065 Future enhancements: 19066 19067 - https://github.com/rclone/rclone/issues/1937 19068 - https://github.com/rclone/rclone/issues/1936 19069 19070 #### cache and crypt #### 19071 19072 One common scenario is to keep your data encrypted in the cloud provider 19073 using the `crypt` remote. `crypt` uses a similar technique to wrap around 19074 an existing remote and handles this translation in a seamless way. 19075 19076 There is an issue with wrapping the remotes in this order: 19077 **cloud remote** -> **crypt** -> **cache** 19078 19079 During testing, I experienced a lot of bans with the remotes in this order. 19080 I suspect it might be related to how crypt opens files on the cloud provider 19081 which makes it think we're downloading the full file instead of small chunks. 19082 Organizing the remotes in this order yields better results: 19083 **cloud remote** -> **cache** -> **crypt** 19084 19085 #### absolute remote paths #### 19086 19087 `cache` can not differentiate between relative and absolute paths for the wrapped remote. 19088 Any path given in the `remote` config setting and on the command line will be passed to 19089 the wrapped remote as is, but for storing the chunks on disk the path will be made 19090 relative by removing any leading `/` character. 19091 19092 This behavior is irrelevant for most backend types, but there are backends where a leading `/` 19093 changes the effective directory, e.g. in the `sftp` backend paths starting with a `/` are 19094 relative to the root of the SSH server and paths without are relative to the user home directory. 19095 As a result `sftp:bin` and `sftp:/bin` will share the same cache folder, even if they represent 19096 a different directory on the SSH server. 19097 19098 ### Cache and Remote Control (--rc) ### 19099 Cache supports the new `--rc` mode in rclone and can be remote controlled through the following end points: 19100 By default, the listener is disabled if you do not add the flag. 19101 19102 ### rc cache/expire 19103 Purge a remote from the cache backend. Supports either a directory or a file. 19104 It supports both encrypted and unencrypted file names if cache is wrapped by crypt. 19105 19106 Params: 19107 - **remote** = path to remote **(required)** 19108 - **withData** = true/false to delete cached data (chunks) as well _(optional, false by default)_ 19109 19110 19111 ### Standard options 19112 19113 Here are the Standard options specific to cache (Cache a remote). 19114 19115 #### --cache-remote 19116 19117 Remote to cache. 19118 19119 Normally should contain a ':' and a path, e.g. "myremote:path/to/dir", 19120 "myremote:bucket" or maybe "myremote:" (not recommended). 19121 19122 Properties: 19123 19124 - Config: remote 19125 - Env Var: RCLONE_CACHE_REMOTE 19126 - Type: string 19127 - Required: true 19128 19129 #### --cache-plex-url 19130 19131 The URL of the Plex server. 19132 19133 Properties: 19134 19135 - Config: plex_url 19136 - Env Var: RCLONE_CACHE_PLEX_URL 19137 - Type: string 19138 - Required: false 19139 19140 #### --cache-plex-username 19141 19142 The username of the Plex user. 19143 19144 Properties: 19145 19146 - Config: plex_username 19147 - Env Var: RCLONE_CACHE_PLEX_USERNAME 19148 - Type: string 19149 - Required: false 19150 19151 #### --cache-plex-password 19152 19153 The password of the Plex user. 19154 19155 **NB** Input to this must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/). 19156 19157 Properties: 19158 19159 - Config: plex_password 19160 - Env Var: RCLONE_CACHE_PLEX_PASSWORD 19161 - Type: string 19162 - Required: false 19163 19164 #### --cache-chunk-size 19165 19166 The size of a chunk (partial file data). 19167 19168 Use lower numbers for slower connections. If the chunk size is 19169 changed, any downloaded chunks will be invalid and cache-chunk-path 19170 will need to be cleared or unexpected EOF errors will occur. 19171 19172 Properties: 19173 19174 - Config: chunk_size 19175 - Env Var: RCLONE_CACHE_CHUNK_SIZE 19176 - Type: SizeSuffix 19177 - Default: 5Mi 19178 - Examples: 19179 - "1M" 19180 - 1 MiB 19181 - "5M" 19182 - 5 MiB 19183 - "10M" 19184 - 10 MiB 19185 19186 #### --cache-info-age 19187 19188 How long to cache file structure information (directory listings, file size, times, etc.). 19189 If all write operations are done through the cache then you can safely make 19190 this value very large as the cache store will also be updated in real time. 19191 19192 Properties: 19193 19194 - Config: info_age 19195 - Env Var: RCLONE_CACHE_INFO_AGE 19196 - Type: Duration 19197 - Default: 6h0m0s 19198 - Examples: 19199 - "1h" 19200 - 1 hour 19201 - "24h" 19202 - 24 hours 19203 - "48h" 19204 - 48 hours 19205 19206 #### --cache-chunk-total-size 19207 19208 The total size that the chunks can take up on the local disk. 19209 19210 If the cache exceeds this value then it will start to delete the 19211 oldest chunks until it goes under this value. 19212 19213 Properties: 19214 19215 - Config: chunk_total_size 19216 - Env Var: RCLONE_CACHE_CHUNK_TOTAL_SIZE 19217 - Type: SizeSuffix 19218 - Default: 10Gi 19219 - Examples: 19220 - "500M" 19221 - 500 MiB 19222 - "1G" 19223 - 1 GiB 19224 - "10G" 19225 - 10 GiB 19226 19227 ### Advanced options 19228 19229 Here are the Advanced options specific to cache (Cache a remote). 19230 19231 #### --cache-plex-token 19232 19233 The plex token for authentication - auto set normally. 19234 19235 Properties: 19236 19237 - Config: plex_token 19238 - Env Var: RCLONE_CACHE_PLEX_TOKEN 19239 - Type: string 19240 - Required: false 19241 19242 #### --cache-plex-insecure 19243 19244 Skip all certificate verification when connecting to the Plex server. 19245 19246 Properties: 19247 19248 - Config: plex_insecure 19249 - Env Var: RCLONE_CACHE_PLEX_INSECURE 19250 - Type: string 19251 - Required: false 19252 19253 #### --cache-db-path 19254 19255 Directory to store file structure metadata DB. 19256 19257 The remote name is used as the DB file name. 19258 19259 Properties: 19260 19261 - Config: db_path 19262 - Env Var: RCLONE_CACHE_DB_PATH 19263 - Type: string 19264 - Default: "$HOME/.cache/rclone/cache-backend" 19265 19266 #### --cache-chunk-path 19267 19268 Directory to cache chunk files. 19269 19270 Path to where partial file data (chunks) are stored locally. The remote 19271 name is appended to the final path. 19272 19273 This config follows the "--cache-db-path". If you specify a custom 19274 location for "--cache-db-path" and don't specify one for "--cache-chunk-path" 19275 then "--cache-chunk-path" will use the same path as "--cache-db-path". 19276 19277 Properties: 19278 19279 - Config: chunk_path 19280 - Env Var: RCLONE_CACHE_CHUNK_PATH 19281 - Type: string 19282 - Default: "$HOME/.cache/rclone/cache-backend" 19283 19284 #### --cache-db-purge 19285 19286 Clear all the cached data for this remote on start. 19287 19288 Properties: 19289 19290 - Config: db_purge 19291 - Env Var: RCLONE_CACHE_DB_PURGE 19292 - Type: bool 19293 - Default: false 19294 19295 #### --cache-chunk-clean-interval 19296 19297 How often should the cache perform cleanups of the chunk storage. 19298 19299 The default value should be ok for most people. If you find that the 19300 cache goes over "cache-chunk-total-size" too often then try to lower 19301 this value to force it to perform cleanups more often. 19302 19303 Properties: 19304 19305 - Config: chunk_clean_interval 19306 - Env Var: RCLONE_CACHE_CHUNK_CLEAN_INTERVAL 19307 - Type: Duration 19308 - Default: 1m0s 19309 19310 #### --cache-read-retries 19311 19312 How many times to retry a read from a cache storage. 19313 19314 Since reading from a cache stream is independent from downloading file 19315 data, readers can get to a point where there's no more data in the 19316 cache. Most of the times this can indicate a connectivity issue if 19317 cache isn't able to provide file data anymore. 19318 19319 For really slow connections, increase this to a point where the stream is 19320 able to provide data but your experience will be very stuttering. 19321 19322 Properties: 19323 19324 - Config: read_retries 19325 - Env Var: RCLONE_CACHE_READ_RETRIES 19326 - Type: int 19327 - Default: 10 19328 19329 #### --cache-workers 19330 19331 How many workers should run in parallel to download chunks. 19332 19333 Higher values will mean more parallel processing (better CPU needed) 19334 and more concurrent requests on the cloud provider. This impacts 19335 several aspects like the cloud provider API limits, more stress on the 19336 hardware that rclone runs on but it also means that streams will be 19337 more fluid and data will be available much more faster to readers. 19338 19339 **Note**: If the optional Plex integration is enabled then this 19340 setting will adapt to the type of reading performed and the value 19341 specified here will be used as a maximum number of workers to use. 19342 19343 Properties: 19344 19345 - Config: workers 19346 - Env Var: RCLONE_CACHE_WORKERS 19347 - Type: int 19348 - Default: 4 19349 19350 #### --cache-chunk-no-memory 19351 19352 Disable the in-memory cache for storing chunks during streaming. 19353 19354 By default, cache will keep file data during streaming in RAM as well 19355 to provide it to readers as fast as possible. 19356 19357 This transient data is evicted as soon as it is read and the number of 19358 chunks stored doesn't exceed the number of workers. However, depending 19359 on other settings like "cache-chunk-size" and "cache-workers" this footprint 19360 can increase if there are parallel streams too (multiple files being read 19361 at the same time). 19362 19363 If the hardware permits it, use this feature to provide an overall better 19364 performance during streaming but it can also be disabled if RAM is not 19365 available on the local machine. 19366 19367 Properties: 19368 19369 - Config: chunk_no_memory 19370 - Env Var: RCLONE_CACHE_CHUNK_NO_MEMORY 19371 - Type: bool 19372 - Default: false 19373 19374 #### --cache-rps 19375 19376 Limits the number of requests per second to the source FS (-1 to disable). 19377 19378 This setting places a hard limit on the number of requests per second 19379 that cache will be doing to the cloud provider remote and try to 19380 respect that value by setting waits between reads. 19381 19382 If you find that you're getting banned or limited on the cloud 19383 provider through cache and know that a smaller number of requests per 19384 second will allow you to work with it then you can use this setting 19385 for that. 19386 19387 A good balance of all the other settings should make this setting 19388 useless but it is available to set for more special cases. 19389 19390 **NOTE**: This will limit the number of requests during streams but 19391 other API calls to the cloud provider like directory listings will 19392 still pass. 19393 19394 Properties: 19395 19396 - Config: rps 19397 - Env Var: RCLONE_CACHE_RPS 19398 - Type: int 19399 - Default: -1 19400 19401 #### --cache-writes 19402 19403 Cache file data on writes through the FS. 19404 19405 If you need to read files immediately after you upload them through 19406 cache you can enable this flag to have their data stored in the 19407 cache store at the same time during upload. 19408 19409 Properties: 19410 19411 - Config: writes 19412 - Env Var: RCLONE_CACHE_WRITES 19413 - Type: bool 19414 - Default: false 19415 19416 #### --cache-tmp-upload-path 19417 19418 Directory to keep temporary files until they are uploaded. 19419 19420 This is the path where cache will use as a temporary storage for new 19421 files that need to be uploaded to the cloud provider. 19422 19423 Specifying a value will enable this feature. Without it, it is 19424 completely disabled and files will be uploaded directly to the cloud 19425 provider 19426 19427 Properties: 19428 19429 - Config: tmp_upload_path 19430 - Env Var: RCLONE_CACHE_TMP_UPLOAD_PATH 19431 - Type: string 19432 - Required: false 19433 19434 #### --cache-tmp-wait-time 19435 19436 How long should files be stored in local cache before being uploaded. 19437 19438 This is the duration that a file must wait in the temporary location 19439 _cache-tmp-upload-path_ before it is selected for upload. 19440 19441 Note that only one file is uploaded at a time and it can take longer 19442 to start the upload if a queue formed for this purpose. 19443 19444 Properties: 19445 19446 - Config: tmp_wait_time 19447 - Env Var: RCLONE_CACHE_TMP_WAIT_TIME 19448 - Type: Duration 19449 - Default: 15s 19450 19451 #### --cache-db-wait-time 19452 19453 How long to wait for the DB to be available - 0 is unlimited. 19454 19455 Only one process can have the DB open at any one time, so rclone waits 19456 for this duration for the DB to become available before it gives an 19457 error. 19458 19459 If you set it to 0 then it will wait forever. 19460 19461 Properties: 19462 19463 - Config: db_wait_time 19464 - Env Var: RCLONE_CACHE_DB_WAIT_TIME 19465 - Type: Duration 19466 - Default: 1s 19467 19468 #### --cache-description 19469 19470 Description of the remote 19471 19472 Properties: 19473 19474 - Config: description 19475 - Env Var: RCLONE_CACHE_DESCRIPTION 19476 - Type: string 19477 - Required: false 19478 19479 ## Backend commands 19480 19481 Here are the commands specific to the cache backend. 19482 19483 Run them with 19484 19485 rclone backend COMMAND remote: 19486 19487 The help below will explain what arguments each command takes. 19488 19489 See the [backend](https://rclone.org/commands/rclone_backend/) command for more 19490 info on how to pass options and arguments. 19491 19492 These can be run on a running backend using the rc command 19493 [backend/command](https://rclone.org/rc/#backend-command). 19494 19495 ### stats 19496 19497 Print stats on the cache backend in JSON format. 19498 19499 rclone backend stats remote: [options] [<arguments>+] 19500 19501 19502 19503 # Chunker 19504 19505 The `chunker` overlay transparently splits large files into smaller chunks 19506 during upload to wrapped remote and transparently assembles them back 19507 when the file is downloaded. This allows to effectively overcome size limits 19508 imposed by storage providers. 19509 19510 ## Configuration 19511 19512 To use it, first set up the underlying remote following the configuration 19513 instructions for that remote. You can also use a local pathname instead of 19514 a remote. 19515 19516 First check your chosen remote is working - we'll call it `remote:path` here. 19517 Note that anything inside `remote:path` will be chunked and anything outside 19518 won't. This means that if you are using a bucket-based remote (e.g. S3, B2, swift) 19519 then you should probably put the bucket in the remote `s3:bucket`. 19520 19521 Now configure `chunker` using `rclone config`. We will call this one `overlay` 19522 to separate it from the `remote` itself. 19523 </code></pre> 19524 <p>No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n name> overlay Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Transparently chunk/split large files "chunker" [snip] Storage> chunker Remote to chunk/unchunk. Normally should contain a ':' and a path, e.g. "myremote:path/to/dir", "myremote:bucket" or maybe "myremote:" (not recommended). Enter a string value. Press Enter for the default (""). remote> remote:path Files larger than chunk size will be split in chunks. Enter a size with suffix K,M,G,T. Press Enter for the default ("2G"). chunk_size> 100M Choose how chunker handles hash sums. All modes but "none" require metadata. Enter a string value. Press Enter for the default ("md5"). Choose a number from below, or type in your own value 1 / Pass any hash supported by wrapped remote for non-chunked files, return nothing otherwise "none" 2 / MD5 for composite files "md5" 3 / SHA1 for composite files "sha1" 4 / MD5 for all files "md5all" 5 / SHA1 for all files "sha1all" 6 / Copying a file to chunker will request MD5 from the source falling back to SHA1 if unsupported "md5quick" 7 / Similar to "md5quick" but prefers SHA1 over MD5 "sha1quick" hash_type> md5 Edit advanced config? (y/n) y) Yes n) No y/n> n Remote config -------------------- [overlay] type = chunker remote = remote:bucket chunk_size = 100M hash_type = md5 -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y</p> 19525 <pre><code> 19526 ### Specifying the remote 19527 19528 In normal use, make sure the remote has a `:` in. If you specify the remote 19529 without a `:` then rclone will use a local directory of that name. 19530 So if you use a remote of `/path/to/secret/files` then rclone will 19531 chunk stuff in that directory. If you use a remote of `name` then rclone 19532 will put files in a directory called `name` in the current directory. 19533 19534 19535 ### Chunking 19536 19537 When rclone starts a file upload, chunker checks the file size. If it 19538 doesn't exceed the configured chunk size, chunker will just pass the file 19539 to the wrapped remote (however, see caveat below). If a file is large, chunker will transparently cut 19540 data in pieces with temporary names and stream them one by one, on the fly. 19541 Each data chunk will contain the specified number of bytes, except for the 19542 last one which may have less data. If file size is unknown in advance 19543 (this is called a streaming upload), chunker will internally create 19544 a temporary copy, record its size and repeat the above process. 19545 19546 When upload completes, temporary chunk files are finally renamed. 19547 This scheme guarantees that operations can be run in parallel and look 19548 from outside as atomic. 19549 A similar method with hidden temporary chunks is used for other operations 19550 (copy/move/rename, etc.). If an operation fails, hidden chunks are normally 19551 destroyed, and the target composite file stays intact. 19552 19553 When a composite file download is requested, chunker transparently 19554 assembles it by concatenating data chunks in order. As the split is trivial 19555 one could even manually concatenate data chunks together to obtain the 19556 original content. 19557 19558 When the `list` rclone command scans a directory on wrapped remote, 19559 the potential chunk files are accounted for, grouped and assembled into 19560 composite directory entries. Any temporary chunks are hidden. 19561 19562 List and other commands can sometimes come across composite files with 19563 missing or invalid chunks, e.g. shadowed by like-named directory or 19564 another file. This usually means that wrapped file system has been directly 19565 tampered with or damaged. If chunker detects a missing chunk it will 19566 by default print warning, skip the whole incomplete group of chunks but 19567 proceed with current command. 19568 You can set the `--chunker-fail-hard` flag to have commands abort with 19569 error message in such cases. 19570 19571 **Caveat**: As it is now, chunker will always create a temporary file in the 19572 backend and then rename it, even if the file is below the chunk threshold. 19573 This will result in unnecessary API calls and can severely restrict throughput 19574 when handling transfers primarily composed of small files on some backends (e.g. Box). 19575 A workaround to this issue is to use chunker only for files above the chunk threshold 19576 via `--min-size` and then perform a separate call without chunker on the remaining 19577 files. 19578 19579 19580 #### Chunk names 19581 19582 The default chunk name format is `*.rclone_chunk.###`, hence by default 19583 chunk names are `BIG_FILE_NAME.rclone_chunk.001`, 19584 `BIG_FILE_NAME.rclone_chunk.002` etc. You can configure another name format 19585 using the `name_format` configuration file option. The format uses asterisk 19586 `*` as a placeholder for the base file name and one or more consecutive 19587 hash characters `#` as a placeholder for sequential chunk number. 19588 There must be one and only one asterisk. The number of consecutive hash 19589 characters defines the minimum length of a string representing a chunk number. 19590 If decimal chunk number has less digits than the number of hashes, it is 19591 left-padded by zeros. If the decimal string is longer, it is left intact. 19592 By default numbering starts from 1 but there is another option that allows 19593 user to start from 0, e.g. for compatibility with legacy software. 19594 19595 For example, if name format is `big_*-##.part` and original file name is 19596 `data.txt` and numbering starts from 0, then the first chunk will be named 19597 `big_data.txt-00.part`, the 99th chunk will be `big_data.txt-98.part` 19598 and the 302nd chunk will become `big_data.txt-301.part`. 19599 19600 Note that `list` assembles composite directory entries only when chunk names 19601 match the configured format and treats non-conforming file names as normal 19602 non-chunked files. 19603 19604 When using `norename` transactions, chunk names will additionally have a unique 19605 file version suffix. For example, `BIG_FILE_NAME.rclone_chunk.001_bp562k`. 19606 19607 19608 ### Metadata 19609 19610 Besides data chunks chunker will by default create metadata object for 19611 a composite file. The object is named after the original file. 19612 Chunker allows user to disable metadata completely (the `none` format). 19613 Note that metadata is normally not created for files smaller than the 19614 configured chunk size. This may change in future rclone releases. 19615 19616 #### Simple JSON metadata format 19617 19618 This is the default format. It supports hash sums and chunk validation 19619 for composite files. Meta objects carry the following fields: 19620 19621 - `ver` - version of format, currently `1` 19622 - `size` - total size of composite file 19623 - `nchunks` - number of data chunks in file 19624 - `md5` - MD5 hashsum of composite file (if present) 19625 - `sha1` - SHA1 hashsum (if present) 19626 - `txn` - identifies current version of the file 19627 19628 There is no field for composite file name as it's simply equal to the name 19629 of meta object on the wrapped remote. Please refer to respective sections 19630 for details on hashsums and modified time handling. 19631 19632 #### No metadata 19633 19634 You can disable meta objects by setting the meta format option to `none`. 19635 In this mode chunker will scan directory for all files that follow 19636 configured chunk name format, group them by detecting chunks with the same 19637 base name and show group names as virtual composite files. 19638 This method is more prone to missing chunk errors (especially missing 19639 last chunk) than format with metadata enabled. 19640 19641 19642 ### Hashsums 19643 19644 Chunker supports hashsums only when a compatible metadata is present. 19645 Hence, if you choose metadata format of `none`, chunker will report hashsum 19646 as `UNSUPPORTED`. 19647 19648 Please note that by default metadata is stored only for composite files. 19649 If a file is smaller than configured chunk size, chunker will transparently 19650 redirect hash requests to wrapped remote, so support depends on that. 19651 You will see the empty string as a hashsum of requested type for small 19652 files if the wrapped remote doesn't support it. 19653 19654 Many storage backends support MD5 and SHA1 hash types, so does chunker. 19655 With chunker you can choose one or another but not both. 19656 MD5 is set by default as the most supported type. 19657 Since chunker keeps hashes for composite files and falls back to the 19658 wrapped remote hash for non-chunked ones, we advise you to choose the same 19659 hash type as supported by wrapped remote so that your file listings 19660 look coherent. 19661 19662 If your storage backend does not support MD5 or SHA1 but you need consistent 19663 file hashing, configure chunker with `md5all` or `sha1all`. These two modes 19664 guarantee given hash for all files. If wrapped remote doesn't support it, 19665 chunker will then add metadata to all files, even small. However, this can 19666 double the amount of small files in storage and incur additional service charges. 19667 You can even use chunker to force md5/sha1 support in any other remote 19668 at expense of sidecar meta objects by setting e.g. `hash_type=sha1all` 19669 to force hashsums and `chunk_size=1P` to effectively disable chunking. 19670 19671 Normally, when a file is copied to chunker controlled remote, chunker 19672 will ask the file source for compatible file hash and revert to on-the-fly 19673 calculation if none is found. This involves some CPU overhead but provides 19674 a guarantee that given hashsum is available. Also, chunker will reject 19675 a server-side copy or move operation if source and destination hashsum 19676 types are different resulting in the extra network bandwidth, too. 19677 In some rare cases this may be undesired, so chunker provides two optional 19678 choices: `sha1quick` and `md5quick`. If the source does not support primary 19679 hash type and the quick mode is enabled, chunker will try to fall back to 19680 the secondary type. This will save CPU and bandwidth but can result in empty 19681 hashsums at destination. Beware of consequences: the `sync` command will 19682 revert (sometimes silently) to time/size comparison if compatible hashsums 19683 between source and target are not found. 19684 19685 19686 ### Modification times 19687 19688 Chunker stores modification times using the wrapped remote so support 19689 depends on that. For a small non-chunked file the chunker overlay simply 19690 manipulates modification time of the wrapped remote file. 19691 For a composite file with metadata chunker will get and set 19692 modification time of the metadata object on the wrapped remote. 19693 If file is chunked but metadata format is `none` then chunker will 19694 use modification time of the first data chunk. 19695 19696 19697 ### Migrations 19698 19699 The idiomatic way to migrate to a different chunk size, hash type, transaction 19700 style or chunk naming scheme is to: 19701 19702 - Collect all your chunked files under a directory and have your 19703 chunker remote point to it. 19704 - Create another directory (most probably on the same cloud storage) 19705 and configure a new remote with desired metadata format, 19706 hash type, chunk naming etc. 19707 - Now run `rclone sync --interactive oldchunks: newchunks:` and all your data 19708 will be transparently converted in transfer. 19709 This may take some time, yet chunker will try server-side 19710 copy if possible. 19711 - After checking data integrity you may remove configuration section 19712 of the old remote. 19713 19714 If rclone gets killed during a long operation on a big composite file, 19715 hidden temporary chunks may stay in the directory. They will not be 19716 shown by the `list` command but will eat up your account quota. 19717 Please note that the `deletefile` command deletes only active 19718 chunks of a file. As a workaround, you can use remote of the wrapped 19719 file system to see them. 19720 An easy way to get rid of hidden garbage is to copy littered directory 19721 somewhere using the chunker remote and purge the original directory. 19722 The `copy` command will copy only active chunks while the `purge` will 19723 remove everything including garbage. 19724 19725 19726 ### Caveats and Limitations 19727 19728 Chunker requires wrapped remote to support server-side `move` (or `copy` + 19729 `delete`) operations, otherwise it will explicitly refuse to start. 19730 This is because it internally renames temporary chunk files to their final 19731 names when an operation completes successfully. 19732 19733 Chunker encodes chunk number in file name, so with default `name_format` 19734 setting it adds 17 characters. Also chunker adds 7 characters of temporary 19735 suffix during operations. Many file systems limit base file name without path 19736 by 255 characters. Using rclone's crypt remote as a base file system limits 19737 file name by 143 characters. Thus, maximum name length is 231 for most files 19738 and 119 for chunker-over-crypt. A user in need can change name format to 19739 e.g. `*.rcc##` and save 10 characters (provided at most 99 chunks per file). 19740 19741 Note that a move implemented using the copy-and-delete method may incur 19742 double charging with some cloud storage providers. 19743 19744 Chunker will not automatically rename existing chunks when you run 19745 `rclone config` on a live remote and change the chunk name format. 19746 Beware that in result of this some files which have been treated as chunks 19747 before the change can pop up in directory listings as normal files 19748 and vice versa. The same warning holds for the chunk size. 19749 If you desperately need to change critical chunking settings, you should 19750 run data migration as described above. 19751 19752 If wrapped remote is case insensitive, the chunker overlay will inherit 19753 that property (so you can't have a file called "Hello.doc" and "hello.doc" 19754 in the same directory). 19755 19756 Chunker included in rclone releases up to `v1.54` can sometimes fail to 19757 detect metadata produced by recent versions of rclone. We recommend users 19758 to keep rclone up-to-date to avoid data corruption. 19759 19760 Changing `transactions` is dangerous and requires explicit migration. 19761 19762 19763 ### Standard options 19764 19765 Here are the Standard options specific to chunker (Transparently chunk/split large files). 19766 19767 #### --chunker-remote 19768 19769 Remote to chunk/unchunk. 19770 19771 Normally should contain a ':' and a path, e.g. "myremote:path/to/dir", 19772 "myremote:bucket" or maybe "myremote:" (not recommended). 19773 19774 Properties: 19775 19776 - Config: remote 19777 - Env Var: RCLONE_CHUNKER_REMOTE 19778 - Type: string 19779 - Required: true 19780 19781 #### --chunker-chunk-size 19782 19783 Files larger than chunk size will be split in chunks. 19784 19785 Properties: 19786 19787 - Config: chunk_size 19788 - Env Var: RCLONE_CHUNKER_CHUNK_SIZE 19789 - Type: SizeSuffix 19790 - Default: 2Gi 19791 19792 #### --chunker-hash-type 19793 19794 Choose how chunker handles hash sums. 19795 19796 All modes but "none" require metadata. 19797 19798 Properties: 19799 19800 - Config: hash_type 19801 - Env Var: RCLONE_CHUNKER_HASH_TYPE 19802 - Type: string 19803 - Default: "md5" 19804 - Examples: 19805 - "none" 19806 - Pass any hash supported by wrapped remote for non-chunked files. 19807 - Return nothing otherwise. 19808 - "md5" 19809 - MD5 for composite files. 19810 - "sha1" 19811 - SHA1 for composite files. 19812 - "md5all" 19813 - MD5 for all files. 19814 - "sha1all" 19815 - SHA1 for all files. 19816 - "md5quick" 19817 - Copying a file to chunker will request MD5 from the source. 19818 - Falling back to SHA1 if unsupported. 19819 - "sha1quick" 19820 - Similar to "md5quick" but prefers SHA1 over MD5. 19821 19822 ### Advanced options 19823 19824 Here are the Advanced options specific to chunker (Transparently chunk/split large files). 19825 19826 #### --chunker-name-format 19827 19828 String format of chunk file names. 19829 19830 The two placeholders are: base file name (*) and chunk number (#...). 19831 There must be one and only one asterisk and one or more consecutive hash characters. 19832 If chunk number has less digits than the number of hashes, it is left-padded by zeros. 19833 If there are more digits in the number, they are left as is. 19834 Possible chunk files are ignored if their name does not match given format. 19835 19836 Properties: 19837 19838 - Config: name_format 19839 - Env Var: RCLONE_CHUNKER_NAME_FORMAT 19840 - Type: string 19841 - Default: "*.rclone_chunk.###" 19842 19843 #### --chunker-start-from 19844 19845 Minimum valid chunk number. Usually 0 or 1. 19846 19847 By default chunk numbers start from 1. 19848 19849 Properties: 19850 19851 - Config: start_from 19852 - Env Var: RCLONE_CHUNKER_START_FROM 19853 - Type: int 19854 - Default: 1 19855 19856 #### --chunker-meta-format 19857 19858 Format of the metadata object or "none". 19859 19860 By default "simplejson". 19861 Metadata is a small JSON file named after the composite file. 19862 19863 Properties: 19864 19865 - Config: meta_format 19866 - Env Var: RCLONE_CHUNKER_META_FORMAT 19867 - Type: string 19868 - Default: "simplejson" 19869 - Examples: 19870 - "none" 19871 - Do not use metadata files at all. 19872 - Requires hash type "none". 19873 - "simplejson" 19874 - Simple JSON supports hash sums and chunk validation. 19875 - 19876 - It has the following fields: ver, size, nchunks, md5, sha1. 19877 19878 #### --chunker-fail-hard 19879 19880 Choose how chunker should handle files with missing or invalid chunks. 19881 19882 Properties: 19883 19884 - Config: fail_hard 19885 - Env Var: RCLONE_CHUNKER_FAIL_HARD 19886 - Type: bool 19887 - Default: false 19888 - Examples: 19889 - "true" 19890 - Report errors and abort current command. 19891 - "false" 19892 - Warn user, skip incomplete file and proceed. 19893 19894 #### --chunker-transactions 19895 19896 Choose how chunker should handle temporary files during transactions. 19897 19898 Properties: 19899 19900 - Config: transactions 19901 - Env Var: RCLONE_CHUNKER_TRANSACTIONS 19902 - Type: string 19903 - Default: "rename" 19904 - Examples: 19905 - "rename" 19906 - Rename temporary files after a successful transaction. 19907 - "norename" 19908 - Leave temporary file names and write transaction ID to metadata file. 19909 - Metadata is required for no rename transactions (meta format cannot be "none"). 19910 - If you are using norename transactions you should be careful not to downgrade Rclone 19911 - as older versions of Rclone don't support this transaction style and will misinterpret 19912 - files manipulated by norename transactions. 19913 - This method is EXPERIMENTAL, don't use on production systems. 19914 - "auto" 19915 - Rename or norename will be used depending on capabilities of the backend. 19916 - If meta format is set to "none", rename transactions will always be used. 19917 - This method is EXPERIMENTAL, don't use on production systems. 19918 19919 #### --chunker-description 19920 19921 Description of the remote 19922 19923 Properties: 19924 19925 - Config: description 19926 - Env Var: RCLONE_CHUNKER_DESCRIPTION 19927 - Type: string 19928 - Required: false 19929 19930 19931 19932 # Citrix ShareFile 19933 19934 [Citrix ShareFile](https://sharefile.com) is a secure file sharing and transfer service aimed as business. 19935 19936 ## Configuration 19937 19938 The initial setup for Citrix ShareFile involves getting a token from 19939 Citrix ShareFile which you can in your browser. `rclone config` walks you 19940 through it. 19941 19942 Here is an example of how to make a remote called `remote`. First run: 19943 19944 rclone config 19945 19946 This will guide you through an interactive setup process: 19947 </code></pre> 19948 <p>No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n name> remote Type of storage to configure. Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value XX / Citrix Sharefile "sharefile" Storage> sharefile ** See help for sharefile backend at: https://rclone.org/sharefile/ **</p> 19949 <p>ID of the root folder</p> 19950 <p>Leave blank to access "Personal Folders". You can use one of the standard values here or any folder ID (long hex number ID). Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value 1 / Access the Personal Folders. (Default) "" 2 / Access the Favorites folder. "favorites" 3 / Access all the shared folders. "allshared" 4 / Access all the individual connectors. "connectors" 5 / Access the home, favorites, and shared folders as well as the connectors. "top" root_folder_id> Edit advanced config? (y/n) y) Yes n) No y/n> n Remote config Use web browser to automatically authenticate rclone with remote? * Say Y if the machine running rclone has a web browser you can use * Say N if running rclone on a (remote) machine without web browser access If not sure try Y. If Y failed, try N. y) Yes n) No y/n> y If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth?state=XXX Log in and authorize rclone for access Waiting for code... Got code -------------------- [remote] type = sharefile endpoint = https://XXX.sharefile.com token = {"access_token":"XXX","token_type":"bearer","refresh_token":"XXX","expiry":"2019-09-30T19:41:45.878561877+01:00"} -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y</p> 19951 <pre><code> 19952 See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a 19953 machine with no Internet browser available. 19954 19955 Note that rclone runs a webserver on your local machine to collect the 19956 token as returned from Citrix ShareFile. This only runs from the moment it opens 19957 your browser to the moment you get back the verification code. This 19958 is on `http://127.0.0.1:53682/` and this it may require you to unblock 19959 it temporarily if you are running a host firewall. 19960 19961 Once configured you can then use `rclone` like this, 19962 19963 List directories in top level of your ShareFile 19964 19965 rclone lsd remote: 19966 19967 List all the files in your ShareFile 19968 19969 rclone ls remote: 19970 19971 To copy a local directory to an ShareFile directory called backup 19972 19973 rclone copy /home/source remote:backup 19974 19975 Paths may be as deep as required, e.g. `remote:directory/subdirectory`. 19976 19977 ### Modification times and hashes 19978 19979 ShareFile allows modification times to be set on objects accurate to 1 19980 second. These will be used to detect whether objects need syncing or 19981 not. 19982 19983 ShareFile supports MD5 type hashes, so you can use the `--checksum` 19984 flag. 19985 19986 ### Transfers 19987 19988 For files above 128 MiB rclone will use a chunked transfer. Rclone will 19989 upload up to `--transfers` chunks at the same time (shared among all 19990 the multipart uploads). Chunks are buffered in memory and are 19991 normally 64 MiB so increasing `--transfers` will increase memory use. 19992 19993 ### Restricted filename characters 19994 19995 In addition to the [default restricted characters set](https://rclone.org/overview/#restricted-characters) 19996 the following characters are also replaced: 19997 19998 | Character | Value | Replacement | 19999 | --------- |:-----:|:-----------:| 20000 | \\ | 0x5C | ＼ | 20001 | * | 0x2A | ＊ | 20002 | < | 0x3C | ＜ | 20003 | > | 0x3E | ＞ | 20004 | ? | 0x3F | ？ | 20005 | : | 0x3A | ： | 20006 | \| | 0x7C | ｜ | 20007 | " | 0x22 | ＂ | 20008 20009 File names can also not start or end with the following characters. 20010 These only get replaced if they are the first or last character in the 20011 name: 20012 20013 | Character | Value | Replacement | 20014 | --------- |:-----:|:-----------:| 20015 | SP | 0x20 | ␠ | 20016 | . | 0x2E | ． | 20017 20018 Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8), 20019 as they can't be used in JSON strings. 20020 20021 20022 ### Standard options 20023 20024 Here are the Standard options specific to sharefile (Citrix Sharefile). 20025 20026 #### --sharefile-client-id 20027 20028 OAuth Client Id. 20029 20030 Leave blank normally. 20031 20032 Properties: 20033 20034 - Config: client_id 20035 - Env Var: RCLONE_SHAREFILE_CLIENT_ID 20036 - Type: string 20037 - Required: false 20038 20039 #### --sharefile-client-secret 20040 20041 OAuth Client Secret. 20042 20043 Leave blank normally. 20044 20045 Properties: 20046 20047 - Config: client_secret 20048 - Env Var: RCLONE_SHAREFILE_CLIENT_SECRET 20049 - Type: string 20050 - Required: false 20051 20052 #### --sharefile-root-folder-id 20053 20054 ID of the root folder. 20055 20056 Leave blank to access "Personal Folders". You can use one of the 20057 standard values here or any folder ID (long hex number ID). 20058 20059 Properties: 20060 20061 - Config: root_folder_id 20062 - Env Var: RCLONE_SHAREFILE_ROOT_FOLDER_ID 20063 - Type: string 20064 - Required: false 20065 - Examples: 20066 - "" 20067 - Access the Personal Folders (default). 20068 - "favorites" 20069 - Access the Favorites folder. 20070 - "allshared" 20071 - Access all the shared folders. 20072 - "connectors" 20073 - Access all the individual connectors. 20074 - "top" 20075 - Access the home, favorites, and shared folders as well as the connectors. 20076 20077 ### Advanced options 20078 20079 Here are the Advanced options specific to sharefile (Citrix Sharefile). 20080 20081 #### --sharefile-token 20082 20083 OAuth Access Token as a JSON blob. 20084 20085 Properties: 20086 20087 - Config: token 20088 - Env Var: RCLONE_SHAREFILE_TOKEN 20089 - Type: string 20090 - Required: false 20091 20092 #### --sharefile-auth-url 20093 20094 Auth server URL. 20095 20096 Leave blank to use the provider defaults. 20097 20098 Properties: 20099 20100 - Config: auth_url 20101 - Env Var: RCLONE_SHAREFILE_AUTH_URL 20102 - Type: string 20103 - Required: false 20104 20105 #### --sharefile-token-url 20106 20107 Token server url. 20108 20109 Leave blank to use the provider defaults. 20110 20111 Properties: 20112 20113 - Config: token_url 20114 - Env Var: RCLONE_SHAREFILE_TOKEN_URL 20115 - Type: string 20116 - Required: false 20117 20118 #### --sharefile-upload-cutoff 20119 20120 Cutoff for switching to multipart upload. 20121 20122 Properties: 20123 20124 - Config: upload_cutoff 20125 - Env Var: RCLONE_SHAREFILE_UPLOAD_CUTOFF 20126 - Type: SizeSuffix 20127 - Default: 128Mi 20128 20129 #### --sharefile-chunk-size 20130 20131 Upload chunk size. 20132 20133 Must a power of 2 >= 256k. 20134 20135 Making this larger will improve performance, but note that each chunk 20136 is buffered in memory one per transfer. 20137 20138 Reducing this will reduce memory usage but decrease performance. 20139 20140 Properties: 20141 20142 - Config: chunk_size 20143 - Env Var: RCLONE_SHAREFILE_CHUNK_SIZE 20144 - Type: SizeSuffix 20145 - Default: 64Mi 20146 20147 #### --sharefile-endpoint 20148 20149 Endpoint for API calls. 20150 20151 This is usually auto discovered as part of the oauth process, but can 20152 be set manually to something like: https://XXX.sharefile.com 20153 20154 20155 Properties: 20156 20157 - Config: endpoint 20158 - Env Var: RCLONE_SHAREFILE_ENDPOINT 20159 - Type: string 20160 - Required: false 20161 20162 #### --sharefile-encoding 20163 20164 The encoding for the backend. 20165 20166 See the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. 20167 20168 Properties: 20169 20170 - Config: encoding 20171 - Env Var: RCLONE_SHAREFILE_ENCODING 20172 - Type: Encoding 20173 - Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot 20174 20175 #### --sharefile-description 20176 20177 Description of the remote 20178 20179 Properties: 20180 20181 - Config: description 20182 - Env Var: RCLONE_SHAREFILE_DESCRIPTION 20183 - Type: string 20184 - Required: false 20185 20186 20187 ## Limitations 20188 20189 Note that ShareFile is case insensitive so you can't have a file called 20190 "Hello.doc" and one called "hello.doc". 20191 20192 ShareFile only supports filenames up to 256 characters in length. 20193 20194 `rclone about` is not supported by the Citrix ShareFile backend. Backends without 20195 this capability cannot determine free space for an rclone mount or 20196 use policy `mfs` (most free space) as a member of an rclone union 20197 remote. 20198 20199 See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features) and [rclone about](https://rclone.org/commands/rclone_about/) 20200 20201 # Crypt 20202 20203 Rclone `crypt` remotes encrypt and decrypt other remotes. 20204 20205 A remote of type `crypt` does not access a [storage system](https://rclone.org/overview/) 20206 directly, but instead wraps another remote, which in turn accesses 20207 the storage system. This is similar to how [alias](https://rclone.org/alias/), 20208 [union](https://rclone.org/union/), [chunker](https://rclone.org/chunker/) 20209 and a few others work. It makes the usage very flexible, as you can 20210 add a layer, in this case an encryption layer, on top of any other 20211 backend, even in multiple layers. Rclone's functionality 20212 can be used as with any other remote, for example you can 20213 [mount](https://rclone.org/commands/rclone_mount/) a crypt remote. 20214 20215 Accessing a storage system through a crypt remote realizes client-side 20216 encryption, which makes it safe to keep your data in a location you do 20217 not trust will not get compromised. 20218 When working against the `crypt` remote, rclone will automatically 20219 encrypt (before uploading) and decrypt (after downloading) on your local 20220 system as needed on the fly, leaving the data encrypted at rest in the 20221 wrapped remote. If you access the storage system using an application 20222 other than rclone, or access the wrapped remote directly using rclone, 20223 there will not be any encryption/decryption: Downloading existing content 20224 will just give you the encrypted (scrambled) format, and anything you 20225 upload will *not* become encrypted. 20226 20227 The encryption is a secret-key encryption (also called symmetric key encryption) 20228 algorithm, where a password (or pass phrase) is used to generate real encryption key. 20229 The password can be supplied by user, or you may chose to let rclone 20230 generate one. It will be stored in the configuration file, in a lightly obscured form. 20231 If you are in an environment where you are not able to keep your configuration 20232 secured, you should add 20233 [configuration encryption](https://rclone.org/docs/#configuration-encryption) 20234 as protection. As long as you have this configuration file, you will be able to 20235 decrypt your data. Without the configuration file, as long as you remember 20236 the password (or keep it in a safe place), you can re-create the configuration 20237 and gain access to the existing data. You may also configure a corresponding 20238 remote in a different installation to access the same data. 20239 See below for guidance to [changing password](#changing-password). 20240 20241 Encryption uses [cryptographic salt](https://en.wikipedia.org/wiki/Salt_(cryptography)), 20242 to permute the encryption key so that the same string may be encrypted in 20243 different ways. When configuring the crypt remote it is optional to enter a salt, 20244 or to let rclone generate a unique salt. If omitted, rclone uses a built-in unique string. 20245 Normally in cryptography, the salt is stored together with the encrypted content, 20246 and do not have to be memorized by the user. This is not the case in rclone, 20247 because rclone does not store any additional information on the remotes. Use of 20248 custom salt is effectively a second password that must be memorized. 20249 20250 [File content](#file-encryption) encryption is performed using 20251 [NaCl SecretBox](https://godoc.org/golang.org/x/crypto/nacl/secretbox), 20252 based on XSalsa20 cipher and Poly1305 for integrity. 20253 [Names](#name-encryption) (file- and directory names) are also encrypted 20254 by default, but this has some implications and is therefore 20255 possible to be turned off. 20256 20257 ## Configuration 20258 20259 Here is an example of how to make a remote called `secret`. 20260 20261 To use `crypt`, first set up the underlying remote. Follow the 20262 `rclone config` instructions for the specific backend. 20263 20264 Before configuring the crypt remote, check the underlying remote is 20265 working. In this example the underlying remote is called `remote`. 20266 We will configure a path `path` within this remote to contain the 20267 encrypted content. Anything inside `remote:path` will be encrypted 20268 and anything outside will not. 20269 20270 Configure `crypt` using `rclone config`. In this example the `crypt` 20271 remote is called `secret`, to differentiate it from the underlying 20272 `remote`. 20273 20274 When you are done you can use the crypt remote named `secret` just 20275 as you would with any other remote, e.g. `rclone copy D:\docs secret:\docs`, 20276 and rclone will encrypt and decrypt as needed on the fly. 20277 If you access the wrapped remote `remote:path` directly you will bypass 20278 the encryption, and anything you read will be in encrypted form, and 20279 anything you write will be unencrypted. To avoid issues it is best to 20280 configure a dedicated path for encrypted content, and access it 20281 exclusively through a crypt remote. 20282 </code></pre> 20283 <p>No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n name> secret Type of storage to configure. Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value [snip] XX / Encrypt/Decrypt a remote "crypt" [snip] Storage> crypt ** See help for crypt backend at: https://rclone.org/crypt/ **</p> 20284 <p>Remote to encrypt/decrypt. Normally should contain a ':' and a path, eg "myremote:path/to/dir", "myremote:bucket" or maybe "myremote:" (not recommended). Enter a string value. Press Enter for the default (""). remote> remote:path How to encrypt the filenames. Enter a string value. Press Enter for the default ("standard"). Choose a number from below, or type in your own value. / Encrypt the filenames. 1 | See the docs for the details. "standard" 2 / Very simple filename obfuscation. "obfuscate" / Don't encrypt the file names. 3 | Adds a ".bin" extension only. "off" filename_encryption> Option to either encrypt directory names or leave them intact.</p> 20285 <p>NB If filename_encryption is "off" then this option will do nothing. Enter a boolean value (true or false). Press Enter for the default ("true"). Choose a number from below, or type in your own value 1 / Encrypt directory names. "true" 2 / Don't encrypt directory names, leave them intact. "false" directory_name_encryption> Password or pass phrase for encryption. y) Yes type in my own password g) Generate random password y/g> y Enter the password: password: Confirm the password: password: Password or pass phrase for salt. Optional but recommended. Should be different to the previous password. y) Yes type in my own password g) Generate random password n) No leave this optional password blank (default) y/g/n> g Password strength in bits. 64 is just about memorable 128 is secure 1024 is the maximum Bits> 128 Your password is: JAsJvRcgR-_veXNfy_sGmQ Use this password? Please note that an obscured version of this password (and not the password itself) will be stored under your configuration file, so keep this generated password in a safe place. y) Yes (default) n) No y/n> Edit advanced config? (y/n) y) Yes n) No (default) y/n> Remote config -------------------- [secret] type = crypt remote = remote:path password = *** ENCRYPTED <strong><em> password2 = </em></strong> ENCRYPTED *** -------------------- y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d></p> 20286 <pre><code> 20287 **Important** The crypt password stored in `rclone.conf` is lightly 20288 obscured. That only protects it from cursory inspection. It is not 20289 secure unless [configuration encryption](https://rclone.org/docs/#configuration-encryption) of `rclone.conf` is specified. 20290 20291 A long passphrase is recommended, or `rclone config` can generate a 20292 random one. 20293 20294 The obscured password is created using AES-CTR with a static key. The 20295 salt is stored verbatim at the beginning of the obscured password. This 20296 static key is shared between all versions of rclone. 20297 20298 If you reconfigure rclone with the same passwords/passphrases 20299 elsewhere it will be compatible, but the obscured version will be different 20300 due to the different salt. 20301 20302 Rclone does not encrypt 20303 20304 * file length - this can be calculated within 16 bytes 20305 * modification time - used for syncing 20306 20307 ### Specifying the remote 20308 20309 When configuring the remote to encrypt/decrypt, you may specify any 20310 string that rclone accepts as a source/destination of other commands. 20311 20312 The primary use case is to specify the path into an already configured 20313 remote (e.g. `remote:path/to/dir` or `remote:bucket`), such that 20314 data in a remote untrusted location can be stored encrypted. 20315 20316 You may also specify a local filesystem path, such as 20317 `/path/to/dir` on Linux, `C:\path\to\dir` on Windows. By creating 20318 a crypt remote pointing to such a local filesystem path, you can 20319 use rclone as a utility for pure local file encryption, for example 20320 to keep encrypted files on a removable USB drive. 20321 20322 **Note**: A string which do not contain a `:` will by rclone be treated 20323 as a relative path in the local filesystem. For example, if you enter 20324 the name `remote` without the trailing `:`, it will be treated as 20325 a subdirectory of the current directory with name "remote". 20326 20327 If a path `remote:path/to/dir` is specified, rclone stores encrypted 20328 files in `path/to/dir` on the remote. With file name encryption, files 20329 saved to `secret:subdir/subfile` are stored in the unencrypted path 20330 `path/to/dir` but the `subdir/subpath` element is encrypted. 20331 20332 The path you specify does not have to exist, rclone will create 20333 it when needed. 20334 20335 If you intend to use the wrapped remote both directly for keeping 20336 unencrypted content, as well as through a crypt remote for encrypted 20337 content, it is recommended to point the crypt remote to a separate 20338 directory within the wrapped remote. If you use a bucket-based storage 20339 system (e.g. Swift, S3, Google Compute Storage, B2) it is generally 20340 advisable to wrap the crypt remote around a specific bucket (`s3:bucket`). 20341 If wrapping around the entire root of the storage (`s3:`), and use the 20342 optional file name encryption, rclone will encrypt the bucket name. 20343 20344 ### Changing password 20345 20346 Should the password, or the configuration file containing a lightly obscured 20347 form of the password, be compromised, you need to re-encrypt your data with 20348 a new password. Since rclone uses secret-key encryption, where the encryption 20349 key is generated directly from the password kept on the client, it is not 20350 possible to change the password/key of already encrypted content. Just changing 20351 the password configured for an existing crypt remote means you will no longer 20352 able to decrypt any of the previously encrypted content. The only possibility 20353 is to re-upload everything via a crypt remote configured with your new password. 20354 20355 Depending on the size of your data, your bandwidth, storage quota etc, there are 20356 different approaches you can take: 20357 - If you have everything in a different location, for example on your local system, 20358 you could remove all of the prior encrypted files, change the password for your 20359 configured crypt remote (or delete and re-create the crypt configuration), 20360 and then re-upload everything from the alternative location. 20361 - If you have enough space on the storage system you can create a new crypt 20362 remote pointing to a separate directory on the same backend, and then use 20363 rclone to copy everything from the original crypt remote to the new, 20364 effectively decrypting everything on the fly using the old password and 20365 re-encrypting using the new password. When done, delete the original crypt 20366 remote directory and finally the rclone crypt configuration with the old password. 20367 All data will be streamed from the storage system and back, so you will 20368 get half the bandwidth and be charged twice if you have upload and download quota 20369 on the storage system. 20370 20371 **Note**: A security problem related to the random password generator 20372 was fixed in rclone version 1.53.3 (released 2020-11-19). Passwords generated 20373 by rclone config in version 1.49.0 (released 2019-08-26) to 1.53.2 20374 (released 2020-10-26) are not considered secure and should be changed. 20375 If you made up your own password, or used rclone version older than 1.49.0 or 20376 newer than 1.53.2 to generate it, you are *not* affected by this issue. 20377 See [issue #4783](https://github.com/rclone/rclone/issues/4783) for more 20378 details, and a tool you can use to check if you are affected. 20379 20380 ### Example 20381 20382 Create the following file structure using "standard" file name 20383 encryption. 20384 </code></pre> 20385 <p>plaintext/ ├── file0.txt ├── file1.txt └── subdir ├── file2.txt ├── file3.txt └── subsubdir └── file4.txt</p> 20386 <pre><code> 20387 Copy these to the remote, and list them 20388 </code></pre> 20389 <p>$ rclone -q copy plaintext secret: $ rclone -q ls secret: 7 file1.txt 6 file0.txt 8 subdir/file2.txt 10 subdir/subsubdir/file4.txt 9 subdir/file3.txt</p> 20390 <pre><code> 20391 The crypt remote looks like 20392 </code></pre> 20393 <p>$ rclone -q ls remote:path 55 hagjclgavj2mbiqm6u6cnjjqcg 54 v05749mltvv1tf4onltun46gls 57 86vhrsv86mpbtd3a0akjuqslj8/dlj7fkq4kdq72emafg7a7s41uo 58 86vhrsv86mpbtd3a0akjuqslj8/7uu829995du6o42n32otfhjqp4/b9pausrfansjth5ob3jkdqd4lc 56 86vhrsv86mpbtd3a0akjuqslj8/8njh1sk437gttmep3p70g81aps</p> 20394 <pre><code> 20395 The directory structure is preserved 20396 </code></pre> 20397 <p>$ rclone -q ls secret:subdir 8 file2.txt 9 file3.txt 10 subsubdir/file4.txt</p> 20398 <pre><code> 20399 Without file name encryption `.bin` extensions are added to underlying 20400 names. This prevents the cloud provider attempting to interpret file 20401 content. 20402 </code></pre> 20403 <p>$ rclone -q ls remote:path 54 file0.txt.bin 57 subdir/file3.txt.bin 56 subdir/file2.txt.bin 58 subdir/subsubdir/file4.txt.bin 55 file1.txt.bin</p> 20404 <pre><code> 20405 ### File name encryption modes 20406 20407 Off 20408 20409 * doesn't hide file names or directory structure 20410 * allows for longer file names (~246 characters) 20411 * can use sub paths and copy single files 20412 20413 Standard 20414 20415 * file names encrypted 20416 * file names can't be as long (~143 characters) 20417 * can use sub paths and copy single files 20418 * directory structure visible 20419 * identical files names will have identical uploaded names 20420 * can use shortcuts to shorten the directory recursion 20421 20422 Obfuscation 20423 20424 This is a simple "rotate" of the filename, with each file having a rot 20425 distance based on the filename. Rclone stores the distance at the 20426 beginning of the filename. A file called "hello" may become "53.jgnnq". 20427 20428 Obfuscation is not a strong encryption of filenames, but hinders 20429 automated scanning tools picking up on filename patterns. It is an 20430 intermediate between "off" and "standard" which allows for longer path 20431 segment names. 20432 20433 There is a possibility with some unicode based filenames that the 20434 obfuscation is weak and may map lower case characters to upper case 20435 equivalents. 20436 20437 Obfuscation cannot be relied upon for strong protection. 20438 20439 * file names very lightly obfuscated 20440 * file names can be longer than standard encryption 20441 * can use sub paths and copy single files 20442 * directory structure visible 20443 * identical files names will have identical uploaded names 20444 20445 Cloud storage systems have limits on file name length and 20446 total path length which rclone is more likely to breach using 20447 "Standard" file name encryption. Where file names are less than 156 20448 characters in length issues should not be encountered, irrespective of 20449 cloud storage provider. 20450 20451 An experimental advanced option `filename_encoding` is now provided to 20452 address this problem to a certain degree. 20453 For cloud storage systems with case sensitive file names (e.g. Google Drive), 20454 `base64` can be used to reduce file name length. 20455 For cloud storage systems using UTF-16 to store file names internally 20456 (e.g. OneDrive, Dropbox, Box), `base32768` can be used to drastically reduce 20457 file name length. 20458 20459 An alternative, future rclone file name encryption mode may tolerate 20460 backend provider path length limits. 20461 20462 ### Directory name encryption 20463 20464 Crypt offers the option of encrypting dir names or leaving them intact. 20465 There are two options: 20466 20467 True 20468 20469 Encrypts the whole file path including directory names 20470 Example: 20471 `1/12/123.txt` is encrypted to 20472 `p0e52nreeaj0a5ea7s64m4j72s/l42g6771hnv3an9cgc8cr2n1ng/qgm4avr35m5loi1th53ato71v0` 20473 20474 False 20475 20476 Only encrypts file names, skips directory names 20477 Example: 20478 `1/12/123.txt` is encrypted to 20479 `1/12/qgm4avr35m5loi1th53ato71v0` 20480 20481 20482 ### Modification times and hashes 20483 20484 Crypt stores modification times using the underlying remote so support 20485 depends on that. 20486 20487 Hashes are not stored for crypt. However the data integrity is 20488 protected by an extremely strong crypto authenticator. 20489 20490 Use the `rclone cryptcheck` command to check the 20491 integrity of an encrypted remote instead of `rclone check` which can't 20492 check the checksums properly. 20493 20494 20495 ### Standard options 20496 20497 Here are the Standard options specific to crypt (Encrypt/Decrypt a remote). 20498 20499 #### --crypt-remote 20500 20501 Remote to encrypt/decrypt. 20502 20503 Normally should contain a ':' and a path, e.g. "myremote:path/to/dir", 20504 "myremote:bucket" or maybe "myremote:" (not recommended). 20505 20506 Properties: 20507 20508 - Config: remote 20509 - Env Var: RCLONE_CRYPT_REMOTE 20510 - Type: string 20511 - Required: true 20512 20513 #### --crypt-filename-encryption 20514 20515 How to encrypt the filenames. 20516 20517 Properties: 20518 20519 - Config: filename_encryption 20520 - Env Var: RCLONE_CRYPT_FILENAME_ENCRYPTION 20521 - Type: string 20522 - Default: "standard" 20523 - Examples: 20524 - "standard" 20525 - Encrypt the filenames. 20526 - See the docs for the details. 20527 - "obfuscate" 20528 - Very simple filename obfuscation. 20529 - "off" 20530 - Don't encrypt the file names. 20531 - Adds a ".bin", or "suffix" extension only. 20532 20533 #### --crypt-directory-name-encryption 20534 20535 Option to either encrypt directory names or leave them intact. 20536 20537 NB If filename_encryption is "off" then this option will do nothing. 20538 20539 Properties: 20540 20541 - Config: directory_name_encryption 20542 - Env Var: RCLONE_CRYPT_DIRECTORY_NAME_ENCRYPTION 20543 - Type: bool 20544 - Default: true 20545 - Examples: 20546 - "true" 20547 - Encrypt directory names. 20548 - "false" 20549 - Don't encrypt directory names, leave them intact. 20550 20551 #### --crypt-password 20552 20553 Password or pass phrase for encryption. 20554 20555 **NB** Input to this must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/). 20556 20557 Properties: 20558 20559 - Config: password 20560 - Env Var: RCLONE_CRYPT_PASSWORD 20561 - Type: string 20562 - Required: true 20563 20564 #### --crypt-password2 20565 20566 Password or pass phrase for salt. 20567 20568 Optional but recommended. 20569 Should be different to the previous password. 20570 20571 **NB** Input to this must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/). 20572 20573 Properties: 20574 20575 - Config: password2 20576 - Env Var: RCLONE_CRYPT_PASSWORD2 20577 - Type: string 20578 - Required: false 20579 20580 ### Advanced options 20581 20582 Here are the Advanced options specific to crypt (Encrypt/Decrypt a remote). 20583 20584 #### --crypt-server-side-across-configs 20585 20586 Deprecated: use --server-side-across-configs instead. 20587 20588 Allow server-side operations (e.g. copy) to work across different crypt configs. 20589 20590 Normally this option is not what you want, but if you have two crypts 20591 pointing to the same backend you can use it. 20592 20593 This can be used, for example, to change file name encryption type 20594 without re-uploading all the data. Just make two crypt backends 20595 pointing to two different directories with the single changed 20596 parameter and use rclone move to move the files between the crypt 20597 remotes. 20598 20599 Properties: 20600 20601 - Config: server_side_across_configs 20602 - Env Var: RCLONE_CRYPT_SERVER_SIDE_ACROSS_CONFIGS 20603 - Type: bool 20604 - Default: false 20605 20606 #### --crypt-show-mapping 20607 20608 For all files listed show how the names encrypt. 20609 20610 If this flag is set then for each file that the remote is asked to 20611 list, it will log (at level INFO) a line stating the decrypted file 20612 name and the encrypted file name. 20613 20614 This is so you can work out which encrypted names are which decrypted 20615 names just in case you need to do something with the encrypted file 20616 names, or for debugging purposes. 20617 20618 Properties: 20619 20620 - Config: show_mapping 20621 - Env Var: RCLONE_CRYPT_SHOW_MAPPING 20622 - Type: bool 20623 - Default: false 20624 20625 #### --crypt-no-data-encryption 20626 20627 Option to either encrypt file data or leave it unencrypted. 20628 20629 Properties: 20630 20631 - Config: no_data_encryption 20632 - Env Var: RCLONE_CRYPT_NO_DATA_ENCRYPTION 20633 - Type: bool 20634 - Default: false 20635 - Examples: 20636 - "true" 20637 - Don't encrypt file data, leave it unencrypted. 20638 - "false" 20639 - Encrypt file data. 20640 20641 #### --crypt-pass-bad-blocks 20642 20643 If set this will pass bad blocks through as all 0. 20644 20645 This should not be set in normal operation, it should only be set if 20646 trying to recover an encrypted file with errors and it is desired to 20647 recover as much of the file as possible. 20648 20649 Properties: 20650 20651 - Config: pass_bad_blocks 20652 - Env Var: RCLONE_CRYPT_PASS_BAD_BLOCKS 20653 - Type: bool 20654 - Default: false 20655 20656 #### --crypt-strict-names 20657 20658 If set, this will raise an error when crypt comes across a filename that can't be decrypted. 20659 20660 (By default, rclone will just log a NOTICE and continue as normal.) 20661 This can happen if encrypted and unencrypted files are stored in the same 20662 directory (which is not recommended.) It may also indicate a more serious 20663 problem that should be investigated. 20664 20665 Properties: 20666 20667 - Config: strict_names 20668 - Env Var: RCLONE_CRYPT_STRICT_NAMES 20669 - Type: bool 20670 - Default: false 20671 20672 #### --crypt-filename-encoding 20673 20674 How to encode the encrypted filename to text string. 20675 20676 This option could help with shortening the encrypted filename. The 20677 suitable option would depend on the way your remote count the filename 20678 length and if it's case sensitive. 20679 20680 Properties: 20681 20682 - Config: filename_encoding 20683 - Env Var: RCLONE_CRYPT_FILENAME_ENCODING 20684 - Type: string 20685 - Default: "base32" 20686 - Examples: 20687 - "base32" 20688 - Encode using base32. Suitable for all remote. 20689 - "base64" 20690 - Encode using base64. Suitable for case sensitive remote. 20691 - "base32768" 20692 - Encode using base32768. Suitable if your remote counts UTF-16 or 20693 - Unicode codepoint instead of UTF-8 byte length. (Eg. Onedrive, Dropbox) 20694 20695 #### --crypt-suffix 20696 20697 If this is set it will override the default suffix of ".bin". 20698 20699 Setting suffix to "none" will result in an empty suffix. This may be useful 20700 when the path length is critical. 20701 20702 Properties: 20703 20704 - Config: suffix 20705 - Env Var: RCLONE_CRYPT_SUFFIX 20706 - Type: string 20707 - Default: ".bin" 20708 20709 #### --crypt-description 20710 20711 Description of the remote 20712 20713 Properties: 20714 20715 - Config: description 20716 - Env Var: RCLONE_CRYPT_DESCRIPTION 20717 - Type: string 20718 - Required: false 20719 20720 ### Metadata 20721 20722 Any metadata supported by the underlying remote is read and written. 20723 20724 See the [metadata](https://rclone.org/docs/#metadata) docs for more info. 20725 20726 ## Backend commands 20727 20728 Here are the commands specific to the crypt backend. 20729 20730 Run them with 20731 20732 rclone backend COMMAND remote: 20733 20734 The help below will explain what arguments each command takes. 20735 20736 See the [backend](https://rclone.org/commands/rclone_backend/) command for more 20737 info on how to pass options and arguments. 20738 20739 These can be run on a running backend using the rc command 20740 [backend/command](https://rclone.org/rc/#backend-command). 20741 20742 ### encode 20743 20744 Encode the given filename(s) 20745 20746 rclone backend encode remote: [options] [<arguments>+] 20747 20748 This encodes the filenames given as arguments returning a list of 20749 strings of the encoded results. 20750 20751 Usage Example: 20752 20753 rclone backend encode crypt: file1 [file2...] 20754 rclone rc backend/command command=encode fs=crypt: file1 [file2...] 20755 20756 20757 ### decode 20758 20759 Decode the given filename(s) 20760 20761 rclone backend decode remote: [options] [<arguments>+] 20762 20763 This decodes the filenames given as arguments returning a list of 20764 strings of the decoded results. It will return an error if any of the 20765 inputs are invalid. 20766 20767 Usage Example: 20768 20769 rclone backend decode crypt: encryptedfile1 [encryptedfile2...] 20770 rclone rc backend/command command=decode fs=crypt: encryptedfile1 [encryptedfile2...] 20771 20772 20773 20774 20775 ## Backing up an encrypted remote 20776 20777 If you wish to backup an encrypted remote, it is recommended that you use 20778 `rclone sync` on the encrypted files, and make sure the passwords are 20779 the same in the new encrypted remote. 20780 20781 This will have the following advantages 20782 20783 * `rclone sync` will check the checksums while copying 20784 * you can use `rclone check` between the encrypted remotes 20785 * you don't decrypt and encrypt unnecessarily 20786 20787 For example, let's say you have your original remote at `remote:` with 20788 the encrypted version at `eremote:` with path `remote:crypt`. You 20789 would then set up the new remote `remote2:` and then the encrypted 20790 version `eremote2:` with path `remote2:crypt` using the same passwords 20791 as `eremote:`. 20792 20793 To sync the two remotes you would do 20794 20795 rclone sync --interactive remote:crypt remote2:crypt 20796 20797 And to check the integrity you would do 20798 20799 rclone check remote:crypt remote2:crypt 20800 20801 ## File formats 20802 20803 ### File encryption 20804 20805 Files are encrypted 1:1 source file to destination object. The file 20806 has a header and is divided into chunks. 20807 20808 #### Header 20809 20810 * 8 bytes magic string `RCLONE\x00\x00` 20811 * 24 bytes Nonce (IV) 20812 20813 The initial nonce is generated from the operating systems crypto 20814 strong random number generator. The nonce is incremented for each 20815 chunk read making sure each nonce is unique for each block written. 20816 The chance of a nonce being reused is minuscule. If you wrote an 20817 exabyte of data (10¹⁸ bytes) you would have a probability of 20818 approximately 2×10⁻³² of re-using a nonce. 20819 20820 #### Chunk 20821 20822 Each chunk will contain 64 KiB of data, except for the last one which 20823 may have less data. The data chunk is in standard NaCl SecretBox 20824 format. SecretBox uses XSalsa20 and Poly1305 to encrypt and 20825 authenticate messages. 20826 20827 Each chunk contains: 20828 20829 * 16 Bytes of Poly1305 authenticator 20830 * 1 - 65536 bytes XSalsa20 encrypted data 20831 20832 64k chunk size was chosen as the best performing chunk size (the 20833 authenticator takes too much time below this and the performance drops 20834 off due to cache effects above this). Note that these chunks are 20835 buffered in memory so they can't be too big. 20836 20837 This uses a 32 byte (256 bit key) key derived from the user password. 20838 20839 #### Examples 20840 20841 1 byte file will encrypt to 20842 20843 * 32 bytes header 20844 * 17 bytes data chunk 20845 20846 49 bytes total 20847 20848 1 MiB (1048576 bytes) file will encrypt to 20849 20850 * 32 bytes header 20851 * 16 chunks of 65568 bytes 20852 20853 1049120 bytes total (a 0.05% overhead). This is the overhead for big 20854 files. 20855 20856 ### Name encryption 20857 20858 File names are encrypted segment by segment - the path is broken up 20859 into `/` separated strings and these are encrypted individually. 20860 20861 File segments are padded using PKCS#7 to a multiple of 16 bytes 20862 before encryption. 20863 20864 They are then encrypted with EME using AES with 256 bit key. EME 20865 (ECB-Mix-ECB) is a wide-block encryption mode presented in the 2003 20866 paper "A Parallelizable Enciphering Mode" by Halevi and Rogaway. 20867 20868 This makes for deterministic encryption which is what we want - the 20869 same filename must encrypt to the same thing otherwise we can't find 20870 it on the cloud storage system. 20871 20872 This means that 20873 20874 * filenames with the same name will encrypt the same 20875 * filenames which start the same won't have a common prefix 20876 20877 This uses a 32 byte key (256 bits) and a 16 byte (128 bits) IV both of 20878 which are derived from the user password. 20879 20880 After encryption they are written out using a modified version of 20881 standard `base32` encoding as described in RFC4648. The standard 20882 encoding is modified in two ways: 20883 20884 * it becomes lower case (no-one likes upper case filenames!) 20885 * we strip the padding character `=` 20886 20887 `base32` is used rather than the more efficient `base64` so rclone can be 20888 used on case insensitive remotes (e.g. Windows, Box, Dropbox, Onedrive etc). 20889 20890 ### Key derivation 20891 20892 Rclone uses `scrypt` with parameters `N=16384, r=8, p=1` with an 20893 optional user supplied salt (password2) to derive the 32+32+16 = 80 20894 bytes of key material required. If the user doesn't supply a salt 20895 then rclone uses an internal one. 20896 20897 `scrypt` makes it impractical to mount a dictionary attack on rclone 20898 encrypted data. For full protection against this you should always use 20899 a salt. 20900 20901 ## SEE ALSO 20902 20903 * [rclone cryptdecode](https://rclone.org/commands/rclone_cryptdecode/) - Show forward/reverse mapping of encrypted filenames 20904 20905 # Compress 20906 20907 ## Warning 20908 20909 This remote is currently **experimental**. Things may break and data may be lost. Anything you do with this remote is 20910 at your own risk. Please understand the risks associated with using experimental code and don't use this remote in 20911 critical applications. 20912 20913 The `Compress` remote adds compression to another remote. It is best used with remotes containing 20914 many large compressible files. 20915 20916 ## Configuration 20917 20918 To use this remote, all you need to do is specify another remote and a compression mode to use: 20919 </code></pre> 20920 <p>Current remotes:</p> 20921 <p>Name Type ==== ==== remote_to_press sometype</p> 20922 <ol start="5" type="a"> 20923 <li>Edit existing remote $ rclone config</li> 20924 <li>New remote</li> 20925 <li>Delete remote</li> 20926 <li>Rename remote</li> 20927 <li>Copy remote</li> 20928 <li>Set configuration password</li> 20929 <li>Quit config e/n/d/r/c/s/q> n name> compress ... 8 / Compress a remote "compress" ... Storage> compress ** See help for compress backend at: https://rclone.org/compress/ **</li> 20930 </ol> 20931 <p>Remote to compress. Enter a string value. Press Enter for the default (""). remote> remote_to_press:subdir Compression mode. Enter a string value. Press Enter for the default ("gzip"). Choose a number from below, or type in your own value 1 / Gzip compression balanced for speed and compression strength. "gzip" compression_mode> gzip Edit advanced config? (y/n) y) Yes n) No (default) y/n> n Remote config -------------------- [compress] type = compress remote = remote_to_press:subdir compression_mode = gzip -------------------- y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y</p> 20932 <pre><code> 20933 ### Compression Modes 20934 20935 Currently only gzip compression is supported. It provides a decent balance between speed and size and is well 20936 supported by other applications. Compression strength can further be configured via an advanced setting where 0 is no 20937 compression and 9 is strongest compression. 20938 20939 ### File types 20940 20941 If you open a remote wrapped by compress, you will see that there are many files with an extension corresponding to 20942 the compression algorithm you chose. These files are standard files that can be opened by various archive programs, 20943 but they have some hidden metadata that allows them to be used by rclone. 20944 While you may download and decompress these files at will, do **not** manually delete or rename files. Files without 20945 correct metadata files will not be recognized by rclone. 20946 20947 ### File names 20948 20949 The compressed files will be named `*.###########.gz` where `*` is the base file and the `#` part is base64 encoded 20950 size of the uncompressed file. The file names should not be changed by anything other than the rclone compression backend. 20951 20952 20953 ### Standard options 20954 20955 Here are the Standard options specific to compress (Compress a remote). 20956 20957 #### --compress-remote 20958 20959 Remote to compress. 20960 20961 Properties: 20962 20963 - Config: remote 20964 - Env Var: RCLONE_COMPRESS_REMOTE 20965 - Type: string 20966 - Required: true 20967 20968 #### --compress-mode 20969 20970 Compression mode. 20971 20972 Properties: 20973 20974 - Config: mode 20975 - Env Var: RCLONE_COMPRESS_MODE 20976 - Type: string 20977 - Default: "gzip" 20978 - Examples: 20979 - "gzip" 20980 - Standard gzip compression with fastest parameters. 20981 20982 ### Advanced options 20983 20984 Here are the Advanced options specific to compress (Compress a remote). 20985 20986 #### --compress-level 20987 20988 GZIP compression level (-2 to 9). 20989 20990 Generally -1 (default, equivalent to 5) is recommended. 20991 Levels 1 to 9 increase compression at the cost of speed. Going past 6 20992 generally offers very little return. 20993 20994 Level -2 uses Huffman encoding only. Only use if you know what you 20995 are doing. 20996 Level 0 turns off compression. 20997 20998 Properties: 20999 21000 - Config: level 21001 - Env Var: RCLONE_COMPRESS_LEVEL 21002 - Type: int 21003 - Default: -1 21004 21005 #### --compress-ram-cache-limit 21006 21007 Some remotes don't allow the upload of files with unknown size. 21008 In this case the compressed file will need to be cached to determine 21009 it's size. 21010 21011 Files smaller than this limit will be cached in RAM, files larger than 21012 this limit will be cached on disk. 21013 21014 Properties: 21015 21016 - Config: ram_cache_limit 21017 - Env Var: RCLONE_COMPRESS_RAM_CACHE_LIMIT 21018 - Type: SizeSuffix 21019 - Default: 20Mi 21020 21021 #### --compress-description 21022 21023 Description of the remote 21024 21025 Properties: 21026 21027 - Config: description 21028 - Env Var: RCLONE_COMPRESS_DESCRIPTION 21029 - Type: string 21030 - Required: false 21031 21032 ### Metadata 21033 21034 Any metadata supported by the underlying remote is read and written. 21035 21036 See the [metadata](https://rclone.org/docs/#metadata) docs for more info. 21037 21038 21039 21040 # Combine 21041 21042 The `combine` backend joins remotes together into a single directory 21043 tree. 21044 21045 For example you might have a remote for images on one provider: 21046 </code></pre> 21047 <p>$ rclone tree s3:imagesbucket / ├── image1.jpg └── image2.jpg</p> 21048 <pre><code> 21049 And a remote for files on another: 21050 </code></pre> 21051 <p>$ rclone tree drive:important/files / ├── file1.txt └── file2.txt</p> 21052 <pre><code> 21053 The `combine` backend can join these together into a synthetic 21054 directory structure like this: 21055 </code></pre> 21056 <p>$ rclone tree combined: / ├── files │ ├── file1.txt │ └── file2.txt └── images ├── image1.jpg └── image2.jpg</p> 21057 <pre><code> 21058 You'd do this by specifying an `upstreams` parameter in the config 21059 like this 21060 21061 upstreams = images=s3:imagesbucket files=drive:important/files 21062 21063 During the initial setup with `rclone config` you will specify the 21064 upstreams remotes as a space separated list. The upstream remotes can 21065 either be a local paths or other remotes. 21066 21067 ## Configuration 21068 21069 Here is an example of how to make a combine called `remote` for the 21070 example above. First run: 21071 21072 rclone config 21073 21074 This will guide you through an interactive setup process: 21075 </code></pre> 21076 <p>No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n name> remote Option Storage. Type of storage to configure. Choose a number from below, or type in your own value. ... XX / Combine several remotes into one (combine) ... Storage> combine Option upstreams. Upstreams for combining These should be in the form dir=remote:path dir2=remote2:path Where before the = is specified the root directory and after is the remote to put there. Embedded spaces can be added using quotes "dir=remote:path with space" "dir2=remote2:path with space" Enter a fs.SpaceSepList value. upstreams> images=s3:imagesbucket files=drive:important/files -------------------- [remote] type = combine upstreams = images=s3:imagesbucket files=drive:important/files -------------------- y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y</p> 21077 <pre><code> 21078 ### Configuring for Google Drive Shared Drives 21079 21080 Rclone has a convenience feature for making a combine backend for all 21081 the shared drives you have access to. 21082 21083 Assuming your main (non shared drive) Google drive remote is called 21084 `drive:` you would run 21085 21086 rclone backend -o config drives drive: 21087 21088 This would produce something like this: 21089 21090 [My Drive] 21091 type = alias 21092 remote = drive,team_drive=0ABCDEF-01234567890,root_folder_id=: 21093 21094 [Test Drive] 21095 type = alias 21096 remote = drive,team_drive=0ABCDEFabcdefghijkl,root_folder_id=: 21097 21098 [AllDrives] 21099 type = combine 21100 upstreams = "My Drive=My Drive:" "Test Drive=Test Drive:" 21101 21102 If you then add that config to your config file (find it with `rclone 21103 config file`) then you can access all the shared drives in one place 21104 with the `AllDrives:` remote. 21105 21106 See [the Google Drive docs](https://rclone.org/drive/#drives) for full info. 21107 21108 21109 ### Standard options 21110 21111 Here are the Standard options specific to combine (Combine several remotes into one). 21112 21113 #### --combine-upstreams 21114 21115 Upstreams for combining 21116 21117 These should be in the form 21118 21119 dir=remote:path dir2=remote2:path 21120 21121 Where before the = is specified the root directory and after is the remote to 21122 put there. 21123 21124 Embedded spaces can be added using quotes 21125 21126 "dir=remote:path with space" "dir2=remote2:path with space" 21127 21128 21129 21130 Properties: 21131 21132 - Config: upstreams 21133 - Env Var: RCLONE_COMBINE_UPSTREAMS 21134 - Type: SpaceSepList 21135 - Default: 21136 21137 ### Advanced options 21138 21139 Here are the Advanced options specific to combine (Combine several remotes into one). 21140 21141 #### --combine-description 21142 21143 Description of the remote 21144 21145 Properties: 21146 21147 - Config: description 21148 - Env Var: RCLONE_COMBINE_DESCRIPTION 21149 - Type: string 21150 - Required: false 21151 21152 ### Metadata 21153 21154 Any metadata supported by the underlying remote is read and written. 21155 21156 See the [metadata](https://rclone.org/docs/#metadata) docs for more info. 21157 21158 21159 21160 # Dropbox 21161 21162 Paths are specified as `remote:path` 21163 21164 Dropbox paths may be as deep as required, e.g. 21165 `remote:directory/subdirectory`. 21166 21167 ## Configuration 21168 21169 The initial setup for dropbox involves getting a token from Dropbox 21170 which you need to do in your browser. `rclone config` walks you 21171 through it. 21172 21173 Here is an example of how to make a remote called `remote`. First run: 21174 21175 rclone config 21176 21177 This will guide you through an interactive setup process: 21178 </code></pre> 21179 <ol start="14" type="a"> 21180 <li>New remote</li> 21181 <li>Delete remote</li> 21182 <li>Quit config e/n/d/q> n name> remote Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Dropbox "dropbox" [snip] Storage> dropbox Dropbox App Key - leave blank normally. app_key> Dropbox App Secret - leave blank normally. app_secret> Remote config Please visit: https://www.dropbox.com/1/oauth2/authorize?client_id=XXXXXXXXXXXXXXX&response_type=code Enter the code: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX_XXXXXXXXXX -------------------- [remote] app_key = app_secret = token = XXXXXXXXXXXXXXXXXXXXXXXXXXXXX_XXXX_XXXXXXXXXXXXXXXXXXXXXXXXXXXXX --------------------</li> 21183 <li>Yes this is OK</li> 21184 <li>Edit this remote</li> 21185 <li>Delete this remote y/e/d> y</li> 21186 </ol> 21187 <pre><code> 21188 See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a 21189 machine with no Internet browser available. 21190 21191 Note that rclone runs a webserver on your local machine to collect the 21192 token as returned from Dropbox. This only 21193 runs from the moment it opens your browser to the moment you get back 21194 the verification code. This is on `http://127.0.0.1:53682/` and it 21195 may require you to unblock it temporarily if you are running a host 21196 firewall, or use manual mode. 21197 21198 You can then use it like this, 21199 21200 List directories in top level of your dropbox 21201 21202 rclone lsd remote: 21203 21204 List all the files in your dropbox 21205 21206 rclone ls remote: 21207 21208 To copy a local directory to a dropbox directory called backup 21209 21210 rclone copy /home/source remote:backup 21211 21212 ### Dropbox for business 21213 21214 Rclone supports Dropbox for business and Team Folders. 21215 21216 When using Dropbox for business `remote:` and `remote:path/to/file` 21217 will refer to your personal folder. 21218 21219 If you wish to see Team Folders you must use a leading `/` in the 21220 path, so `rclone lsd remote:/` will refer to the root and show you all 21221 Team Folders and your User Folder. 21222 21223 You can then use team folders like this `remote:/TeamFolder` and 21224 `remote:/TeamFolder/path/to/file`. 21225 21226 A leading `/` for a Dropbox personal account will do nothing, but it 21227 will take an extra HTTP transaction so it should be avoided. 21228 21229 ### Modification times and hashes 21230 21231 Dropbox supports modified times, but the only way to set a 21232 modification time is to re-upload the file. 21233 21234 This means that if you uploaded your data with an older version of 21235 rclone which didn't support the v2 API and modified times, rclone will 21236 decide to upload all your old data to fix the modification times. If 21237 you don't want this to happen use `--size-only` or `--checksum` flag 21238 to stop it. 21239 21240 Dropbox supports [its own hash 21241 type](https://www.dropbox.com/developers/reference/content-hash) which 21242 is checked for all transfers. 21243 21244 ### Restricted filename characters 21245 21246 | Character | Value | Replacement | 21247 | --------- |:-----:|:-----------:| 21248 | NUL | 0x00 | ␀ | 21249 | / | 0x2F | ／ | 21250 | DEL | 0x7F | ␡ | 21251 | \ | 0x5C | ＼ | 21252 21253 File names can also not end with the following characters. 21254 These only get replaced if they are the last character in the name: 21255 21256 | Character | Value | Replacement | 21257 | --------- |:-----:|:-----------:| 21258 | SP | 0x20 | ␠ | 21259 21260 Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8), 21261 as they can't be used in JSON strings. 21262 21263 ### Batch mode uploads {#batch-mode} 21264 21265 Using batch mode uploads is very important for performance when using 21266 the Dropbox API. See [the dropbox performance guide](https://developers.dropbox.com/dbx-performance-guide) 21267 for more info. 21268 21269 There are 3 modes rclone can use for uploads. 21270 21271 #### --dropbox-batch-mode off 21272 21273 In this mode rclone will not use upload batching. This was the default 21274 before rclone v1.55. It has the disadvantage that it is very likely to 21275 encounter `too_many_requests` errors like this 21276 21277 NOTICE: too_many_requests/.: Too many requests or write operations. Trying again in 15 seconds. 21278 21279 When rclone receives these it has to wait for 15s or sometimes 300s 21280 before continuing which really slows down transfers. 21281 21282 This will happen especially if `--transfers` is large, so this mode 21283 isn't recommended except for compatibility or investigating problems. 21284 21285 #### --dropbox-batch-mode sync 21286 21287 In this mode rclone will batch up uploads to the size specified by 21288 `--dropbox-batch-size` and commit them together. 21289 21290 Using this mode means you can use a much higher `--transfers` 21291 parameter (32 or 64 works fine) without receiving `too_many_requests` 21292 errors. 21293 21294 This mode ensures full data integrity. 21295 21296 Note that there may be a pause when quitting rclone while rclone 21297 finishes up the last batch using this mode. 21298 21299 #### --dropbox-batch-mode async 21300 21301 In this mode rclone will batch up uploads to the size specified by 21302 `--dropbox-batch-size` and commit them together. 21303 21304 However it will not wait for the status of the batch to be returned to 21305 the caller. This means rclone can use a much bigger batch size (much 21306 bigger than `--transfers`), at the cost of not being able to check the 21307 status of the upload. 21308 21309 This provides the maximum possible upload speed especially with lots 21310 of small files, however rclone can't check the file got uploaded 21311 properly using this mode. 21312 21313 If you are using this mode then using "rclone check" after the 21314 transfer completes is recommended. Or you could do an initial transfer 21315 with `--dropbox-batch-mode async` then do a final transfer with 21316 `--dropbox-batch-mode sync` (the default). 21317 21318 Note that there may be a pause when quitting rclone while rclone 21319 finishes up the last batch using this mode. 21320 21321 21322 21323 ### Standard options 21324 21325 Here are the Standard options specific to dropbox (Dropbox). 21326 21327 #### --dropbox-client-id 21328 21329 OAuth Client Id. 21330 21331 Leave blank normally. 21332 21333 Properties: 21334 21335 - Config: client_id 21336 - Env Var: RCLONE_DROPBOX_CLIENT_ID 21337 - Type: string 21338 - Required: false 21339 21340 #### --dropbox-client-secret 21341 21342 OAuth Client Secret. 21343 21344 Leave blank normally. 21345 21346 Properties: 21347 21348 - Config: client_secret 21349 - Env Var: RCLONE_DROPBOX_CLIENT_SECRET 21350 - Type: string 21351 - Required: false 21352 21353 ### Advanced options 21354 21355 Here are the Advanced options specific to dropbox (Dropbox). 21356 21357 #### --dropbox-token 21358 21359 OAuth Access Token as a JSON blob. 21360 21361 Properties: 21362 21363 - Config: token 21364 - Env Var: RCLONE_DROPBOX_TOKEN 21365 - Type: string 21366 - Required: false 21367 21368 #### --dropbox-auth-url 21369 21370 Auth server URL. 21371 21372 Leave blank to use the provider defaults. 21373 21374 Properties: 21375 21376 - Config: auth_url 21377 - Env Var: RCLONE_DROPBOX_AUTH_URL 21378 - Type: string 21379 - Required: false 21380 21381 #### --dropbox-token-url 21382 21383 Token server url. 21384 21385 Leave blank to use the provider defaults. 21386 21387 Properties: 21388 21389 - Config: token_url 21390 - Env Var: RCLONE_DROPBOX_TOKEN_URL 21391 - Type: string 21392 - Required: false 21393 21394 #### --dropbox-chunk-size 21395 21396 Upload chunk size (< 150Mi). 21397 21398 Any files larger than this will be uploaded in chunks of this size. 21399 21400 Note that chunks are buffered in memory (one at a time) so rclone can 21401 deal with retries. Setting this larger will increase the speed 21402 slightly (at most 10% for 128 MiB in tests) at the cost of using more 21403 memory. It can be set smaller if you are tight on memory. 21404 21405 Properties: 21406 21407 - Config: chunk_size 21408 - Env Var: RCLONE_DROPBOX_CHUNK_SIZE 21409 - Type: SizeSuffix 21410 - Default: 48Mi 21411 21412 #### --dropbox-impersonate 21413 21414 Impersonate this user when using a business account. 21415 21416 Note that if you want to use impersonate, you should make sure this 21417 flag is set when running "rclone config" as this will cause rclone to 21418 request the "members.read" scope which it won't normally. This is 21419 needed to lookup a members email address into the internal ID that 21420 dropbox uses in the API. 21421 21422 Using the "members.read" scope will require a Dropbox Team Admin 21423 to approve during the OAuth flow. 21424 21425 You will have to use your own App (setting your own client_id and 21426 client_secret) to use this option as currently rclone's default set of 21427 permissions doesn't include "members.read". This can be added once 21428 v1.55 or later is in use everywhere. 21429 21430 21431 Properties: 21432 21433 - Config: impersonate 21434 - Env Var: RCLONE_DROPBOX_IMPERSONATE 21435 - Type: string 21436 - Required: false 21437 21438 #### --dropbox-shared-files 21439 21440 Instructs rclone to work on individual shared files. 21441 21442 In this mode rclone's features are extremely limited - only list (ls, lsl, etc.) 21443 operations and read operations (e.g. downloading) are supported in this mode. 21444 All other operations will be disabled. 21445 21446 Properties: 21447 21448 - Config: shared_files 21449 - Env Var: RCLONE_DROPBOX_SHARED_FILES 21450 - Type: bool 21451 - Default: false 21452 21453 #### --dropbox-shared-folders 21454 21455 Instructs rclone to work on shared folders. 21456 21457 When this flag is used with no path only the List operation is supported and 21458 all available shared folders will be listed. If you specify a path the first part 21459 will be interpreted as the name of shared folder. Rclone will then try to mount this 21460 shared to the root namespace. On success shared folder rclone proceeds normally. 21461 The shared folder is now pretty much a normal folder and all normal operations 21462 are supported. 21463 21464 Note that we don't unmount the shared folder afterwards so the 21465 --dropbox-shared-folders can be omitted after the first use of a particular 21466 shared folder. 21467 21468 Properties: 21469 21470 - Config: shared_folders 21471 - Env Var: RCLONE_DROPBOX_SHARED_FOLDERS 21472 - Type: bool 21473 - Default: false 21474 21475 #### --dropbox-pacer-min-sleep 21476 21477 Minimum time to sleep between API calls. 21478 21479 Properties: 21480 21481 - Config: pacer_min_sleep 21482 - Env Var: RCLONE_DROPBOX_PACER_MIN_SLEEP 21483 - Type: Duration 21484 - Default: 10ms 21485 21486 #### --dropbox-encoding 21487 21488 The encoding for the backend. 21489 21490 See the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. 21491 21492 Properties: 21493 21494 - Config: encoding 21495 - Env Var: RCLONE_DROPBOX_ENCODING 21496 - Type: Encoding 21497 - Default: Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot 21498 21499 #### --dropbox-batch-mode 21500 21501 Upload file batching sync|async|off. 21502 21503 This sets the batch mode used by rclone. 21504 21505 For full info see [the main docs](https://rclone.org/dropbox/#batch-mode) 21506 21507 This has 3 possible values 21508 21509 - off - no batching 21510 - sync - batch uploads and check completion (default) 21511 - async - batch upload and don't check completion 21512 21513 Rclone will close any outstanding batches when it exits which may make 21514 a delay on quit. 21515 21516 21517 Properties: 21518 21519 - Config: batch_mode 21520 - Env Var: RCLONE_DROPBOX_BATCH_MODE 21521 - Type: string 21522 - Default: "sync" 21523 21524 #### --dropbox-batch-size 21525 21526 Max number of files in upload batch. 21527 21528 This sets the batch size of files to upload. It has to be less than 1000. 21529 21530 By default this is 0 which means rclone which calculate the batch size 21531 depending on the setting of batch_mode. 21532 21533 - batch_mode: async - default batch_size is 100 21534 - batch_mode: sync - default batch_size is the same as --transfers 21535 - batch_mode: off - not in use 21536 21537 Rclone will close any outstanding batches when it exits which may make 21538 a delay on quit. 21539 21540 Setting this is a great idea if you are uploading lots of small files 21541 as it will make them a lot quicker. You can use --transfers 32 to 21542 maximise throughput. 21543 21544 21545 Properties: 21546 21547 - Config: batch_size 21548 - Env Var: RCLONE_DROPBOX_BATCH_SIZE 21549 - Type: int 21550 - Default: 0 21551 21552 #### --dropbox-batch-timeout 21553 21554 Max time to allow an idle upload batch before uploading. 21555 21556 If an upload batch is idle for more than this long then it will be 21557 uploaded. 21558 21559 The default for this is 0 which means rclone will choose a sensible 21560 default based on the batch_mode in use. 21561 21562 - batch_mode: async - default batch_timeout is 10s 21563 - batch_mode: sync - default batch_timeout is 500ms 21564 - batch_mode: off - not in use 21565 21566 21567 Properties: 21568 21569 - Config: batch_timeout 21570 - Env Var: RCLONE_DROPBOX_BATCH_TIMEOUT 21571 - Type: Duration 21572 - Default: 0s 21573 21574 #### --dropbox-batch-commit-timeout 21575 21576 Max time to wait for a batch to finish committing 21577 21578 Properties: 21579 21580 - Config: batch_commit_timeout 21581 - Env Var: RCLONE_DROPBOX_BATCH_COMMIT_TIMEOUT 21582 - Type: Duration 21583 - Default: 10m0s 21584 21585 #### --dropbox-description 21586 21587 Description of the remote 21588 21589 Properties: 21590 21591 - Config: description 21592 - Env Var: RCLONE_DROPBOX_DESCRIPTION 21593 - Type: string 21594 - Required: false 21595 21596 21597 21598 ## Limitations 21599 21600 Note that Dropbox is case insensitive so you can't have a file called 21601 "Hello.doc" and one called "hello.doc". 21602 21603 There are some file names such as `thumbs.db` which Dropbox can't 21604 store. There is a full list of them in the ["Ignored Files" section 21605 of this document](https://www.dropbox.com/en/help/145). Rclone will 21606 issue an error message `File name disallowed - not uploading` if it 21607 attempts to upload one of those file names, but the sync won't fail. 21608 21609 Some errors may occur if you try to sync copyright-protected files 21610 because Dropbox has its own [copyright detector](https://techcrunch.com/2014/03/30/how-dropbox-knows-when-youre-sharing-copyrighted-stuff-without-actually-looking-at-your-stuff/) that 21611 prevents this sort of file being downloaded. This will return the error `ERROR : 21612 /path/to/your/file: Failed to copy: failed to open source object: 21613 path/restricted_content/.` 21614 21615 If you have more than 10,000 files in a directory then `rclone purge 21616 dropbox:dir` will return the error `Failed to purge: There are too 21617 many files involved in this operation`. As a work-around do an 21618 `rclone delete dropbox:dir` followed by an `rclone rmdir dropbox:dir`. 21619 21620 When using `rclone link` you'll need to set `--expire` if using a 21621 non-personal account otherwise the visibility may not be correct. 21622 (Note that `--expire` isn't supported on personal accounts). See the 21623 [forum discussion](https://forum.rclone.org/t/rclone-link-dropbox-permissions/23211) and the 21624 [dropbox SDK issue](https://github.com/dropbox/dropbox-sdk-go-unofficial/issues/75). 21625 21626 ## Get your own Dropbox App ID 21627 21628 When you use rclone with Dropbox in its default configuration you are using rclone's App ID. This is shared between all the rclone users. 21629 21630 Here is how to create your own Dropbox App ID for rclone: 21631 21632 1. Log into the [Dropbox App console](https://www.dropbox.com/developers/apps/create) with your Dropbox Account (It need not 21633 to be the same account as the Dropbox you want to access) 21634 21635 2. Choose an API => Usually this should be `Dropbox API` 21636 21637 3. Choose the type of access you want to use => `Full Dropbox` or `App Folder`. If you want to use Team Folders, `Full Dropbox` is required ([see here](https://www.dropboxforum.com/t5/Dropbox-API-Support-Feedback/How-to-create-team-folder-inside-my-app-s-folder/m-p/601005/highlight/true#M27911)). 21638 21639 4. Name your App. The app name is global, so you can't use `rclone` for example 21640 21641 5. Click the button `Create App` 21642 21643 6. Switch to the `Permissions` tab. Enable at least the following permissions: `account_info.read`, `files.metadata.write`, `files.content.write`, `files.content.read`, `sharing.write`. The `files.metadata.read` and `sharing.read` checkboxes will be marked too. Click `Submit` 21644 21645 7. Switch to the `Settings` tab. Fill `OAuth2 - Redirect URIs` as `http://localhost:53682/` and click on `Add` 21646 21647 8. Find the `App key` and `App secret` values on the `Settings` tab. Use these values in rclone config to add a new remote or edit an existing remote. The `App key` setting corresponds to `client_id` in rclone config, the `App secret` corresponds to `client_secret` 21648 21649 # Enterprise File Fabric 21650 21651 This backend supports [Storage Made Easy's Enterprise File 21652 Fabric™](https://storagemadeeasy.com/about/) which provides a software 21653 solution to integrate and unify File and Object Storage accessible 21654 through a global file system. 21655 21656 ## Configuration 21657 21658 The initial setup for the Enterprise File Fabric backend involves 21659 getting a token from the Enterprise File Fabric which you need to 21660 do in your browser. `rclone config` walks you through it. 21661 21662 Here is an example of how to make a remote called `remote`. First run: 21663 21664 rclone config 21665 21666 This will guide you through an interactive setup process: 21667 </code></pre> 21668 <p>No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n name> remote Type of storage to configure. Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value [snip] XX / Enterprise File Fabric "filefabric" [snip] Storage> filefabric ** See help for filefabric backend at: https://rclone.org/filefabric/ **</p> 21669 <p>URL of the Enterprise File Fabric to connect to Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value 1 / Storage Made Easy US "https://storagemadeeasy.com" 2 / Storage Made Easy EU "https://eu.storagemadeeasy.com" 3 / Connect to your Enterprise File Fabric "https://yourfabric.smestorage.com" url> https://yourfabric.smestorage.com/ ID of the root folder Leave blank normally.</p> 21670 <p>Fill in to make rclone start with directory of a given ID.</p> 21671 <p>Enter a string value. Press Enter for the default (""). root_folder_id> Permanent Authentication Token</p> 21672 <p>A Permanent Authentication Token can be created in the Enterprise File Fabric, on the users Dashboard under Security, there is an entry you'll see called "My Authentication Tokens". Click the Manage button to create one.</p> 21673 <p>These tokens are normally valid for several years.</p> 21674 <p>For more info see: https://docs.storagemadeeasy.com/organisationcloud/api-tokens</p> 21675 <p>Enter a string value. Press Enter for the default (""). permanent_token> xxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx Edit advanced config? (y/n) y) Yes n) No (default) y/n> n Remote config -------------------- [remote] type = filefabric url = https://yourfabric.smestorage.com/ permanent_token = xxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx -------------------- y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y</p> 21676 <pre><code> 21677 Once configured you can then use `rclone` like this, 21678 21679 List directories in top level of your Enterprise File Fabric 21680 21681 rclone lsd remote: 21682 21683 List all the files in your Enterprise File Fabric 21684 21685 rclone ls remote: 21686 21687 To copy a local directory to an Enterprise File Fabric directory called backup 21688 21689 rclone copy /home/source remote:backup 21690 21691 ### Modification times and hashes 21692 21693 The Enterprise File Fabric allows modification times to be set on 21694 files accurate to 1 second. These will be used to detect whether 21695 objects need syncing or not. 21696 21697 The Enterprise File Fabric does not support any data hashes at this time. 21698 21699 ### Restricted filename characters 21700 21701 The [default restricted characters set](https://rclone.org/overview/#restricted-characters) 21702 will be replaced. 21703 21704 Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8), 21705 as they can't be used in JSON strings. 21706 21707 ### Empty files 21708 21709 Empty files aren't supported by the Enterprise File Fabric. Rclone will therefore 21710 upload an empty file as a single space with a mime type of 21711 `application/vnd.rclone.empty.file` and files with that mime type are 21712 treated as empty. 21713 21714 ### Root folder ID ### 21715 21716 You can set the `root_folder_id` for rclone. This is the directory 21717 (identified by its `Folder ID`) that rclone considers to be the root 21718 of your Enterprise File Fabric. 21719 21720 Normally you will leave this blank and rclone will determine the 21721 correct root to use itself. 21722 21723 However you can set this to restrict rclone to a specific folder 21724 hierarchy. 21725 21726 In order to do this you will have to find the `Folder ID` of the 21727 directory you wish rclone to display. These aren't displayed in the 21728 web interface, but you can use `rclone lsf` to find them, for example 21729 </code></pre> 21730 <p>$ rclone lsf --dirs-only -Fip --csv filefabric: 120673758,Burnt PDFs/ 120673759,My Quick Uploads/ 120673755,My Syncs/ 120673756,My backups/ 120673757,My contacts/ 120673761,S3 Storage/</p> 21731 <pre><code> 21732 The ID for "S3 Storage" would be `120673761`. 21733 21734 21735 ### Standard options 21736 21737 Here are the Standard options specific to filefabric (Enterprise File Fabric). 21738 21739 #### --filefabric-url 21740 21741 URL of the Enterprise File Fabric to connect to. 21742 21743 Properties: 21744 21745 - Config: url 21746 - Env Var: RCLONE_FILEFABRIC_URL 21747 - Type: string 21748 - Required: true 21749 - Examples: 21750 - "https://storagemadeeasy.com" 21751 - Storage Made Easy US 21752 - "https://eu.storagemadeeasy.com" 21753 - Storage Made Easy EU 21754 - "https://yourfabric.smestorage.com" 21755 - Connect to your Enterprise File Fabric 21756 21757 #### --filefabric-root-folder-id 21758 21759 ID of the root folder. 21760 21761 Leave blank normally. 21762 21763 Fill in to make rclone start with directory of a given ID. 21764 21765 21766 Properties: 21767 21768 - Config: root_folder_id 21769 - Env Var: RCLONE_FILEFABRIC_ROOT_FOLDER_ID 21770 - Type: string 21771 - Required: false 21772 21773 #### --filefabric-permanent-token 21774 21775 Permanent Authentication Token. 21776 21777 A Permanent Authentication Token can be created in the Enterprise File 21778 Fabric, on the users Dashboard under Security, there is an entry 21779 you'll see called "My Authentication Tokens". Click the Manage button 21780 to create one. 21781 21782 These tokens are normally valid for several years. 21783 21784 For more info see: https://docs.storagemadeeasy.com/organisationcloud/api-tokens 21785 21786 21787 Properties: 21788 21789 - Config: permanent_token 21790 - Env Var: RCLONE_FILEFABRIC_PERMANENT_TOKEN 21791 - Type: string 21792 - Required: false 21793 21794 ### Advanced options 21795 21796 Here are the Advanced options specific to filefabric (Enterprise File Fabric). 21797 21798 #### --filefabric-token 21799 21800 Session Token. 21801 21802 This is a session token which rclone caches in the config file. It is 21803 usually valid for 1 hour. 21804 21805 Don't set this value - rclone will set it automatically. 21806 21807 21808 Properties: 21809 21810 - Config: token 21811 - Env Var: RCLONE_FILEFABRIC_TOKEN 21812 - Type: string 21813 - Required: false 21814 21815 #### --filefabric-token-expiry 21816 21817 Token expiry time. 21818 21819 Don't set this value - rclone will set it automatically. 21820 21821 21822 Properties: 21823 21824 - Config: token_expiry 21825 - Env Var: RCLONE_FILEFABRIC_TOKEN_EXPIRY 21826 - Type: string 21827 - Required: false 21828 21829 #### --filefabric-version 21830 21831 Version read from the file fabric. 21832 21833 Don't set this value - rclone will set it automatically. 21834 21835 21836 Properties: 21837 21838 - Config: version 21839 - Env Var: RCLONE_FILEFABRIC_VERSION 21840 - Type: string 21841 - Required: false 21842 21843 #### --filefabric-encoding 21844 21845 The encoding for the backend. 21846 21847 See the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. 21848 21849 Properties: 21850 21851 - Config: encoding 21852 - Env Var: RCLONE_FILEFABRIC_ENCODING 21853 - Type: Encoding 21854 - Default: Slash,Del,Ctl,InvalidUtf8,Dot 21855 21856 #### --filefabric-description 21857 21858 Description of the remote 21859 21860 Properties: 21861 21862 - Config: description 21863 - Env Var: RCLONE_FILEFABRIC_DESCRIPTION 21864 - Type: string 21865 - Required: false 21866 21867 21868 21869 # FTP 21870 21871 FTP is the File Transfer Protocol. Rclone FTP support is provided using the 21872 [github.com/jlaffaye/ftp](https://godoc.org/github.com/jlaffaye/ftp) 21873 package. 21874 21875 [Limitations of Rclone's FTP backend](#limitations) 21876 21877 Paths are specified as `remote:path`. If the path does not begin with 21878 a `/` it is relative to the home directory of the user. An empty path 21879 `remote:` refers to the user's home directory. 21880 21881 ## Configuration 21882 21883 To create an FTP configuration named `remote`, run 21884 21885 rclone config 21886 21887 Rclone config guides you through an interactive setup process. A minimal 21888 rclone FTP remote definition only requires host, username and password. 21889 For an anonymous FTP server, see [below](#anonymous-ftp). 21890 </code></pre> 21891 <p>No remotes found, make a new one? n) New remote r) Rename remote c) Copy remote s) Set configuration password q) Quit config n/r/c/s/q> n name> remote Type of storage to configure. Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value [snip] XX / FTP "ftp" [snip] Storage> ftp ** See help for ftp backend at: https://rclone.org/ftp/ **</p> 21892 <p>FTP host to connect to Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value 1 / Connect to ftp.example.com "ftp.example.com" host> ftp.example.com FTP username Enter a string value. Press Enter for the default ("$USER"). user> FTP port number Enter a signed integer. Press Enter for the default (21). port> FTP password y) Yes type in my own password g) Generate random password y/g> y Enter the password: password: Confirm the password: password: Use FTP over TLS (Implicit) Enter a boolean value (true or false). Press Enter for the default ("false"). tls> Use FTP over TLS (Explicit) Enter a boolean value (true or false). Press Enter for the default ("false"). explicit_tls> Remote config -------------------- [remote] type = ftp host = ftp.example.com pass = *** ENCRYPTED *** -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y</p> 21893 <pre><code> 21894 To see all directories in the home directory of `remote` 21895 21896 rclone lsd remote: 21897 21898 Make a new directory 21899 21900 rclone mkdir remote:path/to/directory 21901 21902 List the contents of a directory 21903 21904 rclone ls remote:path/to/directory 21905 21906 Sync `/home/local/directory` to the remote directory, deleting any 21907 excess files in the directory. 21908 21909 rclone sync --interactive /home/local/directory remote:directory 21910 21911 ### Anonymous FTP 21912 21913 When connecting to a FTP server that allows anonymous login, you can use the 21914 special "anonymous" username. Traditionally, this user account accepts any 21915 string as a password, although it is common to use either the password 21916 "anonymous" or "guest". Some servers require the use of a valid e-mail 21917 address as password. 21918 21919 Using [on-the-fly](#backend-path-to-dir) or 21920 [connection string](https://rclone.org/docs/#connection-strings) remotes makes it easy to access 21921 such servers, without requiring any configuration in advance. The following 21922 are examples of that: 21923 21924 rclone lsf :ftp: --ftp-host=speedtest.tele2.net --ftp-user=anonymous --ftp-pass=$(rclone obscure dummy) 21925 rclone lsf :ftp,host=speedtest.tele2.net,user=anonymous,pass=$(rclone obscure dummy): 21926 21927 The above examples work in Linux shells and in PowerShell, but not Windows 21928 Command Prompt. They execute the [rclone obscure](https://rclone.org/commands/rclone_obscure/) 21929 command to create a password string in the format required by the 21930 [pass](#ftp-pass) option. The following examples are exactly the same, except use 21931 an already obscured string representation of the same password "dummy", and 21932 therefore works even in Windows Command Prompt: 21933 21934 rclone lsf :ftp: --ftp-host=speedtest.tele2.net --ftp-user=anonymous --ftp-pass=IXs2wc8OJOz7SYLBk47Ji1rHTmxM 21935 rclone lsf :ftp,host=speedtest.tele2.net,user=anonymous,pass=IXs2wc8OJOz7SYLBk47Ji1rHTmxM: 21936 21937 ### Implicit TLS 21938 21939 Rlone FTP supports implicit FTP over TLS servers (FTPS). This has to 21940 be enabled in the FTP backend config for the remote, or with 21941 [`--ftp-tls`](#ftp-tls). The default FTPS port is `990`, not `21` and 21942 can be set with [`--ftp-port`](#ftp-port). 21943 21944 ### Restricted filename characters 21945 21946 In addition to the [default restricted characters set](https://rclone.org/overview/#restricted-characters) 21947 the following characters are also replaced: 21948 21949 File names cannot end with the following characters. Replacement is 21950 limited to the last character in a file name: 21951 21952 | Character | Value | Replacement | 21953 | --------- |:-----:|:-----------:| 21954 | SP | 0x20 | ␠ | 21955 21956 Not all FTP servers can have all characters in file names, for example: 21957 21958 | FTP Server| Forbidden characters | 21959 | --------- |:--------------------:| 21960 | proftpd | `*` | 21961 | pureftpd | `\ [ ]` | 21962 21963 This backend's interactive configuration wizard provides a selection of 21964 sensible encoding settings for major FTP servers: ProFTPd, PureFTPd, VsFTPd. 21965 Just hit a selection number when prompted. 21966 21967 21968 ### Standard options 21969 21970 Here are the Standard options specific to ftp (FTP). 21971 21972 #### --ftp-host 21973 21974 FTP host to connect to. 21975 21976 E.g. "ftp.example.com". 21977 21978 Properties: 21979 21980 - Config: host 21981 - Env Var: RCLONE_FTP_HOST 21982 - Type: string 21983 - Required: true 21984 21985 #### --ftp-user 21986 21987 FTP username. 21988 21989 Properties: 21990 21991 - Config: user 21992 - Env Var: RCLONE_FTP_USER 21993 - Type: string 21994 - Default: "$USER" 21995 21996 #### --ftp-port 21997 21998 FTP port number. 21999 22000 Properties: 22001 22002 - Config: port 22003 - Env Var: RCLONE_FTP_PORT 22004 - Type: int 22005 - Default: 21 22006 22007 #### --ftp-pass 22008 22009 FTP password. 22010 22011 **NB** Input to this must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/). 22012 22013 Properties: 22014 22015 - Config: pass 22016 - Env Var: RCLONE_FTP_PASS 22017 - Type: string 22018 - Required: false 22019 22020 #### --ftp-tls 22021 22022 Use Implicit FTPS (FTP over TLS). 22023 22024 When using implicit FTP over TLS the client connects using TLS 22025 right from the start which breaks compatibility with 22026 non-TLS-aware servers. This is usually served over port 990 rather 22027 than port 21. Cannot be used in combination with explicit FTPS. 22028 22029 Properties: 22030 22031 - Config: tls 22032 - Env Var: RCLONE_FTP_TLS 22033 - Type: bool 22034 - Default: false 22035 22036 #### --ftp-explicit-tls 22037 22038 Use Explicit FTPS (FTP over TLS). 22039 22040 When using explicit FTP over TLS the client explicitly requests 22041 security from the server in order to upgrade a plain text connection 22042 to an encrypted one. Cannot be used in combination with implicit FTPS. 22043 22044 Properties: 22045 22046 - Config: explicit_tls 22047 - Env Var: RCLONE_FTP_EXPLICIT_TLS 22048 - Type: bool 22049 - Default: false 22050 22051 ### Advanced options 22052 22053 Here are the Advanced options specific to ftp (FTP). 22054 22055 #### --ftp-concurrency 22056 22057 Maximum number of FTP simultaneous connections, 0 for unlimited. 22058 22059 Note that setting this is very likely to cause deadlocks so it should 22060 be used with care. 22061 22062 If you are doing a sync or copy then make sure concurrency is one more 22063 than the sum of `--transfers` and `--checkers`. 22064 22065 If you use `--check-first` then it just needs to be one more than the 22066 maximum of `--checkers` and `--transfers`. 22067 22068 So for `concurrency 3` you'd use `--checkers 2 --transfers 2 22069 --check-first` or `--checkers 1 --transfers 1`. 22070 22071 22072 22073 Properties: 22074 22075 - Config: concurrency 22076 - Env Var: RCLONE_FTP_CONCURRENCY 22077 - Type: int 22078 - Default: 0 22079 22080 #### --ftp-no-check-certificate 22081 22082 Do not verify the TLS certificate of the server. 22083 22084 Properties: 22085 22086 - Config: no_check_certificate 22087 - Env Var: RCLONE_FTP_NO_CHECK_CERTIFICATE 22088 - Type: bool 22089 - Default: false 22090 22091 #### --ftp-disable-epsv 22092 22093 Disable using EPSV even if server advertises support. 22094 22095 Properties: 22096 22097 - Config: disable_epsv 22098 - Env Var: RCLONE_FTP_DISABLE_EPSV 22099 - Type: bool 22100 - Default: false 22101 22102 #### --ftp-disable-mlsd 22103 22104 Disable using MLSD even if server advertises support. 22105 22106 Properties: 22107 22108 - Config: disable_mlsd 22109 - Env Var: RCLONE_FTP_DISABLE_MLSD 22110 - Type: bool 22111 - Default: false 22112 22113 #### --ftp-disable-utf8 22114 22115 Disable using UTF-8 even if server advertises support. 22116 22117 Properties: 22118 22119 - Config: disable_utf8 22120 - Env Var: RCLONE_FTP_DISABLE_UTF8 22121 - Type: bool 22122 - Default: false 22123 22124 #### --ftp-writing-mdtm 22125 22126 Use MDTM to set modification time (VsFtpd quirk) 22127 22128 Properties: 22129 22130 - Config: writing_mdtm 22131 - Env Var: RCLONE_FTP_WRITING_MDTM 22132 - Type: bool 22133 - Default: false 22134 22135 #### --ftp-force-list-hidden 22136 22137 Use LIST -a to force listing of hidden files and folders. This will disable the use of MLSD. 22138 22139 Properties: 22140 22141 - Config: force_list_hidden 22142 - Env Var: RCLONE_FTP_FORCE_LIST_HIDDEN 22143 - Type: bool 22144 - Default: false 22145 22146 #### --ftp-idle-timeout 22147 22148 Max time before closing idle connections. 22149 22150 If no connections have been returned to the connection pool in the time 22151 given, rclone will empty the connection pool. 22152 22153 Set to 0 to keep connections indefinitely. 22154 22155 22156 Properties: 22157 22158 - Config: idle_timeout 22159 - Env Var: RCLONE_FTP_IDLE_TIMEOUT 22160 - Type: Duration 22161 - Default: 1m0s 22162 22163 #### --ftp-close-timeout 22164 22165 Maximum time to wait for a response to close. 22166 22167 Properties: 22168 22169 - Config: close_timeout 22170 - Env Var: RCLONE_FTP_CLOSE_TIMEOUT 22171 - Type: Duration 22172 - Default: 1m0s 22173 22174 #### --ftp-tls-cache-size 22175 22176 Size of TLS session cache for all control and data connections. 22177 22178 TLS cache allows to resume TLS sessions and reuse PSK between connections. 22179 Increase if default size is not enough resulting in TLS resumption errors. 22180 Enabled by default. Use 0 to disable. 22181 22182 Properties: 22183 22184 - Config: tls_cache_size 22185 - Env Var: RCLONE_FTP_TLS_CACHE_SIZE 22186 - Type: int 22187 - Default: 32 22188 22189 #### --ftp-disable-tls13 22190 22191 Disable TLS 1.3 (workaround for FTP servers with buggy TLS) 22192 22193 Properties: 22194 22195 - Config: disable_tls13 22196 - Env Var: RCLONE_FTP_DISABLE_TLS13 22197 - Type: bool 22198 - Default: false 22199 22200 #### --ftp-shut-timeout 22201 22202 Maximum time to wait for data connection closing status. 22203 22204 Properties: 22205 22206 - Config: shut_timeout 22207 - Env Var: RCLONE_FTP_SHUT_TIMEOUT 22208 - Type: Duration 22209 - Default: 1m0s 22210 22211 #### --ftp-ask-password 22212 22213 Allow asking for FTP password when needed. 22214 22215 If this is set and no password is supplied then rclone will ask for a password 22216 22217 22218 Properties: 22219 22220 - Config: ask_password 22221 - Env Var: RCLONE_FTP_ASK_PASSWORD 22222 - Type: bool 22223 - Default: false 22224 22225 #### --ftp-socks-proxy 22226 22227 Socks 5 proxy host. 22228 22229 Supports the format user:pass@host:port, user@host:port, host:port. 22230 22231 Example: 22232 22233 myUser:myPass@localhost:9005 22234 22235 22236 Properties: 22237 22238 - Config: socks_proxy 22239 - Env Var: RCLONE_FTP_SOCKS_PROXY 22240 - Type: string 22241 - Required: false 22242 22243 #### --ftp-encoding 22244 22245 The encoding for the backend. 22246 22247 See the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. 22248 22249 Properties: 22250 22251 - Config: encoding 22252 - Env Var: RCLONE_FTP_ENCODING 22253 - Type: Encoding 22254 - Default: Slash,Del,Ctl,RightSpace,Dot 22255 - Examples: 22256 - "Asterisk,Ctl,Dot,Slash" 22257 - ProFTPd can't handle '*' in file names 22258 - "BackSlash,Ctl,Del,Dot,RightSpace,Slash,SquareBracket" 22259 - PureFTPd can't handle '[]' or '*' in file names 22260 - "Ctl,LeftPeriod,Slash" 22261 - VsFTPd can't handle file names starting with dot 22262 22263 #### --ftp-description 22264 22265 Description of the remote 22266 22267 Properties: 22268 22269 - Config: description 22270 - Env Var: RCLONE_FTP_DESCRIPTION 22271 - Type: string 22272 - Required: false 22273 22274 22275 22276 ## Limitations 22277 22278 FTP servers acting as rclone remotes must support `passive` mode. 22279 The mode cannot be configured as `passive` is the only supported one. 22280 Rclone's FTP implementation is not compatible with `active` mode 22281 as [the library it uses doesn't support it](https://github.com/jlaffaye/ftp/issues/29). 22282 This will likely never be supported due to security concerns. 22283 22284 Rclone's FTP backend does not support any checksums but can compare 22285 file sizes. 22286 22287 `rclone about` is not supported by the FTP backend. Backends without 22288 this capability cannot determine free space for an rclone mount or 22289 use policy `mfs` (most free space) as a member of an rclone union 22290 remote. 22291 22292 See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features) and [rclone about](https://rclone.org/commands/rclone_about/) 22293 22294 The implementation of : `--dump headers`, 22295 `--dump bodies`, `--dump auth` for debugging isn't the same as 22296 for rclone HTTP based backends - it has less fine grained control. 22297 22298 `--timeout` isn't supported (but `--contimeout` is). 22299 22300 `--bind` isn't supported. 22301 22302 Rclone's FTP backend could support server-side move but does not 22303 at present. 22304 22305 The `ftp_proxy` environment variable is not currently supported. 22306 22307 ### Modification times 22308 22309 File modification time (timestamps) is supported to 1 second resolution 22310 for major FTP servers: ProFTPd, PureFTPd, VsFTPd, and FileZilla FTP server. 22311 The `VsFTPd` server has non-standard implementation of time related protocol 22312 commands and needs a special configuration setting: `writing_mdtm = true`. 22313 22314 Support for precise file time with other FTP servers varies depending on what 22315 protocol extensions they advertise. If all the `MLSD`, `MDTM` and `MFTM` 22316 extensions are present, rclone will use them together to provide precise time. 22317 Otherwise the times you see on the FTP server through rclone are those of the 22318 last file upload. 22319 22320 You can use the following command to check whether rclone can use precise time 22321 with your FTP server: `rclone backend features your_ftp_remote:` (the trailing 22322 colon is important). Look for the number in the line tagged by `Precision` 22323 designating the remote time precision expressed as nanoseconds. A value of 22324 `1000000000` means that file time precision of 1 second is available. 22325 A value of `3153600000000000000` (or another large number) means "unsupported". 22326 22327 # Google Cloud Storage 22328 22329 Paths are specified as `remote:bucket` (or `remote:` for the `lsd` 22330 command.) You may put subdirectories in too, e.g. `remote:bucket/path/to/dir`. 22331 22332 ## Configuration 22333 22334 The initial setup for google cloud storage involves getting a token from Google Cloud Storage 22335 which you need to do in your browser. `rclone config` walks you 22336 through it. 22337 22338 Here is an example of how to make a remote called `remote`. First run: 22339 22340 rclone config 22341 22342 This will guide you through an interactive setup process: 22343 </code></pre> 22344 <ol start="14" type="a"> 22345 <li>New remote</li> 22346 <li>Delete remote</li> 22347 <li>Quit config e/n/d/q> n name> remote Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Google Cloud Storage (this is not Google Drive) "google cloud storage" [snip] Storage> google cloud storage Google Application Client Id - leave blank normally. client_id> Google Application Client Secret - leave blank normally. client_secret> Project number optional - needed only for list/create/delete buckets - see your developer console. project_number> 12345678 Service Account Credentials JSON file path - needed only if you want use SA instead of interactive login. service_account_file> Access Control List for new objects. Choose a number from below, or type in your own value 1 / Object owner gets OWNER access, and all Authenticated Users get READER access. "authenticatedRead" 2 / Object owner gets OWNER access, and project team owners get OWNER access. "bucketOwnerFullControl" 3 / Object owner gets OWNER access, and project team owners get READER access. "bucketOwnerRead" 4 / Object owner gets OWNER access [default if left blank]. "private" 5 / Object owner gets OWNER access, and project team members get access according to their roles. "projectPrivate" 6 / Object owner gets OWNER access, and all Users get READER access. "publicRead" object_acl> 4 Access Control List for new buckets. Choose a number from below, or type in your own value 1 / Project team owners get OWNER access, and all Authenticated Users get READER access. "authenticatedRead" 2 / Project team owners get OWNER access [default if left blank]. "private" 3 / Project team members get access according to their roles. "projectPrivate" 4 / Project team owners get OWNER access, and all Users get READER access. "publicRead" 5 / Project team owners get OWNER access, and all Users get WRITER access. "publicReadWrite" bucket_acl> 2 Location for the newly created buckets. Choose a number from below, or type in your own value 1 / Empty for default location (US). "" 2 / Multi-regional location for Asia. "asia" 3 / Multi-regional location for Europe. "eu" 4 / Multi-regional location for United States. "us" 5 / Taiwan. "asia-east1" 6 / Tokyo. "asia-northeast1" 7 / Singapore. "asia-southeast1" 8 / Sydney. "australia-southeast1" 9 / Belgium. "europe-west1" 10 / London. "europe-west2" 11 / Iowa. "us-central1" 12 / South Carolina. "us-east1" 13 / Northern Virginia. "us-east4" 14 / Oregon. "us-west1" location> 12 The storage class to use when storing objects in Google Cloud Storage. Choose a number from below, or type in your own value 1 / Default "" 2 / Multi-regional storage class "MULTI_REGIONAL" 3 / Regional storage class "REGIONAL" 4 / Nearline storage class "NEARLINE" 5 / Coldline storage class "COLDLINE" 6 / Durable reduced availability storage class "DURABLE_REDUCED_AVAILABILITY" storage_class> 5 Remote config Use web browser to automatically authenticate rclone with remote?</li> 22348 </ol> 22349 <ul> 22350 <li>Say Y if the machine running rclone has a web browser you can use</li> 22351 <li>Say N if running rclone on a (remote) machine without web browser access If not sure try Y. If Y failed, try N.</li> 22352 </ul> 22353 <ol start="25" type="a"> 22354 <li>Yes</li> 22355 <li>No y/n> y If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth Log in and authorize rclone for access Waiting for code... Got code -------------------- [remote] type = google cloud storage client_id = client_secret = token = {"AccessToken":"xxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","RefreshToken":"x/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxxxxx","Expiry":"2014-07-17T20:49:14.929208288+01:00","Extra":null} project_number = 12345678 object_acl = private bucket_acl = private --------------------</li> 22356 <li>Yes this is OK</li> 22357 <li>Edit this remote</li> 22358 <li>Delete this remote y/e/d> y</li> 22359 </ol> 22360 <pre><code> 22361 See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a 22362 machine with no Internet browser available. 22363 22364 Note that rclone runs a webserver on your local machine to collect the 22365 token as returned from Google if using web browser to automatically 22366 authenticate. This only 22367 runs from the moment it opens your browser to the moment you get back 22368 the verification code. This is on `http://127.0.0.1:53682/` and this 22369 it may require you to unblock it temporarily if you are running a host 22370 firewall, or use manual mode. 22371 22372 This remote is called `remote` and can now be used like this 22373 22374 See all the buckets in your project 22375 22376 rclone lsd remote: 22377 22378 Make a new bucket 22379 22380 rclone mkdir remote:bucket 22381 22382 List the contents of a bucket 22383 22384 rclone ls remote:bucket 22385 22386 Sync `/home/local/directory` to the remote bucket, deleting any excess 22387 files in the bucket. 22388 22389 rclone sync --interactive /home/local/directory remote:bucket 22390 22391 ### Service Account support 22392 22393 You can set up rclone with Google Cloud Storage in an unattended mode, 22394 i.e. not tied to a specific end-user Google account. This is useful 22395 when you want to synchronise files onto machines that don't have 22396 actively logged-in users, for example build machines. 22397 22398 To get credentials for Google Cloud Platform 22399 [IAM Service Accounts](https://cloud.google.com/iam/docs/service-accounts), 22400 please head to the 22401 [Service Account](https://console.cloud.google.com/permissions/serviceaccounts) 22402 section of the Google Developer Console. Service Accounts behave just 22403 like normal `User` permissions in 22404 [Google Cloud Storage ACLs](https://cloud.google.com/storage/docs/access-control), 22405 so you can limit their access (e.g. make them read only). After 22406 creating an account, a JSON file containing the Service Account's 22407 credentials will be downloaded onto your machines. These credentials 22408 are what rclone will use for authentication. 22409 22410 To use a Service Account instead of OAuth2 token flow, enter the path 22411 to your Service Account credentials at the `service_account_file` 22412 prompt and rclone won't use the browser based authentication 22413 flow. If you'd rather stuff the contents of the credentials file into 22414 the rclone config file, you can set `service_account_credentials` with 22415 the actual contents of the file instead, or set the equivalent 22416 environment variable. 22417 22418 ### Anonymous Access 22419 22420 For downloads of objects that permit public access you can configure rclone 22421 to use anonymous access by setting `anonymous` to `true`. 22422 With unauthorized access you can't write or create files but only read or list 22423 those buckets and objects that have public read access. 22424 22425 ### Application Default Credentials 22426 22427 If no other source of credentials is provided, rclone will fall back 22428 to 22429 [Application Default Credentials](https://cloud.google.com/video-intelligence/docs/common/auth#authenticating_with_application_default_credentials) 22430 this is useful both when you already have configured authentication 22431 for your developer account, or in production when running on a google 22432 compute host. Note that if running in docker, you may need to run 22433 additional commands on your google compute machine - 22434 [see this page](https://cloud.google.com/container-registry/docs/advanced-authentication#gcloud_as_a_docker_credential_helper). 22435 22436 Note that in the case application default credentials are used, there 22437 is no need to explicitly configure a project number. 22438 22439 ### --fast-list 22440 22441 This remote supports `--fast-list` which allows you to use fewer 22442 transactions in exchange for more memory. See the [rclone 22443 docs](https://rclone.org/docs/#fast-list) for more details. 22444 22445 ### Custom upload headers 22446 22447 You can set custom upload headers with the `--header-upload` 22448 flag. Google Cloud Storage supports the headers as described in the 22449 [working with metadata documentation](https://cloud.google.com/storage/docs/gsutil/addlhelp/WorkingWithObjectMetadata) 22450 22451 - Cache-Control 22452 - Content-Disposition 22453 - Content-Encoding 22454 - Content-Language 22455 - Content-Type 22456 - X-Goog-Storage-Class 22457 - X-Goog-Meta- 22458 22459 Eg `--header-upload "Content-Type text/potato"` 22460 22461 Note that the last of these is for setting custom metadata in the form 22462 `--header-upload "x-goog-meta-key: value"` 22463 22464 ### Modification times 22465 22466 Google Cloud Storage stores md5sum natively. 22467 Google's [gsutil](https://cloud.google.com/storage/docs/gsutil) tool stores modification time 22468 with one-second precision as `goog-reserved-file-mtime` in file metadata. 22469 22470 To ensure compatibility with gsutil, rclone stores modification time in 2 separate metadata entries. 22471 `mtime` uses RFC3339 format with one-nanosecond precision. 22472 `goog-reserved-file-mtime` uses Unix timestamp format with one-second precision. 22473 To get modification time from object metadata, rclone reads the metadata in the following order: `mtime`, `goog-reserved-file-mtime`, object updated time. 22474 22475 Note that rclone's default modify window is 1ns. 22476 Files uploaded by gsutil only contain timestamps with one-second precision. 22477 If you use rclone to sync files previously uploaded by gsutil, 22478 rclone will attempt to update modification time for all these files. 22479 To avoid these possibly unnecessary updates, use `--modify-window 1s`. 22480 22481 ### Restricted filename characters 22482 22483 | Character | Value | Replacement | 22484 | --------- |:-----:|:-----------:| 22485 | NUL | 0x00 | ␀ | 22486 | LF | 0x0A | ␊ | 22487 | CR | 0x0D | ␍ | 22488 | / | 0x2F | ／ | 22489 22490 Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8), 22491 as they can't be used in JSON strings. 22492 22493 22494 ### Standard options 22495 22496 Here are the Standard options specific to google cloud storage (Google Cloud Storage (this is not Google Drive)). 22497 22498 #### --gcs-client-id 22499 22500 OAuth Client Id. 22501 22502 Leave blank normally. 22503 22504 Properties: 22505 22506 - Config: client_id 22507 - Env Var: RCLONE_GCS_CLIENT_ID 22508 - Type: string 22509 - Required: false 22510 22511 #### --gcs-client-secret 22512 22513 OAuth Client Secret. 22514 22515 Leave blank normally. 22516 22517 Properties: 22518 22519 - Config: client_secret 22520 - Env Var: RCLONE_GCS_CLIENT_SECRET 22521 - Type: string 22522 - Required: false 22523 22524 #### --gcs-project-number 22525 22526 Project number. 22527 22528 Optional - needed only for list/create/delete buckets - see your developer console. 22529 22530 Properties: 22531 22532 - Config: project_number 22533 - Env Var: RCLONE_GCS_PROJECT_NUMBER 22534 - Type: string 22535 - Required: false 22536 22537 #### --gcs-user-project 22538 22539 User project. 22540 22541 Optional - needed only for requester pays. 22542 22543 Properties: 22544 22545 - Config: user_project 22546 - Env Var: RCLONE_GCS_USER_PROJECT 22547 - Type: string 22548 - Required: false 22549 22550 #### --gcs-service-account-file 22551 22552 Service Account Credentials JSON file path. 22553 22554 Leave blank normally. 22555 Needed only if you want use SA instead of interactive login. 22556 22557 Leading `~` will be expanded in the file name as will environment variables such as `${RCLONE_CONFIG_DIR}`. 22558 22559 Properties: 22560 22561 - Config: service_account_file 22562 - Env Var: RCLONE_GCS_SERVICE_ACCOUNT_FILE 22563 - Type: string 22564 - Required: false 22565 22566 #### --gcs-service-account-credentials 22567 22568 Service Account Credentials JSON blob. 22569 22570 Leave blank normally. 22571 Needed only if you want use SA instead of interactive login. 22572 22573 Properties: 22574 22575 - Config: service_account_credentials 22576 - Env Var: RCLONE_GCS_SERVICE_ACCOUNT_CREDENTIALS 22577 - Type: string 22578 - Required: false 22579 22580 #### --gcs-anonymous 22581 22582 Access public buckets and objects without credentials. 22583 22584 Set to 'true' if you just want to download files and don't configure credentials. 22585 22586 Properties: 22587 22588 - Config: anonymous 22589 - Env Var: RCLONE_GCS_ANONYMOUS 22590 - Type: bool 22591 - Default: false 22592 22593 #### --gcs-object-acl 22594 22595 Access Control List for new objects. 22596 22597 Properties: 22598 22599 - Config: object_acl 22600 - Env Var: RCLONE_GCS_OBJECT_ACL 22601 - Type: string 22602 - Required: false 22603 - Examples: 22604 - "authenticatedRead" 22605 - Object owner gets OWNER access. 22606 - All Authenticated Users get READER access. 22607 - "bucketOwnerFullControl" 22608 - Object owner gets OWNER access. 22609 - Project team owners get OWNER access. 22610 - "bucketOwnerRead" 22611 - Object owner gets OWNER access. 22612 - Project team owners get READER access. 22613 - "private" 22614 - Object owner gets OWNER access. 22615 - Default if left blank. 22616 - "projectPrivate" 22617 - Object owner gets OWNER access. 22618 - Project team members get access according to their roles. 22619 - "publicRead" 22620 - Object owner gets OWNER access. 22621 - All Users get READER access. 22622 22623 #### --gcs-bucket-acl 22624 22625 Access Control List for new buckets. 22626 22627 Properties: 22628 22629 - Config: bucket_acl 22630 - Env Var: RCLONE_GCS_BUCKET_ACL 22631 - Type: string 22632 - Required: false 22633 - Examples: 22634 - "authenticatedRead" 22635 - Project team owners get OWNER access. 22636 - All Authenticated Users get READER access. 22637 - "private" 22638 - Project team owners get OWNER access. 22639 - Default if left blank. 22640 - "projectPrivate" 22641 - Project team members get access according to their roles. 22642 - "publicRead" 22643 - Project team owners get OWNER access. 22644 - All Users get READER access. 22645 - "publicReadWrite" 22646 - Project team owners get OWNER access. 22647 - All Users get WRITER access. 22648 22649 #### --gcs-bucket-policy-only 22650 22651 Access checks should use bucket-level IAM policies. 22652 22653 If you want to upload objects to a bucket with Bucket Policy Only set 22654 then you will need to set this. 22655 22656 When it is set, rclone: 22657 22658 - ignores ACLs set on buckets 22659 - ignores ACLs set on objects 22660 - creates buckets with Bucket Policy Only set 22661 22662 Docs: https://cloud.google.com/storage/docs/bucket-policy-only 22663 22664 22665 Properties: 22666 22667 - Config: bucket_policy_only 22668 - Env Var: RCLONE_GCS_BUCKET_POLICY_ONLY 22669 - Type: bool 22670 - Default: false 22671 22672 #### --gcs-location 22673 22674 Location for the newly created buckets. 22675 22676 Properties: 22677 22678 - Config: location 22679 - Env Var: RCLONE_GCS_LOCATION 22680 - Type: string 22681 - Required: false 22682 - Examples: 22683 - "" 22684 - Empty for default location (US) 22685 - "asia" 22686 - Multi-regional location for Asia 22687 - "eu" 22688 - Multi-regional location for Europe 22689 - "us" 22690 - Multi-regional location for United States 22691 - "asia-east1" 22692 - Taiwan 22693 - "asia-east2" 22694 - Hong Kong 22695 - "asia-northeast1" 22696 - Tokyo 22697 - "asia-northeast2" 22698 - Osaka 22699 - "asia-northeast3" 22700 - Seoul 22701 - "asia-south1" 22702 - Mumbai 22703 - "asia-south2" 22704 - Delhi 22705 - "asia-southeast1" 22706 - Singapore 22707 - "asia-southeast2" 22708 - Jakarta 22709 - "australia-southeast1" 22710 - Sydney 22711 - "australia-southeast2" 22712 - Melbourne 22713 - "europe-north1" 22714 - Finland 22715 - "europe-west1" 22716 - Belgium 22717 - "europe-west2" 22718 - London 22719 - "europe-west3" 22720 - Frankfurt 22721 - "europe-west4" 22722 - Netherlands 22723 - "europe-west6" 22724 - Zürich 22725 - "europe-central2" 22726 - Warsaw 22727 - "us-central1" 22728 - Iowa 22729 - "us-east1" 22730 - South Carolina 22731 - "us-east4" 22732 - Northern Virginia 22733 - "us-west1" 22734 - Oregon 22735 - "us-west2" 22736 - California 22737 - "us-west3" 22738 - Salt Lake City 22739 - "us-west4" 22740 - Las Vegas 22741 - "northamerica-northeast1" 22742 - Montréal 22743 - "northamerica-northeast2" 22744 - Toronto 22745 - "southamerica-east1" 22746 - São Paulo 22747 - "southamerica-west1" 22748 - Santiago 22749 - "asia1" 22750 - Dual region: asia-northeast1 and asia-northeast2. 22751 - "eur4" 22752 - Dual region: europe-north1 and europe-west4. 22753 - "nam4" 22754 - Dual region: us-central1 and us-east1. 22755 22756 #### --gcs-storage-class 22757 22758 The storage class to use when storing objects in Google Cloud Storage. 22759 22760 Properties: 22761 22762 - Config: storage_class 22763 - Env Var: RCLONE_GCS_STORAGE_CLASS 22764 - Type: string 22765 - Required: false 22766 - Examples: 22767 - "" 22768 - Default 22769 - "MULTI_REGIONAL" 22770 - Multi-regional storage class 22771 - "REGIONAL" 22772 - Regional storage class 22773 - "NEARLINE" 22774 - Nearline storage class 22775 - "COLDLINE" 22776 - Coldline storage class 22777 - "ARCHIVE" 22778 - Archive storage class 22779 - "DURABLE_REDUCED_AVAILABILITY" 22780 - Durable reduced availability storage class 22781 22782 #### --gcs-env-auth 22783 22784 Get GCP IAM credentials from runtime (environment variables or instance meta data if no env vars). 22785 22786 Only applies if service_account_file and service_account_credentials is blank. 22787 22788 Properties: 22789 22790 - Config: env_auth 22791 - Env Var: RCLONE_GCS_ENV_AUTH 22792 - Type: bool 22793 - Default: false 22794 - Examples: 22795 - "false" 22796 - Enter credentials in the next step. 22797 - "true" 22798 - Get GCP IAM credentials from the environment (env vars or IAM). 22799 22800 ### Advanced options 22801 22802 Here are the Advanced options specific to google cloud storage (Google Cloud Storage (this is not Google Drive)). 22803 22804 #### --gcs-token 22805 22806 OAuth Access Token as a JSON blob. 22807 22808 Properties: 22809 22810 - Config: token 22811 - Env Var: RCLONE_GCS_TOKEN 22812 - Type: string 22813 - Required: false 22814 22815 #### --gcs-auth-url 22816 22817 Auth server URL. 22818 22819 Leave blank to use the provider defaults. 22820 22821 Properties: 22822 22823 - Config: auth_url 22824 - Env Var: RCLONE_GCS_AUTH_URL 22825 - Type: string 22826 - Required: false 22827 22828 #### --gcs-token-url 22829 22830 Token server url. 22831 22832 Leave blank to use the provider defaults. 22833 22834 Properties: 22835 22836 - Config: token_url 22837 - Env Var: RCLONE_GCS_TOKEN_URL 22838 - Type: string 22839 - Required: false 22840 22841 #### --gcs-directory-markers 22842 22843 Upload an empty object with a trailing slash when a new directory is created 22844 22845 Empty folders are unsupported for bucket based remotes, this option creates an empty 22846 object ending with "/", to persist the folder. 22847 22848 22849 Properties: 22850 22851 - Config: directory_markers 22852 - Env Var: RCLONE_GCS_DIRECTORY_MARKERS 22853 - Type: bool 22854 - Default: false 22855 22856 #### --gcs-no-check-bucket 22857 22858 If set, don't attempt to check the bucket exists or create it. 22859 22860 This can be useful when trying to minimise the number of transactions 22861 rclone does if you know the bucket exists already. 22862 22863 22864 Properties: 22865 22866 - Config: no_check_bucket 22867 - Env Var: RCLONE_GCS_NO_CHECK_BUCKET 22868 - Type: bool 22869 - Default: false 22870 22871 #### --gcs-decompress 22872 22873 If set this will decompress gzip encoded objects. 22874 22875 It is possible to upload objects to GCS with "Content-Encoding: gzip" 22876 set. Normally rclone will download these files as compressed objects. 22877 22878 If this flag is set then rclone will decompress these files with 22879 "Content-Encoding: gzip" as they are received. This means that rclone 22880 can't check the size and hash but the file contents will be decompressed. 22881 22882 22883 Properties: 22884 22885 - Config: decompress 22886 - Env Var: RCLONE_GCS_DECOMPRESS 22887 - Type: bool 22888 - Default: false 22889 22890 #### --gcs-endpoint 22891 22892 Endpoint for the service. 22893 22894 Leave blank normally. 22895 22896 Properties: 22897 22898 - Config: endpoint 22899 - Env Var: RCLONE_GCS_ENDPOINT 22900 - Type: string 22901 - Required: false 22902 22903 #### --gcs-encoding 22904 22905 The encoding for the backend. 22906 22907 See the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. 22908 22909 Properties: 22910 22911 - Config: encoding 22912 - Env Var: RCLONE_GCS_ENCODING 22913 - Type: Encoding 22914 - Default: Slash,CrLf,InvalidUtf8,Dot 22915 22916 #### --gcs-description 22917 22918 Description of the remote 22919 22920 Properties: 22921 22922 - Config: description 22923 - Env Var: RCLONE_GCS_DESCRIPTION 22924 - Type: string 22925 - Required: false 22926 22927 22928 22929 ## Limitations 22930 22931 `rclone about` is not supported by the Google Cloud Storage backend. Backends without 22932 this capability cannot determine free space for an rclone mount or 22933 use policy `mfs` (most free space) as a member of an rclone union 22934 remote. 22935 22936 See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features) and [rclone about](https://rclone.org/commands/rclone_about/) 22937 22938 # Google Drive 22939 22940 Paths are specified as `drive:path` 22941 22942 Drive paths may be as deep as required, e.g. `drive:directory/subdirectory`. 22943 22944 ## Configuration 22945 22946 The initial setup for drive involves getting a token from Google drive 22947 which you need to do in your browser. `rclone config` walks you 22948 through it. 22949 22950 Here is an example of how to make a remote called `remote`. First run: 22951 22952 rclone config 22953 22954 This will guide you through an interactive setup process: 22955 </code></pre> 22956 <p>No remotes found, make a new one? n) New remote r) Rename remote c) Copy remote s) Set configuration password q) Quit config n/r/c/s/q> n name> remote Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Google Drive "drive" [snip] Storage> drive Google Application Client Id - leave blank normally. client_id> Google Application Client Secret - leave blank normally. client_secret> Scope that rclone should use when requesting access from drive. Choose a number from below, or type in your own value 1 / Full access all files, excluding Application Data Folder. "drive" 2 / Read-only access to file metadata and file contents. "drive.readonly" / Access to files created by rclone only. 3 | These are visible in the drive website. | File authorization is revoked when the user deauthorizes the app. "drive.file" / Allows read and write access to the Application Data folder. 4 | This is not visible in the drive website. "drive.appfolder" / Allows read-only access to file metadata but 5 | does not allow any access to read or download file content. "drive.metadata.readonly" scope> 1 Service Account Credentials JSON file path - needed only if you want use SA instead of interactive login. service_account_file> Remote config Use web browser to automatically authenticate rclone with remote? * Say Y if the machine running rclone has a web browser you can use * Say N if running rclone on a (remote) machine without web browser access If not sure try Y. If Y failed, try N. y) Yes n) No y/n> y If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth Log in and authorize rclone for access Waiting for code... Got code Configure this as a Shared Drive (Team Drive)? y) Yes n) No y/n> n -------------------- [remote] client_id = client_secret = scope = drive root_folder_id = service_account_file = token = {"access_token":"XXX","token_type":"Bearer","refresh_token":"XXX","expiry":"2014-03-16T13:57:58.955387075Z"} -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y</p> 22957 <pre><code> 22958 See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a 22959 machine with no Internet browser available. 22960 22961 Note that rclone runs a webserver on your local machine to collect the 22962 token as returned from Google if using web browser to automatically 22963 authenticate. This only 22964 runs from the moment it opens your browser to the moment you get back 22965 the verification code. This is on `http://127.0.0.1:53682/` and it 22966 may require you to unblock it temporarily if you are running a host 22967 firewall, or use manual mode. 22968 22969 You can then use it like this, 22970 22971 List directories in top level of your drive 22972 22973 rclone lsd remote: 22974 22975 List all the files in your drive 22976 22977 rclone ls remote: 22978 22979 To copy a local directory to a drive directory called backup 22980 22981 rclone copy /home/source remote:backup 22982 22983 ### Scopes 22984 22985 Rclone allows you to select which scope you would like for rclone to 22986 use. This changes what type of token is granted to rclone. [The 22987 scopes are defined 22988 here](https://developers.google.com/drive/v3/web/about-auth). 22989 22990 A comma-separated list is allowed e.g. `drive.readonly,drive.file`. 22991 22992 The scope are 22993 22994 #### drive 22995 22996 This is the default scope and allows full access to all files, except 22997 for the Application Data Folder (see below). 22998 22999 Choose this one if you aren't sure. 23000 23001 #### drive.readonly 23002 23003 This allows read only access to all files. Files may be listed and 23004 downloaded but not uploaded, renamed or deleted. 23005 23006 #### drive.file 23007 23008 With this scope rclone can read/view/modify only those files and 23009 folders it creates. 23010 23011 So if you uploaded files to drive via the web interface (or any other 23012 means) they will not be visible to rclone. 23013 23014 This can be useful if you are using rclone to backup data and you want 23015 to be sure confidential data on your drive is not visible to rclone. 23016 23017 Files created with this scope are visible in the web interface. 23018 23019 #### drive.appfolder 23020 23021 This gives rclone its own private area to store files. Rclone will 23022 not be able to see any other files on your drive and you won't be able 23023 to see rclone's files from the web interface either. 23024 23025 #### drive.metadata.readonly 23026 23027 This allows read only access to file names only. It does not allow 23028 rclone to download or upload data, or rename or delete files or 23029 directories. 23030 23031 ### Root folder ID 23032 23033 This option has been moved to the advanced section. You can set the `root_folder_id` for rclone. This is the directory 23034 (identified by its `Folder ID`) that rclone considers to be the root 23035 of your drive. 23036 23037 Normally you will leave this blank and rclone will determine the 23038 correct root to use itself. 23039 23040 However you can set this to restrict rclone to a specific folder 23041 hierarchy or to access data within the "Computers" tab on the drive 23042 web interface (where files from Google's Backup and Sync desktop 23043 program go). 23044 23045 In order to do this you will have to find the `Folder ID` of the 23046 directory you wish rclone to display. This will be the last segment 23047 of the URL when you open the relevant folder in the drive web 23048 interface. 23049 23050 So if the folder you want rclone to use has a URL which looks like 23051 `https://drive.google.com/drive/folders/1XyfxxxxxxxxxxxxxxxxxxxxxxxxxKHCh` 23052 in the browser, then you use `1XyfxxxxxxxxxxxxxxxxxxxxxxxxxKHCh` as 23053 the `root_folder_id` in the config. 23054 23055 **NB** folders under the "Computers" tab seem to be read only (drive 23056 gives a 500 error) when using rclone. 23057 23058 There doesn't appear to be an API to discover the folder IDs of the 23059 "Computers" tab - please contact us if you know otherwise! 23060 23061 Note also that rclone can't access any data under the "Backups" tab on 23062 the google drive web interface yet. 23063 23064 ### Service Account support 23065 23066 You can set up rclone with Google Drive in an unattended mode, 23067 i.e. not tied to a specific end-user Google account. This is useful 23068 when you want to synchronise files onto machines that don't have 23069 actively logged-in users, for example build machines. 23070 23071 To use a Service Account instead of OAuth2 token flow, enter the path 23072 to your Service Account credentials at the `service_account_file` 23073 prompt during `rclone config` and rclone won't use the browser based 23074 authentication flow. If you'd rather stuff the contents of the 23075 credentials file into the rclone config file, you can set 23076 `service_account_credentials` with the actual contents of the file 23077 instead, or set the equivalent environment variable. 23078 23079 #### Use case - Google Apps/G-suite account and individual Drive 23080 23081 Let's say that you are the administrator of a Google Apps (old) or 23082 G-suite account. 23083 The goal is to store data on an individual's Drive account, who IS 23084 a member of the domain. 23085 We'll call the domain **example.com**, and the user 23086 **foo@example.com**. 23087 23088 There's a few steps we need to go through to accomplish this: 23089 23090 ##### 1. Create a service account for example.com 23091 - To create a service account and obtain its credentials, go to the 23092 [Google Developer Console](https://console.developers.google.com). 23093 - You must have a project - create one if you don't. 23094 - Then go to "IAM & admin" -> "Service Accounts". 23095 - Use the "Create Service Account" button. Fill in "Service account name" 23096 and "Service account ID" with something that identifies your client. 23097 - Select "Create And Continue". Step 2 and 3 are optional. 23098 - These credentials are what rclone will use for authentication. 23099 If you ever need to remove access, press the "Delete service 23100 account key" button. 23101 23102 ##### 2. Allowing API access to example.com Google Drive 23103 - Go to example.com's admin console 23104 - Go into "Security" (or use the search bar) 23105 - Select "Show more" and then "Advanced settings" 23106 - Select "Manage API client access" in the "Authentication" section 23107 - In the "Client Name" field enter the service account's 23108 "Client ID" - this can be found in the Developer Console under 23109 "IAM & Admin" -> "Service Accounts", then "View Client ID" for 23110 the newly created service account. 23111 It is a ~21 character numerical string. 23112 - In the next field, "One or More API Scopes", enter 23113 `https://www.googleapis.com/auth/drive` 23114 to grant access to Google Drive specifically. 23115 23116 ##### 3. Configure rclone, assuming a new install 23117 </code></pre> 23118 <p>rclone config</p> 23119 <p>n/s/q> n # New name>gdrive # Gdrive is an example name Storage> # Select the number shown for Google Drive client_id> # Can be left blank client_secret> # Can be left blank scope> # Select your scope, 1 for example root_folder_id> # Can be left blank service_account_file> /home/foo/myJSONfile.json # This is where the JSON file goes! y/n> # Auto config, n</p> 23120 <pre><code> 23121 ##### 4. Verify that it's working 23122 - `rclone -v --drive-impersonate foo@example.com lsf gdrive:backup` 23123 - The arguments do: 23124 - `-v` - verbose logging 23125 - `--drive-impersonate foo@example.com` - this is what does 23126 the magic, pretending to be user foo. 23127 - `lsf` - list files in a parsing friendly way 23128 - `gdrive:backup` - use the remote called gdrive, work in 23129 the folder named backup. 23130 23131 Note: in case you configured a specific root folder on gdrive and rclone is unable to access the contents of that folder when using `--drive-impersonate`, do this instead: 23132 - in the gdrive web interface, share your root folder with the user/email of the new Service Account you created/selected at step #1 23133 - use rclone without specifying the `--drive-impersonate` option, like this: 23134 `rclone -v lsf gdrive:backup` 23135 23136 23137 ### Shared drives (team drives) 23138 23139 If you want to configure the remote to point to a Google Shared Drive 23140 (previously known as Team Drives) then answer `y` to the question 23141 `Configure this as a Shared Drive (Team Drive)?`. 23142 23143 This will fetch the list of Shared Drives from google and allow you to 23144 configure which one you want to use. You can also type in a Shared 23145 Drive ID if you prefer. 23146 23147 For example: 23148 </code></pre> 23149 <p>Configure this as a Shared Drive (Team Drive)? y) Yes n) No y/n> y Fetching Shared Drive list... Choose a number from below, or type in your own value 1 / Rclone Test "xxxxxxxxxxxxxxxxxxxx" 2 / Rclone Test 2 "yyyyyyyyyyyyyyyyyyyy" 3 / Rclone Test 3 "zzzzzzzzzzzzzzzzzzzz" Enter a Shared Drive ID> 1 -------------------- [remote] client_id = client_secret = token = {"AccessToken":"xxxx.x.xxxxx_xxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","RefreshToken":"1/xxxxxxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxx","Expiry":"2014-03-16T13:57:58.955387075Z","Extra":null} team_drive = xxxxxxxxxxxxxxxxxxxx -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y</p> 23150 <pre><code> 23151 ### --fast-list 23152 23153 This remote supports `--fast-list` which allows you to use fewer 23154 transactions in exchange for more memory. See the [rclone 23155 docs](https://rclone.org/docs/#fast-list) for more details. 23156 23157 It does this by combining multiple `list` calls into a single API request. 23158 23159 This works by combining many `'%s' in parents` filters into one expression. 23160 To list the contents of directories a, b and c, the following requests will be send by the regular `List` function:</code></pre> 23161 <p>trashed=false and 'a' in parents trashed=false and 'b' in parents trashed=false and 'c' in parents</p> 23162 <pre><code>These can now be combined into a single request:</code></pre> 23163 <p>trashed=false and ('a' in parents or 'b' in parents or 'c' in parents)</p> 23164 <pre><code> 23165 The implementation of `ListR` will put up to 50 `parents` filters into one request. 23166 It will use the `--checkers` value to specify the number of requests to run in parallel. 23167 23168 In tests, these batch requests were up to 20x faster than the regular method. 23169 Running the following command against different sized folders gives:</code></pre> 23170 <p>rclone lsjson -vv -R --checkers=6 gdrive:folder</p> 23171 <pre><code> 23172 small folder (220 directories, 700 files): 23173 23174 - without `--fast-list`: 38s 23175 - with `--fast-list`: 10s 23176 23177 large folder (10600 directories, 39000 files): 23178 23179 - without `--fast-list`: 22:05 min 23180 - with `--fast-list`: 58s 23181 23182 ### Modification times and hashes 23183 23184 Google drive stores modification times accurate to 1 ms. 23185 23186 Hash algorithms MD5, SHA1 and SHA256 are supported. Note, however, 23187 that a small fraction of files uploaded may not have SHA1 or SHA256 23188 hashes especially if they were uploaded before 2018. 23189 23190 ### Restricted filename characters 23191 23192 Only Invalid UTF-8 bytes will be [replaced](https://rclone.org/overview/#invalid-utf8), 23193 as they can't be used in JSON strings. 23194 23195 In contrast to other backends, `/` can also be used in names and `.` 23196 or `..` are valid names. 23197 23198 ### Revisions 23199 23200 Google drive stores revisions of files. When you upload a change to 23201 an existing file to google drive using rclone it will create a new 23202 revision of that file. 23203 23204 Revisions follow the standard google policy which at time of writing 23205 was 23206 23207 * They are deleted after 30 days or 100 revisions (whatever comes first). 23208 * They do not count towards a user storage quota. 23209 23210 ### Deleting files 23211 23212 By default rclone will send all files to the trash when deleting 23213 files. If deleting them permanently is required then use the 23214 `--drive-use-trash=false` flag, or set the equivalent environment 23215 variable. 23216 23217 ### Shortcuts 23218 23219 In March 2020 Google introduced a new feature in Google Drive called 23220 [drive shortcuts](https://support.google.com/drive/answer/9700156) 23221 ([API](https://developers.google.com/drive/api/v3/shortcuts)). These 23222 will (by September 2020) [replace the ability for files or folders to 23223 be in multiple folders at once](https://cloud.google.com/blog/products/g-suite/simplifying-google-drives-folder-structure-and-sharing-models). 23224 23225 Shortcuts are files that link to other files on Google Drive somewhat 23226 like a symlink in unix, except they point to the underlying file data 23227 (e.g. the inode in unix terms) so they don't break if the source is 23228 renamed or moved about. 23229 23230 By default rclone treats these as follows. 23231 23232 For shortcuts pointing to files: 23233 23234 - When listing a file shortcut appears as the destination file. 23235 - When downloading the contents of the destination file is downloaded. 23236 - When updating shortcut file with a non shortcut file, the shortcut is removed then a new file is uploaded in place of the shortcut. 23237 - When server-side moving (renaming) the shortcut is renamed, not the destination file. 23238 - When server-side copying the shortcut is copied, not the contents of the shortcut. (unless `--drive-copy-shortcut-content` is in use in which case the contents of the shortcut gets copied). 23239 - When deleting the shortcut is deleted not the linked file. 23240 - When setting the modification time, the modification time of the linked file will be set. 23241 23242 For shortcuts pointing to folders: 23243 23244 - When listing the shortcut appears as a folder and that folder will contain the contents of the linked folder appear (including any sub folders) 23245 - When downloading the contents of the linked folder and sub contents are downloaded 23246 - When uploading to a shortcut folder the file will be placed in the linked folder 23247 - When server-side moving (renaming) the shortcut is renamed, not the destination folder 23248 - When server-side copying the contents of the linked folder is copied, not the shortcut. 23249 - When deleting with `rclone rmdir` or `rclone purge` the shortcut is deleted not the linked folder. 23250 - **NB** When deleting with `rclone remove` or `rclone mount` the contents of the linked folder will be deleted. 23251 23252 The [rclone backend](https://rclone.org/commands/rclone_backend/) command can be used to create shortcuts. 23253 23254 Shortcuts can be completely ignored with the `--drive-skip-shortcuts` flag 23255 or the corresponding `skip_shortcuts` configuration setting. 23256 23257 ### Emptying trash 23258 23259 If you wish to empty your trash you can use the `rclone cleanup remote:` 23260 command which will permanently delete all your trashed files. This command 23261 does not take any path arguments. 23262 23263 Note that Google Drive takes some time (minutes to days) to empty the 23264 trash even though the command returns within a few seconds. No output 23265 is echoed, so there will be no confirmation even using -v or -vv. 23266 23267 ### Quota information 23268 23269 To view your current quota you can use the `rclone about remote:` 23270 command which will display your usage limit (quota), the usage in Google 23271 Drive, the size of all files in the Trash and the space used by other 23272 Google services such as Gmail. This command does not take any path 23273 arguments. 23274 23275 #### Import/Export of google documents 23276 23277 Google documents can be exported from and uploaded to Google Drive. 23278 23279 When rclone downloads a Google doc it chooses a format to download 23280 depending upon the `--drive-export-formats` setting. 23281 By default the export formats are `docx,xlsx,pptx,svg` which are a 23282 sensible default for an editable document. 23283 23284 When choosing a format, rclone runs down the list provided in order 23285 and chooses the first file format the doc can be exported as from the 23286 list. If the file can't be exported to a format on the formats list, 23287 then rclone will choose a format from the default list. 23288 23289 If you prefer an archive copy then you might use `--drive-export-formats 23290 pdf`, or if you prefer openoffice/libreoffice formats you might use 23291 `--drive-export-formats ods,odt,odp`. 23292 23293 Note that rclone adds the extension to the google doc, so if it is 23294 called `My Spreadsheet` on google docs, it will be exported as `My 23295 Spreadsheet.xlsx` or `My Spreadsheet.pdf` etc. 23296 23297 When importing files into Google Drive, rclone will convert all 23298 files with an extension in `--drive-import-formats` to their 23299 associated document type. 23300 rclone will not convert any files by default, since the conversion 23301 is lossy process. 23302 23303 The conversion must result in a file with the same extension when 23304 the `--drive-export-formats` rules are applied to the uploaded document. 23305 23306 Here are some examples for allowed and prohibited conversions. 23307 23308 | export-formats | import-formats | Upload Ext | Document Ext | Allowed | 23309 | -------------- | -------------- | ---------- | ------------ | ------- | 23310 | odt | odt | odt | odt | Yes | 23311 | odt | docx,odt | odt | odt | Yes | 23312 | | docx | docx | docx | Yes | 23313 | | odt | odt | docx | No | 23314 | odt,docx | docx,odt | docx | odt | No | 23315 | docx,odt | docx,odt | docx | docx | Yes | 23316 | docx,odt | docx,odt | odt | docx | No | 23317 23318 This limitation can be disabled by specifying `--drive-allow-import-name-change`. 23319 When using this flag, rclone can convert multiple files types resulting 23320 in the same document type at once, e.g. with `--drive-import-formats docx,odt,txt`, 23321 all files having these extension would result in a document represented as a docx file. 23322 This brings the additional risk of overwriting a document, if multiple files 23323 have the same stem. Many rclone operations will not handle this name change 23324 in any way. They assume an equal name when copying files and might copy the 23325 file again or delete them when the name changes. 23326 23327 Here are the possible export extensions with their corresponding mime types. 23328 Most of these can also be used for importing, but there more that are not 23329 listed here. Some of these additional ones might only be available when 23330 the operating system provides the correct MIME type entries. 23331 23332 This list can be changed by Google Drive at any time and might not 23333 represent the currently available conversions. 23334 23335 | Extension | Mime Type | Description | 23336 | --------- |-----------| ------------| 23337 | bmp | image/bmp | Windows Bitmap format | 23338 | csv | text/csv | Standard CSV format for Spreadsheets | 23339 | doc | application/msword | Classic Word file | 23340 | docx | application/vnd.openxmlformats-officedocument.wordprocessingml.document | Microsoft Office Document | 23341 | epub | application/epub+zip | E-book format | 23342 | html | text/html | An HTML Document | 23343 | jpg | image/jpeg | A JPEG Image File | 23344 | json | application/vnd.google-apps.script+json | JSON Text Format for Google Apps scripts | 23345 | odp | application/vnd.oasis.opendocument.presentation | Openoffice Presentation | 23346 | ods | application/vnd.oasis.opendocument.spreadsheet | Openoffice Spreadsheet | 23347 | ods | application/x-vnd.oasis.opendocument.spreadsheet | Openoffice Spreadsheet | 23348 | odt | application/vnd.oasis.opendocument.text | Openoffice Document | 23349 | pdf | application/pdf | Adobe PDF Format | 23350 | pjpeg | image/pjpeg | Progressive JPEG Image | 23351 | png | image/png | PNG Image Format| 23352 | pptx | application/vnd.openxmlformats-officedocument.presentationml.presentation | Microsoft Office Powerpoint | 23353 | rtf | application/rtf | Rich Text Format | 23354 | svg | image/svg+xml | Scalable Vector Graphics Format | 23355 | tsv | text/tab-separated-values | Standard TSV format for spreadsheets | 23356 | txt | text/plain | Plain Text | 23357 | wmf | application/x-msmetafile | Windows Meta File | 23358 | xls | application/vnd.ms-excel | Classic Excel file | 23359 | xlsx | application/vnd.openxmlformats-officedocument.spreadsheetml.sheet | Microsoft Office Spreadsheet | 23360 | zip | application/zip | A ZIP file of HTML, Images CSS | 23361 23362 Google documents can also be exported as link files. These files will 23363 open a browser window for the Google Docs website of that document 23364 when opened. The link file extension has to be specified as a 23365 `--drive-export-formats` parameter. They will match all available 23366 Google Documents. 23367 23368 | Extension | Description | OS Support | 23369 | --------- | ----------- | ---------- | 23370 | desktop | freedesktop.org specified desktop entry | Linux | 23371 | link.html | An HTML Document with a redirect | All | 23372 | url | INI style link file | macOS, Windows | 23373 | webloc | macOS specific XML format | macOS | 23374 23375 23376 ### Standard options 23377 23378 Here are the Standard options specific to drive (Google Drive). 23379 23380 #### --drive-client-id 23381 23382 Google Application Client Id 23383 Setting your own is recommended. 23384 See https://rclone.org/drive/#making-your-own-client-id for how to create your own. 23385 If you leave this blank, it will use an internal key which is low performance. 23386 23387 Properties: 23388 23389 - Config: client_id 23390 - Env Var: RCLONE_DRIVE_CLIENT_ID 23391 - Type: string 23392 - Required: false 23393 23394 #### --drive-client-secret 23395 23396 OAuth Client Secret. 23397 23398 Leave blank normally. 23399 23400 Properties: 23401 23402 - Config: client_secret 23403 - Env Var: RCLONE_DRIVE_CLIENT_SECRET 23404 - Type: string 23405 - Required: false 23406 23407 #### --drive-scope 23408 23409 Comma separated list of scopes that rclone should use when requesting access from drive. 23410 23411 Properties: 23412 23413 - Config: scope 23414 - Env Var: RCLONE_DRIVE_SCOPE 23415 - Type: string 23416 - Required: false 23417 - Examples: 23418 - "drive" 23419 - Full access all files, excluding Application Data Folder. 23420 - "drive.readonly" 23421 - Read-only access to file metadata and file contents. 23422 - "drive.file" 23423 - Access to files created by rclone only. 23424 - These are visible in the drive website. 23425 - File authorization is revoked when the user deauthorizes the app. 23426 - "drive.appfolder" 23427 - Allows read and write access to the Application Data folder. 23428 - This is not visible in the drive website. 23429 - "drive.metadata.readonly" 23430 - Allows read-only access to file metadata but 23431 - does not allow any access to read or download file content. 23432 23433 #### --drive-service-account-file 23434 23435 Service Account Credentials JSON file path. 23436 23437 Leave blank normally. 23438 Needed only if you want use SA instead of interactive login. 23439 23440 Leading `~` will be expanded in the file name as will environment variables such as `${RCLONE_CONFIG_DIR}`. 23441 23442 Properties: 23443 23444 - Config: service_account_file 23445 - Env Var: RCLONE_DRIVE_SERVICE_ACCOUNT_FILE 23446 - Type: string 23447 - Required: false 23448 23449 #### --drive-alternate-export 23450 23451 Deprecated: No longer needed. 23452 23453 Properties: 23454 23455 - Config: alternate_export 23456 - Env Var: RCLONE_DRIVE_ALTERNATE_EXPORT 23457 - Type: bool 23458 - Default: false 23459 23460 ### Advanced options 23461 23462 Here are the Advanced options specific to drive (Google Drive). 23463 23464 #### --drive-token 23465 23466 OAuth Access Token as a JSON blob. 23467 23468 Properties: 23469 23470 - Config: token 23471 - Env Var: RCLONE_DRIVE_TOKEN 23472 - Type: string 23473 - Required: false 23474 23475 #### --drive-auth-url 23476 23477 Auth server URL. 23478 23479 Leave blank to use the provider defaults. 23480 23481 Properties: 23482 23483 - Config: auth_url 23484 - Env Var: RCLONE_DRIVE_AUTH_URL 23485 - Type: string 23486 - Required: false 23487 23488 #### --drive-token-url 23489 23490 Token server url. 23491 23492 Leave blank to use the provider defaults. 23493 23494 Properties: 23495 23496 - Config: token_url 23497 - Env Var: RCLONE_DRIVE_TOKEN_URL 23498 - Type: string 23499 - Required: false 23500 23501 #### --drive-root-folder-id 23502 23503 ID of the root folder. 23504 Leave blank normally. 23505 23506 Fill in to access "Computers" folders (see docs), or for rclone to use 23507 a non root folder as its starting point. 23508 23509 23510 Properties: 23511 23512 - Config: root_folder_id 23513 - Env Var: RCLONE_DRIVE_ROOT_FOLDER_ID 23514 - Type: string 23515 - Required: false 23516 23517 #### --drive-service-account-credentials 23518 23519 Service Account Credentials JSON blob. 23520 23521 Leave blank normally. 23522 Needed only if you want use SA instead of interactive login. 23523 23524 Properties: 23525 23526 - Config: service_account_credentials 23527 - Env Var: RCLONE_DRIVE_SERVICE_ACCOUNT_CREDENTIALS 23528 - Type: string 23529 - Required: false 23530 23531 #### --drive-team-drive 23532 23533 ID of the Shared Drive (Team Drive). 23534 23535 Properties: 23536 23537 - Config: team_drive 23538 - Env Var: RCLONE_DRIVE_TEAM_DRIVE 23539 - Type: string 23540 - Required: false 23541 23542 #### --drive-auth-owner-only 23543 23544 Only consider files owned by the authenticated user. 23545 23546 Properties: 23547 23548 - Config: auth_owner_only 23549 - Env Var: RCLONE_DRIVE_AUTH_OWNER_ONLY 23550 - Type: bool 23551 - Default: false 23552 23553 #### --drive-use-trash 23554 23555 Send files to the trash instead of deleting permanently. 23556 23557 Defaults to true, namely sending files to the trash. 23558 Use `--drive-use-trash=false` to delete files permanently instead. 23559 23560 Properties: 23561 23562 - Config: use_trash 23563 - Env Var: RCLONE_DRIVE_USE_TRASH 23564 - Type: bool 23565 - Default: true 23566 23567 #### --drive-copy-shortcut-content 23568 23569 Server side copy contents of shortcuts instead of the shortcut. 23570 23571 When doing server side copies, normally rclone will copy shortcuts as 23572 shortcuts. 23573 23574 If this flag is used then rclone will copy the contents of shortcuts 23575 rather than shortcuts themselves when doing server side copies. 23576 23577 Properties: 23578 23579 - Config: copy_shortcut_content 23580 - Env Var: RCLONE_DRIVE_COPY_SHORTCUT_CONTENT 23581 - Type: bool 23582 - Default: false 23583 23584 #### --drive-skip-gdocs 23585 23586 Skip google documents in all listings. 23587 23588 If given, gdocs practically become invisible to rclone. 23589 23590 Properties: 23591 23592 - Config: skip_gdocs 23593 - Env Var: RCLONE_DRIVE_SKIP_GDOCS 23594 - Type: bool 23595 - Default: false 23596 23597 #### --drive-show-all-gdocs 23598 23599 Show all Google Docs including non-exportable ones in listings. 23600 23601 If you try a server side copy on a Google Form without this flag, you 23602 will get this error: 23603 23604 No export formats found for "application/vnd.google-apps.form" 23605 23606 However adding this flag will allow the form to be server side copied. 23607 23608 Note that rclone doesn't add extensions to the Google Docs file names 23609 in this mode. 23610 23611 Do **not** use this flag when trying to download Google Docs - rclone 23612 will fail to download them. 23613 23614 23615 Properties: 23616 23617 - Config: show_all_gdocs 23618 - Env Var: RCLONE_DRIVE_SHOW_ALL_GDOCS 23619 - Type: bool 23620 - Default: false 23621 23622 #### --drive-skip-checksum-gphotos 23623 23624 Skip checksums on Google photos and videos only. 23625 23626 Use this if you get checksum errors when transferring Google photos or 23627 videos. 23628 23629 Setting this flag will cause Google photos and videos to return a 23630 blank checksums. 23631 23632 Google photos are identified by being in the "photos" space. 23633 23634 Corrupted checksums are caused by Google modifying the image/video but 23635 not updating the checksum. 23636 23637 Properties: 23638 23639 - Config: skip_checksum_gphotos 23640 - Env Var: RCLONE_DRIVE_SKIP_CHECKSUM_GPHOTOS 23641 - Type: bool 23642 - Default: false 23643 23644 #### --drive-shared-with-me 23645 23646 Only show files that are shared with me. 23647 23648 Instructs rclone to operate on your "Shared with me" folder (where 23649 Google Drive lets you access the files and folders others have shared 23650 with you). 23651 23652 This works both with the "list" (lsd, lsl, etc.) and the "copy" 23653 commands (copy, sync, etc.), and with all other commands too. 23654 23655 Properties: 23656 23657 - Config: shared_with_me 23658 - Env Var: RCLONE_DRIVE_SHARED_WITH_ME 23659 - Type: bool 23660 - Default: false 23661 23662 #### --drive-trashed-only 23663 23664 Only show files that are in the trash. 23665 23666 This will show trashed files in their original directory structure. 23667 23668 Properties: 23669 23670 - Config: trashed_only 23671 - Env Var: RCLONE_DRIVE_TRASHED_ONLY 23672 - Type: bool 23673 - Default: false 23674 23675 #### --drive-starred-only 23676 23677 Only show files that are starred. 23678 23679 Properties: 23680 23681 - Config: starred_only 23682 - Env Var: RCLONE_DRIVE_STARRED_ONLY 23683 - Type: bool 23684 - Default: false 23685 23686 #### --drive-formats 23687 23688 Deprecated: See export_formats. 23689 23690 Properties: 23691 23692 - Config: formats 23693 - Env Var: RCLONE_DRIVE_FORMATS 23694 - Type: string 23695 - Required: false 23696 23697 #### --drive-export-formats 23698 23699 Comma separated list of preferred formats for downloading Google docs. 23700 23701 Properties: 23702 23703 - Config: export_formats 23704 - Env Var: RCLONE_DRIVE_EXPORT_FORMATS 23705 - Type: string 23706 - Default: "docx,xlsx,pptx,svg" 23707 23708 #### --drive-import-formats 23709 23710 Comma separated list of preferred formats for uploading Google docs. 23711 23712 Properties: 23713 23714 - Config: import_formats 23715 - Env Var: RCLONE_DRIVE_IMPORT_FORMATS 23716 - Type: string 23717 - Required: false 23718 23719 #### --drive-allow-import-name-change 23720 23721 Allow the filetype to change when uploading Google docs. 23722 23723 E.g. file.doc to file.docx. This will confuse sync and reupload every time. 23724 23725 Properties: 23726 23727 - Config: allow_import_name_change 23728 - Env Var: RCLONE_DRIVE_ALLOW_IMPORT_NAME_CHANGE 23729 - Type: bool 23730 - Default: false 23731 23732 #### --drive-use-created-date 23733 23734 Use file created date instead of modified date. 23735 23736 Useful when downloading data and you want the creation date used in 23737 place of the last modified date. 23738 23739 **WARNING**: This flag may have some unexpected consequences. 23740 23741 When uploading to your drive all files will be overwritten unless they 23742 haven't been modified since their creation. And the inverse will occur 23743 while downloading. This side effect can be avoided by using the 23744 "--checksum" flag. 23745 23746 This feature was implemented to retain photos capture date as recorded 23747 by google photos. You will first need to check the "Create a Google 23748 Photos folder" option in your google drive settings. You can then copy 23749 or move the photos locally and use the date the image was taken 23750 (created) set as the modification date. 23751 23752 Properties: 23753 23754 - Config: use_created_date 23755 - Env Var: RCLONE_DRIVE_USE_CREATED_DATE 23756 - Type: bool 23757 - Default: false 23758 23759 #### --drive-use-shared-date 23760 23761 Use date file was shared instead of modified date. 23762 23763 Note that, as with "--drive-use-created-date", this flag may have 23764 unexpected consequences when uploading/downloading files. 23765 23766 If both this flag and "--drive-use-created-date" are set, the created 23767 date is used. 23768 23769 Properties: 23770 23771 - Config: use_shared_date 23772 - Env Var: RCLONE_DRIVE_USE_SHARED_DATE 23773 - Type: bool 23774 - Default: false 23775 23776 #### --drive-list-chunk 23777 23778 Size of listing chunk 100-1000, 0 to disable. 23779 23780 Properties: 23781 23782 - Config: list_chunk 23783 - Env Var: RCLONE_DRIVE_LIST_CHUNK 23784 - Type: int 23785 - Default: 1000 23786 23787 #### --drive-impersonate 23788 23789 Impersonate this user when using a service account. 23790 23791 Properties: 23792 23793 - Config: impersonate 23794 - Env Var: RCLONE_DRIVE_IMPERSONATE 23795 - Type: string 23796 - Required: false 23797 23798 #### --drive-upload-cutoff 23799 23800 Cutoff for switching to chunked upload. 23801 23802 Properties: 23803 23804 - Config: upload_cutoff 23805 - Env Var: RCLONE_DRIVE_UPLOAD_CUTOFF 23806 - Type: SizeSuffix 23807 - Default: 8Mi 23808 23809 #### --drive-chunk-size 23810 23811 Upload chunk size. 23812 23813 Must a power of 2 >= 256k. 23814 23815 Making this larger will improve performance, but note that each chunk 23816 is buffered in memory one per transfer. 23817 23818 Reducing this will reduce memory usage but decrease performance. 23819 23820 Properties: 23821 23822 - Config: chunk_size 23823 - Env Var: RCLONE_DRIVE_CHUNK_SIZE 23824 - Type: SizeSuffix 23825 - Default: 8Mi 23826 23827 #### --drive-acknowledge-abuse 23828 23829 Set to allow files which return cannotDownloadAbusiveFile to be downloaded. 23830 23831 If downloading a file returns the error "This file has been identified 23832 as malware or spam and cannot be downloaded" with the error code 23833 "cannotDownloadAbusiveFile" then supply this flag to rclone to 23834 indicate you acknowledge the risks of downloading the file and rclone 23835 will download it anyway. 23836 23837 Note that if you are using service account it will need Manager 23838 permission (not Content Manager) to for this flag to work. If the SA 23839 does not have the right permission, Google will just ignore the flag. 23840 23841 Properties: 23842 23843 - Config: acknowledge_abuse 23844 - Env Var: RCLONE_DRIVE_ACKNOWLEDGE_ABUSE 23845 - Type: bool 23846 - Default: false 23847 23848 #### --drive-keep-revision-forever 23849 23850 Keep new head revision of each file forever. 23851 23852 Properties: 23853 23854 - Config: keep_revision_forever 23855 - Env Var: RCLONE_DRIVE_KEEP_REVISION_FOREVER 23856 - Type: bool 23857 - Default: false 23858 23859 #### --drive-size-as-quota 23860 23861 Show sizes as storage quota usage, not actual size. 23862 23863 Show the size of a file as the storage quota used. This is the 23864 current version plus any older versions that have been set to keep 23865 forever. 23866 23867 **WARNING**: This flag may have some unexpected consequences. 23868 23869 It is not recommended to set this flag in your config - the 23870 recommended usage is using the flag form --drive-size-as-quota when 23871 doing rclone ls/lsl/lsf/lsjson/etc only. 23872 23873 If you do use this flag for syncing (not recommended) then you will 23874 need to use --ignore size also. 23875 23876 Properties: 23877 23878 - Config: size_as_quota 23879 - Env Var: RCLONE_DRIVE_SIZE_AS_QUOTA 23880 - Type: bool 23881 - Default: false 23882 23883 #### --drive-v2-download-min-size 23884 23885 If Object's are greater, use drive v2 API to download. 23886 23887 Properties: 23888 23889 - Config: v2_download_min_size 23890 - Env Var: RCLONE_DRIVE_V2_DOWNLOAD_MIN_SIZE 23891 - Type: SizeSuffix 23892 - Default: off 23893 23894 #### --drive-pacer-min-sleep 23895 23896 Minimum time to sleep between API calls. 23897 23898 Properties: 23899 23900 - Config: pacer_min_sleep 23901 - Env Var: RCLONE_DRIVE_PACER_MIN_SLEEP 23902 - Type: Duration 23903 - Default: 100ms 23904 23905 #### --drive-pacer-burst 23906 23907 Number of API calls to allow without sleeping. 23908 23909 Properties: 23910 23911 - Config: pacer_burst 23912 - Env Var: RCLONE_DRIVE_PACER_BURST 23913 - Type: int 23914 - Default: 100 23915 23916 #### --drive-server-side-across-configs 23917 23918 Deprecated: use --server-side-across-configs instead. 23919 23920 Allow server-side operations (e.g. copy) to work across different drive configs. 23921 23922 This can be useful if you wish to do a server-side copy between two 23923 different Google drives. Note that this isn't enabled by default 23924 because it isn't easy to tell if it will work between any two 23925 configurations. 23926 23927 Properties: 23928 23929 - Config: server_side_across_configs 23930 - Env Var: RCLONE_DRIVE_SERVER_SIDE_ACROSS_CONFIGS 23931 - Type: bool 23932 - Default: false 23933 23934 #### --drive-disable-http2 23935 23936 Disable drive using http2. 23937 23938 There is currently an unsolved issue with the google drive backend and 23939 HTTP/2. HTTP/2 is therefore disabled by default for the drive backend 23940 but can be re-enabled here. When the issue is solved this flag will 23941 be removed. 23942 23943 See: https://github.com/rclone/rclone/issues/3631 23944 23945 23946 23947 Properties: 23948 23949 - Config: disable_http2 23950 - Env Var: RCLONE_DRIVE_DISABLE_HTTP2 23951 - Type: bool 23952 - Default: true 23953 23954 #### --drive-stop-on-upload-limit 23955 23956 Make upload limit errors be fatal. 23957 23958 At the time of writing it is only possible to upload 750 GiB of data to 23959 Google Drive a day (this is an undocumented limit). When this limit is 23960 reached Google Drive produces a slightly different error message. When 23961 this flag is set it causes these errors to be fatal. These will stop 23962 the in-progress sync. 23963 23964 Note that this detection is relying on error message strings which 23965 Google don't document so it may break in the future. 23966 23967 See: https://github.com/rclone/rclone/issues/3857 23968 23969 23970 Properties: 23971 23972 - Config: stop_on_upload_limit 23973 - Env Var: RCLONE_DRIVE_STOP_ON_UPLOAD_LIMIT 23974 - Type: bool 23975 - Default: false 23976 23977 #### --drive-stop-on-download-limit 23978 23979 Make download limit errors be fatal. 23980 23981 At the time of writing it is only possible to download 10 TiB of data from 23982 Google Drive a day (this is an undocumented limit). When this limit is 23983 reached Google Drive produces a slightly different error message. When 23984 this flag is set it causes these errors to be fatal. These will stop 23985 the in-progress sync. 23986 23987 Note that this detection is relying on error message strings which 23988 Google don't document so it may break in the future. 23989 23990 23991 Properties: 23992 23993 - Config: stop_on_download_limit 23994 - Env Var: RCLONE_DRIVE_STOP_ON_DOWNLOAD_LIMIT 23995 - Type: bool 23996 - Default: false 23997 23998 #### --drive-skip-shortcuts 23999 24000 If set skip shortcut files. 24001 24002 Normally rclone dereferences shortcut files making them appear as if 24003 they are the original file (see [the shortcuts section](#shortcuts)). 24004 If this flag is set then rclone will ignore shortcut files completely. 24005 24006 24007 Properties: 24008 24009 - Config: skip_shortcuts 24010 - Env Var: RCLONE_DRIVE_SKIP_SHORTCUTS 24011 - Type: bool 24012 - Default: false 24013 24014 #### --drive-skip-dangling-shortcuts 24015 24016 If set skip dangling shortcut files. 24017 24018 If this is set then rclone will not show any dangling shortcuts in listings. 24019 24020 24021 Properties: 24022 24023 - Config: skip_dangling_shortcuts 24024 - Env Var: RCLONE_DRIVE_SKIP_DANGLING_SHORTCUTS 24025 - Type: bool 24026 - Default: false 24027 24028 #### --drive-resource-key 24029 24030 Resource key for accessing a link-shared file. 24031 24032 If you need to access files shared with a link like this 24033 24034 https://drive.google.com/drive/folders/XXX?resourcekey=YYY&usp=sharing 24035 24036 Then you will need to use the first part "XXX" as the "root_folder_id" 24037 and the second part "YYY" as the "resource_key" otherwise you will get 24038 404 not found errors when trying to access the directory. 24039 24040 See: https://developers.google.com/drive/api/guides/resource-keys 24041 24042 This resource key requirement only applies to a subset of old files. 24043 24044 Note also that opening the folder once in the web interface (with the 24045 user you've authenticated rclone with) seems to be enough so that the 24046 resource key is not needed. 24047 24048 24049 Properties: 24050 24051 - Config: resource_key 24052 - Env Var: RCLONE_DRIVE_RESOURCE_KEY 24053 - Type: string 24054 - Required: false 24055 24056 #### --drive-fast-list-bug-fix 24057 24058 Work around a bug in Google Drive listing. 24059 24060 Normally rclone will work around a bug in Google Drive when using 24061 --fast-list (ListR) where the search "(A in parents) or (B in 24062 parents)" returns nothing sometimes. See #3114, #4289 and 24063 https://issuetracker.google.com/issues/149522397 24064 24065 Rclone detects this by finding no items in more than one directory 24066 when listing and retries them as lists of individual directories. 24067 24068 This means that if you have a lot of empty directories rclone will end 24069 up listing them all individually and this can take many more API 24070 calls. 24071 24072 This flag allows the work-around to be disabled. This is **not** 24073 recommended in normal use - only if you have a particular case you are 24074 having trouble with like many empty directories. 24075 24076 24077 Properties: 24078 24079 - Config: fast_list_bug_fix 24080 - Env Var: RCLONE_DRIVE_FAST_LIST_BUG_FIX 24081 - Type: bool 24082 - Default: true 24083 24084 #### --drive-metadata-owner 24085 24086 Control whether owner should be read or written in metadata. 24087 24088 Owner is a standard part of the file metadata so is easy to read. But it 24089 isn't always desirable to set the owner from the metadata. 24090 24091 Note that you can't set the owner on Shared Drives, and that setting 24092 ownership will generate an email to the new owner (this can't be 24093 disabled), and you can't transfer ownership to someone outside your 24094 organization. 24095 24096 24097 Properties: 24098 24099 - Config: metadata_owner 24100 - Env Var: RCLONE_DRIVE_METADATA_OWNER 24101 - Type: Bits 24102 - Default: read 24103 - Examples: 24104 - "off" 24105 - Do not read or write the value 24106 - "read" 24107 - Read the value only 24108 - "write" 24109 - Write the value only 24110 - "read,write" 24111 - Read and Write the value. 24112 24113 #### --drive-metadata-permissions 24114 24115 Control whether permissions should be read or written in metadata. 24116 24117 Reading permissions metadata from files can be done quickly, but it 24118 isn't always desirable to set the permissions from the metadata. 24119 24120 Note that rclone drops any inherited permissions on Shared Drives and 24121 any owner permission on My Drives as these are duplicated in the owner 24122 metadata. 24123 24124 24125 Properties: 24126 24127 - Config: metadata_permissions 24128 - Env Var: RCLONE_DRIVE_METADATA_PERMISSIONS 24129 - Type: Bits 24130 - Default: off 24131 - Examples: 24132 - "off" 24133 - Do not read or write the value 24134 - "read" 24135 - Read the value only 24136 - "write" 24137 - Write the value only 24138 - "read,write" 24139 - Read and Write the value. 24140 24141 #### --drive-metadata-labels 24142 24143 Control whether labels should be read or written in metadata. 24144 24145 Reading labels metadata from files takes an extra API transaction and 24146 will slow down listings. It isn't always desirable to set the labels 24147 from the metadata. 24148 24149 The format of labels is documented in the drive API documentation at 24150 https://developers.google.com/drive/api/reference/rest/v3/Label - 24151 rclone just provides a JSON dump of this format. 24152 24153 When setting labels, the label and fields must already exist - rclone 24154 will not create them. This means that if you are transferring labels 24155 from two different accounts you will have to create the labels in 24156 advance and use the metadata mapper to translate the IDs between the 24157 two accounts. 24158 24159 24160 Properties: 24161 24162 - Config: metadata_labels 24163 - Env Var: RCLONE_DRIVE_METADATA_LABELS 24164 - Type: Bits 24165 - Default: off 24166 - Examples: 24167 - "off" 24168 - Do not read or write the value 24169 - "read" 24170 - Read the value only 24171 - "write" 24172 - Write the value only 24173 - "read,write" 24174 - Read and Write the value. 24175 24176 #### --drive-encoding 24177 24178 The encoding for the backend. 24179 24180 See the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. 24181 24182 Properties: 24183 24184 - Config: encoding 24185 - Env Var: RCLONE_DRIVE_ENCODING 24186 - Type: Encoding 24187 - Default: InvalidUtf8 24188 24189 #### --drive-env-auth 24190 24191 Get IAM credentials from runtime (environment variables or instance meta data if no env vars). 24192 24193 Only applies if service_account_file and service_account_credentials is blank. 24194 24195 Properties: 24196 24197 - Config: env_auth 24198 - Env Var: RCLONE_DRIVE_ENV_AUTH 24199 - Type: bool 24200 - Default: false 24201 - Examples: 24202 - "false" 24203 - Enter credentials in the next step. 24204 - "true" 24205 - Get GCP IAM credentials from the environment (env vars or IAM). 24206 24207 #### --drive-description 24208 24209 Description of the remote 24210 24211 Properties: 24212 24213 - Config: description 24214 - Env Var: RCLONE_DRIVE_DESCRIPTION 24215 - Type: string 24216 - Required: false 24217 24218 ### Metadata 24219 24220 User metadata is stored in the properties field of the drive object. 24221 24222 Metadata is supported on files and directories. 24223 24224 Here are the possible system metadata items for the drive backend. 24225 24226 | Name | Help | Type | Example | Read Only | 24227 |------|------|------|---------|-----------| 24228 | btime | Time of file birth (creation) with mS accuracy. Note that this is only writable on fresh uploads - it can't be written for updates. | RFC 3339 | 2006-01-02T15:04:05.999Z07:00 | N | 24229 | content-type | The MIME type of the file. | string | text/plain | N | 24230 | copy-requires-writer-permission | Whether the options to copy, print, or download this file, should be disabled for readers and commenters. | boolean | true | N | 24231 | description | A short description of the file. | string | Contract for signing | N | 24232 | folder-color-rgb | The color for a folder or a shortcut to a folder as an RGB hex string. | string | 881133 | N | 24233 | labels | Labels attached to this file in a JSON dump of Googled drive format. Enable with --drive-metadata-labels. | JSON | [] | N | 24234 | mtime | Time of last modification with mS accuracy. | RFC 3339 | 2006-01-02T15:04:05.999Z07:00 | N | 24235 | owner | The owner of the file. Usually an email address. Enable with --drive-metadata-owner. | string | user@example.com | N | 24236 | permissions | Permissions in a JSON dump of Google drive format. On shared drives these will only be present if they aren't inherited. Enable with --drive-metadata-permissions. | JSON | {} | N | 24237 | starred | Whether the user has starred the file. | boolean | false | N | 24238 | viewed-by-me | Whether the file has been viewed by this user. | boolean | true | **Y** | 24239 | writers-can-share | Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives. | boolean | false | N | 24240 24241 See the [metadata](https://rclone.org/docs/#metadata) docs for more info. 24242 24243 ## Backend commands 24244 24245 Here are the commands specific to the drive backend. 24246 24247 Run them with 24248 24249 rclone backend COMMAND remote: 24250 24251 The help below will explain what arguments each command takes. 24252 24253 See the [backend](https://rclone.org/commands/rclone_backend/) command for more 24254 info on how to pass options and arguments. 24255 24256 These can be run on a running backend using the rc command 24257 [backend/command](https://rclone.org/rc/#backend-command). 24258 24259 ### get 24260 24261 Get command for fetching the drive config parameters 24262 24263 rclone backend get remote: [options] [<arguments>+] 24264 24265 This is a get command which will be used to fetch the various drive config parameters 24266 24267 Usage Examples: 24268 24269 rclone backend get drive: [-o service_account_file] [-o chunk_size] 24270 rclone rc backend/command command=get fs=drive: [-o service_account_file] [-o chunk_size] 24271 24272 24273 Options: 24274 24275 - "chunk_size": show the current upload chunk size 24276 - "service_account_file": show the current service account file 24277 24278 ### set 24279 24280 Set command for updating the drive config parameters 24281 24282 rclone backend set remote: [options] [<arguments>+] 24283 24284 This is a set command which will be used to update the various drive config parameters 24285 24286 Usage Examples: 24287 24288 rclone backend set drive: [-o service_account_file=sa.json] [-o chunk_size=67108864] 24289 rclone rc backend/command command=set fs=drive: [-o service_account_file=sa.json] [-o chunk_size=67108864] 24290 24291 24292 Options: 24293 24294 - "chunk_size": update the current upload chunk size 24295 - "service_account_file": update the current service account file 24296 24297 ### shortcut 24298 24299 Create shortcuts from files or directories 24300 24301 rclone backend shortcut remote: [options] [<arguments>+] 24302 24303 This command creates shortcuts from files or directories. 24304 24305 Usage: 24306 24307 rclone backend shortcut drive: source_item destination_shortcut 24308 rclone backend shortcut drive: source_item -o target=drive2: destination_shortcut 24309 24310 In the first example this creates a shortcut from the "source_item" 24311 which can be a file or a directory to the "destination_shortcut". The 24312 "source_item" and the "destination_shortcut" should be relative paths 24313 from "drive:" 24314 24315 In the second example this creates a shortcut from the "source_item" 24316 relative to "drive:" to the "destination_shortcut" relative to 24317 "drive2:". This may fail with a permission error if the user 24318 authenticated with "drive2:" can't read files from "drive:". 24319 24320 24321 Options: 24322 24323 - "target": optional target remote for the shortcut destination 24324 24325 ### drives 24326 24327 List the Shared Drives available to this account 24328 24329 rclone backend drives remote: [options] [<arguments>+] 24330 24331 This command lists the Shared Drives (Team Drives) available to this 24332 account. 24333 24334 Usage: 24335 24336 rclone backend [-o config] drives drive: 24337 24338 This will return a JSON list of objects like this 24339 24340 [ 24341 { 24342 "id": "0ABCDEF-01234567890", 24343 "kind": "drive#teamDrive", 24344 "name": "My Drive" 24345 }, 24346 { 24347 "id": "0ABCDEFabcdefghijkl", 24348 "kind": "drive#teamDrive", 24349 "name": "Test Drive" 24350 } 24351 ] 24352 24353 With the -o config parameter it will output the list in a format 24354 suitable for adding to a config file to make aliases for all the 24355 drives found and a combined drive. 24356 24357 [My Drive] 24358 type = alias 24359 remote = drive,team_drive=0ABCDEF-01234567890,root_folder_id=: 24360 24361 [Test Drive] 24362 type = alias 24363 remote = drive,team_drive=0ABCDEFabcdefghijkl,root_folder_id=: 24364 24365 [AllDrives] 24366 type = combine 24367 upstreams = "My Drive=My Drive:" "Test Drive=Test Drive:" 24368 24369 Adding this to the rclone config file will cause those team drives to 24370 be accessible with the aliases shown. Any illegal characters will be 24371 substituted with "_" and duplicate names will have numbers suffixed. 24372 It will also add a remote called AllDrives which shows all the shared 24373 drives combined into one directory tree. 24374 24375 24376 ### untrash 24377 24378 Untrash files and directories 24379 24380 rclone backend untrash remote: [options] [<arguments>+] 24381 24382 This command untrashes all the files and directories in the directory 24383 passed in recursively. 24384 24385 Usage: 24386 24387 This takes an optional directory to trash which make this easier to 24388 use via the API. 24389 24390 rclone backend untrash drive:directory 24391 rclone backend --interactive untrash drive:directory subdir 24392 24393 Use the --interactive/-i or --dry-run flag to see what would be restored before restoring it. 24394 24395 Result: 24396 24397 { 24398 "Untrashed": 17, 24399 "Errors": 0 24400 } 24401 24402 24403 ### copyid 24404 24405 Copy files by ID 24406 24407 rclone backend copyid remote: [options] [<arguments>+] 24408 24409 This command copies files by ID 24410 24411 Usage: 24412 24413 rclone backend copyid drive: ID path 24414 rclone backend copyid drive: ID1 path1 ID2 path2 24415 24416 It copies the drive file with ID given to the path (an rclone path which 24417 will be passed internally to rclone copyto). The ID and path pairs can be 24418 repeated. 24419 24420 The path should end with a / to indicate copy the file as named to 24421 this directory. If it doesn't end with a / then the last path 24422 component will be used as the file name. 24423 24424 If the destination is a drive backend then server-side copying will be 24425 attempted if possible. 24426 24427 Use the --interactive/-i or --dry-run flag to see what would be copied before copying. 24428 24429 24430 ### exportformats 24431 24432 Dump the export formats for debug purposes 24433 24434 rclone backend exportformats remote: [options] [<arguments>+] 24435 24436 ### importformats 24437 24438 Dump the import formats for debug purposes 24439 24440 rclone backend importformats remote: [options] [<arguments>+] 24441 24442 24443 24444 ## Limitations 24445 24446 Drive has quite a lot of rate limiting. This causes rclone to be 24447 limited to transferring about 2 files per second only. Individual 24448 files may be transferred much faster at 100s of MiB/s but lots of 24449 small files can take a long time. 24450 24451 Server side copies are also subject to a separate rate limit. If you 24452 see User rate limit exceeded errors, wait at least 24 hours and retry. 24453 You can disable server-side copies with `--disable copy` to download 24454 and upload the files if you prefer. 24455 24456 ### Limitations of Google Docs 24457 24458 Google docs will appear as size -1 in `rclone ls`, `rclone ncdu` etc, 24459 and as size 0 in anything which uses the VFS layer, e.g. `rclone mount` 24460 and `rclone serve`. When calculating directory totals, e.g. in 24461 `rclone size` and `rclone ncdu`, they will be counted in as empty 24462 files. 24463 24464 This is because rclone can't find out the size of the Google docs 24465 without downloading them. 24466 24467 Google docs will transfer correctly with `rclone sync`, `rclone copy` 24468 etc as rclone knows to ignore the size when doing the transfer. 24469 24470 However an unfortunate consequence of this is that you may not be able 24471 to download Google docs using `rclone mount`. If it doesn't work you 24472 will get a 0 sized file. If you try again the doc may gain its 24473 correct size and be downloadable. Whether it will work on not depends 24474 on the application accessing the mount and the OS you are running - 24475 experiment to find out if it does work for you! 24476 24477 ### Duplicated files 24478 24479 Sometimes, for no reason I've been able to track down, drive will 24480 duplicate a file that rclone uploads. Drive unlike all the other 24481 remotes can have duplicated files. 24482 24483 Duplicated files cause problems with the syncing and you will see 24484 messages in the log about duplicates. 24485 24486 Use `rclone dedupe` to fix duplicated files. 24487 24488 Note that this isn't just a problem with rclone, even Google Photos on 24489 Android duplicates files on drive sometimes. 24490 24491 ### Rclone appears to be re-copying files it shouldn't 24492 24493 The most likely cause of this is the duplicated file issue above - run 24494 `rclone dedupe` and check your logs for duplicate object or directory 24495 messages. 24496 24497 This can also be caused by a delay/caching on google drive's end when 24498 comparing directory listings. Specifically with team drives used in 24499 combination with --fast-list. Files that were uploaded recently may 24500 not appear on the directory list sent to rclone when using --fast-list. 24501 24502 Waiting a moderate period of time between attempts (estimated to be 24503 approximately 1 hour) and/or not using --fast-list both seem to be 24504 effective in preventing the problem. 24505 24506 ### SHA1 or SHA256 hashes may be missing 24507 24508 All files have MD5 hashes, but a small fraction of files uploaded may 24509 not have SHA1 or SHA256 hashes especially if they were uploaded before 2018. 24510 24511 ## Making your own client_id 24512 24513 When you use rclone with Google drive in its default configuration you 24514 are using rclone's client_id. This is shared between all the rclone 24515 users. There is a global rate limit on the number of queries per 24516 second that each client_id can do set by Google. rclone already has a 24517 high quota and I will continue to make sure it is high enough by 24518 contacting Google. 24519 24520 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. 24521 24522 Here is how to create your own Google Drive client ID for rclone: 24523 24524 1. Log into the [Google API 24525 Console](https://console.developers.google.com/) with your Google 24526 account. It doesn't matter what Google account you use. (It need not 24527 be the same account as the Google Drive you want to access) 24528 24529 2. Select a project or create a new project. 24530 24531 3. Under "ENABLE APIS AND SERVICES" search for "Drive", and enable the 24532 "Google Drive API". 24533 24534 4. Click "Credentials" in the left-side panel (not "Create 24535 credentials", which opens the wizard). 24536 24537 5. If you already configured an "Oauth Consent Screen", then skip 24538 to the next step; if not, click on "CONFIGURE CONSENT SCREEN" button 24539 (near the top right corner of the right panel), then select "External" 24540 and click on "CREATE"; on the next screen, enter an "Application name" 24541 ("rclone" is OK); enter "User Support Email" (your own email is OK); 24542 enter "Developer Contact Email" (your own email is OK); then click on 24543 "Save" (all other data is optional). You will also have to add some scopes, 24544 including `.../auth/docs` and `.../auth/drive` in order to be able to edit, 24545 create and delete files with RClone. You may also want to include the 24546 `../auth/drive.metadata.readonly` scope. After adding scopes, click 24547 "Save and continue" to add test users. Be sure to add your own account to 24548 the test users. Once you've added yourself as a test user and saved the 24549 changes, click again on "Credentials" on the left panel to go back to 24550 the "Credentials" screen. 24551 24552 (PS: if you are a GSuite user, you could also select "Internal" instead 24553 of "External" above, but this will restrict API use to Google Workspace 24554 users in your organisation). 24555 24556 6. Click on the "+ CREATE CREDENTIALS" button at the top of the screen, 24557 then select "OAuth client ID". 24558 24559 7. Choose an application type of "Desktop app" and click "Create". (the default name is fine) 24560 24561 8. It will show you a client ID and client secret. Make a note of these. 24562 24563 (If you selected "External" at Step 5 continue to Step 9. 24564 If you chose "Internal" you don't need to publish and can skip straight to 24565 Step 10 but your destination drive must be part of the same Google Workspace.) 24566 24567 9. Go to "Oauth consent screen" and then click "PUBLISH APP" button and confirm. 24568 You will also want to add yourself as a test user. 24569 24570 10. Provide the noted client ID and client secret to rclone. 24571 24572 Be aware that, due to the "enhanced security" recently introduced by 24573 Google, you are theoretically expected to "submit your app for verification" 24574 and then wait a few weeks(!) for their response; in practice, you can go right 24575 ahead and use the client ID and client secret with rclone, the only issue will 24576 be a very scary confirmation screen shown when you connect via your browser 24577 for rclone to be able to get its token-id (but as this only happens during 24578 the remote configuration, it's not such a big deal). Keeping the application in 24579 "Testing" will work as well, but the limitation is that any grants will expire 24580 after a week, which can be annoying to refresh constantly. If, for whatever 24581 reason, a short grant time is not a problem, then keeping the application in 24582 testing mode would also be sufficient. 24583 24584 (Thanks to @balazer on github for these instructions.) 24585 24586 Sometimes, creation of an OAuth consent in Google API Console fails due to an error message 24587 “The request failed because changes to one of the field of the resource is not supported”. 24588 As a convenient workaround, the necessary Google Drive API key can be created on the 24589 [Python Quickstart](https://developers.google.com/drive/api/v3/quickstart/python) page. 24590 Just push the Enable the Drive API button to receive the Client ID and Secret. 24591 Note that it will automatically create a new project in the API Console. 24592 24593 # Google Photos 24594 24595 The rclone backend for [Google Photos](https://www.google.com/photos/about/) is 24596 a specialized backend for transferring photos and videos to and from 24597 Google Photos. 24598 24599 **NB** The Google Photos API which rclone uses has quite a few 24600 limitations, so please read the [limitations section](#limitations) 24601 carefully to make sure it is suitable for your use. 24602 24603 ## Configuration 24604 24605 The initial setup for google cloud storage involves getting a token from Google Photos 24606 which you need to do in your browser. `rclone config` walks you 24607 through it. 24608 24609 Here is an example of how to make a remote called `remote`. First run: 24610 24611 rclone config 24612 24613 This will guide you through an interactive setup process: 24614 </code></pre> 24615 <p>No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n name> remote Type of storage to configure. Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value [snip] XX / Google Photos "google photos" [snip] Storage> google photos ** See help for google photos backend at: https://rclone.org/googlephotos/ **</p> 24616 <p>Google Application Client Id Leave blank normally. Enter a string value. Press Enter for the default (""). client_id> Google Application Client Secret Leave blank normally. Enter a string value. Press Enter for the default (""). client_secret> Set to make the Google Photos backend read only.</p> 24617 <p>If you choose read only then rclone will only request read only access to your photos, otherwise rclone will request full access. Enter a boolean value (true or false). Press Enter for the default ("false"). read_only> Edit advanced config? (y/n) y) Yes n) No y/n> n Remote config Use web browser to automatically authenticate rclone with remote? * Say Y if the machine running rclone has a web browser you can use * Say N if running rclone on a (remote) machine without web browser access If not sure try Y. If Y failed, try N. y) Yes n) No y/n> y If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth Log in and authorize rclone for access Waiting for code... Got code</p> 24618 <p>*** IMPORTANT: All media items uploaded to Google Photos with rclone *** are stored in full resolution at original quality. These uploads *** will count towards storage in your Google Account.</p> 24619 <table style="width:29%;"> 24620 <colgroup> 24621 <col style="width: 29%" /> 24622 </colgroup> 24623 <thead> 24624 <tr class="header"> 24625 <th style="text-align: left;">[remote] type = google photos token = {"access_token":"XXX","token_type":"Bearer","refresh_token":"XXX","expiry":"2019-06-28T17:38:04.644930156+01:00"}</th> 24626 </tr> 24627 </thead> 24628 <tbody> 24629 <tr class="odd"> 24630 <td style="text-align: left;">y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y ```</td> 24631 </tr> 24632 <tr class="even"> 24633 <td style="text-align: left;">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.</td> 24634 </tr> 24635 <tr class="odd"> 24636 <td style="text-align: left;">Note that rclone runs a webserver on your local machine to collect the token as returned from Google if using web browser to automatically authenticate. This only runs from the moment it opens your browser to the moment you get back the verification code. This is on <code>http://127.0.0.1:53682/</code> and this may require you to unblock it temporarily if you are running a host firewall, or use manual mode.</td> 24637 </tr> 24638 <tr class="even"> 24639 <td style="text-align: left;">This remote is called <code>remote</code> and can now be used like this</td> 24640 </tr> 24641 <tr class="odd"> 24642 <td style="text-align: left;">See all the albums in your photos</td> 24643 </tr> 24644 <tr class="even"> 24645 <td style="text-align: left;">rclone lsd remote:album</td> 24646 </tr> 24647 <tr class="odd"> 24648 <td style="text-align: left;">Make a new album</td> 24649 </tr> 24650 <tr class="even"> 24651 <td style="text-align: left;">rclone mkdir remote:album/newAlbum</td> 24652 </tr> 24653 <tr class="odd"> 24654 <td style="text-align: left;">List the contents of an album</td> 24655 </tr> 24656 <tr class="even"> 24657 <td style="text-align: left;">rclone ls remote:album/newAlbum</td> 24658 </tr> 24659 <tr class="odd"> 24660 <td style="text-align: left;">Sync <code>/home/local/images</code> to the Google Photos, removing any excess files in the album.</td> 24661 </tr> 24662 <tr class="even"> 24663 <td style="text-align: left;">rclone sync --interactive /home/local/image remote:album/newAlbum</td> 24664 </tr> 24665 <tr class="odd"> 24666 <td style="text-align: left;">### Layout</td> 24667 </tr> 24668 <tr class="even"> 24669 <td style="text-align: left;">As Google Photos is not a general purpose cloud storage system, the backend is laid out to help you navigate it.</td> 24670 </tr> 24671 <tr class="odd"> 24672 <td style="text-align: left;">The directories under <code>media</code> show different ways of categorizing the media. Each file will appear multiple times. So if you want to make a backup of your google photos you might choose to backup <code>remote:media/by-month</code>. (<strong>NB</strong> <code>remote:media/by-day</code> is rather slow at the moment so avoid for syncing.)</td> 24673 </tr> 24674 <tr class="even"> 24675 <td style="text-align: left;">Note that all your photos and videos will appear somewhere under <code>media</code>, but they may not appear under <code>album</code> unless you've put them into albums.</td> 24676 </tr> 24677 <tr class="odd"> 24678 <td style="text-align: left;"><code>/ - upload - file1.jpg - file2.jpg - ... - media - all - file1.jpg - file2.jpg - ... - by-year - 2000 - file1.jpg - ... - 2001 - file2.jpg - ... - ... - by-month - 2000 - 2000-01 - file1.jpg - ... - 2000-02 - file2.jpg - ... - ... - by-day - 2000 - 2000-01-01 - file1.jpg - ... - 2000-01-02 - file2.jpg - ... - ... - album - album name - album name/sub - shared-album - album name - album name/sub - feature - favorites - file1.jpg - file2.jpg</code></td> 24679 </tr> 24680 <tr class="even"> 24681 <td style="text-align: left;">There are two writable parts of the tree, the <code>upload</code> directory and sub directories of the <code>album</code> directory.</td> 24682 </tr> 24683 <tr class="odd"> 24684 <td style="text-align: left;">The <code>upload</code> directory is for uploading files you don't want to put into albums. This will be empty to start with and will contain the files you've uploaded for one rclone session only, becoming empty again when you restart rclone. The use case for this would be if you have a load of files you just want to once off dump into Google Photos. For repeated syncing, uploading to <code>album</code> will work better.</td> 24685 </tr> 24686 <tr class="even"> 24687 <td style="text-align: left;">Directories within the <code>album</code> directory are also writeable and you may create new directories (albums) under <code>album</code>. If you copy files with a directory hierarchy in there then rclone will create albums with the <code>/</code> character in them. For example if you do</td> 24688 </tr> 24689 <tr class="odd"> 24690 <td style="text-align: left;">rclone copy /path/to/images remote:album/images</td> 24691 </tr> 24692 <tr class="even"> 24693 <td style="text-align: left;">and the images directory contains</td> 24694 </tr> 24695 <tr class="odd"> 24696 <td style="text-align: left;"><code>images - file1.jpg dir file2.jpg dir2 dir3 file3.jpg</code></td> 24697 </tr> 24698 <tr class="even"> 24699 <td style="text-align: left;">Then rclone will create the following albums with the following files in</td> 24700 </tr> 24701 <tr class="odd"> 24702 <td style="text-align: left;">- images - file1.jpg - images/dir - file2.jpg - images/dir2/dir3 - file3.jpg</td> 24703 </tr> 24704 <tr class="even"> 24705 <td style="text-align: left;">This means that you can use the <code>album</code> path pretty much like a normal filesystem and it is a good target for repeated syncing.</td> 24706 </tr> 24707 <tr class="odd"> 24708 <td style="text-align: left;">The <code>shared-album</code> directory shows albums shared with you or by you. This is similar to the Sharing tab in the Google Photos web interface.</td> 24709 </tr> 24710 <tr class="even"> 24711 <td style="text-align: left;">### Standard options</td> 24712 </tr> 24713 <tr class="odd"> 24714 <td style="text-align: left;">Here are the Standard options specific to google photos (Google Photos).</td> 24715 </tr> 24716 <tr class="even"> 24717 <td style="text-align: left;">#### --gphotos-client-id</td> 24718 </tr> 24719 <tr class="odd"> 24720 <td style="text-align: left;">OAuth Client Id.</td> 24721 </tr> 24722 <tr class="even"> 24723 <td style="text-align: left;">Leave blank normally.</td> 24724 </tr> 24725 <tr class="odd"> 24726 <td style="text-align: left;">Properties:</td> 24727 </tr> 24728 <tr class="even"> 24729 <td style="text-align: left;">- Config: client_id - Env Var: RCLONE_GPHOTOS_CLIENT_ID - Type: string - Required: false</td> 24730 </tr> 24731 <tr class="odd"> 24732 <td style="text-align: left;">#### --gphotos-client-secret</td> 24733 </tr> 24734 <tr class="even"> 24735 <td style="text-align: left;">OAuth Client Secret.</td> 24736 </tr> 24737 <tr class="odd"> 24738 <td style="text-align: left;">Leave blank normally.</td> 24739 </tr> 24740 <tr class="even"> 24741 <td style="text-align: left;">Properties:</td> 24742 </tr> 24743 <tr class="odd"> 24744 <td style="text-align: left;">- Config: client_secret - Env Var: RCLONE_GPHOTOS_CLIENT_SECRET - Type: string - Required: false</td> 24745 </tr> 24746 <tr class="even"> 24747 <td style="text-align: left;">#### --gphotos-read-only</td> 24748 </tr> 24749 <tr class="odd"> 24750 <td style="text-align: left;">Set to make the Google Photos backend read only.</td> 24751 </tr> 24752 <tr class="even"> 24753 <td style="text-align: left;">If you choose read only then rclone will only request read only access to your photos, otherwise rclone will request full access.</td> 24754 </tr> 24755 <tr class="odd"> 24756 <td style="text-align: left;">Properties:</td> 24757 </tr> 24758 <tr class="even"> 24759 <td style="text-align: left;">- Config: read_only - Env Var: RCLONE_GPHOTOS_READ_ONLY - Type: bool - Default: false</td> 24760 </tr> 24761 <tr class="odd"> 24762 <td style="text-align: left;">### Advanced options</td> 24763 </tr> 24764 <tr class="even"> 24765 <td style="text-align: left;">Here are the Advanced options specific to google photos (Google Photos).</td> 24766 </tr> 24767 <tr class="odd"> 24768 <td style="text-align: left;">#### --gphotos-token</td> 24769 </tr> 24770 <tr class="even"> 24771 <td style="text-align: left;">OAuth Access Token as a JSON blob.</td> 24772 </tr> 24773 <tr class="odd"> 24774 <td style="text-align: left;">Properties:</td> 24775 </tr> 24776 <tr class="even"> 24777 <td style="text-align: left;">- Config: token - Env Var: RCLONE_GPHOTOS_TOKEN - Type: string - Required: false</td> 24778 </tr> 24779 <tr class="odd"> 24780 <td style="text-align: left;">#### --gphotos-auth-url</td> 24781 </tr> 24782 <tr class="even"> 24783 <td style="text-align: left;">Auth server URL.</td> 24784 </tr> 24785 <tr class="odd"> 24786 <td style="text-align: left;">Leave blank to use the provider defaults.</td> 24787 </tr> 24788 <tr class="even"> 24789 <td style="text-align: left;">Properties:</td> 24790 </tr> 24791 <tr class="odd"> 24792 <td style="text-align: left;">- Config: auth_url - Env Var: RCLONE_GPHOTOS_AUTH_URL - Type: string - Required: false</td> 24793 </tr> 24794 <tr class="even"> 24795 <td style="text-align: left;">#### --gphotos-token-url</td> 24796 </tr> 24797 <tr class="odd"> 24798 <td style="text-align: left;">Token server url.</td> 24799 </tr> 24800 <tr class="even"> 24801 <td style="text-align: left;">Leave blank to use the provider defaults.</td> 24802 </tr> 24803 <tr class="odd"> 24804 <td style="text-align: left;">Properties:</td> 24805 </tr> 24806 <tr class="even"> 24807 <td style="text-align: left;">- Config: token_url - Env Var: RCLONE_GPHOTOS_TOKEN_URL - Type: string - Required: false</td> 24808 </tr> 24809 <tr class="odd"> 24810 <td style="text-align: left;">#### --gphotos-read-size</td> 24811 </tr> 24812 <tr class="even"> 24813 <td style="text-align: left;">Set to read the size of media items.</td> 24814 </tr> 24815 <tr class="odd"> 24816 <td style="text-align: left;">Normally rclone does not read the size of media items since this takes another transaction. This isn't necessary for syncing. However rclone mount needs to know the size of files in advance of reading them, so setting this flag when using rclone mount is recommended if you want to read the media.</td> 24817 </tr> 24818 <tr class="even"> 24819 <td style="text-align: left;">Properties:</td> 24820 </tr> 24821 <tr class="odd"> 24822 <td style="text-align: left;">- Config: read_size - Env Var: RCLONE_GPHOTOS_READ_SIZE - Type: bool - Default: false</td> 24823 </tr> 24824 <tr class="even"> 24825 <td style="text-align: left;">#### --gphotos-start-year</td> 24826 </tr> 24827 <tr class="odd"> 24828 <td style="text-align: left;">Year limits the photos to be downloaded to those which are uploaded after the given year.</td> 24829 </tr> 24830 <tr class="even"> 24831 <td style="text-align: left;">Properties:</td> 24832 </tr> 24833 <tr class="odd"> 24834 <td style="text-align: left;">- Config: start_year - Env Var: RCLONE_GPHOTOS_START_YEAR - Type: int - Default: 2000</td> 24835 </tr> 24836 <tr class="even"> 24837 <td style="text-align: left;">#### --gphotos-include-archived</td> 24838 </tr> 24839 <tr class="odd"> 24840 <td style="text-align: left;">Also view and download archived media.</td> 24841 </tr> 24842 <tr class="even"> 24843 <td style="text-align: left;">By default, rclone does not request archived media. Thus, when syncing, archived media is not visible in directory listings or transferred.</td> 24844 </tr> 24845 <tr class="odd"> 24846 <td style="text-align: left;">Note that media in albums is always visible and synced, no matter their archive status.</td> 24847 </tr> 24848 <tr class="even"> 24849 <td style="text-align: left;">With this flag, archived media are always visible in directory listings and transferred.</td> 24850 </tr> 24851 <tr class="odd"> 24852 <td style="text-align: left;">Without this flag, archived media will not be visible in directory listings and won't be transferred.</td> 24853 </tr> 24854 <tr class="even"> 24855 <td style="text-align: left;">Properties:</td> 24856 </tr> 24857 <tr class="odd"> 24858 <td style="text-align: left;">- Config: include_archived - Env Var: RCLONE_GPHOTOS_INCLUDE_ARCHIVED - Type: bool - Default: false</td> 24859 </tr> 24860 <tr class="even"> 24861 <td style="text-align: left;">#### --gphotos-encoding</td> 24862 </tr> 24863 <tr class="odd"> 24864 <td style="text-align: left;">The encoding for the backend.</td> 24865 </tr> 24866 <tr class="even"> 24867 <td style="text-align: left;">See the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</td> 24868 </tr> 24869 <tr class="odd"> 24870 <td style="text-align: left;">Properties:</td> 24871 </tr> 24872 <tr class="even"> 24873 <td style="text-align: left;">- Config: encoding - Env Var: RCLONE_GPHOTOS_ENCODING - Type: Encoding - Default: Slash,CrLf,InvalidUtf8,Dot</td> 24874 </tr> 24875 <tr class="odd"> 24876 <td style="text-align: left;">#### --gphotos-batch-mode</td> 24877 </tr> 24878 <tr class="even"> 24879 <td style="text-align: left;">Upload file batching sync|async|off.</td> 24880 </tr> 24881 <tr class="odd"> 24882 <td style="text-align: left;">This sets the batch mode used by rclone.</td> 24883 </tr> 24884 <tr class="even"> 24885 <td style="text-align: left;">This has 3 possible values</td> 24886 </tr> 24887 <tr class="odd"> 24888 <td style="text-align: left;">- off - no batching - sync - batch uploads and check completion (default) - async - batch upload and don't check completion</td> 24889 </tr> 24890 <tr class="even"> 24891 <td style="text-align: left;">Rclone will close any outstanding batches when it exits which may make a delay on quit.</td> 24892 </tr> 24893 <tr class="odd"> 24894 <td style="text-align: left;">Properties:</td> 24895 </tr> 24896 <tr class="even"> 24897 <td style="text-align: left;">- Config: batch_mode - Env Var: RCLONE_GPHOTOS_BATCH_MODE - Type: string - Default: "sync"</td> 24898 </tr> 24899 <tr class="odd"> 24900 <td style="text-align: left;">#### --gphotos-batch-size</td> 24901 </tr> 24902 <tr class="even"> 24903 <td style="text-align: left;">Max number of files in upload batch.</td> 24904 </tr> 24905 <tr class="odd"> 24906 <td style="text-align: left;">This sets the batch size of files to upload. It has to be less than 50.</td> 24907 </tr> 24908 <tr class="even"> 24909 <td style="text-align: left;">By default this is 0 which means rclone which calculate the batch size depending on the setting of batch_mode.</td> 24910 </tr> 24911 <tr class="odd"> 24912 <td style="text-align: left;">- batch_mode: async - default batch_size is 50 - batch_mode: sync - default batch_size is the same as --transfers - batch_mode: off - not in use</td> 24913 </tr> 24914 <tr class="even"> 24915 <td style="text-align: left;">Rclone will close any outstanding batches when it exits which may make a delay on quit.</td> 24916 </tr> 24917 <tr class="odd"> 24918 <td style="text-align: left;">Setting this is a great idea if you are uploading lots of small files as it will make them a lot quicker. You can use --transfers 32 to maximise throughput.</td> 24919 </tr> 24920 <tr class="even"> 24921 <td style="text-align: left;">Properties:</td> 24922 </tr> 24923 <tr class="odd"> 24924 <td style="text-align: left;">- Config: batch_size - Env Var: RCLONE_GPHOTOS_BATCH_SIZE - Type: int - Default: 0</td> 24925 </tr> 24926 <tr class="even"> 24927 <td style="text-align: left;">#### --gphotos-batch-timeout</td> 24928 </tr> 24929 <tr class="odd"> 24930 <td style="text-align: left;">Max time to allow an idle upload batch before uploading.</td> 24931 </tr> 24932 <tr class="even"> 24933 <td style="text-align: left;">If an upload batch is idle for more than this long then it will be uploaded.</td> 24934 </tr> 24935 <tr class="odd"> 24936 <td style="text-align: left;">The default for this is 0 which means rclone will choose a sensible default based on the batch_mode in use.</td> 24937 </tr> 24938 <tr class="even"> 24939 <td style="text-align: left;">- batch_mode: async - default batch_timeout is 10s - batch_mode: sync - default batch_timeout is 1s - batch_mode: off - not in use</td> 24940 </tr> 24941 <tr class="odd"> 24942 <td style="text-align: left;">Properties:</td> 24943 </tr> 24944 <tr class="even"> 24945 <td style="text-align: left;">- Config: batch_timeout - Env Var: RCLONE_GPHOTOS_BATCH_TIMEOUT - Type: Duration - Default: 0s</td> 24946 </tr> 24947 <tr class="odd"> 24948 <td style="text-align: left;">#### --gphotos-batch-commit-timeout</td> 24949 </tr> 24950 <tr class="even"> 24951 <td style="text-align: left;">Max time to wait for a batch to finish committing</td> 24952 </tr> 24953 <tr class="odd"> 24954 <td style="text-align: left;">Properties:</td> 24955 </tr> 24956 <tr class="even"> 24957 <td style="text-align: left;">- Config: batch_commit_timeout - Env Var: RCLONE_GPHOTOS_BATCH_COMMIT_TIMEOUT - Type: Duration - Default: 10m0s</td> 24958 </tr> 24959 <tr class="odd"> 24960 <td style="text-align: left;">#### --gphotos-description</td> 24961 </tr> 24962 <tr class="even"> 24963 <td style="text-align: left;">Description of the remote</td> 24964 </tr> 24965 <tr class="odd"> 24966 <td style="text-align: left;">Properties:</td> 24967 </tr> 24968 <tr class="even"> 24969 <td style="text-align: left;">- Config: description - Env Var: RCLONE_GPHOTOS_DESCRIPTION - Type: string - Required: false</td> 24970 </tr> 24971 <tr class="odd"> 24972 <td style="text-align: left;">## Limitations</td> 24973 </tr> 24974 <tr class="even"> 24975 <td style="text-align: left;">Only images and videos can be uploaded. If you attempt to upload non videos or images or formats that Google Photos doesn't understand, rclone will upload the file, then Google Photos will give an error when it is put turned into a media item.</td> 24976 </tr> 24977 <tr class="odd"> 24978 <td style="text-align: left;">Note that all media items uploaded to Google Photos through the API are stored in full resolution at "original quality" and <strong>will</strong> count towards your storage quota in your Google Account. The API does <strong>not</strong> offer a way to upload in "high quality" mode..</td> 24979 </tr> 24980 <tr class="even"> 24981 <td style="text-align: left;"><code>rclone about</code> is not supported by the Google Photos backend. Backends without this capability cannot determine free space for an rclone mount or use policy <code>mfs</code> (most free space) as a member of an rclone union remote.</td> 24982 </tr> 24983 <tr class="odd"> 24984 <td style="text-align: left;">See <a href="https://rclone.org/overview/#optional-features">List of backends that do not support rclone about</a> See <a href="https://rclone.org/commands/rclone_about/">rclone about</a></td> 24985 </tr> 24986 <tr class="even"> 24987 <td style="text-align: left;">### Downloading Images</td> 24988 </tr> 24989 <tr class="odd"> 24990 <td style="text-align: left;">When Images are downloaded this strips EXIF location (according to the docs and my tests). This is a limitation of the Google Photos API and is covered by <a href="https://issuetracker.google.com/issues/112096115">bug #112096115</a>.</td> 24991 </tr> 24992 <tr class="even"> 24993 <td style="text-align: left;"><strong>The current google API does not allow photos to be downloaded at original resolution. This is very important if you are, for example, relying on "Google Photos" as a backup of your photos. You will not be able to use rclone to redownload original images. You could use 'google takeout' to recover the original photos as a last resort</strong></td> 24994 </tr> 24995 <tr class="odd"> 24996 <td style="text-align: left;">### Downloading Videos</td> 24997 </tr> 24998 <tr class="even"> 24999 <td style="text-align: left;">When videos are downloaded they are downloaded in a really compressed version of the video compared to downloading it via the Google Photos web interface. This is covered by <a href="https://issuetracker.google.com/issues/113672044">bug #113672044</a>.</td> 25000 </tr> 25001 <tr class="odd"> 25002 <td style="text-align: left;">### Duplicates</td> 25003 </tr> 25004 <tr class="even"> 25005 <td style="text-align: left;">If a file name is duplicated in a directory then rclone will add the file ID into its name. So two files called <code>file.jpg</code> would then appear as <code>file {123456}.jpg</code> and <code>file {ABCDEF}.jpg</code> (the actual IDs are a lot longer alas!).</td> 25006 </tr> 25007 <tr class="odd"> 25008 <td style="text-align: left;">If you upload the same image (with the same binary data) twice then Google Photos will deduplicate it. However it will retain the filename from the first upload which may confuse rclone. For example if you uploaded an image to <code>upload</code> then uploaded the same image to <code>album/my_album</code> the filename of the image in <code>album/my_album</code> will be what it was uploaded with initially, not what you uploaded it with to <code>album</code>. In practise this shouldn't cause too many problems.</td> 25009 </tr> 25010 <tr class="even"> 25011 <td style="text-align: left;">### Modification times</td> 25012 </tr> 25013 <tr class="odd"> 25014 <td style="text-align: left;">The date shown of media in Google Photos is the creation date as determined by the EXIF information, or the upload date if that is not known.</td> 25015 </tr> 25016 <tr class="even"> 25017 <td style="text-align: left;">This is not changeable by rclone and is not the modification date of the media on local disk. This means that rclone cannot use the dates from Google Photos for syncing purposes.</td> 25018 </tr> 25019 <tr class="odd"> 25020 <td style="text-align: left;">### Size</td> 25021 </tr> 25022 <tr class="even"> 25023 <td style="text-align: left;">The Google Photos API does not return the size of media. This means that when syncing to Google Photos, rclone can only do a file existence check.</td> 25024 </tr> 25025 <tr class="odd"> 25026 <td style="text-align: left;">It is possible to read the size of the media, but this needs an extra HTTP HEAD request per media item so is <strong>very slow</strong> and uses up a lot of transactions. This can be enabled with the <code>--gphotos-read-size</code> option or the <code>read_size = true</code> config parameter.</td> 25027 </tr> 25028 <tr class="even"> 25029 <td style="text-align: left;">If you want to use the backend with <code>rclone mount</code> you may need to enable this flag (depending on your OS and application using the photos) otherwise you may not be able to read media off the mount. You'll need to experiment to see if it works for you without the flag.</td> 25030 </tr> 25031 <tr class="odd"> 25032 <td style="text-align: left;">### Albums</td> 25033 </tr> 25034 <tr class="even"> 25035 <td style="text-align: left;">Rclone can only upload files to albums it created. This is a <a href="https://developers.google.com/photos/library/guides/manage-albums">limitation of the Google Photos API</a>.</td> 25036 </tr> 25037 <tr class="odd"> 25038 <td style="text-align: left;">Rclone can remove files it uploaded from albums it created only.</td> 25039 </tr> 25040 <tr class="even"> 25041 <td style="text-align: left;">### Deleting files</td> 25042 </tr> 25043 <tr class="odd"> 25044 <td style="text-align: left;">Rclone can remove files from albums it created, but note that the Google Photos API does not allow media to be deleted permanently so this media will still remain. See <a href="https://issuetracker.google.com/issues/109759781">bug #109759781</a>.</td> 25045 </tr> 25046 <tr class="even"> 25047 <td style="text-align: left;">Rclone cannot delete files anywhere except under <code>album</code>.</td> 25048 </tr> 25049 <tr class="odd"> 25050 <td style="text-align: left;">### Deleting albums</td> 25051 </tr> 25052 <tr class="even"> 25053 <td style="text-align: left;">The Google Photos API does not support deleting albums - see <a href="https://issuetracker.google.com/issues/135714733">bug #135714733</a>.</td> 25054 </tr> 25055 <tr class="odd"> 25056 <td style="text-align: left;"># Hasher</td> 25057 </tr> 25058 <tr class="even"> 25059 <td style="text-align: left;">Hasher is a special overlay backend to create remotes which handle checksums for other remotes. It's main functions include: - Emulate hash types unimplemented by backends - Cache checksums to help with slow hashing of large local or (S)FTP files - Warm up checksum cache from external SUM files</td> 25060 </tr> 25061 <tr class="odd"> 25062 <td style="text-align: left;">## Getting started</td> 25063 </tr> 25064 <tr class="even"> 25065 <td style="text-align: left;">To use Hasher, first set up the underlying remote following the configuration instructions for that remote. You can also use a local pathname instead of a remote. Check that your base remote is working.</td> 25066 </tr> 25067 <tr class="odd"> 25068 <td style="text-align: left;">Let's call the base remote <code>myRemote:path</code> here. Note that anything inside <code>myRemote:path</code> will be handled by hasher and anything outside won't. This means that if you are using a bucket based remote (S3, B2, Swift) then you should put the bucket in the remote <code>s3:bucket</code>.</td> 25069 </tr> 25070 <tr class="even"> 25071 <td style="text-align: left;">Now proceed to interactive or manual configuration.</td> 25072 </tr> 25073 <tr class="odd"> 25074 <td style="text-align: left;">### Interactive configuration</td> 25075 </tr> 25076 <tr class="even"> 25077 <td style="text-align: left;">Run <code>rclone config</code>: ``` No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n name> Hasher1 Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Handle checksums for other remotes "hasher" [snip] Storage> hasher Remote to cache checksums for, like myremote:mypath. Enter a string value. Press Enter for the default (""). remote> myRemote:path Comma separated list of supported checksum types. Enter a string value. Press Enter for the default ("md5,sha1"). hashsums> md5 Maximum time to keep checksums in cache. 0 = no cache, off = cache forever. max_age> off Edit advanced config? (y/n) y) Yes n) No y/n> n Remote config</td> 25078 </tr> 25079 </tbody> 25080 </table> 25081 <p>[Hasher1] type = hasher remote = myRemote:path hashsums = md5 max_age = off -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y</p> 25082 <pre><code> 25083 ### Manual configuration 25084 25085 Run `rclone config path` to see the path of current active config file, 25086 usually `YOURHOME/.config/rclone/rclone.conf`. 25087 Open it in your favorite text editor, find section for the base remote 25088 and create new section for hasher like in the following examples: 25089 </code></pre> 25090 <p>[Hasher1] type = hasher remote = myRemote:path hashes = md5 max_age = off</p> 25091 <p>[Hasher2] type = hasher remote = /local/path hashes = dropbox,sha1 max_age = 24h</p> 25092 <pre><code> 25093 Hasher takes basically the following parameters: 25094 - `remote` is required, 25095 - `hashes` is a comma separated list of supported checksums 25096 (by default `md5,sha1`), 25097 - `max_age` - maximum time to keep a checksum value in the cache, 25098 `0` will disable caching completely, 25099 `off` will cache "forever" (that is until the files get changed). 25100 25101 Make sure the `remote` has `:` (colon) in. If you specify the remote without 25102 a colon then rclone will use a local directory of that name. So if you use 25103 a remote of `/local/path` then rclone will handle hashes for that directory. 25104 If you use `remote = name` literally then rclone will put files 25105 **in a directory called `name` located under current directory**. 25106 25107 ## Usage 25108 25109 ### Basic operations 25110 25111 Now you can use it as `Hasher2:subdir/file` instead of base remote. 25112 Hasher will transparently update cache with new checksums when a file 25113 is fully read or overwritten, like:</code></pre> 25114 <p>rclone copy External:path/file Hasher:dest/path</p> 25115 <p>rclone cat Hasher:path/to/file > /dev/null</p> 25116 <pre><code> 25117 The way to refresh **all** cached checksums (even unsupported by the base backend) 25118 for a subtree is to **re-download** all files in the subtree. For example, 25119 use `hashsum --download` using **any** supported hashsum on the command line 25120 (we just care to re-read):</code></pre> 25121 <p>rclone hashsum MD5 --download Hasher:path/to/subtree > /dev/null</p> 25122 <p>rclone backend dump Hasher:path/to/subtree</p> 25123 <pre><code> 25124 You can print or drop hashsum cache using custom backend commands:</code></pre> 25125 <p>rclone backend dump Hasher:dir/subdir</p> 25126 <p>rclone backend drop Hasher:</p> 25127 <pre><code> 25128 ### Pre-Seed from a SUM File 25129 25130 Hasher supports two backend commands: generic SUM file `import` and faster 25131 but less consistent `stickyimport`. 25132 </code></pre> 25133 <p>rclone backend import Hasher:dir/subdir SHA1 /path/to/SHA1SUM [--checkers 4]</p> 25134 <pre><code> 25135 Instead of SHA1 it can be any hash supported by the remote. The last argument 25136 can point to either a local or an `other-remote:path` text file in SUM format. 25137 The command will parse the SUM file, then walk down the path given by the 25138 first argument, snapshot current fingerprints and fill in the cache entries 25139 correspondingly. 25140 - Paths in the SUM file are treated as relative to `hasher:dir/subdir`. 25141 - The command will **not** check that supplied values are correct. 25142 You **must know** what you are doing. 25143 - This is a one-time action. The SUM file will not get "attached" to the 25144 remote. Cache entries can still be overwritten later, should the object's 25145 fingerprint change. 25146 - The tree walk can take long depending on the tree size. You can increase 25147 `--checkers` to make it faster. Or use `stickyimport` if you don't care 25148 about fingerprints and consistency. 25149 </code></pre> 25150 <p>rclone backend stickyimport hasher:path/to/data sha1 remote:/path/to/sum.sha1</p> 25151 <pre><code> 25152 `stickyimport` is similar to `import` but works much faster because it 25153 does not need to stat existing files and skips initial tree walk. 25154 Instead of binding cache entries to file fingerprints it creates _sticky_ 25155 entries bound to the file name alone ignoring size, modification time etc. 25156 Such hash entries can be replaced only by `purge`, `delete`, `backend drop` 25157 or by full re-read/re-write of the files. 25158 25159 ## Configuration reference 25160 25161 25162 ### Standard options 25163 25164 Here are the Standard options specific to hasher (Better checksums for other remotes). 25165 25166 #### --hasher-remote 25167 25168 Remote to cache checksums for (e.g. myRemote:path). 25169 25170 Properties: 25171 25172 - Config: remote 25173 - Env Var: RCLONE_HASHER_REMOTE 25174 - Type: string 25175 - Required: true 25176 25177 #### --hasher-hashes 25178 25179 Comma separated list of supported checksum types. 25180 25181 Properties: 25182 25183 - Config: hashes 25184 - Env Var: RCLONE_HASHER_HASHES 25185 - Type: CommaSepList 25186 - Default: md5,sha1 25187 25188 #### --hasher-max-age 25189 25190 Maximum time to keep checksums in cache (0 = no cache, off = cache forever). 25191 25192 Properties: 25193 25194 - Config: max_age 25195 - Env Var: RCLONE_HASHER_MAX_AGE 25196 - Type: Duration 25197 - Default: off 25198 25199 ### Advanced options 25200 25201 Here are the Advanced options specific to hasher (Better checksums for other remotes). 25202 25203 #### --hasher-auto-size 25204 25205 Auto-update checksum for files smaller than this size (disabled by default). 25206 25207 Properties: 25208 25209 - Config: auto_size 25210 - Env Var: RCLONE_HASHER_AUTO_SIZE 25211 - Type: SizeSuffix 25212 - Default: 0 25213 25214 #### --hasher-description 25215 25216 Description of the remote 25217 25218 Properties: 25219 25220 - Config: description 25221 - Env Var: RCLONE_HASHER_DESCRIPTION 25222 - Type: string 25223 - Required: false 25224 25225 ### Metadata 25226 25227 Any metadata supported by the underlying remote is read and written. 25228 25229 See the [metadata](https://rclone.org/docs/#metadata) docs for more info. 25230 25231 ## Backend commands 25232 25233 Here are the commands specific to the hasher backend. 25234 25235 Run them with 25236 25237 rclone backend COMMAND remote: 25238 25239 The help below will explain what arguments each command takes. 25240 25241 See the [backend](https://rclone.org/commands/rclone_backend/) command for more 25242 info on how to pass options and arguments. 25243 25244 These can be run on a running backend using the rc command 25245 [backend/command](https://rclone.org/rc/#backend-command). 25246 25247 ### drop 25248 25249 Drop cache 25250 25251 rclone backend drop remote: [options] [<arguments>+] 25252 25253 Completely drop checksum cache. 25254 Usage Example: 25255 rclone backend drop hasher: 25256 25257 25258 ### dump 25259 25260 Dump the database 25261 25262 rclone backend dump remote: [options] [<arguments>+] 25263 25264 Dump cache records covered by the current remote 25265 25266 ### fulldump 25267 25268 Full dump of the database 25269 25270 rclone backend fulldump remote: [options] [<arguments>+] 25271 25272 Dump all cache records in the database 25273 25274 ### import 25275 25276 Import a SUM file 25277 25278 rclone backend import remote: [options] [<arguments>+] 25279 25280 Amend hash cache from a SUM file and bind checksums to files by size/time. 25281 Usage Example: 25282 rclone backend import hasher:subdir md5 /path/to/sum.md5 25283 25284 25285 ### stickyimport 25286 25287 Perform fast import of a SUM file 25288 25289 rclone backend stickyimport remote: [options] [<arguments>+] 25290 25291 Fill hash cache from a SUM file without verifying file fingerprints. 25292 Usage Example: 25293 rclone backend stickyimport hasher:subdir md5 remote:path/to/sum.md5 25294 25295 25296 25297 25298 ## Implementation details (advanced) 25299 25300 This section explains how various rclone operations work on a hasher remote. 25301 25302 **Disclaimer. This section describes current implementation which can 25303 change in future rclone versions!.** 25304 25305 ### Hashsum command 25306 25307 The `rclone hashsum` (or `md5sum` or `sha1sum`) command will: 25308 25309 1. if requested hash is supported by lower level, just pass it. 25310 2. if object size is below `auto_size` then download object and calculate 25311 _requested_ hashes on the fly. 25312 3. if unsupported and the size is big enough, build object `fingerprint` 25313 (including size, modtime if supported, first-found _other_ hash if any). 25314 4. if the strict match is found in cache for the requested remote, return 25315 the stored hash. 25316 5. if remote found but fingerprint mismatched, then purge the entry and 25317 proceed to step 6. 25318 6. if remote not found or had no requested hash type or after step 5: 25319 download object, calculate all _supported_ hashes on the fly and store 25320 in cache; return requested hash. 25321 25322 ### Other operations 25323 25324 - whenever a file is uploaded or downloaded **in full**, capture the stream 25325 to calculate all supported hashes on the fly and update database 25326 - server-side `move` will update keys of existing cache entries 25327 - `deletefile` will remove a single cache entry 25328 - `purge` will remove all cache entries under the purged path 25329 25330 Note that setting `max_age = 0` will disable checksum caching completely. 25331 25332 If you set `max_age = off`, checksums in cache will never age, unless you 25333 fully rewrite or delete the file. 25334 25335 ### Cache storage 25336 25337 Cached checksums are stored as `bolt` database files under rclone cache 25338 directory, usually `~/.cache/rclone/kv/`. Databases are maintained 25339 one per _base_ backend, named like `BaseRemote~hasher.bolt`. 25340 Checksums for multiple `alias`-es into a single base backend 25341 will be stored in the single database. All local paths are treated as 25342 aliases into the `local` backend (unless encrypted or chunked) and stored 25343 in `~/.cache/rclone/kv/local~hasher.bolt`. 25344 Databases can be shared between multiple rclone processes. 25345 25346 # HDFS 25347 25348 [HDFS](https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-hdfs/HdfsDesign.html) is a 25349 distributed file-system, part of the [Apache Hadoop](https://hadoop.apache.org/) framework. 25350 25351 Paths are specified as `remote:` or `remote:path/to/dir`. 25352 25353 ## Configuration 25354 25355 Here is an example of how to make a remote called `remote`. First run: 25356 25357 rclone config 25358 25359 This will guide you through an interactive setup process: 25360 </code></pre> 25361 <p>No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n name> remote Type of storage to configure. Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value [skip] XX / Hadoop distributed file system "hdfs" [skip] Storage> hdfs ** See help for hdfs backend at: https://rclone.org/hdfs/ **</p> 25362 <p>hadoop name node and port Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value 1 / Connect to host namenode at port 8020 "namenode:8020" namenode> namenode.hadoop:8020 hadoop user name Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value 1 / Connect to hdfs as root "root" username> root Edit advanced config? (y/n) y) Yes n) No (default) y/n> n Remote config -------------------- [remote] type = hdfs namenode = namenode.hadoop:8020 username = root -------------------- y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y Current remotes:</p> 25363 <p>Name Type ==== ==== hadoop hdfs</p> 25364 <ol start="5" type="a"> 25365 <li>Edit existing remote</li> 25366 <li>New remote</li> 25367 <li>Delete remote</li> 25368 <li>Rename remote</li> 25369 <li>Copy remote</li> 25370 <li>Set configuration password</li> 25371 <li>Quit config e/n/d/r/c/s/q> q</li> 25372 </ol> 25373 <pre><code> 25374 This remote is called `remote` and can now be used like this 25375 25376 See all the top level directories 25377 25378 rclone lsd remote: 25379 25380 List the contents of a directory 25381 25382 rclone ls remote:directory 25383 25384 Sync the remote `directory` to `/home/local/directory`, deleting any excess files. 25385 25386 rclone sync --interactive remote:directory /home/local/directory 25387 25388 ### Setting up your own HDFS instance for testing 25389 25390 You may start with a [manual setup](https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-common/SingleCluster.html) 25391 or use the docker image from the tests: 25392 25393 If you want to build the docker image 25394 </code></pre> 25395 <p>git clone https://github.com/rclone/rclone.git cd rclone/fstest/testserver/images/test-hdfs docker build --rm -t rclone/test-hdfs .</p> 25396 <pre><code> 25397 Or you can just use the latest one pushed 25398 </code></pre> 25399 <p>docker run --rm --name "rclone-hdfs" -p 127.0.0.1:9866:9866 -p 127.0.0.1:8020:8020 --hostname "rclone-hdfs" rclone/test-hdfs</p> 25400 <pre><code> 25401 **NB** it need few seconds to startup. 25402 25403 For this docker image the remote needs to be configured like this: 25404 </code></pre> 25405 <p>[remote] type = hdfs namenode = 127.0.0.1:8020 username = root</p> 25406 <pre><code> 25407 You can stop this image with `docker kill rclone-hdfs` (**NB** it does not use volumes, so all data 25408 uploaded will be lost.) 25409 25410 ### Modification times 25411 25412 Time accurate to 1 second is stored. 25413 25414 ### Checksum 25415 25416 No checksums are implemented. 25417 25418 ### Usage information 25419 25420 You can use the `rclone about remote:` command which will display filesystem size and current usage. 25421 25422 ### Restricted filename characters 25423 25424 In addition to the [default restricted characters set](https://rclone.org/overview/#restricted-characters) 25425 the following characters are also replaced: 25426 25427 | Character | Value | Replacement | 25428 | --------- |:-----:|:-----------:| 25429 | : | 0x3A | ： | 25430 25431 Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8). 25432 25433 25434 ### Standard options 25435 25436 Here are the Standard options specific to hdfs (Hadoop distributed file system). 25437 25438 #### --hdfs-namenode 25439 25440 Hadoop name nodes and ports. 25441 25442 E.g. "namenode-1:8020,namenode-2:8020,..." to connect to host namenodes at port 8020. 25443 25444 Properties: 25445 25446 - Config: namenode 25447 - Env Var: RCLONE_HDFS_NAMENODE 25448 - Type: CommaSepList 25449 - Default: 25450 25451 #### --hdfs-username 25452 25453 Hadoop user name. 25454 25455 Properties: 25456 25457 - Config: username 25458 - Env Var: RCLONE_HDFS_USERNAME 25459 - Type: string 25460 - Required: false 25461 - Examples: 25462 - "root" 25463 - Connect to hdfs as root. 25464 25465 ### Advanced options 25466 25467 Here are the Advanced options specific to hdfs (Hadoop distributed file system). 25468 25469 #### --hdfs-service-principal-name 25470 25471 Kerberos service principal name for the namenode. 25472 25473 Enables KERBEROS authentication. Specifies the Service Principal Name 25474 (SERVICE/FQDN) for the namenode. E.g. \"hdfs/namenode.hadoop.docker\" 25475 for namenode running as service 'hdfs' with FQDN 'namenode.hadoop.docker'. 25476 25477 Properties: 25478 25479 - Config: service_principal_name 25480 - Env Var: RCLONE_HDFS_SERVICE_PRINCIPAL_NAME 25481 - Type: string 25482 - Required: false 25483 25484 #### --hdfs-data-transfer-protection 25485 25486 Kerberos data transfer protection: authentication|integrity|privacy. 25487 25488 Specifies whether or not authentication, data signature integrity 25489 checks, and wire encryption are required when communicating with 25490 the datanodes. Possible values are 'authentication', 'integrity' 25491 and 'privacy'. Used only with KERBEROS enabled. 25492 25493 Properties: 25494 25495 - Config: data_transfer_protection 25496 - Env Var: RCLONE_HDFS_DATA_TRANSFER_PROTECTION 25497 - Type: string 25498 - Required: false 25499 - Examples: 25500 - "privacy" 25501 - Ensure authentication, integrity and encryption enabled. 25502 25503 #### --hdfs-encoding 25504 25505 The encoding for the backend. 25506 25507 See the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. 25508 25509 Properties: 25510 25511 - Config: encoding 25512 - Env Var: RCLONE_HDFS_ENCODING 25513 - Type: Encoding 25514 - Default: Slash,Colon,Del,Ctl,InvalidUtf8,Dot 25515 25516 #### --hdfs-description 25517 25518 Description of the remote 25519 25520 Properties: 25521 25522 - Config: description 25523 - Env Var: RCLONE_HDFS_DESCRIPTION 25524 - Type: string 25525 - Required: false 25526 25527 25528 25529 ## Limitations 25530 25531 - No server-side `Move` or `DirMove`. 25532 - Checksums not implemented. 25533 25534 # HiDrive 25535 25536 Paths are specified as `remote:path` 25537 25538 Paths may be as deep as required, e.g. `remote:directory/subdirectory`. 25539 25540 The initial setup for hidrive involves getting a token from HiDrive 25541 which you need to do in your browser. 25542 `rclone config` walks you through it. 25543 25544 ## Configuration 25545 25546 Here is an example of how to make a remote called `remote`. First run: 25547 25548 rclone config 25549 25550 This will guide you through an interactive setup process: 25551 </code></pre> 25552 <p>No remotes found - make a new one n) New remote s) Set configuration password q) Quit config n/s/q> n name> remote Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / HiDrive "hidrive" [snip] Storage> hidrive OAuth Client Id - Leave blank normally. client_id> OAuth Client Secret - Leave blank normally. client_secret> Access permissions that rclone should use when requesting access from HiDrive. Leave blank normally. scope_access> Edit advanced config? y/n> n Use web browser to automatically authenticate rclone with remote? * Say Y if the machine running rclone has a web browser you can use * Say N if running rclone on a (remote) machine without web browser access If not sure try Y. If Y failed, try N. y/n> y If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth?state=xxxxxxxxxxxxxxxxxxxxxx Log in and authorize rclone for access Waiting for code... Got code -------------------- [remote] type = hidrive token = {"access_token":"xxxxxxxxxxxxxxxxxxxx","token_type":"Bearer","refresh_token":"xxxxxxxxxxxxxxxxxxxxxxx","expiry":"xxxxxxxxxxxxxxxxxxxxxxx"} -------------------- y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y</p> 25553 <pre><code> 25554 **You should be aware that OAuth-tokens can be used to access your account 25555 and hence should not be shared with other persons.** 25556 See the [below section](#keeping-your-tokens-safe) for more information. 25557 25558 See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a 25559 machine with no Internet browser available. 25560 25561 Note that rclone runs a webserver on your local machine to collect the 25562 token as returned from HiDrive. This only runs from the moment it opens 25563 your browser to the moment you get back the verification code. 25564 The webserver runs on `http://127.0.0.1:53682/`. 25565 If local port `53682` is protected by a firewall you may need to temporarily 25566 unblock the firewall to complete authorization. 25567 25568 Once configured you can then use `rclone` like this, 25569 25570 List directories in top level of your HiDrive root folder 25571 25572 rclone lsd remote: 25573 25574 List all the files in your HiDrive filesystem 25575 25576 rclone ls remote: 25577 25578 To copy a local directory to a HiDrive directory called backup 25579 25580 rclone copy /home/source remote:backup 25581 25582 ### Keeping your tokens safe 25583 25584 Any OAuth-tokens will be stored by rclone in the remote's configuration file as unencrypted text. 25585 Anyone can use a valid refresh-token to access your HiDrive filesystem without knowing your password. 25586 Therefore you should make sure no one else can access your configuration. 25587 25588 It is possible to encrypt rclone's configuration file. 25589 You can find information on securing your configuration file by viewing the [configuration encryption docs](https://rclone.org/docs/#configuration-encryption). 25590 25591 ### Invalid refresh token 25592 25593 As can be verified [here](https://developer.hidrive.com/basics-flows/), 25594 each `refresh_token` (for Native Applications) is valid for 60 days. 25595 If used to access HiDrivei, its validity will be automatically extended. 25596 25597 This means that if you 25598 25599 * Don't use the HiDrive remote for 60 days 25600 25601 then rclone will return an error which includes a text 25602 that implies the refresh token is *invalid* or *expired*. 25603 25604 To fix this you will need to authorize rclone to access your HiDrive account again. 25605 25606 Using 25607 25608 rclone config reconnect remote: 25609 25610 the process is very similar to the process of initial setup exemplified before. 25611 25612 ### Modification times and hashes 25613 25614 HiDrive allows modification times to be set on objects accurate to 1 second. 25615 25616 HiDrive supports [its own hash type](https://static.hidrive.com/dev/0001) 25617 which is used to verify the integrity of file contents after successful transfers. 25618 25619 ### Restricted filename characters 25620 25621 HiDrive cannot store files or folders that include 25622 `/` (0x2F) or null-bytes (0x00) in their name. 25623 Any other characters can be used in the names of files or folders. 25624 Additionally, files or folders cannot be named either of the following: `.` or `..` 25625 25626 Therefore rclone will automatically replace these characters, 25627 if files or folders are stored or accessed with such names. 25628 25629 You can read about how this filename encoding works in general 25630 [here](overview/#restricted-filenames). 25631 25632 Keep in mind that HiDrive only supports file or folder names 25633 with a length of 255 characters or less. 25634 25635 ### Transfers 25636 25637 HiDrive limits file sizes per single request to a maximum of 2 GiB. 25638 To allow storage of larger files and allow for better upload performance, 25639 the hidrive backend will use a chunked transfer for files larger than 96 MiB. 25640 Rclone will upload multiple parts/chunks of the file at the same time. 25641 Chunks in the process of being uploaded are buffered in memory, 25642 so you may want to restrict this behaviour on systems with limited resources. 25643 25644 You can customize this behaviour using the following options: 25645 25646 * `chunk_size`: size of file parts 25647 * `upload_cutoff`: files larger or equal to this in size will use a chunked transfer 25648 * `upload_concurrency`: number of file-parts to upload at the same time 25649 25650 See the below section about configuration options for more details. 25651 25652 ### Root folder 25653 25654 You can set the root folder for rclone. 25655 This is the directory that rclone considers to be the root of your HiDrive. 25656 25657 Usually, you will leave this blank, and rclone will use the root of the account. 25658 25659 However, you can set this to restrict rclone to a specific folder hierarchy. 25660 25661 This works by prepending the contents of the `root_prefix` option 25662 to any paths accessed by rclone. 25663 For example, the following two ways to access the home directory are equivalent: 25664 25665 rclone lsd --hidrive-root-prefix="/users/test/" remote:path 25666 25667 rclone lsd remote:/users/test/path 25668 25669 See the below section about configuration options for more details. 25670 25671 ### Directory member count 25672 25673 By default, rclone will know the number of directory members contained in a directory. 25674 For example, `rclone lsd` uses this information. 25675 25676 The acquisition of this information will result in additional time costs for HiDrive's API. 25677 When dealing with large directory structures, it may be desirable to circumvent this time cost, 25678 especially when this information is not explicitly needed. 25679 For this, the `disable_fetching_member_count` option can be used. 25680 25681 See the below section about configuration options for more details. 25682 25683 25684 ### Standard options 25685 25686 Here are the Standard options specific to hidrive (HiDrive). 25687 25688 #### --hidrive-client-id 25689 25690 OAuth Client Id. 25691 25692 Leave blank normally. 25693 25694 Properties: 25695 25696 - Config: client_id 25697 - Env Var: RCLONE_HIDRIVE_CLIENT_ID 25698 - Type: string 25699 - Required: false 25700 25701 #### --hidrive-client-secret 25702 25703 OAuth Client Secret. 25704 25705 Leave blank normally. 25706 25707 Properties: 25708 25709 - Config: client_secret 25710 - Env Var: RCLONE_HIDRIVE_CLIENT_SECRET 25711 - Type: string 25712 - Required: false 25713 25714 #### --hidrive-scope-access 25715 25716 Access permissions that rclone should use when requesting access from HiDrive. 25717 25718 Properties: 25719 25720 - Config: scope_access 25721 - Env Var: RCLONE_HIDRIVE_SCOPE_ACCESS 25722 - Type: string 25723 - Default: "rw" 25724 - Examples: 25725 - "rw" 25726 - Read and write access to resources. 25727 - "ro" 25728 - Read-only access to resources. 25729 25730 ### Advanced options 25731 25732 Here are the Advanced options specific to hidrive (HiDrive). 25733 25734 #### --hidrive-token 25735 25736 OAuth Access Token as a JSON blob. 25737 25738 Properties: 25739 25740 - Config: token 25741 - Env Var: RCLONE_HIDRIVE_TOKEN 25742 - Type: string 25743 - Required: false 25744 25745 #### --hidrive-auth-url 25746 25747 Auth server URL. 25748 25749 Leave blank to use the provider defaults. 25750 25751 Properties: 25752 25753 - Config: auth_url 25754 - Env Var: RCLONE_HIDRIVE_AUTH_URL 25755 - Type: string 25756 - Required: false 25757 25758 #### --hidrive-token-url 25759 25760 Token server url. 25761 25762 Leave blank to use the provider defaults. 25763 25764 Properties: 25765 25766 - Config: token_url 25767 - Env Var: RCLONE_HIDRIVE_TOKEN_URL 25768 - Type: string 25769 - Required: false 25770 25771 #### --hidrive-scope-role 25772 25773 User-level that rclone should use when requesting access from HiDrive. 25774 25775 Properties: 25776 25777 - Config: scope_role 25778 - Env Var: RCLONE_HIDRIVE_SCOPE_ROLE 25779 - Type: string 25780 - Default: "user" 25781 - Examples: 25782 - "user" 25783 - User-level access to management permissions. 25784 - This will be sufficient in most cases. 25785 - "admin" 25786 - Extensive access to management permissions. 25787 - "owner" 25788 - Full access to management permissions. 25789 25790 #### --hidrive-root-prefix 25791 25792 The root/parent folder for all paths. 25793 25794 Fill in to use the specified folder as the parent for all paths given to the remote. 25795 This way rclone can use any folder as its starting point. 25796 25797 Properties: 25798 25799 - Config: root_prefix 25800 - Env Var: RCLONE_HIDRIVE_ROOT_PREFIX 25801 - Type: string 25802 - Default: "/" 25803 - Examples: 25804 - "/" 25805 - The topmost directory accessible by rclone. 25806 - This will be equivalent with "root" if rclone uses a regular HiDrive user account. 25807 - "root" 25808 - The topmost directory of the HiDrive user account 25809 - "" 25810 - This specifies that there is no root-prefix for your paths. 25811 - When using this you will always need to specify paths to this remote with a valid parent e.g. "remote:/path/to/dir" or "remote:root/path/to/dir". 25812 25813 #### --hidrive-endpoint 25814 25815 Endpoint for the service. 25816 25817 This is the URL that API-calls will be made to. 25818 25819 Properties: 25820 25821 - Config: endpoint 25822 - Env Var: RCLONE_HIDRIVE_ENDPOINT 25823 - Type: string 25824 - Default: "https://api.hidrive.strato.com/2.1" 25825 25826 #### --hidrive-disable-fetching-member-count 25827 25828 Do not fetch number of objects in directories unless it is absolutely necessary. 25829 25830 Requests may be faster if the number of objects in subdirectories is not fetched. 25831 25832 Properties: 25833 25834 - Config: disable_fetching_member_count 25835 - Env Var: RCLONE_HIDRIVE_DISABLE_FETCHING_MEMBER_COUNT 25836 - Type: bool 25837 - Default: false 25838 25839 #### --hidrive-chunk-size 25840 25841 Chunksize for chunked uploads. 25842 25843 Any files larger than the configured cutoff (or files of unknown size) will be uploaded in chunks of this size. 25844 25845 The upper limit for this is 2147483647 bytes (about 2.000Gi). 25846 That is the maximum amount of bytes a single upload-operation will support. 25847 Setting this above the upper limit or to a negative value will cause uploads to fail. 25848 25849 Setting this to larger values may increase the upload speed at the cost of using more memory. 25850 It can be set to smaller values smaller to save on memory. 25851 25852 Properties: 25853 25854 - Config: chunk_size 25855 - Env Var: RCLONE_HIDRIVE_CHUNK_SIZE 25856 - Type: SizeSuffix 25857 - Default: 48Mi 25858 25859 #### --hidrive-upload-cutoff 25860 25861 Cutoff/Threshold for chunked uploads. 25862 25863 Any files larger than this will be uploaded in chunks of the configured chunksize. 25864 25865 The upper limit for this is 2147483647 bytes (about 2.000Gi). 25866 That is the maximum amount of bytes a single upload-operation will support. 25867 Setting this above the upper limit will cause uploads to fail. 25868 25869 Properties: 25870 25871 - Config: upload_cutoff 25872 - Env Var: RCLONE_HIDRIVE_UPLOAD_CUTOFF 25873 - Type: SizeSuffix 25874 - Default: 96Mi 25875 25876 #### --hidrive-upload-concurrency 25877 25878 Concurrency for chunked uploads. 25879 25880 This is the upper limit for how many transfers for the same file are running concurrently. 25881 Setting this above to a value smaller than 1 will cause uploads to deadlock. 25882 25883 If you are uploading small numbers of large files over high-speed links 25884 and these uploads do not fully utilize your bandwidth, then increasing 25885 this may help to speed up the transfers. 25886 25887 Properties: 25888 25889 - Config: upload_concurrency 25890 - Env Var: RCLONE_HIDRIVE_UPLOAD_CONCURRENCY 25891 - Type: int 25892 - Default: 4 25893 25894 #### --hidrive-encoding 25895 25896 The encoding for the backend. 25897 25898 See the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. 25899 25900 Properties: 25901 25902 - Config: encoding 25903 - Env Var: RCLONE_HIDRIVE_ENCODING 25904 - Type: Encoding 25905 - Default: Slash,Dot 25906 25907 #### --hidrive-description 25908 25909 Description of the remote 25910 25911 Properties: 25912 25913 - Config: description 25914 - Env Var: RCLONE_HIDRIVE_DESCRIPTION 25915 - Type: string 25916 - Required: false 25917 25918 25919 25920 ## Limitations 25921 25922 ### Symbolic links 25923 25924 HiDrive is able to store symbolic links (*symlinks*) by design, 25925 for example, when unpacked from a zip archive. 25926 25927 There exists no direct mechanism to manage native symlinks in remotes. 25928 As such this implementation has chosen to ignore any native symlinks present in the remote. 25929 rclone will not be able to access or show any symlinks stored in the hidrive-remote. 25930 This means symlinks cannot be individually removed, copied, or moved, 25931 except when removing, copying, or moving the parent folder. 25932 25933 *This does not affect the `.rclonelink`-files 25934 that rclone uses to encode and store symbolic links.* 25935 25936 ### Sparse files 25937 25938 It is possible to store sparse files in HiDrive. 25939 25940 Note that copying a sparse file will expand the holes 25941 into null-byte (0x00) regions that will then consume disk space. 25942 Likewise, when downloading a sparse file, 25943 the resulting file will have null-byte regions in the place of file holes. 25944 25945 # HTTP 25946 25947 The HTTP remote is a read only remote for reading files of a 25948 webserver. The webserver should provide file listings which rclone 25949 will read and turn into a remote. This has been tested with common 25950 webservers such as Apache/Nginx/Caddy and will likely work with file 25951 listings from most web servers. (If it doesn't then please file an 25952 issue, or send a pull request!) 25953 25954 Paths are specified as `remote:` or `remote:path`. 25955 25956 The `remote:` represents the configured [url](#http-url), and any path following 25957 it will be resolved relative to this url, according to the URL standard. This 25958 means with remote url `https://beta.rclone.org/branch` and path `fix`, the 25959 resolved URL will be `https://beta.rclone.org/branch/fix`, while with path 25960 `/fix` the resolved URL will be `https://beta.rclone.org/fix` as the absolute 25961 path is resolved from the root of the domain. 25962 25963 If the path following the `remote:` ends with `/` it will be assumed to point 25964 to a directory. If the path does not end with `/`, then a HEAD request is sent 25965 and the response used to decide if it it is treated as a file or a directory 25966 (run with `-vv` to see details). When [--http-no-head](#http-no-head) is 25967 specified, a path without ending `/` is always assumed to be a file. If rclone 25968 incorrectly assumes the path is a file, the solution is to specify the path with 25969 ending `/`. When you know the path is a directory, ending it with `/` is always 25970 better as it avoids the initial HEAD request. 25971 25972 To just download a single file it is easier to use 25973 [copyurl](https://rclone.org/commands/rclone_copyurl/). 25974 25975 ## Configuration 25976 25977 Here is an example of how to make a remote called `remote`. First 25978 run: 25979 25980 rclone config 25981 25982 This will guide you through an interactive setup process: 25983 </code></pre> 25984 <p>No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n name> remote Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / HTTP "http" [snip] Storage> http URL of http host to connect to Choose a number from below, or type in your own value 1 / Connect to example.com "https://example.com" url> https://beta.rclone.org Remote config -------------------- [remote] url = https://beta.rclone.org -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y Current remotes:</p> 25985 <p>Name Type ==== ==== remote http</p> 25986 <ol start="5" type="a"> 25987 <li>Edit existing remote</li> 25988 <li>New remote</li> 25989 <li>Delete remote</li> 25990 <li>Rename remote</li> 25991 <li>Copy remote</li> 25992 <li>Set configuration password</li> 25993 <li>Quit config e/n/d/r/c/s/q> q</li> 25994 </ol> 25995 <pre><code> 25996 This remote is called `remote` and can now be used like this 25997 25998 See all the top level directories 25999 26000 rclone lsd remote: 26001 26002 List the contents of a directory 26003 26004 rclone ls remote:directory 26005 26006 Sync the remote `directory` to `/home/local/directory`, deleting any excess files. 26007 26008 rclone sync --interactive remote:directory /home/local/directory 26009 26010 ### Read only 26011 26012 This remote is read only - you can't upload files to an HTTP server. 26013 26014 ### Modification times 26015 26016 Most HTTP servers store time accurate to 1 second. 26017 26018 ### Checksum 26019 26020 No checksums are stored. 26021 26022 ### Usage without a config file 26023 26024 Since the http remote only has one config parameter it is easy to use 26025 without a config file: 26026 26027 rclone lsd --http-url https://beta.rclone.org :http: 26028 26029 or: 26030 26031 rclone lsd :http,url='https://beta.rclone.org': 26032 26033 26034 ### Standard options 26035 26036 Here are the Standard options specific to http (HTTP). 26037 26038 #### --http-url 26039 26040 URL of HTTP host to connect to. 26041 26042 E.g. "https://example.com", or "https://user:pass@example.com" to use a username and password. 26043 26044 Properties: 26045 26046 - Config: url 26047 - Env Var: RCLONE_HTTP_URL 26048 - Type: string 26049 - Required: true 26050 26051 ### Advanced options 26052 26053 Here are the Advanced options specific to http (HTTP). 26054 26055 #### --http-headers 26056 26057 Set HTTP headers for all transactions. 26058 26059 Use this to set additional HTTP headers for all transactions. 26060 26061 The input format is comma separated list of key,value pairs. Standard 26062 [CSV encoding](https://godoc.org/encoding/csv) may be used. 26063 26064 For example, to set a Cookie use 'Cookie,name=value', or '"Cookie","name=value"'. 26065 26066 You can set multiple headers, e.g. '"Cookie","name=value","Authorization","xxx"'. 26067 26068 Properties: 26069 26070 - Config: headers 26071 - Env Var: RCLONE_HTTP_HEADERS 26072 - Type: CommaSepList 26073 - Default: 26074 26075 #### --http-no-slash 26076 26077 Set this if the site doesn't end directories with /. 26078 26079 Use this if your target website does not use / on the end of 26080 directories. 26081 26082 A / on the end of a path is how rclone normally tells the difference 26083 between files and directories. If this flag is set, then rclone will 26084 treat all files with Content-Type: text/html as directories and read 26085 URLs from them rather than downloading them. 26086 26087 Note that this may cause rclone to confuse genuine HTML files with 26088 directories. 26089 26090 Properties: 26091 26092 - Config: no_slash 26093 - Env Var: RCLONE_HTTP_NO_SLASH 26094 - Type: bool 26095 - Default: false 26096 26097 #### --http-no-head 26098 26099 Don't use HEAD requests. 26100 26101 HEAD requests are mainly used to find file sizes in dir listing. 26102 If your site is being very slow to load then you can try this option. 26103 Normally rclone does a HEAD request for each potential file in a 26104 directory listing to: 26105 26106 - find its size 26107 - check it really exists 26108 - check to see if it is a directory 26109 26110 If you set this option, rclone will not do the HEAD request. This will mean 26111 that directory listings are much quicker, but rclone won't have the times or 26112 sizes of any files, and some files that don't exist may be in the listing. 26113 26114 Properties: 26115 26116 - Config: no_head 26117 - Env Var: RCLONE_HTTP_NO_HEAD 26118 - Type: bool 26119 - Default: false 26120 26121 #### --http-description 26122 26123 Description of the remote 26124 26125 Properties: 26126 26127 - Config: description 26128 - Env Var: RCLONE_HTTP_DESCRIPTION 26129 - Type: string 26130 - Required: false 26131 26132 ## Backend commands 26133 26134 Here are the commands specific to the http backend. 26135 26136 Run them with 26137 26138 rclone backend COMMAND remote: 26139 26140 The help below will explain what arguments each command takes. 26141 26142 See the [backend](https://rclone.org/commands/rclone_backend/) command for more 26143 info on how to pass options and arguments. 26144 26145 These can be run on a running backend using the rc command 26146 [backend/command](https://rclone.org/rc/#backend-command). 26147 26148 ### set 26149 26150 Set command for updating the config parameters. 26151 26152 rclone backend set remote: [options] [<arguments>+] 26153 26154 This set command can be used to update the config parameters 26155 for a running http backend. 26156 26157 Usage Examples: 26158 26159 rclone backend set remote: [-o opt_name=opt_value] [-o opt_name2=opt_value2] 26160 rclone rc backend/command command=set fs=remote: [-o opt_name=opt_value] [-o opt_name2=opt_value2] 26161 rclone rc backend/command command=set fs=remote: -o url=https://example.com 26162 26163 The option keys are named as they are in the config file. 26164 26165 This rebuilds the connection to the http backend when it is called with 26166 the new parameters. Only new parameters need be passed as the values 26167 will default to those currently in use. 26168 26169 It doesn't return anything. 26170 26171 26172 26173 26174 ## Limitations 26175 26176 `rclone about` is not supported by the HTTP backend. Backends without 26177 this capability cannot determine free space for an rclone mount or 26178 use policy `mfs` (most free space) as a member of an rclone union 26179 remote. 26180 26181 See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features) and [rclone about](https://rclone.org/commands/rclone_about/) 26182 26183 # ImageKit 26184 This is a backend for the [ImageKit.io](https://imagekit.io/) storage service. 26185 26186 #### About ImageKit 26187 [ImageKit.io](https://imagekit.io/) provides real-time image and video optimizations, transformations, and CDN delivery. Over 1,000 businesses and 70,000 developers trust ImageKit with their images and videos on the web. 26188 26189 26190 #### Accounts & Pricing 26191 26192 To use this backend, you need to [create an account](https://imagekit.io/registration/) on ImageKit. Start with a free plan with generous usage limits. Then, as your requirements grow, upgrade to a plan that best fits your needs. See [the pricing details](https://imagekit.io/plans). 26193 26194 ## Configuration 26195 26196 Here is an example of making an imagekit configuration. 26197 26198 Firstly create a [ImageKit.io](https://imagekit.io/) account and choose a plan. 26199 26200 You will need to log in and get the `publicKey` and `privateKey` for your account from the developer section. 26201 26202 Now run</code></pre> 26203 <p>rclone config</p> 26204 <pre><code> 26205 This will guide you through an interactive setup process: 26206 </code></pre> 26207 <p>No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n</p> 26208 <p>Enter the name for the new remote. name> imagekit-media-library</p> 26209 <p>Option Storage. Type of storage to configure. Choose a number from below, or type in your own value. [snip] XX / ImageKit.io (imagekit) [snip] Storage> imagekit</p> 26210 <p>Option endpoint. You can find your ImageKit.io URL endpoint in your <a href="https://imagekit.io/dashboard/developer/api-keys">dashboard</a> Enter a value. endpoint> https://ik.imagekit.io/imagekit_id</p> 26211 <p>Option public_key. You can find your ImageKit.io public key in your <a href="https://imagekit.io/dashboard/developer/api-keys">dashboard</a> Enter a value. public_key> public_****************************</p> 26212 <p>Option private_key. You can find your ImageKit.io private key in your <a href="https://imagekit.io/dashboard/developer/api-keys">dashboard</a> Enter a value. private_key> private_****************************</p> 26213 <p>Edit advanced config? y) Yes n) No (default) y/n> n</p> 26214 <p>Configuration complete. Options: - type: imagekit - endpoint: https://ik.imagekit.io/imagekit_id - public_key: public_**************************** - private_key: private_****************************</p> 26215 <p>Keep this "imagekit-media-library" remote? y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y</p> 26216 <pre><code>List directories in the top level of your Media Library</code></pre> 26217 <p>rclone lsd imagekit-media-library:</p> 26218 <pre><code>Make a new directory.</code></pre> 26219 <p>rclone mkdir imagekit-media-library:directory</p> 26220 <pre><code>List the contents of a directory.</code></pre> 26221 <p>rclone ls imagekit-media-library:directory</p> 26222 <pre><code> 26223 ### Modified time and hashes 26224 26225 ImageKit does not support modification times or hashes yet. 26226 26227 ### Checksums 26228 26229 No checksums are supported. 26230 26231 26232 ### Standard options 26233 26234 Here are the Standard options specific to imagekit (ImageKit.io). 26235 26236 #### --imagekit-endpoint 26237 26238 You can find your ImageKit.io URL endpoint in your [dashboard](https://imagekit.io/dashboard/developer/api-keys) 26239 26240 Properties: 26241 26242 - Config: endpoint 26243 - Env Var: RCLONE_IMAGEKIT_ENDPOINT 26244 - Type: string 26245 - Required: true 26246 26247 #### --imagekit-public-key 26248 26249 You can find your ImageKit.io public key in your [dashboard](https://imagekit.io/dashboard/developer/api-keys) 26250 26251 Properties: 26252 26253 - Config: public_key 26254 - Env Var: RCLONE_IMAGEKIT_PUBLIC_KEY 26255 - Type: string 26256 - Required: true 26257 26258 #### --imagekit-private-key 26259 26260 You can find your ImageKit.io private key in your [dashboard](https://imagekit.io/dashboard/developer/api-keys) 26261 26262 Properties: 26263 26264 - Config: private_key 26265 - Env Var: RCLONE_IMAGEKIT_PRIVATE_KEY 26266 - Type: string 26267 - Required: true 26268 26269 ### Advanced options 26270 26271 Here are the Advanced options specific to imagekit (ImageKit.io). 26272 26273 #### --imagekit-only-signed 26274 26275 If you have configured `Restrict unsigned image URLs` in your dashboard settings, set this to true. 26276 26277 Properties: 26278 26279 - Config: only_signed 26280 - Env Var: RCLONE_IMAGEKIT_ONLY_SIGNED 26281 - Type: bool 26282 - Default: false 26283 26284 #### --imagekit-versions 26285 26286 Include old versions in directory listings. 26287 26288 Properties: 26289 26290 - Config: versions 26291 - Env Var: RCLONE_IMAGEKIT_VERSIONS 26292 - Type: bool 26293 - Default: false 26294 26295 #### --imagekit-upload-tags 26296 26297 Tags to add to the uploaded files, e.g. "tag1,tag2". 26298 26299 Properties: 26300 26301 - Config: upload_tags 26302 - Env Var: RCLONE_IMAGEKIT_UPLOAD_TAGS 26303 - Type: string 26304 - Required: false 26305 26306 #### --imagekit-encoding 26307 26308 The encoding for the backend. 26309 26310 See the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. 26311 26312 Properties: 26313 26314 - Config: encoding 26315 - Env Var: RCLONE_IMAGEKIT_ENCODING 26316 - Type: Encoding 26317 - Default: Slash,LtGt,DoubleQuote,Dollar,Question,Hash,Percent,BackSlash,Del,Ctl,InvalidUtf8,Dot,SquareBracket 26318 26319 #### --imagekit-description 26320 26321 Description of the remote 26322 26323 Properties: 26324 26325 - Config: description 26326 - Env Var: RCLONE_IMAGEKIT_DESCRIPTION 26327 - Type: string 26328 - Required: false 26329 26330 ### Metadata 26331 26332 Any metadata supported by the underlying remote is read and written. 26333 26334 Here are the possible system metadata items for the imagekit backend. 26335 26336 | Name | Help | Type | Example | Read Only | 26337 |------|------|------|---------|-----------| 26338 | aws-tags | AI generated tags by AWS Rekognition associated with the image | string | tag1,tag2 | **Y** | 26339 | btime | Time of file birth (creation) read from Last-Modified header | RFC 3339 | 2006-01-02T15:04:05.999999999Z07:00 | **Y** | 26340 | custom-coordinates | Custom coordinates of the file | string | 0,0,100,100 | **Y** | 26341 | file-type | Type of the file | string | image | **Y** | 26342 | google-tags | AI generated tags by Google Cloud Vision associated with the image | string | tag1,tag2 | **Y** | 26343 | has-alpha | Whether the image has alpha channel or not | bool | | **Y** | 26344 | height | Height of the image or video in pixels | int | | **Y** | 26345 | is-private-file | Whether the file is private or not | bool | | **Y** | 26346 | size | Size of the object in bytes | int64 | | **Y** | 26347 | tags | Tags associated with the file | string | tag1,tag2 | **Y** | 26348 | width | Width of the image or video in pixels | int | | **Y** | 26349 26350 See the [metadata](https://rclone.org/docs/#metadata) docs for more info. 26351 26352 26353 26354 # Internet Archive 26355 26356 The Internet Archive backend utilizes Items on [archive.org](https://archive.org/) 26357 26358 Refer to [IAS3 API documentation](https://archive.org/services/docs/api/ias3.html) for the API this backend uses. 26359 26360 Paths are specified as `remote:bucket` (or `remote:` for the `lsd` 26361 command.) You may put subdirectories in too, e.g. `remote:item/path/to/dir`. 26362 26363 Unlike S3, listing up all items uploaded by you isn't supported. 26364 26365 Once you have made a remote, you can use it like this: 26366 26367 Make a new item 26368 26369 rclone mkdir remote:item 26370 26371 List the contents of a item 26372 26373 rclone ls remote:item 26374 26375 Sync `/home/local/directory` to the remote item, deleting any excess 26376 files in the item. 26377 26378 rclone sync --interactive /home/local/directory remote:item 26379 26380 ## Notes 26381 Because of Internet Archive's architecture, it enqueues write operations (and extra post-processings) in a per-item queue. You can check item's queue at https://catalogd.archive.org/history/item-name-here . Because of that, all uploads/deletes will not show up immediately and takes some time to be available. 26382 The per-item queue is enqueued to an another queue, Item Deriver Queue. [You can check the status of Item Deriver Queue here.](https://catalogd.archive.org/catalog.php?whereami=1) This queue has a limit, and it may block you from uploading, or even deleting. You should avoid uploading a lot of small files for better behavior. 26383 26384 You can optionally wait for the server's processing to finish, by setting non-zero value to `wait_archive` key. 26385 By making it wait, rclone can do normal file comparison. 26386 Make sure to set a large enough value (e.g. `30m0s` for smaller files) as it can take a long time depending on server's queue. 26387 26388 ## About metadata 26389 This backend supports setting, updating and reading metadata of each file. 26390 The metadata will appear as file metadata on Internet Archive. 26391 However, some fields are reserved by both Internet Archive and rclone. 26392 26393 The following are reserved by Internet Archive: 26394 - `name` 26395 - `source` 26396 - `size` 26397 - `md5` 26398 - `crc32` 26399 - `sha1` 26400 - `format` 26401 - `old_version` 26402 - `viruscheck` 26403 - `summation` 26404 26405 Trying to set values to these keys is ignored with a warning. 26406 Only setting `mtime` is an exception. Doing so make it the identical behavior as setting ModTime. 26407 26408 rclone reserves all the keys starting with `rclone-`. Setting value for these keys will give you warnings, but values are set according to request. 26409 26410 If there are multiple values for a key, only the first one is returned. 26411 This is a limitation of rclone, that supports one value per one key. 26412 It can be triggered when you did a server-side copy. 26413 26414 Reading metadata will also provide custom (non-standard nor reserved) ones. 26415 26416 ## Filtering auto generated files 26417 26418 The Internet Archive automatically creates metadata files after 26419 upload. These can cause problems when doing an `rclone sync` as rclone 26420 will try, and fail, to delete them. These metadata files are not 26421 changeable, as they are created by the Internet Archive automatically. 26422 26423 These auto-created files can be excluded from the sync using [metadata 26424 filtering](https://rclone.org/filtering/#metadata). 26425 26426 rclone sync ... --metadata-exclude "source=metadata" --metadata-exclude "format=Metadata" 26427 26428 Which excludes from the sync any files which have the 26429 `source=metadata` or `format=Metadata` flags which are added to 26430 Internet Archive auto-created files. 26431 26432 ## Configuration 26433 26434 Here is an example of making an internetarchive configuration. 26435 Most applies to the other providers as well, any differences are described [below](#providers). 26436 26437 First run 26438 26439 rclone config 26440 26441 This will guide you through an interactive setup process. 26442 </code></pre> 26443 <p>No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n name> remote Option Storage. Type of storage to configure. Choose a number from below, or type in your own value. XX / InternetArchive Items (internetarchive) Storage> internetarchive Option access_key_id. IAS3 Access Key. Leave blank for anonymous access. You can find one here: https://archive.org/account/s3.php Enter a value. Press Enter to leave empty. access_key_id> XXXX Option secret_access_key. IAS3 Secret Key (password). Leave blank for anonymous access. Enter a value. Press Enter to leave empty. secret_access_key> XXXX Edit advanced config? y) Yes n) No (default) y/n> y Option endpoint. IAS3 Endpoint. Leave blank for default value. Enter a string value. Press Enter for the default (https://s3.us.archive.org). endpoint> Option front_endpoint. Host of InternetArchive Frontend. Leave blank for default value. Enter a string value. Press Enter for the default (https://archive.org). front_endpoint> Option disable_checksum. Don't store MD5 checksum with object metadata. Normally rclone will calculate the MD5 checksum of the input before uploading it so it can ask the server to check the object against checksum. This is great for data integrity checking but can cause long delays for large files to start uploading. Enter a boolean value (true or false). Press Enter for the default (true). disable_checksum> true Option encoding. The encoding for the backend. See the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info. Enter a encoder.MultiEncoder value. Press Enter for the default (Slash,Question,Hash,Percent,Del,Ctl,InvalidUtf8,Dot). encoding> Edit advanced config? y) Yes n) No (default) y/n> n -------------------- [remote] type = internetarchive access_key_id = XXXX secret_access_key = XXXX -------------------- y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y</p> 26444 <pre><code> 26445 26446 ### Standard options 26447 26448 Here are the Standard options specific to internetarchive (Internet Archive). 26449 26450 #### --internetarchive-access-key-id 26451 26452 IAS3 Access Key. 26453 26454 Leave blank for anonymous access. 26455 You can find one here: https://archive.org/account/s3.php 26456 26457 Properties: 26458 26459 - Config: access_key_id 26460 - Env Var: RCLONE_INTERNETARCHIVE_ACCESS_KEY_ID 26461 - Type: string 26462 - Required: false 26463 26464 #### --internetarchive-secret-access-key 26465 26466 IAS3 Secret Key (password). 26467 26468 Leave blank for anonymous access. 26469 26470 Properties: 26471 26472 - Config: secret_access_key 26473 - Env Var: RCLONE_INTERNETARCHIVE_SECRET_ACCESS_KEY 26474 - Type: string 26475 - Required: false 26476 26477 ### Advanced options 26478 26479 Here are the Advanced options specific to internetarchive (Internet Archive). 26480 26481 #### --internetarchive-endpoint 26482 26483 IAS3 Endpoint. 26484 26485 Leave blank for default value. 26486 26487 Properties: 26488 26489 - Config: endpoint 26490 - Env Var: RCLONE_INTERNETARCHIVE_ENDPOINT 26491 - Type: string 26492 - Default: "https://s3.us.archive.org" 26493 26494 #### --internetarchive-front-endpoint 26495 26496 Host of InternetArchive Frontend. 26497 26498 Leave blank for default value. 26499 26500 Properties: 26501 26502 - Config: front_endpoint 26503 - Env Var: RCLONE_INTERNETARCHIVE_FRONT_ENDPOINT 26504 - Type: string 26505 - Default: "https://archive.org" 26506 26507 #### --internetarchive-disable-checksum 26508 26509 Don't ask the server to test against MD5 checksum calculated by rclone. 26510 Normally rclone will calculate the MD5 checksum of the input before 26511 uploading it so it can ask the server to check the object against checksum. 26512 This is great for data integrity checking but can cause long delays for 26513 large files to start uploading. 26514 26515 Properties: 26516 26517 - Config: disable_checksum 26518 - Env Var: RCLONE_INTERNETARCHIVE_DISABLE_CHECKSUM 26519 - Type: bool 26520 - Default: true 26521 26522 #### --internetarchive-wait-archive 26523 26524 Timeout for waiting the server's processing tasks (specifically archive and book_op) to finish. 26525 Only enable if you need to be guaranteed to be reflected after write operations. 26526 0 to disable waiting. No errors to be thrown in case of timeout. 26527 26528 Properties: 26529 26530 - Config: wait_archive 26531 - Env Var: RCLONE_INTERNETARCHIVE_WAIT_ARCHIVE 26532 - Type: Duration 26533 - Default: 0s 26534 26535 #### --internetarchive-encoding 26536 26537 The encoding for the backend. 26538 26539 See the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. 26540 26541 Properties: 26542 26543 - Config: encoding 26544 - Env Var: RCLONE_INTERNETARCHIVE_ENCODING 26545 - Type: Encoding 26546 - Default: Slash,LtGt,CrLf,Del,Ctl,InvalidUtf8,Dot 26547 26548 #### --internetarchive-description 26549 26550 Description of the remote 26551 26552 Properties: 26553 26554 - Config: description 26555 - Env Var: RCLONE_INTERNETARCHIVE_DESCRIPTION 26556 - Type: string 26557 - Required: false 26558 26559 ### Metadata 26560 26561 Metadata fields provided by Internet Archive. 26562 If there are multiple values for a key, only the first one is returned. 26563 This is a limitation of Rclone, that supports one value per one key. 26564 26565 Owner is able to add custom keys. Metadata feature grabs all the keys including them. 26566 26567 Here are the possible system metadata items for the internetarchive backend. 26568 26569 | Name | Help | Type | Example | Read Only | 26570 |------|------|------|---------|-----------| 26571 | crc32 | CRC32 calculated by Internet Archive | string | 01234567 | **Y** | 26572 | format | Name of format identified by Internet Archive | string | Comma-Separated Values | **Y** | 26573 | md5 | MD5 hash calculated by Internet Archive | string | 01234567012345670123456701234567 | **Y** | 26574 | mtime | Time of last modification, managed by Rclone | RFC 3339 | 2006-01-02T15:04:05.999999999Z | **Y** | 26575 | name | Full file path, without the bucket part | filename | backend/internetarchive/internetarchive.go | **Y** | 26576 | old_version | Whether the file was replaced and moved by keep-old-version flag | boolean | true | **Y** | 26577 | rclone-ia-mtime | Time of last modification, managed by Internet Archive | RFC 3339 | 2006-01-02T15:04:05.999999999Z | N | 26578 | rclone-mtime | Time of last modification, managed by Rclone | RFC 3339 | 2006-01-02T15:04:05.999999999Z | N | 26579 | rclone-update-track | Random value used by Rclone for tracking changes inside Internet Archive | string | aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa | N | 26580 | sha1 | SHA1 hash calculated by Internet Archive | string | 0123456701234567012345670123456701234567 | **Y** | 26581 | size | File size in bytes | decimal number | 123456 | **Y** | 26582 | source | The source of the file | string | original | **Y** | 26583 | summation | Check https://forum.rclone.org/t/31922 for how it is used | string | md5 | **Y** | 26584 | viruscheck | The last time viruscheck process was run for the file (?) | unixtime | 1654191352 | **Y** | 26585 26586 See the [metadata](https://rclone.org/docs/#metadata) docs for more info. 26587 26588 26589 26590 # Jottacloud 26591 26592 Jottacloud is a cloud storage service provider from a Norwegian company, using its own datacenters 26593 in Norway. In addition to the official service at [jottacloud.com](https://www.jottacloud.com/), 26594 it also provides white-label solutions to different companies, such as: 26595 * Telia 26596 * Telia Cloud (cloud.telia.se) 26597 * Telia Sky (sky.telia.no) 26598 * Tele2 26599 * Tele2 Cloud (mittcloud.tele2.se) 26600 * Onlime 26601 * Onlime Cloud Storage (onlime.dk) 26602 * Elkjøp (with subsidiaries): 26603 * Elkjøp Cloud (cloud.elkjop.no) 26604 * Elgiganten Sweden (cloud.elgiganten.se) 26605 * Elgiganten Denmark (cloud.elgiganten.dk) 26606 * Giganti Cloud (cloud.gigantti.fi) 26607 * ELKO Cloud (cloud.elko.is) 26608 26609 Most of the white-label versions are supported by this backend, although may require different 26610 authentication setup - described below. 26611 26612 Paths are specified as `remote:path` 26613 26614 Paths may be as deep as required, e.g. `remote:directory/subdirectory`. 26615 26616 ## Authentication types 26617 26618 Some of the whitelabel versions uses a different authentication method than the official service, 26619 and you have to choose the correct one when setting up the remote. 26620 26621 ### Standard authentication 26622 26623 The standard authentication method used by the official service (jottacloud.com), as well as 26624 some of the whitelabel services, requires you to generate a single-use personal login token 26625 from the account security settings in the service's web interface. Log in to your account, 26626 go to "Settings" and then "Security", or use the direct link presented to you by rclone when 26627 configuring the remote: <https://www.jottacloud.com/web/secure>. Scroll down to the section 26628 "Personal login token", and click the "Generate" button. Note that if you are using a 26629 whitelabel service you probably can't use the direct link, you need to find the same page in 26630 their dedicated web interface, and also it may be in a different location than described above. 26631 26632 To access your account from multiple instances of rclone, you need to configure each of them 26633 with a separate personal login token. E.g. you create a Jottacloud remote with rclone in one 26634 location, and copy the configuration file to a second location where you also want to run 26635 rclone and access the same remote. Then you need to replace the token for one of them, using 26636 the [config reconnect](https://rclone.org/commands/rclone_config_reconnect/) command, which 26637 requires you to generate a new personal login token and supply as input. If you do not 26638 do this, the token may easily end up being invalidated, resulting in both instances failing 26639 with an error message something along the lines of: 26640 26641 oauth2: cannot fetch token: 400 Bad Request 26642 Response: {"error":"invalid_grant","error_description":"Stale token"} 26643 26644 When this happens, you need to replace the token as described above to be able to use your 26645 remote again. 26646 26647 All personal login tokens you have taken into use will be listed in the web interface under 26648 "My logged in devices", and from the right side of that list you can click the "X" button to 26649 revoke individual tokens. 26650 26651 ### Legacy authentication 26652 26653 If you are using one of the whitelabel versions (e.g. from Elkjøp) you may not have the option 26654 to generate a CLI token. In this case you'll have to use the legacy authentication. To do this select 26655 yes when the setup asks for legacy authentication and enter your username and password. 26656 The rest of the setup is identical to the default setup. 26657 26658 ### Telia Cloud authentication 26659 26660 Similar to other whitelabel versions Telia Cloud doesn't offer the option of creating a CLI token, and 26661 additionally uses a separate authentication flow where the username is generated internally. To setup 26662 rclone to use Telia Cloud, choose Telia Cloud authentication in the setup. The rest of the setup is 26663 identical to the default setup. 26664 26665 ### Tele2 Cloud authentication 26666 26667 As Tele2-Com Hem merger was completed this authentication can be used for former Com Hem Cloud and 26668 Tele2 Cloud customers as no support for creating a CLI token exists, and additionally uses a separate 26669 authentication flow where the username is generated internally. To setup rclone to use Tele2 Cloud, 26670 choose Tele2 Cloud authentication in the setup. The rest of the setup is identical to the default setup. 26671 26672 ### Onlime Cloud Storage authentication 26673 26674 Onlime has sold access to Jottacloud proper, while providing localized support to Danish Customers, but 26675 have recently set up their own hosting, transferring their customers from Jottacloud servers to their 26676 own ones. 26677 26678 This, of course, necessitates using their servers for authentication, but otherwise functionality and 26679 architecture seems equivalent to Jottacloud. 26680 26681 To setup rclone to use Onlime Cloud Storage, choose Onlime Cloud authentication in the setup. The rest 26682 of the setup is identical to the default setup. 26683 26684 ## Configuration 26685 26686 Here is an example of how to make a remote called `remote` with the default setup. First run: 26687 26688 rclone config 26689 26690 This will guide you through an interactive setup process: 26691 </code></pre> 26692 <p>No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n name> remote Option Storage. Type of storage to configure. Choose a number from below, or type in your own value. [snip] XX / Jottacloud (jottacloud) [snip] Storage> jottacloud Edit advanced config? y) Yes n) No (default) y/n> n Option config_type. Select authentication type. Choose a number from below, or type in an existing string value. Press Enter for the default (standard). / Standard authentication. 1 | Use this if you're a normal Jottacloud user. (standard) / Legacy authentication. 2 | This is only required for certain whitelabel versions of Jottacloud and not recommended for normal users. (legacy) / Telia Cloud authentication. 3 | Use this if you are using Telia Cloud. (telia) / Tele2 Cloud authentication. 4 | Use this if you are using Tele2 Cloud. (tele2) / Onlime Cloud authentication. 5 | Use this if you are using Onlime Cloud. (onlime) config_type> 1 Personal login token. Generate here: https://www.jottacloud.com/web/secure Login Token> <your token here> Use a non-standard device/mountpoint? Choosing no, the default, will let you access the storage used for the archive section of the official Jottacloud client. If you instead want to access the sync or the backup section, for example, you must choose yes. y) Yes n) No (default) y/n> y Option config_device. The device to use. In standard setup the built-in Jotta device is used, which contains predefined mountpoints for archive, sync etc. All other devices are treated as backup devices by the official Jottacloud client. You may create a new by entering a unique name. Choose a number from below, or type in your own string value. Press Enter for the default (DESKTOP-3H31129). 1 > DESKTOP-3H31129 2 > Jotta config_device> 2 Option config_mountpoint. The mountpoint to use for the built-in device Jotta. The standard setup is to use the Archive mountpoint. Most other mountpoints have very limited support in rclone and should generally be avoided. Choose a number from below, or type in an existing string value. Press Enter for the default (Archive). 1 > Archive 2 > Shared 3 > Sync config_mountpoint> 1 -------------------- [remote] type = jottacloud configVersion = 1 client_id = jottacli client_secret = tokenURL = https://id.jottacloud.com/auth/realms/jottacloud/protocol/openid-connect/token token = {........} username = 2940e57271a93d987d6f8a21 device = Jotta mountpoint = Archive -------------------- y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y</p> 26693 <pre><code> 26694 Once configured you can then use `rclone` like this, 26695 26696 List directories in top level of your Jottacloud 26697 26698 rclone lsd remote: 26699 26700 List all the files in your Jottacloud 26701 26702 rclone ls remote: 26703 26704 To copy a local directory to an Jottacloud directory called backup 26705 26706 rclone copy /home/source remote:backup 26707 26708 ### Devices and Mountpoints 26709 26710 The official Jottacloud client registers a device for each computer you install 26711 it on, and shows them in the backup section of the user interface. For each 26712 folder you select for backup it will create a mountpoint within this device. 26713 A built-in device called Jotta is special, and contains mountpoints Archive, 26714 Sync and some others, used for corresponding features in official clients. 26715 26716 With rclone you'll want to use the standard Jotta/Archive device/mountpoint in 26717 most cases. However, you may for example want to access files from the sync or 26718 backup functionality provided by the official clients, and rclone therefore 26719 provides the option to select other devices and mountpoints during config. 26720 26721 You are allowed to create new devices and mountpoints. All devices except the 26722 built-in Jotta device are treated as backup devices by official Jottacloud 26723 clients, and the mountpoints on them are individual backup sets. 26724 26725 With the built-in Jotta device, only existing, built-in, mountpoints can be 26726 selected. In addition to the mentioned Archive and Sync, it may contain 26727 several other mountpoints such as: Latest, Links, Shared and Trash. All of 26728 these are special mountpoints with a different internal representation than 26729 the "regular" mountpoints. Rclone will only to a very limited degree support 26730 them. Generally you should avoid these, unless you know what you are doing. 26731 26732 ### --fast-list 26733 26734 This backend supports `--fast-list` which allows you to use fewer 26735 transactions in exchange for more memory. See the [rclone 26736 docs](https://rclone.org/docs/#fast-list) for more details. 26737 26738 Note that the implementation in Jottacloud always uses only a single 26739 API request to get the entire list, so for large folders this could 26740 lead to long wait time before the first results are shown. 26741 26742 Note also that with rclone version 1.58 and newer, information about 26743 [MIME types](https://rclone.org/overview/#mime-type) and metadata item [utime](#metadata) 26744 are not available when using `--fast-list`. 26745 26746 ### Modification times and hashes 26747 26748 Jottacloud allows modification times to be set on objects accurate to 1 26749 second. These will be used to detect whether objects need syncing or 26750 not. 26751 26752 Jottacloud supports MD5 type hashes, so you can use the `--checksum` 26753 flag. 26754 26755 Note that Jottacloud requires the MD5 hash before upload so if the 26756 source does not have an MD5 checksum then the file will be cached 26757 temporarily on disk (in location given by 26758 [--temp-dir](https://rclone.org/docs/#temp-dir-dir)) before it is uploaded. 26759 Small files will be cached in memory - see the 26760 [--jottacloud-md5-memory-limit](#jottacloud-md5-memory-limit) flag. 26761 When uploading from local disk the source checksum is always available, 26762 so this does not apply. Starting with rclone version 1.52 the same is 26763 true for encrypted remotes (in older versions the crypt backend would not 26764 calculate hashes for uploads from local disk, so the Jottacloud 26765 backend had to do it as described above). 26766 26767 ### Restricted filename characters 26768 26769 In addition to the [default restricted characters set](https://rclone.org/overview/#restricted-characters) 26770 the following characters are also replaced: 26771 26772 | Character | Value | Replacement | 26773 | --------- |:-----:|:-----------:| 26774 | " | 0x22 | ＂ | 26775 | * | 0x2A | ＊ | 26776 | : | 0x3A | ： | 26777 | < | 0x3C | ＜ | 26778 | > | 0x3E | ＞ | 26779 | ? | 0x3F | ？ | 26780 | \| | 0x7C | ｜ | 26781 26782 Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8), 26783 as they can't be used in XML strings. 26784 26785 ### Deleting files 26786 26787 By default, rclone will send all files to the trash when deleting files. They will be permanently 26788 deleted automatically after 30 days. You may bypass the trash and permanently delete files immediately 26789 by using the [--jottacloud-hard-delete](#jottacloud-hard-delete) flag, or set the equivalent environment variable. 26790 Emptying the trash is supported by the [cleanup](https://rclone.org/commands/rclone_cleanup/) command. 26791 26792 ### Versions 26793 26794 Jottacloud supports file versioning. When rclone uploads a new version of a file it creates a new version of it. 26795 Currently rclone only supports retrieving the current version but older versions can be accessed via the Jottacloud Website. 26796 26797 Versioning can be disabled by `--jottacloud-no-versions` option. This is achieved by deleting the remote file prior to uploading 26798 a new version. If the upload the fails no version of the file will be available in the remote. 26799 26800 ### Quota information 26801 26802 To view your current quota you can use the `rclone about remote:` 26803 command which will display your usage limit (unless it is unlimited) 26804 and the current usage. 26805 26806 26807 ### Standard options 26808 26809 Here are the Standard options specific to jottacloud (Jottacloud). 26810 26811 #### --jottacloud-client-id 26812 26813 OAuth Client Id. 26814 26815 Leave blank normally. 26816 26817 Properties: 26818 26819 - Config: client_id 26820 - Env Var: RCLONE_JOTTACLOUD_CLIENT_ID 26821 - Type: string 26822 - Required: false 26823 26824 #### --jottacloud-client-secret 26825 26826 OAuth Client Secret. 26827 26828 Leave blank normally. 26829 26830 Properties: 26831 26832 - Config: client_secret 26833 - Env Var: RCLONE_JOTTACLOUD_CLIENT_SECRET 26834 - Type: string 26835 - Required: false 26836 26837 ### Advanced options 26838 26839 Here are the Advanced options specific to jottacloud (Jottacloud). 26840 26841 #### --jottacloud-token 26842 26843 OAuth Access Token as a JSON blob. 26844 26845 Properties: 26846 26847 - Config: token 26848 - Env Var: RCLONE_JOTTACLOUD_TOKEN 26849 - Type: string 26850 - Required: false 26851 26852 #### --jottacloud-auth-url 26853 26854 Auth server URL. 26855 26856 Leave blank to use the provider defaults. 26857 26858 Properties: 26859 26860 - Config: auth_url 26861 - Env Var: RCLONE_JOTTACLOUD_AUTH_URL 26862 - Type: string 26863 - Required: false 26864 26865 #### --jottacloud-token-url 26866 26867 Token server url. 26868 26869 Leave blank to use the provider defaults. 26870 26871 Properties: 26872 26873 - Config: token_url 26874 - Env Var: RCLONE_JOTTACLOUD_TOKEN_URL 26875 - Type: string 26876 - Required: false 26877 26878 #### --jottacloud-md5-memory-limit 26879 26880 Files bigger than this will be cached on disk to calculate the MD5 if required. 26881 26882 Properties: 26883 26884 - Config: md5_memory_limit 26885 - Env Var: RCLONE_JOTTACLOUD_MD5_MEMORY_LIMIT 26886 - Type: SizeSuffix 26887 - Default: 10Mi 26888 26889 #### --jottacloud-trashed-only 26890 26891 Only show files that are in the trash. 26892 26893 This will show trashed files in their original directory structure. 26894 26895 Properties: 26896 26897 - Config: trashed_only 26898 - Env Var: RCLONE_JOTTACLOUD_TRASHED_ONLY 26899 - Type: bool 26900 - Default: false 26901 26902 #### --jottacloud-hard-delete 26903 26904 Delete files permanently rather than putting them into the trash. 26905 26906 Properties: 26907 26908 - Config: hard_delete 26909 - Env Var: RCLONE_JOTTACLOUD_HARD_DELETE 26910 - Type: bool 26911 - Default: false 26912 26913 #### --jottacloud-upload-resume-limit 26914 26915 Files bigger than this can be resumed if the upload fail's. 26916 26917 Properties: 26918 26919 - Config: upload_resume_limit 26920 - Env Var: RCLONE_JOTTACLOUD_UPLOAD_RESUME_LIMIT 26921 - Type: SizeSuffix 26922 - Default: 10Mi 26923 26924 #### --jottacloud-no-versions 26925 26926 Avoid server side versioning by deleting files and recreating files instead of overwriting them. 26927 26928 Properties: 26929 26930 - Config: no_versions 26931 - Env Var: RCLONE_JOTTACLOUD_NO_VERSIONS 26932 - Type: bool 26933 - Default: false 26934 26935 #### --jottacloud-encoding 26936 26937 The encoding for the backend. 26938 26939 See the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. 26940 26941 Properties: 26942 26943 - Config: encoding 26944 - Env Var: RCLONE_JOTTACLOUD_ENCODING 26945 - Type: Encoding 26946 - Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot 26947 26948 #### --jottacloud-description 26949 26950 Description of the remote 26951 26952 Properties: 26953 26954 - Config: description 26955 - Env Var: RCLONE_JOTTACLOUD_DESCRIPTION 26956 - Type: string 26957 - Required: false 26958 26959 ### Metadata 26960 26961 Jottacloud has limited support for metadata, currently an extended set of timestamps. 26962 26963 Here are the possible system metadata items for the jottacloud backend. 26964 26965 | Name | Help | Type | Example | Read Only | 26966 |------|------|------|---------|-----------| 26967 | btime | Time of file birth (creation), read from rclone metadata | RFC 3339 | 2006-01-02T15:04:05.999999999Z07:00 | N | 26968 | content-type | MIME type, also known as media type | string | text/plain | **Y** | 26969 | mtime | Time of last modification, read from rclone metadata | RFC 3339 | 2006-01-02T15:04:05.999999999Z07:00 | N | 26970 | utime | Time of last upload, when current revision was created, generated by backend | RFC 3339 | 2006-01-02T15:04:05.999999999Z07:00 | **Y** | 26971 26972 See the [metadata](https://rclone.org/docs/#metadata) docs for more info. 26973 26974 26975 26976 ## Limitations 26977 26978 Note that Jottacloud is case insensitive so you can't have a file called 26979 "Hello.doc" and one called "hello.doc". 26980 26981 There are quite a few characters that can't be in Jottacloud file names. Rclone will map these names to and from an identical 26982 looking unicode equivalent. For example if a file has a ? in it will be mapped to ？ instead. 26983 26984 Jottacloud only supports filenames up to 255 characters in length. 26985 26986 ## Troubleshooting 26987 26988 Jottacloud exhibits some inconsistent behaviours regarding deleted files and folders which may cause Copy, Move and DirMove 26989 operations to previously deleted paths to fail. Emptying the trash should help in such cases. 26990 26991 # Koofr 26992 26993 Paths are specified as `remote:path` 26994 26995 Paths may be as deep as required, e.g. `remote:directory/subdirectory`. 26996 26997 ## Configuration 26998 26999 The initial setup for Koofr involves creating an application password for 27000 rclone. You can do that by opening the Koofr 27001 [web application](https://app.koofr.net/app/admin/preferences/password), 27002 giving the password a nice name like `rclone` and clicking on generate. 27003 27004 Here is an example of how to make a remote called `koofr`. First run: 27005 27006 rclone config 27007 27008 This will guide you through an interactive setup process: 27009 </code></pre> 27010 <p>No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n name> koofr Option Storage. Type of storage to configure. Choose a number from below, or type in your own value. [snip] 22 / Koofr, Digi Storage and other Koofr-compatible storage providers (koofr) [snip] Storage> koofr Option provider. Choose your storage provider. Choose a number from below, or type in your own value. Press Enter to leave empty. 1 / Koofr, https://app.koofr.net/ (koofr) 2 / Digi Storage, https://storage.rcs-rds.ro/ (digistorage) 3 / Any other Koofr API compatible storage service (other) provider> 1<br /> 27011 Option user. Your user name. Enter a value. user> USERNAME Option password. Your password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password). Choose an alternative below. y) Yes, type in my own password g) Generate random password y/g> y Enter the password: password: Confirm the password: password: Edit advanced config? y) Yes n) No (default) y/n> n Remote config -------------------- [koofr] type = koofr provider = koofr user = USERNAME password = *** ENCRYPTED *** -------------------- y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y</p> 27012 <pre><code> 27013 You can choose to edit advanced config in order to enter your own service URL 27014 if you use an on-premise or white label Koofr instance, or choose an alternative 27015 mount instead of your primary storage. 27016 27017 Once configured you can then use `rclone` like this, 27018 27019 List directories in top level of your Koofr 27020 27021 rclone lsd koofr: 27022 27023 List all the files in your Koofr 27024 27025 rclone ls koofr: 27026 27027 To copy a local directory to an Koofr directory called backup 27028 27029 rclone copy /home/source koofr:backup 27030 27031 ### Restricted filename characters 27032 27033 In addition to the [default restricted characters set](https://rclone.org/overview/#restricted-characters) 27034 the following characters are also replaced: 27035 27036 | Character | Value | Replacement | 27037 | --------- |:-----:|:-----------:| 27038 | \ | 0x5C | ＼ | 27039 27040 Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8), 27041 as they can't be used in XML strings. 27042 27043 27044 ### Standard options 27045 27046 Here are the Standard options specific to koofr (Koofr, Digi Storage and other Koofr-compatible storage providers). 27047 27048 #### --koofr-provider 27049 27050 Choose your storage provider. 27051 27052 Properties: 27053 27054 - Config: provider 27055 - Env Var: RCLONE_KOOFR_PROVIDER 27056 - Type: string 27057 - Required: false 27058 - Examples: 27059 - "koofr" 27060 - Koofr, https://app.koofr.net/ 27061 - "digistorage" 27062 - Digi Storage, https://storage.rcs-rds.ro/ 27063 - "other" 27064 - Any other Koofr API compatible storage service 27065 27066 #### --koofr-endpoint 27067 27068 The Koofr API endpoint to use. 27069 27070 Properties: 27071 27072 - Config: endpoint 27073 - Env Var: RCLONE_KOOFR_ENDPOINT 27074 - Provider: other 27075 - Type: string 27076 - Required: true 27077 27078 #### --koofr-user 27079 27080 Your user name. 27081 27082 Properties: 27083 27084 - Config: user 27085 - Env Var: RCLONE_KOOFR_USER 27086 - Type: string 27087 - Required: true 27088 27089 #### --koofr-password 27090 27091 Your password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password). 27092 27093 **NB** Input to this must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/). 27094 27095 Properties: 27096 27097 - Config: password 27098 - Env Var: RCLONE_KOOFR_PASSWORD 27099 - Provider: koofr 27100 - Type: string 27101 - Required: true 27102 27103 ### Advanced options 27104 27105 Here are the Advanced options specific to koofr (Koofr, Digi Storage and other Koofr-compatible storage providers). 27106 27107 #### --koofr-mountid 27108 27109 Mount ID of the mount to use. 27110 27111 If omitted, the primary mount is used. 27112 27113 Properties: 27114 27115 - Config: mountid 27116 - Env Var: RCLONE_KOOFR_MOUNTID 27117 - Type: string 27118 - Required: false 27119 27120 #### --koofr-setmtime 27121 27122 Does the backend support setting modification time. 27123 27124 Set this to false if you use a mount ID that points to a Dropbox or Amazon Drive backend. 27125 27126 Properties: 27127 27128 - Config: setmtime 27129 - Env Var: RCLONE_KOOFR_SETMTIME 27130 - Type: bool 27131 - Default: true 27132 27133 #### --koofr-encoding 27134 27135 The encoding for the backend. 27136 27137 See the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. 27138 27139 Properties: 27140 27141 - Config: encoding 27142 - Env Var: RCLONE_KOOFR_ENCODING 27143 - Type: Encoding 27144 - Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot 27145 27146 #### --koofr-description 27147 27148 Description of the remote 27149 27150 Properties: 27151 27152 - Config: description 27153 - Env Var: RCLONE_KOOFR_DESCRIPTION 27154 - Type: string 27155 - Required: false 27156 27157 27158 27159 ## Limitations 27160 27161 Note that Koofr is case insensitive so you can't have a file called 27162 "Hello.doc" and one called "hello.doc". 27163 27164 ## Providers 27165 27166 ### Koofr 27167 27168 This is the original [Koofr](https://koofr.eu) storage provider used as main example and described in the [configuration](#configuration) section above. 27169 27170 ### Digi Storage 27171 27172 [Digi Storage](https://www.digi.ro/servicii/online/digi-storage) is a cloud storage service run by [Digi.ro](https://www.digi.ro/) that 27173 provides a Koofr API. 27174 27175 Here is an example of how to make a remote called `ds`. First run: 27176 27177 rclone config 27178 27179 This will guide you through an interactive setup process: 27180 </code></pre> 27181 <p>No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n name> ds Option Storage. Type of storage to configure. Choose a number from below, or type in your own value. [snip] 22 / Koofr, Digi Storage and other Koofr-compatible storage providers (koofr) [snip] Storage> koofr Option provider. Choose your storage provider. Choose a number from below, or type in your own value. Press Enter to leave empty. 1 / Koofr, https://app.koofr.net/ (koofr) 2 / Digi Storage, https://storage.rcs-rds.ro/ (digistorage) 3 / Any other Koofr API compatible storage service (other) provider> 2 Option user. Your user name. Enter a value. user> USERNAME Option password. Your password for rclone (generate one at https://storage.rcs-rds.ro/app/admin/preferences/password). Choose an alternative below. y) Yes, type in my own password g) Generate random password y/g> y Enter the password: password: Confirm the password: password: Edit advanced config? y) Yes n) No (default) y/n> n -------------------- [ds] type = koofr provider = digistorage user = USERNAME password = *** ENCRYPTED *** -------------------- y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y</p> 27182 <pre><code> 27183 ### Other 27184 27185 You may also want to use another, public or private storage provider that runs a Koofr API compatible service, by simply providing the base URL to connect to. 27186 27187 Here is an example of how to make a remote called `other`. First run: 27188 27189 rclone config 27190 27191 This will guide you through an interactive setup process: 27192 </code></pre> 27193 <p>No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n name> other Option Storage. Type of storage to configure. Choose a number from below, or type in your own value. [snip] 22 / Koofr, Digi Storage and other Koofr-compatible storage providers (koofr) [snip] Storage> koofr Option provider. Choose your storage provider. Choose a number from below, or type in your own value. Press Enter to leave empty. 1 / Koofr, https://app.koofr.net/ (koofr) 2 / Digi Storage, https://storage.rcs-rds.ro/ (digistorage) 3 / Any other Koofr API compatible storage service (other) provider> 3 Option endpoint. The Koofr API endpoint to use. Enter a value. endpoint> https://koofr.other.org Option user. Your user name. Enter a value. user> USERNAME Option password. Your password for rclone (generate one at your service's settings page). Choose an alternative below. y) Yes, type in my own password g) Generate random password y/g> y Enter the password: password: Confirm the password: password: Edit advanced config? y) Yes n) No (default) y/n> n -------------------- [other] type = koofr provider = other endpoint = https://koofr.other.org user = USERNAME password = *** ENCRYPTED *** -------------------- y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y</p> 27194 <pre><code> 27195 # Linkbox 27196 27197 Linkbox is [a private cloud drive](https://linkbox.to/). 27198 27199 ## Configuration 27200 27201 Here is an example of making a remote for Linkbox. 27202 27203 First run: 27204 27205 rclone config 27206 27207 This will guide you through an interactive setup process: 27208 </code></pre> 27209 <p>No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n</p> 27210 <p>Enter name for new remote. name> remote</p> 27211 <p>Option Storage. Type of storage to configure. Choose a number from below, or type in your own value. XX / Linkbox (linkbox) Storage> XX</p> 27212 <p>Option token. Token from https://www.linkbox.to/admin/account Enter a value. token> testFromCLToken</p> 27213 <p>Configuration complete. Options: - type: linkbox - token: XXXXXXXXXXX Keep this "linkbox" remote? y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y</p> 27214 <pre><code> 27215 27216 ### Standard options 27217 27218 Here are the Standard options specific to linkbox (Linkbox). 27219 27220 #### --linkbox-token 27221 27222 Token from https://www.linkbox.to/admin/account 27223 27224 Properties: 27225 27226 - Config: token 27227 - Env Var: RCLONE_LINKBOX_TOKEN 27228 - Type: string 27229 - Required: true 27230 27231 ### Advanced options 27232 27233 Here are the Advanced options specific to linkbox (Linkbox). 27234 27235 #### --linkbox-description 27236 27237 Description of the remote 27238 27239 Properties: 27240 27241 - Config: description 27242 - Env Var: RCLONE_LINKBOX_DESCRIPTION 27243 - Type: string 27244 - Required: false 27245 27246 27247 27248 ## Limitations 27249 27250 Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8), 27251 as they can't be used in JSON strings. 27252 27253 # Mail.ru Cloud 27254 27255 [Mail.ru Cloud](https://cloud.mail.ru/) is a cloud storage provided by a Russian internet company [Mail.Ru Group](https://mail.ru). The official desktop client is [Disk-O:](https://disk-o.cloud/en), available on Windows and Mac OS. 27256 27257 ## Features highlights 27258 27259 - Paths may be as deep as required, e.g. `remote:directory/subdirectory` 27260 - Files have a `last modified time` property, directories don't 27261 - Deleted files are by default moved to the trash 27262 - Files and directories can be shared via public links 27263 - Partial uploads or streaming are not supported, file size must be known before upload 27264 - Maximum file size is limited to 2G for a free account, unlimited for paid accounts 27265 - Storage keeps hash for all files and performs transparent deduplication, 27266 the hash algorithm is a modified SHA1 27267 - If a particular file is already present in storage, one can quickly submit file hash 27268 instead of long file upload (this optimization is supported by rclone) 27269 27270 ## Configuration 27271 27272 Here is an example of making a mailru configuration. 27273 27274 First create a Mail.ru Cloud account and choose a tariff. 27275 27276 You will need to log in and create an app password for rclone. Rclone 27277 **will not work** with your normal username and password - it will 27278 give an error like `oauth2: server response missing access_token`. 27279 27280 - Click on your user icon in the top right 27281 - Go to Security / "Пароль и безопасность" 27282 - Click password for apps / "Пароли для внешних приложений" 27283 - Add the password - give it a name - eg "rclone" 27284 - Copy the password and use this password below - your normal login password won't work. 27285 27286 Now run 27287 27288 rclone config 27289 27290 This will guide you through an interactive setup process: 27291 </code></pre> 27292 <p>No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n name> remote Type of storage to configure. Type of storage to configure. Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value [snip] XX / Mail.ru Cloud "mailru" [snip] Storage> mailru User name (usually email) Enter a string value. Press Enter for the default (""). user> username@mail.ru Password</p> 27293 <p>This must be an app password - rclone will not work with your normal password. See the Configuration section in the docs for how to make an app password. y) Yes type in my own password g) Generate random password y/g> y Enter the password: password: Confirm the password: password: Skip full upload if there is another file with same data hash. This feature is called "speedup" or "put by hash". It is especially efficient in case of generally available files like popular books, video or audio clips [snip] Enter a boolean value (true or false). Press Enter for the default ("true"). Choose a number from below, or type in your own value 1 / Enable "true" 2 / Disable "false" speedup_enable> 1 Edit advanced config? (y/n) y) Yes n) No y/n> n Remote config -------------------- [remote] type = mailru user = username@mail.ru pass = *** ENCRYPTED *** speedup_enable = true -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y</p> 27294 <pre><code> 27295 Configuration of this backend does not require a local web browser. 27296 You can use the configured backend as shown below: 27297 27298 See top level directories 27299 27300 rclone lsd remote: 27301 27302 Make a new directory 27303 27304 rclone mkdir remote:directory 27305 27306 List the contents of a directory 27307 27308 rclone ls remote:directory 27309 27310 Sync `/home/local/directory` to the remote path, deleting any 27311 excess files in the path. 27312 27313 rclone sync --interactive /home/local/directory remote:directory 27314 27315 ### Modification times and hashes 27316 27317 Files support a modification time attribute with up to 1 second precision. 27318 Directories do not have a modification time, which is shown as "Jan 1 1970". 27319 27320 File hashes are supported, with a custom Mail.ru algorithm based on SHA1. 27321 If file size is less than or equal to the SHA1 block size (20 bytes), 27322 its hash is simply its data right-padded with zero bytes. 27323 Hashes of a larger file is computed as a SHA1 of the file data 27324 bytes concatenated with a decimal representation of the data length. 27325 27326 ### Emptying Trash 27327 27328 Removing a file or directory actually moves it to the trash, which is not 27329 visible to rclone but can be seen in a web browser. The trashed file 27330 still occupies part of total quota. If you wish to empty your trash 27331 and free some quota, you can use the `rclone cleanup remote:` command, 27332 which will permanently delete all your trashed files. 27333 This command does not take any path arguments. 27334 27335 ### Quota information 27336 27337 To view your current quota you can use the `rclone about remote:` 27338 command which will display your usage limit (quota) and the current usage. 27339 27340 ### Restricted filename characters 27341 27342 In addition to the [default restricted characters set](https://rclone.org/overview/#restricted-characters) 27343 the following characters are also replaced: 27344 27345 | Character | Value | Replacement | 27346 | --------- |:-----:|:-----------:| 27347 | " | 0x22 | ＂ | 27348 | * | 0x2A | ＊ | 27349 | : | 0x3A | ： | 27350 | < | 0x3C | ＜ | 27351 | > | 0x3E | ＞ | 27352 | ? | 0x3F | ？ | 27353 | \ | 0x5C | ＼ | 27354 | \| | 0x7C | ｜ | 27355 27356 Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8), 27357 as they can't be used in JSON strings. 27358 27359 27360 ### Standard options 27361 27362 Here are the Standard options specific to mailru (Mail.ru Cloud). 27363 27364 #### --mailru-client-id 27365 27366 OAuth Client Id. 27367 27368 Leave blank normally. 27369 27370 Properties: 27371 27372 - Config: client_id 27373 - Env Var: RCLONE_MAILRU_CLIENT_ID 27374 - Type: string 27375 - Required: false 27376 27377 #### --mailru-client-secret 27378 27379 OAuth Client Secret. 27380 27381 Leave blank normally. 27382 27383 Properties: 27384 27385 - Config: client_secret 27386 - Env Var: RCLONE_MAILRU_CLIENT_SECRET 27387 - Type: string 27388 - Required: false 27389 27390 #### --mailru-user 27391 27392 User name (usually email). 27393 27394 Properties: 27395 27396 - Config: user 27397 - Env Var: RCLONE_MAILRU_USER 27398 - Type: string 27399 - Required: true 27400 27401 #### --mailru-pass 27402 27403 Password. 27404 27405 This must be an app password - rclone will not work with your normal 27406 password. See the Configuration section in the docs for how to make an 27407 app password. 27408 27409 27410 **NB** Input to this must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/). 27411 27412 Properties: 27413 27414 - Config: pass 27415 - Env Var: RCLONE_MAILRU_PASS 27416 - Type: string 27417 - Required: true 27418 27419 #### --mailru-speedup-enable 27420 27421 Skip full upload if there is another file with same data hash. 27422 27423 This feature is called "speedup" or "put by hash". It is especially efficient 27424 in case of generally available files like popular books, video or audio clips, 27425 because files are searched by hash in all accounts of all mailru users. 27426 It is meaningless and ineffective if source file is unique or encrypted. 27427 Please note that rclone may need local memory and disk space to calculate 27428 content hash in advance and decide whether full upload is required. 27429 Also, if rclone does not know file size in advance (e.g. in case of 27430 streaming or partial uploads), it will not even try this optimization. 27431 27432 Properties: 27433 27434 - Config: speedup_enable 27435 - Env Var: RCLONE_MAILRU_SPEEDUP_ENABLE 27436 - Type: bool 27437 - Default: true 27438 - Examples: 27439 - "true" 27440 - Enable 27441 - "false" 27442 - Disable 27443 27444 ### Advanced options 27445 27446 Here are the Advanced options specific to mailru (Mail.ru Cloud). 27447 27448 #### --mailru-token 27449 27450 OAuth Access Token as a JSON blob. 27451 27452 Properties: 27453 27454 - Config: token 27455 - Env Var: RCLONE_MAILRU_TOKEN 27456 - Type: string 27457 - Required: false 27458 27459 #### --mailru-auth-url 27460 27461 Auth server URL. 27462 27463 Leave blank to use the provider defaults. 27464 27465 Properties: 27466 27467 - Config: auth_url 27468 - Env Var: RCLONE_MAILRU_AUTH_URL 27469 - Type: string 27470 - Required: false 27471 27472 #### --mailru-token-url 27473 27474 Token server url. 27475 27476 Leave blank to use the provider defaults. 27477 27478 Properties: 27479 27480 - Config: token_url 27481 - Env Var: RCLONE_MAILRU_TOKEN_URL 27482 - Type: string 27483 - Required: false 27484 27485 #### --mailru-speedup-file-patterns 27486 27487 Comma separated list of file name patterns eligible for speedup (put by hash). 27488 27489 Patterns are case insensitive and can contain '*' or '?' meta characters. 27490 27491 Properties: 27492 27493 - Config: speedup_file_patterns 27494 - Env Var: RCLONE_MAILRU_SPEEDUP_FILE_PATTERNS 27495 - Type: string 27496 - Default: "*.mkv,*.avi,*.mp4,*.mp3,*.zip,*.gz,*.rar,*.pdf" 27497 - Examples: 27498 - "" 27499 - Empty list completely disables speedup (put by hash). 27500 - "*" 27501 - All files will be attempted for speedup. 27502 - "*.mkv,*.avi,*.mp4,*.mp3" 27503 - Only common audio/video files will be tried for put by hash. 27504 - "*.zip,*.gz,*.rar,*.pdf" 27505 - Only common archives or PDF books will be tried for speedup. 27506 27507 #### --mailru-speedup-max-disk 27508 27509 This option allows you to disable speedup (put by hash) for large files. 27510 27511 Reason is that preliminary hashing can exhaust your RAM or disk space. 27512 27513 Properties: 27514 27515 - Config: speedup_max_disk 27516 - Env Var: RCLONE_MAILRU_SPEEDUP_MAX_DISK 27517 - Type: SizeSuffix 27518 - Default: 3Gi 27519 - Examples: 27520 - "0" 27521 - Completely disable speedup (put by hash). 27522 - "1G" 27523 - Files larger than 1Gb will be uploaded directly. 27524 - "3G" 27525 - Choose this option if you have less than 3Gb free on local disk. 27526 27527 #### --mailru-speedup-max-memory 27528 27529 Files larger than the size given below will always be hashed on disk. 27530 27531 Properties: 27532 27533 - Config: speedup_max_memory 27534 - Env Var: RCLONE_MAILRU_SPEEDUP_MAX_MEMORY 27535 - Type: SizeSuffix 27536 - Default: 32Mi 27537 - Examples: 27538 - "0" 27539 - Preliminary hashing will always be done in a temporary disk location. 27540 - "32M" 27541 - Do not dedicate more than 32Mb RAM for preliminary hashing. 27542 - "256M" 27543 - You have at most 256Mb RAM free for hash calculations. 27544 27545 #### --mailru-check-hash 27546 27547 What should copy do if file checksum is mismatched or invalid. 27548 27549 Properties: 27550 27551 - Config: check_hash 27552 - Env Var: RCLONE_MAILRU_CHECK_HASH 27553 - Type: bool 27554 - Default: true 27555 - Examples: 27556 - "true" 27557 - Fail with error. 27558 - "false" 27559 - Ignore and continue. 27560 27561 #### --mailru-user-agent 27562 27563 HTTP user agent used internally by client. 27564 27565 Defaults to "rclone/VERSION" or "--user-agent" provided on command line. 27566 27567 Properties: 27568 27569 - Config: user_agent 27570 - Env Var: RCLONE_MAILRU_USER_AGENT 27571 - Type: string 27572 - Required: false 27573 27574 #### --mailru-quirks 27575 27576 Comma separated list of internal maintenance flags. 27577 27578 This option must not be used by an ordinary user. It is intended only to 27579 facilitate remote troubleshooting of backend issues. Strict meaning of 27580 flags is not documented and not guaranteed to persist between releases. 27581 Quirks will be removed when the backend grows stable. 27582 Supported quirks: atomicmkdir binlist unknowndirs 27583 27584 Properties: 27585 27586 - Config: quirks 27587 - Env Var: RCLONE_MAILRU_QUIRKS 27588 - Type: string 27589 - Required: false 27590 27591 #### --mailru-encoding 27592 27593 The encoding for the backend. 27594 27595 See the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. 27596 27597 Properties: 27598 27599 - Config: encoding 27600 - Env Var: RCLONE_MAILRU_ENCODING 27601 - Type: Encoding 27602 - Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot 27603 27604 #### --mailru-description 27605 27606 Description of the remote 27607 27608 Properties: 27609 27610 - Config: description 27611 - Env Var: RCLONE_MAILRU_DESCRIPTION 27612 - Type: string 27613 - Required: false 27614 27615 27616 27617 ## Limitations 27618 27619 File size limits depend on your account. A single file size is limited by 2G 27620 for a free account and unlimited for paid tariffs. Please refer to the Mail.ru 27621 site for the total uploaded size limits. 27622 27623 Note that Mailru is case insensitive so you can't have a file called 27624 "Hello.doc" and one called "hello.doc". 27625 27626 # Mega 27627 27628 [Mega](https://mega.nz/) is a cloud storage and file hosting service 27629 known for its security feature where all files are encrypted locally 27630 before they are uploaded. This prevents anyone (including employees of 27631 Mega) from accessing the files without knowledge of the key used for 27632 encryption. 27633 27634 This is an rclone backend for Mega which supports the file transfer 27635 features of Mega using the same client side encryption. 27636 27637 Paths are specified as `remote:path` 27638 27639 Paths may be as deep as required, e.g. `remote:directory/subdirectory`. 27640 27641 ## Configuration 27642 27643 Here is an example of how to make a remote called `remote`. First run: 27644 27645 rclone config 27646 27647 This will guide you through an interactive setup process: 27648 </code></pre> 27649 <p>No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n name> remote Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Mega "mega" [snip] Storage> mega User name user> you@example.com Password. y) Yes type in my own password g) Generate random password n) No leave this optional password blank y/g/n> y Enter the password: password: Confirm the password: password: Remote config -------------------- [remote] type = mega user = you@example.com pass = *** ENCRYPTED *** -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y</p> 27650 <pre><code> 27651 **NOTE:** The encryption keys need to have been already generated after a regular login 27652 via the browser, otherwise attempting to use the credentials in `rclone` will fail. 27653 27654 Once configured you can then use `rclone` like this, 27655 27656 List directories in top level of your Mega 27657 27658 rclone lsd remote: 27659 27660 List all the files in your Mega 27661 27662 rclone ls remote: 27663 27664 To copy a local directory to an Mega directory called backup 27665 27666 rclone copy /home/source remote:backup 27667 27668 ### Modification times and hashes 27669 27670 Mega does not support modification times or hashes yet. 27671 27672 ### Restricted filename characters 27673 27674 | Character | Value | Replacement | 27675 | --------- |:-----:|:-----------:| 27676 | NUL | 0x00 | ␀ | 27677 | / | 0x2F | ／ | 27678 27679 Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8), 27680 as they can't be used in JSON strings. 27681 27682 ### Duplicated files 27683 27684 Mega can have two files with exactly the same name and path (unlike a 27685 normal file system). 27686 27687 Duplicated files cause problems with the syncing and you will see 27688 messages in the log about duplicates. 27689 27690 Use `rclone dedupe` to fix duplicated files. 27691 27692 ### Failure to log-in 27693 27694 #### Object not found 27695 27696 If you are connecting to your Mega remote for the first time, 27697 to test access and synchronization, you may receive an error such as 27698 </code></pre> 27699 <p>Failed to create file system for "my-mega-remote:": couldn't login: Object (typically, node or user) not found</p> 27700 <pre><code> 27701 The diagnostic steps often recommended in the [rclone forum](https://forum.rclone.org/search?q=mega) 27702 start with the **MEGAcmd** utility. Note that this refers to 27703 the official C++ command from https://github.com/meganz/MEGAcmd 27704 and not the go language built command from t3rm1n4l/megacmd 27705 that is no longer maintained. 27706 27707 Follow the instructions for installing MEGAcmd and try accessing 27708 your remote as they recommend. You can establish whether or not 27709 you can log in using MEGAcmd, and obtain diagnostic information 27710 to help you, and search or work with others in the forum. 27711 </code></pre> 27712 <p>MEGA CMD> login me@example.com Password: Fetching nodes ... Loading transfers from local cache Login complete as me@example.com me@example.com:/$</p> 27713 <pre><code> 27714 Note that some have found issues with passwords containing special 27715 characters. If you can not log on with rclone, but MEGAcmd logs on 27716 just fine, then consider changing your password temporarily to 27717 pure alphanumeric characters, in case that helps. 27718 27719 27720 #### Repeated commands blocks access 27721 27722 Mega remotes seem to get blocked (reject logins) under "heavy use". 27723 We haven't worked out the exact blocking rules but it seems to be 27724 related to fast paced, successive rclone commands. 27725 27726 For example, executing this command 90 times in a row `rclone link 27727 remote:file` will cause the remote to become "blocked". This is not an 27728 abnormal situation, for example if you wish to get the public links of 27729 a directory with hundred of files... After more or less a week, the 27730 remote will remote accept rclone logins normally again. 27731 27732 You can mitigate this issue by mounting the remote it with `rclone 27733 mount`. This will log-in when mounting and a log-out when unmounting 27734 only. You can also run `rclone rcd` and then use `rclone rc` to run 27735 the commands over the API to avoid logging in each time. 27736 27737 Rclone does not currently close mega sessions (you can see them in the 27738 web interface), however closing the sessions does not solve the issue. 27739 27740 If you space rclone commands by 3 seconds it will avoid blocking the 27741 remote. We haven't identified the exact blocking rules, so perhaps one 27742 could execute the command 80 times without waiting and avoid blocking 27743 by waiting 3 seconds, then continuing... 27744 27745 Note that this has been observed by trial and error and might not be 27746 set in stone. 27747 27748 Other tools seem not to produce this blocking effect, as they use a 27749 different working approach (state-based, using sessionIDs instead of 27750 log-in) which isn't compatible with the current stateless rclone 27751 approach. 27752 27753 Note that once blocked, the use of other tools (such as megacmd) is 27754 not a sure workaround: following megacmd login times have been 27755 observed in succession for blocked remote: 7 minutes, 20 min, 30min, 30 27756 min, 30min. Web access looks unaffected though. 27757 27758 Investigation is continuing in relation to workarounds based on 27759 timeouts, pacers, retrials and tpslimits - if you discover something 27760 relevant, please post on the forum. 27761 27762 So, if rclone was working nicely and suddenly you are unable to log-in 27763 and you are sure the user and the password are correct, likely you 27764 have got the remote blocked for a while. 27765 27766 27767 ### Standard options 27768 27769 Here are the Standard options specific to mega (Mega). 27770 27771 #### --mega-user 27772 27773 User name. 27774 27775 Properties: 27776 27777 - Config: user 27778 - Env Var: RCLONE_MEGA_USER 27779 - Type: string 27780 - Required: true 27781 27782 #### --mega-pass 27783 27784 Password. 27785 27786 **NB** Input to this must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/). 27787 27788 Properties: 27789 27790 - Config: pass 27791 - Env Var: RCLONE_MEGA_PASS 27792 - Type: string 27793 - Required: true 27794 27795 ### Advanced options 27796 27797 Here are the Advanced options specific to mega (Mega). 27798 27799 #### --mega-debug 27800 27801 Output more debug from Mega. 27802 27803 If this flag is set (along with -vv) it will print further debugging 27804 information from the mega backend. 27805 27806 Properties: 27807 27808 - Config: debug 27809 - Env Var: RCLONE_MEGA_DEBUG 27810 - Type: bool 27811 - Default: false 27812 27813 #### --mega-hard-delete 27814 27815 Delete files permanently rather than putting them into the trash. 27816 27817 Normally the mega backend will put all deletions into the trash rather 27818 than permanently deleting them. If you specify this then rclone will 27819 permanently delete objects instead. 27820 27821 Properties: 27822 27823 - Config: hard_delete 27824 - Env Var: RCLONE_MEGA_HARD_DELETE 27825 - Type: bool 27826 - Default: false 27827 27828 #### --mega-use-https 27829 27830 Use HTTPS for transfers. 27831 27832 MEGA uses plain text HTTP connections by default. 27833 Some ISPs throttle HTTP connections, this causes transfers to become very slow. 27834 Enabling this will force MEGA to use HTTPS for all transfers. 27835 HTTPS is normally not necessary since all data is already encrypted anyway. 27836 Enabling it will increase CPU usage and add network overhead. 27837 27838 Properties: 27839 27840 - Config: use_https 27841 - Env Var: RCLONE_MEGA_USE_HTTPS 27842 - Type: bool 27843 - Default: false 27844 27845 #### --mega-encoding 27846 27847 The encoding for the backend. 27848 27849 See the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. 27850 27851 Properties: 27852 27853 - Config: encoding 27854 - Env Var: RCLONE_MEGA_ENCODING 27855 - Type: Encoding 27856 - Default: Slash,InvalidUtf8,Dot 27857 27858 #### --mega-description 27859 27860 Description of the remote 27861 27862 Properties: 27863 27864 - Config: description 27865 - Env Var: RCLONE_MEGA_DESCRIPTION 27866 - Type: string 27867 - Required: false 27868 27869 27870 27871 ### Process `killed` 27872 27873 On accounts with large files or something else, memory usage can significantly increase when executing list/sync instructions. When running on cloud providers (like AWS with EC2), check if the instance type has sufficient memory/CPU to execute the commands. Use the resource monitoring tools to inspect after sending the commands. Look [at this issue](https://forum.rclone.org/t/rclone-with-mega-appears-to-work-only-in-some-accounts/40233/4). 27874 27875 ## Limitations 27876 27877 This backend uses the [go-mega go library](https://github.com/t3rm1n4l/go-mega) which is an opensource 27878 go library implementing the Mega API. There doesn't appear to be any 27879 documentation for the mega protocol beyond the [mega C++ SDK](https://github.com/meganz/sdk) source code 27880 so there are likely quite a few errors still remaining in this library. 27881 27882 Mega allows duplicate files which may confuse rclone. 27883 27884 # Memory 27885 27886 The memory backend is an in RAM backend. It does not persist its 27887 data - use the local backend for that. 27888 27889 The memory backend behaves like a bucket-based remote (e.g. like 27890 s3). Because it has no parameters you can just use it with the 27891 `:memory:` remote name. 27892 27893 ## Configuration 27894 27895 You can configure it as a remote like this with `rclone config` too if 27896 you want to: 27897 </code></pre> 27898 <p>No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n name> remote Type of storage to configure. Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value [snip] XX / Memory "memory" [snip] Storage> memory ** See help for memory backend at: https://rclone.org/memory/ **</p> 27899 <p>Remote config</p> 27900 <table> 27901 <tbody> 27902 <tr class="odd"> 27903 <td style="text-align: left;">[remote]</td> 27904 </tr> 27905 <tr class="even"> 27906 <td style="text-align: left;">type = memory</td> 27907 </tr> 27908 </tbody> 27909 </table> 27910 <ol start="25" type="a"> 27911 <li>Yes this is OK (default)</li> 27912 <li>Edit this remote</li> 27913 <li>Delete this remote y/e/d> y</li> 27914 </ol> 27915 <pre><code> 27916 Because the memory backend isn't persistent it is most useful for 27917 testing or with an rclone server or rclone mount, e.g. 27918 27919 rclone mount :memory: /mnt/tmp 27920 rclone serve webdav :memory: 27921 rclone serve sftp :memory: 27922 27923 ### Modification times and hashes 27924 27925 The memory backend supports MD5 hashes and modification times accurate to 1 nS. 27926 27927 ### Restricted filename characters 27928 27929 The memory backend replaces the [default restricted characters 27930 set](https://rclone.org/overview/#restricted-characters). 27931 27932 27933 ### Advanced options 27934 27935 Here are the Advanced options specific to memory (In memory object storage system.). 27936 27937 #### --memory-description 27938 27939 Description of the remote 27940 27941 Properties: 27942 27943 - Config: description 27944 - Env Var: RCLONE_MEMORY_DESCRIPTION 27945 - Type: string 27946 - Required: false 27947 27948 27949 27950 # Akamai NetStorage 27951 27952 Paths are specified as `remote:` 27953 You may put subdirectories in too, e.g. `remote:/path/to/dir`. 27954 If you have a CP code you can use that as the folder after the domain such as \<domain>\/\<cpcode>\/\<internal directories within cpcode>. 27955 27956 For example, this is commonly configured with or without a CP code: 27957 * **With a CP code**. `[your-domain-prefix]-nsu.akamaihd.net/123456/subdirectory/` 27958 * **Without a CP code**. `[your-domain-prefix]-nsu.akamaihd.net` 27959 27960 27961 See all buckets 27962 rclone lsd remote: 27963 The initial setup for Netstorage involves getting an account and secret. Use `rclone config` to walk you through the setup process. 27964 27965 ## Configuration 27966 27967 Here's an example of how to make a remote called `ns1`. 27968 27969 1. To begin the interactive configuration process, enter this command: 27970 </code></pre> 27971 <p>rclone config</p> 27972 <pre><code> 27973 2. Type `n` to create a new remote. 27974 </code></pre> 27975 <ol start="14" type="a"> 27976 <li>New remote</li> 27977 <li>Delete remote</li> 27978 <li>Quit config e/n/d/q> n</li> 27979 </ol> 27980 <pre><code> 27981 3. For this example, enter `ns1` when you reach the name> prompt. 27982 </code></pre> 27983 <p>name> ns1</p> 27984 <pre><code> 27985 4. Enter `netstorage` as the type of storage to configure. 27986 </code></pre> 27987 <p>Type of storage to configure. Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value XX / NetStorage "netstorage" Storage> netstorage</p> 27988 <pre><code> 27989 5. Select between the HTTP or HTTPS protocol. Most users should choose HTTPS, which is the default. HTTP is provided primarily for debugging purposes. 27990 27991 </code></pre> 27992 <p>Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value 1 / HTTP protocol "http" 2 / HTTPS protocol "https" protocol> 1</p> 27993 <pre><code> 27994 6. Specify your NetStorage host, CP code, and any necessary content paths using this format: `<domain>/<cpcode>/<content>/` 27995 </code></pre> 27996 <p>Enter a string value. Press Enter for the default (""). host> baseball-nsu.akamaihd.net/123456/content/</p> 27997 <pre><code> 27998 7. Set the netstorage account name</code></pre> 27999 <p>Enter a string value. Press Enter for the default (""). account> username</p> 28000 <pre><code> 28001 8. Set the Netstorage account secret/G2O key which will be used for authentication purposes. Select the `y` option to set your own password then enter your secret. 28002 Note: The secret is stored in the `rclone.conf` file with hex-encoded encryption. 28003 </code></pre> 28004 <ol start="25" type="a"> 28005 <li>Yes type in my own password</li> 28006 <li>Generate random password y/g> y Enter the password: password: Confirm the password: password:</li> 28007 </ol> 28008 <pre><code> 28009 9. View the summary and confirm your remote configuration. 28010 </code></pre> 28011 <p>[ns1] type = netstorage protocol = http host = baseball-nsu.akamaihd.net/123456/content/ account = username secret = *** ENCRYPTED *** -------------------- y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y</p> 28012 <pre><code> 28013 This remote is called `ns1` and can now be used. 28014 28015 ## Example operations 28016 28017 Get started with rclone and NetStorage with these examples. For additional rclone commands, visit https://rclone.org/commands/. 28018 28019 ### See contents of a directory in your project 28020 28021 rclone lsd ns1:/974012/testing/ 28022 28023 ### Sync the contents local with remote 28024 28025 rclone sync . ns1:/974012/testing/ 28026 28027 ### Upload local content to remote 28028 rclone copy notes.txt ns1:/974012/testing/ 28029 28030 ### Delete content on remote 28031 rclone delete ns1:/974012/testing/notes.txt 28032 28033 ### Move or copy content between CP codes. 28034 28035 Your credentials must have access to two CP codes on the same remote. You can't perform operations between different remotes. 28036 28037 rclone move ns1:/974012/testing/notes.txt ns1:/974450/testing2/ 28038 28039 ## Features 28040 28041 ### Symlink Support 28042 28043 The Netstorage backend changes the rclone `--links, -l` behavior. When uploading, instead of creating the .rclonelink file, use the "symlink" API in order to create the corresponding symlink on the remote. The .rclonelink file will not be created, the upload will be intercepted and only the symlink file that matches the source file name with no suffix will be created on the remote. 28044 28045 This will effectively allow commands like copy/copyto, move/moveto and sync to upload from local to remote and download from remote to local directories with symlinks. Due to internal rclone limitations, it is not possible to upload an individual symlink file to any remote backend. You can always use the "backend symlink" command to create a symlink on the NetStorage server, refer to "symlink" section below. 28046 28047 Individual symlink files on the remote can be used with the commands like "cat" to print the destination name, or "delete" to delete symlink, or copy, copy/to and move/moveto to download from the remote to local. Note: individual symlink files on the remote should be specified including the suffix .rclonelink. 28048 28049 **Note**: No file with the suffix .rclonelink should ever exist on the server since it is not possible to actually upload/create a file with .rclonelink suffix with rclone, it can only exist if it is manually created through a non-rclone method on the remote. 28050 28051 ### Implicit vs. Explicit Directories 28052 28053 With NetStorage, directories can exist in one of two forms: 28054 28055 1. **Explicit Directory**. This is an actual, physical directory that you have created in a storage group. 28056 2. **Implicit Directory**. This refers to a directory within a path that has not been physically created. For example, during upload of a file, nonexistent subdirectories can be specified in the target path. NetStorage creates these as "implicit." While the directories aren't physically created, they exist implicitly and the noted path is connected with the uploaded file. 28057 28058 Rclone will intercept all file uploads and mkdir commands for the NetStorage remote and will explicitly issue the mkdir command for each directory in the uploading path. This will help with the interoperability with the other Akamai services such as SFTP and the Content Management Shell (CMShell). Rclone will not guarantee correctness of operations with implicit directories which might have been created as a result of using an upload API directly. 28059 28060 ### `--fast-list` / ListR support 28061 28062 NetStorage remote supports the ListR feature by using the "list" NetStorage API action to return a lexicographical list of all objects within the specified CP code, recursing into subdirectories as they're encountered. 28063 28064 * **Rclone will use the ListR method for some commands by default**. Commands such as `lsf -R` will use ListR by default. To disable this, include the `--disable listR` option to use the non-recursive method of listing objects. 28065 28066 * **Rclone will not use the ListR method for some commands**. Commands such as `sync` don't use ListR by default. To force using the ListR method, include the `--fast-list` option. 28067 28068 There are pros and cons of using the ListR method, refer to [rclone documentation](https://rclone.org/docs/#fast-list). In general, the sync command over an existing deep tree on the remote will run faster with the "--fast-list" flag but with extra memory usage as a side effect. It might also result in higher CPU utilization but the whole task can be completed faster. 28069 28070 **Note**: There is a known limitation that "lsf -R" will display number of files in the directory and directory size as -1 when ListR method is used. The workaround is to pass "--disable listR" flag if these numbers are important in the output. 28071 28072 ### Purge 28073 28074 NetStorage remote supports the purge feature by using the "quick-delete" NetStorage API action. The quick-delete action is disabled by default for security reasons and can be enabled for the account through the Akamai portal. Rclone will first try to use quick-delete action for the purge command and if this functionality is disabled then will fall back to a standard delete method. 28075 28076 **Note**: Read the [NetStorage Usage API](https://learn.akamai.com/en-us/webhelp/netstorage/netstorage-http-api-developer-guide/GUID-15836617-9F50-405A-833C-EA2556756A30.html) for considerations when using "quick-delete". In general, using quick-delete method will not delete the tree immediately and objects targeted for quick-delete may still be accessible. 28077 28078 28079 ### Standard options 28080 28081 Here are the Standard options specific to netstorage (Akamai NetStorage). 28082 28083 #### --netstorage-host 28084 28085 Domain+path of NetStorage host to connect to. 28086 28087 Format should be `<domain>/<internal folders>` 28088 28089 Properties: 28090 28091 - Config: host 28092 - Env Var: RCLONE_NETSTORAGE_HOST 28093 - Type: string 28094 - Required: true 28095 28096 #### --netstorage-account 28097 28098 Set the NetStorage account name 28099 28100 Properties: 28101 28102 - Config: account 28103 - Env Var: RCLONE_NETSTORAGE_ACCOUNT 28104 - Type: string 28105 - Required: true 28106 28107 #### --netstorage-secret 28108 28109 Set the NetStorage account secret/G2O key for authentication. 28110 28111 Please choose the 'y' option to set your own password then enter your secret. 28112 28113 **NB** Input to this must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/). 28114 28115 Properties: 28116 28117 - Config: secret 28118 - Env Var: RCLONE_NETSTORAGE_SECRET 28119 - Type: string 28120 - Required: true 28121 28122 ### Advanced options 28123 28124 Here are the Advanced options specific to netstorage (Akamai NetStorage). 28125 28126 #### --netstorage-protocol 28127 28128 Select between HTTP or HTTPS protocol. 28129 28130 Most users should choose HTTPS, which is the default. 28131 HTTP is provided primarily for debugging purposes. 28132 28133 Properties: 28134 28135 - Config: protocol 28136 - Env Var: RCLONE_NETSTORAGE_PROTOCOL 28137 - Type: string 28138 - Default: "https" 28139 - Examples: 28140 - "http" 28141 - HTTP protocol 28142 - "https" 28143 - HTTPS protocol 28144 28145 #### --netstorage-description 28146 28147 Description of the remote 28148 28149 Properties: 28150 28151 - Config: description 28152 - Env Var: RCLONE_NETSTORAGE_DESCRIPTION 28153 - Type: string 28154 - Required: false 28155 28156 ## Backend commands 28157 28158 Here are the commands specific to the netstorage backend. 28159 28160 Run them with 28161 28162 rclone backend COMMAND remote: 28163 28164 The help below will explain what arguments each command takes. 28165 28166 See the [backend](https://rclone.org/commands/rclone_backend/) command for more 28167 info on how to pass options and arguments. 28168 28169 These can be run on a running backend using the rc command 28170 [backend/command](https://rclone.org/rc/#backend-command). 28171 28172 ### du 28173 28174 Return disk usage information for a specified directory 28175 28176 rclone backend du remote: [options] [<arguments>+] 28177 28178 The usage information returned, includes the targeted directory as well as all 28179 files stored in any sub-directories that may exist. 28180 28181 ### symlink 28182 28183 You can create a symbolic link in ObjectStore with the symlink action. 28184 28185 rclone backend symlink remote: [options] [<arguments>+] 28186 28187 The desired path location (including applicable sub-directories) ending in 28188 the object that will be the target of the symlink (for example, /links/mylink). 28189 Include the file extension for the object, if applicable. 28190 `rclone backend symlink <src> <path>` 28191 28192 28193 28194 # Microsoft Azure Blob Storage 28195 28196 Paths are specified as `remote:container` (or `remote:` for the `lsd` 28197 command.) You may put subdirectories in too, e.g. 28198 `remote:container/path/to/dir`. 28199 28200 ## Configuration 28201 28202 Here is an example of making a Microsoft Azure Blob Storage 28203 configuration. For a remote called `remote`. First run: 28204 28205 rclone config 28206 28207 This will guide you through an interactive setup process: 28208 </code></pre> 28209 <p>No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n name> remote Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Microsoft Azure Blob Storage "azureblob" [snip] Storage> azureblob Storage Account Name account> account_name Storage Account Key key> base64encodedkey== Endpoint for the service - leave blank normally. endpoint> Remote config -------------------- [remote] account = account_name key = base64encodedkey== endpoint = -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y</p> 28210 <pre><code> 28211 See all containers 28212 28213 rclone lsd remote: 28214 28215 Make a new container 28216 28217 rclone mkdir remote:container 28218 28219 List the contents of a container 28220 28221 rclone ls remote:container 28222 28223 Sync `/home/local/directory` to the remote container, deleting any excess 28224 files in the container. 28225 28226 rclone sync --interactive /home/local/directory remote:container 28227 28228 ### --fast-list 28229 28230 This remote supports `--fast-list` which allows you to use fewer 28231 transactions in exchange for more memory. See the [rclone 28232 docs](https://rclone.org/docs/#fast-list) for more details. 28233 28234 ### Modification times and hashes 28235 28236 The modification time is stored as metadata on the object with the 28237 `mtime` key. It is stored using RFC3339 Format time with nanosecond 28238 precision. The metadata is supplied during directory listings so 28239 there is no performance overhead to using it. 28240 28241 If you wish to use the Azure standard `LastModified` time stored on 28242 the object as the modified time, then use the `--use-server-modtime` 28243 flag. Note that rclone can't set `LastModified`, so using the 28244 `--update` flag when syncing is recommended if using 28245 `--use-server-modtime`. 28246 28247 MD5 hashes are stored with blobs. However blobs that were uploaded in 28248 chunks only have an MD5 if the source remote was capable of MD5 28249 hashes, e.g. the local disk. 28250 28251 ### Performance 28252 28253 When uploading large files, increasing the value of 28254 `--azureblob-upload-concurrency` will increase performance at the cost 28255 of using more memory. The default of 16 is set quite conservatively to 28256 use less memory. It maybe be necessary raise it to 64 or higher to 28257 fully utilize a 1 GBit/s link with a single file transfer. 28258 28259 ### Restricted filename characters 28260 28261 In addition to the [default restricted characters set](https://rclone.org/overview/#restricted-characters) 28262 the following characters are also replaced: 28263 28264 | Character | Value | Replacement | 28265 | --------- |:-----:|:-----------:| 28266 | / | 0x2F | ／ | 28267 | \ | 0x5C | ＼ | 28268 28269 File names can also not end with the following characters. 28270 These only get replaced if they are the last character in the name: 28271 28272 | Character | Value | Replacement | 28273 | --------- |:-----:|:-----------:| 28274 | . | 0x2E | ． | 28275 28276 Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8), 28277 as they can't be used in JSON strings. 28278 28279 ### Authentication {#authentication} 28280 28281 There are a number of ways of supplying credentials for Azure Blob 28282 Storage. Rclone tries them in the order of the sections below. 28283 28284 #### Env Auth 28285 28286 If the `env_auth` config parameter is `true` then rclone will pull 28287 credentials from the environment or runtime. 28288 28289 It tries these authentication methods in this order: 28290 28291 1. Environment Variables 28292 2. Managed Service Identity Credentials 28293 3. Azure CLI credentials (as used by the az tool) 28294 28295 These are described in the following sections 28296 28297 ##### Env Auth: 1. Environment Variables 28298 28299 If `env_auth` is set and environment variables are present rclone 28300 authenticates a service principal with a secret or certificate, or a 28301 user with a password, depending on which environment variable are set. 28302 It reads configuration from these variables, in the following order: 28303 28304 1. Service principal with client secret 28305 - `AZURE_TENANT_ID`: ID of the service principal's tenant. Also called its "directory" ID. 28306 - `AZURE_CLIENT_ID`: the service principal's client ID 28307 - `AZURE_CLIENT_SECRET`: one of the service principal's client secrets 28308 2. Service principal with certificate 28309 - `AZURE_TENANT_ID`: ID of the service principal's tenant. Also called its "directory" ID. 28310 - `AZURE_CLIENT_ID`: the service principal's client ID 28311 - `AZURE_CLIENT_CERTIFICATE_PATH`: path to a PEM or PKCS12 certificate file including the private key. 28312 - `AZURE_CLIENT_CERTIFICATE_PASSWORD`: (optional) password for the certificate file. 28313 - `AZURE_CLIENT_SEND_CERTIFICATE_CHAIN`: (optional) Specifies whether an authentication request will include an x5c header to support subject name / issuer based authentication. When set to "true" or "1", authentication requests include the x5c header. 28314 3. User with username and password 28315 - `AZURE_TENANT_ID`: (optional) tenant to authenticate in. Defaults to "organizations". 28316 - `AZURE_CLIENT_ID`: client ID of the application the user will authenticate to 28317 - `AZURE_USERNAME`: a username (usually an email address) 28318 - `AZURE_PASSWORD`: the user's password 28319 4. Workload Identity 28320 - `AZURE_TENANT_ID`: Tenant to authenticate in. 28321 - `AZURE_CLIENT_ID`: Client ID of the application the user will authenticate to. 28322 - `AZURE_FEDERATED_TOKEN_FILE`: Path to projected service account token file. 28323 - `AZURE_AUTHORITY_HOST`: Authority of an Azure Active Directory endpoint (default: login.microsoftonline.com). 28324 28325 28326 ##### Env Auth: 2. Managed Service Identity Credentials 28327 28328 When using Managed Service Identity if the VM(SS) on which this 28329 program is running has a system-assigned identity, it will be used by 28330 default. If the resource has no system-assigned but exactly one 28331 user-assigned identity, the user-assigned identity will be used by 28332 default. 28333 28334 If the resource has multiple user-assigned identities you will need to 28335 unset `env_auth` and set `use_msi` instead. See the [`use_msi` 28336 section](#use_msi). 28337 28338 ##### Env Auth: 3. Azure CLI credentials (as used by the az tool) 28339 28340 Credentials created with the `az` tool can be picked up using `env_auth`. 28341 28342 For example if you were to login with a service principal like this: 28343 28344 az login --service-principal -u XXX -p XXX --tenant XXX 28345 28346 Then you could access rclone resources like this: 28347 28348 rclone lsf :azureblob,env_auth,account=ACCOUNT:CONTAINER 28349 28350 Or 28351 28352 rclone lsf --azureblob-env-auth --azureblob-account=ACCOUNT :azureblob:CONTAINER 28353 28354 Which is analogous to using the `az` tool: 28355 28356 az storage blob list --container-name CONTAINER --account-name ACCOUNT --auth-mode login 28357 28358 #### Account and Shared Key 28359 28360 This is the most straight forward and least flexible way. Just fill 28361 in the `account` and `key` lines and leave the rest blank. 28362 28363 #### SAS URL 28364 28365 This can be an account level SAS URL or container level SAS URL. 28366 28367 To use it leave `account` and `key` blank and fill in `sas_url`. 28368 28369 An account level SAS URL or container level SAS URL can be obtained 28370 from the Azure portal or the Azure Storage Explorer. To get a 28371 container level SAS URL right click on a container in the Azure Blob 28372 explorer in the Azure portal. 28373 28374 If you use a container level SAS URL, rclone operations are permitted 28375 only on a particular container, e.g. 28376 28377 rclone ls azureblob:container 28378 28379 You can also list the single container from the root. This will only 28380 show the container specified by the SAS URL. 28381 28382 $ rclone lsd azureblob: 28383 container/ 28384 28385 Note that you can't see or access any other containers - this will 28386 fail 28387 28388 rclone ls azureblob:othercontainer 28389 28390 Container level SAS URLs are useful for temporarily allowing third 28391 parties access to a single container or putting credentials into an 28392 untrusted environment such as a CI build server. 28393 28394 #### Service principal with client secret 28395 28396 If these variables are set, rclone will authenticate with a service principal with a client secret. 28397 28398 - `tenant`: ID of the service principal's tenant. Also called its "directory" ID. 28399 - `client_id`: the service principal's client ID 28400 - `client_secret`: one of the service principal's client secrets 28401 28402 The credentials can also be placed in a file using the 28403 `service_principal_file` configuration option. 28404 28405 #### Service principal with certificate 28406 28407 If these variables are set, rclone will authenticate with a service principal with certificate. 28408 28409 - `tenant`: ID of the service principal's tenant. Also called its "directory" ID. 28410 - `client_id`: the service principal's client ID 28411 - `client_certificate_path`: path to a PEM or PKCS12 certificate file including the private key. 28412 - `client_certificate_password`: (optional) password for the certificate file. 28413 - `client_send_certificate_chain`: (optional) Specifies whether an authentication request will include an x5c header to support subject name / issuer based authentication. When set to "true" or "1", authentication requests include the x5c header. 28414 28415 **NB** `client_certificate_password` must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/). 28416 28417 #### User with username and password 28418 28419 If these variables are set, rclone will authenticate with username and password. 28420 28421 - `tenant`: (optional) tenant to authenticate in. Defaults to "organizations". 28422 - `client_id`: client ID of the application the user will authenticate to 28423 - `username`: a username (usually an email address) 28424 - `password`: the user's password 28425 28426 Microsoft doesn't recommend this kind of authentication, because it's 28427 less secure than other authentication flows. This method is not 28428 interactive, so it isn't compatible with any form of multi-factor 28429 authentication, and the application must already have user or admin 28430 consent. This credential can only authenticate work and school 28431 accounts; it can't authenticate Microsoft accounts. 28432 28433 **NB** `password` must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/). 28434 28435 #### Managed Service Identity Credentials {#use_msi} 28436 28437 If `use_msi` is set then managed service identity credentials are 28438 used. This authentication only works when running in an Azure service. 28439 `env_auth` needs to be unset to use this. 28440 28441 However if you have multiple user identities to choose from these must 28442 be explicitly specified using exactly one of the `msi_object_id`, 28443 `msi_client_id`, or `msi_mi_res_id` parameters. 28444 28445 If none of `msi_object_id`, `msi_client_id`, or `msi_mi_res_id` is 28446 set, this is is equivalent to using `env_auth`. 28447 28448 28449 ### Standard options 28450 28451 Here are the Standard options specific to azureblob (Microsoft Azure Blob Storage). 28452 28453 #### --azureblob-account 28454 28455 Azure Storage Account Name. 28456 28457 Set this to the Azure Storage Account Name in use. 28458 28459 Leave blank to use SAS URL or Emulator, otherwise it needs to be set. 28460 28461 If this is blank and if env_auth is set it will be read from the 28462 environment variable `AZURE_STORAGE_ACCOUNT_NAME` if possible. 28463 28464 28465 Properties: 28466 28467 - Config: account 28468 - Env Var: RCLONE_AZUREBLOB_ACCOUNT 28469 - Type: string 28470 - Required: false 28471 28472 #### --azureblob-env-auth 28473 28474 Read credentials from runtime (environment variables, CLI or MSI). 28475 28476 See the [authentication docs](/azureblob#authentication) for full info. 28477 28478 Properties: 28479 28480 - Config: env_auth 28481 - Env Var: RCLONE_AZUREBLOB_ENV_AUTH 28482 - Type: bool 28483 - Default: false 28484 28485 #### --azureblob-key 28486 28487 Storage Account Shared Key. 28488 28489 Leave blank to use SAS URL or Emulator. 28490 28491 Properties: 28492 28493 - Config: key 28494 - Env Var: RCLONE_AZUREBLOB_KEY 28495 - Type: string 28496 - Required: false 28497 28498 #### --azureblob-sas-url 28499 28500 SAS URL for container level access only. 28501 28502 Leave blank if using account/key or Emulator. 28503 28504 Properties: 28505 28506 - Config: sas_url 28507 - Env Var: RCLONE_AZUREBLOB_SAS_URL 28508 - Type: string 28509 - Required: false 28510 28511 #### --azureblob-tenant 28512 28513 ID of the service principal's tenant. Also called its directory ID. 28514 28515 Set this if using 28516 - Service principal with client secret 28517 - Service principal with certificate 28518 - User with username and password 28519 28520 28521 Properties: 28522 28523 - Config: tenant 28524 - Env Var: RCLONE_AZUREBLOB_TENANT 28525 - Type: string 28526 - Required: false 28527 28528 #### --azureblob-client-id 28529 28530 The ID of the client in use. 28531 28532 Set this if using 28533 - Service principal with client secret 28534 - Service principal with certificate 28535 - User with username and password 28536 28537 28538 Properties: 28539 28540 - Config: client_id 28541 - Env Var: RCLONE_AZUREBLOB_CLIENT_ID 28542 - Type: string 28543 - Required: false 28544 28545 #### --azureblob-client-secret 28546 28547 One of the service principal's client secrets 28548 28549 Set this if using 28550 - Service principal with client secret 28551 28552 28553 Properties: 28554 28555 - Config: client_secret 28556 - Env Var: RCLONE_AZUREBLOB_CLIENT_SECRET 28557 - Type: string 28558 - Required: false 28559 28560 #### --azureblob-client-certificate-path 28561 28562 Path to a PEM or PKCS12 certificate file including the private key. 28563 28564 Set this if using 28565 - Service principal with certificate 28566 28567 28568 Properties: 28569 28570 - Config: client_certificate_path 28571 - Env Var: RCLONE_AZUREBLOB_CLIENT_CERTIFICATE_PATH 28572 - Type: string 28573 - Required: false 28574 28575 #### --azureblob-client-certificate-password 28576 28577 Password for the certificate file (optional). 28578 28579 Optionally set this if using 28580 - Service principal with certificate 28581 28582 And the certificate has a password. 28583 28584 28585 **NB** Input to this must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/). 28586 28587 Properties: 28588 28589 - Config: client_certificate_password 28590 - Env Var: RCLONE_AZUREBLOB_CLIENT_CERTIFICATE_PASSWORD 28591 - Type: string 28592 - Required: false 28593 28594 ### Advanced options 28595 28596 Here are the Advanced options specific to azureblob (Microsoft Azure Blob Storage). 28597 28598 #### --azureblob-client-send-certificate-chain 28599 28600 Send the certificate chain when using certificate auth. 28601 28602 Specifies whether an authentication request will include an x5c header 28603 to support subject name / issuer based authentication. When set to 28604 true, authentication requests include the x5c header. 28605 28606 Optionally set this if using 28607 - Service principal with certificate 28608 28609 28610 Properties: 28611 28612 - Config: client_send_certificate_chain 28613 - Env Var: RCLONE_AZUREBLOB_CLIENT_SEND_CERTIFICATE_CHAIN 28614 - Type: bool 28615 - Default: false 28616 28617 #### --azureblob-username 28618 28619 User name (usually an email address) 28620 28621 Set this if using 28622 - User with username and password 28623 28624 28625 Properties: 28626 28627 - Config: username 28628 - Env Var: RCLONE_AZUREBLOB_USERNAME 28629 - Type: string 28630 - Required: false 28631 28632 #### --azureblob-password 28633 28634 The user's password 28635 28636 Set this if using 28637 - User with username and password 28638 28639 28640 **NB** Input to this must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/). 28641 28642 Properties: 28643 28644 - Config: password 28645 - Env Var: RCLONE_AZUREBLOB_PASSWORD 28646 - Type: string 28647 - Required: false 28648 28649 #### --azureblob-service-principal-file 28650 28651 Path to file containing credentials for use with a service principal. 28652 28653 Leave blank normally. Needed only if you want to use a service principal instead of interactive login. 28654 28655 $ az ad sp create-for-rbac --name "<name>" \ 28656 --role "Storage Blob Data Owner" \ 28657 --scopes "/subscriptions/<subscription>/resourceGroups/<resource-group>/providers/Microsoft.Storage/storageAccounts/<storage-account>/blobServices/default/containers/<container>" \ 28658 > azure-principal.json 28659 28660 See ["Create an Azure service principal"](https://docs.microsoft.com/en-us/cli/azure/create-an-azure-service-principal-azure-cli) and ["Assign an Azure role for access to blob data"](https://docs.microsoft.com/en-us/azure/storage/common/storage-auth-aad-rbac-cli) pages for more details. 28661 28662 It may be more convenient to put the credentials directly into the 28663 rclone config file under the `client_id`, `tenant` and `client_secret` 28664 keys instead of setting `service_principal_file`. 28665 28666 28667 Properties: 28668 28669 - Config: service_principal_file 28670 - Env Var: RCLONE_AZUREBLOB_SERVICE_PRINCIPAL_FILE 28671 - Type: string 28672 - Required: false 28673 28674 #### --azureblob-use-msi 28675 28676 Use a managed service identity to authenticate (only works in Azure). 28677 28678 When true, use a [managed service identity](https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/) 28679 to authenticate to Azure Storage instead of a SAS token or account key. 28680 28681 If the VM(SS) on which this program is running has a system-assigned identity, it will 28682 be used by default. If the resource has no system-assigned but exactly one user-assigned identity, 28683 the user-assigned identity will be used by default. If the resource has multiple user-assigned 28684 identities, the identity to use must be explicitly specified using exactly one of the msi_object_id, 28685 msi_client_id, or msi_mi_res_id parameters. 28686 28687 Properties: 28688 28689 - Config: use_msi 28690 - Env Var: RCLONE_AZUREBLOB_USE_MSI 28691 - Type: bool 28692 - Default: false 28693 28694 #### --azureblob-msi-object-id 28695 28696 Object ID of the user-assigned MSI to use, if any. 28697 28698 Leave blank if msi_client_id or msi_mi_res_id specified. 28699 28700 Properties: 28701 28702 - Config: msi_object_id 28703 - Env Var: RCLONE_AZUREBLOB_MSI_OBJECT_ID 28704 - Type: string 28705 - Required: false 28706 28707 #### --azureblob-msi-client-id 28708 28709 Object ID of the user-assigned MSI to use, if any. 28710 28711 Leave blank if msi_object_id or msi_mi_res_id specified. 28712 28713 Properties: 28714 28715 - Config: msi_client_id 28716 - Env Var: RCLONE_AZUREBLOB_MSI_CLIENT_ID 28717 - Type: string 28718 - Required: false 28719 28720 #### --azureblob-msi-mi-res-id 28721 28722 Azure resource ID of the user-assigned MSI to use, if any. 28723 28724 Leave blank if msi_client_id or msi_object_id specified. 28725 28726 Properties: 28727 28728 - Config: msi_mi_res_id 28729 - Env Var: RCLONE_AZUREBLOB_MSI_MI_RES_ID 28730 - Type: string 28731 - Required: false 28732 28733 #### --azureblob-use-emulator 28734 28735 Uses local storage emulator if provided as 'true'. 28736 28737 Leave blank if using real azure storage endpoint. 28738 28739 Properties: 28740 28741 - Config: use_emulator 28742 - Env Var: RCLONE_AZUREBLOB_USE_EMULATOR 28743 - Type: bool 28744 - Default: false 28745 28746 #### --azureblob-endpoint 28747 28748 Endpoint for the service. 28749 28750 Leave blank normally. 28751 28752 Properties: 28753 28754 - Config: endpoint 28755 - Env Var: RCLONE_AZUREBLOB_ENDPOINT 28756 - Type: string 28757 - Required: false 28758 28759 #### --azureblob-upload-cutoff 28760 28761 Cutoff for switching to chunked upload (<= 256 MiB) (deprecated). 28762 28763 Properties: 28764 28765 - Config: upload_cutoff 28766 - Env Var: RCLONE_AZUREBLOB_UPLOAD_CUTOFF 28767 - Type: string 28768 - Required: false 28769 28770 #### --azureblob-chunk-size 28771 28772 Upload chunk size. 28773 28774 Note that this is stored in memory and there may be up to 28775 "--transfers" * "--azureblob-upload-concurrency" chunks stored at once 28776 in memory. 28777 28778 Properties: 28779 28780 - Config: chunk_size 28781 - Env Var: RCLONE_AZUREBLOB_CHUNK_SIZE 28782 - Type: SizeSuffix 28783 - Default: 4Mi 28784 28785 #### --azureblob-upload-concurrency 28786 28787 Concurrency for multipart uploads. 28788 28789 This is the number of chunks of the same file that are uploaded 28790 concurrently. 28791 28792 If you are uploading small numbers of large files over high-speed 28793 links and these uploads do not fully utilize your bandwidth, then 28794 increasing this may help to speed up the transfers. 28795 28796 In tests, upload speed increases almost linearly with upload 28797 concurrency. For example to fill a gigabit pipe it may be necessary to 28798 raise this to 64. Note that this will use more memory. 28799 28800 Note that chunks are stored in memory and there may be up to 28801 "--transfers" * "--azureblob-upload-concurrency" chunks stored at once 28802 in memory. 28803 28804 Properties: 28805 28806 - Config: upload_concurrency 28807 - Env Var: RCLONE_AZUREBLOB_UPLOAD_CONCURRENCY 28808 - Type: int 28809 - Default: 16 28810 28811 #### --azureblob-list-chunk 28812 28813 Size of blob list. 28814 28815 This sets the number of blobs requested in each listing chunk. Default 28816 is the maximum, 5000. "List blobs" requests are permitted 2 minutes 28817 per megabyte to complete. If an operation is taking longer than 2 28818 minutes per megabyte on average, it will time out ( 28819 [source](https://docs.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-blob-service-operations#exceptions-to-default-timeout-interval) 28820 ). This can be used to limit the number of blobs items to return, to 28821 avoid the time out. 28822 28823 Properties: 28824 28825 - Config: list_chunk 28826 - Env Var: RCLONE_AZUREBLOB_LIST_CHUNK 28827 - Type: int 28828 - Default: 5000 28829 28830 #### --azureblob-access-tier 28831 28832 Access tier of blob: hot, cool, cold or archive. 28833 28834 Archived blobs can be restored by setting access tier to hot, cool or 28835 cold. Leave blank if you intend to use default access tier, which is 28836 set at account level 28837 28838 If there is no "access tier" specified, rclone doesn't apply any tier. 28839 rclone performs "Set Tier" operation on blobs while uploading, if objects 28840 are not modified, specifying "access tier" to new one will have no effect. 28841 If blobs are in "archive tier" at remote, trying to perform data transfer 28842 operations from remote will not be allowed. User should first restore by 28843 tiering blob to "Hot", "Cool" or "Cold". 28844 28845 Properties: 28846 28847 - Config: access_tier 28848 - Env Var: RCLONE_AZUREBLOB_ACCESS_TIER 28849 - Type: string 28850 - Required: false 28851 28852 #### --azureblob-archive-tier-delete 28853 28854 Delete archive tier blobs before overwriting. 28855 28856 Archive tier blobs cannot be updated. So without this flag, if you 28857 attempt to update an archive tier blob, then rclone will produce the 28858 error: 28859 28860 can't update archive tier blob without --azureblob-archive-tier-delete 28861 28862 With this flag set then before rclone attempts to overwrite an archive 28863 tier blob, it will delete the existing blob before uploading its 28864 replacement. This has the potential for data loss if the upload fails 28865 (unlike updating a normal blob) and also may cost more since deleting 28866 archive tier blobs early may be chargable. 28867 28868 28869 Properties: 28870 28871 - Config: archive_tier_delete 28872 - Env Var: RCLONE_AZUREBLOB_ARCHIVE_TIER_DELETE 28873 - Type: bool 28874 - Default: false 28875 28876 #### --azureblob-disable-checksum 28877 28878 Don't store MD5 checksum with object metadata. 28879 28880 Normally rclone will calculate the MD5 checksum of the input before 28881 uploading it so it can add it to metadata on the object. This is great 28882 for data integrity checking but can cause long delays for large files 28883 to start uploading. 28884 28885 Properties: 28886 28887 - Config: disable_checksum 28888 - Env Var: RCLONE_AZUREBLOB_DISABLE_CHECKSUM 28889 - Type: bool 28890 - Default: false 28891 28892 #### --azureblob-memory-pool-flush-time 28893 28894 How often internal memory buffer pools will be flushed. (no longer used) 28895 28896 Properties: 28897 28898 - Config: memory_pool_flush_time 28899 - Env Var: RCLONE_AZUREBLOB_MEMORY_POOL_FLUSH_TIME 28900 - Type: Duration 28901 - Default: 1m0s 28902 28903 #### --azureblob-memory-pool-use-mmap 28904 28905 Whether to use mmap buffers in internal memory pool. (no longer used) 28906 28907 Properties: 28908 28909 - Config: memory_pool_use_mmap 28910 - Env Var: RCLONE_AZUREBLOB_MEMORY_POOL_USE_MMAP 28911 - Type: bool 28912 - Default: false 28913 28914 #### --azureblob-encoding 28915 28916 The encoding for the backend. 28917 28918 See the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. 28919 28920 Properties: 28921 28922 - Config: encoding 28923 - Env Var: RCLONE_AZUREBLOB_ENCODING 28924 - Type: Encoding 28925 - Default: Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8 28926 28927 #### --azureblob-public-access 28928 28929 Public access level of a container: blob or container. 28930 28931 Properties: 28932 28933 - Config: public_access 28934 - Env Var: RCLONE_AZUREBLOB_PUBLIC_ACCESS 28935 - Type: string 28936 - Required: false 28937 - Examples: 28938 - "" 28939 - The container and its blobs can be accessed only with an authorized request. 28940 - It's a default value. 28941 - "blob" 28942 - Blob data within this container can be read via anonymous request. 28943 - "container" 28944 - Allow full public read access for container and blob data. 28945 28946 #### --azureblob-directory-markers 28947 28948 Upload an empty object with a trailing slash when a new directory is created 28949 28950 Empty folders are unsupported for bucket based remotes, this option 28951 creates an empty object ending with "/", to persist the folder. 28952 28953 This object also has the metadata "hdi_isfolder = true" to conform to 28954 the Microsoft standard. 28955 28956 28957 Properties: 28958 28959 - Config: directory_markers 28960 - Env Var: RCLONE_AZUREBLOB_DIRECTORY_MARKERS 28961 - Type: bool 28962 - Default: false 28963 28964 #### --azureblob-no-check-container 28965 28966 If set, don't attempt to check the container exists or create it. 28967 28968 This can be useful when trying to minimise the number of transactions 28969 rclone does if you know the container exists already. 28970 28971 28972 Properties: 28973 28974 - Config: no_check_container 28975 - Env Var: RCLONE_AZUREBLOB_NO_CHECK_CONTAINER 28976 - Type: bool 28977 - Default: false 28978 28979 #### --azureblob-no-head-object 28980 28981 If set, do not do HEAD before GET when getting objects. 28982 28983 Properties: 28984 28985 - Config: no_head_object 28986 - Env Var: RCLONE_AZUREBLOB_NO_HEAD_OBJECT 28987 - Type: bool 28988 - Default: false 28989 28990 #### --azureblob-delete-snapshots 28991 28992 Set to specify how to deal with snapshots on blob deletion. 28993 28994 Properties: 28995 28996 - Config: delete_snapshots 28997 - Env Var: RCLONE_AZUREBLOB_DELETE_SNAPSHOTS 28998 - Type: string 28999 - Required: false 29000 - Choices: 29001 - "" 29002 - By default, the delete operation fails if a blob has snapshots 29003 - "include" 29004 - Specify 'include' to remove the root blob and all its snapshots 29005 - "only" 29006 - Specify 'only' to remove only the snapshots but keep the root blob. 29007 29008 #### --azureblob-description 29009 29010 Description of the remote 29011 29012 Properties: 29013 29014 - Config: description 29015 - Env Var: RCLONE_AZUREBLOB_DESCRIPTION 29016 - Type: string 29017 - Required: false 29018 29019 29020 29021 ### Custom upload headers 29022 29023 You can set custom upload headers with the `--header-upload` flag. 29024 29025 - Cache-Control 29026 - Content-Disposition 29027 - Content-Encoding 29028 - Content-Language 29029 - Content-Type 29030 29031 Eg `--header-upload "Content-Type: text/potato"` 29032 29033 ## Limitations 29034 29035 MD5 sums are only uploaded with chunked files if the source has an MD5 29036 sum. This will always be the case for a local to azure copy. 29037 29038 `rclone about` is not supported by the Microsoft Azure Blob storage backend. Backends without 29039 this capability cannot determine free space for an rclone mount or 29040 use policy `mfs` (most free space) as a member of an rclone union 29041 remote. 29042 29043 See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features) and [rclone about](https://rclone.org/commands/rclone_about/) 29044 29045 ## Azure Storage Emulator Support 29046 29047 You can run rclone with the storage emulator (usually _azurite_). 29048 29049 To do this, just set up a new remote with `rclone config` following 29050 the instructions in the introduction and set `use_emulator` in the 29051 advanced settings as `true`. You do not need to provide a default 29052 account name nor an account key. But you can override them in the 29053 `account` and `key` options. (Prior to v1.61 they were hard coded to 29054 _azurite_'s `devstoreaccount1`.) 29055 29056 Also, if you want to access a storage emulator instance running on a 29057 different machine, you can override the `endpoint` parameter in the 29058 advanced settings, setting it to 29059 `http(s)://<host>:<port>/devstoreaccount1` 29060 (e.g. `http://10.254.2.5:10000/devstoreaccount1`). 29061 29062 # Microsoft Azure Files Storage 29063 29064 Paths are specified as `remote:` You may put subdirectories in too, 29065 e.g. `remote:path/to/dir`. 29066 29067 ## Configuration 29068 29069 Here is an example of making a Microsoft Azure Files Storage 29070 configuration. For a remote called `remote`. First run: 29071 29072 rclone config 29073 29074 This will guide you through an interactive setup process: 29075 </code></pre> 29076 <p>No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n name> remote Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Microsoft Azure Files Storage "azurefiles" [snip]</p> 29077 <p>Option account. Azure Storage Account Name. Set this to the Azure Storage Account Name in use. Leave blank to use SAS URL or connection string, otherwise it needs to be set. If this is blank and if env_auth is set it will be read from the environment variable <code>AZURE_STORAGE_ACCOUNT_NAME</code> if possible. Enter a value. Press Enter to leave empty. account> account_name</p> 29078 <p>Option share_name. Azure Files Share Name. This is required and is the name of the share to access. Enter a value. Press Enter to leave empty. share_name> share_name</p> 29079 <p>Option env_auth. Read credentials from runtime (environment variables, CLI or MSI). See the <a href="/azurefiles#authentication">authentication docs</a> for full info. Enter a boolean value (true or false). Press Enter for the default (false). env_auth></p> 29080 <p>Option key. Storage Account Shared Key. Leave blank to use SAS URL or connection string. Enter a value. Press Enter to leave empty. key> base64encodedkey==</p> 29081 <p>Option sas_url. SAS URL. Leave blank if using account/key or connection string. Enter a value. Press Enter to leave empty. sas_url></p> 29082 <p>Option connection_string. Azure Files Connection String. Enter a value. Press Enter to leave empty. connection_string> [snip]</p> 29083 <p>Configuration complete. Options: - type: azurefiles - account: account_name - share_name: share_name - key: base64encodedkey== Keep this "remote" remote? y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d></p> 29084 <pre><code> 29085 Once configured you can use rclone. 29086 29087 See all files in the top level: 29088 29089 rclone lsf remote: 29090 29091 Make a new directory in the root: 29092 29093 rclone mkdir remote:dir 29094 29095 Recursively List the contents: 29096 29097 rclone ls remote: 29098 29099 Sync `/home/local/directory` to the remote directory, deleting any 29100 excess files in the directory. 29101 29102 rclone sync --interactive /home/local/directory remote:dir 29103 29104 ### Modified time 29105 29106 The modified time is stored as Azure standard `LastModified` time on 29107 files 29108 29109 ### Performance 29110 29111 When uploading large files, increasing the value of 29112 `--azurefiles-upload-concurrency` will increase performance at the cost 29113 of using more memory. The default of 16 is set quite conservatively to 29114 use less memory. It maybe be necessary raise it to 64 or higher to 29115 fully utilize a 1 GBit/s link with a single file transfer. 29116 29117 ### Restricted filename characters 29118 29119 In addition to the [default restricted characters set](https://rclone.org/overview/#restricted-characters) 29120 the following characters are also replaced: 29121 29122 | Character | Value | Replacement | 29123 | --------- |:-----:|:-----------:| 29124 | " | 0x22 | ＂ | 29125 | * | 0x2A | ＊ | 29126 | : | 0x3A | ： | 29127 | < | 0x3C | ＜ | 29128 | > | 0x3E | ＞ | 29129 | ? | 0x3F | ？ | 29130 | \ | 0x5C | ＼ | 29131 | \| | 0x7C | ｜ | 29132 29133 File names can also not end with the following characters. 29134 These only get replaced if they are the last character in the name: 29135 29136 | Character | Value | Replacement | 29137 | --------- |:-----:|:-----------:| 29138 | . | 0x2E | ． | 29139 29140 Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8), 29141 as they can't be used in JSON strings. 29142 29143 ### Hashes 29144 29145 MD5 hashes are stored with files. Not all files will have MD5 hashes 29146 as these have to be uploaded with the file. 29147 29148 ### Authentication {#authentication} 29149 29150 There are a number of ways of supplying credentials for Azure Files 29151 Storage. Rclone tries them in the order of the sections below. 29152 29153 #### Env Auth 29154 29155 If the `env_auth` config parameter is `true` then rclone will pull 29156 credentials from the environment or runtime. 29157 29158 It tries these authentication methods in this order: 29159 29160 1. Environment Variables 29161 2. Managed Service Identity Credentials 29162 3. Azure CLI credentials (as used by the az tool) 29163 29164 These are described in the following sections 29165 29166 ##### Env Auth: 1. Environment Variables 29167 29168 If `env_auth` is set and environment variables are present rclone 29169 authenticates a service principal with a secret or certificate, or a 29170 user with a password, depending on which environment variable are set. 29171 It reads configuration from these variables, in the following order: 29172 29173 1. Service principal with client secret 29174 - `AZURE_TENANT_ID`: ID of the service principal's tenant. Also called its "directory" ID. 29175 - `AZURE_CLIENT_ID`: the service principal's client ID 29176 - `AZURE_CLIENT_SECRET`: one of the service principal's client secrets 29177 2. Service principal with certificate 29178 - `AZURE_TENANT_ID`: ID of the service principal's tenant. Also called its "directory" ID. 29179 - `AZURE_CLIENT_ID`: the service principal's client ID 29180 - `AZURE_CLIENT_CERTIFICATE_PATH`: path to a PEM or PKCS12 certificate file including the private key. 29181 - `AZURE_CLIENT_CERTIFICATE_PASSWORD`: (optional) password for the certificate file. 29182 - `AZURE_CLIENT_SEND_CERTIFICATE_CHAIN`: (optional) Specifies whether an authentication request will include an x5c header to support subject name / issuer based authentication. When set to "true" or "1", authentication requests include the x5c header. 29183 3. User with username and password 29184 - `AZURE_TENANT_ID`: (optional) tenant to authenticate in. Defaults to "organizations". 29185 - `AZURE_CLIENT_ID`: client ID of the application the user will authenticate to 29186 - `AZURE_USERNAME`: a username (usually an email address) 29187 - `AZURE_PASSWORD`: the user's password 29188 4. Workload Identity 29189 - `AZURE_TENANT_ID`: Tenant to authenticate in. 29190 - `AZURE_CLIENT_ID`: Client ID of the application the user will authenticate to. 29191 - `AZURE_FEDERATED_TOKEN_FILE`: Path to projected service account token file. 29192 - `AZURE_AUTHORITY_HOST`: Authority of an Azure Active Directory endpoint (default: login.microsoftonline.com). 29193 29194 29195 ##### Env Auth: 2. Managed Service Identity Credentials 29196 29197 When using Managed Service Identity if the VM(SS) on which this 29198 program is running has a system-assigned identity, it will be used by 29199 default. If the resource has no system-assigned but exactly one 29200 user-assigned identity, the user-assigned identity will be used by 29201 default. 29202 29203 If the resource has multiple user-assigned identities you will need to 29204 unset `env_auth` and set `use_msi` instead. See the [`use_msi` 29205 section](#use_msi). 29206 29207 ##### Env Auth: 3. Azure CLI credentials (as used by the az tool) 29208 29209 Credentials created with the `az` tool can be picked up using `env_auth`. 29210 29211 For example if you were to login with a service principal like this: 29212 29213 az login --service-principal -u XXX -p XXX --tenant XXX 29214 29215 Then you could access rclone resources like this: 29216 29217 rclone lsf :azurefiles,env_auth,account=ACCOUNT: 29218 29219 Or 29220 29221 rclone lsf --azurefiles-env-auth --azurefiles-account=ACCOUNT :azurefiles: 29222 29223 #### Account and Shared Key 29224 29225 This is the most straight forward and least flexible way. Just fill 29226 in the `account` and `key` lines and leave the rest blank. 29227 29228 #### SAS URL 29229 29230 To use it leave `account`, `key` and `connection_string` blank and fill in `sas_url`. 29231 29232 #### Connection String 29233 29234 To use it leave `account`, `key` and "sas_url" blank and fill in `connection_string`. 29235 29236 #### Service principal with client secret 29237 29238 If these variables are set, rclone will authenticate with a service principal with a client secret. 29239 29240 - `tenant`: ID of the service principal's tenant. Also called its "directory" ID. 29241 - `client_id`: the service principal's client ID 29242 - `client_secret`: one of the service principal's client secrets 29243 29244 The credentials can also be placed in a file using the 29245 `service_principal_file` configuration option. 29246 29247 #### Service principal with certificate 29248 29249 If these variables are set, rclone will authenticate with a service principal with certificate. 29250 29251 - `tenant`: ID of the service principal's tenant. Also called its "directory" ID. 29252 - `client_id`: the service principal's client ID 29253 - `client_certificate_path`: path to a PEM or PKCS12 certificate file including the private key. 29254 - `client_certificate_password`: (optional) password for the certificate file. 29255 - `client_send_certificate_chain`: (optional) Specifies whether an authentication request will include an x5c header to support subject name / issuer based authentication. When set to "true" or "1", authentication requests include the x5c header. 29256 29257 **NB** `client_certificate_password` must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/). 29258 29259 #### User with username and password 29260 29261 If these variables are set, rclone will authenticate with username and password. 29262 29263 - `tenant`: (optional) tenant to authenticate in. Defaults to "organizations". 29264 - `client_id`: client ID of the application the user will authenticate to 29265 - `username`: a username (usually an email address) 29266 - `password`: the user's password 29267 29268 Microsoft doesn't recommend this kind of authentication, because it's 29269 less secure than other authentication flows. This method is not 29270 interactive, so it isn't compatible with any form of multi-factor 29271 authentication, and the application must already have user or admin 29272 consent. This credential can only authenticate work and school 29273 accounts; it can't authenticate Microsoft accounts. 29274 29275 **NB** `password` must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/). 29276 29277 #### Managed Service Identity Credentials {#use_msi} 29278 29279 If `use_msi` is set then managed service identity credentials are 29280 used. This authentication only works when running in an Azure service. 29281 `env_auth` needs to be unset to use this. 29282 29283 However if you have multiple user identities to choose from these must 29284 be explicitly specified using exactly one of the `msi_object_id`, 29285 `msi_client_id`, or `msi_mi_res_id` parameters. 29286 29287 If none of `msi_object_id`, `msi_client_id`, or `msi_mi_res_id` is 29288 set, this is is equivalent to using `env_auth`. 29289 29290 29291 ### Standard options 29292 29293 Here are the Standard options specific to azurefiles (Microsoft Azure Files). 29294 29295 #### --azurefiles-account 29296 29297 Azure Storage Account Name. 29298 29299 Set this to the Azure Storage Account Name in use. 29300 29301 Leave blank to use SAS URL or connection string, otherwise it needs to be set. 29302 29303 If this is blank and if env_auth is set it will be read from the 29304 environment variable `AZURE_STORAGE_ACCOUNT_NAME` if possible. 29305 29306 29307 Properties: 29308 29309 - Config: account 29310 - Env Var: RCLONE_AZUREFILES_ACCOUNT 29311 - Type: string 29312 - Required: false 29313 29314 #### --azurefiles-share-name 29315 29316 Azure Files Share Name. 29317 29318 This is required and is the name of the share to access. 29319 29320 29321 Properties: 29322 29323 - Config: share_name 29324 - Env Var: RCLONE_AZUREFILES_SHARE_NAME 29325 - Type: string 29326 - Required: false 29327 29328 #### --azurefiles-env-auth 29329 29330 Read credentials from runtime (environment variables, CLI or MSI). 29331 29332 See the [authentication docs](/azurefiles#authentication) for full info. 29333 29334 Properties: 29335 29336 - Config: env_auth 29337 - Env Var: RCLONE_AZUREFILES_ENV_AUTH 29338 - Type: bool 29339 - Default: false 29340 29341 #### --azurefiles-key 29342 29343 Storage Account Shared Key. 29344 29345 Leave blank to use SAS URL or connection string. 29346 29347 Properties: 29348 29349 - Config: key 29350 - Env Var: RCLONE_AZUREFILES_KEY 29351 - Type: string 29352 - Required: false 29353 29354 #### --azurefiles-sas-url 29355 29356 SAS URL. 29357 29358 Leave blank if using account/key or connection string. 29359 29360 Properties: 29361 29362 - Config: sas_url 29363 - Env Var: RCLONE_AZUREFILES_SAS_URL 29364 - Type: string 29365 - Required: false 29366 29367 #### --azurefiles-connection-string 29368 29369 Azure Files Connection String. 29370 29371 Properties: 29372 29373 - Config: connection_string 29374 - Env Var: RCLONE_AZUREFILES_CONNECTION_STRING 29375 - Type: string 29376 - Required: false 29377 29378 #### --azurefiles-tenant 29379 29380 ID of the service principal's tenant. Also called its directory ID. 29381 29382 Set this if using 29383 - Service principal with client secret 29384 - Service principal with certificate 29385 - User with username and password 29386 29387 29388 Properties: 29389 29390 - Config: tenant 29391 - Env Var: RCLONE_AZUREFILES_TENANT 29392 - Type: string 29393 - Required: false 29394 29395 #### --azurefiles-client-id 29396 29397 The ID of the client in use. 29398 29399 Set this if using 29400 - Service principal with client secret 29401 - Service principal with certificate 29402 - User with username and password 29403 29404 29405 Properties: 29406 29407 - Config: client_id 29408 - Env Var: RCLONE_AZUREFILES_CLIENT_ID 29409 - Type: string 29410 - Required: false 29411 29412 #### --azurefiles-client-secret 29413 29414 One of the service principal's client secrets 29415 29416 Set this if using 29417 - Service principal with client secret 29418 29419 29420 Properties: 29421 29422 - Config: client_secret 29423 - Env Var: RCLONE_AZUREFILES_CLIENT_SECRET 29424 - Type: string 29425 - Required: false 29426 29427 #### --azurefiles-client-certificate-path 29428 29429 Path to a PEM or PKCS12 certificate file including the private key. 29430 29431 Set this if using 29432 - Service principal with certificate 29433 29434 29435 Properties: 29436 29437 - Config: client_certificate_path 29438 - Env Var: RCLONE_AZUREFILES_CLIENT_CERTIFICATE_PATH 29439 - Type: string 29440 - Required: false 29441 29442 #### --azurefiles-client-certificate-password 29443 29444 Password for the certificate file (optional). 29445 29446 Optionally set this if using 29447 - Service principal with certificate 29448 29449 And the certificate has a password. 29450 29451 29452 **NB** Input to this must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/). 29453 29454 Properties: 29455 29456 - Config: client_certificate_password 29457 - Env Var: RCLONE_AZUREFILES_CLIENT_CERTIFICATE_PASSWORD 29458 - Type: string 29459 - Required: false 29460 29461 ### Advanced options 29462 29463 Here are the Advanced options specific to azurefiles (Microsoft Azure Files). 29464 29465 #### --azurefiles-client-send-certificate-chain 29466 29467 Send the certificate chain when using certificate auth. 29468 29469 Specifies whether an authentication request will include an x5c header 29470 to support subject name / issuer based authentication. When set to 29471 true, authentication requests include the x5c header. 29472 29473 Optionally set this if using 29474 - Service principal with certificate 29475 29476 29477 Properties: 29478 29479 - Config: client_send_certificate_chain 29480 - Env Var: RCLONE_AZUREFILES_CLIENT_SEND_CERTIFICATE_CHAIN 29481 - Type: bool 29482 - Default: false 29483 29484 #### --azurefiles-username 29485 29486 User name (usually an email address) 29487 29488 Set this if using 29489 - User with username and password 29490 29491 29492 Properties: 29493 29494 - Config: username 29495 - Env Var: RCLONE_AZUREFILES_USERNAME 29496 - Type: string 29497 - Required: false 29498 29499 #### --azurefiles-password 29500 29501 The user's password 29502 29503 Set this if using 29504 - User with username and password 29505 29506 29507 **NB** Input to this must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/). 29508 29509 Properties: 29510 29511 - Config: password 29512 - Env Var: RCLONE_AZUREFILES_PASSWORD 29513 - Type: string 29514 - Required: false 29515 29516 #### --azurefiles-service-principal-file 29517 29518 Path to file containing credentials for use with a service principal. 29519 29520 Leave blank normally. Needed only if you want to use a service principal instead of interactive login. 29521 29522 $ az ad sp create-for-rbac --name "<name>" \ 29523 --role "Storage Files Data Owner" \ 29524 --scopes "/subscriptions/<subscription>/resourceGroups/<resource-group>/providers/Microsoft.Storage/storageAccounts/<storage-account>/blobServices/default/containers/<container>" \ 29525 > azure-principal.json 29526 29527 See ["Create an Azure service principal"](https://docs.microsoft.com/en-us/cli/azure/create-an-azure-service-principal-azure-cli) and ["Assign an Azure role for access to files data"](https://docs.microsoft.com/en-us/azure/storage/common/storage-auth-aad-rbac-cli) pages for more details. 29528 29529 **NB** this section needs updating for Azure Files - pull requests appreciated! 29530 29531 It may be more convenient to put the credentials directly into the 29532 rclone config file under the `client_id`, `tenant` and `client_secret` 29533 keys instead of setting `service_principal_file`. 29534 29535 29536 Properties: 29537 29538 - Config: service_principal_file 29539 - Env Var: RCLONE_AZUREFILES_SERVICE_PRINCIPAL_FILE 29540 - Type: string 29541 - Required: false 29542 29543 #### --azurefiles-use-msi 29544 29545 Use a managed service identity to authenticate (only works in Azure). 29546 29547 When true, use a [managed service identity](https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/) 29548 to authenticate to Azure Storage instead of a SAS token or account key. 29549 29550 If the VM(SS) on which this program is running has a system-assigned identity, it will 29551 be used by default. If the resource has no system-assigned but exactly one user-assigned identity, 29552 the user-assigned identity will be used by default. If the resource has multiple user-assigned 29553 identities, the identity to use must be explicitly specified using exactly one of the msi_object_id, 29554 msi_client_id, or msi_mi_res_id parameters. 29555 29556 Properties: 29557 29558 - Config: use_msi 29559 - Env Var: RCLONE_AZUREFILES_USE_MSI 29560 - Type: bool 29561 - Default: false 29562 29563 #### --azurefiles-msi-object-id 29564 29565 Object ID of the user-assigned MSI to use, if any. 29566 29567 Leave blank if msi_client_id or msi_mi_res_id specified. 29568 29569 Properties: 29570 29571 - Config: msi_object_id 29572 - Env Var: RCLONE_AZUREFILES_MSI_OBJECT_ID 29573 - Type: string 29574 - Required: false 29575 29576 #### --azurefiles-msi-client-id 29577 29578 Object ID of the user-assigned MSI to use, if any. 29579 29580 Leave blank if msi_object_id or msi_mi_res_id specified. 29581 29582 Properties: 29583 29584 - Config: msi_client_id 29585 - Env Var: RCLONE_AZUREFILES_MSI_CLIENT_ID 29586 - Type: string 29587 - Required: false 29588 29589 #### --azurefiles-msi-mi-res-id 29590 29591 Azure resource ID of the user-assigned MSI to use, if any. 29592 29593 Leave blank if msi_client_id or msi_object_id specified. 29594 29595 Properties: 29596 29597 - Config: msi_mi_res_id 29598 - Env Var: RCLONE_AZUREFILES_MSI_MI_RES_ID 29599 - Type: string 29600 - Required: false 29601 29602 #### --azurefiles-endpoint 29603 29604 Endpoint for the service. 29605 29606 Leave blank normally. 29607 29608 Properties: 29609 29610 - Config: endpoint 29611 - Env Var: RCLONE_AZUREFILES_ENDPOINT 29612 - Type: string 29613 - Required: false 29614 29615 #### --azurefiles-chunk-size 29616 29617 Upload chunk size. 29618 29619 Note that this is stored in memory and there may be up to 29620 "--transfers" * "--azurefile-upload-concurrency" chunks stored at once 29621 in memory. 29622 29623 Properties: 29624 29625 - Config: chunk_size 29626 - Env Var: RCLONE_AZUREFILES_CHUNK_SIZE 29627 - Type: SizeSuffix 29628 - Default: 4Mi 29629 29630 #### --azurefiles-upload-concurrency 29631 29632 Concurrency for multipart uploads. 29633 29634 This is the number of chunks of the same file that are uploaded 29635 concurrently. 29636 29637 If you are uploading small numbers of large files over high-speed 29638 links and these uploads do not fully utilize your bandwidth, then 29639 increasing this may help to speed up the transfers. 29640 29641 Note that chunks are stored in memory and there may be up to 29642 "--transfers" * "--azurefile-upload-concurrency" chunks stored at once 29643 in memory. 29644 29645 Properties: 29646 29647 - Config: upload_concurrency 29648 - Env Var: RCLONE_AZUREFILES_UPLOAD_CONCURRENCY 29649 - Type: int 29650 - Default: 16 29651 29652 #### --azurefiles-max-stream-size 29653 29654 Max size for streamed files. 29655 29656 Azure files needs to know in advance how big the file will be. When 29657 rclone doesn't know it uses this value instead. 29658 29659 This will be used when rclone is streaming data, the most common uses are: 29660 29661 - Uploading files with `--vfs-cache-mode off` with `rclone mount` 29662 - Using `rclone rcat` 29663 - Copying files with unknown length 29664 29665 You will need this much free space in the share as the file will be this size temporarily. 29666 29667 29668 Properties: 29669 29670 - Config: max_stream_size 29671 - Env Var: RCLONE_AZUREFILES_MAX_STREAM_SIZE 29672 - Type: SizeSuffix 29673 - Default: 10Gi 29674 29675 #### --azurefiles-encoding 29676 29677 The encoding for the backend. 29678 29679 See the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. 29680 29681 Properties: 29682 29683 - Config: encoding 29684 - Env Var: RCLONE_AZUREFILES_ENCODING 29685 - Type: Encoding 29686 - Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8,Dot 29687 29688 #### --azurefiles-description 29689 29690 Description of the remote 29691 29692 Properties: 29693 29694 - Config: description 29695 - Env Var: RCLONE_AZUREFILES_DESCRIPTION 29696 - Type: string 29697 - Required: false 29698 29699 29700 29701 ### Custom upload headers 29702 29703 You can set custom upload headers with the `--header-upload` flag. 29704 29705 - Cache-Control 29706 - Content-Disposition 29707 - Content-Encoding 29708 - Content-Language 29709 - Content-Type 29710 29711 Eg `--header-upload "Content-Type: text/potato"` 29712 29713 ## Limitations 29714 29715 MD5 sums are only uploaded with chunked files if the source has an MD5 29716 sum. This will always be the case for a local to azure copy. 29717 29718 # Microsoft OneDrive 29719 29720 Paths are specified as `remote:path` 29721 29722 Paths may be as deep as required, e.g. `remote:directory/subdirectory`. 29723 29724 ## Configuration 29725 29726 The initial setup for OneDrive involves getting a token from 29727 Microsoft which you need to do in your browser. `rclone config` walks 29728 you through it. 29729 29730 Here is an example of how to make a remote called `remote`. First run: 29731 29732 rclone config 29733 29734 This will guide you through an interactive setup process: 29735 </code></pre> 29736 <ol start="5" type="a"> 29737 <li>Edit existing remote</li> 29738 <li>New remote</li> 29739 <li>Delete remote</li> 29740 <li>Rename remote</li> 29741 <li>Copy remote</li> 29742 <li>Set configuration password</li> 29743 <li>Quit config e/n/d/r/c/s/q> n name> remote Type of storage to configure. Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value [snip] XX / Microsoft OneDrive "onedrive" [snip] Storage> onedrive Microsoft App Client Id Leave blank normally. Enter a string value. Press Enter for the default (""). client_id> Microsoft App Client Secret Leave blank normally. Enter a string value. Press Enter for the default (""). client_secret> Edit advanced config? (y/n)</li> 29744 <li>Yes</li> 29745 <li>No y/n> n Remote config Use web browser to automatically authenticate rclone with remote?</li> 29746 </ol> 29747 <ul> 29748 <li>Say Y if the machine running rclone has a web browser you can use</li> 29749 <li>Say N if running rclone on a (remote) machine without web browser access If not sure try Y. If Y failed, try N.</li> 29750 </ul> 29751 <ol start="25" type="a"> 29752 <li>Yes</li> 29753 <li>No y/n> y If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth Log in and authorize rclone for access Waiting for code... Got code Choose a number from below, or type in an existing value 1 / OneDrive Personal or Business "onedrive" 2 / Sharepoint site "sharepoint" 3 / Type in driveID "driveid" 4 / Type in SiteID "siteid" 5 / Search a Sharepoint site "search" Your choice> 1 Found 1 drives, please select the one you want to use: 0: OneDrive (business) id=b!Eqwertyuiopasdfghjklzxcvbnm-7mnbvcxzlkjhgfdsapoiuytrewqk Chose drive to use:> 0 Found drive 'root' of type 'business', URL: https://org-my.sharepoint.com/personal/you/Documents Is that okay?</li> 29754 <li>Yes</li> 29755 <li>No y/n> y -------------------- [remote] type = onedrive token = {"access_token":"youraccesstoken","token_type":"Bearer","refresh_token":"yourrefreshtoken","expiry":"2018-08-26T22:39:52.486512262+08:00"} drive_id = b!Eqwertyuiopasdfghjklzxcvbnm-7mnbvcxzlkjhgfdsapoiuytrewqk drive_type = business --------------------</li> 29756 <li>Yes this is OK</li> 29757 <li>Edit this remote</li> 29758 <li>Delete this remote y/e/d> y</li> 29759 </ol> 29760 <pre><code> 29761 See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a 29762 machine with no Internet browser available. 29763 29764 Note that rclone runs a webserver on your local machine to collect the 29765 token as returned from Microsoft. This only runs from the moment it 29766 opens your browser to the moment you get back the verification 29767 code. This is on `http://127.0.0.1:53682/` and this it may require 29768 you to unblock it temporarily if you are running a host firewall. 29769 29770 Once configured you can then use `rclone` like this, 29771 29772 List directories in top level of your OneDrive 29773 29774 rclone lsd remote: 29775 29776 List all the files in your OneDrive 29777 29778 rclone ls remote: 29779 29780 To copy a local directory to an OneDrive directory called backup 29781 29782 rclone copy /home/source remote:backup 29783 29784 ### Getting your own Client ID and Key 29785 29786 rclone uses a default Client ID when talking to OneDrive, unless a custom `client_id` is specified in the config. 29787 The default Client ID and Key are shared by all rclone users when performing requests. 29788 29789 You may choose to create and use your own Client ID, in case the default one does not work well for you. 29790 For example, you might see throttling. 29791 29792 #### Creating Client ID for OneDrive Personal 29793 29794 To create your own Client ID, please follow these steps: 29795 29796 1. Open https://portal.azure.com/#blade/Microsoft_AAD_RegisteredApps/ApplicationsListBlade and then click `New registration`. 29797 2. Enter a name for your app, choose account type `Accounts in any organizational directory (Any Azure AD directory - Multitenant) and personal Microsoft accounts (e.g. Skype, Xbox)`, select `Web` in `Redirect URI`, then type (do not copy and paste) `http://localhost:53682/` and click Register. Copy and keep the `Application (client) ID` under the app name for later use. 29798 3. Under `manage` select `Certificates & secrets`, click `New client secret`. Enter a description (can be anything) and set `Expires` to 24 months. Copy and keep that secret _Value_ for later use (you _won't_ be able to see this value afterwards). 29799 4. Under `manage` select `API permissions`, click `Add a permission` and select `Microsoft Graph` then select `delegated permissions`. 29800 5. Search and select the following permissions: `Files.Read`, `Files.ReadWrite`, `Files.Read.All`, `Files.ReadWrite.All`, `offline_access`, `User.Read` and `Sites.Read.All` (if custom access scopes are configured, select the permissions accordingly). Once selected click `Add permissions` at the bottom. 29801 29802 Now the application is complete. Run `rclone config` to create or edit a OneDrive remote. 29803 Supply the app ID and password as Client ID and Secret, respectively. rclone will walk you through the remaining steps. 29804 29805 The access_scopes option allows you to configure the permissions requested by rclone. 29806 See [Microsoft Docs](https://docs.microsoft.com/en-us/graph/permissions-reference#files-permissions) for more information about the different scopes. 29807 29808 The `Sites.Read.All` permission is required if you need to [search SharePoint sites when configuring the remote](https://github.com/rclone/rclone/pull/5883). However, if that permission is not assigned, you need to exclude `Sites.Read.All` from your access scopes or set `disable_site_permission` option to true in the advanced options. 29809 29810 #### Creating Client ID for OneDrive Business 29811 29812 The steps for OneDrive Personal may or may not work for OneDrive Business, depending on the security settings of the organization. 29813 A common error is that the publisher of the App is not verified. 29814 29815 You may try to [verify you account](https://docs.microsoft.com/en-us/azure/active-directory/develop/publisher-verification-overview), or try to limit the App to your organization only, as shown below. 29816 29817 1. Make sure to create the App with your business account. 29818 2. Follow the steps above to create an App. However, we need a different account type here: `Accounts in this organizational directory only (*** - Single tenant)`. Note that you can also change the account type after creating the App. 29819 3. Find the [tenant ID](https://docs.microsoft.com/en-us/azure/active-directory/fundamentals/active-directory-how-to-find-tenant) of your organization. 29820 4. In the rclone config, set `auth_url` to `https://login.microsoftonline.com/YOUR_TENANT_ID/oauth2/v2.0/authorize`. 29821 5. In the rclone config, set `token_url` to `https://login.microsoftonline.com/YOUR_TENANT_ID/oauth2/v2.0/token`. 29822 29823 Note: If you have a special region, you may need a different host in step 4 and 5. Here are [some hints](https://github.com/rclone/rclone/blob/bc23bf11db1c78c6ebbf8ea538fbebf7058b4176/backend/onedrive/onedrive.go#L86). 29824 29825 29826 ### Modification times and hashes 29827 29828 OneDrive allows modification times to be set on objects accurate to 1 29829 second. These will be used to detect whether objects need syncing or 29830 not. 29831 29832 OneDrive Personal, OneDrive for Business and Sharepoint Server support 29833 [QuickXorHash](https://docs.microsoft.com/en-us/onedrive/developer/code-snippets/quickxorhash). 29834 29835 Before rclone 1.62 the default hash for Onedrive Personal was `SHA1`. 29836 For rclone 1.62 and above the default for all Onedrive backends is 29837 `QuickXorHash`. 29838 29839 Starting from July 2023 `SHA1` support is being phased out in Onedrive 29840 Personal in favour of `QuickXorHash`. If necessary the 29841 `--onedrive-hash-type` flag (or `hash_type` config option) can be used 29842 to select `SHA1` during the transition period if this is important 29843 your workflow. 29844 29845 For all types of OneDrive you can use the `--checksum` flag. 29846 29847 ### --fast-list 29848 29849 This remote supports `--fast-list` which allows you to use fewer 29850 transactions in exchange for more memory. See the [rclone 29851 docs](https://rclone.org/docs/#fast-list) for more details. 29852 29853 This must be enabled with the `--onedrive-delta` flag (or `delta = 29854 true` in the config file) as it can cause performance degradation. 29855 29856 It does this by using the delta listing facilities of OneDrive which 29857 returns all the files in the remote very efficiently. This is much 29858 more efficient than listing directories recursively and is Microsoft's 29859 recommended way of reading all the file information from a drive. 29860 29861 This can be useful with `rclone mount` and [rclone rc vfs/refresh 29862 recursive=true](https://rclone.org/rc/#vfs-refresh)) to very quickly fill the mount with 29863 information about all the files. 29864 29865 The API used for the recursive listing (`ListR`) only supports listing 29866 from the root of the drive. This will become increasingly inefficient 29867 the further away you get from the root as rclone will have to discard 29868 files outside of the directory you are using. 29869 29870 Some commands (like `rclone lsf -R`) will use `ListR` by default - you 29871 can turn this off with `--disable ListR` if you need to. 29872 29873 ### Restricted filename characters 29874 29875 In addition to the [default restricted characters set](https://rclone.org/overview/#restricted-characters) 29876 the following characters are also replaced: 29877 29878 | Character | Value | Replacement | 29879 | --------- |:-----:|:-----------:| 29880 | " | 0x22 | ＂ | 29881 | * | 0x2A | ＊ | 29882 | : | 0x3A | ： | 29883 | < | 0x3C | ＜ | 29884 | > | 0x3E | ＞ | 29885 | ? | 0x3F | ？ | 29886 | \ | 0x5C | ＼ | 29887 | \| | 0x7C | ｜ | 29888 29889 File names can also not end with the following characters. 29890 These only get replaced if they are the last character in the name: 29891 29892 | Character | Value | Replacement | 29893 | --------- |:-----:|:-----------:| 29894 | SP | 0x20 | ␠ | 29895 | . | 0x2E | ． | 29896 29897 File names can also not begin with the following characters. 29898 These only get replaced if they are the first character in the name: 29899 29900 | Character | Value | Replacement | 29901 | --------- |:-----:|:-----------:| 29902 | SP | 0x20 | ␠ | 29903 | ~ | 0x7E | ～ | 29904 29905 Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8), 29906 as they can't be used in JSON strings. 29907 29908 ### Deleting files 29909 29910 Any files you delete with rclone will end up in the trash. Microsoft 29911 doesn't provide an API to permanently delete files, nor to empty the 29912 trash, so you will have to do that with one of Microsoft's apps or via 29913 the OneDrive website. 29914 29915 29916 ### Standard options 29917 29918 Here are the Standard options specific to onedrive (Microsoft OneDrive). 29919 29920 #### --onedrive-client-id 29921 29922 OAuth Client Id. 29923 29924 Leave blank normally. 29925 29926 Properties: 29927 29928 - Config: client_id 29929 - Env Var: RCLONE_ONEDRIVE_CLIENT_ID 29930 - Type: string 29931 - Required: false 29932 29933 #### --onedrive-client-secret 29934 29935 OAuth Client Secret. 29936 29937 Leave blank normally. 29938 29939 Properties: 29940 29941 - Config: client_secret 29942 - Env Var: RCLONE_ONEDRIVE_CLIENT_SECRET 29943 - Type: string 29944 - Required: false 29945 29946 #### --onedrive-region 29947 29948 Choose national cloud region for OneDrive. 29949 29950 Properties: 29951 29952 - Config: region 29953 - Env Var: RCLONE_ONEDRIVE_REGION 29954 - Type: string 29955 - Default: "global" 29956 - Examples: 29957 - "global" 29958 - Microsoft Cloud Global 29959 - "us" 29960 - Microsoft Cloud for US Government 29961 - "de" 29962 - Microsoft Cloud Germany 29963 - "cn" 29964 - Azure and Office 365 operated by Vnet Group in China 29965 29966 ### Advanced options 29967 29968 Here are the Advanced options specific to onedrive (Microsoft OneDrive). 29969 29970 #### --onedrive-token 29971 29972 OAuth Access Token as a JSON blob. 29973 29974 Properties: 29975 29976 - Config: token 29977 - Env Var: RCLONE_ONEDRIVE_TOKEN 29978 - Type: string 29979 - Required: false 29980 29981 #### --onedrive-auth-url 29982 29983 Auth server URL. 29984 29985 Leave blank to use the provider defaults. 29986 29987 Properties: 29988 29989 - Config: auth_url 29990 - Env Var: RCLONE_ONEDRIVE_AUTH_URL 29991 - Type: string 29992 - Required: false 29993 29994 #### --onedrive-token-url 29995 29996 Token server url. 29997 29998 Leave blank to use the provider defaults. 29999 30000 Properties: 30001 30002 - Config: token_url 30003 - Env Var: RCLONE_ONEDRIVE_TOKEN_URL 30004 - Type: string 30005 - Required: false 30006 30007 #### --onedrive-chunk-size 30008 30009 Chunk size to upload files with - must be multiple of 320k (327,680 bytes). 30010 30011 Above this size files will be chunked - must be multiple of 320k (327,680 bytes) and 30012 should not exceed 250M (262,144,000 bytes) else you may encounter \"Microsoft.SharePoint.Client.InvalidClientQueryException: The request message is too big.\" 30013 Note that the chunks will be buffered into memory. 30014 30015 Properties: 30016 30017 - Config: chunk_size 30018 - Env Var: RCLONE_ONEDRIVE_CHUNK_SIZE 30019 - Type: SizeSuffix 30020 - Default: 10Mi 30021 30022 #### --onedrive-drive-id 30023 30024 The ID of the drive to use. 30025 30026 Properties: 30027 30028 - Config: drive_id 30029 - Env Var: RCLONE_ONEDRIVE_DRIVE_ID 30030 - Type: string 30031 - Required: false 30032 30033 #### --onedrive-drive-type 30034 30035 The type of the drive (personal | business | documentLibrary). 30036 30037 Properties: 30038 30039 - Config: drive_type 30040 - Env Var: RCLONE_ONEDRIVE_DRIVE_TYPE 30041 - Type: string 30042 - Required: false 30043 30044 #### --onedrive-root-folder-id 30045 30046 ID of the root folder. 30047 30048 This isn't normally needed, but in special circumstances you might 30049 know the folder ID that you wish to access but not be able to get 30050 there through a path traversal. 30051 30052 30053 Properties: 30054 30055 - Config: root_folder_id 30056 - Env Var: RCLONE_ONEDRIVE_ROOT_FOLDER_ID 30057 - Type: string 30058 - Required: false 30059 30060 #### --onedrive-access-scopes 30061 30062 Set scopes to be requested by rclone. 30063 30064 Choose or manually enter a custom space separated list with all scopes, that rclone should request. 30065 30066 30067 Properties: 30068 30069 - Config: access_scopes 30070 - Env Var: RCLONE_ONEDRIVE_ACCESS_SCOPES 30071 - Type: SpaceSepList 30072 - Default: Files.Read Files.ReadWrite Files.Read.All Files.ReadWrite.All Sites.Read.All offline_access 30073 - Examples: 30074 - "Files.Read Files.ReadWrite Files.Read.All Files.ReadWrite.All Sites.Read.All offline_access" 30075 - Read and write access to all resources 30076 - "Files.Read Files.Read.All Sites.Read.All offline_access" 30077 - Read only access to all resources 30078 - "Files.Read Files.ReadWrite Files.Read.All Files.ReadWrite.All offline_access" 30079 - Read and write access to all resources, without the ability to browse SharePoint sites. 30080 - Same as if disable_site_permission was set to true 30081 30082 #### --onedrive-disable-site-permission 30083 30084 Disable the request for Sites.Read.All permission. 30085 30086 If set to true, you will no longer be able to search for a SharePoint site when 30087 configuring drive ID, because rclone will not request Sites.Read.All permission. 30088 Set it to true if your organization didn't assign Sites.Read.All permission to the 30089 application, and your organization disallows users to consent app permission 30090 request on their own. 30091 30092 Properties: 30093 30094 - Config: disable_site_permission 30095 - Env Var: RCLONE_ONEDRIVE_DISABLE_SITE_PERMISSION 30096 - Type: bool 30097 - Default: false 30098 30099 #### --onedrive-expose-onenote-files 30100 30101 Set to make OneNote files show up in directory listings. 30102 30103 By default, rclone will hide OneNote files in directory listings because 30104 operations like "Open" and "Update" won't work on them. But this 30105 behaviour may also prevent you from deleting them. If you want to 30106 delete OneNote files or otherwise want them to show up in directory 30107 listing, set this option. 30108 30109 Properties: 30110 30111 - Config: expose_onenote_files 30112 - Env Var: RCLONE_ONEDRIVE_EXPOSE_ONENOTE_FILES 30113 - Type: bool 30114 - Default: false 30115 30116 #### --onedrive-server-side-across-configs 30117 30118 Deprecated: use --server-side-across-configs instead. 30119 30120 Allow server-side operations (e.g. copy) to work across different onedrive configs. 30121 30122 This will only work if you are copying between two OneDrive *Personal* drives AND 30123 the files to copy are already shared between them. In other cases, rclone will 30124 fall back to normal copy (which will be slightly slower). 30125 30126 Properties: 30127 30128 - Config: server_side_across_configs 30129 - Env Var: RCLONE_ONEDRIVE_SERVER_SIDE_ACROSS_CONFIGS 30130 - Type: bool 30131 - Default: false 30132 30133 #### --onedrive-list-chunk 30134 30135 Size of listing chunk. 30136 30137 Properties: 30138 30139 - Config: list_chunk 30140 - Env Var: RCLONE_ONEDRIVE_LIST_CHUNK 30141 - Type: int 30142 - Default: 1000 30143 30144 #### --onedrive-no-versions 30145 30146 Remove all versions on modifying operations. 30147 30148 Onedrive for business creates versions when rclone uploads new files 30149 overwriting an existing one and when it sets the modification time. 30150 30151 These versions take up space out of the quota. 30152 30153 This flag checks for versions after file upload and setting 30154 modification time and removes all but the last version. 30155 30156 **NB** Onedrive personal can't currently delete versions so don't use 30157 this flag there. 30158 30159 30160 Properties: 30161 30162 - Config: no_versions 30163 - Env Var: RCLONE_ONEDRIVE_NO_VERSIONS 30164 - Type: bool 30165 - Default: false 30166 30167 #### --onedrive-link-scope 30168 30169 Set the scope of the links created by the link command. 30170 30171 Properties: 30172 30173 - Config: link_scope 30174 - Env Var: RCLONE_ONEDRIVE_LINK_SCOPE 30175 - Type: string 30176 - Default: "anonymous" 30177 - Examples: 30178 - "anonymous" 30179 - Anyone with the link has access, without needing to sign in. 30180 - This may include people outside of your organization. 30181 - Anonymous link support may be disabled by an administrator. 30182 - "organization" 30183 - Anyone signed into your organization (tenant) can use the link to get access. 30184 - Only available in OneDrive for Business and SharePoint. 30185 30186 #### --onedrive-link-type 30187 30188 Set the type of the links created by the link command. 30189 30190 Properties: 30191 30192 - Config: link_type 30193 - Env Var: RCLONE_ONEDRIVE_LINK_TYPE 30194 - Type: string 30195 - Default: "view" 30196 - Examples: 30197 - "view" 30198 - Creates a read-only link to the item. 30199 - "edit" 30200 - Creates a read-write link to the item. 30201 - "embed" 30202 - Creates an embeddable link to the item. 30203 30204 #### --onedrive-link-password 30205 30206 Set the password for links created by the link command. 30207 30208 At the time of writing this only works with OneDrive personal paid accounts. 30209 30210 30211 Properties: 30212 30213 - Config: link_password 30214 - Env Var: RCLONE_ONEDRIVE_LINK_PASSWORD 30215 - Type: string 30216 - Required: false 30217 30218 #### --onedrive-hash-type 30219 30220 Specify the hash in use for the backend. 30221 30222 This specifies the hash type in use. If set to "auto" it will use the 30223 default hash which is QuickXorHash. 30224 30225 Before rclone 1.62 an SHA1 hash was used by default for Onedrive 30226 Personal. For 1.62 and later the default is to use a QuickXorHash for 30227 all onedrive types. If an SHA1 hash is desired then set this option 30228 accordingly. 30229 30230 From July 2023 QuickXorHash will be the only available hash for 30231 both OneDrive for Business and OneDriver Personal. 30232 30233 This can be set to "none" to not use any hashes. 30234 30235 If the hash requested does not exist on the object, it will be 30236 returned as an empty string which is treated as a missing hash by 30237 rclone. 30238 30239 30240 Properties: 30241 30242 - Config: hash_type 30243 - Env Var: RCLONE_ONEDRIVE_HASH_TYPE 30244 - Type: string 30245 - Default: "auto" 30246 - Examples: 30247 - "auto" 30248 - Rclone chooses the best hash 30249 - "quickxor" 30250 - QuickXor 30251 - "sha1" 30252 - SHA1 30253 - "sha256" 30254 - SHA256 30255 - "crc32" 30256 - CRC32 30257 - "none" 30258 - None - don't use any hashes 30259 30260 #### --onedrive-av-override 30261 30262 Allows download of files the server thinks has a virus. 30263 30264 The onedrive/sharepoint server may check files uploaded with an Anti 30265 Virus checker. If it detects any potential viruses or malware it will 30266 block download of the file. 30267 30268 In this case you will see a message like this 30269 30270 server reports this file is infected with a virus - use --onedrive-av-override to download anyway: Infected (name of virus): 403 Forbidden: 30271 30272 If you are 100% sure you want to download this file anyway then use 30273 the --onedrive-av-override flag, or av_override = true in the config 30274 file. 30275 30276 30277 Properties: 30278 30279 - Config: av_override 30280 - Env Var: RCLONE_ONEDRIVE_AV_OVERRIDE 30281 - Type: bool 30282 - Default: false 30283 30284 #### --onedrive-delta 30285 30286 If set rclone will use delta listing to implement recursive listings. 30287 30288 If this flag is set the onedrive backend will advertise `ListR` 30289 support for recursive listings. 30290 30291 Setting this flag speeds up these things greatly: 30292 30293 rclone lsf -R onedrive: 30294 rclone size onedrive: 30295 rclone rc vfs/refresh recursive=true 30296 30297 **However** the delta listing API **only** works at the root of the 30298 drive. If you use it not at the root then it recurses from the root 30299 and discards all the data that is not under the directory you asked 30300 for. So it will be correct but may not be very efficient. 30301 30302 This is why this flag is not set as the default. 30303 30304 As a rule of thumb if nearly all of your data is under rclone's root 30305 directory (the `root/directory` in `onedrive:root/directory`) then 30306 using this flag will be be a big performance win. If your data is 30307 mostly not under the root then using this flag will be a big 30308 performance loss. 30309 30310 It is recommended if you are mounting your onedrive at the root 30311 (or near the root when using crypt) and using rclone `rc vfs/refresh`. 30312 30313 30314 Properties: 30315 30316 - Config: delta 30317 - Env Var: RCLONE_ONEDRIVE_DELTA 30318 - Type: bool 30319 - Default: false 30320 30321 #### --onedrive-metadata-permissions 30322 30323 Control whether permissions should be read or written in metadata. 30324 30325 Reading permissions metadata from files can be done quickly, but it 30326 isn't always desirable to set the permissions from the metadata. 30327 30328 30329 Properties: 30330 30331 - Config: metadata_permissions 30332 - Env Var: RCLONE_ONEDRIVE_METADATA_PERMISSIONS 30333 - Type: Bits 30334 - Default: off 30335 - Examples: 30336 - "off" 30337 - Do not read or write the value 30338 - "read" 30339 - Read the value only 30340 - "write" 30341 - Write the value only 30342 - "read,write" 30343 - Read and Write the value. 30344 30345 #### --onedrive-encoding 30346 30347 The encoding for the backend. 30348 30349 See the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. 30350 30351 Properties: 30352 30353 - Config: encoding 30354 - Env Var: RCLONE_ONEDRIVE_ENCODING 30355 - Type: Encoding 30356 - Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot 30357 30358 #### --onedrive-description 30359 30360 Description of the remote 30361 30362 Properties: 30363 30364 - Config: description 30365 - Env Var: RCLONE_ONEDRIVE_DESCRIPTION 30366 - Type: string 30367 - Required: false 30368 30369 ### Metadata 30370 30371 OneDrive supports System Metadata (not User Metadata, as of this writing) for 30372 both files and directories. Much of the metadata is read-only, and there are some 30373 differences between OneDrive Personal and Business (see table below for 30374 details). 30375 30376 Permissions are also supported, if `--onedrive-metadata-permissions` is set. The 30377 accepted values for `--onedrive-metadata-permissions` are `read`, `write`, 30378 `read,write`, and `off` (the default). `write` supports adding new permissions, 30379 updating the "role" of existing permissions, and removing permissions. Updating 30380 and removing require the Permission ID to be known, so it is recommended to use 30381 `read,write` instead of `write` if you wish to update/remove permissions. 30382 30383 Permissions are read/written in JSON format using the same schema as the 30384 [OneDrive API](https://learn.microsoft.com/en-us/onedrive/developer/rest-api/resources/permission?view=odsp-graph-online), 30385 which differs slightly between OneDrive Personal and Business. 30386 30387 Example for OneDrive Personal: 30388 ```json 30389 [ 30390 { 30391 "id": "1234567890ABC!123", 30392 "grantedTo": { 30393 "user": { 30394 "id": "ryan@contoso.com" 30395 }, 30396 "application": {}, 30397 "device": {} 30398 }, 30399 "invitation": { 30400 "email": "ryan@contoso.com" 30401 }, 30402 "link": { 30403 "webUrl": "https://1drv.ms/t/s!1234567890ABC" 30404 }, 30405 "roles": [ 30406 "read" 30407 ], 30408 "shareId": "s!1234567890ABC" 30409 } 30410 ]</code></pre> 30411 <p>Example for OneDrive Business:</p> 30412 <div class="sourceCode" id="cb1034"><pre class="sourceCode json"><code class="sourceCode json"><span id="cb1034-1"><a href="#cb1034-1" aria-hidden="true"></a><span class="ot">[</span></span> 30413 <span id="cb1034-2"><a href="#cb1034-2" aria-hidden="true"></a> <span class="fu">{</span></span> 30414 <span id="cb1034-3"><a href="#cb1034-3" aria-hidden="true"></a> <span class="dt">"id"</span><span class="fu">:</span> <span class="st">"48d31887-5fad-4d73-a9f5-3c356e68a038"</span><span class="fu">,</span></span> 30415 <span id="cb1034-4"><a href="#cb1034-4" aria-hidden="true"></a> <span class="dt">"grantedToIdentities"</span><span class="fu">:</span> <span class="ot">[</span></span> 30416 <span id="cb1034-5"><a href="#cb1034-5" aria-hidden="true"></a> <span class="fu">{</span></span> 30417 <span id="cb1034-6"><a href="#cb1034-6" aria-hidden="true"></a> <span class="dt">"user"</span><span class="fu">:</span> <span class="fu">{</span></span> 30418 <span id="cb1034-7"><a href="#cb1034-7" aria-hidden="true"></a> <span class="dt">"displayName"</span><span class="fu">:</span> <span class="st">"ryan@contoso.com"</span></span> 30419 <span id="cb1034-8"><a href="#cb1034-8" aria-hidden="true"></a> <span class="fu">},</span></span> 30420 <span id="cb1034-9"><a href="#cb1034-9" aria-hidden="true"></a> <span class="dt">"application"</span><span class="fu">:</span> <span class="fu">{},</span></span> 30421 <span id="cb1034-10"><a href="#cb1034-10" aria-hidden="true"></a> <span class="dt">"device"</span><span class="fu">:</span> <span class="fu">{}</span></span> 30422 <span id="cb1034-11"><a href="#cb1034-11" aria-hidden="true"></a> <span class="fu">}</span></span> 30423 <span id="cb1034-12"><a href="#cb1034-12" aria-hidden="true"></a> <span class="ot">]</span><span class="fu">,</span></span> 30424 <span id="cb1034-13"><a href="#cb1034-13" aria-hidden="true"></a> <span class="dt">"link"</span><span class="fu">:</span> <span class="fu">{</span></span> 30425 <span id="cb1034-14"><a href="#cb1034-14" aria-hidden="true"></a> <span class="dt">"type"</span><span class="fu">:</span> <span class="st">"view"</span><span class="fu">,</span></span> 30426 <span id="cb1034-15"><a href="#cb1034-15" aria-hidden="true"></a> <span class="dt">"scope"</span><span class="fu">:</span> <span class="st">"users"</span><span class="fu">,</span></span> 30427 <span id="cb1034-16"><a href="#cb1034-16" aria-hidden="true"></a> <span class="dt">"webUrl"</span><span class="fu">:</span> <span class="st">"https://contoso.sharepoint.com/:w:/t/design/a577ghg9hgh737613bmbjf839026561fmzhsr85ng9f3hjck2t5s"</span></span> 30428 <span id="cb1034-17"><a href="#cb1034-17" aria-hidden="true"></a> <span class="fu">},</span></span> 30429 <span id="cb1034-18"><a href="#cb1034-18" aria-hidden="true"></a> <span class="dt">"roles"</span><span class="fu">:</span> <span class="ot">[</span></span> 30430 <span id="cb1034-19"><a href="#cb1034-19" aria-hidden="true"></a> <span class="st">"read"</span></span> 30431 <span id="cb1034-20"><a href="#cb1034-20" aria-hidden="true"></a> <span class="ot">]</span><span class="fu">,</span></span> 30432 <span id="cb1034-21"><a href="#cb1034-21" aria-hidden="true"></a> <span class="dt">"shareId"</span><span class="fu">:</span> <span class="st">"u!LKj1lkdlals90j1nlkascl"</span></span> 30433 <span id="cb1034-22"><a href="#cb1034-22" aria-hidden="true"></a> <span class="fu">}</span><span class="ot">,</span></span> 30434 <span id="cb1034-23"><a href="#cb1034-23" aria-hidden="true"></a> <span class="fu">{</span></span> 30435 <span id="cb1034-24"><a href="#cb1034-24" aria-hidden="true"></a> <span class="dt">"id"</span><span class="fu">:</span> <span class="st">"5D33DD65C6932946"</span><span class="fu">,</span></span> 30436 <span id="cb1034-25"><a href="#cb1034-25" aria-hidden="true"></a> <span class="dt">"grantedTo"</span><span class="fu">:</span> <span class="fu">{</span></span> 30437 <span id="cb1034-26"><a href="#cb1034-26" aria-hidden="true"></a> <span class="dt">"user"</span><span class="fu">:</span> <span class="fu">{</span></span> 30438 <span id="cb1034-27"><a href="#cb1034-27" aria-hidden="true"></a> <span class="dt">"displayName"</span><span class="fu">:</span> <span class="st">"John Doe"</span><span class="fu">,</span></span> 30439 <span id="cb1034-28"><a href="#cb1034-28" aria-hidden="true"></a> <span class="dt">"id"</span><span class="fu">:</span> <span class="st">"efee1b77-fb3b-4f65-99d6-274c11914d12"</span></span> 30440 <span id="cb1034-29"><a href="#cb1034-29" aria-hidden="true"></a> <span class="fu">},</span></span> 30441 <span id="cb1034-30"><a href="#cb1034-30" aria-hidden="true"></a> <span class="dt">"application"</span><span class="fu">:</span> <span class="fu">{},</span></span> 30442 <span id="cb1034-31"><a href="#cb1034-31" aria-hidden="true"></a> <span class="dt">"device"</span><span class="fu">:</span> <span class="fu">{}</span></span> 30443 <span id="cb1034-32"><a href="#cb1034-32" aria-hidden="true"></a> <span class="fu">},</span></span> 30444 <span id="cb1034-33"><a href="#cb1034-33" aria-hidden="true"></a> <span class="dt">"roles"</span><span class="fu">:</span> <span class="ot">[</span></span> 30445 <span id="cb1034-34"><a href="#cb1034-34" aria-hidden="true"></a> <span class="st">"owner"</span></span> 30446 <span id="cb1034-35"><a href="#cb1034-35" aria-hidden="true"></a> <span class="ot">]</span><span class="fu">,</span></span> 30447 <span id="cb1034-36"><a href="#cb1034-36" aria-hidden="true"></a> <span class="dt">"shareId"</span><span class="fu">:</span> <span class="st">"FWxc1lasfdbEAGM5fI7B67aB5ZMPDMmQ11U"</span></span> 30448 <span id="cb1034-37"><a href="#cb1034-37" aria-hidden="true"></a> <span class="fu">}</span></span> 30449 <span id="cb1034-38"><a href="#cb1034-38" aria-hidden="true"></a><span class="ot">]</span></span></code></pre></div> 30450 <p>To write permissions, pass in a "permissions" metadata key using this same format. The <a href="https://rclone.org/docs/#metadata-mapper"><code>--metadata-mapper</code></a> tool can be very helpful for this.</p> 30451 <p>When adding permissions, an email address can be provided in the <code>User.ID</code> or <code>DisplayName</code> properties of <code>grantedTo</code> or <code>grantedToIdentities</code>. Alternatively, an ObjectID can be provided in <code>User.ID</code>. At least one valid recipient must be provided in order to add a permission for a user. Creating a Public Link is also supported, if <code>Link.Scope</code> is set to <code>"anonymous"</code>.</p> 30452 <p>Example request to add a "read" permission:</p> 30453 <div class="sourceCode" id="cb1035"><pre class="sourceCode json"><code class="sourceCode json"><span id="cb1035-1"><a href="#cb1035-1" aria-hidden="true"></a><span class="ot">[</span></span> 30454 <span id="cb1035-2"><a href="#cb1035-2" aria-hidden="true"></a> <span class="fu">{</span></span> 30455 <span id="cb1035-3"><a href="#cb1035-3" aria-hidden="true"></a> <span class="dt">"id"</span><span class="fu">:</span> <span class="st">""</span><span class="fu">,</span></span> 30456 <span id="cb1035-4"><a href="#cb1035-4" aria-hidden="true"></a> <span class="dt">"grantedTo"</span><span class="fu">:</span> <span class="fu">{</span></span> 30457 <span id="cb1035-5"><a href="#cb1035-5" aria-hidden="true"></a> <span class="dt">"user"</span><span class="fu">:</span> <span class="fu">{},</span></span> 30458 <span id="cb1035-6"><a href="#cb1035-6" aria-hidden="true"></a> <span class="dt">"application"</span><span class="fu">:</span> <span class="fu">{},</span></span> 30459 <span id="cb1035-7"><a href="#cb1035-7" aria-hidden="true"></a> <span class="dt">"device"</span><span class="fu">:</span> <span class="fu">{}</span></span> 30460 <span id="cb1035-8"><a href="#cb1035-8" aria-hidden="true"></a> <span class="fu">},</span></span> 30461 <span id="cb1035-9"><a href="#cb1035-9" aria-hidden="true"></a> <span class="dt">"grantedToIdentities"</span><span class="fu">:</span> <span class="ot">[</span></span> 30462 <span id="cb1035-10"><a href="#cb1035-10" aria-hidden="true"></a> <span class="fu">{</span></span> 30463 <span id="cb1035-11"><a href="#cb1035-11" aria-hidden="true"></a> <span class="dt">"user"</span><span class="fu">:</span> <span class="fu">{</span></span> 30464 <span id="cb1035-12"><a href="#cb1035-12" aria-hidden="true"></a> <span class="dt">"id"</span><span class="fu">:</span> <span class="st">"ryan@contoso.com"</span></span> 30465 <span id="cb1035-13"><a href="#cb1035-13" aria-hidden="true"></a> <span class="fu">},</span></span> 30466 <span id="cb1035-14"><a href="#cb1035-14" aria-hidden="true"></a> <span class="dt">"application"</span><span class="fu">:</span> <span class="fu">{},</span></span> 30467 <span id="cb1035-15"><a href="#cb1035-15" aria-hidden="true"></a> <span class="dt">"device"</span><span class="fu">:</span> <span class="fu">{}</span></span> 30468 <span id="cb1035-16"><a href="#cb1035-16" aria-hidden="true"></a> <span class="fu">}</span></span> 30469 <span id="cb1035-17"><a href="#cb1035-17" aria-hidden="true"></a> <span class="ot">]</span><span class="fu">,</span></span> 30470 <span id="cb1035-18"><a href="#cb1035-18" aria-hidden="true"></a> <span class="dt">"roles"</span><span class="fu">:</span> <span class="ot">[</span></span> 30471 <span id="cb1035-19"><a href="#cb1035-19" aria-hidden="true"></a> <span class="st">"read"</span></span> 30472 <span id="cb1035-20"><a href="#cb1035-20" aria-hidden="true"></a> <span class="ot">]</span></span> 30473 <span id="cb1035-21"><a href="#cb1035-21" aria-hidden="true"></a> <span class="fu">}</span></span> 30474 <span id="cb1035-22"><a href="#cb1035-22" aria-hidden="true"></a><span class="ot">]</span></span></code></pre></div> 30475 <p>Note that adding a permission can fail if a conflicting permission already exists for the file/folder.</p> 30476 <p>To update an existing permission, include both the Permission ID and the new <code>roles</code> to be assigned. <code>roles</code> is the only property that can be changed.</p> 30477 <p>To remove permissions, pass in a blob containing only the permissions you wish to keep (which can be empty, to remove all.)</p> 30478 <p>Note that both reading and writing permissions requires extra API calls, so if you don't need to read or write permissions it is recommended to omit <code>--onedrive-metadata-permissions</code>.</p> 30479 <p>Metadata and permissions are supported for Folders (directories) as well as Files. Note that setting the <code>mtime</code> or <code>btime</code> on a Folder requires one extra API call on OneDrive Business only.</p> 30480 <p>OneDrive does not currently support User Metadata. When writing metadata, only writeable system properties will be written -- any read-only or unrecognized keys passed in will be ignored.</p> 30481 <p>TIP: to see the metadata and permissions for any file or folder, run:</p> 30482 <pre><code>rclone lsjson remote:path --stat -M --onedrive-metadata-permissions read</code></pre> 30483 <p>Here are the possible system metadata items for the onedrive backend.</p> 30484 <table> 30485 <colgroup> 30486 <col style="width: 15%" /> 30487 <col style="width: 15%" /> 30488 <col style="width: 15%" /> 30489 <col style="width: 23%" /> 30490 <col style="width: 28%" /> 30491 </colgroup> 30492 <thead> 30493 <tr class="header"> 30494 <th>Name</th> 30495 <th>Help</th> 30496 <th>Type</th> 30497 <th>Example</th> 30498 <th>Read Only</th> 30499 </tr> 30500 </thead> 30501 <tbody> 30502 <tr class="odd"> 30503 <td>btime</td> 30504 <td>Time of file birth (creation) with S accuracy (mS for OneDrive Personal).</td> 30505 <td>RFC 3339</td> 30506 <td>2006-01-02T15:04:05Z</td> 30507 <td>N</td> 30508 </tr> 30509 <tr class="even"> 30510 <td>content-type</td> 30511 <td>The MIME type of the file.</td> 30512 <td>string</td> 30513 <td>text/plain</td> 30514 <td><strong>Y</strong></td> 30515 </tr> 30516 <tr class="odd"> 30517 <td>created-by-display-name</td> 30518 <td>Display name of the user that created the item.</td> 30519 <td>string</td> 30520 <td>John Doe</td> 30521 <td><strong>Y</strong></td> 30522 </tr> 30523 <tr class="even"> 30524 <td>created-by-id</td> 30525 <td>ID of the user that created the item.</td> 30526 <td>string</td> 30527 <td>48d31887-5fad-4d73-a9f5-3c356e68a038</td> 30528 <td><strong>Y</strong></td> 30529 </tr> 30530 <tr class="odd"> 30531 <td>description</td> 30532 <td>A short description of the file. Max 1024 characters. Only supported for OneDrive Personal.</td> 30533 <td>string</td> 30534 <td>Contract for signing</td> 30535 <td>N</td> 30536 </tr> 30537 <tr class="even"> 30538 <td>id</td> 30539 <td>The unique identifier of the item within OneDrive.</td> 30540 <td>string</td> 30541 <td>01BYE5RZ6QN3ZWBTUFOFD3GSPGOHDJD36K</td> 30542 <td><strong>Y</strong></td> 30543 </tr> 30544 <tr class="odd"> 30545 <td>last-modified-by-display-name</td> 30546 <td>Display name of the user that last modified the item.</td> 30547 <td>string</td> 30548 <td>John Doe</td> 30549 <td><strong>Y</strong></td> 30550 </tr> 30551 <tr class="even"> 30552 <td>last-modified-by-id</td> 30553 <td>ID of the user that last modified the item.</td> 30554 <td>string</td> 30555 <td>48d31887-5fad-4d73-a9f5-3c356e68a038</td> 30556 <td><strong>Y</strong></td> 30557 </tr> 30558 <tr class="odd"> 30559 <td>malware-detected</td> 30560 <td>Whether OneDrive has detected that the item contains malware.</td> 30561 <td>boolean</td> 30562 <td>true</td> 30563 <td><strong>Y</strong></td> 30564 </tr> 30565 <tr class="even"> 30566 <td>mtime</td> 30567 <td>Time of last modification with S accuracy (mS for OneDrive Personal).</td> 30568 <td>RFC 3339</td> 30569 <td>2006-01-02T15:04:05Z</td> 30570 <td>N</td> 30571 </tr> 30572 <tr class="odd"> 30573 <td>package-type</td> 30574 <td>If present, indicates that this item is a package instead of a folder or file. Packages are treated like files in some contexts and folders in others.</td> 30575 <td>string</td> 30576 <td>oneNote</td> 30577 <td><strong>Y</strong></td> 30578 </tr> 30579 <tr class="even"> 30580 <td>permissions</td> 30581 <td>Permissions in a JSON dump of OneDrive format. Enable with --onedrive-metadata-permissions. Properties: id, grantedTo, grantedToIdentities, invitation, inheritedFrom, link, roles, shareId</td> 30582 <td>JSON</td> 30583 <td>{}</td> 30584 <td>N</td> 30585 </tr> 30586 <tr class="odd"> 30587 <td>shared-by-id</td> 30588 <td>ID of the user that shared the item (if shared).</td> 30589 <td>string</td> 30590 <td>48d31887-5fad-4d73-a9f5-3c356e68a038</td> 30591 <td><strong>Y</strong></td> 30592 </tr> 30593 <tr class="even"> 30594 <td>shared-owner-id</td> 30595 <td>ID of the owner of the shared item (if shared).</td> 30596 <td>string</td> 30597 <td>48d31887-5fad-4d73-a9f5-3c356e68a038</td> 30598 <td><strong>Y</strong></td> 30599 </tr> 30600 <tr class="odd"> 30601 <td>shared-scope</td> 30602 <td>If shared, indicates the scope of how the item is shared: anonymous, organization, or users.</td> 30603 <td>string</td> 30604 <td>users</td> 30605 <td><strong>Y</strong></td> 30606 </tr> 30607 <tr class="even"> 30608 <td>shared-time</td> 30609 <td>Time when the item was shared, with S accuracy (mS for OneDrive Personal).</td> 30610 <td>RFC 3339</td> 30611 <td>2006-01-02T15:04:05Z</td> 30612 <td><strong>Y</strong></td> 30613 </tr> 30614 <tr class="odd"> 30615 <td>utime</td> 30616 <td>Time of upload with S accuracy (mS for OneDrive Personal).</td> 30617 <td>RFC 3339</td> 30618 <td>2006-01-02T15:04:05Z</td> 30619 <td><strong>Y</strong></td> 30620 </tr> 30621 </tbody> 30622 </table> 30623 <p>See the <a href="https://rclone.org/docs/#metadata">metadata</a> docs for more info.</p> 30624 <h2 id="limitations-7">Limitations</h2> 30625 <p>If you don't use rclone for 90 days the refresh token will expire. This will result in authorization problems. This is easy to fix by running the <code>rclone config reconnect remote:</code> command to get a new token and refresh token.</p> 30626 <h3 id="naming">Naming</h3> 30627 <p>Note that OneDrive is case insensitive so you can't have a file called "Hello.doc" and one called "hello.doc".</p> 30628 <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> 30629 <h3 id="file-sizes">File sizes</h3> 30630 <p>The largest allowed file size is 250 GiB for both OneDrive Personal and OneDrive for Business <a href="https://support.microsoft.com/en-us/office/invalid-file-names-and-file-types-in-onedrive-and-sharepoint-64883a5d-228e-48f5-b3d2-eb39e07630fa?ui=en-us&rs=en-us&ad=us#individualfilesize">(Updated 13 Jan 2021)</a>.</p> 30631 <h3 id="path-length">Path length</h3> 30632 <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> 30633 <h3 id="number-of-files">Number of files</h3> 30634 <p>OneDrive seems to be OK with at least 50,000 files in a folder, but at 100,000 rclone will get errors listing the directory like <code>couldn’t list files: UnknownError:</code>. See <a href="https://github.com/rclone/rclone/issues/2707">#2707</a> for more info.</p> 30635 <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> 30636 <h2 id="versions-1">Versions</h2> 30637 <p>Every change in a file OneDrive causes the service to create a new version of the file. This counts against a users quota. For example changing the modification time of a file creates a second version, so the file apparently uses twice the space.</p> 30638 <p>For example the <code>copy</code> command is affected by this as rclone copies the file and then afterwards sets the modification time to match the source file which uses another version.</p> 30639 <p>You can use the <code>rclone cleanup</code> command (see below) to remove all old versions.</p> 30640 <p>Or you can set the <code>no_versions</code> parameter to <code>true</code> and rclone will remove versions after operations which create new versions. This takes extra transactions so only enable it if you need it.</p> 30641 <p><strong>Note</strong> At the time of writing Onedrive Personal creates versions (but not for setting the modification time) but the API for removing them returns "API not found" so cleanup and <code>no_versions</code> should not be used on Onedrive Personal.</p> 30642 <h3 id="disabling-versioning">Disabling versioning</h3> 30643 <p>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> 30644 <ol type="1"> 30645 <li><code>Install-Module -Name Microsoft.Online.SharePoint.PowerShell</code> (in case you haven't installed this already)</li> 30646 <li><code>Import-Module Microsoft.Online.SharePoint.PowerShell -DisableNameChecking</code></li> 30647 <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> 30648 <li><code>Set-SPOTenant -EnableMinimumVersionRequirement $False</code></li> 30649 <li><code>Disconnect-SPOService</code> (to disconnect from the server)</li> 30650 </ol> 30651 <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> 30652 <p>User <a href="https://github.com/Weropol">Weropol</a> has found a method to disable versioning on OneDrive</p> 30653 <ol type="1"> 30654 <li>Open the settings menu by clicking on the gear symbol at the top of the OneDrive Business page.</li> 30655 <li>Click Site settings.</li> 30656 <li>Once on the Site settings page, navigate to Site Administration > Site libraries and lists.</li> 30657 <li>Click Customize "Documents".</li> 30658 <li>Click General Settings > Versioning Settings.</li> 30659 <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> 30660 <li>Apply the changes by clicking OK.</li> 30661 <li>Use rclone to upload or modify files. (I also use the --no-update-modtime flag)</li> 30662 <li>Restore the versioning settings after using rclone. (Optional)</li> 30663 </ol> 30664 <h2 id="cleanup-3">Cleanup</h2> 30665 <p>OneDrive supports <code>rclone cleanup</code> which causes rclone to look through every file under the path supplied and delete all version but the current version. Because this involves traversing all the files, then querying each file for versions it can be quite slow. Rclone does <code>--checkers</code> tests in parallel. The command also supports <code>--interactive</code>/<code>i</code> or <code>--dry-run</code> which is a great way to see what it would do.</p> 30666 <pre><code>rclone cleanup --interactive remote:path/subdir # interactively remove all old version for path/subdir 30667 rclone cleanup remote:path/subdir # unconditionally remove all old version for path/subdir</code></pre> 30668 <p><strong>NB</strong> Onedrive personal can't currently delete versions</p> 30669 <h2 id="troubleshooting-1">Troubleshooting</h2> 30670 <h3 id="excessive-throttling-or-blocked-on-sharepoint">Excessive throttling or blocked on SharePoint</h3> 30671 <p>If you experience excessive throttling or is being blocked on SharePoint then it may help to set the user agent explicitly with a flag like this: <code>--user-agent "ISV|rclone.org|rclone/v1.55.1"</code></p> 30672 <p>The specific details can be found in the Microsoft document: <a href="https://docs.microsoft.com/en-us/sharepoint/dev/general-development/how-to-avoid-getting-throttled-or-blocked-in-sharepoint-online#how-to-decorate-your-http-traffic-to-avoid-throttling">Avoid getting throttled or blocked in SharePoint Online</a></p> 30673 <h3 id="unexpected-file-sizehash-differences-on-sharepoint">Unexpected file size/hash differences on Sharepoint</h3> 30674 <p>It is a <a href="https://github.com/OneDrive/onedrive-api-docs/issues/935#issuecomment-441741631">known</a> issue that Sharepoint (not OneDrive or OneDrive for Business) silently modifies uploaded files, mainly Office files (.docx, .xlsx, etc.), causing file size and hash checks to fail. There are also other situations that will cause OneDrive to report inconsistent file sizes. To use rclone with such affected files on Sharepoint, you may disable these checks with the following command line arguments:</p> 30675 <pre><code>--ignore-checksum --ignore-size</code></pre> 30676 <p>Alternatively, if you have write access to the OneDrive files, it may be possible to fix this problem for certain files, by attempting the steps below. Open the web interface for <a href="https://onedrive.live.com">OneDrive</a> and find the affected files (which will be in the error messages/log for rclone). Simply click on each of these files, causing OneDrive to open them on the web. This will cause each file to be converted in place to a format that is functionally equivalent but which will no longer trigger the size discrepancy. Once all problematic files are converted you will no longer need the ignore options above.</p> 30677 <h3 id="replacingdeleting-existing-files-on-sharepoint-gets-item-not-found">Replacing/deleting existing files on Sharepoint gets "item not found"</h3> 30678 <p>It is a <a href="https://github.com/OneDrive/onedrive-api-docs/issues/1068">known</a> issue that Sharepoint (not OneDrive or OneDrive for Business) may return "item not found" errors when users try to replace or delete uploaded files; this seems to mainly affect Office files (.docx, .xlsx, etc.) and web files (.html, .aspx, etc.). As a workaround, you may use the <code>--backup-dir <BACKUP_DIR></code> command line argument so rclone moves the files to be replaced/deleted into a given backup directory (instead of directly replacing/deleting them). For example, to instruct rclone to move the files into the directory <code>rclone-backup-dir</code> on backend <code>mysharepoint</code>, you may use:</p> 30679 <pre><code>--backup-dir mysharepoint:rclone-backup-dir</code></pre> 30680 <h3 id="access_denied-aadsts65005">access_denied (AADSTS65005)</h3> 30681 <pre><code>Error: access_denied 30682 Code: AADSTS65005 30683 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> 30684 <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> 30685 <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> 30686 <h3 id="invalid_grant-aadsts50076">invalid_grant (AADSTS50076)</h3> 30687 <pre><code>Error: invalid_grant 30688 Code: AADSTS50076 30689 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> 30690 <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> 30691 <h3 id="invalid-request-when-making-public-links">Invalid request when making public links</h3> 30692 <p>On Sharepoint and OneDrive for Business, <code>rclone link</code> may return an "Invalid request" error. A possible cause is that the organisation admin didn't allow public links to be made for the organisation/sharepoint library. To fix the permissions as an admin, take a look at the docs: <a href="https://docs.microsoft.com/en-us/sharepoint/turn-external-sharing-on-or-off">1</a>, <a href="https://support.microsoft.com/en-us/office/set-up-and-manage-access-requests-94b26e0b-2822-49d4-929a-8455698654b3">2</a>.</p> 30693 <h3 id="can-not-access-shared-with-me-files">Can not access <code>Shared</code> with me files</h3> 30694 <p>Shared with me files is not supported by rclone <a href="https://github.com/rclone/rclone/issues/4062">currently</a>, but there is a workaround:</p> 30695 <ol type="1"> 30696 <li>Visit <a href="https://onedrive.live.com/">https://onedrive.live.com</a></li> 30697 <li>Right click a item in <code>Shared</code>, then click <code>Add shortcut to My files</code> in the context <img src="https://user-images.githubusercontent.com/60313789/206118040-7e762b3b-aa61-41a1-8649-cc18889f3572.png" title="Screenshot (Shared with me)" alt="make_shortcut" /></li> 30698 <li>The shortcut will appear in <code>My files</code>, you can access it with rclone, it behaves like a normal folder/file. <img src="https://i.imgur.com/0S8H3li.png" title="Screenshot (My Files)" alt="in_my_files" /> <img src="https://i.imgur.com/2Iq66sW.png" title="Screenshot (rclone mount)" alt="rclone_mount" /></li> 30699 </ol> 30700 <h3 id="live-photos-uploaded-from-ios-small-video-clips-in-.heic-files">Live Photos uploaded from iOS (small video clips in .heic files)</h3> 30701 <p>The iOS OneDrive app introduced <a href="https://techcommunity.microsoft.com/t5/microsoft-onedrive-blog/live-photos-come-to-onedrive/ba-p/1953452">upload and storage</a> of <a href="https://support.apple.com/en-gb/HT207310">Live Photos</a> in 2020. The usage and download of these uploaded Live Photos is unfortunately still work-in-progress and this introduces several issues when copying, synchronising and mounting – both in rclone and in the native OneDrive client on Windows.</p> 30702 <p>The root cause can easily be seen if you locate one of your Live Photos in the OneDrive web interface. Then download the photo from the web interface. You will then see that the size of downloaded .heic file is smaller than the size displayed in the web interface. The downloaded file is smaller because it only contains a single frame (still photo) extracted from the Live Photo (movie) stored in OneDrive.</p> 30703 <p>The different sizes will cause <code>rclone copy/sync</code> to repeatedly recopy unmodified photos something like this:</p> 30704 <pre><code>DEBUG : 20230203_123826234_iOS.heic: Sizes differ (src 4470314 vs dst 1298667) 30705 DEBUG : 20230203_123826234_iOS.heic: sha1 = fc2edde7863b7a7c93ca6771498ac797f8460750 OK 30706 INFO : 20230203_123826234_iOS.heic: Copied (replaced existing)</code></pre> 30707 <p>These recopies can be worked around by adding <code>--ignore-size</code>. Please note that this workaround only syncs the still-picture not the movie clip, and relies on modification dates being correctly updated on all files in all situations.</p> 30708 <p>The different sizes will also cause <code>rclone check</code> to report size errors something like this:</p> 30709 <pre><code>ERROR : 20230203_123826234_iOS.heic: sizes differ</code></pre> 30710 <p>These check errors can be suppressed by adding <code>--ignore-size</code>.</p> 30711 <p>The different sizes will also cause <code>rclone mount</code> to fail downloading with an error something like this:</p> 30712 <pre><code>ERROR : 20230203_123826234_iOS.heic: ReadFileHandle.Read error: low level retry 1/10: unexpected EOF</code></pre> 30713 <p>or like this when using <code>--cache-mode=full</code>:</p> 30714 <pre><code>INFO : 20230203_123826234_iOS.heic: vfs cache: downloader: error count now 1: vfs reader: failed to write to cache file: 416 Requested Range Not Satisfiable: 30715 ERROR : 20230203_123826234_iOS.heic: vfs cache: failed to download: vfs reader: failed to write to cache file: 416 Requested Range Not Satisfiable:</code></pre> 30716 <h1 id="opendrive">OpenDrive</h1> 30717 <p>Paths are specified as <code>remote:path</code></p> 30718 <p>Paths may be as deep as required, e.g. <code>remote:directory/subdirectory</code>.</p> 30719 <h2 id="configuration-3">Configuration</h2> 30720 <p>Here is an example of how to make a remote called <code>remote</code>. First run:</p> 30721 <pre><code> rclone config</code></pre> 30722 <p>This will guide you through an interactive setup process:</p> 30723 <pre><code>n) New remote 30724 d) Delete remote 30725 q) Quit config 30726 e/n/d/q> n 30727 name> remote 30728 Type of storage to configure. 30729 Choose a number from below, or type in your own value 30730 [snip] 30731 XX / OpenDrive 30732 \ "opendrive" 30733 [snip] 30734 Storage> opendrive 30735 Username 30736 username> 30737 Password 30738 y) Yes type in my own password 30739 g) Generate random password 30740 y/g> y 30741 Enter the password: 30742 password: 30743 Confirm the password: 30744 password: 30745 -------------------- 30746 [remote] 30747 username = 30748 password = *** ENCRYPTED *** 30749 -------------------- 30750 y) Yes this is OK 30751 e) Edit this remote 30752 d) Delete this remote 30753 y/e/d> y</code></pre> 30754 <p>List directories in top level of your OpenDrive</p> 30755 <pre><code>rclone lsd remote:</code></pre> 30756 <p>List all the files in your OpenDrive</p> 30757 <pre><code>rclone ls remote:</code></pre> 30758 <p>To copy a local directory to an OpenDrive directory called backup</p> 30759 <pre><code>rclone copy /home/source remote:backup</code></pre> 30760 <h3 id="modification-times-and-hashes-2">Modification times and hashes</h3> 30761 <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> 30762 <p>The MD5 hash algorithm is supported.</p> 30763 <h3 id="restricted-filename-characters-2">Restricted filename characters</h3> 30764 <table> 30765 <thead> 30766 <tr class="header"> 30767 <th>Character</th> 30768 <th style="text-align: center;">Value</th> 30769 <th style="text-align: center;">Replacement</th> 30770 </tr> 30771 </thead> 30772 <tbody> 30773 <tr class="odd"> 30774 <td>NUL</td> 30775 <td style="text-align: center;">0x00</td> 30776 <td style="text-align: center;">␀</td> 30777 </tr> 30778 <tr class="even"> 30779 <td>/</td> 30780 <td style="text-align: center;">0x2F</td> 30781 <td style="text-align: center;">／</td> 30782 </tr> 30783 <tr class="odd"> 30784 <td>"</td> 30785 <td style="text-align: center;">0x22</td> 30786 <td style="text-align: center;">＂</td> 30787 </tr> 30788 <tr class="even"> 30789 <td>*</td> 30790 <td style="text-align: center;">0x2A</td> 30791 <td style="text-align: center;">＊</td> 30792 </tr> 30793 <tr class="odd"> 30794 <td>:</td> 30795 <td style="text-align: center;">0x3A</td> 30796 <td style="text-align: center;">：</td> 30797 </tr> 30798 <tr class="even"> 30799 <td><</td> 30800 <td style="text-align: center;">0x3C</td> 30801 <td style="text-align: center;">＜</td> 30802 </tr> 30803 <tr class="odd"> 30804 <td>></td> 30805 <td style="text-align: center;">0x3E</td> 30806 <td style="text-align: center;">＞</td> 30807 </tr> 30808 <tr class="even"> 30809 <td>?</td> 30810 <td style="text-align: center;">0x3F</td> 30811 <td style="text-align: center;">？</td> 30812 </tr> 30813 <tr class="odd"> 30814 <td>\</td> 30815 <td style="text-align: center;">0x5C</td> 30816 <td style="text-align: center;">＼</td> 30817 </tr> 30818 <tr class="even"> 30819 <td>|</td> 30820 <td style="text-align: center;">0x7C</td> 30821 <td style="text-align: center;">｜</td> 30822 </tr> 30823 </tbody> 30824 </table> 30825 <p>File names can also not begin or end with the following characters. These only get replaced if they are the first or last character in the name:</p> 30826 <table> 30827 <thead> 30828 <tr class="header"> 30829 <th>Character</th> 30830 <th style="text-align: center;">Value</th> 30831 <th style="text-align: center;">Replacement</th> 30832 </tr> 30833 </thead> 30834 <tbody> 30835 <tr class="odd"> 30836 <td>SP</td> 30837 <td style="text-align: center;">0x20</td> 30838 <td style="text-align: center;">␠</td> 30839 </tr> 30840 <tr class="even"> 30841 <td>HT</td> 30842 <td style="text-align: center;">0x09</td> 30843 <td style="text-align: center;">␉</td> 30844 </tr> 30845 <tr class="odd"> 30846 <td>LF</td> 30847 <td style="text-align: center;">0x0A</td> 30848 <td style="text-align: center;">␊</td> 30849 </tr> 30850 <tr class="even"> 30851 <td>VT</td> 30852 <td style="text-align: center;">0x0B</td> 30853 <td style="text-align: center;">␋</td> 30854 </tr> 30855 <tr class="odd"> 30856 <td>CR</td> 30857 <td style="text-align: center;">0x0D</td> 30858 <td style="text-align: center;">␍</td> 30859 </tr> 30860 </tbody> 30861 </table> 30862 <p>Invalid UTF-8 bytes will also be <a href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they can't be used in JSON strings.</p> 30863 <h3 id="standard-options-3">Standard options</h3> 30864 <p>Here are the Standard options specific to opendrive (OpenDrive).</p> 30865 <h4 id="opendrive-username">--opendrive-username</h4> 30866 <p>Username.</p> 30867 <p>Properties:</p> 30868 <ul> 30869 <li>Config: username</li> 30870 <li>Env Var: RCLONE_OPENDRIVE_USERNAME</li> 30871 <li>Type: string</li> 30872 <li>Required: true</li> 30873 </ul> 30874 <h4 id="opendrive-password">--opendrive-password</h4> 30875 <p>Password.</p> 30876 <p><strong>NB</strong> Input to this must be obscured - see <a href="https://rclone.org/commands/rclone_obscure/">rclone obscure</a>.</p> 30877 <p>Properties:</p> 30878 <ul> 30879 <li>Config: password</li> 30880 <li>Env Var: RCLONE_OPENDRIVE_PASSWORD</li> 30881 <li>Type: string</li> 30882 <li>Required: true</li> 30883 </ul> 30884 <h3 id="advanced-options-3">Advanced options</h3> 30885 <p>Here are the Advanced options specific to opendrive (OpenDrive).</p> 30886 <h4 id="opendrive-encoding">--opendrive-encoding</h4> 30887 <p>The encoding for the backend.</p> 30888 <p>See the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 30889 <p>Properties:</p> 30890 <ul> 30891 <li>Config: encoding</li> 30892 <li>Env Var: RCLONE_OPENDRIVE_ENCODING</li> 30893 <li>Type: Encoding</li> 30894 <li>Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,LeftSpace,LeftCrLfHtVt,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot</li> 30895 </ul> 30896 <h4 id="opendrive-chunk-size">--opendrive-chunk-size</h4> 30897 <p>Files will be uploaded in chunks this size.</p> 30898 <p>Note that these chunks are buffered in memory so increasing them will increase memory use.</p> 30899 <p>Properties:</p> 30900 <ul> 30901 <li>Config: chunk_size</li> 30902 <li>Env Var: RCLONE_OPENDRIVE_CHUNK_SIZE</li> 30903 <li>Type: SizeSuffix</li> 30904 <li>Default: 10Mi</li> 30905 </ul> 30906 <h4 id="opendrive-description">--opendrive-description</h4> 30907 <p>Description of the remote</p> 30908 <p>Properties:</p> 30909 <ul> 30910 <li>Config: description</li> 30911 <li>Env Var: RCLONE_OPENDRIVE_DESCRIPTION</li> 30912 <li>Type: string</li> 30913 <li>Required: false</li> 30914 </ul> 30915 <h2 id="limitations-8">Limitations</h2> 30916 <p>Note that OpenDrive is case insensitive so you can't have a file called "Hello.doc" and one called "hello.doc".</p> 30917 <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> 30918 <p><code>rclone about</code> is not supported by the OpenDrive backend. Backends without this capability cannot determine free space for an rclone mount or use policy <code>mfs</code> (most free space) as a member of an rclone union remote.</p> 30919 <p>See <a href="https://rclone.org/overview/#optional-features">List of backends that do not support rclone about</a> and <a href="https://rclone.org/commands/rclone_about/">rclone about</a></p> 30920 <h1 id="oracle-object-storage">Oracle Object Storage</h1> 30921 <ul> 30922 <li><a href="https://docs.oracle.com/en-us/iaas/Content/Object/Concepts/objectstorageoverview.htm">Oracle Object Storage Overview</a></li> 30923 <li><a href="https://www.oracle.com/cloud/storage/object-storage/faq/">Oracle Object Storage FAQ</a></li> 30924 <li><a href="https://docs.oracle.com/en-us/iaas/Content/Resources/Assets/whitepapers/oci-object-storage-best-practices.pdf">Oracle Object Storage Limits</a></li> 30925 </ul> 30926 <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, e.g. <code>remote:bucket/path/to/dir</code>.</p> 30927 <p>Sample command to transfer local artifacts to remote:bucket in oracle object storage:</p> 30928 <p><code>rclone -vvv --progress --stats-one-line --max-stats-groups 10 --log-format date,time,UTC,longfile --fast-list --buffer-size 256Mi --oos-no-check-bucket --oos-upload-cutoff 10Mi --multi-thread-cutoff 16Mi --multi-thread-streams 3000 --transfers 3000 --checkers 64 --retries 2 --oos-chunk-size 10Mi --oos-upload-concurrency 10000 --oos-attempt-resume-upload --oos-leave-parts-on-error sync ./artifacts remote:bucket -vv</code></p> 30929 <h2 id="configuration-4">Configuration</h2> 30930 <p>Here is an example of making an oracle object storage configuration. <code>rclone config</code> walks you through it.</p> 30931 <p>Here is an example of how to make a remote called <code>remote</code>. First run:</p> 30932 <pre><code> rclone config</code></pre> 30933 <p>This will guide you through an interactive setup process:</p> 30934 <pre><code>n) New remote 30935 d) Delete remote 30936 r) Rename remote 30937 c) Copy remote 30938 s) Set configuration password 30939 q) Quit config 30940 e/n/d/r/c/s/q> n 30941 30942 Enter name for new remote. 30943 name> remote 30944 30945 Option Storage. 30946 Type of storage to configure. 30947 Choose a number from below, or type in your own value. 30948 [snip] 30949 XX / Oracle Cloud Infrastructure Object Storage 30950 \ (oracleobjectstorage) 30951 Storage> oracleobjectstorage 30952 30953 Option provider. 30954 Choose your Auth Provider 30955 Choose a number from below, or type in your own string value. 30956 Press Enter for the default (env_auth). 30957 1 / automatically pickup the credentials from runtime(env), first one to provide auth wins 30958 \ (env_auth) 30959 / use an OCI user and an API key for authentication. 30960 2 | you’ll need to put in a config file your tenancy OCID, user OCID, region, the path, fingerprint to an API key. 30961 | https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdkconfig.htm 30962 \ (user_principal_auth) 30963 / use instance principals to authorize an instance to make API calls. 30964 3 | each instance has its own identity, and authenticates using the certificates that are read from instance metadata. 30965 | https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/callingservicesfrominstances.htm 30966 \ (instance_principal_auth) 30967 / use workload identity to grant Kubernetes pods policy-driven access to Oracle Cloud 30968 4 | Infrastructure (OCI) resources using OCI Identity and Access Management (IAM). 30969 | https://docs.oracle.com/en-us/iaas/Content/ContEng/Tasks/contenggrantingworkloadaccesstoresources.htm 30970 \ (workload_identity_auth) 30971 5 / use resource principals to make API calls 30972 \ (resource_principal_auth) 30973 6 / no credentials needed, this is typically for reading public buckets 30974 \ (no_auth) 30975 provider> 2 30976 30977 Option namespace. 30978 Object storage namespace 30979 Enter a value. 30980 namespace> idbamagbg734 30981 30982 Option compartment. 30983 Object storage compartment OCID 30984 Enter a value. 30985 compartment> ocid1.compartment.oc1..aaaaaaaapufkxc7ame3sthry5i7ujrwfc7ejnthhu6bhanm5oqfjpyasjkba 30986 30987 Option region. 30988 Object storage Region 30989 Enter a value. 30990 region> us-ashburn-1 30991 30992 Option endpoint. 30993 Endpoint for Object storage API. 30994 Leave blank to use the default endpoint for the region. 30995 Enter a value. Press Enter to leave empty. 30996 endpoint> 30997 30998 Option config_file. 30999 Full Path to OCI config file 31000 Choose a number from below, or type in your own string value. 31001 Press Enter for the default (~/.oci/config). 31002 1 / oci configuration file location 31003 \ (~/.oci/config) 31004 config_file> /etc/oci/dev.conf 31005 31006 Option config_profile. 31007 Profile name inside OCI config file 31008 Choose a number from below, or type in your own string value. 31009 Press Enter for the default (Default). 31010 1 / Use the default profile 31011 \ (Default) 31012 config_profile> Test 31013 31014 Edit advanced config? 31015 y) Yes 31016 n) No (default) 31017 y/n> n 31018 31019 Configuration complete. 31020 Options: 31021 - type: oracleobjectstorage 31022 - namespace: idbamagbg734 31023 - compartment: ocid1.compartment.oc1..aaaaaaaapufkxc7ame3sthry5i7ujrwfc7ejnthhu6bhanm5oqfjpyasjkba 31024 - region: us-ashburn-1 31025 - provider: user_principal_auth 31026 - config_file: /etc/oci/dev.conf 31027 - config_profile: Test 31028 Keep this "remote" remote? 31029 y) Yes this is OK (default) 31030 e) Edit this remote 31031 d) Delete this remote 31032 y/e/d> y</code></pre> 31033 <p>See all buckets</p> 31034 <pre><code>rclone lsd remote:</code></pre> 31035 <p>Create a new bucket</p> 31036 <pre><code>rclone mkdir remote:bucket</code></pre> 31037 <p>List the contents of a bucket</p> 31038 <pre><code>rclone ls remote:bucket 31039 rclone ls remote:bucket --max-depth 1</code></pre> 31040 <h2 id="authentication-providers">Authentication Providers</h2> 31041 <p>OCI has various authentication methods. To learn more about authentication methods please refer <a href="https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdk_authentication_methods.htm">oci authentication methods</a> These choices can be specified in the rclone config file.</p> 31042 <p>Rclone supports the following OCI authentication provider.</p> 31043 <pre><code>User Principal 31044 Instance Principal 31045 Resource Principal 31046 Workload Identity 31047 No authentication</code></pre> 31048 <h3 id="user-principal">User Principal</h3> 31049 <p>Sample rclone config file for Authentication Provider User Principal:</p> 31050 <pre><code>[oos] 31051 type = oracleobjectstorage 31052 namespace = id<redacted>34 31053 compartment = ocid1.compartment.oc1..aa<redacted>ba 31054 region = us-ashburn-1 31055 provider = user_principal_auth 31056 config_file = /home/opc/.oci/config 31057 config_profile = Default</code></pre> 31058 <p>Advantages: - One can use this method from any server within OCI or on-premises or from other cloud provider.</p> 31059 <p>Considerations: - you need to configure user’s privileges / policy to allow access to object storage - Overhead of managing users and keys. - If the user is deleted, the config file will no longer work and may cause automation regressions that use the user's credentials.</p> 31060 <h3 id="instance-principal">Instance Principal</h3> 31061 <p>An OCI compute instance can be authorized to use rclone by using it's identity and certificates as an instance principal. With this approach no credentials have to be stored and managed.</p> 31062 <p>Sample rclone configuration file for Authentication Provider Instance Principal:</p> 31063 <pre><code>[opc@rclone ~]$ cat ~/.config/rclone/rclone.conf 31064 [oos] 31065 type = oracleobjectstorage 31066 namespace = id<redacted>fn 31067 compartment = ocid1.compartment.oc1..aa<redacted>k7a 31068 region = us-ashburn-1 31069 provider = instance_principal_auth</code></pre> 31070 <p>Advantages:</p> 31071 <ul> 31072 <li>With instance principals, you don't need to configure user credentials and transfer/ save it to disk in your compute instances or rotate the credentials.</li> 31073 <li>You don’t need to deal with users and keys.</li> 31074 <li>Greatly helps in automation as you don't have to manage access keys, user private keys, storing them in vault, using kms etc.</li> 31075 </ul> 31076 <p>Considerations:</p> 31077 <ul> 31078 <li>You need to configure a dynamic group having this instance as member and add policy to read object storage to that dynamic group.</li> 31079 <li>Everyone who has access to this machine can execute the CLI commands.</li> 31080 <li>It is applicable for oci compute instances only. It cannot be used on external instance or resources.</li> 31081 </ul> 31082 <h3 id="resource-principal">Resource Principal</h3> 31083 <p>Resource principal auth is very similar to instance principal auth but used for resources that are not compute instances such as <a href="https://docs.oracle.com/en-us/iaas/Content/Functions/Concepts/functionsoverview.htm">serverless functions</a>. To use resource principal ensure Rclone process is started with these environment variables set in its process.</p> 31084 <pre><code>export OCI_RESOURCE_PRINCIPAL_VERSION=2.2 31085 export OCI_RESOURCE_PRINCIPAL_REGION=us-ashburn-1 31086 export OCI_RESOURCE_PRINCIPAL_PRIVATE_PEM=/usr/share/model-server/key.pem 31087 export OCI_RESOURCE_PRINCIPAL_RPST=/usr/share/model-server/security_token</code></pre> 31088 <p>Sample rclone configuration file for Authentication Provider Resource Principal:</p> 31089 <pre><code>[oos] 31090 type = oracleobjectstorage 31091 namespace = id<redacted>34 31092 compartment = ocid1.compartment.oc1..aa<redacted>ba 31093 region = us-ashburn-1 31094 provider = resource_principal_auth</code></pre> 31095 <h3 id="workload-identity">Workload Identity</h3> 31096 <p>Workload Identity auth may be used when running Rclone from Kubernetes pod on a Container Engine for Kubernetes (OKE) cluster. For more details on configuring Workload Identity, see <a href="https://docs.oracle.com/en-us/iaas/Content/ContEng/Tasks/contenggrantingworkloadaccesstoresources.htm">Granting Workloads Access to OCI Resources</a>. To use workload identity, ensure Rclone is started with these environment variables set in its process.</p> 31097 <pre><code>export OCI_RESOURCE_PRINCIPAL_VERSION=2.2 31098 export OCI_RESOURCE_PRINCIPAL_REGION=us-ashburn-1</code></pre> 31099 <h3 id="no-authentication">No authentication</h3> 31100 <p>Public buckets do not require any authentication mechanism to read objects. Sample rclone configuration file for No authentication:</p> 31101 <pre><code>[oos] 31102 type = oracleobjectstorage 31103 namespace = id<redacted>34 31104 compartment = ocid1.compartment.oc1..aa<redacted>ba 31105 region = us-ashburn-1 31106 provider = no_auth</code></pre> 31107 <h3 id="modification-times-and-hashes-3">Modification times and hashes</h3> 31108 <p>The modification time is stored as metadata on the object as <code>opc-meta-mtime</code> as floating point since the epoch, accurate to 1 ns.</p> 31109 <p>If the modification time needs to be updated rclone will attempt to perform a server side copy to update the modification if the object can be copied in a single part. In the case the object is larger than 5Gb, the object will be uploaded rather than copied.</p> 31110 <p>Note that reading this from the object takes an additional <code>HEAD</code> request as the metadata isn't returned in object listings.</p> 31111 <p>The MD5 hash algorithm is supported.</p> 31112 <h3 id="multipart-uploads-1">Multipart uploads</h3> 31113 <p>rclone supports multipart uploads with OOS which means that it can upload files bigger than 5 GiB.</p> 31114 <p>Note that files uploaded <em>both</em> with multipart upload <em>and</em> through crypt remotes do not have MD5 sums.</p> 31115 <p>rclone switches from single part uploads to multipart uploads at the point specified by <code>--oos-upload-cutoff</code>. This can be a maximum of 5 GiB and a minimum of 0 (ie always upload multipart files).</p> 31116 <p>The chunk sizes used in the multipart upload are specified by <code>--oos-chunk-size</code> and the number of chunks uploaded concurrently is specified by <code>--oos-upload-concurrency</code>.</p> 31117 <p>Multipart uploads will use <code>--transfers</code> * <code>--oos-upload-concurrency</code> * <code>--oos-chunk-size</code> extra memory. Single part uploads to not use extra memory.</p> 31118 <p>Single part transfers can be faster than multipart transfers or slower depending on your latency from oos - the more latency, the more likely single part transfers will be faster.</p> 31119 <p>Increasing <code>--oos-upload-concurrency</code> will increase throughput (8 would be a sensible value) and increasing <code>--oos-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> 31120 <h3 id="standard-options-4">Standard options</h3> 31121 <p>Here are the Standard options specific to oracleobjectstorage (Oracle Cloud Infrastructure Object Storage).</p> 31122 <h4 id="oos-provider">--oos-provider</h4> 31123 <p>Choose your Auth Provider</p> 31124 <p>Properties:</p> 31125 <ul> 31126 <li>Config: provider</li> 31127 <li>Env Var: RCLONE_OOS_PROVIDER</li> 31128 <li>Type: string</li> 31129 <li>Default: "env_auth"</li> 31130 <li>Examples: 31131 <ul> 31132 <li>"env_auth" 31133 <ul> 31134 <li>automatically pickup the credentials from runtime(env), first one to provide auth wins</li> 31135 </ul></li> 31136 <li>"user_principal_auth" 31137 <ul> 31138 <li>use an OCI user and an API key for authentication.</li> 31139 <li>you’ll need to put in a config file your tenancy OCID, user OCID, region, the path, fingerprint to an API key.</li> 31140 <li>https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdkconfig.htm</li> 31141 </ul></li> 31142 <li>"instance_principal_auth" 31143 <ul> 31144 <li>use instance principals to authorize an instance to make API calls.</li> 31145 <li>each instance has its own identity, and authenticates using the certificates that are read from instance metadata.</li> 31146 <li>https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/callingservicesfrominstances.htm</li> 31147 </ul></li> 31148 <li>"workload_identity_auth" 31149 <ul> 31150 <li>use workload identity to grant OCI Container Engine for Kubernetes workloads policy-driven access to OCI resources using OCI Identity and Access Management (IAM).</li> 31151 <li>https://docs.oracle.com/en-us/iaas/Content/ContEng/Tasks/contenggrantingworkloadaccesstoresources.htm</li> 31152 </ul></li> 31153 <li>"resource_principal_auth" 31154 <ul> 31155 <li>use resource principals to make API calls</li> 31156 </ul></li> 31157 <li>"no_auth" 31158 <ul> 31159 <li>no credentials needed, this is typically for reading public buckets</li> 31160 </ul></li> 31161 </ul></li> 31162 </ul> 31163 <h4 id="oos-namespace">--oos-namespace</h4> 31164 <p>Object storage namespace</p> 31165 <p>Properties:</p> 31166 <ul> 31167 <li>Config: namespace</li> 31168 <li>Env Var: RCLONE_OOS_NAMESPACE</li> 31169 <li>Type: string</li> 31170 <li>Required: true</li> 31171 </ul> 31172 <h4 id="oos-compartment">--oos-compartment</h4> 31173 <p>Object storage compartment OCID</p> 31174 <p>Properties:</p> 31175 <ul> 31176 <li>Config: compartment</li> 31177 <li>Env Var: RCLONE_OOS_COMPARTMENT</li> 31178 <li>Provider: !no_auth</li> 31179 <li>Type: string</li> 31180 <li>Required: true</li> 31181 </ul> 31182 <h4 id="oos-region">--oos-region</h4> 31183 <p>Object storage Region</p> 31184 <p>Properties:</p> 31185 <ul> 31186 <li>Config: region</li> 31187 <li>Env Var: RCLONE_OOS_REGION</li> 31188 <li>Type: string</li> 31189 <li>Required: true</li> 31190 </ul> 31191 <h4 id="oos-endpoint">--oos-endpoint</h4> 31192 <p>Endpoint for Object storage API.</p> 31193 <p>Leave blank to use the default endpoint for the region.</p> 31194 <p>Properties:</p> 31195 <ul> 31196 <li>Config: endpoint</li> 31197 <li>Env Var: RCLONE_OOS_ENDPOINT</li> 31198 <li>Type: string</li> 31199 <li>Required: false</li> 31200 </ul> 31201 <h4 id="oos-config-file">--oos-config-file</h4> 31202 <p>Path to OCI config file</p> 31203 <p>Properties:</p> 31204 <ul> 31205 <li>Config: config_file</li> 31206 <li>Env Var: RCLONE_OOS_CONFIG_FILE</li> 31207 <li>Provider: user_principal_auth</li> 31208 <li>Type: string</li> 31209 <li>Default: "~/.oci/config"</li> 31210 <li>Examples: 31211 <ul> 31212 <li>"~/.oci/config" 31213 <ul> 31214 <li>oci configuration file location</li> 31215 </ul></li> 31216 </ul></li> 31217 </ul> 31218 <h4 id="oos-config-profile">--oos-config-profile</h4> 31219 <p>Profile name inside the oci config file</p> 31220 <p>Properties:</p> 31221 <ul> 31222 <li>Config: config_profile</li> 31223 <li>Env Var: RCLONE_OOS_CONFIG_PROFILE</li> 31224 <li>Provider: user_principal_auth</li> 31225 <li>Type: string</li> 31226 <li>Default: "Default"</li> 31227 <li>Examples: 31228 <ul> 31229 <li>"Default" 31230 <ul> 31231 <li>Use the default profile</li> 31232 </ul></li> 31233 </ul></li> 31234 </ul> 31235 <h3 id="advanced-options-4">Advanced options</h3> 31236 <p>Here are the Advanced options specific to oracleobjectstorage (Oracle Cloud Infrastructure Object Storage).</p> 31237 <h4 id="oos-storage-tier">--oos-storage-tier</h4> 31238 <p>The storage class to use when storing new objects in storage. https://docs.oracle.com/en-us/iaas/Content/Object/Concepts/understandingstoragetiers.htm</p> 31239 <p>Properties:</p> 31240 <ul> 31241 <li>Config: storage_tier</li> 31242 <li>Env Var: RCLONE_OOS_STORAGE_TIER</li> 31243 <li>Type: string</li> 31244 <li>Default: "Standard"</li> 31245 <li>Examples: 31246 <ul> 31247 <li>"Standard" 31248 <ul> 31249 <li>Standard storage tier, this is the default tier</li> 31250 </ul></li> 31251 <li>"InfrequentAccess" 31252 <ul> 31253 <li>InfrequentAccess storage tier</li> 31254 </ul></li> 31255 <li>"Archive" 31256 <ul> 31257 <li>Archive storage tier</li> 31258 </ul></li> 31259 </ul></li> 31260 </ul> 31261 <h4 id="oos-upload-cutoff">--oos-upload-cutoff</h4> 31262 <p>Cutoff for switching to chunked upload.</p> 31263 <p>Any files larger than this will be uploaded in chunks of chunk_size. The minimum is 0 and the maximum is 5 GiB.</p> 31264 <p>Properties:</p> 31265 <ul> 31266 <li>Config: upload_cutoff</li> 31267 <li>Env Var: RCLONE_OOS_UPLOAD_CUTOFF</li> 31268 <li>Type: SizeSuffix</li> 31269 <li>Default: 200Mi</li> 31270 </ul> 31271 <h4 id="oos-chunk-size">--oos-chunk-size</h4> 31272 <p>Chunk size to use for uploading.</p> 31273 <p>When uploading files larger than upload_cutoff or files with unknown size (e.g. from "rclone rcat" or uploaded with "rclone mount" they will be uploaded as multipart uploads using this chunk size.</p> 31274 <p>Note that "upload_concurrency" chunks of this size are buffered in memory per transfer.</p> 31275 <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> 31276 <p>Rclone will automatically increase the chunk size when uploading a large file of known size to stay below the 10,000 chunks limit.</p> 31277 <p>Files of unknown size are uploaded with the configured chunk_size. Since the default chunk size is 5 MiB and there can be at most 10,000 chunks, this means that by default the maximum size of a file you can stream upload is 48 GiB. If you wish to stream upload larger files then you will need to increase chunk_size.</p> 31278 <p>Increasing the chunk size decreases the accuracy of the progress statistics displayed with "-P" flag.</p> 31279 <p>Properties:</p> 31280 <ul> 31281 <li>Config: chunk_size</li> 31282 <li>Env Var: RCLONE_OOS_CHUNK_SIZE</li> 31283 <li>Type: SizeSuffix</li> 31284 <li>Default: 5Mi</li> 31285 </ul> 31286 <h4 id="oos-max-upload-parts">--oos-max-upload-parts</h4> 31287 <p>Maximum number of parts in a multipart upload.</p> 31288 <p>This option defines the maximum number of multipart chunks to use when doing a multipart upload.</p> 31289 <p>OCI has max parts limit of 10,000 chunks.</p> 31290 <p>Rclone will automatically increase the chunk size when uploading a large file of a known size to stay below this number of chunks limit.</p> 31291 <p>Properties:</p> 31292 <ul> 31293 <li>Config: max_upload_parts</li> 31294 <li>Env Var: RCLONE_OOS_MAX_UPLOAD_PARTS</li> 31295 <li>Type: int</li> 31296 <li>Default: 10000</li> 31297 </ul> 31298 <h4 id="oos-upload-concurrency">--oos-upload-concurrency</h4> 31299 <p>Concurrency for multipart uploads.</p> 31300 <p>This is the number of chunks of the same file that are uploaded concurrently.</p> 31301 <p>If you are uploading small numbers of large files over high-speed links and these uploads do not fully utilize your bandwidth, then increasing this may help to speed up the transfers.</p> 31302 <p>Properties:</p> 31303 <ul> 31304 <li>Config: upload_concurrency</li> 31305 <li>Env Var: RCLONE_OOS_UPLOAD_CONCURRENCY</li> 31306 <li>Type: int</li> 31307 <li>Default: 10</li> 31308 </ul> 31309 <h4 id="oos-copy-cutoff">--oos-copy-cutoff</h4> 31310 <p>Cutoff for switching to multipart copy.</p> 31311 <p>Any files larger than this that need to be server-side copied will be copied in chunks of this size.</p> 31312 <p>The minimum is 0 and the maximum is 5 GiB.</p> 31313 <p>Properties:</p> 31314 <ul> 31315 <li>Config: copy_cutoff</li> 31316 <li>Env Var: RCLONE_OOS_COPY_CUTOFF</li> 31317 <li>Type: SizeSuffix</li> 31318 <li>Default: 4.656Gi</li> 31319 </ul> 31320 <h4 id="oos-copy-timeout">--oos-copy-timeout</h4> 31321 <p>Timeout for copy.</p> 31322 <p>Copy is an asynchronous operation, specify timeout to wait for copy to succeed</p> 31323 <p>Properties:</p> 31324 <ul> 31325 <li>Config: copy_timeout</li> 31326 <li>Env Var: RCLONE_OOS_COPY_TIMEOUT</li> 31327 <li>Type: Duration</li> 31328 <li>Default: 1m0s</li> 31329 </ul> 31330 <h4 id="oos-disable-checksum">--oos-disable-checksum</h4> 31331 <p>Don't store MD5 checksum with object metadata.</p> 31332 <p>Normally rclone will calculate the MD5 checksum of the input before uploading it so it can add it to metadata on the object. This is great for data integrity checking but can cause long delays for large files to start uploading.</p> 31333 <p>Properties:</p> 31334 <ul> 31335 <li>Config: disable_checksum</li> 31336 <li>Env Var: RCLONE_OOS_DISABLE_CHECKSUM</li> 31337 <li>Type: bool</li> 31338 <li>Default: false</li> 31339 </ul> 31340 <h4 id="oos-encoding">--oos-encoding</h4> 31341 <p>The encoding for the backend.</p> 31342 <p>See the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 31343 <p>Properties:</p> 31344 <ul> 31345 <li>Config: encoding</li> 31346 <li>Env Var: RCLONE_OOS_ENCODING</li> 31347 <li>Type: Encoding</li> 31348 <li>Default: Slash,InvalidUtf8,Dot</li> 31349 </ul> 31350 <h4 id="oos-leave-parts-on-error">--oos-leave-parts-on-error</h4> 31351 <p>If true avoid calling abort upload on a failure, leaving all successfully uploaded parts for manual recovery.</p> 31352 <p>It should be set to true for resuming uploads across different sessions.</p> 31353 <p>WARNING: Storing parts of an incomplete multipart upload counts towards space usage on object storage and will add additional costs if not cleaned up.</p> 31354 <p>Properties:</p> 31355 <ul> 31356 <li>Config: leave_parts_on_error</li> 31357 <li>Env Var: RCLONE_OOS_LEAVE_PARTS_ON_ERROR</li> 31358 <li>Type: bool</li> 31359 <li>Default: false</li> 31360 </ul> 31361 <h4 id="oos-attempt-resume-upload">--oos-attempt-resume-upload</h4> 31362 <p>If true attempt to resume previously started multipart upload for the object. This will be helpful to speed up multipart transfers by resuming uploads from past session.</p> 31363 <p>WARNING: If chunk size differs in resumed session from past incomplete session, then the resumed multipart upload is aborted and a new multipart upload is started with the new chunk size.</p> 31364 <p>The flag leave_parts_on_error must be true to resume and optimize to skip parts that were already uploaded successfully.</p> 31365 <p>Properties:</p> 31366 <ul> 31367 <li>Config: attempt_resume_upload</li> 31368 <li>Env Var: RCLONE_OOS_ATTEMPT_RESUME_UPLOAD</li> 31369 <li>Type: bool</li> 31370 <li>Default: false</li> 31371 </ul> 31372 <h4 id="oos-no-check-bucket">--oos-no-check-bucket</h4> 31373 <p>If set, don't attempt to check the bucket exists or create it.</p> 31374 <p>This can be useful when trying to minimise the number of transactions rclone does if you know the bucket exists already.</p> 31375 <p>It can also be needed if the user you are using does not have bucket creation permissions.</p> 31376 <p>Properties:</p> 31377 <ul> 31378 <li>Config: no_check_bucket</li> 31379 <li>Env Var: RCLONE_OOS_NO_CHECK_BUCKET</li> 31380 <li>Type: bool</li> 31381 <li>Default: false</li> 31382 </ul> 31383 <h4 id="oos-sse-customer-key-file">--oos-sse-customer-key-file</h4> 31384 <p>To use SSE-C, a file containing the base64-encoded string of the AES-256 encryption key associated with the object. Please note only one of sse_customer_key_file|sse_customer_key|sse_kms_key_id is needed.'</p> 31385 <p>Properties:</p> 31386 <ul> 31387 <li>Config: sse_customer_key_file</li> 31388 <li>Env Var: RCLONE_OOS_SSE_CUSTOMER_KEY_FILE</li> 31389 <li>Type: string</li> 31390 <li>Required: false</li> 31391 <li>Examples: 31392 <ul> 31393 <li>"" 31394 <ul> 31395 <li>None</li> 31396 </ul></li> 31397 </ul></li> 31398 </ul> 31399 <h4 id="oos-sse-customer-key">--oos-sse-customer-key</h4> 31400 <p>To use SSE-C, the optional header that specifies the base64-encoded 256-bit encryption key to use to encrypt or decrypt the data. Please note only one of sse_customer_key_file|sse_customer_key|sse_kms_key_id is needed. For more information, see Using Your Own Keys for Server-Side Encryption (https://docs.cloud.oracle.com/Content/Object/Tasks/usingyourencryptionkeys.htm)</p> 31401 <p>Properties:</p> 31402 <ul> 31403 <li>Config: sse_customer_key</li> 31404 <li>Env Var: RCLONE_OOS_SSE_CUSTOMER_KEY</li> 31405 <li>Type: string</li> 31406 <li>Required: false</li> 31407 <li>Examples: 31408 <ul> 31409 <li>"" 31410 <ul> 31411 <li>None</li> 31412 </ul></li> 31413 </ul></li> 31414 </ul> 31415 <h4 id="oos-sse-customer-key-sha256">--oos-sse-customer-key-sha256</h4> 31416 <p>If using SSE-C, The optional header that specifies the base64-encoded SHA256 hash of the encryption key. This value is used to check the integrity of the encryption key. see Using Your Own Keys for Server-Side Encryption (https://docs.cloud.oracle.com/Content/Object/Tasks/usingyourencryptionkeys.htm).</p> 31417 <p>Properties:</p> 31418 <ul> 31419 <li>Config: sse_customer_key_sha256</li> 31420 <li>Env Var: RCLONE_OOS_SSE_CUSTOMER_KEY_SHA256</li> 31421 <li>Type: string</li> 31422 <li>Required: false</li> 31423 <li>Examples: 31424 <ul> 31425 <li>"" 31426 <ul> 31427 <li>None</li> 31428 </ul></li> 31429 </ul></li> 31430 </ul> 31431 <h4 id="oos-sse-kms-key-id">--oos-sse-kms-key-id</h4> 31432 <p>if using your own master key in vault, this header specifies the OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of a master encryption key used to call the Key Management service to generate a data encryption key or to encrypt or decrypt a data encryption key. Please note only one of sse_customer_key_file|sse_customer_key|sse_kms_key_id is needed.</p> 31433 <p>Properties:</p> 31434 <ul> 31435 <li>Config: sse_kms_key_id</li> 31436 <li>Env Var: RCLONE_OOS_SSE_KMS_KEY_ID</li> 31437 <li>Type: string</li> 31438 <li>Required: false</li> 31439 <li>Examples: 31440 <ul> 31441 <li>"" 31442 <ul> 31443 <li>None</li> 31444 </ul></li> 31445 </ul></li> 31446 </ul> 31447 <h4 id="oos-sse-customer-algorithm">--oos-sse-customer-algorithm</h4> 31448 <p>If using SSE-C, the optional header that specifies "AES256" as the encryption algorithm. Object Storage supports "AES256" as the encryption algorithm. For more information, see Using Your Own Keys for Server-Side Encryption (https://docs.cloud.oracle.com/Content/Object/Tasks/usingyourencryptionkeys.htm).</p> 31449 <p>Properties:</p> 31450 <ul> 31451 <li>Config: sse_customer_algorithm</li> 31452 <li>Env Var: RCLONE_OOS_SSE_CUSTOMER_ALGORITHM</li> 31453 <li>Type: string</li> 31454 <li>Required: false</li> 31455 <li>Examples: 31456 <ul> 31457 <li>"" 31458 <ul> 31459 <li>None</li> 31460 </ul></li> 31461 <li>"AES256" 31462 <ul> 31463 <li>AES256</li> 31464 </ul></li> 31465 </ul></li> 31466 </ul> 31467 <h4 id="oos-description">--oos-description</h4> 31468 <p>Description of the remote</p> 31469 <p>Properties:</p> 31470 <ul> 31471 <li>Config: description</li> 31472 <li>Env Var: RCLONE_OOS_DESCRIPTION</li> 31473 <li>Type: string</li> 31474 <li>Required: false</li> 31475 </ul> 31476 <h2 id="backend-commands-1">Backend commands</h2> 31477 <p>Here are the commands specific to the oracleobjectstorage backend.</p> 31478 <p>Run them with</p> 31479 <pre><code>rclone backend COMMAND remote:</code></pre> 31480 <p>The help below will explain what arguments each command takes.</p> 31481 <p>See the <a href="https://rclone.org/commands/rclone_backend/">backend</a> command for more info on how to pass options and arguments.</p> 31482 <p>These can be run on a running backend using the rc command <a href="https://rclone.org/rc/#backend-command">backend/command</a>.</p> 31483 <h3 id="rename">rename</h3> 31484 <p>change the name of an object</p> 31485 <pre><code>rclone backend rename remote: [options] [<arguments>+]</code></pre> 31486 <p>This command can be used to rename a object.</p> 31487 <p>Usage Examples:</p> 31488 <pre><code>rclone backend rename oos:bucket relative-object-path-under-bucket object-new-name</code></pre> 31489 <h3 id="list-multipart-uploads-1">list-multipart-uploads</h3> 31490 <p>List the unfinished multipart uploads</p> 31491 <pre><code>rclone backend list-multipart-uploads remote: [options] [<arguments>+]</code></pre> 31492 <p>This command lists the unfinished multipart uploads in JSON format.</p> 31493 <pre><code>rclone backend list-multipart-uploads oos:bucket/path/to/object</code></pre> 31494 <p>It returns a dictionary of buckets with values as lists of unfinished multipart uploads.</p> 31495 <p>You can call it with no bucket in which case it lists all bucket, with a bucket or with a bucket and path.</p> 31496 <pre><code>{ 31497 "test-bucket": [ 31498 { 31499 "namespace": "test-namespace", 31500 "bucket": "test-bucket", 31501 "object": "600m.bin", 31502 "uploadId": "51dd8114-52a4-b2f2-c42f-5291f05eb3c8", 31503 "timeCreated": "2022-07-29T06:21:16.595Z", 31504 "storageTier": "Standard" 31505 } 31506 ]</code></pre> 31507 <h3 id="cleanup-4">cleanup</h3> 31508 <p>Remove unfinished multipart uploads.</p> 31509 <pre><code>rclone backend cleanup remote: [options] [<arguments>+]</code></pre> 31510 <p>This command removes unfinished multipart uploads of age greater than max-age which defaults to 24 hours.</p> 31511 <p>Note that you can use --interactive/-i or --dry-run with this command to see what it would do.</p> 31512 <pre><code>rclone backend cleanup oos:bucket/path/to/object 31513 rclone backend cleanup -o max-age=7w oos:bucket/path/to/object</code></pre> 31514 <p>Durations are parsed as per the rest of rclone, 2h, 7d, 7w etc.</p> 31515 <p>Options:</p> 31516 <ul> 31517 <li>"max-age": Max age of upload to delete</li> 31518 </ul> 31519 <h3 id="restore-1">restore</h3> 31520 <p>Restore objects from Archive to Standard storage</p> 31521 <pre><code>rclone backend restore remote: [options] [<arguments>+]</code></pre> 31522 <p>This command can be used to restore one or more objects from Archive to Standard storage.</p> 31523 <pre><code>Usage Examples: 31524 31525 rclone backend restore oos:bucket/path/to/directory -o hours=HOURS 31526 rclone backend restore oos:bucket -o hours=HOURS</code></pre> 31527 <p>This flag also obeys the filters. Test first with --interactive/-i or --dry-run flags</p> 31528 <pre><code>rclone --interactive backend restore --include "*.txt" oos:bucket/path -o hours=72</code></pre> 31529 <p>All the objects shown will be marked for restore, then</p> 31530 <pre><code>rclone backend restore --include "*.txt" oos:bucket/path -o hours=72 31531 31532 It returns a list of status dictionaries with Object Name and Status 31533 keys. The Status will be "RESTORED"" if it was successful or an error message 31534 if not. 31535 31536 [ 31537 { 31538 "Object": "test.txt" 31539 "Status": "RESTORED", 31540 }, 31541 { 31542 "Object": "test/file4.txt" 31543 "Status": "RESTORED", 31544 } 31545 ]</code></pre> 31546 <p>Options:</p> 31547 <ul> 31548 <li>"hours": The number of hours for which this object will be restored. Default is 24 hrs.</li> 31549 </ul> 31550 <h2 id="tutorials">Tutorials</h2> 31551 <h3 id="mounting-buckets"><a href="https://rclone.org/oracleobjectstorage/tutorial_mount/">Mounting Buckets</a></h3> 31552 <h1 id="qingstor">QingStor</h1> 31553 <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, e.g. <code>remote:bucket/path/to/dir</code>.</p> 31554 <h2 id="configuration-5">Configuration</h2> 31555 <p>Here is an example of making an QingStor configuration. First run</p> 31556 <pre><code>rclone config</code></pre> 31557 <p>This will guide you through an interactive setup process.</p> 31558 <pre><code>No remotes found, make a new one? 31559 n) New remote 31560 r) Rename remote 31561 c) Copy remote 31562 s) Set configuration password 31563 q) Quit config 31564 n/r/c/s/q> n 31565 name> remote 31566 Type of storage to configure. 31567 Choose a number from below, or type in your own value 31568 [snip] 31569 XX / QingStor Object Storage 31570 \ "qingstor" 31571 [snip] 31572 Storage> qingstor 31573 Get QingStor credentials from runtime. Only applies if access_key_id and secret_access_key is blank. 31574 Choose a number from below, or type in your own value 31575 1 / Enter QingStor credentials in the next step 31576 \ "false" 31577 2 / Get QingStor credentials from the environment (env vars or IAM) 31578 \ "true" 31579 env_auth> 1 31580 QingStor Access Key ID - leave blank for anonymous access or runtime credentials. 31581 access_key_id> access_key 31582 QingStor Secret Access Key (password) - leave blank for anonymous access or runtime credentials. 31583 secret_access_key> secret_key 31584 Enter an endpoint URL to connection QingStor API. 31585 Leave blank will use the default value "https://qingstor.com:443" 31586 endpoint> 31587 Zone connect to. Default is "pek3a". 31588 Choose a number from below, or type in your own value 31589 / The Beijing (China) Three Zone 31590 1 | Needs location constraint pek3a. 31591 \ "pek3a" 31592 / The Shanghai (China) First Zone 31593 2 | Needs location constraint sh1a. 31594 \ "sh1a" 31595 zone> 1 31596 Number of connection retry. 31597 Leave blank will use the default value "3". 31598 connection_retries> 31599 Remote config 31600 -------------------- 31601 [remote] 31602 env_auth = false 31603 access_key_id = access_key 31604 secret_access_key = secret_key 31605 endpoint = 31606 zone = pek3a 31607 connection_retries = 31608 -------------------- 31609 y) Yes this is OK 31610 e) Edit this remote 31611 d) Delete this remote 31612 y/e/d> y</code></pre> 31613 <p>This remote is called <code>remote</code> and can now be used like this</p> 31614 <p>See all buckets</p> 31615 <pre><code>rclone lsd remote:</code></pre> 31616 <p>Make a new bucket</p> 31617 <pre><code>rclone mkdir remote:bucket</code></pre> 31618 <p>List the contents of a bucket</p> 31619 <pre><code>rclone ls remote:bucket</code></pre> 31620 <p>Sync <code>/home/local/directory</code> to the remote bucket, deleting any excess files in the bucket.</p> 31621 <pre><code>rclone sync --interactive /home/local/directory remote:bucket</code></pre> 31622 <h3 id="fast-list-1">--fast-list</h3> 31623 <p>This remote supports <code>--fast-list</code> which allows you to use fewer transactions in exchange for more memory. See the <a href="https://rclone.org/docs/#fast-list">rclone docs</a> for more details.</p> 31624 <h3 id="multipart-uploads-2">Multipart uploads</h3> 31625 <p>rclone supports multipart uploads with QingStor which means that it can upload files bigger than 5 GiB. Note that files uploaded with multipart upload don't have an MD5SUM.</p> 31626 <p>Note that incomplete multipart uploads older than 24 hours can be removed with <code>rclone cleanup remote:bucket</code> just for one bucket <code>rclone cleanup remote:</code> for all buckets. QingStor does not ever remove incomplete multipart uploads so it may be necessary to run this from time to time.</p> 31627 <h3 id="buckets-and-zone">Buckets and Zone</h3> 31628 <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> 31629 <h3 id="authentication-6">Authentication</h3> 31630 <p>There are two ways to supply <code>rclone</code> with a set of QingStor credentials. In order of precedence:</p> 31631 <ul> 31632 <li>Directly in the rclone configuration file (as configured by <code>rclone config</code>) 31633 <ul> 31634 <li>set <code>access_key_id</code> and <code>secret_access_key</code></li> 31635 </ul></li> 31636 <li>Runtime configuration: 31637 <ul> 31638 <li>set <code>env_auth</code> to <code>true</code> in the config file</li> 31639 <li>Exporting the following environment variables before running <code>rclone</code> 31640 <ul> 31641 <li>Access Key ID: <code>QS_ACCESS_KEY_ID</code> or <code>QS_ACCESS_KEY</code></li> 31642 <li>Secret Access Key: <code>QS_SECRET_ACCESS_KEY</code> or <code>QS_SECRET_KEY</code></li> 31643 </ul></li> 31644 </ul></li> 31645 </ul> 31646 <h3 id="restricted-filename-characters-3">Restricted filename characters</h3> 31647 <p>The control characters 0x00-0x1F and / are replaced as in the <a href="https://rclone.org/overview/#restricted-characters">default restricted characters set</a>. Note that 0x7F is not replaced.</p> 31648 <p>Invalid UTF-8 bytes will also be <a href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they can't be used in JSON strings.</p> 31649 <h3 id="standard-options-5">Standard options</h3> 31650 <p>Here are the Standard options specific to qingstor (QingCloud Object Storage).</p> 31651 <h4 id="qingstor-env-auth">--qingstor-env-auth</h4> 31652 <p>Get QingStor credentials from runtime.</p> 31653 <p>Only applies if access_key_id and secret_access_key is blank.</p> 31654 <p>Properties:</p> 31655 <ul> 31656 <li>Config: env_auth</li> 31657 <li>Env Var: RCLONE_QINGSTOR_ENV_AUTH</li> 31658 <li>Type: bool</li> 31659 <li>Default: false</li> 31660 <li>Examples: 31661 <ul> 31662 <li>"false" 31663 <ul> 31664 <li>Enter QingStor credentials in the next step.</li> 31665 </ul></li> 31666 <li>"true" 31667 <ul> 31668 <li>Get QingStor credentials from the environment (env vars or IAM).</li> 31669 </ul></li> 31670 </ul></li> 31671 </ul> 31672 <h4 id="qingstor-access-key-id">--qingstor-access-key-id</h4> 31673 <p>QingStor Access Key ID.</p> 31674 <p>Leave blank for anonymous access or runtime credentials.</p> 31675 <p>Properties:</p> 31676 <ul> 31677 <li>Config: access_key_id</li> 31678 <li>Env Var: RCLONE_QINGSTOR_ACCESS_KEY_ID</li> 31679 <li>Type: string</li> 31680 <li>Required: false</li> 31681 </ul> 31682 <h4 id="qingstor-secret-access-key">--qingstor-secret-access-key</h4> 31683 <p>QingStor Secret Access Key (password).</p> 31684 <p>Leave blank for anonymous access or runtime credentials.</p> 31685 <p>Properties:</p> 31686 <ul> 31687 <li>Config: secret_access_key</li> 31688 <li>Env Var: RCLONE_QINGSTOR_SECRET_ACCESS_KEY</li> 31689 <li>Type: string</li> 31690 <li>Required: false</li> 31691 </ul> 31692 <h4 id="qingstor-endpoint">--qingstor-endpoint</h4> 31693 <p>Enter an endpoint URL to connection QingStor API.</p> 31694 <p>Leave blank will use the default value "https://qingstor.com:443".</p> 31695 <p>Properties:</p> 31696 <ul> 31697 <li>Config: endpoint</li> 31698 <li>Env Var: RCLONE_QINGSTOR_ENDPOINT</li> 31699 <li>Type: string</li> 31700 <li>Required: false</li> 31701 </ul> 31702 <h4 id="qingstor-zone">--qingstor-zone</h4> 31703 <p>Zone to connect to.</p> 31704 <p>Default is "pek3a".</p> 31705 <p>Properties:</p> 31706 <ul> 31707 <li>Config: zone</li> 31708 <li>Env Var: RCLONE_QINGSTOR_ZONE</li> 31709 <li>Type: string</li> 31710 <li>Required: false</li> 31711 <li>Examples: 31712 <ul> 31713 <li>"pek3a" 31714 <ul> 31715 <li>The Beijing (China) Three Zone.</li> 31716 <li>Needs location constraint pek3a.</li> 31717 </ul></li> 31718 <li>"sh1a" 31719 <ul> 31720 <li>The Shanghai (China) First Zone.</li> 31721 <li>Needs location constraint sh1a.</li> 31722 </ul></li> 31723 <li>"gd2a" 31724 <ul> 31725 <li>The Guangdong (China) Second Zone.</li> 31726 <li>Needs location constraint gd2a.</li> 31727 </ul></li> 31728 </ul></li> 31729 </ul> 31730 <h3 id="advanced-options-5">Advanced options</h3> 31731 <p>Here are the Advanced options specific to qingstor (QingCloud Object Storage).</p> 31732 <h4 id="qingstor-connection-retries">--qingstor-connection-retries</h4> 31733 <p>Number of connection retries.</p> 31734 <p>Properties:</p> 31735 <ul> 31736 <li>Config: connection_retries</li> 31737 <li>Env Var: RCLONE_QINGSTOR_CONNECTION_RETRIES</li> 31738 <li>Type: int</li> 31739 <li>Default: 3</li> 31740 </ul> 31741 <h4 id="qingstor-upload-cutoff">--qingstor-upload-cutoff</h4> 31742 <p>Cutoff for switching to chunked upload.</p> 31743 <p>Any files larger than this will be uploaded in chunks of chunk_size. The minimum is 0 and the maximum is 5 GiB.</p> 31744 <p>Properties:</p> 31745 <ul> 31746 <li>Config: upload_cutoff</li> 31747 <li>Env Var: RCLONE_QINGSTOR_UPLOAD_CUTOFF</li> 31748 <li>Type: SizeSuffix</li> 31749 <li>Default: 200Mi</li> 31750 </ul> 31751 <h4 id="qingstor-chunk-size">--qingstor-chunk-size</h4> 31752 <p>Chunk size to use for uploading.</p> 31753 <p>When uploading files larger than upload_cutoff they will be uploaded as multipart uploads using this chunk size.</p> 31754 <p>Note that "--qingstor-upload-concurrency" chunks of this size are buffered in memory per transfer.</p> 31755 <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> 31756 <p>Properties:</p> 31757 <ul> 31758 <li>Config: chunk_size</li> 31759 <li>Env Var: RCLONE_QINGSTOR_CHUNK_SIZE</li> 31760 <li>Type: SizeSuffix</li> 31761 <li>Default: 4Mi</li> 31762 </ul> 31763 <h4 id="qingstor-upload-concurrency">--qingstor-upload-concurrency</h4> 31764 <p>Concurrency for multipart uploads.</p> 31765 <p>This is the number of chunks of the same file that are uploaded concurrently.</p> 31766 <p>NB if you set this to > 1 then the checksums of multipart uploads become corrupted (the uploads themselves are not corrupted though).</p> 31767 <p>If you are uploading small numbers of large files over high-speed links and these uploads do not fully utilize your bandwidth, then increasing this may help to speed up the transfers.</p> 31768 <p>Properties:</p> 31769 <ul> 31770 <li>Config: upload_concurrency</li> 31771 <li>Env Var: RCLONE_QINGSTOR_UPLOAD_CONCURRENCY</li> 31772 <li>Type: int</li> 31773 <li>Default: 1</li> 31774 </ul> 31775 <h4 id="qingstor-encoding">--qingstor-encoding</h4> 31776 <p>The encoding for the backend.</p> 31777 <p>See the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 31778 <p>Properties:</p> 31779 <ul> 31780 <li>Config: encoding</li> 31781 <li>Env Var: RCLONE_QINGSTOR_ENCODING</li> 31782 <li>Type: Encoding</li> 31783 <li>Default: Slash,Ctl,InvalidUtf8</li> 31784 </ul> 31785 <h4 id="qingstor-description">--qingstor-description</h4> 31786 <p>Description of the remote</p> 31787 <p>Properties:</p> 31788 <ul> 31789 <li>Config: description</li> 31790 <li>Env Var: RCLONE_QINGSTOR_DESCRIPTION</li> 31791 <li>Type: string</li> 31792 <li>Required: false</li> 31793 </ul> 31794 <h2 id="limitations-9">Limitations</h2> 31795 <p><code>rclone about</code> is not supported by the qingstor backend. Backends without this capability cannot determine free space for an rclone mount or use policy <code>mfs</code> (most free space) as a member of an rclone union remote.</p> 31796 <p>See <a href="https://rclone.org/overview/#optional-features">List of backends that do not support rclone about</a> and <a href="https://rclone.org/commands/rclone_about/">rclone about</a></p> 31797 <h1 id="quatrix">Quatrix</h1> 31798 <p>Quatrix by Maytech is <a href="https://www.maytech.net/products/quatrix-business">Quatrix Secure Compliant File Sharing | Maytech</a>.</p> 31799 <p>Paths are specified as <code>remote:path</code></p> 31800 <p>Paths may be as deep as required, e.g., <code>remote:directory/subdirectory</code>.</p> 31801 <p>The initial setup for Quatrix involves getting an API Key from Quatrix. You can get the API key in the user's profile at <code>https://<account>/profile/api-keys</code> or with the help of the API - https://docs.maytech.net/quatrix/quatrix-api/api-explorer#/API-Key/post_api_key_create.</p> 31802 <p>See complete Swagger documentation for Quatrix - https://docs.maytech.net/quatrix/quatrix-api/api-explorer</p> 31803 <h2 id="configuration-6">Configuration</h2> 31804 <p>Here is an example of how to make a remote called <code>remote</code>. First run:</p> 31805 <pre><code> rclone config</code></pre> 31806 <p>This will guide you through an interactive setup process:</p> 31807 <pre><code>No remotes found, make a new one? 31808 n) New remote 31809 s) Set configuration password 31810 q) Quit config 31811 n/s/q> n 31812 name> remote 31813 Type of storage to configure. 31814 Choose a number from below, or type in your own value 31815 [snip] 31816 XX / Quatrix by Maytech 31817 \ "quatrix" 31818 [snip] 31819 Storage> quatrix 31820 API key for accessing Quatrix account. 31821 api_key> your_api_key 31822 Host name of Quatrix account. 31823 host> example.quatrix.it 31824 31825 -------------------- 31826 [remote] 31827 api_key = your_api_key 31828 host = example.quatrix.it 31829 -------------------- 31830 y) Yes this is OK 31831 e) Edit this remote 31832 d) Delete this remote 31833 y/e/d> y</code></pre> 31834 <p>Once configured you can then use <code>rclone</code> like this,</p> 31835 <p>List directories in top level of your Quatrix</p> 31836 <pre><code>rclone lsd remote:</code></pre> 31837 <p>List all the files in your Quatrix</p> 31838 <pre><code>rclone ls remote:</code></pre> 31839 <p>To copy a local directory to an Quatrix directory called backup</p> 31840 <pre><code>rclone copy /home/source remote:backup</code></pre> 31841 <h3 id="api-key-validity">API key validity</h3> 31842 <p>API Key is created with no expiration date. It will be valid until you delete or deactivate it in your account. After disabling, the API Key can be enabled back. If the API Key was deleted and a new key was created, you can update it in rclone config. The same happens if the hostname was changed.</p> 31843 <pre><code>$ rclone config 31844 Current remotes: 31845 31846 Name Type 31847 ==== ==== 31848 remote quatrix 31849 31850 e) Edit existing remote 31851 n) New remote 31852 d) Delete remote 31853 r) Rename remote 31854 c) Copy remote 31855 s) Set configuration password 31856 q) Quit config 31857 e/n/d/r/c/s/q> e 31858 Choose a number from below, or type in an existing value 31859 1 > remote 31860 remote> remote 31861 -------------------- 31862 [remote] 31863 type = quatrix 31864 host = some_host.quatrix.it 31865 api_key = your_api_key 31866 -------------------- 31867 Edit remote 31868 Option api_key. 31869 API key for accessing Quatrix account 31870 Enter a string value. Press Enter for the default (your_api_key) 31871 api_key> 31872 Option host. 31873 Host name of Quatrix account 31874 Enter a string value. Press Enter for the default (some_host.quatrix.it). 31875 31876 -------------------- 31877 [remote] 31878 type = quatrix 31879 host = some_host.quatrix.it 31880 api_key = your_api_key 31881 -------------------- 31882 y) Yes this is OK 31883 e) Edit this remote 31884 d) Delete this remote 31885 y/e/d> y</code></pre> 31886 <h3 id="modification-times-and-hashes-4">Modification times and hashes</h3> 31887 <p>Quatrix allows modification times to be set on objects accurate to 1 microsecond. These will be used to detect whether objects need syncing or not.</p> 31888 <p>Quatrix does not support hashes, so you cannot use the <code>--checksum</code> flag.</p> 31889 <h3 id="restricted-filename-characters-4">Restricted filename characters</h3> 31890 <p>File names in Quatrix are case sensitive and have limitations like the maximum length of a filename is 255, and the minimum length is 1. A file name cannot be equal to <code>.</code> or <code>..</code> nor contain <code>/</code> , <code>\</code> or non-printable ascii.</p> 31891 <h3 id="transfers">Transfers</h3> 31892 <p>For files above 50 MiB rclone will use a chunked transfer. Rclone will upload up to <code>--transfers</code> chunks at the same time (shared among all multipart uploads). Chunks are buffered in memory, and the minimal chunk size is 10_000_000 bytes by default, and it can be changed in the advanced configuration, so increasing <code>--transfers</code> will increase the memory use. The chunk size has a maximum size limit, which is set to 100_000_000 bytes by default and can be changed in the advanced configuration. The size of the uploaded chunk will dynamically change depending on the upload speed. The total memory use equals the number of transfers multiplied by the minimal chunk size. In case there's free memory allocated for the upload (which equals the difference of <code>maximal_summary_chunk_size</code> and <code>minimal_chunk_size</code> * <code>transfers</code>), the chunk size may increase in case of high upload speed. As well as it can decrease in case of upload speed problems. If no free memory is available, all chunks will equal <code>minimal_chunk_size</code>.</p> 31893 <h3 id="deleting-files">Deleting files</h3> 31894 <p>Files you delete with rclone will end up in Trash and be stored there for 30 days. Quatrix also provides an API to permanently delete files and an API to empty the Trash so that you can remove files permanently from your account.</p> 31895 <h3 id="standard-options-6">Standard options</h3> 31896 <p>Here are the Standard options specific to quatrix (Quatrix by Maytech).</p> 31897 <h4 id="quatrix-api-key">--quatrix-api-key</h4> 31898 <p>API key for accessing Quatrix account</p> 31899 <p>Properties:</p> 31900 <ul> 31901 <li>Config: api_key</li> 31902 <li>Env Var: RCLONE_QUATRIX_API_KEY</li> 31903 <li>Type: string</li> 31904 <li>Required: true</li> 31905 </ul> 31906 <h4 id="quatrix-host">--quatrix-host</h4> 31907 <p>Host name of Quatrix account</p> 31908 <p>Properties:</p> 31909 <ul> 31910 <li>Config: host</li> 31911 <li>Env Var: RCLONE_QUATRIX_HOST</li> 31912 <li>Type: string</li> 31913 <li>Required: true</li> 31914 </ul> 31915 <h3 id="advanced-options-6">Advanced options</h3> 31916 <p>Here are the Advanced options specific to quatrix (Quatrix by Maytech).</p> 31917 <h4 id="quatrix-encoding">--quatrix-encoding</h4> 31918 <p>The encoding for the backend.</p> 31919 <p>See the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 31920 <p>Properties:</p> 31921 <ul> 31922 <li>Config: encoding</li> 31923 <li>Env Var: RCLONE_QUATRIX_ENCODING</li> 31924 <li>Type: Encoding</li> 31925 <li>Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot</li> 31926 </ul> 31927 <h4 id="quatrix-effective-upload-time">--quatrix-effective-upload-time</h4> 31928 <p>Wanted upload time for one chunk</p> 31929 <p>Properties:</p> 31930 <ul> 31931 <li>Config: effective_upload_time</li> 31932 <li>Env Var: RCLONE_QUATRIX_EFFECTIVE_UPLOAD_TIME</li> 31933 <li>Type: string</li> 31934 <li>Default: "4s"</li> 31935 </ul> 31936 <h4 id="quatrix-minimal-chunk-size">--quatrix-minimal-chunk-size</h4> 31937 <p>The minimal size for one chunk</p> 31938 <p>Properties:</p> 31939 <ul> 31940 <li>Config: minimal_chunk_size</li> 31941 <li>Env Var: RCLONE_QUATRIX_MINIMAL_CHUNK_SIZE</li> 31942 <li>Type: SizeSuffix</li> 31943 <li>Default: 9.537Mi</li> 31944 </ul> 31945 <h4 id="quatrix-maximal-summary-chunk-size">--quatrix-maximal-summary-chunk-size</h4> 31946 <p>The maximal summary for all chunks. It should not be less than 'transfers'*'minimal_chunk_size'</p> 31947 <p>Properties:</p> 31948 <ul> 31949 <li>Config: maximal_summary_chunk_size</li> 31950 <li>Env Var: RCLONE_QUATRIX_MAXIMAL_SUMMARY_CHUNK_SIZE</li> 31951 <li>Type: SizeSuffix</li> 31952 <li>Default: 95.367Mi</li> 31953 </ul> 31954 <h4 id="quatrix-hard-delete">--quatrix-hard-delete</h4> 31955 <p>Delete files permanently rather than putting them into the trash</p> 31956 <p>Properties:</p> 31957 <ul> 31958 <li>Config: hard_delete</li> 31959 <li>Env Var: RCLONE_QUATRIX_HARD_DELETE</li> 31960 <li>Type: bool</li> 31961 <li>Default: false</li> 31962 </ul> 31963 <h4 id="quatrix-skip-project-folders">--quatrix-skip-project-folders</h4> 31964 <p>Skip project folders in operations</p> 31965 <p>Properties:</p> 31966 <ul> 31967 <li>Config: skip_project_folders</li> 31968 <li>Env Var: RCLONE_QUATRIX_SKIP_PROJECT_FOLDERS</li> 31969 <li>Type: bool</li> 31970 <li>Default: false</li> 31971 </ul> 31972 <h4 id="quatrix-description">--quatrix-description</h4> 31973 <p>Description of the remote</p> 31974 <p>Properties:</p> 31975 <ul> 31976 <li>Config: description</li> 31977 <li>Env Var: RCLONE_QUATRIX_DESCRIPTION</li> 31978 <li>Type: string</li> 31979 <li>Required: false</li> 31980 </ul> 31981 <h2 id="storage-usage">Storage usage</h2> 31982 <p>The storage usage in Quatrix is restricted to the account during the purchase. You can restrict any user with a smaller storage limit. The account limit is applied if the user has no custom storage limit. Once you've reached the limit, the upload of files will fail. This can be fixed by freeing up the space or increasing the quota.</p> 31983 <h2 id="server-side-operations">Server-side operations</h2> 31984 <p>Quatrix supports server-side operations (copy and move). In case of conflict, files are overwritten during server-side operation.</p> 31985 <h1 id="sia">Sia</h1> 31986 <p>Sia (<a href="https://sia.tech/">sia.tech</a>) is a decentralized cloud storage platform based on the <a href="https://wikipedia.org/wiki/Blockchain">blockchain</a> technology. With rclone you can use it like any other remote filesystem or mount Sia folders locally. The technology behind it involves a number of new concepts such as Siacoins and Wallet, Blockchain and Consensus, Renting and Hosting, and so on. If you are new to it, you'd better first familiarize yourself using their excellent <a href="https://support.sia.tech/">support documentation</a>.</p> 31987 <h2 id="introduction-1">Introduction</h2> 31988 <p>Before you can use rclone with Sia, you will need to have a running copy of <code>Sia-UI</code> or <code>siad</code> (the Sia daemon) locally on your computer or on local network (e.g. a NAS). Please follow the <a href="https://sia.tech/get-started">Get started</a> guide and install one.</p> 31989 <p>rclone interacts with Sia network by talking to the Sia daemon via <a href="https://sia.tech/docs/">HTTP API</a> which is usually available on port <em>9980</em>. By default you will run the daemon locally on the same computer so it's safe to leave the API password blank (the API URL will be <code>http://127.0.0.1:9980</code> making external access impossible).</p> 31990 <p>However, if you want to access Sia daemon running on another node, for example due to memory constraints or because you want to share single daemon between several rclone and Sia-UI instances, you'll need to make a few more provisions: - Ensure you have <em>Sia daemon</em> installed directly or in a <a href="https://github.com/SiaFoundation/siad/pkgs/container/siad">docker container</a> because Sia-UI does not support this mode natively. - Run it on externally accessible port, for example provide <code>--api-addr :9980</code> and <code>--disable-api-security</code> arguments on the daemon command line. - Enforce API password for the <code>siad</code> daemon via environment variable <code>SIA_API_PASSWORD</code> or text file named <code>apipassword</code> in the daemon directory. - Set rclone backend option <code>api_password</code> taking it from above locations.</p> 31991 <p>Notes: 1. If your wallet is locked, rclone cannot unlock it automatically. You should either unlock it in advance by using Sia-UI or via command line <code>siac wallet unlock</code>. Alternatively you can make <code>siad</code> unlock your wallet automatically upon startup by running it with environment variable <code>SIA_WALLET_PASSWORD</code>. 2. If <code>siad</code> cannot find the <code>SIA_API_PASSWORD</code> variable or the <code>apipassword</code> file in the <code>SIA_DIR</code> directory, it will generate a random password and store in the text file named <code>apipassword</code> under <code>YOUR_HOME/.sia/</code> directory on Unix or <code>C:\Users\YOUR_HOME\AppData\Local\Sia\apipassword</code> on Windows. Remember this when you configure password in rclone. 3. The only way to use <code>siad</code> without API password is to run it <strong>on localhost</strong> with command line argument <code>--authorize-api=false</code>, but this is insecure and <strong>strongly discouraged</strong>.</p> 31992 <h2 id="configuration-7">Configuration</h2> 31993 <p>Here is an example of how to make a <code>sia</code> remote called <code>mySia</code>. First, run:</p> 31994 <pre><code> rclone config</code></pre> 31995 <p>This will guide you through an interactive setup process:</p> 31996 <pre><code>No remotes found, make a new one? 31997 n) New remote 31998 s) Set configuration password 31999 q) Quit config 32000 n/s/q> n 32001 name> mySia 32002 Type of storage to configure. 32003 Enter a string value. Press Enter for the default (""). 32004 Choose a number from below, or type in your own value 32005 ... 32006 29 / Sia Decentralized Cloud 32007 \ "sia" 32008 ... 32009 Storage> sia 32010 Sia daemon API URL, like http://sia.daemon.host:9980. 32011 Note that siad must run with --disable-api-security to open API port for other hosts (not recommended). 32012 Keep default if Sia daemon runs on localhost. 32013 Enter a string value. Press Enter for the default ("http://127.0.0.1:9980"). 32014 api_url> http://127.0.0.1:9980 32015 Sia Daemon API Password. 32016 Can be found in the apipassword file located in HOME/.sia/ or in the daemon directory. 32017 y) Yes type in my own password 32018 g) Generate random password 32019 n) No leave this optional password blank (default) 32020 y/g/n> y 32021 Enter the password: 32022 password: 32023 Confirm the password: 32024 password: 32025 Edit advanced config? 32026 y) Yes 32027 n) No (default) 32028 y/n> n 32029 -------------------- 32030 [mySia] 32031 type = sia 32032 api_url = http://127.0.0.1:9980 32033 api_password = *** ENCRYPTED *** 32034 -------------------- 32035 y) Yes this is OK (default) 32036 e) Edit this remote 32037 d) Delete this remote 32038 y/e/d> y</code></pre> 32039 <p>Once configured, you can then use <code>rclone</code> like this:</p> 32040 <ul> 32041 <li>List directories in top level of your Sia storage</li> 32042 </ul> 32043 <pre><code>rclone lsd mySia:</code></pre> 32044 <ul> 32045 <li>List all the files in your Sia storage</li> 32046 </ul> 32047 <pre><code>rclone ls mySia:</code></pre> 32048 <ul> 32049 <li>Upload a local directory to the Sia directory called <em>backup</em></li> 32050 </ul> 32051 <pre><code>rclone copy /home/source mySia:backup</code></pre> 32052 <h3 id="standard-options-7">Standard options</h3> 32053 <p>Here are the Standard options specific to sia (Sia Decentralized Cloud).</p> 32054 <h4 id="sia-api-url">--sia-api-url</h4> 32055 <p>Sia daemon API URL, like http://sia.daemon.host:9980.</p> 32056 <p>Note that siad must run with --disable-api-security to open API port for other hosts (not recommended). Keep default if Sia daemon runs on localhost.</p> 32057 <p>Properties:</p> 32058 <ul> 32059 <li>Config: api_url</li> 32060 <li>Env Var: RCLONE_SIA_API_URL</li> 32061 <li>Type: string</li> 32062 <li>Default: "http://127.0.0.1:9980"</li> 32063 </ul> 32064 <h4 id="sia-api-password">--sia-api-password</h4> 32065 <p>Sia Daemon API Password.</p> 32066 <p>Can be found in the apipassword file located in HOME/.sia/ or in the daemon directory.</p> 32067 <p><strong>NB</strong> Input to this must be obscured - see <a href="https://rclone.org/commands/rclone_obscure/">rclone obscure</a>.</p> 32068 <p>Properties:</p> 32069 <ul> 32070 <li>Config: api_password</li> 32071 <li>Env Var: RCLONE_SIA_API_PASSWORD</li> 32072 <li>Type: string</li> 32073 <li>Required: false</li> 32074 </ul> 32075 <h3 id="advanced-options-7">Advanced options</h3> 32076 <p>Here are the Advanced options specific to sia (Sia Decentralized Cloud).</p> 32077 <h4 id="sia-user-agent">--sia-user-agent</h4> 32078 <p>Siad User Agent</p> 32079 <p>Sia daemon requires the 'Sia-Agent' user agent by default for security</p> 32080 <p>Properties:</p> 32081 <ul> 32082 <li>Config: user_agent</li> 32083 <li>Env Var: RCLONE_SIA_USER_AGENT</li> 32084 <li>Type: string</li> 32085 <li>Default: "Sia-Agent"</li> 32086 </ul> 32087 <h4 id="sia-encoding">--sia-encoding</h4> 32088 <p>The encoding for the backend.</p> 32089 <p>See the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 32090 <p>Properties:</p> 32091 <ul> 32092 <li>Config: encoding</li> 32093 <li>Env Var: RCLONE_SIA_ENCODING</li> 32094 <li>Type: Encoding</li> 32095 <li>Default: Slash,Question,Hash,Percent,Del,Ctl,InvalidUtf8,Dot</li> 32096 </ul> 32097 <h4 id="sia-description">--sia-description</h4> 32098 <p>Description of the remote</p> 32099 <p>Properties:</p> 32100 <ul> 32101 <li>Config: description</li> 32102 <li>Env Var: RCLONE_SIA_DESCRIPTION</li> 32103 <li>Type: string</li> 32104 <li>Required: false</li> 32105 </ul> 32106 <h2 id="limitations-10">Limitations</h2> 32107 <ul> 32108 <li>Modification times not supported</li> 32109 <li>Checksums not supported</li> 32110 <li><code>rclone about</code> not supported</li> 32111 <li>rclone can work only with <em>Siad</em> or <em>Sia-UI</em> at the moment, the <strong>SkyNet daemon is not supported yet.</strong></li> 32112 <li>Sia does not allow control characters or symbols like question and pound signs in file names. rclone will transparently <a href="https://rclone.org/overview/#encoding">encode</a> them for you, but you'd better be aware</li> 32113 </ul> 32114 <h1 id="swift">Swift</h1> 32115 <p>Swift refers to <a href="https://docs.openstack.org/swift/latest/">OpenStack Object Storage</a>. Commercial implementations of that being:</p> 32116 <ul> 32117 <li><a href="https://www.rackspace.com/cloud/files/">Rackspace Cloud Files</a></li> 32118 <li><a href="https://www.memset.com/cloud/storage/">Memset Memstore</a></li> 32119 <li><a href="https://www.ovh.co.uk/public-cloud/storage/object-storage/">OVH Object Storage</a></li> 32120 <li><a href="https://docs.oracle.com/en-us/iaas/integration/doc/configure-object-storage.html">Oracle Cloud Storage</a></li> 32121 <li><a href="https://www.blomp.com/cloud-storage/">Blomp Cloud Storage</a></li> 32122 <li><a href="https://console.bluemix.net/docs/infrastructure/objectstorage-swift/index.html">IBM Bluemix Cloud ObjectStorage Swift</a></li> 32123 </ul> 32124 <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, e.g. <code>remote:container/path/to/dir</code>.</p> 32125 <h2 id="configuration-8">Configuration</h2> 32126 <p>Here is an example of making a swift configuration. First run</p> 32127 <pre><code>rclone config</code></pre> 32128 <p>This will guide you through an interactive setup process.</p> 32129 <pre><code>No remotes found, make a new one? 32130 n) New remote 32131 s) Set configuration password 32132 q) Quit config 32133 n/s/q> n 32134 name> remote 32135 Type of storage to configure. 32136 Choose a number from below, or type in your own value 32137 [snip] 32138 XX / OpenStack Swift (Rackspace Cloud Files, Blomp Cloud Storage, Memset Memstore, OVH) 32139 \ "swift" 32140 [snip] 32141 Storage> swift 32142 Get swift credentials from environment variables in standard OpenStack form. 32143 Choose a number from below, or type in your own value 32144 1 / Enter swift credentials in the next step 32145 \ "false" 32146 2 / Get swift credentials from environment vars. Leave other fields blank if using this. 32147 \ "true" 32148 env_auth> true 32149 User name to log in (OS_USERNAME). 32150 user> 32151 API key or password (OS_PASSWORD). 32152 key> 32153 Authentication URL for server (OS_AUTH_URL). 32154 Choose a number from below, or type in your own value 32155 1 / Rackspace US 32156 \ "https://auth.api.rackspacecloud.com/v1.0" 32157 2 / Rackspace UK 32158 \ "https://lon.auth.api.rackspacecloud.com/v1.0" 32159 3 / Rackspace v2 32160 \ "https://identity.api.rackspacecloud.com/v2.0" 32161 4 / Memset Memstore UK 32162 \ "https://auth.storage.memset.com/v1.0" 32163 5 / Memset Memstore UK v2 32164 \ "https://auth.storage.memset.com/v2.0" 32165 6 / OVH 32166 \ "https://auth.cloud.ovh.net/v3" 32167 7 / Blomp Cloud Storage 32168 \ "https://authenticate.ain.net" 32169 auth> 32170 User ID to log in - optional - most swift systems use user and leave this blank (v3 auth) (OS_USER_ID). 32171 user_id> 32172 User domain - optional (v3 auth) (OS_USER_DOMAIN_NAME) 32173 domain> 32174 Tenant name - optional for v1 auth, this or tenant_id required otherwise (OS_TENANT_NAME or OS_PROJECT_NAME) 32175 tenant> 32176 Tenant ID - optional for v1 auth, this or tenant required otherwise (OS_TENANT_ID) 32177 tenant_id> 32178 Tenant domain - optional (v3 auth) (OS_PROJECT_DOMAIN_NAME) 32179 tenant_domain> 32180 Region name - optional (OS_REGION_NAME) 32181 region> 32182 Storage URL - optional (OS_STORAGE_URL) 32183 storage_url> 32184 Auth Token from alternate authentication - optional (OS_AUTH_TOKEN) 32185 auth_token> 32186 AuthVersion - optional - set to (1,2,3) if your auth URL has no version (ST_AUTH_VERSION) 32187 auth_version> 32188 Endpoint type to choose from the service catalogue (OS_ENDPOINT_TYPE) 32189 Choose a number from below, or type in your own value 32190 1 / Public (default, choose this if not sure) 32191 \ "public" 32192 2 / Internal (use internal service net) 32193 \ "internal" 32194 3 / Admin 32195 \ "admin" 32196 endpoint_type> 32197 Remote config 32198 -------------------- 32199 [test] 32200 env_auth = true 32201 user = 32202 key = 32203 auth = 32204 user_id = 32205 domain = 32206 tenant = 32207 tenant_id = 32208 tenant_domain = 32209 region = 32210 storage_url = 32211 auth_token = 32212 auth_version = 32213 endpoint_type = 32214 -------------------- 32215 y) Yes this is OK 32216 e) Edit this remote 32217 d) Delete this remote 32218 y/e/d> y</code></pre> 32219 <p>This remote is called <code>remote</code> and can now be used like this</p> 32220 <p>See all containers</p> 32221 <pre><code>rclone lsd remote:</code></pre> 32222 <p>Make a new container</p> 32223 <pre><code>rclone mkdir remote:container</code></pre> 32224 <p>List the contents of a container</p> 32225 <pre><code>rclone ls remote:container</code></pre> 32226 <p>Sync <code>/home/local/directory</code> to the remote container, deleting any excess files in the container.</p> 32227 <pre><code>rclone sync --interactive /home/local/directory remote:container</code></pre> 32228 <h3 id="configuration-from-an-openstack-credentials-file">Configuration from an OpenStack credentials file</h3> 32229 <p>An OpenStack credentials file typically looks something something like this (without the comments)</p> 32230 <pre><code>export OS_AUTH_URL=https://a.provider.net/v2.0 32231 export OS_TENANT_ID=ffffffffffffffffffffffffffffffff 32232 export OS_TENANT_NAME="1234567890123456" 32233 export OS_USERNAME="123abc567xy" 32234 echo "Please enter your OpenStack Password: " 32235 read -sr OS_PASSWORD_INPUT 32236 export OS_PASSWORD=$OS_PASSWORD_INPUT 32237 export OS_REGION_NAME="SBG1" 32238 if [ -z "$OS_REGION_NAME" ]; then unset OS_REGION_NAME; fi</code></pre> 32239 <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> 32240 <pre><code>[remote] 32241 type = swift 32242 user = $OS_USERNAME 32243 key = $OS_PASSWORD 32244 auth = $OS_AUTH_URL 32245 tenant = $OS_TENANT_NAME</code></pre> 32246 <p>Note that you may (or may not) need to set <code>region</code> too - try without first.</p> 32247 <h3 id="configuration-from-the-environment">Configuration from the environment</h3> 32248 <p>If you prefer you can configure rclone to use swift using a standard set of OpenStack environment variables.</p> 32249 <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> 32250 <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> 32251 <h3 id="using-an-alternate-authentication-method">Using an alternate authentication method</h3> 32252 <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> 32253 <h4 id="using-rclone-without-a-config-file">Using rclone without a config file</h4> 32254 <p>You can use rclone with swift without a config file, if desired, like this:</p> 32255 <pre><code>source openstack-credentials-file 32256 export RCLONE_CONFIG_MYREMOTE_TYPE=swift 32257 export RCLONE_CONFIG_MYREMOTE_ENV_AUTH=true 32258 rclone lsd myremote:</code></pre> 32259 <h3 id="fast-list-2">--fast-list</h3> 32260 <p>This remote supports <code>--fast-list</code> which allows you to use fewer transactions in exchange for more memory. See the <a href="https://rclone.org/docs/#fast-list">rclone docs</a> for more details.</p> 32261 <h3 id="update-and---use-server-modtime">--update and --use-server-modtime</h3> 32262 <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> 32263 <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> 32264 <h3 id="modification-times-and-hashes-5">Modification times and hashes</h3> 32265 <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> 32266 <p>This is a de facto standard (used in the official python-swiftclient amongst others) for storing the modification time for an object.</p> 32267 <p>The MD5 hash algorithm is supported.</p> 32268 <h3 id="restricted-filename-characters-5">Restricted filename characters</h3> 32269 <table> 32270 <thead> 32271 <tr class="header"> 32272 <th>Character</th> 32273 <th style="text-align: center;">Value</th> 32274 <th style="text-align: center;">Replacement</th> 32275 </tr> 32276 </thead> 32277 <tbody> 32278 <tr class="odd"> 32279 <td>NUL</td> 32280 <td style="text-align: center;">0x00</td> 32281 <td style="text-align: center;">␀</td> 32282 </tr> 32283 <tr class="even"> 32284 <td>/</td> 32285 <td style="text-align: center;">0x2F</td> 32286 <td style="text-align: center;">／</td> 32287 </tr> 32288 </tbody> 32289 </table> 32290 <p>Invalid UTF-8 bytes will also be <a href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they can't be used in JSON strings.</p> 32291 <h3 id="standard-options-8">Standard options</h3> 32292 <p>Here are the Standard options specific to swift (OpenStack Swift (Rackspace Cloud Files, Blomp Cloud Storage, Memset Memstore, OVH)).</p> 32293 <h4 id="swift-env-auth">--swift-env-auth</h4> 32294 <p>Get swift credentials from environment variables in standard OpenStack form.</p> 32295 <p>Properties:</p> 32296 <ul> 32297 <li>Config: env_auth</li> 32298 <li>Env Var: RCLONE_SWIFT_ENV_AUTH</li> 32299 <li>Type: bool</li> 32300 <li>Default: false</li> 32301 <li>Examples: 32302 <ul> 32303 <li>"false" 32304 <ul> 32305 <li>Enter swift credentials in the next step.</li> 32306 </ul></li> 32307 <li>"true" 32308 <ul> 32309 <li>Get swift credentials from environment vars.</li> 32310 <li>Leave other fields blank if using this.</li> 32311 </ul></li> 32312 </ul></li> 32313 </ul> 32314 <h4 id="swift-user">--swift-user</h4> 32315 <p>User name to log in (OS_USERNAME).</p> 32316 <p>Properties:</p> 32317 <ul> 32318 <li>Config: user</li> 32319 <li>Env Var: RCLONE_SWIFT_USER</li> 32320 <li>Type: string</li> 32321 <li>Required: false</li> 32322 </ul> 32323 <h4 id="swift-key">--swift-key</h4> 32324 <p>API key or password (OS_PASSWORD).</p> 32325 <p>Properties:</p> 32326 <ul> 32327 <li>Config: key</li> 32328 <li>Env Var: RCLONE_SWIFT_KEY</li> 32329 <li>Type: string</li> 32330 <li>Required: false</li> 32331 </ul> 32332 <h4 id="swift-auth">--swift-auth</h4> 32333 <p>Authentication URL for server (OS_AUTH_URL).</p> 32334 <p>Properties:</p> 32335 <ul> 32336 <li>Config: auth</li> 32337 <li>Env Var: RCLONE_SWIFT_AUTH</li> 32338 <li>Type: string</li> 32339 <li>Required: false</li> 32340 <li>Examples: 32341 <ul> 32342 <li>"https://auth.api.rackspacecloud.com/v1.0" 32343 <ul> 32344 <li>Rackspace US</li> 32345 </ul></li> 32346 <li>"https://lon.auth.api.rackspacecloud.com/v1.0" 32347 <ul> 32348 <li>Rackspace UK</li> 32349 </ul></li> 32350 <li>"https://identity.api.rackspacecloud.com/v2.0" 32351 <ul> 32352 <li>Rackspace v2</li> 32353 </ul></li> 32354 <li>"https://auth.storage.memset.com/v1.0" 32355 <ul> 32356 <li>Memset Memstore UK</li> 32357 </ul></li> 32358 <li>"https://auth.storage.memset.com/v2.0" 32359 <ul> 32360 <li>Memset Memstore UK v2</li> 32361 </ul></li> 32362 <li>"https://auth.cloud.ovh.net/v3" 32363 <ul> 32364 <li>OVH</li> 32365 </ul></li> 32366 <li>"https://authenticate.ain.net" 32367 <ul> 32368 <li>Blomp Cloud Storage</li> 32369 </ul></li> 32370 </ul></li> 32371 </ul> 32372 <h4 id="swift-user-id">--swift-user-id</h4> 32373 <p>User ID to log in - optional - most swift systems use user and leave this blank (v3 auth) (OS_USER_ID).</p> 32374 <p>Properties:</p> 32375 <ul> 32376 <li>Config: user_id</li> 32377 <li>Env Var: RCLONE_SWIFT_USER_ID</li> 32378 <li>Type: string</li> 32379 <li>Required: false</li> 32380 </ul> 32381 <h4 id="swift-domain">--swift-domain</h4> 32382 <p>User domain - optional (v3 auth) (OS_USER_DOMAIN_NAME)</p> 32383 <p>Properties:</p> 32384 <ul> 32385 <li>Config: domain</li> 32386 <li>Env Var: RCLONE_SWIFT_DOMAIN</li> 32387 <li>Type: string</li> 32388 <li>Required: false</li> 32389 </ul> 32390 <h4 id="swift-tenant">--swift-tenant</h4> 32391 <p>Tenant name - optional for v1 auth, this or tenant_id required otherwise (OS_TENANT_NAME or OS_PROJECT_NAME).</p> 32392 <p>Properties:</p> 32393 <ul> 32394 <li>Config: tenant</li> 32395 <li>Env Var: RCLONE_SWIFT_TENANT</li> 32396 <li>Type: string</li> 32397 <li>Required: false</li> 32398 </ul> 32399 <h4 id="swift-tenant-id">--swift-tenant-id</h4> 32400 <p>Tenant ID - optional for v1 auth, this or tenant required otherwise (OS_TENANT_ID).</p> 32401 <p>Properties:</p> 32402 <ul> 32403 <li>Config: tenant_id</li> 32404 <li>Env Var: RCLONE_SWIFT_TENANT_ID</li> 32405 <li>Type: string</li> 32406 <li>Required: false</li> 32407 </ul> 32408 <h4 id="swift-tenant-domain">--swift-tenant-domain</h4> 32409 <p>Tenant domain - optional (v3 auth) (OS_PROJECT_DOMAIN_NAME).</p> 32410 <p>Properties:</p> 32411 <ul> 32412 <li>Config: tenant_domain</li> 32413 <li>Env Var: RCLONE_SWIFT_TENANT_DOMAIN</li> 32414 <li>Type: string</li> 32415 <li>Required: false</li> 32416 </ul> 32417 <h4 id="swift-region">--swift-region</h4> 32418 <p>Region name - optional (OS_REGION_NAME).</p> 32419 <p>Properties:</p> 32420 <ul> 32421 <li>Config: region</li> 32422 <li>Env Var: RCLONE_SWIFT_REGION</li> 32423 <li>Type: string</li> 32424 <li>Required: false</li> 32425 </ul> 32426 <h4 id="swift-storage-url">--swift-storage-url</h4> 32427 <p>Storage URL - optional (OS_STORAGE_URL).</p> 32428 <p>Properties:</p> 32429 <ul> 32430 <li>Config: storage_url</li> 32431 <li>Env Var: RCLONE_SWIFT_STORAGE_URL</li> 32432 <li>Type: string</li> 32433 <li>Required: false</li> 32434 </ul> 32435 <h4 id="swift-auth-token">--swift-auth-token</h4> 32436 <p>Auth Token from alternate authentication - optional (OS_AUTH_TOKEN).</p> 32437 <p>Properties:</p> 32438 <ul> 32439 <li>Config: auth_token</li> 32440 <li>Env Var: RCLONE_SWIFT_AUTH_TOKEN</li> 32441 <li>Type: string</li> 32442 <li>Required: false</li> 32443 </ul> 32444 <h4 id="swift-application-credential-id">--swift-application-credential-id</h4> 32445 <p>Application Credential ID (OS_APPLICATION_CREDENTIAL_ID).</p> 32446 <p>Properties:</p> 32447 <ul> 32448 <li>Config: application_credential_id</li> 32449 <li>Env Var: RCLONE_SWIFT_APPLICATION_CREDENTIAL_ID</li> 32450 <li>Type: string</li> 32451 <li>Required: false</li> 32452 </ul> 32453 <h4 id="swift-application-credential-name">--swift-application-credential-name</h4> 32454 <p>Application Credential Name (OS_APPLICATION_CREDENTIAL_NAME).</p> 32455 <p>Properties:</p> 32456 <ul> 32457 <li>Config: application_credential_name</li> 32458 <li>Env Var: RCLONE_SWIFT_APPLICATION_CREDENTIAL_NAME</li> 32459 <li>Type: string</li> 32460 <li>Required: false</li> 32461 </ul> 32462 <h4 id="swift-application-credential-secret">--swift-application-credential-secret</h4> 32463 <p>Application Credential Secret (OS_APPLICATION_CREDENTIAL_SECRET).</p> 32464 <p>Properties:</p> 32465 <ul> 32466 <li>Config: application_credential_secret</li> 32467 <li>Env Var: RCLONE_SWIFT_APPLICATION_CREDENTIAL_SECRET</li> 32468 <li>Type: string</li> 32469 <li>Required: false</li> 32470 </ul> 32471 <h4 id="swift-auth-version">--swift-auth-version</h4> 32472 <p>AuthVersion - optional - set to (1,2,3) if your auth URL has no version (ST_AUTH_VERSION).</p> 32473 <p>Properties:</p> 32474 <ul> 32475 <li>Config: auth_version</li> 32476 <li>Env Var: RCLONE_SWIFT_AUTH_VERSION</li> 32477 <li>Type: int</li> 32478 <li>Default: 0</li> 32479 </ul> 32480 <h4 id="swift-endpoint-type">--swift-endpoint-type</h4> 32481 <p>Endpoint type to choose from the service catalogue (OS_ENDPOINT_TYPE).</p> 32482 <p>Properties:</p> 32483 <ul> 32484 <li>Config: endpoint_type</li> 32485 <li>Env Var: RCLONE_SWIFT_ENDPOINT_TYPE</li> 32486 <li>Type: string</li> 32487 <li>Default: "public"</li> 32488 <li>Examples: 32489 <ul> 32490 <li>"public" 32491 <ul> 32492 <li>Public (default, choose this if not sure)</li> 32493 </ul></li> 32494 <li>"internal" 32495 <ul> 32496 <li>Internal (use internal service net)</li> 32497 </ul></li> 32498 <li>"admin" 32499 <ul> 32500 <li>Admin</li> 32501 </ul></li> 32502 </ul></li> 32503 </ul> 32504 <h4 id="swift-storage-policy">--swift-storage-policy</h4> 32505 <p>The storage policy to use when creating a new container.</p> 32506 <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> 32507 <p>Properties:</p> 32508 <ul> 32509 <li>Config: storage_policy</li> 32510 <li>Env Var: RCLONE_SWIFT_STORAGE_POLICY</li> 32511 <li>Type: string</li> 32512 <li>Required: false</li> 32513 <li>Examples: 32514 <ul> 32515 <li>"" 32516 <ul> 32517 <li>Default</li> 32518 </ul></li> 32519 <li>"pcs" 32520 <ul> 32521 <li>OVH Public Cloud Storage</li> 32522 </ul></li> 32523 <li>"pca" 32524 <ul> 32525 <li>OVH Public Cloud Archive</li> 32526 </ul></li> 32527 </ul></li> 32528 </ul> 32529 <h3 id="advanced-options-8">Advanced options</h3> 32530 <p>Here are the Advanced options specific to swift (OpenStack Swift (Rackspace Cloud Files, Blomp Cloud Storage, Memset Memstore, OVH)).</p> 32531 <h4 id="swift-leave-parts-on-error">--swift-leave-parts-on-error</h4> 32532 <p>If true avoid calling abort upload on a failure.</p> 32533 <p>It should be set to true for resuming uploads across different sessions.</p> 32534 <p>Properties:</p> 32535 <ul> 32536 <li>Config: leave_parts_on_error</li> 32537 <li>Env Var: RCLONE_SWIFT_LEAVE_PARTS_ON_ERROR</li> 32538 <li>Type: bool</li> 32539 <li>Default: false</li> 32540 </ul> 32541 <h4 id="swift-chunk-size">--swift-chunk-size</h4> 32542 <p>Above this size files will be chunked into a _segments container.</p> 32543 <p>Above this size files will be chunked into a _segments container. The default for this is 5 GiB which is its maximum value.</p> 32544 <p>Properties:</p> 32545 <ul> 32546 <li>Config: chunk_size</li> 32547 <li>Env Var: RCLONE_SWIFT_CHUNK_SIZE</li> 32548 <li>Type: SizeSuffix</li> 32549 <li>Default: 5Gi</li> 32550 </ul> 32551 <h4 id="swift-no-chunk">--swift-no-chunk</h4> 32552 <p>Don't chunk files during streaming upload.</p> 32553 <p>When doing streaming uploads (e.g. using rcat or mount) setting this flag will cause the swift backend to not upload chunked files.</p> 32554 <p>This will limit the maximum upload size to 5 GiB. However non chunked files are easier to deal with and have an MD5SUM.</p> 32555 <p>Rclone will still chunk files bigger than chunk_size when doing normal copy operations.</p> 32556 <p>Properties:</p> 32557 <ul> 32558 <li>Config: no_chunk</li> 32559 <li>Env Var: RCLONE_SWIFT_NO_CHUNK</li> 32560 <li>Type: bool</li> 32561 <li>Default: false</li> 32562 </ul> 32563 <h4 id="swift-no-large-objects">--swift-no-large-objects</h4> 32564 <p>Disable support for static and dynamic large objects</p> 32565 <p>Swift cannot transparently store files bigger than 5 GiB. There are two schemes for doing that, static or dynamic large objects, and the API does not allow rclone to determine whether a file is a static or dynamic large object without doing a HEAD on the object. Since these need to be treated differently, this means rclone has to issue HEAD requests for objects for example when reading checksums.</p> 32566 <p>When <code>no_large_objects</code> is set, rclone will assume that there are no static or dynamic large objects stored. This means it can stop doing the extra HEAD calls which in turn increases performance greatly especially when doing a swift to swift transfer with <code>--checksum</code> set.</p> 32567 <p>Setting this option implies <code>no_chunk</code> and also that no files will be uploaded in chunks, so files bigger than 5 GiB will just fail on upload.</p> 32568 <p>If you set this option and there <em>are</em> static or dynamic large objects, then this will give incorrect hashes for them. Downloads will succeed, but other operations such as Remove and Copy will fail.</p> 32569 <p>Properties:</p> 32570 <ul> 32571 <li>Config: no_large_objects</li> 32572 <li>Env Var: RCLONE_SWIFT_NO_LARGE_OBJECTS</li> 32573 <li>Type: bool</li> 32574 <li>Default: false</li> 32575 </ul> 32576 <h4 id="swift-encoding">--swift-encoding</h4> 32577 <p>The encoding for the backend.</p> 32578 <p>See the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 32579 <p>Properties:</p> 32580 <ul> 32581 <li>Config: encoding</li> 32582 <li>Env Var: RCLONE_SWIFT_ENCODING</li> 32583 <li>Type: Encoding</li> 32584 <li>Default: Slash,InvalidUtf8</li> 32585 </ul> 32586 <h4 id="swift-description">--swift-description</h4> 32587 <p>Description of the remote</p> 32588 <p>Properties:</p> 32589 <ul> 32590 <li>Config: description</li> 32591 <li>Env Var: RCLONE_SWIFT_DESCRIPTION</li> 32592 <li>Type: string</li> 32593 <li>Required: false</li> 32594 </ul> 32595 <h2 id="limitations-11">Limitations</h2> 32596 <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> 32597 <h2 id="troubleshooting-2">Troubleshooting</h2> 32598 <h3 id="rclone-gives-failed-to-create-file-system-for-remote-bad-request">Rclone gives Failed to create file system for "remote:": Bad Request</h3> 32599 <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> 32600 <p>So this most likely means your username / password is wrong. You can investigate further with the <code>--dump-bodies</code> flag.</p> 32601 <p>This may also be caused by specifying the region when you shouldn't have (e.g. OVH).</p> 32602 <h3 id="rclone-gives-failed-to-create-file-system-response-didnt-have-storage-url-and-auth-token">Rclone gives Failed to create file system: Response didn't have storage url and auth token</h3> 32603 <p>This is most likely caused by forgetting to specify your tenant when setting up a swift remote.</p> 32604 <h2 id="ovh-cloud-archive">OVH Cloud Archive</h2> 32605 <p>To use rclone with OVH cloud archive, first use <code>rclone config</code> to set up a <code>swift</code> backend with OVH, choosing <code>pca</code> as the <code>storage_policy</code>.</p> 32606 <h3 id="uploading-objects">Uploading Objects</h3> 32607 <p>Uploading objects to OVH cloud archive is no different to object storage, you just simply run the command you like (move, copy or sync) to upload the objects. Once uploaded the objects will show in a "Frozen" state within the OVH control panel.</p> 32608 <h3 id="retrieving-objects">Retrieving Objects</h3> 32609 <p>To retrieve objects use <code>rclone copy</code> as normal. If the objects are in a frozen state then rclone will ask for them all to be unfrozen and it will wait at the end of the output with a message like the following:</p> 32610 <p><code>2019/03/23 13:06:33 NOTICE: Received retry after error - sleeping until 2019-03-23T13:16:33.481657164+01:00 (9m59.99985121s)</code></p> 32611 <p>Rclone will wait for the time specified then retry the copy.</p> 32612 <h1 id="pcloud">pCloud</h1> 32613 <p>Paths are specified as <code>remote:path</code></p> 32614 <p>Paths may be as deep as required, e.g. <code>remote:directory/subdirectory</code>.</p> 32615 <h2 id="configuration-9">Configuration</h2> 32616 <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> 32617 <p>Here is an example of how to make a remote called <code>remote</code>. First run:</p> 32618 <pre><code> rclone config</code></pre> 32619 <p>This will guide you through an interactive setup process:</p> 32620 <pre><code>No remotes found, make a new one? 32621 n) New remote 32622 s) Set configuration password 32623 q) Quit config 32624 n/s/q> n 32625 name> remote 32626 Type of storage to configure. 32627 Choose a number from below, or type in your own value 32628 [snip] 32629 XX / Pcloud 32630 \ "pcloud" 32631 [snip] 32632 Storage> pcloud 32633 Pcloud App Client Id - leave blank normally. 32634 client_id> 32635 Pcloud App Client Secret - leave blank normally. 32636 client_secret> 32637 Remote config 32638 Use web browser to automatically authenticate rclone with remote? 32639 * Say Y if the machine running rclone has a web browser you can use 32640 * Say N if running rclone on a (remote) machine without web browser access 32641 If not sure try Y. If Y failed, try N. 32642 y) Yes 32643 n) No 32644 y/n> y 32645 If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth 32646 Log in and authorize rclone for access 32647 Waiting for code... 32648 Got code 32649 -------------------- 32650 [remote] 32651 client_id = 32652 client_secret = 32653 token = {"access_token":"XXX","token_type":"bearer","expiry":"0001-01-01T00:00:00Z"} 32654 -------------------- 32655 y) Yes this is OK 32656 e) Edit this remote 32657 d) Delete this remote 32658 y/e/d> y</code></pre> 32659 <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> 32660 <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> 32661 <p>Once configured you can then use <code>rclone</code> like this,</p> 32662 <p>List directories in top level of your pCloud</p> 32663 <pre><code>rclone lsd remote:</code></pre> 32664 <p>List all the files in your pCloud</p> 32665 <pre><code>rclone ls remote:</code></pre> 32666 <p>To copy a local directory to a pCloud directory called backup</p> 32667 <pre><code>rclone copy /home/source remote:backup</code></pre> 32668 <h3 id="modification-times-and-hashes-6">Modification times and hashes</h3> 32669 <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> 32670 <p>pCloud supports MD5 and SHA1 hashes in the US region, and SHA1 and SHA256 hashes in the EU region, so you can use the <code>--checksum</code> flag.</p> 32671 <h3 id="restricted-filename-characters-6">Restricted filename characters</h3> 32672 <p>In addition to the <a href="https://rclone.org/overview/#restricted-characters">default restricted characters set</a> the following characters are also replaced:</p> 32673 <table> 32674 <thead> 32675 <tr class="header"> 32676 <th>Character</th> 32677 <th style="text-align: center;">Value</th> 32678 <th style="text-align: center;">Replacement</th> 32679 </tr> 32680 </thead> 32681 <tbody> 32682 <tr class="odd"> 32683 <td>\</td> 32684 <td style="text-align: center;">0x5C</td> 32685 <td style="text-align: center;">＼</td> 32686 </tr> 32687 </tbody> 32688 </table> 32689 <p>Invalid UTF-8 bytes will also be <a href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they can't be used in JSON strings.</p> 32690 <h3 id="deleting-files-1">Deleting files</h3> 32691 <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> 32692 <h3 id="emptying-the-trash">Emptying the trash</h3> 32693 <p>Due to an API limitation, the <code>rclone cleanup</code> command will only work if you set your username and password in the advanced options for this backend. Since we generally want to avoid storing user passwords in the rclone config file, we advise you to only set this up if you need the <code>rclone cleanup</code> command to work.</p> 32694 <h3 id="root-folder-id">Root folder ID</h3> 32695 <p>You can set the <code>root_folder_id</code> for rclone. This is the directory (identified by its <code>Folder ID</code>) that rclone considers to be the root of your pCloud drive.</p> 32696 <p>Normally you will leave this blank and rclone will determine the correct root to use itself.</p> 32697 <p>However you can set this to restrict rclone to a specific folder hierarchy.</p> 32698 <p>In order to do this you will have to find the <code>Folder ID</code> of the directory you wish rclone to display. This will be the <code>folder</code> field of the URL when you open the relevant folder in the pCloud web interface.</p> 32699 <p>So if the folder you want rclone to use has a URL which looks like <code>https://my.pcloud.com/#page=filemanager&folder=5xxxxxxxx8&tpl=foldergrid</code> in the browser, then you use <code>5xxxxxxxx8</code> as the <code>root_folder_id</code> in the config.</p> 32700 <h3 id="standard-options-9">Standard options</h3> 32701 <p>Here are the Standard options specific to pcloud (Pcloud).</p> 32702 <h4 id="pcloud-client-id">--pcloud-client-id</h4> 32703 <p>OAuth Client Id.</p> 32704 <p>Leave blank normally.</p> 32705 <p>Properties:</p> 32706 <ul> 32707 <li>Config: client_id</li> 32708 <li>Env Var: RCLONE_PCLOUD_CLIENT_ID</li> 32709 <li>Type: string</li> 32710 <li>Required: false</li> 32711 </ul> 32712 <h4 id="pcloud-client-secret">--pcloud-client-secret</h4> 32713 <p>OAuth Client Secret.</p> 32714 <p>Leave blank normally.</p> 32715 <p>Properties:</p> 32716 <ul> 32717 <li>Config: client_secret</li> 32718 <li>Env Var: RCLONE_PCLOUD_CLIENT_SECRET</li> 32719 <li>Type: string</li> 32720 <li>Required: false</li> 32721 </ul> 32722 <h3 id="advanced-options-9">Advanced options</h3> 32723 <p>Here are the Advanced options specific to pcloud (Pcloud).</p> 32724 <h4 id="pcloud-token">--pcloud-token</h4> 32725 <p>OAuth Access Token as a JSON blob.</p> 32726 <p>Properties:</p> 32727 <ul> 32728 <li>Config: token</li> 32729 <li>Env Var: RCLONE_PCLOUD_TOKEN</li> 32730 <li>Type: string</li> 32731 <li>Required: false</li> 32732 </ul> 32733 <h4 id="pcloud-auth-url">--pcloud-auth-url</h4> 32734 <p>Auth server URL.</p> 32735 <p>Leave blank to use the provider defaults.</p> 32736 <p>Properties:</p> 32737 <ul> 32738 <li>Config: auth_url</li> 32739 <li>Env Var: RCLONE_PCLOUD_AUTH_URL</li> 32740 <li>Type: string</li> 32741 <li>Required: false</li> 32742 </ul> 32743 <h4 id="pcloud-token-url">--pcloud-token-url</h4> 32744 <p>Token server url.</p> 32745 <p>Leave blank to use the provider defaults.</p> 32746 <p>Properties:</p> 32747 <ul> 32748 <li>Config: token_url</li> 32749 <li>Env Var: RCLONE_PCLOUD_TOKEN_URL</li> 32750 <li>Type: string</li> 32751 <li>Required: false</li> 32752 </ul> 32753 <h4 id="pcloud-encoding">--pcloud-encoding</h4> 32754 <p>The encoding for the backend.</p> 32755 <p>See the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 32756 <p>Properties:</p> 32757 <ul> 32758 <li>Config: encoding</li> 32759 <li>Env Var: RCLONE_PCLOUD_ENCODING</li> 32760 <li>Type: Encoding</li> 32761 <li>Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot</li> 32762 </ul> 32763 <h4 id="pcloud-root-folder-id">--pcloud-root-folder-id</h4> 32764 <p>Fill in for rclone to use a non root folder as its starting point.</p> 32765 <p>Properties:</p> 32766 <ul> 32767 <li>Config: root_folder_id</li> 32768 <li>Env Var: RCLONE_PCLOUD_ROOT_FOLDER_ID</li> 32769 <li>Type: string</li> 32770 <li>Default: "d0"</li> 32771 </ul> 32772 <h4 id="pcloud-hostname">--pcloud-hostname</h4> 32773 <p>Hostname to connect to.</p> 32774 <p>This is normally set when rclone initially does the oauth connection, however you will need to set it by hand if you are using remote config with rclone authorize.</p> 32775 <p>Properties:</p> 32776 <ul> 32777 <li>Config: hostname</li> 32778 <li>Env Var: RCLONE_PCLOUD_HOSTNAME</li> 32779 <li>Type: string</li> 32780 <li>Default: "api.pcloud.com"</li> 32781 <li>Examples: 32782 <ul> 32783 <li>"api.pcloud.com" 32784 <ul> 32785 <li>Original/US region</li> 32786 </ul></li> 32787 <li>"eapi.pcloud.com" 32788 <ul> 32789 <li>EU region</li> 32790 </ul></li> 32791 </ul></li> 32792 </ul> 32793 <h4 id="pcloud-username">--pcloud-username</h4> 32794 <p>Your pcloud username.</p> 32795 <p>This is only required when you want to use the cleanup command. Due to a bug in the pcloud API the required API does not support OAuth authentication so we have to rely on user password authentication for it.</p> 32796 <p>Properties:</p> 32797 <ul> 32798 <li>Config: username</li> 32799 <li>Env Var: RCLONE_PCLOUD_USERNAME</li> 32800 <li>Type: string</li> 32801 <li>Required: false</li> 32802 </ul> 32803 <h4 id="pcloud-password">--pcloud-password</h4> 32804 <p>Your pcloud password.</p> 32805 <p><strong>NB</strong> Input to this must be obscured - see <a href="https://rclone.org/commands/rclone_obscure/">rclone obscure</a>.</p> 32806 <p>Properties:</p> 32807 <ul> 32808 <li>Config: password</li> 32809 <li>Env Var: RCLONE_PCLOUD_PASSWORD</li> 32810 <li>Type: string</li> 32811 <li>Required: false</li> 32812 </ul> 32813 <h4 id="pcloud-description">--pcloud-description</h4> 32814 <p>Description of the remote</p> 32815 <p>Properties:</p> 32816 <ul> 32817 <li>Config: description</li> 32818 <li>Env Var: RCLONE_PCLOUD_DESCRIPTION</li> 32819 <li>Type: string</li> 32820 <li>Required: false</li> 32821 </ul> 32822 <h1 id="pikpak">PikPak</h1> 32823 <p>PikPak is <a href="https://mypikpak.com/">a private cloud drive</a>.</p> 32824 <p>Paths are specified as <code>remote:path</code>, and may be as deep as required, e.g. <code>remote:directory/subdirectory</code>.</p> 32825 <h2 id="configuration-10">Configuration</h2> 32826 <p>Here is an example of making a remote for PikPak.</p> 32827 <p>First run:</p> 32828 <pre><code> rclone config</code></pre> 32829 <p>This will guide you through an interactive setup process:</p> 32830 <pre><code>No remotes found, make a new one? 32831 n) New remote 32832 s) Set configuration password 32833 q) Quit config 32834 n/s/q> n 32835 32836 Enter name for new remote. 32837 name> remote 32838 32839 Option Storage. 32840 Type of storage to configure. 32841 Choose a number from below, or type in your own value. 32842 XX / PikPak 32843 \ (pikpak) 32844 Storage> XX 32845 32846 Option user. 32847 Pikpak username. 32848 Enter a value. 32849 user> USERNAME 32850 32851 Option pass. 32852 Pikpak password. 32853 Choose an alternative below. 32854 y) Yes, type in my own password 32855 g) Generate random password 32856 y/g> y 32857 Enter the password: 32858 password: 32859 Confirm the password: 32860 password: 32861 32862 Edit advanced config? 32863 y) Yes 32864 n) No (default) 32865 y/n> 32866 32867 Configuration complete. 32868 Options: 32869 - type: pikpak 32870 - user: USERNAME 32871 - pass: *** ENCRYPTED *** 32872 - token: {"access_token":"eyJ...","token_type":"Bearer","refresh_token":"os...","expiry":"2023-01-26T18:54:32.170582647+09:00"} 32873 Keep this "remote" remote? 32874 y) Yes this is OK (default) 32875 e) Edit this remote 32876 d) Delete this remote 32877 y/e/d> y</code></pre> 32878 <h3 id="modification-times-and-hashes-7">Modification times and hashes</h3> 32879 <p>PikPak keeps modification times on objects, and updates them when uploading objects, but it does not support changing only the modification time</p> 32880 <p>The MD5 hash algorithm is supported.</p> 32881 <h3 id="standard-options-10">Standard options</h3> 32882 <p>Here are the Standard options specific to pikpak (PikPak).</p> 32883 <h4 id="pikpak-user">--pikpak-user</h4> 32884 <p>Pikpak username.</p> 32885 <p>Properties:</p> 32886 <ul> 32887 <li>Config: user</li> 32888 <li>Env Var: RCLONE_PIKPAK_USER</li> 32889 <li>Type: string</li> 32890 <li>Required: true</li> 32891 </ul> 32892 <h4 id="pikpak-pass">--pikpak-pass</h4> 32893 <p>Pikpak password.</p> 32894 <p><strong>NB</strong> Input to this must be obscured - see <a href="https://rclone.org/commands/rclone_obscure/">rclone obscure</a>.</p> 32895 <p>Properties:</p> 32896 <ul> 32897 <li>Config: pass</li> 32898 <li>Env Var: RCLONE_PIKPAK_PASS</li> 32899 <li>Type: string</li> 32900 <li>Required: true</li> 32901 </ul> 32902 <h3 id="advanced-options-10">Advanced options</h3> 32903 <p>Here are the Advanced options specific to pikpak (PikPak).</p> 32904 <h4 id="pikpak-client-id">--pikpak-client-id</h4> 32905 <p>OAuth Client Id.</p> 32906 <p>Leave blank normally.</p> 32907 <p>Properties:</p> 32908 <ul> 32909 <li>Config: client_id</li> 32910 <li>Env Var: RCLONE_PIKPAK_CLIENT_ID</li> 32911 <li>Type: string</li> 32912 <li>Required: false</li> 32913 </ul> 32914 <h4 id="pikpak-client-secret">--pikpak-client-secret</h4> 32915 <p>OAuth Client Secret.</p> 32916 <p>Leave blank normally.</p> 32917 <p>Properties:</p> 32918 <ul> 32919 <li>Config: client_secret</li> 32920 <li>Env Var: RCLONE_PIKPAK_CLIENT_SECRET</li> 32921 <li>Type: string</li> 32922 <li>Required: false</li> 32923 </ul> 32924 <h4 id="pikpak-token">--pikpak-token</h4> 32925 <p>OAuth Access Token as a JSON blob.</p> 32926 <p>Properties:</p> 32927 <ul> 32928 <li>Config: token</li> 32929 <li>Env Var: RCLONE_PIKPAK_TOKEN</li> 32930 <li>Type: string</li> 32931 <li>Required: false</li> 32932 </ul> 32933 <h4 id="pikpak-auth-url">--pikpak-auth-url</h4> 32934 <p>Auth server URL.</p> 32935 <p>Leave blank to use the provider defaults.</p> 32936 <p>Properties:</p> 32937 <ul> 32938 <li>Config: auth_url</li> 32939 <li>Env Var: RCLONE_PIKPAK_AUTH_URL</li> 32940 <li>Type: string</li> 32941 <li>Required: false</li> 32942 </ul> 32943 <h4 id="pikpak-token-url">--pikpak-token-url</h4> 32944 <p>Token server url.</p> 32945 <p>Leave blank to use the provider defaults.</p> 32946 <p>Properties:</p> 32947 <ul> 32948 <li>Config: token_url</li> 32949 <li>Env Var: RCLONE_PIKPAK_TOKEN_URL</li> 32950 <li>Type: string</li> 32951 <li>Required: false</li> 32952 </ul> 32953 <h4 id="pikpak-root-folder-id">--pikpak-root-folder-id</h4> 32954 <p>ID of the root folder. Leave blank normally.</p> 32955 <p>Fill in for rclone to use a non root folder as its starting point.</p> 32956 <p>Properties:</p> 32957 <ul> 32958 <li>Config: root_folder_id</li> 32959 <li>Env Var: RCLONE_PIKPAK_ROOT_FOLDER_ID</li> 32960 <li>Type: string</li> 32961 <li>Required: false</li> 32962 </ul> 32963 <h4 id="pikpak-use-trash">--pikpak-use-trash</h4> 32964 <p>Send files to the trash instead of deleting permanently.</p> 32965 <p>Defaults to true, namely sending files to the trash. Use <code>--pikpak-use-trash=false</code> to delete files permanently instead.</p> 32966 <p>Properties:</p> 32967 <ul> 32968 <li>Config: use_trash</li> 32969 <li>Env Var: RCLONE_PIKPAK_USE_TRASH</li> 32970 <li>Type: bool</li> 32971 <li>Default: true</li> 32972 </ul> 32973 <h4 id="pikpak-trashed-only">--pikpak-trashed-only</h4> 32974 <p>Only show files that are in the trash.</p> 32975 <p>This will show trashed files in their original directory structure.</p> 32976 <p>Properties:</p> 32977 <ul> 32978 <li>Config: trashed_only</li> 32979 <li>Env Var: RCLONE_PIKPAK_TRASHED_ONLY</li> 32980 <li>Type: bool</li> 32981 <li>Default: false</li> 32982 </ul> 32983 <h4 id="pikpak-hash-memory-limit">--pikpak-hash-memory-limit</h4> 32984 <p>Files bigger than this will be cached on disk to calculate hash if required.</p> 32985 <p>Properties:</p> 32986 <ul> 32987 <li>Config: hash_memory_limit</li> 32988 <li>Env Var: RCLONE_PIKPAK_HASH_MEMORY_LIMIT</li> 32989 <li>Type: SizeSuffix</li> 32990 <li>Default: 10Mi</li> 32991 </ul> 32992 <h4 id="pikpak-encoding">--pikpak-encoding</h4> 32993 <p>The encoding for the backend.</p> 32994 <p>See the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 32995 <p>Properties:</p> 32996 <ul> 32997 <li>Config: encoding</li> 32998 <li>Env Var: RCLONE_PIKPAK_ENCODING</li> 32999 <li>Type: Encoding</li> 33000 <li>Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,RightSpace,RightPeriod,InvalidUtf8,Dot</li> 33001 </ul> 33002 <h4 id="pikpak-description">--pikpak-description</h4> 33003 <p>Description of the remote</p> 33004 <p>Properties:</p> 33005 <ul> 33006 <li>Config: description</li> 33007 <li>Env Var: RCLONE_PIKPAK_DESCRIPTION</li> 33008 <li>Type: string</li> 33009 <li>Required: false</li> 33010 </ul> 33011 <h2 id="backend-commands-2">Backend commands</h2> 33012 <p>Here are the commands specific to the pikpak backend.</p> 33013 <p>Run them with</p> 33014 <pre><code>rclone backend COMMAND remote:</code></pre> 33015 <p>The help below will explain what arguments each command takes.</p> 33016 <p>See the <a href="https://rclone.org/commands/rclone_backend/">backend</a> command for more info on how to pass options and arguments.</p> 33017 <p>These can be run on a running backend using the rc command <a href="https://rclone.org/rc/#backend-command">backend/command</a>.</p> 33018 <h3 id="addurl">addurl</h3> 33019 <p>Add offline download task for url</p> 33020 <pre><code>rclone backend addurl remote: [options] [<arguments>+]</code></pre> 33021 <p>This command adds offline download task for url.</p> 33022 <p>Usage:</p> 33023 <pre><code>rclone backend addurl pikpak:dirpath url</code></pre> 33024 <p>Downloads will be stored in 'dirpath'. If 'dirpath' is invalid, download will fallback to default 'My Pack' folder.</p> 33025 <h3 id="decompress">decompress</h3> 33026 <p>Request decompress of a file/files in a folder</p> 33027 <pre><code>rclone backend decompress remote: [options] [<arguments>+]</code></pre> 33028 <p>This command requests decompress of file/files in a folder.</p> 33029 <p>Usage:</p> 33030 <pre><code>rclone backend decompress pikpak:dirpath {filename} -o password=password 33031 rclone backend decompress pikpak:dirpath {filename} -o delete-src-file</code></pre> 33032 <p>An optional argument 'filename' can be specified for a file located in 'pikpak:dirpath'. You may want to pass '-o password=password' for a password-protected files. Also, pass '-o delete-src-file' to delete source files after decompression finished.</p> 33033 <p>Result:</p> 33034 <pre><code>{ 33035 "Decompressed": 17, 33036 "SourceDeleted": 0, 33037 "Errors": 0 33038 }</code></pre> 33039 <h2 id="limitations-12">Limitations</h2> 33040 <h3 id="hashes-may-be-empty">Hashes may be empty</h3> 33041 <p>PikPak supports MD5 hash, but sometimes given empty especially for user-uploaded files.</p> 33042 <h3 id="deleted-files-still-visible-with-trashed-only">Deleted files still visible with trashed-only</h3> 33043 <p>Deleted files will still be visible with <code>--pikpak-trashed-only</code> even after the trash emptied. This goes away after few days.</p> 33044 <h1 id="premiumize.me">premiumize.me</h1> 33045 <p>Paths are specified as <code>remote:path</code></p> 33046 <p>Paths may be as deep as required, e.g. <code>remote:directory/subdirectory</code>.</p> 33047 <h2 id="configuration-11">Configuration</h2> 33048 <p>The initial setup for <a href="https://premiumize.me/">premiumize.me</a> involves getting a token from premiumize.me which you need to do in your browser. <code>rclone config</code> walks you through it.</p> 33049 <p>Here is an example of how to make a remote called <code>remote</code>. First run:</p> 33050 <pre><code> rclone config</code></pre> 33051 <p>This will guide you through an interactive setup process:</p> 33052 <pre><code>No remotes found, make a new one? 33053 n) New remote 33054 s) Set configuration password 33055 q) Quit config 33056 n/s/q> n 33057 name> remote 33058 Type of storage to configure. 33059 Enter a string value. Press Enter for the default (""). 33060 Choose a number from below, or type in your own value 33061 [snip] 33062 XX / premiumize.me 33063 \ "premiumizeme" 33064 [snip] 33065 Storage> premiumizeme 33066 ** See help for premiumizeme backend at: https://rclone.org/premiumizeme/ ** 33067 33068 Remote config 33069 Use web browser to automatically authenticate rclone with remote? 33070 * Say Y if the machine running rclone has a web browser you can use 33071 * Say N if running rclone on a (remote) machine without web browser access 33072 If not sure try Y. If Y failed, try N. 33073 y) Yes 33074 n) No 33075 y/n> y 33076 If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth 33077 Log in and authorize rclone for access 33078 Waiting for code... 33079 Got code 33080 -------------------- 33081 [remote] 33082 type = premiumizeme 33083 token = {"access_token":"XXX","token_type":"Bearer","refresh_token":"XXX","expiry":"2029-08-07T18:44:15.548915378+01:00"} 33084 -------------------- 33085 y) Yes this is OK 33086 e) Edit this remote 33087 d) Delete this remote 33088 y/e/d> </code></pre> 33089 <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> 33090 <p>Note that rclone runs a webserver on your local machine to collect the token as returned from premiumize.me. This only runs from the moment it opens your browser to the moment you get back the verification code. This is on <code>http://127.0.0.1:53682/</code> and this it may require you to unblock it temporarily if you are running a host firewall.</p> 33091 <p>Once configured you can then use <code>rclone</code> like this,</p> 33092 <p>List directories in top level of your premiumize.me</p> 33093 <pre><code>rclone lsd remote:</code></pre> 33094 <p>List all the files in your premiumize.me</p> 33095 <pre><code>rclone ls remote:</code></pre> 33096 <p>To copy a local directory to an premiumize.me directory called backup</p> 33097 <pre><code>rclone copy /home/source remote:backup</code></pre> 33098 <h3 id="modification-times-and-hashes-8">Modification times and hashes</h3> 33099 <p>premiumize.me does not support modification times or hashes, therefore syncing will default to <code>--size-only</code> checking. Note that using <code>--update</code> will work.</p> 33100 <h3 id="restricted-filename-characters-7">Restricted filename characters</h3> 33101 <p>In addition to the <a href="https://rclone.org/overview/#restricted-characters">default restricted characters set</a> the following characters are also replaced:</p> 33102 <table> 33103 <thead> 33104 <tr class="header"> 33105 <th>Character</th> 33106 <th style="text-align: center;">Value</th> 33107 <th style="text-align: center;">Replacement</th> 33108 </tr> 33109 </thead> 33110 <tbody> 33111 <tr class="odd"> 33112 <td>\</td> 33113 <td style="text-align: center;">0x5C</td> 33114 <td style="text-align: center;">＼</td> 33115 </tr> 33116 <tr class="even"> 33117 <td>"</td> 33118 <td style="text-align: center;">0x22</td> 33119 <td style="text-align: center;">＂</td> 33120 </tr> 33121 </tbody> 33122 </table> 33123 <p>Invalid UTF-8 bytes will also be <a href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they can't be used in JSON strings.</p> 33124 <h3 id="standard-options-11">Standard options</h3> 33125 <p>Here are the Standard options specific to premiumizeme (premiumize.me).</p> 33126 <h4 id="premiumizeme-client-id">--premiumizeme-client-id</h4> 33127 <p>OAuth Client Id.</p> 33128 <p>Leave blank normally.</p> 33129 <p>Properties:</p> 33130 <ul> 33131 <li>Config: client_id</li> 33132 <li>Env Var: RCLONE_PREMIUMIZEME_CLIENT_ID</li> 33133 <li>Type: string</li> 33134 <li>Required: false</li> 33135 </ul> 33136 <h4 id="premiumizeme-client-secret">--premiumizeme-client-secret</h4> 33137 <p>OAuth Client Secret.</p> 33138 <p>Leave blank normally.</p> 33139 <p>Properties:</p> 33140 <ul> 33141 <li>Config: client_secret</li> 33142 <li>Env Var: RCLONE_PREMIUMIZEME_CLIENT_SECRET</li> 33143 <li>Type: string</li> 33144 <li>Required: false</li> 33145 </ul> 33146 <h4 id="premiumizeme-api-key">--premiumizeme-api-key</h4> 33147 <p>API Key.</p> 33148 <p>This is not normally used - use oauth instead.</p> 33149 <p>Properties:</p> 33150 <ul> 33151 <li>Config: api_key</li> 33152 <li>Env Var: RCLONE_PREMIUMIZEME_API_KEY</li> 33153 <li>Type: string</li> 33154 <li>Required: false</li> 33155 </ul> 33156 <h3 id="advanced-options-11">Advanced options</h3> 33157 <p>Here are the Advanced options specific to premiumizeme (premiumize.me).</p> 33158 <h4 id="premiumizeme-token">--premiumizeme-token</h4> 33159 <p>OAuth Access Token as a JSON blob.</p> 33160 <p>Properties:</p> 33161 <ul> 33162 <li>Config: token</li> 33163 <li>Env Var: RCLONE_PREMIUMIZEME_TOKEN</li> 33164 <li>Type: string</li> 33165 <li>Required: false</li> 33166 </ul> 33167 <h4 id="premiumizeme-auth-url">--premiumizeme-auth-url</h4> 33168 <p>Auth server URL.</p> 33169 <p>Leave blank to use the provider defaults.</p> 33170 <p>Properties:</p> 33171 <ul> 33172 <li>Config: auth_url</li> 33173 <li>Env Var: RCLONE_PREMIUMIZEME_AUTH_URL</li> 33174 <li>Type: string</li> 33175 <li>Required: false</li> 33176 </ul> 33177 <h4 id="premiumizeme-token-url">--premiumizeme-token-url</h4> 33178 <p>Token server url.</p> 33179 <p>Leave blank to use the provider defaults.</p> 33180 <p>Properties:</p> 33181 <ul> 33182 <li>Config: token_url</li> 33183 <li>Env Var: RCLONE_PREMIUMIZEME_TOKEN_URL</li> 33184 <li>Type: string</li> 33185 <li>Required: false</li> 33186 </ul> 33187 <h4 id="premiumizeme-encoding">--premiumizeme-encoding</h4> 33188 <p>The encoding for the backend.</p> 33189 <p>See the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 33190 <p>Properties:</p> 33191 <ul> 33192 <li>Config: encoding</li> 33193 <li>Env Var: RCLONE_PREMIUMIZEME_ENCODING</li> 33194 <li>Type: Encoding</li> 33195 <li>Default: Slash,DoubleQuote,BackSlash,Del,Ctl,InvalidUtf8,Dot</li> 33196 </ul> 33197 <h4 id="premiumizeme-description">--premiumizeme-description</h4> 33198 <p>Description of the remote</p> 33199 <p>Properties:</p> 33200 <ul> 33201 <li>Config: description</li> 33202 <li>Env Var: RCLONE_PREMIUMIZEME_DESCRIPTION</li> 33203 <li>Type: string</li> 33204 <li>Required: false</li> 33205 </ul> 33206 <h2 id="limitations-13">Limitations</h2> 33207 <p>Note that premiumize.me is case insensitive so you can't have a file called "Hello.doc" and one called "hello.doc".</p> 33208 <p>premiumize.me file names can't have the <code>\</code> or <code>"</code> characters in. rclone maps these to and from an identical looking unicode equivalents <code>＼</code> and <code>＂</code></p> 33209 <p>premiumize.me only supports filenames up to 255 characters in length.</p> 33210 <h1 id="proton-drive">Proton Drive</h1> 33211 <p><a href="https://proton.me/drive">Proton Drive</a> is an end-to-end encrypted Swiss vault for your files that protects your data.</p> 33212 <p>This is an rclone backend for Proton Drive which supports the file transfer features of Proton Drive using the same client-side encryption.</p> 33213 <p>Due to the fact that Proton Drive doesn't publish its API documentation, this backend is implemented with best efforts by reading the open-sourced client source code and observing the Proton Drive traffic in the browser.</p> 33214 <p><strong>NB</strong> This backend is currently in Beta. It is believed to be correct and all the integration tests pass. However the Proton Drive protocol has evolved over time there may be accounts it is not compatible with. Please <a href="https://forum.rclone.org/">post on the rclone forum</a> if you find an incompatibility.</p> 33215 <p>Paths are specified as <code>remote:path</code></p> 33216 <p>Paths may be as deep as required, e.g. <code>remote:directory/subdirectory</code>.</p> 33217 <h2 id="configurations">Configurations</h2> 33218 <p>Here is an example of how to make a remote called <code>remote</code>. First run:</p> 33219 <pre><code> rclone config</code></pre> 33220 <p>This will guide you through an interactive setup process:</p> 33221 <pre><code>No remotes found, make a new one? 33222 n) New remote 33223 s) Set configuration password 33224 q) Quit config 33225 n/s/q> n 33226 name> remote 33227 Type of storage to configure. 33228 Choose a number from below, or type in your own value 33229 [snip] 33230 XX / Proton Drive 33231 \ "Proton Drive" 33232 [snip] 33233 Storage> protondrive 33234 User name 33235 user> you@protonmail.com 33236 Password. 33237 y) Yes type in my own password 33238 g) Generate random password 33239 n) No leave this optional password blank 33240 y/g/n> y 33241 Enter the password: 33242 password: 33243 Confirm the password: 33244 password: 33245 Option 2fa. 33246 2FA code (if the account requires one) 33247 Enter a value. Press Enter to leave empty. 33248 2fa> 123456 33249 Remote config 33250 -------------------- 33251 [remote] 33252 type = protondrive 33253 user = you@protonmail.com 33254 pass = *** ENCRYPTED *** 33255 -------------------- 33256 y) Yes this is OK 33257 e) Edit this remote 33258 d) Delete this remote 33259 y/e/d> y</code></pre> 33260 <p><strong>NOTE:</strong> The Proton Drive 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> 33261 <p>Once configured you can then use <code>rclone</code> like this,</p> 33262 <p>List directories in top level of your Proton Drive</p> 33263 <pre><code>rclone lsd remote:</code></pre> 33264 <p>List all the files in your Proton Drive</p> 33265 <pre><code>rclone ls remote:</code></pre> 33266 <p>To copy a local directory to an Proton Drive directory called backup</p> 33267 <pre><code>rclone copy /home/source remote:backup</code></pre> 33268 <h3 id="modification-times-and-hashes-9">Modification times and hashes</h3> 33269 <p>Proton Drive Bridge does not support updating modification times yet.</p> 33270 <p>The SHA1 hash algorithm is supported.</p> 33271 <h3 id="restricted-filename-characters-8">Restricted filename characters</h3> 33272 <p>Invalid UTF-8 bytes will be <a href="https://rclone.org/overview/#invalid-utf8">replaced</a>, also left and right spaces will be removed (<a href="https://github.com/ProtonMail/WebClients/blob/b4eba99d241af4fdae06ff7138bd651a40ef5d3c/applications/drive/src/app/store/_links/validation.ts#L51">code reference</a>)</p> 33273 <h3 id="duplicated-files-1">Duplicated files</h3> 33274 <p>Proton Drive can not have two files with exactly the same name and path. If the conflict occurs, depending on the advanced config, the file might or might not be overwritten.</p> 33275 <h3 id="mailbox-password"><a href="https://proton.me/support/the-difference-between-the-mailbox-password-and-login-password">Mailbox password</a></h3> 33276 <p>Please set your mailbox password in the advanced config section.</p> 33277 <h3 id="caching">Caching</h3> 33278 <p>The cache is currently built for the case when the rclone is the only instance performing operations to the mount point. The event system, which is the proton API system that provides visibility of what has changed on the drive, is yet to be implemented, so updates from other clients won’t be reflected in the cache. Thus, if there are concurrent clients accessing the same mount point, then we might have a problem with caching the stale data.</p> 33279 <h3 id="standard-options-12">Standard options</h3> 33280 <p>Here are the Standard options specific to protondrive (Proton Drive).</p> 33281 <h4 id="protondrive-username">--protondrive-username</h4> 33282 <p>The username of your proton account</p> 33283 <p>Properties:</p> 33284 <ul> 33285 <li>Config: username</li> 33286 <li>Env Var: RCLONE_PROTONDRIVE_USERNAME</li> 33287 <li>Type: string</li> 33288 <li>Required: true</li> 33289 </ul> 33290 <h4 id="protondrive-password">--protondrive-password</h4> 33291 <p>The password of your proton account.</p> 33292 <p><strong>NB</strong> Input to this must be obscured - see <a href="https://rclone.org/commands/rclone_obscure/">rclone obscure</a>.</p> 33293 <p>Properties:</p> 33294 <ul> 33295 <li>Config: password</li> 33296 <li>Env Var: RCLONE_PROTONDRIVE_PASSWORD</li> 33297 <li>Type: string</li> 33298 <li>Required: true</li> 33299 </ul> 33300 <h4 id="protondrive-2fa">--protondrive-2fa</h4> 33301 <p>The 2FA code</p> 33302 <p>The value can also be provided with --protondrive-2fa=000000</p> 33303 <p>The 2FA code of your proton drive account if the account is set up with two-factor authentication</p> 33304 <p>Properties:</p> 33305 <ul> 33306 <li>Config: 2fa</li> 33307 <li>Env Var: RCLONE_PROTONDRIVE_2FA</li> 33308 <li>Type: string</li> 33309 <li>Required: false</li> 33310 </ul> 33311 <h3 id="advanced-options-12">Advanced options</h3> 33312 <p>Here are the Advanced options specific to protondrive (Proton Drive).</p> 33313 <h4 id="protondrive-mailbox-password">--protondrive-mailbox-password</h4> 33314 <p>The mailbox password of your two-password proton account.</p> 33315 <p>For more information regarding the mailbox password, please check the following official knowledge base article: https://proton.me/support/the-difference-between-the-mailbox-password-and-login-password</p> 33316 <p><strong>NB</strong> Input to this must be obscured - see <a href="https://rclone.org/commands/rclone_obscure/">rclone obscure</a>.</p> 33317 <p>Properties:</p> 33318 <ul> 33319 <li>Config: mailbox_password</li> 33320 <li>Env Var: RCLONE_PROTONDRIVE_MAILBOX_PASSWORD</li> 33321 <li>Type: string</li> 33322 <li>Required: false</li> 33323 </ul> 33324 <h4 id="protondrive-client-uid">--protondrive-client-uid</h4> 33325 <p>Client uid key (internal use only)</p> 33326 <p>Properties:</p> 33327 <ul> 33328 <li>Config: client_uid</li> 33329 <li>Env Var: RCLONE_PROTONDRIVE_CLIENT_UID</li> 33330 <li>Type: string</li> 33331 <li>Required: false</li> 33332 </ul> 33333 <h4 id="protondrive-client-access-token">--protondrive-client-access-token</h4> 33334 <p>Client access token key (internal use only)</p> 33335 <p>Properties:</p> 33336 <ul> 33337 <li>Config: client_access_token</li> 33338 <li>Env Var: RCLONE_PROTONDRIVE_CLIENT_ACCESS_TOKEN</li> 33339 <li>Type: string</li> 33340 <li>Required: false</li> 33341 </ul> 33342 <h4 id="protondrive-client-refresh-token">--protondrive-client-refresh-token</h4> 33343 <p>Client refresh token key (internal use only)</p> 33344 <p>Properties:</p> 33345 <ul> 33346 <li>Config: client_refresh_token</li> 33347 <li>Env Var: RCLONE_PROTONDRIVE_CLIENT_REFRESH_TOKEN</li> 33348 <li>Type: string</li> 33349 <li>Required: false</li> 33350 </ul> 33351 <h4 id="protondrive-client-salted-key-pass">--protondrive-client-salted-key-pass</h4> 33352 <p>Client salted key pass key (internal use only)</p> 33353 <p>Properties:</p> 33354 <ul> 33355 <li>Config: client_salted_key_pass</li> 33356 <li>Env Var: RCLONE_PROTONDRIVE_CLIENT_SALTED_KEY_PASS</li> 33357 <li>Type: string</li> 33358 <li>Required: false</li> 33359 </ul> 33360 <h4 id="protondrive-encoding">--protondrive-encoding</h4> 33361 <p>The encoding for the backend.</p> 33362 <p>See the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 33363 <p>Properties:</p> 33364 <ul> 33365 <li>Config: encoding</li> 33366 <li>Env Var: RCLONE_PROTONDRIVE_ENCODING</li> 33367 <li>Type: Encoding</li> 33368 <li>Default: Slash,LeftSpace,RightSpace,InvalidUtf8,Dot</li> 33369 </ul> 33370 <h4 id="protondrive-original-file-size">--protondrive-original-file-size</h4> 33371 <p>Return the file size before encryption</p> 33372 <p>The size of the encrypted file will be different from (bigger than) the original file size. Unless there is a reason to return the file size after encryption is performed, otherwise, set this option to true, as features like Open() which will need to be supplied with original content size, will fail to operate properly</p> 33373 <p>Properties:</p> 33374 <ul> 33375 <li>Config: original_file_size</li> 33376 <li>Env Var: RCLONE_PROTONDRIVE_ORIGINAL_FILE_SIZE</li> 33377 <li>Type: bool</li> 33378 <li>Default: true</li> 33379 </ul> 33380 <h4 id="protondrive-app-version">--protondrive-app-version</h4> 33381 <p>The app version string</p> 33382 <p>The app version string indicates the client that is currently performing the API request. This information is required and will be sent with every API request.</p> 33383 <p>Properties:</p> 33384 <ul> 33385 <li>Config: app_version</li> 33386 <li>Env Var: RCLONE_PROTONDRIVE_APP_VERSION</li> 33387 <li>Type: string</li> 33388 <li>Default: "macos-drive@1.0.0-alpha.1+rclone"</li> 33389 </ul> 33390 <h4 id="protondrive-replace-existing-draft">--protondrive-replace-existing-draft</h4> 33391 <p>Create a new revision when filename conflict is detected</p> 33392 <p>When a file upload is cancelled or failed before completion, a draft will be created and the subsequent upload of the same file to the same location will be reported as a conflict.</p> 33393 <p>The value can also be set by --protondrive-replace-existing-draft=true</p> 33394 <p>If the option is set to true, the draft will be replaced and then the upload operation will restart. If there are other clients also uploading at the same file location at the same time, the behavior is currently unknown. Need to set to true for integration tests. If the option is set to false, an error "a draft exist - usually this means a file is being uploaded at another client, or, there was a failed upload attempt" will be returned, and no upload will happen.</p> 33395 <p>Properties:</p> 33396 <ul> 33397 <li>Config: replace_existing_draft</li> 33398 <li>Env Var: RCLONE_PROTONDRIVE_REPLACE_EXISTING_DRAFT</li> 33399 <li>Type: bool</li> 33400 <li>Default: false</li> 33401 </ul> 33402 <h4 id="protondrive-enable-caching">--protondrive-enable-caching</h4> 33403 <p>Caches the files and folders metadata to reduce API calls</p> 33404 <p>Notice: If you are mounting ProtonDrive as a VFS, please disable this feature, as the current implementation doesn't update or clear the cache when there are external changes.</p> 33405 <p>The files and folders on ProtonDrive are represented as links with keyrings, which can be cached to improve performance and be friendly to the API server.</p> 33406 <p>The cache is currently built for the case when the rclone is the only instance performing operations to the mount point. The event system, which is the proton API system that provides visibility of what has changed on the drive, is yet to be implemented, so updates from other clients won’t be reflected in the cache. Thus, if there are concurrent clients accessing the same mount point, then we might have a problem with caching the stale data.</p> 33407 <p>Properties:</p> 33408 <ul> 33409 <li>Config: enable_caching</li> 33410 <li>Env Var: RCLONE_PROTONDRIVE_ENABLE_CACHING</li> 33411 <li>Type: bool</li> 33412 <li>Default: true</li> 33413 </ul> 33414 <h4 id="protondrive-description">--protondrive-description</h4> 33415 <p>Description of the remote</p> 33416 <p>Properties:</p> 33417 <ul> 33418 <li>Config: description</li> 33419 <li>Env Var: RCLONE_PROTONDRIVE_DESCRIPTION</li> 33420 <li>Type: string</li> 33421 <li>Required: false</li> 33422 </ul> 33423 <h2 id="limitations-14">Limitations</h2> 33424 <p>This backend uses the <a href="https://github.com/henrybear327/Proton-API-Bridge">Proton-API-Bridge</a>, which is based on <a href="https://github.com/henrybear327/go-proton-api">go-proton-api</a>, a fork of the <a href="https://github.com/ProtonMail/go-proton-api">official repo</a>.</p> 33425 <p>There is no official API documentation available from Proton Drive. But, thanks to Proton open sourcing <a href="https://github.com/ProtonMail/go-proton-api">proton-go-api</a> and the web, iOS, and Android client codebases, we don't need to completely reverse engineer the APIs by observing the web client traffic!</p> 33426 <p><a href="https://github.com/ProtonMail/go-proton-api">proton-go-api</a> provides the basic building blocks of API calls and error handling, such as 429 exponential back-off, but it is pretty much just a barebone interface to the Proton API. For example, the encryption and decryption of the Proton Drive file are not provided in this library.</p> 33427 <p>The Proton-API-Bridge, attempts to bridge the gap, so rclone can be built on top of this quickly. This codebase handles the intricate tasks before and after calling Proton APIs, particularly the complex encryption scheme, allowing developers to implement features for other software on top of this codebase. There are likely quite a few errors in this library, as there isn't official documentation available.</p> 33428 <h1 id="put.io">put.io</h1> 33429 <p>Paths are specified as <code>remote:path</code></p> 33430 <p>put.io paths may be as deep as required, e.g. <code>remote:directory/subdirectory</code>.</p> 33431 <h2 id="configuration-12">Configuration</h2> 33432 <p>The initial setup for put.io involves getting a token from put.io which you need to do in your browser. <code>rclone config</code> walks you through it.</p> 33433 <p>Here is an example of how to make a remote called <code>remote</code>. First run:</p> 33434 <pre><code> rclone config</code></pre> 33435 <p>This will guide you through an interactive setup process:</p> 33436 <pre><code>No remotes found, make a new one? 33437 n) New remote 33438 s) Set configuration password 33439 q) Quit config 33440 n/s/q> n 33441 name> putio 33442 Type of storage to configure. 33443 Enter a string value. Press Enter for the default (""). 33444 Choose a number from below, or type in your own value 33445 [snip] 33446 XX / Put.io 33447 \ "putio" 33448 [snip] 33449 Storage> putio 33450 ** See help for putio backend at: https://rclone.org/putio/ ** 33451 33452 Remote config 33453 Use web browser to automatically authenticate rclone with remote? 33454 * Say Y if the machine running rclone has a web browser you can use 33455 * Say N if running rclone on a (remote) machine without web browser access 33456 If not sure try Y. If Y failed, try N. 33457 y) Yes 33458 n) No 33459 y/n> y 33460 If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth 33461 Log in and authorize rclone for access 33462 Waiting for code... 33463 Got code 33464 -------------------- 33465 [putio] 33466 type = putio 33467 token = {"access_token":"XXXXXXXX","expiry":"0001-01-01T00:00:00Z"} 33468 -------------------- 33469 y) Yes this is OK 33470 e) Edit this remote 33471 d) Delete this remote 33472 y/e/d> y 33473 Current remotes: 33474 33475 Name Type 33476 ==== ==== 33477 putio putio 33478 33479 e) Edit existing remote 33480 n) New remote 33481 d) Delete remote 33482 r) Rename remote 33483 c) Copy remote 33484 s) Set configuration password 33485 q) Quit config 33486 e/n/d/r/c/s/q> q</code></pre> 33487 <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> 33488 <p>Note that rclone runs a webserver on your local machine to collect the token as returned from put.io if using web browser to automatically authenticate. This only runs from the moment it opens your browser to the moment you get back the verification code. This is on <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> 33489 <p>You can then use it like this,</p> 33490 <p>List directories in top level of your put.io</p> 33491 <pre><code>rclone lsd remote:</code></pre> 33492 <p>List all the files in your put.io</p> 33493 <pre><code>rclone ls remote:</code></pre> 33494 <p>To copy a local directory to a put.io directory called backup</p> 33495 <pre><code>rclone copy /home/source remote:backup</code></pre> 33496 <h3 id="restricted-filename-characters-9">Restricted filename characters</h3> 33497 <p>In addition to the <a href="https://rclone.org/overview/#restricted-characters">default restricted characters set</a> the following characters are also replaced:</p> 33498 <table> 33499 <thead> 33500 <tr class="header"> 33501 <th>Character</th> 33502 <th style="text-align: center;">Value</th> 33503 <th style="text-align: center;">Replacement</th> 33504 </tr> 33505 </thead> 33506 <tbody> 33507 <tr class="odd"> 33508 <td>\</td> 33509 <td style="text-align: center;">0x5C</td> 33510 <td style="text-align: center;">＼</td> 33511 </tr> 33512 </tbody> 33513 </table> 33514 <p>Invalid UTF-8 bytes will also be <a href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they can't be used in JSON strings.</p> 33515 <h3 id="standard-options-13">Standard options</h3> 33516 <p>Here are the Standard options specific to putio (Put.io).</p> 33517 <h4 id="putio-client-id">--putio-client-id</h4> 33518 <p>OAuth Client Id.</p> 33519 <p>Leave blank normally.</p> 33520 <p>Properties:</p> 33521 <ul> 33522 <li>Config: client_id</li> 33523 <li>Env Var: RCLONE_PUTIO_CLIENT_ID</li> 33524 <li>Type: string</li> 33525 <li>Required: false</li> 33526 </ul> 33527 <h4 id="putio-client-secret">--putio-client-secret</h4> 33528 <p>OAuth Client Secret.</p> 33529 <p>Leave blank normally.</p> 33530 <p>Properties:</p> 33531 <ul> 33532 <li>Config: client_secret</li> 33533 <li>Env Var: RCLONE_PUTIO_CLIENT_SECRET</li> 33534 <li>Type: string</li> 33535 <li>Required: false</li> 33536 </ul> 33537 <h3 id="advanced-options-13">Advanced options</h3> 33538 <p>Here are the Advanced options specific to putio (Put.io).</p> 33539 <h4 id="putio-token">--putio-token</h4> 33540 <p>OAuth Access Token as a JSON blob.</p> 33541 <p>Properties:</p> 33542 <ul> 33543 <li>Config: token</li> 33544 <li>Env Var: RCLONE_PUTIO_TOKEN</li> 33545 <li>Type: string</li> 33546 <li>Required: false</li> 33547 </ul> 33548 <h4 id="putio-auth-url">--putio-auth-url</h4> 33549 <p>Auth server URL.</p> 33550 <p>Leave blank to use the provider defaults.</p> 33551 <p>Properties:</p> 33552 <ul> 33553 <li>Config: auth_url</li> 33554 <li>Env Var: RCLONE_PUTIO_AUTH_URL</li> 33555 <li>Type: string</li> 33556 <li>Required: false</li> 33557 </ul> 33558 <h4 id="putio-token-url">--putio-token-url</h4> 33559 <p>Token server url.</p> 33560 <p>Leave blank to use the provider defaults.</p> 33561 <p>Properties:</p> 33562 <ul> 33563 <li>Config: token_url</li> 33564 <li>Env Var: RCLONE_PUTIO_TOKEN_URL</li> 33565 <li>Type: string</li> 33566 <li>Required: false</li> 33567 </ul> 33568 <h4 id="putio-encoding">--putio-encoding</h4> 33569 <p>The encoding for the backend.</p> 33570 <p>See the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 33571 <p>Properties:</p> 33572 <ul> 33573 <li>Config: encoding</li> 33574 <li>Env Var: RCLONE_PUTIO_ENCODING</li> 33575 <li>Type: Encoding</li> 33576 <li>Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot</li> 33577 </ul> 33578 <h4 id="putio-description">--putio-description</h4> 33579 <p>Description of the remote</p> 33580 <p>Properties:</p> 33581 <ul> 33582 <li>Config: description</li> 33583 <li>Env Var: RCLONE_PUTIO_DESCRIPTION</li> 33584 <li>Type: string</li> 33585 <li>Required: false</li> 33586 </ul> 33587 <h2 id="limitations-15">Limitations</h2> 33588 <p>put.io has rate limiting. When you hit a limit, rclone automatically retries after waiting the amount of time requested by the server.</p> 33589 <p>If you want to avoid ever hitting these limits, you may use the <code>--tpslimit</code> flag with a low number. Note that the imposed limits may be different for different operations, and may change over time.</p> 33590 <h1 id="proton-drive-1">Proton Drive</h1> 33591 <p><a href="https://proton.me/drive">Proton Drive</a> is an end-to-end encrypted Swiss vault for your files that protects your data.</p> 33592 <p>This is an rclone backend for Proton Drive which supports the file transfer features of Proton Drive using the same client-side encryption.</p> 33593 <p>Due to the fact that Proton Drive doesn't publish its API documentation, this backend is implemented with best efforts by reading the open-sourced client source code and observing the Proton Drive traffic in the browser.</p> 33594 <p><strong>NB</strong> This backend is currently in Beta. It is believed to be correct and all the integration tests pass. However the Proton Drive protocol has evolved over time there may be accounts it is not compatible with. Please <a href="https://forum.rclone.org/">post on the rclone forum</a> if you find an incompatibility.</p> 33595 <p>Paths are specified as <code>remote:path</code></p> 33596 <p>Paths may be as deep as required, e.g. <code>remote:directory/subdirectory</code>.</p> 33597 <h2 id="configurations-1">Configurations</h2> 33598 <p>Here is an example of how to make a remote called <code>remote</code>. First run:</p> 33599 <pre><code> rclone config</code></pre> 33600 <p>This will guide you through an interactive setup process:</p> 33601 <pre><code>No remotes found, make a new one? 33602 n) New remote 33603 s) Set configuration password 33604 q) Quit config 33605 n/s/q> n 33606 name> remote 33607 Type of storage to configure. 33608 Choose a number from below, or type in your own value 33609 [snip] 33610 XX / Proton Drive 33611 \ "Proton Drive" 33612 [snip] 33613 Storage> protondrive 33614 User name 33615 user> you@protonmail.com 33616 Password. 33617 y) Yes type in my own password 33618 g) Generate random password 33619 n) No leave this optional password blank 33620 y/g/n> y 33621 Enter the password: 33622 password: 33623 Confirm the password: 33624 password: 33625 Option 2fa. 33626 2FA code (if the account requires one) 33627 Enter a value. Press Enter to leave empty. 33628 2fa> 123456 33629 Remote config 33630 -------------------- 33631 [remote] 33632 type = protondrive 33633 user = you@protonmail.com 33634 pass = *** ENCRYPTED *** 33635 -------------------- 33636 y) Yes this is OK 33637 e) Edit this remote 33638 d) Delete this remote 33639 y/e/d> y</code></pre> 33640 <p><strong>NOTE:</strong> The Proton Drive 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> 33641 <p>Once configured you can then use <code>rclone</code> like this,</p> 33642 <p>List directories in top level of your Proton Drive</p> 33643 <pre><code>rclone lsd remote:</code></pre> 33644 <p>List all the files in your Proton Drive</p> 33645 <pre><code>rclone ls remote:</code></pre> 33646 <p>To copy a local directory to an Proton Drive directory called backup</p> 33647 <pre><code>rclone copy /home/source remote:backup</code></pre> 33648 <h3 id="modification-times-and-hashes-10">Modification times and hashes</h3> 33649 <p>Proton Drive Bridge does not support updating modification times yet.</p> 33650 <p>The SHA1 hash algorithm is supported.</p> 33651 <h3 id="restricted-filename-characters-10">Restricted filename characters</h3> 33652 <p>Invalid UTF-8 bytes will be <a href="https://rclone.org/overview/#invalid-utf8">replaced</a>, also left and right spaces will be removed (<a href="https://github.com/ProtonMail/WebClients/blob/b4eba99d241af4fdae06ff7138bd651a40ef5d3c/applications/drive/src/app/store/_links/validation.ts#L51">code reference</a>)</p> 33653 <h3 id="duplicated-files-2">Duplicated files</h3> 33654 <p>Proton Drive can not have two files with exactly the same name and path. If the conflict occurs, depending on the advanced config, the file might or might not be overwritten.</p> 33655 <h3 id="mailbox-password-1"><a href="https://proton.me/support/the-difference-between-the-mailbox-password-and-login-password">Mailbox password</a></h3> 33656 <p>Please set your mailbox password in the advanced config section.</p> 33657 <h3 id="caching-1">Caching</h3> 33658 <p>The cache is currently built for the case when the rclone is the only instance performing operations to the mount point. The event system, which is the proton API system that provides visibility of what has changed on the drive, is yet to be implemented, so updates from other clients won’t be reflected in the cache. Thus, if there are concurrent clients accessing the same mount point, then we might have a problem with caching the stale data.</p> 33659 <h3 id="standard-options-14">Standard options</h3> 33660 <p>Here are the Standard options specific to protondrive (Proton Drive).</p> 33661 <h4 id="protondrive-username-1">--protondrive-username</h4> 33662 <p>The username of your proton account</p> 33663 <p>Properties:</p> 33664 <ul> 33665 <li>Config: username</li> 33666 <li>Env Var: RCLONE_PROTONDRIVE_USERNAME</li> 33667 <li>Type: string</li> 33668 <li>Required: true</li> 33669 </ul> 33670 <h4 id="protondrive-password-1">--protondrive-password</h4> 33671 <p>The password of your proton account.</p> 33672 <p><strong>NB</strong> Input to this must be obscured - see <a href="https://rclone.org/commands/rclone_obscure/">rclone obscure</a>.</p> 33673 <p>Properties:</p> 33674 <ul> 33675 <li>Config: password</li> 33676 <li>Env Var: RCLONE_PROTONDRIVE_PASSWORD</li> 33677 <li>Type: string</li> 33678 <li>Required: true</li> 33679 </ul> 33680 <h4 id="protondrive-2fa-1">--protondrive-2fa</h4> 33681 <p>The 2FA code</p> 33682 <p>The value can also be provided with --protondrive-2fa=000000</p> 33683 <p>The 2FA code of your proton drive account if the account is set up with two-factor authentication</p> 33684 <p>Properties:</p> 33685 <ul> 33686 <li>Config: 2fa</li> 33687 <li>Env Var: RCLONE_PROTONDRIVE_2FA</li> 33688 <li>Type: string</li> 33689 <li>Required: false</li> 33690 </ul> 33691 <h3 id="advanced-options-14">Advanced options</h3> 33692 <p>Here are the Advanced options specific to protondrive (Proton Drive).</p> 33693 <h4 id="protondrive-mailbox-password-1">--protondrive-mailbox-password</h4> 33694 <p>The mailbox password of your two-password proton account.</p> 33695 <p>For more information regarding the mailbox password, please check the following official knowledge base article: https://proton.me/support/the-difference-between-the-mailbox-password-and-login-password</p> 33696 <p><strong>NB</strong> Input to this must be obscured - see <a href="https://rclone.org/commands/rclone_obscure/">rclone obscure</a>.</p> 33697 <p>Properties:</p> 33698 <ul> 33699 <li>Config: mailbox_password</li> 33700 <li>Env Var: RCLONE_PROTONDRIVE_MAILBOX_PASSWORD</li> 33701 <li>Type: string</li> 33702 <li>Required: false</li> 33703 </ul> 33704 <h4 id="protondrive-client-uid-1">--protondrive-client-uid</h4> 33705 <p>Client uid key (internal use only)</p> 33706 <p>Properties:</p> 33707 <ul> 33708 <li>Config: client_uid</li> 33709 <li>Env Var: RCLONE_PROTONDRIVE_CLIENT_UID</li> 33710 <li>Type: string</li> 33711 <li>Required: false</li> 33712 </ul> 33713 <h4 id="protondrive-client-access-token-1">--protondrive-client-access-token</h4> 33714 <p>Client access token key (internal use only)</p> 33715 <p>Properties:</p> 33716 <ul> 33717 <li>Config: client_access_token</li> 33718 <li>Env Var: RCLONE_PROTONDRIVE_CLIENT_ACCESS_TOKEN</li> 33719 <li>Type: string</li> 33720 <li>Required: false</li> 33721 </ul> 33722 <h4 id="protondrive-client-refresh-token-1">--protondrive-client-refresh-token</h4> 33723 <p>Client refresh token key (internal use only)</p> 33724 <p>Properties:</p> 33725 <ul> 33726 <li>Config: client_refresh_token</li> 33727 <li>Env Var: RCLONE_PROTONDRIVE_CLIENT_REFRESH_TOKEN</li> 33728 <li>Type: string</li> 33729 <li>Required: false</li> 33730 </ul> 33731 <h4 id="protondrive-client-salted-key-pass-1">--protondrive-client-salted-key-pass</h4> 33732 <p>Client salted key pass key (internal use only)</p> 33733 <p>Properties:</p> 33734 <ul> 33735 <li>Config: client_salted_key_pass</li> 33736 <li>Env Var: RCLONE_PROTONDRIVE_CLIENT_SALTED_KEY_PASS</li> 33737 <li>Type: string</li> 33738 <li>Required: false</li> 33739 </ul> 33740 <h4 id="protondrive-encoding-1">--protondrive-encoding</h4> 33741 <p>The encoding for the backend.</p> 33742 <p>See the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 33743 <p>Properties:</p> 33744 <ul> 33745 <li>Config: encoding</li> 33746 <li>Env Var: RCLONE_PROTONDRIVE_ENCODING</li> 33747 <li>Type: Encoding</li> 33748 <li>Default: Slash,LeftSpace,RightSpace,InvalidUtf8,Dot</li> 33749 </ul> 33750 <h4 id="protondrive-original-file-size-1">--protondrive-original-file-size</h4> 33751 <p>Return the file size before encryption</p> 33752 <p>The size of the encrypted file will be different from (bigger than) the original file size. Unless there is a reason to return the file size after encryption is performed, otherwise, set this option to true, as features like Open() which will need to be supplied with original content size, will fail to operate properly</p> 33753 <p>Properties:</p> 33754 <ul> 33755 <li>Config: original_file_size</li> 33756 <li>Env Var: RCLONE_PROTONDRIVE_ORIGINAL_FILE_SIZE</li> 33757 <li>Type: bool</li> 33758 <li>Default: true</li> 33759 </ul> 33760 <h4 id="protondrive-app-version-1">--protondrive-app-version</h4> 33761 <p>The app version string</p> 33762 <p>The app version string indicates the client that is currently performing the API request. This information is required and will be sent with every API request.</p> 33763 <p>Properties:</p> 33764 <ul> 33765 <li>Config: app_version</li> 33766 <li>Env Var: RCLONE_PROTONDRIVE_APP_VERSION</li> 33767 <li>Type: string</li> 33768 <li>Default: "macos-drive@1.0.0-alpha.1+rclone"</li> 33769 </ul> 33770 <h4 id="protondrive-replace-existing-draft-1">--protondrive-replace-existing-draft</h4> 33771 <p>Create a new revision when filename conflict is detected</p> 33772 <p>When a file upload is cancelled or failed before completion, a draft will be created and the subsequent upload of the same file to the same location will be reported as a conflict.</p> 33773 <p>The value can also be set by --protondrive-replace-existing-draft=true</p> 33774 <p>If the option is set to true, the draft will be replaced and then the upload operation will restart. If there are other clients also uploading at the same file location at the same time, the behavior is currently unknown. Need to set to true for integration tests. If the option is set to false, an error "a draft exist - usually this means a file is being uploaded at another client, or, there was a failed upload attempt" will be returned, and no upload will happen.</p> 33775 <p>Properties:</p> 33776 <ul> 33777 <li>Config: replace_existing_draft</li> 33778 <li>Env Var: RCLONE_PROTONDRIVE_REPLACE_EXISTING_DRAFT</li> 33779 <li>Type: bool</li> 33780 <li>Default: false</li> 33781 </ul> 33782 <h4 id="protondrive-enable-caching-1">--protondrive-enable-caching</h4> 33783 <p>Caches the files and folders metadata to reduce API calls</p> 33784 <p>Notice: If you are mounting ProtonDrive as a VFS, please disable this feature, as the current implementation doesn't update or clear the cache when there are external changes.</p> 33785 <p>The files and folders on ProtonDrive are represented as links with keyrings, which can be cached to improve performance and be friendly to the API server.</p> 33786 <p>The cache is currently built for the case when the rclone is the only instance performing operations to the mount point. The event system, which is the proton API system that provides visibility of what has changed on the drive, is yet to be implemented, so updates from other clients won’t be reflected in the cache. Thus, if there are concurrent clients accessing the same mount point, then we might have a problem with caching the stale data.</p> 33787 <p>Properties:</p> 33788 <ul> 33789 <li>Config: enable_caching</li> 33790 <li>Env Var: RCLONE_PROTONDRIVE_ENABLE_CACHING</li> 33791 <li>Type: bool</li> 33792 <li>Default: true</li> 33793 </ul> 33794 <h4 id="protondrive-description-1">--protondrive-description</h4> 33795 <p>Description of the remote</p> 33796 <p>Properties:</p> 33797 <ul> 33798 <li>Config: description</li> 33799 <li>Env Var: RCLONE_PROTONDRIVE_DESCRIPTION</li> 33800 <li>Type: string</li> 33801 <li>Required: false</li> 33802 </ul> 33803 <h2 id="limitations-16">Limitations</h2> 33804 <p>This backend uses the <a href="https://github.com/henrybear327/Proton-API-Bridge">Proton-API-Bridge</a>, which is based on <a href="https://github.com/henrybear327/go-proton-api">go-proton-api</a>, a fork of the <a href="https://github.com/ProtonMail/go-proton-api">official repo</a>.</p> 33805 <p>There is no official API documentation available from Proton Drive. But, thanks to Proton open sourcing <a href="https://github.com/ProtonMail/go-proton-api">proton-go-api</a> and the web, iOS, and Android client codebases, we don't need to completely reverse engineer the APIs by observing the web client traffic!</p> 33806 <p><a href="https://github.com/ProtonMail/go-proton-api">proton-go-api</a> provides the basic building blocks of API calls and error handling, such as 429 exponential back-off, but it is pretty much just a barebone interface to the Proton API. For example, the encryption and decryption of the Proton Drive file are not provided in this library.</p> 33807 <p>The Proton-API-Bridge, attempts to bridge the gap, so rclone can be built on top of this quickly. This codebase handles the intricate tasks before and after calling Proton APIs, particularly the complex encryption scheme, allowing developers to implement features for other software on top of this codebase. There are likely quite a few errors in this library, as there isn't official documentation available.</p> 33808 <h1 id="seafile">Seafile</h1> 33809 <p>This is a backend for the <a href="https://www.seafile.com/">Seafile</a> storage service: - It works with both the free community edition or the professional edition. - Seafile versions 6.x, 7.x, 8.x and 9.x are all supported. - Encrypted libraries are also supported. - It supports 2FA enabled users - Using a Library API Token is <strong>not</strong> supported</p> 33810 <h2 id="configuration-13">Configuration</h2> 33811 <p>There are two distinct modes you can setup your remote: - you point your remote to the <strong>root of the server</strong>, meaning you don't specify a library during the configuration: Paths are specified as <code>remote:library</code>. You may put subdirectories in too, e.g. <code>remote:library/path/to/dir</code>. - you point your remote to a specific library during the configuration: Paths are specified as <code>remote:path/to/dir</code>. <strong>This is the recommended mode when using encrypted libraries</strong>. (<em>This mode is possibly slightly faster than the root mode</em>)</p> 33812 <h3 id="configuration-in-root-mode">Configuration in root mode</h3> 33813 <p>Here is an example of making a seafile configuration for a user with <strong>no</strong> two-factor authentication. First run</p> 33814 <pre><code>rclone config</code></pre> 33815 <p>This will guide you through an interactive setup process. To authenticate you will need the URL of your server, your email (or username) and your password.</p> 33816 <pre><code>No remotes found, make a new one? 33817 n) New remote 33818 s) Set configuration password 33819 q) Quit config 33820 n/s/q> n 33821 name> seafile 33822 Type of storage to configure. 33823 Enter a string value. Press Enter for the default (""). 33824 Choose a number from below, or type in your own value 33825 [snip] 33826 XX / Seafile 33827 \ "seafile" 33828 [snip] 33829 Storage> seafile 33830 ** See help for seafile backend at: https://rclone.org/seafile/ ** 33831 33832 URL of seafile host to connect to 33833 Enter a string value. Press Enter for the default (""). 33834 Choose a number from below, or type in your own value 33835 1 / Connect to cloud.seafile.com 33836 \ "https://cloud.seafile.com/" 33837 url> http://my.seafile.server/ 33838 User name (usually email address) 33839 Enter a string value. Press Enter for the default (""). 33840 user> me@example.com 33841 Password 33842 y) Yes type in my own password 33843 g) Generate random password 33844 n) No leave this optional password blank (default) 33845 y/g> y 33846 Enter the password: 33847 password: 33848 Confirm the password: 33849 password: 33850 Two-factor authentication ('true' if the account has 2FA enabled) 33851 Enter a boolean value (true or false). Press Enter for the default ("false"). 33852 2fa> false 33853 Name of the library. Leave blank to access all non-encrypted libraries. 33854 Enter a string value. Press Enter for the default (""). 33855 library> 33856 Library password (for encrypted libraries only). Leave blank if you pass it through the command line. 33857 y) Yes type in my own password 33858 g) Generate random password 33859 n) No leave this optional password blank (default) 33860 y/g/n> n 33861 Edit advanced config? (y/n) 33862 y) Yes 33863 n) No (default) 33864 y/n> n 33865 Remote config 33866 Two-factor authentication is not enabled on this account. 33867 -------------------- 33868 [seafile] 33869 type = seafile 33870 url = http://my.seafile.server/ 33871 user = me@example.com 33872 pass = *** ENCRYPTED *** 33873 2fa = false 33874 -------------------- 33875 y) Yes this is OK (default) 33876 e) Edit this remote 33877 d) Delete this remote 33878 y/e/d> y</code></pre> 33879 <p>This remote is called <code>seafile</code>. It's pointing to the root of your seafile server and can now be used like this:</p> 33880 <p>See all libraries</p> 33881 <pre><code>rclone lsd seafile:</code></pre> 33882 <p>Create a new library</p> 33883 <pre><code>rclone mkdir seafile:library</code></pre> 33884 <p>List the contents of a library</p> 33885 <pre><code>rclone ls seafile:library</code></pre> 33886 <p>Sync <code>/home/local/directory</code> to the remote library, deleting any excess files in the library.</p> 33887 <pre><code>rclone sync --interactive /home/local/directory seafile:library</code></pre> 33888 <h3 id="configuration-in-library-mode">Configuration in library mode</h3> 33889 <p>Here's an example of a configuration in library mode with a user that has the two-factor authentication enabled. Your 2FA code will be asked at the end of the configuration, and will attempt to authenticate you:</p> 33890 <pre><code>No remotes found, make a new one? 33891 n) New remote 33892 s) Set configuration password 33893 q) Quit config 33894 n/s/q> n 33895 name> seafile 33896 Type of storage to configure. 33897 Enter a string value. Press Enter for the default (""). 33898 Choose a number from below, or type in your own value 33899 [snip] 33900 XX / Seafile 33901 \ "seafile" 33902 [snip] 33903 Storage> seafile 33904 ** See help for seafile backend at: https://rclone.org/seafile/ ** 33905 33906 URL of seafile host to connect to 33907 Enter a string value. Press Enter for the default (""). 33908 Choose a number from below, or type in your own value 33909 1 / Connect to cloud.seafile.com 33910 \ "https://cloud.seafile.com/" 33911 url> http://my.seafile.server/ 33912 User name (usually email address) 33913 Enter a string value. Press Enter for the default (""). 33914 user> me@example.com 33915 Password 33916 y) Yes type in my own password 33917 g) Generate random password 33918 n) No leave this optional password blank (default) 33919 y/g> y 33920 Enter the password: 33921 password: 33922 Confirm the password: 33923 password: 33924 Two-factor authentication ('true' if the account has 2FA enabled) 33925 Enter a boolean value (true or false). Press Enter for the default ("false"). 33926 2fa> true 33927 Name of the library. Leave blank to access all non-encrypted libraries. 33928 Enter a string value. Press Enter for the default (""). 33929 library> My Library 33930 Library password (for encrypted libraries only). Leave blank if you pass it through the command line. 33931 y) Yes type in my own password 33932 g) Generate random password 33933 n) No leave this optional password blank (default) 33934 y/g/n> n 33935 Edit advanced config? (y/n) 33936 y) Yes 33937 n) No (default) 33938 y/n> n 33939 Remote config 33940 Two-factor authentication: please enter your 2FA code 33941 2fa code> 123456 33942 Authenticating... 33943 Success! 33944 -------------------- 33945 [seafile] 33946 type = seafile 33947 url = http://my.seafile.server/ 33948 user = me@example.com 33949 pass = 33950 2fa = true 33951 library = My Library 33952 -------------------- 33953 y) Yes this is OK (default) 33954 e) Edit this remote 33955 d) Delete this remote 33956 y/e/d> y</code></pre> 33957 <p>You'll notice your password is blank in the configuration. It's because we only need the password to authenticate you once.</p> 33958 <p>You specified <code>My Library</code> during the configuration. The root of the remote is pointing at the root of the library <code>My Library</code>:</p> 33959 <p>See all files in the library:</p> 33960 <pre><code>rclone lsd seafile:</code></pre> 33961 <p>Create a new directory inside the library</p> 33962 <pre><code>rclone mkdir seafile:directory</code></pre> 33963 <p>List the contents of a directory</p> 33964 <pre><code>rclone ls seafile:directory</code></pre> 33965 <p>Sync <code>/home/local/directory</code> to the remote library, deleting any excess files in the library.</p> 33966 <pre><code>rclone sync --interactive /home/local/directory seafile:</code></pre> 33967 <h3 id="fast-list-3">--fast-list</h3> 33968 <p>Seafile version 7+ supports <code>--fast-list</code> which allows you to use fewer transactions in exchange for more memory. See the <a href="https://rclone.org/docs/#fast-list">rclone docs</a> for more details. Please note this is not supported on seafile server version 6.x</p> 33969 <h3 id="restricted-filename-characters-11">Restricted filename characters</h3> 33970 <p>In addition to the <a href="https://rclone.org/overview/#restricted-characters">default restricted characters set</a> the following characters are also replaced:</p> 33971 <table> 33972 <thead> 33973 <tr class="header"> 33974 <th>Character</th> 33975 <th style="text-align: center;">Value</th> 33976 <th style="text-align: center;">Replacement</th> 33977 </tr> 33978 </thead> 33979 <tbody> 33980 <tr class="odd"> 33981 <td>/</td> 33982 <td style="text-align: center;">0x2F</td> 33983 <td style="text-align: center;">／</td> 33984 </tr> 33985 <tr class="even"> 33986 <td>"</td> 33987 <td style="text-align: center;">0x22</td> 33988 <td style="text-align: center;">＂</td> 33989 </tr> 33990 <tr class="odd"> 33991 <td>\</td> 33992 <td style="text-align: center;">0x5C</td> 33993 <td style="text-align: center;">＼</td> 33994 </tr> 33995 </tbody> 33996 </table> 33997 <p>Invalid UTF-8 bytes will also be <a href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they can't be used in JSON strings.</p> 33998 <h3 id="seafile-and-rclone-link">Seafile and rclone link</h3> 33999 <p>Rclone supports generating share links for non-encrypted libraries only. They can either be for a file or a directory:</p> 34000 <pre><code>rclone link seafile:seafile-tutorial.doc 34001 http://my.seafile.server/f/fdcd8a2f93f84b8b90f4/ 34002 </code></pre> 34003 <p>or if run on a directory you will get:</p> 34004 <pre><code>rclone link seafile:dir 34005 http://my.seafile.server/d/9ea2455f6f55478bbb0d/</code></pre> 34006 <p>Please note a share link is unique for each file or directory. If you run a link command on a file/dir that has already been shared, you will get the exact same link.</p> 34007 <h3 id="compatibility">Compatibility</h3> 34008 <p>It has been actively developed using the <a href="https://github.com/haiwen/seafile-docker">seafile docker image</a> of these versions: - 6.3.4 community edition - 7.0.5 community edition - 7.1.3 community edition - 9.0.10 community edition</p> 34009 <p>Versions below 6.0 are not supported. Versions between 6.0 and 6.3 haven't been tested and might not work properly.</p> 34010 <p>Each new version of <code>rclone</code> is automatically tested against the <a href="https://hub.docker.com/r/seafileltd/seafile-mc/">latest docker image</a> of the seafile community server.</p> 34011 <h3 id="standard-options-15">Standard options</h3> 34012 <p>Here are the Standard options specific to seafile (seafile).</p> 34013 <h4 id="seafile-url">--seafile-url</h4> 34014 <p>URL of seafile host to connect to.</p> 34015 <p>Properties:</p> 34016 <ul> 34017 <li>Config: url</li> 34018 <li>Env Var: RCLONE_SEAFILE_URL</li> 34019 <li>Type: string</li> 34020 <li>Required: true</li> 34021 <li>Examples: 34022 <ul> 34023 <li>"https://cloud.seafile.com/" 34024 <ul> 34025 <li>Connect to cloud.seafile.com.</li> 34026 </ul></li> 34027 </ul></li> 34028 </ul> 34029 <h4 id="seafile-user">--seafile-user</h4> 34030 <p>User name (usually email address).</p> 34031 <p>Properties:</p> 34032 <ul> 34033 <li>Config: user</li> 34034 <li>Env Var: RCLONE_SEAFILE_USER</li> 34035 <li>Type: string</li> 34036 <li>Required: true</li> 34037 </ul> 34038 <h4 id="seafile-pass">--seafile-pass</h4> 34039 <p>Password.</p> 34040 <p><strong>NB</strong> Input to this must be obscured - see <a href="https://rclone.org/commands/rclone_obscure/">rclone obscure</a>.</p> 34041 <p>Properties:</p> 34042 <ul> 34043 <li>Config: pass</li> 34044 <li>Env Var: RCLONE_SEAFILE_PASS</li> 34045 <li>Type: string</li> 34046 <li>Required: false</li> 34047 </ul> 34048 <h4 id="seafile-2fa">--seafile-2fa</h4> 34049 <p>Two-factor authentication ('true' if the account has 2FA enabled).</p> 34050 <p>Properties:</p> 34051 <ul> 34052 <li>Config: 2fa</li> 34053 <li>Env Var: RCLONE_SEAFILE_2FA</li> 34054 <li>Type: bool</li> 34055 <li>Default: false</li> 34056 </ul> 34057 <h4 id="seafile-library">--seafile-library</h4> 34058 <p>Name of the library.</p> 34059 <p>Leave blank to access all non-encrypted libraries.</p> 34060 <p>Properties:</p> 34061 <ul> 34062 <li>Config: library</li> 34063 <li>Env Var: RCLONE_SEAFILE_LIBRARY</li> 34064 <li>Type: string</li> 34065 <li>Required: false</li> 34066 </ul> 34067 <h4 id="seafile-library-key">--seafile-library-key</h4> 34068 <p>Library password (for encrypted libraries only).</p> 34069 <p>Leave blank if you pass it through the command line.</p> 34070 <p><strong>NB</strong> Input to this must be obscured - see <a href="https://rclone.org/commands/rclone_obscure/">rclone obscure</a>.</p> 34071 <p>Properties:</p> 34072 <ul> 34073 <li>Config: library_key</li> 34074 <li>Env Var: RCLONE_SEAFILE_LIBRARY_KEY</li> 34075 <li>Type: string</li> 34076 <li>Required: false</li> 34077 </ul> 34078 <h4 id="seafile-auth-token">--seafile-auth-token</h4> 34079 <p>Authentication token.</p> 34080 <p>Properties:</p> 34081 <ul> 34082 <li>Config: auth_token</li> 34083 <li>Env Var: RCLONE_SEAFILE_AUTH_TOKEN</li> 34084 <li>Type: string</li> 34085 <li>Required: false</li> 34086 </ul> 34087 <h3 id="advanced-options-15">Advanced options</h3> 34088 <p>Here are the Advanced options specific to seafile (seafile).</p> 34089 <h4 id="seafile-create-library">--seafile-create-library</h4> 34090 <p>Should rclone create a library if it doesn't exist.</p> 34091 <p>Properties:</p> 34092 <ul> 34093 <li>Config: create_library</li> 34094 <li>Env Var: RCLONE_SEAFILE_CREATE_LIBRARY</li> 34095 <li>Type: bool</li> 34096 <li>Default: false</li> 34097 </ul> 34098 <h4 id="seafile-encoding">--seafile-encoding</h4> 34099 <p>The encoding for the backend.</p> 34100 <p>See the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 34101 <p>Properties:</p> 34102 <ul> 34103 <li>Config: encoding</li> 34104 <li>Env Var: RCLONE_SEAFILE_ENCODING</li> 34105 <li>Type: Encoding</li> 34106 <li>Default: Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8</li> 34107 </ul> 34108 <h4 id="seafile-description">--seafile-description</h4> 34109 <p>Description of the remote</p> 34110 <p>Properties:</p> 34111 <ul> 34112 <li>Config: description</li> 34113 <li>Env Var: RCLONE_SEAFILE_DESCRIPTION</li> 34114 <li>Type: string</li> 34115 <li>Required: false</li> 34116 </ul> 34117 <h1 id="sftp">SFTP</h1> 34118 <p>SFTP is the <a href="https://en.wikipedia.org/wiki/SSH_File_Transfer_Protocol">Secure (or SSH) File Transfer Protocol</a>.</p> 34119 <p>The SFTP backend can be used with a number of different providers:</p> 34120 <ul> 34121 <li>Hetzner Storage Box</li> 34122 <li>rsync.net</li> 34123 </ul> 34124 <p>SFTP runs over SSH v2 and is installed as standard with most modern SSH installations.</p> 34125 <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. For example, <code>rclone lsd remote:</code> would list the home directory of the user configured in the rclone remote config (<code>i.e /home/sftpuser</code>). However, <code>rclone lsd remote:/</code> would list the root directory for remote machine (i.e. <code>/</code>)</p> 34126 <p>Note that some SFTP servers will need the leading / - Synology is a good example of this. rsync.net and Hetzner, on the other hand, requires users to OMIT the leading /.</p> 34127 <p>Note that by default rclone will try to execute shell commands on the server, see <a href="#shell-access-considerations">shell access considerations</a>.</p> 34128 <h2 id="configuration-14">Configuration</h2> 34129 <p>Here is an example of making an SFTP configuration. First run</p> 34130 <pre><code>rclone config</code></pre> 34131 <p>This will guide you through an interactive setup process.</p> 34132 <pre><code>No remotes found, make a new one? 34133 n) New remote 34134 s) Set configuration password 34135 q) Quit config 34136 n/s/q> n 34137 name> remote 34138 Type of storage to configure. 34139 Choose a number from below, or type in your own value 34140 [snip] 34141 XX / SSH/SFTP 34142 \ "sftp" 34143 [snip] 34144 Storage> sftp 34145 SSH host to connect to 34146 Choose a number from below, or type in your own value 34147 1 / Connect to example.com 34148 \ "example.com" 34149 host> example.com 34150 SSH username 34151 Enter a string value. Press Enter for the default ("$USER"). 34152 user> sftpuser 34153 SSH port number 34154 Enter a signed integer. Press Enter for the default (22). 34155 port> 34156 SSH password, leave blank to use ssh-agent. 34157 y) Yes type in my own password 34158 g) Generate random password 34159 n) No leave this optional password blank 34160 y/g/n> n 34161 Path to unencrypted PEM-encoded private key file, leave blank to use ssh-agent. 34162 key_file> 34163 Remote config 34164 -------------------- 34165 [remote] 34166 host = example.com 34167 user = sftpuser 34168 port = 34169 pass = 34170 key_file = 34171 -------------------- 34172 y) Yes this is OK 34173 e) Edit this remote 34174 d) Delete this remote 34175 y/e/d> y</code></pre> 34176 <p>This remote is called <code>remote</code> and can now be used like this:</p> 34177 <p>See all directories in the home directory</p> 34178 <pre><code>rclone lsd remote:</code></pre> 34179 <p>See all directories in the root directory</p> 34180 <pre><code>rclone lsd remote:/</code></pre> 34181 <p>Make a new directory</p> 34182 <pre><code>rclone mkdir remote:path/to/directory</code></pre> 34183 <p>List the contents of a directory</p> 34184 <pre><code>rclone ls remote:path/to/directory</code></pre> 34185 <p>Sync <code>/home/local/directory</code> to the remote directory, deleting any excess files in the directory.</p> 34186 <pre><code>rclone sync --interactive /home/local/directory remote:directory</code></pre> 34187 <p>Mount the remote path <code>/srv/www-data/</code> to the local path <code>/mnt/www-data</code></p> 34188 <pre><code>rclone mount remote:/srv/www-data/ /mnt/www-data</code></pre> 34189 <h3 id="ssh-authentication">SSH Authentication</h3> 34190 <p>The SFTP remote supports three authentication methods:</p> 34191 <ul> 34192 <li>Password</li> 34193 <li>Key file, including certificate signed keys</li> 34194 <li>ssh-agent</li> 34195 </ul> 34196 <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> 34197 <p>The key file can be specified in either an external file (key_file) or contained within the rclone config file (key_pem). If using key_pem in the config file, the entry should be on a single line with new line ('' or '') separating lines. i.e.</p> 34198 <pre><code>key_pem = -----BEGIN RSA PRIVATE KEY-----\nMaMbaIXtE\n0gAMbMbaSsd\nMbaass\n-----END RSA PRIVATE KEY-----</code></pre> 34199 <p>This will generate it correctly for key_pem for use in the config:</p> 34200 <pre><code>awk '{printf "%s\\n", $0}' < ~/.ssh/id_rsa</code></pre> 34201 <p>If you don't specify <code>pass</code>, <code>key_file</code>, or <code>key_pem</code> or <code>ask_password</code> then rclone will attempt to contact an ssh-agent. You can also specify <code>key_use_agent</code> to force the usage of an ssh-agent. In this case <code>key_file</code> or <code>key_pem</code> can also be specified to force the usage of a specific key in the ssh-agent.</p> 34202 <p>Using an ssh-agent is the only way to load encrypted OpenSSH keys at the moment.</p> 34203 <p>If you set the <code>ask_password</code> option, rclone will prompt for a password when needed and no password has been configured.</p> 34204 <h4 id="certificate-signed-keys">Certificate-signed keys</h4> 34205 <p>With traditional key-based authentication, you configure your private key only, and the public key built into it will be used during the authentication process.</p> 34206 <p>If you have a certificate you may use it to sign your public key, creating a separate SSH user certificate that should be used instead of the plain public key extracted from the private key. Then you must provide the path to the user certificate public key file in <code>pubkey_file</code>.</p> 34207 <p>Note: This is not the traditional public key paired with your private key, typically saved as <code>/home/$USER/.ssh/id_rsa.pub</code>. Setting this path in <code>pubkey_file</code> will not work.</p> 34208 <p>Example:</p> 34209 <pre><code>[remote] 34210 type = sftp 34211 host = example.com 34212 user = sftpuser 34213 key_file = ~/id_rsa 34214 pubkey_file = ~/id_rsa-cert.pub</code></pre> 34215 <p>If you concatenate a cert with a private key then you can specify the merged file in both places.</p> 34216 <p>Note: the cert must come first in the file. e.g.</p> 34217 <pre><code>cat id_rsa-cert.pub id_rsa > merged_key</code></pre> 34218 <h3 id="host-key-validation">Host key validation</h3> 34219 <p>By default rclone will not check the server's host key for validation. This can allow an attacker to replace a server with their own and if you use password authentication then this can lead to that password being exposed.</p> 34220 <p>Host key matching, using standard <code>known_hosts</code> files can be turned on by enabling the <code>known_hosts_file</code> option. This can point to the file maintained by <code>OpenSSH</code> or can point to a unique file.</p> 34221 <p>e.g. using the OpenSSH <code>known_hosts</code> file:</p> 34222 <pre><code>[remote] 34223 type = sftp 34224 host = example.com 34225 user = sftpuser 34226 pass = 34227 known_hosts_file = ~/.ssh/known_hosts</code></pre> 34228 <p>Alternatively you can create your own known hosts file like this:</p> 34229 <pre><code>ssh-keyscan -t dsa,rsa,ecdsa,ed25519 example.com >> known_hosts</code></pre> 34230 <p>There are some limitations:</p> 34231 <ul> 34232 <li><code>rclone</code> will not <em>manage</em> this file for you. If the key is missing or wrong then the connection will be refused.</li> 34233 <li>If the server is set up for a certificate host key then the entry in the <code>known_hosts</code> file <em>must</em> be the <code>@cert-authority</code> entry for the CA</li> 34234 </ul> 34235 <p>If the host key provided by the server does not match the one in the file (or is missing) then the connection will be aborted and an error returned such as</p> 34236 <pre><code>NewFs: couldn't connect SSH: ssh: handshake failed: knownhosts: key mismatch</code></pre> 34237 <p>or</p> 34238 <pre><code>NewFs: couldn't connect SSH: ssh: handshake failed: knownhosts: key is unknown</code></pre> 34239 <p>If you see an error such as</p> 34240 <pre><code>NewFs: couldn't connect SSH: ssh: handshake failed: ssh: no authorities for hostname: example.com:22</code></pre> 34241 <p>then it is likely the server has presented a CA signed host certificate and you will need to add the appropriate <code>@cert-authority</code> entry.</p> 34242 <p>The <code>known_hosts_file</code> setting can be set during <code>rclone config</code> as an advanced option.</p> 34243 <h3 id="ssh-agent-on-macos">ssh-agent on macOS</h3> 34244 <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, e.g.</p> 34245 <pre><code>eval `ssh-agent -s` && ssh-add -A</code></pre> 34246 <p>And then at the end of the session</p> 34247 <pre><code>eval `ssh-agent -k`</code></pre> 34248 <p>These commands can be used in scripts of course.</p> 34249 <h3 id="shell-access">Shell access</h3> 34250 <p>Some functionality of the SFTP backend relies on remote shell access, and the possibility to execute commands. This includes <a href="#checksum">checksum</a>, and in some cases also <a href="#about-command">about</a>. The shell commands that must be executed may be different on different type of shells, and also quoting/escaping of file path arguments containing special characters may be different. Rclone therefore needs to know what type of shell it is, and if shell access is available at all.</p> 34251 <p>Most servers run on some version of Unix, and then a basic Unix shell can be assumed, without further distinction. Windows 10, Server 2019, and later can also run a SSH server, which is a port of OpenSSH (see official <a href="https://docs.microsoft.com/en-us/windows-server/administration/openssh/openssh_install_firstuse">installation guide</a>). On a Windows server the shell handling is different: Although it can also be set up to use a Unix type shell, e.g. Cygwin bash, the default is to use Windows Command Prompt (cmd.exe), and PowerShell is a recommended alternative. All of these have behave differently, which rclone must handle.</p> 34252 <p>Rclone tries to auto-detect what type of shell is used on the server, first time you access the SFTP remote. If a remote shell session is successfully created, it will look for indications that it is CMD or PowerShell, with fall-back to Unix if not something else is detected. If unable to even create a remote shell session, then shell command execution will be disabled entirely. The result is stored in the SFTP remote configuration, in option <code>shell_type</code>, so that the auto-detection only have to be performed once. If you manually set a value for this option before first run, the auto-detection will be skipped, and if you set a different value later this will override any existing. Value <code>none</code> can be set to avoid any attempts at executing shell commands, e.g. if this is not allowed on the server.</p> 34253 <p>When the server is <a href="https://rclone.org/commands/rclone_serve_sftp/">rclone serve sftp</a>, the rclone SFTP remote will detect this as a Unix type shell - even if it is running on Windows. This server does not actually have a shell, but it accepts input commands matching the specific ones that the SFTP backend relies on for Unix shells, e.g. <code>md5sum</code> and <code>df</code>. Also it handles the string escape rules used for Unix shell. Treating it as a Unix type shell from a SFTP remote will therefore always be correct, and support all features.</p> 34254 <h4 id="shell-access-considerations">Shell access considerations</h4> 34255 <p>The shell type auto-detection logic, described above, means that by default rclone will try to run a shell command the first time a new sftp remote is accessed. If you configure a sftp remote without a config file, e.g. an <a href="https://rclone.org/docs/#backend-path-to-dir%5D">on the fly</a> remote, rclone will have nowhere to store the result, and it will re-run the command on every access. To avoid this you should explicitly set the <code>shell_type</code> option to the correct value, or to <code>none</code> if you want to prevent rclone from executing any remote shell commands.</p> 34256 <p>It is also important to note that, since the shell type decides how quoting and escaping of file paths used as command-line arguments are performed, configuring the wrong shell type may leave you exposed to command injection exploits. Make sure to confirm the auto-detected shell type, or explicitly set the shell type you know is correct, or disable shell access until you know.</p> 34257 <h3 id="checksum">Checksum</h3> 34258 <p>SFTP does not natively support checksums (file hash), but rclone is able to use checksumming if the same login has shell access, and can execute remote commands. If there is a command that can calculate compatible checksums on the remote system, Rclone can then be configured to execute this whenever a checksum is needed, and read back the results. Currently MD5 and SHA-1 are supported.</p> 34259 <p>Normally this requires an external utility being available on the server. By default rclone will try commands <code>md5sum</code>, <code>md5</code> and <code>rclone md5sum</code> for MD5 checksums, and the first one found usable will be picked. Same with <code>sha1sum</code>, <code>sha1</code> and <code>rclone sha1sum</code> commands for SHA-1 checksums. These utilities normally need to be in the remote's PATH to be found.</p> 34260 <p>In some cases the shell itself is capable of calculating checksums. PowerShell is an example of such a shell. If rclone detects that the remote shell is PowerShell, which means it most probably is a Windows OpenSSH server, rclone will use a predefined script block to produce the checksums when no external checksum commands are found (see <a href="#shell-access">shell access</a>). This assumes PowerShell version 4.0 or newer.</p> 34261 <p>The options <code>md5sum_command</code> and <code>sha1_command</code> can be used to customize the command to be executed for calculation of checksums. You can for example set a specific path to where md5sum and sha1sum executables are located, or use them to specify some other tools that print checksums in compatible format. The value can include command-line arguments, or even shell script blocks as with PowerShell. Rclone has subcommands <a href="https://rclone.org/commands/rclone_md5sum/">md5sum</a> and <a href="https://rclone.org/commands/rclone_sha1sum/">sha1sum</a> that use compatible format, which means if you have an rclone executable on the server it can be used. As mentioned above, they will be automatically picked up if found in PATH, but if not you can set something like <code>/path/to/rclone md5sum</code> as the value of option <code>md5sum_command</code> to make sure a specific executable is used.</p> 34262 <p>Remote checksumming is recommended and enabled by default. First time rclone is using a SFTP remote, if options <code>md5sum_command</code> or <code>sha1_command</code> are not set, it will check if any of the default commands for each of them, as described above, can be used. The result will be saved in the remote configuration, so next time it will use the same. Value <code>none</code> will be set if none of the default commands could be used for a specific algorithm, and this algorithm will not be supported by the remote.</p> 34263 <p>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 shell commands is prohibited. Set the configuration option <code>disable_hashcheck</code> to <code>true</code> to disable checksumming entirely, or set <code>shell_type</code> to <code>none</code> to disable all functionality based on remote shell command execution.</p> 34264 <h3 id="modification-times-and-hashes-11">Modification times and hashes</h3> 34265 <p>Modified times are stored on the server to 1 second precision.</p> 34266 <p>Modified times are used in syncing and are fully supported.</p> 34267 <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> 34268 <h3 id="about-command">About command</h3> 34269 <p>The <code>about</code> command returns 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.</p> 34270 <p>SFTP usually supports the <a href="https://rclone.org/commands/rclone_about/">about</a> command, but it depends on the server. If the server implements the vendor-specific VFS statistics extension, which is normally the case with OpenSSH instances, it will be used. If not, but the same login has access to a Unix shell, where the <code>df</code> command is available (e.g. in the remote's PATH), then this will be used instead. If the server shell is PowerShell, probably with a Windows OpenSSH server, rclone will use a built-in shell command (see <a href="#shell-access">shell access</a>). If none of the above is applicable, <code>about</code> will fail.</p> 34271 <h3 id="standard-options-16">Standard options</h3> 34272 <p>Here are the Standard options specific to sftp (SSH/SFTP).</p> 34273 <h4 id="sftp-host">--sftp-host</h4> 34274 <p>SSH host to connect to.</p> 34275 <p>E.g. "example.com".</p> 34276 <p>Properties:</p> 34277 <ul> 34278 <li>Config: host</li> 34279 <li>Env Var: RCLONE_SFTP_HOST</li> 34280 <li>Type: string</li> 34281 <li>Required: true</li> 34282 </ul> 34283 <h4 id="sftp-user">--sftp-user</h4> 34284 <p>SSH username.</p> 34285 <p>Properties:</p> 34286 <ul> 34287 <li>Config: user</li> 34288 <li>Env Var: RCLONE_SFTP_USER</li> 34289 <li>Type: string</li> 34290 <li>Default: "$USER"</li> 34291 </ul> 34292 <h4 id="sftp-port">--sftp-port</h4> 34293 <p>SSH port number.</p> 34294 <p>Properties:</p> 34295 <ul> 34296 <li>Config: port</li> 34297 <li>Env Var: RCLONE_SFTP_PORT</li> 34298 <li>Type: int</li> 34299 <li>Default: 22</li> 34300 </ul> 34301 <h4 id="sftp-pass">--sftp-pass</h4> 34302 <p>SSH password, leave blank to use ssh-agent.</p> 34303 <p><strong>NB</strong> Input to this must be obscured - see <a href="https://rclone.org/commands/rclone_obscure/">rclone obscure</a>.</p> 34304 <p>Properties:</p> 34305 <ul> 34306 <li>Config: pass</li> 34307 <li>Env Var: RCLONE_SFTP_PASS</li> 34308 <li>Type: string</li> 34309 <li>Required: false</li> 34310 </ul> 34311 <h4 id="sftp-key-pem">--sftp-key-pem</h4> 34312 <p>Raw PEM-encoded private key.</p> 34313 <p>If specified, will override key_file parameter.</p> 34314 <p>Properties:</p> 34315 <ul> 34316 <li>Config: key_pem</li> 34317 <li>Env Var: RCLONE_SFTP_KEY_PEM</li> 34318 <li>Type: string</li> 34319 <li>Required: false</li> 34320 </ul> 34321 <h4 id="sftp-key-file">--sftp-key-file</h4> 34322 <p>Path to PEM-encoded private key file.</p> 34323 <p>Leave blank or set key-use-agent to use ssh-agent.</p> 34324 <p>Leading <code>~</code> will be expanded in the file name as will environment variables such as <code>${RCLONE_CONFIG_DIR}</code>.</p> 34325 <p>Properties:</p> 34326 <ul> 34327 <li>Config: key_file</li> 34328 <li>Env Var: RCLONE_SFTP_KEY_FILE</li> 34329 <li>Type: string</li> 34330 <li>Required: false</li> 34331 </ul> 34332 <h4 id="sftp-key-file-pass">--sftp-key-file-pass</h4> 34333 <p>The passphrase to decrypt the PEM-encoded private key file.</p> 34334 <p>Only PEM encrypted key files (old OpenSSH format) are supported. Encrypted keys in the new OpenSSH format can't be used.</p> 34335 <p><strong>NB</strong> Input to this must be obscured - see <a href="https://rclone.org/commands/rclone_obscure/">rclone obscure</a>.</p> 34336 <p>Properties:</p> 34337 <ul> 34338 <li>Config: key_file_pass</li> 34339 <li>Env Var: RCLONE_SFTP_KEY_FILE_PASS</li> 34340 <li>Type: string</li> 34341 <li>Required: false</li> 34342 </ul> 34343 <h4 id="sftp-pubkey-file">--sftp-pubkey-file</h4> 34344 <p>Optional path to public key file.</p> 34345 <p>Set this if you have a signed certificate you want to use for authentication.</p> 34346 <p>Leading <code>~</code> will be expanded in the file name as will environment variables such as <code>${RCLONE_CONFIG_DIR}</code>.</p> 34347 <p>Properties:</p> 34348 <ul> 34349 <li>Config: pubkey_file</li> 34350 <li>Env Var: RCLONE_SFTP_PUBKEY_FILE</li> 34351 <li>Type: string</li> 34352 <li>Required: false</li> 34353 </ul> 34354 <h4 id="sftp-key-use-agent">--sftp-key-use-agent</h4> 34355 <p>When set forces the usage of the ssh-agent.</p> 34356 <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> 34357 <p>Properties:</p> 34358 <ul> 34359 <li>Config: key_use_agent</li> 34360 <li>Env Var: RCLONE_SFTP_KEY_USE_AGENT</li> 34361 <li>Type: bool</li> 34362 <li>Default: false</li> 34363 </ul> 34364 <h4 id="sftp-use-insecure-cipher">--sftp-use-insecure-cipher</h4> 34365 <p>Enable the use of insecure ciphers and key exchange methods.</p> 34366 <p>This enables the use of the following insecure ciphers and key exchange methods:</p> 34367 <ul> 34368 <li>aes128-cbc</li> 34369 <li>aes192-cbc</li> 34370 <li>aes256-cbc</li> 34371 <li>3des-cbc</li> 34372 <li>diffie-hellman-group-exchange-sha256</li> 34373 <li>diffie-hellman-group-exchange-sha1</li> 34374 </ul> 34375 <p>Those algorithms are insecure and may allow plaintext data to be recovered by an attacker.</p> 34376 <p>This must be false if you use either ciphers or key_exchange advanced options.</p> 34377 <p>Properties:</p> 34378 <ul> 34379 <li>Config: use_insecure_cipher</li> 34380 <li>Env Var: RCLONE_SFTP_USE_INSECURE_CIPHER</li> 34381 <li>Type: bool</li> 34382 <li>Default: false</li> 34383 <li>Examples: 34384 <ul> 34385 <li>"false" 34386 <ul> 34387 <li>Use default Cipher list.</li> 34388 </ul></li> 34389 <li>"true" 34390 <ul> 34391 <li>Enables the use of the aes128-cbc cipher and diffie-hellman-group-exchange-sha256, diffie-hellman-group-exchange-sha1 key exchange.</li> 34392 </ul></li> 34393 </ul></li> 34394 </ul> 34395 <h4 id="sftp-disable-hashcheck">--sftp-disable-hashcheck</h4> 34396 <p>Disable the execution of SSH commands to determine if remote file hashing is available.</p> 34397 <p>Leave blank or set to false to enable hashing (recommended), set to true to disable hashing.</p> 34398 <p>Properties:</p> 34399 <ul> 34400 <li>Config: disable_hashcheck</li> 34401 <li>Env Var: RCLONE_SFTP_DISABLE_HASHCHECK</li> 34402 <li>Type: bool</li> 34403 <li>Default: false</li> 34404 </ul> 34405 <h4 id="sftp-ssh">--sftp-ssh</h4> 34406 <p>Path and arguments to external ssh binary.</p> 34407 <p>Normally rclone will use its internal ssh library to connect to the SFTP server. However it does not implement all possible ssh options so it may be desirable to use an external ssh binary.</p> 34408 <p>Rclone ignores all the internal config if you use this option and expects you to configure the ssh binary with the user/host/port and any other options you need.</p> 34409 <p><strong>Important</strong> The ssh command must log in without asking for a password so needs to be configured with keys or certificates.</p> 34410 <p>Rclone will run the command supplied either with the additional arguments "-s sftp" to access the SFTP subsystem or with commands such as "md5sum /path/to/file" appended to read checksums.</p> 34411 <p>Any arguments with spaces in should be surrounded by "double quotes".</p> 34412 <p>An example setting might be:</p> 34413 <pre><code>ssh -o ServerAliveInterval=20 user@example.com</code></pre> 34414 <p>Note that when using an external ssh binary rclone makes a new ssh connection for every hash it calculates.</p> 34415 <p>Properties:</p> 34416 <ul> 34417 <li>Config: ssh</li> 34418 <li>Env Var: RCLONE_SFTP_SSH</li> 34419 <li>Type: SpaceSepList</li> 34420 <li>Default:</li> 34421 </ul> 34422 <h3 id="advanced-options-16">Advanced options</h3> 34423 <p>Here are the Advanced options specific to sftp (SSH/SFTP).</p> 34424 <h4 id="sftp-known-hosts-file">--sftp-known-hosts-file</h4> 34425 <p>Optional path to known_hosts file.</p> 34426 <p>Set this value to enable server host key validation.</p> 34427 <p>Leading <code>~</code> will be expanded in the file name as will environment variables such as <code>${RCLONE_CONFIG_DIR}</code>.</p> 34428 <p>Properties:</p> 34429 <ul> 34430 <li>Config: known_hosts_file</li> 34431 <li>Env Var: RCLONE_SFTP_KNOWN_HOSTS_FILE</li> 34432 <li>Type: string</li> 34433 <li>Required: false</li> 34434 <li>Examples: 34435 <ul> 34436 <li>"~/.ssh/known_hosts" 34437 <ul> 34438 <li>Use OpenSSH's known_hosts file.</li> 34439 </ul></li> 34440 </ul></li> 34441 </ul> 34442 <h4 id="sftp-ask-password">--sftp-ask-password</h4> 34443 <p>Allow asking for SFTP password when needed.</p> 34444 <p>If this is set and no password is supplied then rclone will: - ask for a password - not contact the ssh agent</p> 34445 <p>Properties:</p> 34446 <ul> 34447 <li>Config: ask_password</li> 34448 <li>Env Var: RCLONE_SFTP_ASK_PASSWORD</li> 34449 <li>Type: bool</li> 34450 <li>Default: false</li> 34451 </ul> 34452 <h4 id="sftp-path-override">--sftp-path-override</h4> 34453 <p>Override path used by SSH shell commands.</p> 34454 <p>This allows checksum calculation when SFTP and SSH paths are different. This issue affects among others Synology NAS boxes.</p> 34455 <p>E.g. if shared folders can be found in directories representing volumes:</p> 34456 <pre><code>rclone sync /home/local/directory remote:/directory --sftp-path-override /volume2/directory</code></pre> 34457 <p>E.g. if home directory can be found in a shared folder called "home":</p> 34458 <pre><code>rclone sync /home/local/directory remote:/home/directory --sftp-path-override /volume1/homes/USER/directory</code></pre> 34459 <p>To specify only the path to the SFTP remote's root, and allow rclone to add any relative subpaths automatically (including unwrapping/decrypting remotes as necessary), add the '@' character to the beginning of the path.</p> 34460 <p>E.g. the first example above could be rewritten as:</p> 34461 <pre><code>rclone sync /home/local/directory remote:/directory --sftp-path-override @/volume2</code></pre> 34462 <p>Note that when using this method with Synology "home" folders, the full "/homes/USER" path should be specified instead of "/home".</p> 34463 <p>E.g. the second example above should be rewritten as:</p> 34464 <pre><code>rclone sync /home/local/directory remote:/homes/USER/directory --sftp-path-override @/volume1</code></pre> 34465 <p>Properties:</p> 34466 <ul> 34467 <li>Config: path_override</li> 34468 <li>Env Var: RCLONE_SFTP_PATH_OVERRIDE</li> 34469 <li>Type: string</li> 34470 <li>Required: false</li> 34471 </ul> 34472 <h4 id="sftp-set-modtime">--sftp-set-modtime</h4> 34473 <p>Set the modified time on the remote if set.</p> 34474 <p>Properties:</p> 34475 <ul> 34476 <li>Config: set_modtime</li> 34477 <li>Env Var: RCLONE_SFTP_SET_MODTIME</li> 34478 <li>Type: bool</li> 34479 <li>Default: true</li> 34480 </ul> 34481 <h4 id="sftp-shell-type">--sftp-shell-type</h4> 34482 <p>The type of SSH shell on remote server, if any.</p> 34483 <p>Leave blank for autodetect.</p> 34484 <p>Properties:</p> 34485 <ul> 34486 <li>Config: shell_type</li> 34487 <li>Env Var: RCLONE_SFTP_SHELL_TYPE</li> 34488 <li>Type: string</li> 34489 <li>Required: false</li> 34490 <li>Examples: 34491 <ul> 34492 <li>"none" 34493 <ul> 34494 <li>No shell access</li> 34495 </ul></li> 34496 <li>"unix" 34497 <ul> 34498 <li>Unix shell</li> 34499 </ul></li> 34500 <li>"powershell" 34501 <ul> 34502 <li>PowerShell</li> 34503 </ul></li> 34504 <li>"cmd" 34505 <ul> 34506 <li>Windows Command Prompt</li> 34507 </ul></li> 34508 </ul></li> 34509 </ul> 34510 <h4 id="sftp-md5sum-command">--sftp-md5sum-command</h4> 34511 <p>The command used to read md5 hashes.</p> 34512 <p>Leave blank for autodetect.</p> 34513 <p>Properties:</p> 34514 <ul> 34515 <li>Config: md5sum_command</li> 34516 <li>Env Var: RCLONE_SFTP_MD5SUM_COMMAND</li> 34517 <li>Type: string</li> 34518 <li>Required: false</li> 34519 </ul> 34520 <h4 id="sftp-sha1sum-command">--sftp-sha1sum-command</h4> 34521 <p>The command used to read sha1 hashes.</p> 34522 <p>Leave blank for autodetect.</p> 34523 <p>Properties:</p> 34524 <ul> 34525 <li>Config: sha1sum_command</li> 34526 <li>Env Var: RCLONE_SFTP_SHA1SUM_COMMAND</li> 34527 <li>Type: string</li> 34528 <li>Required: false</li> 34529 </ul> 34530 <h4 id="sftp-skip-links">--sftp-skip-links</h4> 34531 <p>Set to skip any symlinks and any other non regular files.</p> 34532 <p>Properties:</p> 34533 <ul> 34534 <li>Config: skip_links</li> 34535 <li>Env Var: RCLONE_SFTP_SKIP_LINKS</li> 34536 <li>Type: bool</li> 34537 <li>Default: false</li> 34538 </ul> 34539 <h4 id="sftp-subsystem">--sftp-subsystem</h4> 34540 <p>Specifies the SSH2 subsystem on the remote host.</p> 34541 <p>Properties:</p> 34542 <ul> 34543 <li>Config: subsystem</li> 34544 <li>Env Var: RCLONE_SFTP_SUBSYSTEM</li> 34545 <li>Type: string</li> 34546 <li>Default: "sftp"</li> 34547 </ul> 34548 <h4 id="sftp-server-command">--sftp-server-command</h4> 34549 <p>Specifies the path or command to run a sftp server on the remote host.</p> 34550 <p>The subsystem option is ignored when server_command is defined.</p> 34551 <p>If adding server_command to the configuration file please note that it should not be enclosed in quotes, since that will make rclone fail.</p> 34552 <p>A working example is:</p> 34553 <pre><code>[remote_name] 34554 type = sftp 34555 server_command = sudo /usr/libexec/openssh/sftp-server</code></pre> 34556 <p>Properties:</p> 34557 <ul> 34558 <li>Config: server_command</li> 34559 <li>Env Var: RCLONE_SFTP_SERVER_COMMAND</li> 34560 <li>Type: string</li> 34561 <li>Required: false</li> 34562 </ul> 34563 <h4 id="sftp-use-fstat">--sftp-use-fstat</h4> 34564 <p>If set use fstat instead of stat.</p> 34565 <p>Some servers limit the amount of open files and calling Stat after opening the file will throw an error from the server. Setting this flag will call Fstat instead of Stat which is called on an already open file handle.</p> 34566 <p>It has been found that this helps with IBM Sterling SFTP servers which have "extractability" level set to 1 which means only 1 file can be opened at any given time.</p> 34567 <p>Properties:</p> 34568 <ul> 34569 <li>Config: use_fstat</li> 34570 <li>Env Var: RCLONE_SFTP_USE_FSTAT</li> 34571 <li>Type: bool</li> 34572 <li>Default: false</li> 34573 </ul> 34574 <h4 id="sftp-disable-concurrent-reads">--sftp-disable-concurrent-reads</h4> 34575 <p>If set don't use concurrent reads.</p> 34576 <p>Normally concurrent reads are safe to use and not using them will degrade performance, so this option is disabled by default.</p> 34577 <p>Some servers limit the amount number of times a file can be downloaded. Using concurrent reads can trigger this limit, so if you have a server which returns</p> 34578 <pre><code>Failed to copy: file does not exist</code></pre> 34579 <p>Then you may need to enable this flag.</p> 34580 <p>If concurrent reads are disabled, the use_fstat option is ignored.</p> 34581 <p>Properties:</p> 34582 <ul> 34583 <li>Config: disable_concurrent_reads</li> 34584 <li>Env Var: RCLONE_SFTP_DISABLE_CONCURRENT_READS</li> 34585 <li>Type: bool</li> 34586 <li>Default: false</li> 34587 </ul> 34588 <h4 id="sftp-disable-concurrent-writes">--sftp-disable-concurrent-writes</h4> 34589 <p>If set don't use concurrent writes.</p> 34590 <p>Normally rclone uses concurrent writes to upload files. This improves the performance greatly, especially for distant servers.</p> 34591 <p>This option disables concurrent writes should that be necessary.</p> 34592 <p>Properties:</p> 34593 <ul> 34594 <li>Config: disable_concurrent_writes</li> 34595 <li>Env Var: RCLONE_SFTP_DISABLE_CONCURRENT_WRITES</li> 34596 <li>Type: bool</li> 34597 <li>Default: false</li> 34598 </ul> 34599 <h4 id="sftp-idle-timeout">--sftp-idle-timeout</h4> 34600 <p>Max time before closing idle connections.</p> 34601 <p>If no connections have been returned to the connection pool in the time given, rclone will empty the connection pool.</p> 34602 <p>Set to 0 to keep connections indefinitely.</p> 34603 <p>Properties:</p> 34604 <ul> 34605 <li>Config: idle_timeout</li> 34606 <li>Env Var: RCLONE_SFTP_IDLE_TIMEOUT</li> 34607 <li>Type: Duration</li> 34608 <li>Default: 1m0s</li> 34609 </ul> 34610 <h4 id="sftp-chunk-size">--sftp-chunk-size</h4> 34611 <p>Upload and download chunk size.</p> 34612 <p>This controls the maximum size of payload in SFTP protocol packets. The RFC limits this to 32768 bytes (32k), which is the default. However, a lot of servers support larger sizes, typically limited to a maximum total package size of 256k, and setting it larger will increase transfer speed dramatically on high latency links. This includes OpenSSH, and, for example, using the value of 255k works well, leaving plenty of room for overhead while still being within a total packet size of 256k.</p> 34613 <p>Make sure to test thoroughly before using a value higher than 32k, and only use it if you always connect to the same server or after sufficiently broad testing. If you get errors such as "failed to send packet payload: EOF", lots of "connection lost", or "corrupted on transfer", when copying a larger file, try lowering the value. The server run by <a href="/commands/rclone_serve_sftp">rclone serve sftp</a> sends packets with standard 32k maximum payload so you must not set a different chunk_size when downloading files, but it accepts packets up to the 256k total size, so for uploads the chunk_size can be set as for the OpenSSH example above.</p> 34614 <p>Properties:</p> 34615 <ul> 34616 <li>Config: chunk_size</li> 34617 <li>Env Var: RCLONE_SFTP_CHUNK_SIZE</li> 34618 <li>Type: SizeSuffix</li> 34619 <li>Default: 32Ki</li> 34620 </ul> 34621 <h4 id="sftp-concurrency">--sftp-concurrency</h4> 34622 <p>The maximum number of outstanding requests for one file</p> 34623 <p>This controls the maximum number of outstanding requests for one file. Increasing it will increase throughput on high latency links at the cost of using more memory.</p> 34624 <p>Properties:</p> 34625 <ul> 34626 <li>Config: concurrency</li> 34627 <li>Env Var: RCLONE_SFTP_CONCURRENCY</li> 34628 <li>Type: int</li> 34629 <li>Default: 64</li> 34630 </ul> 34631 <h4 id="sftp-set-env">--sftp-set-env</h4> 34632 <p>Environment variables to pass to sftp and commands</p> 34633 <p>Set environment variables in the form:</p> 34634 <pre><code>VAR=value</code></pre> 34635 <p>to be passed to the sftp client and to any commands run (eg md5sum).</p> 34636 <p>Pass multiple variables space separated, eg</p> 34637 <pre><code>VAR1=value VAR2=value</code></pre> 34638 <p>and pass variables with spaces in quotes, eg</p> 34639 <pre><code>"VAR3=value with space" "VAR4=value with space" VAR5=nospacehere</code></pre> 34640 <p>Properties:</p> 34641 <ul> 34642 <li>Config: set_env</li> 34643 <li>Env Var: RCLONE_SFTP_SET_ENV</li> 34644 <li>Type: SpaceSepList</li> 34645 <li>Default:</li> 34646 </ul> 34647 <h4 id="sftp-ciphers">--sftp-ciphers</h4> 34648 <p>Space separated list of ciphers to be used for session encryption, ordered by preference.</p> 34649 <p>At least one must match with server configuration. This can be checked for example using ssh -Q cipher.</p> 34650 <p>This must not be set if use_insecure_cipher is true.</p> 34651 <p>Example:</p> 34652 <pre><code>aes128-ctr aes192-ctr aes256-ctr aes128-gcm@openssh.com aes256-gcm@openssh.com</code></pre> 34653 <p>Properties:</p> 34654 <ul> 34655 <li>Config: ciphers</li> 34656 <li>Env Var: RCLONE_SFTP_CIPHERS</li> 34657 <li>Type: SpaceSepList</li> 34658 <li>Default:</li> 34659 </ul> 34660 <h4 id="sftp-key-exchange">--sftp-key-exchange</h4> 34661 <p>Space separated list of key exchange algorithms, ordered by preference.</p> 34662 <p>At least one must match with server configuration. This can be checked for example using ssh -Q kex.</p> 34663 <p>This must not be set if use_insecure_cipher is true.</p> 34664 <p>Example:</p> 34665 <pre><code>sntrup761x25519-sha512@openssh.com curve25519-sha256 curve25519-sha256@libssh.org ecdh-sha2-nistp256</code></pre> 34666 <p>Properties:</p> 34667 <ul> 34668 <li>Config: key_exchange</li> 34669 <li>Env Var: RCLONE_SFTP_KEY_EXCHANGE</li> 34670 <li>Type: SpaceSepList</li> 34671 <li>Default:</li> 34672 </ul> 34673 <h4 id="sftp-macs">--sftp-macs</h4> 34674 <p>Space separated list of MACs (message authentication code) algorithms, ordered by preference.</p> 34675 <p>At least one must match with server configuration. This can be checked for example using ssh -Q mac.</p> 34676 <p>Example:</p> 34677 <pre><code>umac-64-etm@openssh.com umac-128-etm@openssh.com hmac-sha2-256-etm@openssh.com</code></pre> 34678 <p>Properties:</p> 34679 <ul> 34680 <li>Config: macs</li> 34681 <li>Env Var: RCLONE_SFTP_MACS</li> 34682 <li>Type: SpaceSepList</li> 34683 <li>Default:</li> 34684 </ul> 34685 <h4 id="sftp-host-key-algorithms">--sftp-host-key-algorithms</h4> 34686 <p>Space separated list of host key algorithms, ordered by preference.</p> 34687 <p>At least one must match with server configuration. This can be checked for example using ssh -Q HostKeyAlgorithms.</p> 34688 <p>Note: This can affect the outcome of key negotiation with the server even if server host key validation is not enabled.</p> 34689 <p>Example:</p> 34690 <pre><code>ssh-ed25519 ssh-rsa ssh-dss</code></pre> 34691 <p>Properties:</p> 34692 <ul> 34693 <li>Config: host_key_algorithms</li> 34694 <li>Env Var: RCLONE_SFTP_HOST_KEY_ALGORITHMS</li> 34695 <li>Type: SpaceSepList</li> 34696 <li>Default:</li> 34697 </ul> 34698 <h4 id="sftp-socks-proxy">--sftp-socks-proxy</h4> 34699 <p>Socks 5 proxy host.</p> 34700 <p>Supports the format user:pass@host:port, user@host:port, host:port.</p> 34701 <p>Example:</p> 34702 <pre><code>myUser:myPass@localhost:9005</code></pre> 34703 <p>Properties:</p> 34704 <ul> 34705 <li>Config: socks_proxy</li> 34706 <li>Env Var: RCLONE_SFTP_SOCKS_PROXY</li> 34707 <li>Type: string</li> 34708 <li>Required: false</li> 34709 </ul> 34710 <h4 id="sftp-copy-is-hardlink">--sftp-copy-is-hardlink</h4> 34711 <p>Set to enable server side copies using hardlinks.</p> 34712 <p>The SFTP protocol does not define a copy command so normally server side copies are not allowed with the sftp backend.</p> 34713 <p>However the SFTP protocol does support hardlinking, and if you enable this flag then the sftp backend will support server side copies. These will be implemented by doing a hardlink from the source to the destination.</p> 34714 <p>Not all sftp servers support this.</p> 34715 <p>Note that hardlinking two files together will use no additional space as the source and the destination will be the same file.</p> 34716 <p>This feature may be useful backups made with --copy-dest.</p> 34717 <p>Properties:</p> 34718 <ul> 34719 <li>Config: copy_is_hardlink</li> 34720 <li>Env Var: RCLONE_SFTP_COPY_IS_HARDLINK</li> 34721 <li>Type: bool</li> 34722 <li>Default: false</li> 34723 </ul> 34724 <h4 id="sftp-description">--sftp-description</h4> 34725 <p>Description of the remote</p> 34726 <p>Properties:</p> 34727 <ul> 34728 <li>Config: description</li> 34729 <li>Env Var: RCLONE_SFTP_DESCRIPTION</li> 34730 <li>Type: string</li> 34731 <li>Required: false</li> 34732 </ul> 34733 <h2 id="limitations-17">Limitations</h2> 34734 <p>On some SFTP servers (e.g. 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> 34735 <p>The only ssh agent supported under Windows is Putty's pageant.</p> 34736 <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 <a href="http://www.isg.rhul.ac.uk/~kp/SandPfinal.pdf">in this paper</a>.</p> 34737 <p>SFTP isn't supported under plan9 until <a href="https://github.com/pkg/sftp/issues/156">this issue</a> is fixed.</p> 34738 <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> 34739 <p>Note that <code>--timeout</code> and <code>--contimeout</code> are both supported.</p> 34740 <h2 id="rsync-net">rsync.net</h2> 34741 <p>rsync.net is supported through the SFTP backend.</p> 34742 <p>See <a href="https://www.rsync.net/products/rclone.html">rsync.net's documentation of rclone examples</a>.</p> 34743 <h2 id="hetzner-storage-box">Hetzner Storage Box</h2> 34744 <p>Hetzner Storage Boxes are supported through the SFTP backend on port 23.</p> 34745 <p>See <a href="https://docs.hetzner.com/robot/storage-box/access/access-ssh-rsync-borg#rclone">Hetzner's documentation for details</a></p> 34746 <h1 id="smb">SMB</h1> 34747 <p>SMB is <a href="https://en.wikipedia.org/wiki/Server_Message_Block">a communication protocol to share files over network</a>.</p> 34748 <p>This relies on <a href="https://github.com/hirochachacha/go-smb2/">go-smb2 library</a> for communication with SMB protocol.</p> 34749 <p>Paths are specified as <code>remote:sharename</code> (or <code>remote:</code> for the <code>lsd</code> command.) You may put subdirectories in too, e.g. <code>remote:item/path/to/dir</code>.</p> 34750 <h2 id="notes">Notes</h2> 34751 <p>The first path segment must be the name of the share, which you entered when you started to share on Windows. On smbd, it's the section title in <code>smb.conf</code> (usually in <code>/etc/samba/</code>) file. You can find shares by querying the root if you're unsure (e.g. <code>rclone lsd remote:</code>).</p> 34752 <p>You can't access to the shared printers from rclone, obviously.</p> 34753 <p>You can't use Anonymous access for logging in. You have to use the <code>guest</code> user with an empty password instead. The rclone client tries to avoid 8.3 names when uploading files by encoding trailing spaces and periods. Alternatively, <a href="https://rclone.org/local/#paths-on-windows">the local backend</a> on Windows can access SMB servers using UNC paths, by <code>\\server\share</code>. This doesn't apply to non-Windows OSes, such as Linux and macOS.</p> 34754 <h2 id="configuration-15">Configuration</h2> 34755 <p>Here is an example of making a SMB configuration.</p> 34756 <p>First run</p> 34757 <pre><code>rclone config</code></pre> 34758 <p>This will guide you through an interactive setup process.</p> 34759 <pre><code>No remotes found, make a new one? 34760 n) New remote 34761 s) Set configuration password 34762 q) Quit config 34763 n/s/q> n 34764 name> remote 34765 Option Storage. 34766 Type of storage to configure. 34767 Choose a number from below, or type in your own value. 34768 XX / SMB / CIFS 34769 \ (smb) 34770 Storage> smb 34771 34772 Option host. 34773 Samba hostname to connect to. 34774 E.g. "example.com". 34775 Enter a value. 34776 host> localhost 34777 34778 Option user. 34779 Samba username. 34780 Enter a string value. Press Enter for the default (lesmi). 34781 user> guest 34782 34783 Option port. 34784 Samba port number. 34785 Enter a signed integer. Press Enter for the default (445). 34786 port> 34787 34788 Option pass. 34789 Samba password. 34790 Choose an alternative below. Press Enter for the default (n). 34791 y) Yes, type in my own password 34792 g) Generate random password 34793 n) No, leave this optional password blank (default) 34794 y/g/n> g 34795 Password strength in bits. 34796 64 is just about memorable 34797 128 is secure 34798 1024 is the maximum 34799 Bits> 64 34800 Your password is: XXXX 34801 Use this password? Please note that an obscured version of this 34802 password (and not the password itself) will be stored under your 34803 configuration file, so keep this generated password in a safe place. 34804 y) Yes (default) 34805 n) No 34806 y/n> y 34807 34808 Option domain. 34809 Domain name for NTLM authentication. 34810 Enter a string value. Press Enter for the default (WORKGROUP). 34811 domain> 34812 34813 Edit advanced config? 34814 y) Yes 34815 n) No (default) 34816 y/n> n 34817 34818 Configuration complete. 34819 Options: 34820 - type: samba 34821 - host: localhost 34822 - user: guest 34823 - pass: *** ENCRYPTED *** 34824 Keep this "remote" remote? 34825 y) Yes this is OK (default) 34826 e) Edit this remote 34827 d) Delete this remote 34828 y/e/d> d</code></pre> 34829 <h3 id="standard-options-17">Standard options</h3> 34830 <p>Here are the Standard options specific to smb (SMB / CIFS).</p> 34831 <h4 id="smb-host">--smb-host</h4> 34832 <p>SMB server hostname to connect to.</p> 34833 <p>E.g. "example.com".</p> 34834 <p>Properties:</p> 34835 <ul> 34836 <li>Config: host</li> 34837 <li>Env Var: RCLONE_SMB_HOST</li> 34838 <li>Type: string</li> 34839 <li>Required: true</li> 34840 </ul> 34841 <h4 id="smb-user">--smb-user</h4> 34842 <p>SMB username.</p> 34843 <p>Properties:</p> 34844 <ul> 34845 <li>Config: user</li> 34846 <li>Env Var: RCLONE_SMB_USER</li> 34847 <li>Type: string</li> 34848 <li>Default: "$USER"</li> 34849 </ul> 34850 <h4 id="smb-port">--smb-port</h4> 34851 <p>SMB port number.</p> 34852 <p>Properties:</p> 34853 <ul> 34854 <li>Config: port</li> 34855 <li>Env Var: RCLONE_SMB_PORT</li> 34856 <li>Type: int</li> 34857 <li>Default: 445</li> 34858 </ul> 34859 <h4 id="smb-pass">--smb-pass</h4> 34860 <p>SMB password.</p> 34861 <p><strong>NB</strong> Input to this must be obscured - see <a href="https://rclone.org/commands/rclone_obscure/">rclone obscure</a>.</p> 34862 <p>Properties:</p> 34863 <ul> 34864 <li>Config: pass</li> 34865 <li>Env Var: RCLONE_SMB_PASS</li> 34866 <li>Type: string</li> 34867 <li>Required: false</li> 34868 </ul> 34869 <h4 id="smb-domain">--smb-domain</h4> 34870 <p>Domain name for NTLM authentication.</p> 34871 <p>Properties:</p> 34872 <ul> 34873 <li>Config: domain</li> 34874 <li>Env Var: RCLONE_SMB_DOMAIN</li> 34875 <li>Type: string</li> 34876 <li>Default: "WORKGROUP"</li> 34877 </ul> 34878 <h4 id="smb-spn">--smb-spn</h4> 34879 <p>Service principal name.</p> 34880 <p>Rclone presents this name to the server. Some servers use this as further authentication, and it often needs to be set for clusters. For example:</p> 34881 <pre><code>cifs/remotehost:1020</code></pre> 34882 <p>Leave blank if not sure.</p> 34883 <p>Properties:</p> 34884 <ul> 34885 <li>Config: spn</li> 34886 <li>Env Var: RCLONE_SMB_SPN</li> 34887 <li>Type: string</li> 34888 <li>Required: false</li> 34889 </ul> 34890 <h3 id="advanced-options-17">Advanced options</h3> 34891 <p>Here are the Advanced options specific to smb (SMB / CIFS).</p> 34892 <h4 id="smb-idle-timeout">--smb-idle-timeout</h4> 34893 <p>Max time before closing idle connections.</p> 34894 <p>If no connections have been returned to the connection pool in the time given, rclone will empty the connection pool.</p> 34895 <p>Set to 0 to keep connections indefinitely.</p> 34896 <p>Properties:</p> 34897 <ul> 34898 <li>Config: idle_timeout</li> 34899 <li>Env Var: RCLONE_SMB_IDLE_TIMEOUT</li> 34900 <li>Type: Duration</li> 34901 <li>Default: 1m0s</li> 34902 </ul> 34903 <h4 id="smb-hide-special-share">--smb-hide-special-share</h4> 34904 <p>Hide special shares (e.g. print$) which users aren't supposed to access.</p> 34905 <p>Properties:</p> 34906 <ul> 34907 <li>Config: hide_special_share</li> 34908 <li>Env Var: RCLONE_SMB_HIDE_SPECIAL_SHARE</li> 34909 <li>Type: bool</li> 34910 <li>Default: true</li> 34911 </ul> 34912 <h4 id="smb-case-insensitive">--smb-case-insensitive</h4> 34913 <p>Whether the server is configured to be case-insensitive.</p> 34914 <p>Always true on Windows shares.</p> 34915 <p>Properties:</p> 34916 <ul> 34917 <li>Config: case_insensitive</li> 34918 <li>Env Var: RCLONE_SMB_CASE_INSENSITIVE</li> 34919 <li>Type: bool</li> 34920 <li>Default: true</li> 34921 </ul> 34922 <h4 id="smb-encoding">--smb-encoding</h4> 34923 <p>The encoding for the backend.</p> 34924 <p>See the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 34925 <p>Properties:</p> 34926 <ul> 34927 <li>Config: encoding</li> 34928 <li>Env Var: RCLONE_SMB_ENCODING</li> 34929 <li>Type: Encoding</li> 34930 <li>Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot</li> 34931 </ul> 34932 <h4 id="smb-description">--smb-description</h4> 34933 <p>Description of the remote</p> 34934 <p>Properties:</p> 34935 <ul> 34936 <li>Config: description</li> 34937 <li>Env Var: RCLONE_SMB_DESCRIPTION</li> 34938 <li>Type: string</li> 34939 <li>Required: false</li> 34940 </ul> 34941 <h1 id="storj-1">Storj</h1> 34942 <p><a href="https://storj.io">Storj</a> is an encrypted, secure, and cost-effective object storage service that enables you to store, back up, and archive large amounts of data in a decentralized manner.</p> 34943 <h2 id="backend-options">Backend options</h2> 34944 <p>Storj can be used both with this native backend and with the <a href="https://rclone.org/s3/#storj">s3 backend using the Storj S3 compatible gateway</a> (shared or private).</p> 34945 <p>Use this backend to take advantage of client-side encryption as well as to achieve the best possible download performance. Uploads will be erasure-coded locally, thus a 1gb upload will result in 2.68gb of data being uploaded to storage nodes across the network.</p> 34946 <p>Use the s3 backend and one of the S3 compatible Hosted Gateways to increase upload performance and reduce the load on your systems and network. Uploads will be encrypted and erasure-coded server-side, thus a 1GB upload will result in only in 1GB of data being uploaded to storage nodes across the network.</p> 34947 <p>Side by side comparison with more details:</p> 34948 <ul> 34949 <li>Characteristics: 34950 <ul> 34951 <li><em>Storj backend</em>: Uses native RPC protocol, connects directly to the storage nodes which hosts the data. Requires more CPU resource of encoding/decoding and has network amplification (especially during the upload), uses lots of TCP connections</li> 34952 <li><em>S3 backend</em>: Uses S3 compatible HTTP Rest API via the shared gateways. There is no network amplification, but performance depends on the shared gateways and the secret encryption key is shared with the gateway.</li> 34953 </ul></li> 34954 <li>Typical usage: 34955 <ul> 34956 <li><em>Storj backend</em>: Server environments and desktops with enough resources, internet speed and connectivity - and applications where storjs client-side encryption is required.</li> 34957 <li><em>S3 backend</em>: Desktops and similar with limited resources, internet speed or connectivity.</li> 34958 </ul></li> 34959 <li>Security: 34960 <ul> 34961 <li><em>Storj backend</em>: <strong>strong</strong>. Private encryption key doesn't need to leave the local computer.</li> 34962 <li><em>S3 backend</em>: <strong>weaker</strong>. Private encryption key is <a href="https://docs.storj.io/dcs/api-reference/s3-compatible-gateway#security-and-encryption">shared with</a> the authentication service of the hosted gateway, where it's stored encrypted. It can be stronger when combining with the rclone <a href="/crypt">crypt</a> backend.</li> 34963 </ul></li> 34964 <li>Bandwidth usage (upload): 34965 <ul> 34966 <li><em>Storj backend</em>: <strong>higher</strong>. As data is erasure coded on the client side both the original data and the parities should be uploaded. About ~2.7 times more data is required to be uploaded. Client may start to upload with even higher number of nodes (~3.7 times more) and abandon/stop the slow uploads.</li> 34967 <li><em>S3 backend</em>: <strong>normal</strong>. Only the raw data is uploaded, erasure coding happens on the gateway.</li> 34968 </ul></li> 34969 <li>Bandwidth usage (download) 34970 <ul> 34971 <li><em>Storj backend</em>: <strong>almost normal</strong>. Only the minimal number of data is required, but to avoid very slow data providers a few more sources are used and the slowest are ignored (max 1.2x overhead).</li> 34972 <li><em>S3 backend</em>: <strong>normal</strong>. Only the raw data is downloaded, erasure coding happens on the shared gateway.</li> 34973 </ul></li> 34974 <li>CPU usage: 34975 <ul> 34976 <li><em>Storj backend</em>: <strong>higher</strong>, but more predictable. Erasure code and encryption/decryption happens locally which requires significant CPU usage.</li> 34977 <li><em>S3 backend</em>: <strong>less</strong>. Erasure code and encryption/decryption happens on shared s3 gateways (and as is, it depends on the current load on the gateways)</li> 34978 </ul></li> 34979 <li>TCP connection usage: 34980 <ul> 34981 <li><em>Storj backend</em>: <strong>high</strong>. A direct connection is required to each of the Storj nodes resulting in 110 connections on upload and 35 on download per 64 MB segment. Not all the connections are actively used (slow ones are pruned), but they are all opened. <a href="https://rclone.org/storj/#known-issues">Adjusting the max open file limit</a> may be required.</li> 34982 <li><em>S3 backend</em>: <strong>normal</strong>. Only one connection per download/upload thread is required to the shared gateway.</li> 34983 </ul></li> 34984 <li>Overall performance: 34985 <ul> 34986 <li><em>Storj backend</em>: with enough resources (CPU and bandwidth) <em>storj</em> backend can provide even 2x better performance. Data is directly downloaded to / uploaded from to the client instead of the gateway.</li> 34987 <li><em>S3 backend</em>: Can be faster on edge devices where CPU and network bandwidth is limited as the shared S3 compatible gateways take care about the encrypting/decryption and erasure coding and no download/upload amplification.</li> 34988 </ul></li> 34989 <li>Decentralization: 34990 <ul> 34991 <li><em>Storj backend</em>: <strong>high</strong>. Data is downloaded directly from the distributed cloud of storage providers.</li> 34992 <li><em>S3 backend</em>: <strong>low</strong>. Requires a running S3 gateway (either self-hosted or Storj-hosted).</li> 34993 </ul></li> 34994 <li>Limitations: 34995 <ul> 34996 <li><em>Storj backend</em>: <code>rclone checksum</code> is not possible without download, as checksum metadata is not calculated during upload</li> 34997 <li><em>S3 backend</em>: secret encryption key is shared with the gateway</li> 34998 </ul></li> 34999 </ul> 35000 <h2 id="configuration-16">Configuration</h2> 35001 <p>To make a new Storj configuration you need one of the following: * Access Grant that someone else shared with you. * <a href="https://documentation.storj.io/getting-started/uploading-your-first-object/create-an-api-key">API Key</a> of a Storj project you are a member of.</p> 35002 <p>Here is an example of how to make a remote called <code>remote</code>. First run:</p> 35003 <pre><code> rclone config</code></pre> 35004 <p>This will guide you through an interactive setup process:</p> 35005 <h3 id="setup-with-access-grant">Setup with access grant</h3> 35006 <pre><code>No remotes found, make a new one? 35007 n) New remote 35008 s) Set configuration password 35009 q) Quit config 35010 n/s/q> n 35011 name> remote 35012 Type of storage to configure. 35013 Enter a string value. Press Enter for the default (""). 35014 Choose a number from below, or type in your own value 35015 [snip] 35016 XX / Storj Decentralized Cloud Storage 35017 \ "storj" 35018 [snip] 35019 Storage> storj 35020 ** See help for storj backend at: https://rclone.org/storj/ ** 35021 35022 Choose an authentication method. 35023 Enter a string value. Press Enter for the default ("existing"). 35024 Choose a number from below, or type in your own value 35025 1 / Use an existing access grant. 35026 \ "existing" 35027 2 / Create a new access grant from satellite address, API key, and passphrase. 35028 \ "new" 35029 provider> existing 35030 Access Grant. 35031 Enter a string value. Press Enter for the default (""). 35032 access_grant> your-access-grant-received-by-someone-else 35033 Remote config 35034 -------------------- 35035 [remote] 35036 type = storj 35037 access_grant = your-access-grant-received-by-someone-else 35038 -------------------- 35039 y) Yes this is OK (default) 35040 e) Edit this remote 35041 d) Delete this remote 35042 y/e/d> y</code></pre> 35043 <h3 id="setup-with-api-key-and-passphrase">Setup with API key and passphrase</h3> 35044 <pre><code>No remotes found, make a new one? 35045 n) New remote 35046 s) Set configuration password 35047 q) Quit config 35048 n/s/q> n 35049 name> remote 35050 Type of storage to configure. 35051 Enter a string value. Press Enter for the default (""). 35052 Choose a number from below, or type in your own value 35053 [snip] 35054 XX / Storj Decentralized Cloud Storage 35055 \ "storj" 35056 [snip] 35057 Storage> storj 35058 ** See help for storj backend at: https://rclone.org/storj/ ** 35059 35060 Choose an authentication method. 35061 Enter a string value. Press Enter for the default ("existing"). 35062 Choose a number from below, or type in your own value 35063 1 / Use an existing access grant. 35064 \ "existing" 35065 2 / Create a new access grant from satellite address, API key, and passphrase. 35066 \ "new" 35067 provider> new 35068 Satellite Address. Custom satellite address should match the format: `<nodeid>@<address>:<port>`. 35069 Enter a string value. Press Enter for the default ("us1.storj.io"). 35070 Choose a number from below, or type in your own value 35071 1 / US1 35072 \ "us1.storj.io" 35073 2 / EU1 35074 \ "eu1.storj.io" 35075 3 / AP1 35076 \ "ap1.storj.io" 35077 satellite_address> 1 35078 API Key. 35079 Enter a string value. Press Enter for the default (""). 35080 api_key> your-api-key-for-your-storj-project 35081 Encryption Passphrase. To access existing objects enter passphrase used for uploading. 35082 Enter a string value. Press Enter for the default (""). 35083 passphrase> your-human-readable-encryption-passphrase 35084 Remote config 35085 -------------------- 35086 [remote] 35087 type = storj 35088 satellite_address = 12EayRS2V1kEsWESU9QMRseFhdxYxKicsiFmxrsLZHeLUtdps3S@us1.storj.io:7777 35089 api_key = your-api-key-for-your-storj-project 35090 passphrase = your-human-readable-encryption-passphrase 35091 access_grant = the-access-grant-generated-from-the-api-key-and-passphrase 35092 -------------------- 35093 y) Yes this is OK (default) 35094 e) Edit this remote 35095 d) Delete this remote 35096 y/e/d> y</code></pre> 35097 <h3 id="standard-options-18">Standard options</h3> 35098 <p>Here are the Standard options specific to storj (Storj Decentralized Cloud Storage).</p> 35099 <h4 id="storj-provider">--storj-provider</h4> 35100 <p>Choose an authentication method.</p> 35101 <p>Properties:</p> 35102 <ul> 35103 <li>Config: provider</li> 35104 <li>Env Var: RCLONE_STORJ_PROVIDER</li> 35105 <li>Type: string</li> 35106 <li>Default: "existing"</li> 35107 <li>Examples: 35108 <ul> 35109 <li>"existing" 35110 <ul> 35111 <li>Use an existing access grant.</li> 35112 </ul></li> 35113 <li>"new" 35114 <ul> 35115 <li>Create a new access grant from satellite address, API key, and passphrase.</li> 35116 </ul></li> 35117 </ul></li> 35118 </ul> 35119 <h4 id="storj-access-grant">--storj-access-grant</h4> 35120 <p>Access grant.</p> 35121 <p>Properties:</p> 35122 <ul> 35123 <li>Config: access_grant</li> 35124 <li>Env Var: RCLONE_STORJ_ACCESS_GRANT</li> 35125 <li>Provider: existing</li> 35126 <li>Type: string</li> 35127 <li>Required: false</li> 35128 </ul> 35129 <h4 id="storj-satellite-address">--storj-satellite-address</h4> 35130 <p>Satellite address.</p> 35131 <p>Custom satellite address should match the format: <code><nodeid>@<address>:<port></code>.</p> 35132 <p>Properties:</p> 35133 <ul> 35134 <li>Config: satellite_address</li> 35135 <li>Env Var: RCLONE_STORJ_SATELLITE_ADDRESS</li> 35136 <li>Provider: new</li> 35137 <li>Type: string</li> 35138 <li>Default: "us1.storj.io"</li> 35139 <li>Examples: 35140 <ul> 35141 <li>"us1.storj.io" 35142 <ul> 35143 <li>US1</li> 35144 </ul></li> 35145 <li>"eu1.storj.io" 35146 <ul> 35147 <li>EU1</li> 35148 </ul></li> 35149 <li>"ap1.storj.io" 35150 <ul> 35151 <li>AP1</li> 35152 </ul></li> 35153 </ul></li> 35154 </ul> 35155 <h4 id="storj-api-key">--storj-api-key</h4> 35156 <p>API key.</p> 35157 <p>Properties:</p> 35158 <ul> 35159 <li>Config: api_key</li> 35160 <li>Env Var: RCLONE_STORJ_API_KEY</li> 35161 <li>Provider: new</li> 35162 <li>Type: string</li> 35163 <li>Required: false</li> 35164 </ul> 35165 <h4 id="storj-passphrase">--storj-passphrase</h4> 35166 <p>Encryption passphrase.</p> 35167 <p>To access existing objects enter passphrase used for uploading.</p> 35168 <p>Properties:</p> 35169 <ul> 35170 <li>Config: passphrase</li> 35171 <li>Env Var: RCLONE_STORJ_PASSPHRASE</li> 35172 <li>Provider: new</li> 35173 <li>Type: string</li> 35174 <li>Required: false</li> 35175 </ul> 35176 <h3 id="advanced-options-18">Advanced options</h3> 35177 <p>Here are the Advanced options specific to storj (Storj Decentralized Cloud Storage).</p> 35178 <h4 id="storj-description">--storj-description</h4> 35179 <p>Description of the remote</p> 35180 <p>Properties:</p> 35181 <ul> 35182 <li>Config: description</li> 35183 <li>Env Var: RCLONE_STORJ_DESCRIPTION</li> 35184 <li>Type: string</li> 35185 <li>Required: false</li> 35186 </ul> 35187 <h2 id="usage-1">Usage</h2> 35188 <p>Paths are specified as <code>remote:bucket</code> (or <code>remote:</code> for the <code>lsf</code> command.) You may put subdirectories in too, e.g. <code>remote:bucket/path/to/dir</code>.</p> 35189 <p>Once configured you can then use <code>rclone</code> like this.</p> 35190 <h3 id="create-a-new-bucket">Create a new bucket</h3> 35191 <p>Use the <code>mkdir</code> command to create new bucket, e.g. <code>bucket</code>.</p> 35192 <pre><code>rclone mkdir remote:bucket</code></pre> 35193 <h3 id="list-all-buckets">List all buckets</h3> 35194 <p>Use the <code>lsf</code> command to list all buckets.</p> 35195 <pre><code>rclone lsf remote:</code></pre> 35196 <p>Note the colon (<code>:</code>) character at the end of the command line.</p> 35197 <h3 id="delete-a-bucket">Delete a bucket</h3> 35198 <p>Use the <code>rmdir</code> command to delete an empty bucket.</p> 35199 <pre><code>rclone rmdir remote:bucket</code></pre> 35200 <p>Use the <code>purge</code> command to delete a non-empty bucket with all its content.</p> 35201 <pre><code>rclone purge remote:bucket</code></pre> 35202 <h3 id="upload-objects">Upload objects</h3> 35203 <p>Use the <code>copy</code> command to upload an object.</p> 35204 <pre><code>rclone copy --progress /home/local/directory/file.ext remote:bucket/path/to/dir/</code></pre> 35205 <p>The <code>--progress</code> flag is for displaying progress information. Remove it if you don't need this information.</p> 35206 <p>Use a folder in the local path to upload all its objects.</p> 35207 <pre><code>rclone copy --progress /home/local/directory/ remote:bucket/path/to/dir/</code></pre> 35208 <p>Only modified files will be copied.</p> 35209 <h3 id="list-objects">List objects</h3> 35210 <p>Use the <code>ls</code> command to list recursively all objects in a bucket.</p> 35211 <pre><code>rclone ls remote:bucket</code></pre> 35212 <p>Add the folder to the remote path to list recursively all objects in this folder.</p> 35213 <pre><code>rclone ls remote:bucket/path/to/dir/</code></pre> 35214 <p>Use the <code>lsf</code> command to list non-recursively all objects in a bucket or a folder.</p> 35215 <pre><code>rclone lsf remote:bucket/path/to/dir/</code></pre> 35216 <h3 id="download-objects">Download objects</h3> 35217 <p>Use the <code>copy</code> command to download an object.</p> 35218 <pre><code>rclone copy --progress remote:bucket/path/to/dir/file.ext /home/local/directory/</code></pre> 35219 <p>The <code>--progress</code> flag is for displaying progress information. Remove it if you don't need this information.</p> 35220 <p>Use a folder in the remote path to download all its objects.</p> 35221 <pre><code>rclone copy --progress remote:bucket/path/to/dir/ /home/local/directory/</code></pre> 35222 <h3 id="delete-objects">Delete objects</h3> 35223 <p>Use the <code>deletefile</code> command to delete a single object.</p> 35224 <pre><code>rclone deletefile remote:bucket/path/to/dir/file.ext</code></pre> 35225 <p>Use the <code>delete</code> command to delete all object in a folder.</p> 35226 <pre><code>rclone delete remote:bucket/path/to/dir/</code></pre> 35227 <h3 id="print-the-total-size-of-objects">Print the total size of objects</h3> 35228 <p>Use the <code>size</code> command to print the total size of objects in a bucket or a folder.</p> 35229 <pre><code>rclone size remote:bucket/path/to/dir/</code></pre> 35230 <h3 id="sync-two-locations">Sync two Locations</h3> 35231 <p>Use the <code>sync</code> command to sync the source to the destination, changing the destination only, deleting any excess files.</p> 35232 <pre><code>rclone sync --interactive --progress /home/local/directory/ remote:bucket/path/to/dir/</code></pre> 35233 <p>The <code>--progress</code> flag is for displaying progress information. Remove it if you don't need this information.</p> 35234 <p>Since this can cause data loss, test first with the <code>--dry-run</code> flag to see exactly what would be copied and deleted.</p> 35235 <p>The sync can be done also from Storj to the local file system.</p> 35236 <pre><code>rclone sync --interactive --progress remote:bucket/path/to/dir/ /home/local/directory/</code></pre> 35237 <p>Or between two Storj buckets.</p> 35238 <pre><code>rclone sync --interactive --progress remote-us:bucket/path/to/dir/ remote-europe:bucket/path/to/dir/</code></pre> 35239 <p>Or even between another cloud storage and Storj.</p> 35240 <pre><code>rclone sync --interactive --progress s3:bucket/path/to/dir/ storj:bucket/path/to/dir/</code></pre> 35241 <h2 id="limitations-18">Limitations</h2> 35242 <p><code>rclone about</code> is not supported by the rclone Storj backend. Backends without this capability cannot determine free space for an rclone mount or use policy <code>mfs</code> (most free space) as a member of an rclone union remote.</p> 35243 <p>See <a href="https://rclone.org/overview/#optional-features">List of backends that do not support rclone about</a> and <a href="https://rclone.org/commands/rclone_about/">rclone about</a></p> 35244 <h2 id="known-issues">Known issues</h2> 35245 <p>If you get errors like <code>too many open files</code> this usually happens when the default <code>ulimit</code> for system max open files is exceeded. Native Storj protocol opens a large number of TCP connections (each of which is counted as an open file). For a single upload stream you can expect 110 TCP connections to be opened. For a single download stream you can expect 35. This batch of connections will be opened for every 64 MiB segment and you should also expect TCP connections to be reused. If you do many transfers you eventually open a connection to most storage nodes (thousands of nodes).</p> 35246 <p>To fix these, please raise your system limits. You can do this issuing a <code>ulimit -n 65536</code> just before you run rclone. To change the limits more permanently you can add this to your shell startup script, e.g. <code>$HOME/.bashrc</code>, or change the system-wide configuration, usually <code>/etc/sysctl.conf</code> and/or <code>/etc/security/limits.conf</code>, but please refer to your operating system manual.</p> 35247 <h1 id="sugarsync">SugarSync</h1> 35248 <p><a href="https://sugarsync.com">SugarSync</a> is a cloud service that enables active synchronization of files across computers and other devices for file backup, access, syncing, and sharing.</p> 35249 <h2 id="configuration-17">Configuration</h2> 35250 <p>The initial setup for SugarSync involves getting a token from SugarSync which you can do with rclone. <code>rclone config</code> walks you through it.</p> 35251 <p>Here is an example of how to make a remote called <code>remote</code>. First run:</p> 35252 <pre><code> rclone config</code></pre> 35253 <p>This will guide you through an interactive setup process:</p> 35254 <pre><code>No remotes found, make a new one? 35255 n) New remote 35256 s) Set configuration password 35257 q) Quit config 35258 n/s/q> n 35259 name> remote 35260 Type of storage to configure. 35261 Enter a string value. Press Enter for the default (""). 35262 Choose a number from below, or type in your own value 35263 [snip] 35264 XX / Sugarsync 35265 \ "sugarsync" 35266 [snip] 35267 Storage> sugarsync 35268 ** See help for sugarsync backend at: https://rclone.org/sugarsync/ ** 35269 35270 Sugarsync App ID. 35271 Leave blank to use rclone's. 35272 Enter a string value. Press Enter for the default (""). 35273 app_id> 35274 Sugarsync Access Key ID. 35275 Leave blank to use rclone's. 35276 Enter a string value. Press Enter for the default (""). 35277 access_key_id> 35278 Sugarsync Private Access Key 35279 Leave blank to use rclone's. 35280 Enter a string value. Press Enter for the default (""). 35281 private_access_key> 35282 Permanently delete files if true 35283 otherwise put them in the deleted files. 35284 Enter a boolean value (true or false). Press Enter for the default ("false"). 35285 hard_delete> 35286 Edit advanced config? (y/n) 35287 y) Yes 35288 n) No (default) 35289 y/n> n 35290 Remote config 35291 Username (email address)> nick@craig-wood.com 35292 Your Sugarsync password is only required during setup and will not be stored. 35293 password: 35294 -------------------- 35295 [remote] 35296 type = sugarsync 35297 refresh_token = https://api.sugarsync.com/app-authorization/XXXXXXXXXXXXXXXXXX 35298 -------------------- 35299 y) Yes this is OK (default) 35300 e) Edit this remote 35301 d) Delete this remote 35302 y/e/d> y</code></pre> 35303 <p>Note that the config asks for your email and password but doesn't store them, it only uses them to get the initial token.</p> 35304 <p>Once configured you can then use <code>rclone</code> like this,</p> 35305 <p>List directories (sync folders) in top level of your SugarSync</p> 35306 <pre><code>rclone lsd remote:</code></pre> 35307 <p>List all the files in your SugarSync folder "Test"</p> 35308 <pre><code>rclone ls remote:Test</code></pre> 35309 <p>To copy a local directory to an SugarSync folder called backup</p> 35310 <pre><code>rclone copy /home/source remote:backup</code></pre> 35311 <p>Paths are specified as <code>remote:path</code></p> 35312 <p>Paths may be as deep as required, e.g. <code>remote:directory/subdirectory</code>.</p> 35313 <p><strong>NB</strong> you can't create files in the top level folder you have to create a folder, which rclone will create as a "Sync Folder" with SugarSync.</p> 35314 <h3 id="modification-times-and-hashes-12">Modification times and hashes</h3> 35315 <p>SugarSync does not support modification times or hashes, therefore syncing will default to <code>--size-only</code> checking. Note that using <code>--update</code> will work as rclone can read the time files were uploaded.</p> 35316 <h3 id="restricted-filename-characters-12">Restricted filename characters</h3> 35317 <p>SugarSync replaces the <a href="https://rclone.org/overview/#restricted-characters">default restricted characters set</a> except for DEL.</p> 35318 <p>Invalid UTF-8 bytes will also be <a href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they can't be used in XML strings.</p> 35319 <h3 id="deleting-files-2">Deleting files</h3> 35320 <p>Deleted files will be moved to the "Deleted items" folder by default.</p> 35321 <p>However you can supply the flag <code>--sugarsync-hard-delete</code> or set the config parameter <code>hard_delete = true</code> if you would like files to be deleted straight away.</p> 35322 <h3 id="standard-options-19">Standard options</h3> 35323 <p>Here are the Standard options specific to sugarsync (Sugarsync).</p> 35324 <h4 id="sugarsync-app-id">--sugarsync-app-id</h4> 35325 <p>Sugarsync App ID.</p> 35326 <p>Leave blank to use rclone's.</p> 35327 <p>Properties:</p> 35328 <ul> 35329 <li>Config: app_id</li> 35330 <li>Env Var: RCLONE_SUGARSYNC_APP_ID</li> 35331 <li>Type: string</li> 35332 <li>Required: false</li> 35333 </ul> 35334 <h4 id="sugarsync-access-key-id">--sugarsync-access-key-id</h4> 35335 <p>Sugarsync Access Key ID.</p> 35336 <p>Leave blank to use rclone's.</p> 35337 <p>Properties:</p> 35338 <ul> 35339 <li>Config: access_key_id</li> 35340 <li>Env Var: RCLONE_SUGARSYNC_ACCESS_KEY_ID</li> 35341 <li>Type: string</li> 35342 <li>Required: false</li> 35343 </ul> 35344 <h4 id="sugarsync-private-access-key">--sugarsync-private-access-key</h4> 35345 <p>Sugarsync Private Access Key.</p> 35346 <p>Leave blank to use rclone's.</p> 35347 <p>Properties:</p> 35348 <ul> 35349 <li>Config: private_access_key</li> 35350 <li>Env Var: RCLONE_SUGARSYNC_PRIVATE_ACCESS_KEY</li> 35351 <li>Type: string</li> 35352 <li>Required: false</li> 35353 </ul> 35354 <h4 id="sugarsync-hard-delete">--sugarsync-hard-delete</h4> 35355 <p>Permanently delete files if true otherwise put them in the deleted files.</p> 35356 <p>Properties:</p> 35357 <ul> 35358 <li>Config: hard_delete</li> 35359 <li>Env Var: RCLONE_SUGARSYNC_HARD_DELETE</li> 35360 <li>Type: bool</li> 35361 <li>Default: false</li> 35362 </ul> 35363 <h3 id="advanced-options-19">Advanced options</h3> 35364 <p>Here are the Advanced options specific to sugarsync (Sugarsync).</p> 35365 <h4 id="sugarsync-refresh-token">--sugarsync-refresh-token</h4> 35366 <p>Sugarsync refresh token.</p> 35367 <p>Leave blank normally, will be auto configured by rclone.</p> 35368 <p>Properties:</p> 35369 <ul> 35370 <li>Config: refresh_token</li> 35371 <li>Env Var: RCLONE_SUGARSYNC_REFRESH_TOKEN</li> 35372 <li>Type: string</li> 35373 <li>Required: false</li> 35374 </ul> 35375 <h4 id="sugarsync-authorization">--sugarsync-authorization</h4> 35376 <p>Sugarsync authorization.</p> 35377 <p>Leave blank normally, will be auto configured by rclone.</p> 35378 <p>Properties:</p> 35379 <ul> 35380 <li>Config: authorization</li> 35381 <li>Env Var: RCLONE_SUGARSYNC_AUTHORIZATION</li> 35382 <li>Type: string</li> 35383 <li>Required: false</li> 35384 </ul> 35385 <h4 id="sugarsync-authorization-expiry">--sugarsync-authorization-expiry</h4> 35386 <p>Sugarsync authorization expiry.</p> 35387 <p>Leave blank normally, will be auto configured by rclone.</p> 35388 <p>Properties:</p> 35389 <ul> 35390 <li>Config: authorization_expiry</li> 35391 <li>Env Var: RCLONE_SUGARSYNC_AUTHORIZATION_EXPIRY</li> 35392 <li>Type: string</li> 35393 <li>Required: false</li> 35394 </ul> 35395 <h4 id="sugarsync-user">--sugarsync-user</h4> 35396 <p>Sugarsync user.</p> 35397 <p>Leave blank normally, will be auto configured by rclone.</p> 35398 <p>Properties:</p> 35399 <ul> 35400 <li>Config: user</li> 35401 <li>Env Var: RCLONE_SUGARSYNC_USER</li> 35402 <li>Type: string</li> 35403 <li>Required: false</li> 35404 </ul> 35405 <h4 id="sugarsync-root-id">--sugarsync-root-id</h4> 35406 <p>Sugarsync root id.</p> 35407 <p>Leave blank normally, will be auto configured by rclone.</p> 35408 <p>Properties:</p> 35409 <ul> 35410 <li>Config: root_id</li> 35411 <li>Env Var: RCLONE_SUGARSYNC_ROOT_ID</li> 35412 <li>Type: string</li> 35413 <li>Required: false</li> 35414 </ul> 35415 <h4 id="sugarsync-deleted-id">--sugarsync-deleted-id</h4> 35416 <p>Sugarsync deleted folder id.</p> 35417 <p>Leave blank normally, will be auto configured by rclone.</p> 35418 <p>Properties:</p> 35419 <ul> 35420 <li>Config: deleted_id</li> 35421 <li>Env Var: RCLONE_SUGARSYNC_DELETED_ID</li> 35422 <li>Type: string</li> 35423 <li>Required: false</li> 35424 </ul> 35425 <h4 id="sugarsync-encoding">--sugarsync-encoding</h4> 35426 <p>The encoding for the backend.</p> 35427 <p>See the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 35428 <p>Properties:</p> 35429 <ul> 35430 <li>Config: encoding</li> 35431 <li>Env Var: RCLONE_SUGARSYNC_ENCODING</li> 35432 <li>Type: Encoding</li> 35433 <li>Default: Slash,Ctl,InvalidUtf8,Dot</li> 35434 </ul> 35435 <h4 id="sugarsync-description">--sugarsync-description</h4> 35436 <p>Description of the remote</p> 35437 <p>Properties:</p> 35438 <ul> 35439 <li>Config: description</li> 35440 <li>Env Var: RCLONE_SUGARSYNC_DESCRIPTION</li> 35441 <li>Type: string</li> 35442 <li>Required: false</li> 35443 </ul> 35444 <h2 id="limitations-19">Limitations</h2> 35445 <p><code>rclone about</code> is not supported by the SugarSync backend. Backends without this capability cannot determine free space for an rclone mount or use policy <code>mfs</code> (most free space) as a member of an rclone union remote.</p> 35446 <p>See <a href="https://rclone.org/overview/#optional-features">List of backends that do not support rclone about</a> and <a href="https://rclone.org/commands/rclone_about/">rclone about</a></p> 35447 <h1 id="tardigrade">Tardigrade</h1> 35448 <p>The Tardigrade backend has been renamed to be the <a href="https://rclone.org/storj/">Storj backend</a>. Old configuration files will continue to work.</p> 35449 <h1 id="uptobox">Uptobox</h1> 35450 <p>This is a Backend for Uptobox file storage service. Uptobox is closer to a one-click hoster than a traditional cloud storage provider and therefore not suitable for long term storage.</p> 35451 <p>Paths are specified as <code>remote:path</code></p> 35452 <p>Paths may be as deep as required, e.g. <code>remote:directory/subdirectory</code>.</p> 35453 <h2 id="configuration-18">Configuration</h2> 35454 <p>To configure an Uptobox backend you'll need your personal api token. You'll find it in your <a href="https://uptobox.com/my_account">account settings</a></p> 35455 <p>Here is an example of how to make a remote called <code>remote</code> with the default setup. First run:</p> 35456 <pre><code>rclone config</code></pre> 35457 <p>This will guide you through an interactive setup process:</p> 35458 <pre><code>Current remotes: 35459 35460 Name Type 35461 ==== ==== 35462 TestUptobox uptobox 35463 35464 e) Edit existing remote 35465 n) New remote 35466 d) Delete remote 35467 r) Rename remote 35468 c) Copy remote 35469 s) Set configuration password 35470 q) Quit config 35471 e/n/d/r/c/s/q> n 35472 name> uptobox 35473 Type of storage to configure. 35474 Enter a string value. Press Enter for the default (""). 35475 Choose a number from below, or type in your own value 35476 [...] 35477 37 / Uptobox 35478 \ "uptobox" 35479 [...] 35480 Storage> uptobox 35481 ** See help for uptobox backend at: https://rclone.org/uptobox/ ** 35482 35483 Your API Key, get it from https://uptobox.com/my_account 35484 Enter a string value. Press Enter for the default (""). 35485 api_key> xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 35486 Edit advanced config? (y/n) 35487 y) Yes 35488 n) No (default) 35489 y/n> n 35490 Remote config 35491 -------------------- 35492 [uptobox] 35493 type = uptobox 35494 api_key = xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 35495 -------------------- 35496 y) Yes this is OK (default) 35497 e) Edit this remote 35498 d) Delete this remote 35499 y/e/d> </code></pre> 35500 <p>Once configured you can then use <code>rclone</code> like this,</p> 35501 <p>List directories in top level of your Uptobox</p> 35502 <pre><code>rclone lsd remote:</code></pre> 35503 <p>List all the files in your Uptobox</p> 35504 <pre><code>rclone ls remote:</code></pre> 35505 <p>To copy a local directory to an Uptobox directory called backup</p> 35506 <pre><code>rclone copy /home/source remote:backup</code></pre> 35507 <h3 id="modification-times-and-hashes-13">Modification times and hashes</h3> 35508 <p>Uptobox supports neither modified times nor checksums. All timestamps will read as that set by <code>--default-time</code>.</p> 35509 <h3 id="restricted-filename-characters-13">Restricted filename characters</h3> 35510 <p>In addition to the <a href="https://rclone.org/overview/#restricted-characters">default restricted characters set</a> the following characters are also replaced:</p> 35511 <table> 35512 <thead> 35513 <tr class="header"> 35514 <th>Character</th> 35515 <th style="text-align: center;">Value</th> 35516 <th style="text-align: center;">Replacement</th> 35517 </tr> 35518 </thead> 35519 <tbody> 35520 <tr class="odd"> 35521 <td>"</td> 35522 <td style="text-align: center;">0x22</td> 35523 <td style="text-align: center;">＂</td> 35524 </tr> 35525 <tr class="even"> 35526 <td>`</td> 35527 <td style="text-align: center;">0x41</td> 35528 <td style="text-align: center;">｀</td> 35529 </tr> 35530 </tbody> 35531 </table> 35532 <p>Invalid UTF-8 bytes will also be <a href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they can't be used in XML strings.</p> 35533 <h3 id="standard-options-20">Standard options</h3> 35534 <p>Here are the Standard options specific to uptobox (Uptobox).</p> 35535 <h4 id="uptobox-access-token">--uptobox-access-token</h4> 35536 <p>Your access token.</p> 35537 <p>Get it from https://uptobox.com/my_account.</p> 35538 <p>Properties:</p> 35539 <ul> 35540 <li>Config: access_token</li> 35541 <li>Env Var: RCLONE_UPTOBOX_ACCESS_TOKEN</li> 35542 <li>Type: string</li> 35543 <li>Required: false</li> 35544 </ul> 35545 <h3 id="advanced-options-20">Advanced options</h3> 35546 <p>Here are the Advanced options specific to uptobox (Uptobox).</p> 35547 <h4 id="uptobox-private">--uptobox-private</h4> 35548 <p>Set to make uploaded files private</p> 35549 <p>Properties:</p> 35550 <ul> 35551 <li>Config: private</li> 35552 <li>Env Var: RCLONE_UPTOBOX_PRIVATE</li> 35553 <li>Type: bool</li> 35554 <li>Default: false</li> 35555 </ul> 35556 <h4 id="uptobox-encoding">--uptobox-encoding</h4> 35557 <p>The encoding for the backend.</p> 35558 <p>See the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 35559 <p>Properties:</p> 35560 <ul> 35561 <li>Config: encoding</li> 35562 <li>Env Var: RCLONE_UPTOBOX_ENCODING</li> 35563 <li>Type: Encoding</li> 35564 <li>Default: Slash,LtGt,DoubleQuote,BackQuote,Del,Ctl,LeftSpace,InvalidUtf8,Dot</li> 35565 </ul> 35566 <h4 id="uptobox-description">--uptobox-description</h4> 35567 <p>Description of the remote</p> 35568 <p>Properties:</p> 35569 <ul> 35570 <li>Config: description</li> 35571 <li>Env Var: RCLONE_UPTOBOX_DESCRIPTION</li> 35572 <li>Type: string</li> 35573 <li>Required: false</li> 35574 </ul> 35575 <h2 id="limitations-20">Limitations</h2> 35576 <p>Uptobox will delete inactive files that have not been accessed in 60 days.</p> 35577 <p><code>rclone about</code> is not supported by this backend an overview of used space can however been seen in the uptobox web interface.</p> 35578 <h1 id="union">Union</h1> 35579 <p>The <code>union</code> backend joins several remotes together to make a single unified view of them.</p> 35580 <p>During the initial setup with <code>rclone config</code> you will specify the upstream remotes as a space separated list. The upstream remotes can either be a local paths or other remotes.</p> 35581 <p>The attributes <code>:ro</code>, <code>:nc</code> and <code>:writeback</code> can be attached to the end of the remote to tag the remote as <strong>read only</strong>, <strong>no create</strong> or <strong>writeback</strong>, e.g. <code>remote:directory/subdirectory:ro</code> or <code>remote:directory/subdirectory:nc</code>.</p> 35582 <ul> 35583 <li><code>:ro</code> means files will only be read from here and never written</li> 35584 <li><code>:nc</code> means new files or directories won't be created here</li> 35585 <li><code>:writeback</code> means files found in different remotes will be written back here. See the <a href="#writeback">writeback section</a> for more info.</li> 35586 </ul> 35587 <p>Subfolders can be used in upstream remotes. Assume a union remote named <code>backup</code> with the remotes <code>mydrive:private/backup</code>. Invoking <code>rclone mkdir backup:desktop</code> is exactly the same as invoking <code>rclone mkdir mydrive:private/backup/desktop</code>.</p> 35588 <p>There is 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>.</p> 35589 <h2 id="configuration-19">Configuration</h2> 35590 <p>Here is an example of how to make a union called <code>remote</code> for local folders. First run:</p> 35591 <pre><code> rclone config</code></pre> 35592 <p>This will guide you through an interactive setup process:</p> 35593 <pre><code>No remotes found, make a new one? 35594 n) New remote 35595 s) Set configuration password 35596 q) Quit config 35597 n/s/q> n 35598 name> remote 35599 Type of storage to configure. 35600 Choose a number from below, or type in your own value 35601 [snip] 35602 XX / Union merges the contents of several remotes 35603 \ "union" 35604 [snip] 35605 Storage> union 35606 List of space separated upstreams. 35607 Can be 'upstreama:test/dir upstreamb:', '\"upstreama:test/space:ro dir\" upstreamb:', etc. 35608 Enter a string value. Press Enter for the default (""). 35609 upstreams> remote1:dir1 remote2:dir2 remote3:dir3 35610 Policy to choose upstream on ACTION class. 35611 Enter a string value. Press Enter for the default ("epall"). 35612 action_policy> 35613 Policy to choose upstream on CREATE class. 35614 Enter a string value. Press Enter for the default ("epmfs"). 35615 create_policy> 35616 Policy to choose upstream on SEARCH class. 35617 Enter a string value. Press Enter for the default ("ff"). 35618 search_policy> 35619 Cache time of usage and free space (in seconds). This option is only useful when a path preserving policy is used. 35620 Enter a signed integer. Press Enter for the default ("120"). 35621 cache_time> 35622 Remote config 35623 -------------------- 35624 [remote] 35625 type = union 35626 upstreams = remote1:dir1 remote2:dir2 remote3:dir3 35627 -------------------- 35628 y) Yes this is OK 35629 e) Edit this remote 35630 d) Delete this remote 35631 y/e/d> y 35632 Current remotes: 35633 35634 Name Type 35635 ==== ==== 35636 remote union 35637 35638 e) Edit existing remote 35639 n) New remote 35640 d) Delete remote 35641 r) Rename remote 35642 c) Copy remote 35643 s) Set configuration password 35644 q) Quit config 35645 e/n/d/r/c/s/q> q</code></pre> 35646 <p>Once configured you can then use <code>rclone</code> like this,</p> 35647 <p>List directories in top level in <code>remote1:dir1</code>, <code>remote2:dir2</code> and <code>remote3:dir3</code></p> 35648 <pre><code>rclone lsd remote:</code></pre> 35649 <p>List all the files in <code>remote1:dir1</code>, <code>remote2:dir2</code> and <code>remote3:dir3</code></p> 35650 <pre><code>rclone ls remote:</code></pre> 35651 <p>Copy another local directory to the union directory called source, which will be placed into <code>remote3:dir3</code></p> 35652 <pre><code>rclone copy C:\source remote:source</code></pre> 35653 <h3 id="behavior-policies">Behavior / Policies</h3> 35654 <p>The behavior of union backend is inspired by <a href="https://github.com/trapexit/mergerfs">trapexit/mergerfs</a>. All functions are grouped into 3 categories: <strong>action</strong>, <strong>create</strong> and <strong>search</strong>. These functions and categories can be assigned a policy which dictates what file or directory is chosen when performing that behavior. Any policy can be assigned to a function or category though some may not be very useful in practice. For instance: <strong>rand</strong> (random) may be useful for file creation (create) but could lead to very odd behavior if used for <code>delete</code> if there were more than one copy of the file.</p> 35655 <h3 id="function-category-classifications">Function / Category classifications</h3> 35656 <table> 35657 <colgroup> 35658 <col style="width: 8%" /> 35659 <col style="width: 21%" /> 35660 <col style="width: 70%" /> 35661 </colgroup> 35662 <thead> 35663 <tr class="header"> 35664 <th>Category</th> 35665 <th>Description</th> 35666 <th>Functions</th> 35667 </tr> 35668 </thead> 35669 <tbody> 35670 <tr class="odd"> 35671 <td>action</td> 35672 <td>Writing Existing file</td> 35673 <td>move, rmdir, rmdirs, delete, purge and copy, sync (as destination when file exist)</td> 35674 </tr> 35675 <tr class="even"> 35676 <td>create</td> 35677 <td>Create non-existing file</td> 35678 <td>copy, sync (as destination when file not exist)</td> 35679 </tr> 35680 <tr class="odd"> 35681 <td>search</td> 35682 <td>Reading and listing file</td> 35683 <td>ls, lsd, lsl, cat, md5sum, sha1sum and copy, sync (as source)</td> 35684 </tr> 35685 <tr class="even"> 35686 <td>N/A</td> 35687 <td></td> 35688 <td>size, about</td> 35689 </tr> 35690 </tbody> 35691 </table> 35692 <h3 id="path-preservation">Path Preservation</h3> 35693 <p>Policies, as described below, are of two basic types. <code>path preserving</code> and <code>non-path preserving</code>.</p> 35694 <p>All policies which start with <code>ep</code> (<strong>epff</strong>, <strong>eplfs</strong>, <strong>eplus</strong>, <strong>epmfs</strong>, <strong>eprand</strong>) are <code>path preserving</code>. <code>ep</code> stands for <code>existing path</code>.</p> 35695 <p>A path preserving policy will only consider upstreams where the relative path being accessed already exists.</p> 35696 <p>When using non-path preserving policies paths will be created in target upstreams as necessary.</p> 35697 <h3 id="quota-relevant-policies">Quota Relevant Policies</h3> 35698 <p>Some policies rely on quota information. These policies should be used only if your upstreams support the respective quota fields.</p> 35699 <table> 35700 <thead> 35701 <tr class="header"> 35702 <th>Policy</th> 35703 <th>Required Field</th> 35704 </tr> 35705 </thead> 35706 <tbody> 35707 <tr class="odd"> 35708 <td>lfs, eplfs</td> 35709 <td>Free</td> 35710 </tr> 35711 <tr class="even"> 35712 <td>mfs, epmfs</td> 35713 <td>Free</td> 35714 </tr> 35715 <tr class="odd"> 35716 <td>lus, eplus</td> 35717 <td>Used</td> 35718 </tr> 35719 <tr class="even"> 35720 <td>lno, eplno</td> 35721 <td>Objects</td> 35722 </tr> 35723 </tbody> 35724 </table> 35725 <p>To check if your upstream supports the field, run <code>rclone about remote: [flags]</code> and see if the required field exists.</p> 35726 <h3 id="filters-2">Filters</h3> 35727 <p>Policies basically search upstream remotes and create a list of files / paths for functions to work on. The policy is responsible for filtering and sorting. The policy type defines the sorting but filtering is mostly uniform as described below.</p> 35728 <ul> 35729 <li>No <strong>search</strong> policies filter.</li> 35730 <li>All <strong>action</strong> policies will filter out remotes which are tagged as <strong>read-only</strong>.</li> 35731 <li>All <strong>create</strong> policies will filter out remotes which are tagged <strong>read-only</strong> or <strong>no-create</strong>.</li> 35732 </ul> 35733 <p>If all remotes are filtered an error will be returned.</p> 35734 <h3 id="policy-descriptions">Policy descriptions</h3> 35735 <p>The policies definition are inspired by <a href="https://github.com/trapexit/mergerfs">trapexit/mergerfs</a> but not exactly the same. Some policy definition could be different due to the much larger latency of remote file systems.</p> 35736 <table> 35737 <colgroup> 35738 <col style="width: 23%" /> 35739 <col style="width: 76%" /> 35740 </colgroup> 35741 <thead> 35742 <tr class="header"> 35743 <th>Policy</th> 35744 <th>Description</th> 35745 </tr> 35746 </thead> 35747 <tbody> 35748 <tr class="odd"> 35749 <td>all</td> 35750 <td>Search category: same as <strong>epall</strong>. Action category: same as <strong>epall</strong>. Create category: act on all upstreams.</td> 35751 </tr> 35752 <tr class="even"> 35753 <td>epall (existing path, all)</td> 35754 <td>Search category: Given this order configured, act on the first one found where the relative path exists. Action category: apply to all found. Create category: act on all upstreams where the relative path exists.</td> 35755 </tr> 35756 <tr class="odd"> 35757 <td>epff (existing path, first found)</td> 35758 <td>Act on the first one found, by the time upstreams reply, where the relative path exists.</td> 35759 </tr> 35760 <tr class="even"> 35761 <td>eplfs (existing path, least free space)</td> 35762 <td>Of all the upstreams on which the relative path exists choose the one with the least free space.</td> 35763 </tr> 35764 <tr class="odd"> 35765 <td>eplus (existing path, least used space)</td> 35766 <td>Of all the upstreams on which the relative path exists choose the one with the least used space.</td> 35767 </tr> 35768 <tr class="even"> 35769 <td>eplno (existing path, least number of objects)</td> 35770 <td>Of all the upstreams on which the relative path exists choose the one with the least number of objects.</td> 35771 </tr> 35772 <tr class="odd"> 35773 <td>epmfs (existing path, most free space)</td> 35774 <td>Of all the upstreams on which the relative path exists choose the one with the most free space.</td> 35775 </tr> 35776 <tr class="even"> 35777 <td>eprand (existing path, random)</td> 35778 <td>Calls <strong>epall</strong> and then randomizes. Returns only one upstream.</td> 35779 </tr> 35780 <tr class="odd"> 35781 <td>ff (first found)</td> 35782 <td>Search category: same as <strong>epff</strong>. Action category: same as <strong>epff</strong>. Create category: Act on the first one found by the time upstreams reply.</td> 35783 </tr> 35784 <tr class="even"> 35785 <td>lfs (least free space)</td> 35786 <td>Search category: same as <strong>eplfs</strong>. Action category: same as <strong>eplfs</strong>. Create category: Pick the upstream with the least available free space.</td> 35787 </tr> 35788 <tr class="odd"> 35789 <td>lus (least used space)</td> 35790 <td>Search category: same as <strong>eplus</strong>. Action category: same as <strong>eplus</strong>. Create category: Pick the upstream with the least used space.</td> 35791 </tr> 35792 <tr class="even"> 35793 <td>lno (least number of objects)</td> 35794 <td>Search category: same as <strong>eplno</strong>. Action category: same as <strong>eplno</strong>. Create category: Pick the upstream with the least number of objects.</td> 35795 </tr> 35796 <tr class="odd"> 35797 <td>mfs (most free space)</td> 35798 <td>Search category: same as <strong>epmfs</strong>. Action category: same as <strong>epmfs</strong>. Create category: Pick the upstream with the most available free space.</td> 35799 </tr> 35800 <tr class="even"> 35801 <td>newest</td> 35802 <td>Pick the file / directory with the largest mtime.</td> 35803 </tr> 35804 <tr class="odd"> 35805 <td>rand (random)</td> 35806 <td>Calls <strong>all</strong> and then randomizes. Returns only one upstream.</td> 35807 </tr> 35808 </tbody> 35809 </table> 35810 <h3 id="writeback">Writeback</h3> 35811 <p>The tag <code>:writeback</code> on an upstream remote can be used to make a simple cache system like this:</p> 35812 <pre><code>[union] 35813 type = union 35814 action_policy = all 35815 create_policy = all 35816 search_policy = ff 35817 upstreams = /local:writeback remote:dir</code></pre> 35818 <p>When files are opened for read, if the file is in <code>remote:dir</code> but not <code>/local</code> then rclone will copy the file entirely into <code>/local</code> before returning a reference to the file in <code>/local</code>. The copy will be done with the equivalent of <code>rclone copy</code> so will use <code>--multi-thread-streams</code> if configured. Any copies will be logged with an INFO log.</p> 35819 <p>When files are written, they will be written to both <code>remote:dir</code> and <code>/local</code>.</p> 35820 <p>As many remotes as desired can be added to <code>upstreams</code> but there should only be one <code>:writeback</code> tag.</p> 35821 <p>Rclone does not manage the <code>:writeback</code> remote in any way other than writing files back to it. So if you need to expire old files or manage the size then you will have to do this yourself.</p> 35822 <h3 id="standard-options-21">Standard options</h3> 35823 <p>Here are the Standard options specific to union (Union merges the contents of several upstream fs).</p> 35824 <h4 id="union-upstreams">--union-upstreams</h4> 35825 <p>List of space separated upstreams.</p> 35826 <p>Can be 'upstreama:test/dir upstreamb:', '"upstreama:test/space:ro dir" upstreamb:', etc.</p> 35827 <p>Properties:</p> 35828 <ul> 35829 <li>Config: upstreams</li> 35830 <li>Env Var: RCLONE_UNION_UPSTREAMS</li> 35831 <li>Type: string</li> 35832 <li>Required: true</li> 35833 </ul> 35834 <h4 id="union-action-policy">--union-action-policy</h4> 35835 <p>Policy to choose upstream on ACTION category.</p> 35836 <p>Properties:</p> 35837 <ul> 35838 <li>Config: action_policy</li> 35839 <li>Env Var: RCLONE_UNION_ACTION_POLICY</li> 35840 <li>Type: string</li> 35841 <li>Default: "epall"</li> 35842 </ul> 35843 <h4 id="union-create-policy">--union-create-policy</h4> 35844 <p>Policy to choose upstream on CREATE category.</p> 35845 <p>Properties:</p> 35846 <ul> 35847 <li>Config: create_policy</li> 35848 <li>Env Var: RCLONE_UNION_CREATE_POLICY</li> 35849 <li>Type: string</li> 35850 <li>Default: "epmfs"</li> 35851 </ul> 35852 <h4 id="union-search-policy">--union-search-policy</h4> 35853 <p>Policy to choose upstream on SEARCH category.</p> 35854 <p>Properties:</p> 35855 <ul> 35856 <li>Config: search_policy</li> 35857 <li>Env Var: RCLONE_UNION_SEARCH_POLICY</li> 35858 <li>Type: string</li> 35859 <li>Default: "ff"</li> 35860 </ul> 35861 <h4 id="union-cache-time">--union-cache-time</h4> 35862 <p>Cache time of usage and free space (in seconds).</p> 35863 <p>This option is only useful when a path preserving policy is used.</p> 35864 <p>Properties:</p> 35865 <ul> 35866 <li>Config: cache_time</li> 35867 <li>Env Var: RCLONE_UNION_CACHE_TIME</li> 35868 <li>Type: int</li> 35869 <li>Default: 120</li> 35870 </ul> 35871 <h3 id="advanced-options-21">Advanced options</h3> 35872 <p>Here are the Advanced options specific to union (Union merges the contents of several upstream fs).</p> 35873 <h4 id="union-min-free-space">--union-min-free-space</h4> 35874 <p>Minimum viable free space for lfs/eplfs policies.</p> 35875 <p>If a remote has less than this much free space then it won't be considered for use in lfs or eplfs policies.</p> 35876 <p>Properties:</p> 35877 <ul> 35878 <li>Config: min_free_space</li> 35879 <li>Env Var: RCLONE_UNION_MIN_FREE_SPACE</li> 35880 <li>Type: SizeSuffix</li> 35881 <li>Default: 1Gi</li> 35882 </ul> 35883 <h4 id="union-description">--union-description</h4> 35884 <p>Description of the remote</p> 35885 <p>Properties:</p> 35886 <ul> 35887 <li>Config: description</li> 35888 <li>Env Var: RCLONE_UNION_DESCRIPTION</li> 35889 <li>Type: string</li> 35890 <li>Required: false</li> 35891 </ul> 35892 <h3 id="metadata-4">Metadata</h3> 35893 <p>Any metadata supported by the underlying remote is read and written.</p> 35894 <p>See the <a href="https://rclone.org/docs/#metadata">metadata</a> docs for more info.</p> 35895 <h1 id="webdav">WebDAV</h1> 35896 <p>Paths are specified as <code>remote:path</code></p> 35897 <p>Paths may be as deep as required, e.g. <code>remote:directory/subdirectory</code>.</p> 35898 <h2 id="configuration-20">Configuration</h2> 35899 <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> 35900 <p>Here is an example of how to make a remote called <code>remote</code>. First run:</p> 35901 <pre><code> rclone config</code></pre> 35902 <p>This will guide you through an interactive setup process:</p> 35903 <pre><code>No remotes found, make a new one? 35904 n) New remote 35905 s) Set configuration password 35906 q) Quit config 35907 n/s/q> n 35908 name> remote 35909 Type of storage to configure. 35910 Choose a number from below, or type in your own value 35911 [snip] 35912 XX / WebDAV 35913 \ "webdav" 35914 [snip] 35915 Storage> webdav 35916 URL of http host to connect to 35917 Choose a number from below, or type in your own value 35918 1 / Connect to example.com 35919 \ "https://example.com" 35920 url> https://example.com/remote.php/webdav/ 35921 Name of the WebDAV site/service/software you are using 35922 Choose a number from below, or type in your own value 35923 1 / Fastmail Files 35924 \ (fastmail) 35925 2 / Nextcloud 35926 \ (nextcloud) 35927 3 / Owncloud 35928 \ (owncloud) 35929 4 / Sharepoint Online, authenticated by Microsoft account 35930 \ (sharepoint) 35931 5 / Sharepoint with NTLM authentication, usually self-hosted or on-premises 35932 \ (sharepoint-ntlm) 35933 6 / rclone WebDAV server to serve a remote over HTTP via the WebDAV protocol 35934 \ (rclone) 35935 7 / Other site/service or software 35936 \ (other) 35937 vendor> 2 35938 User name 35939 user> user 35940 Password. 35941 y) Yes type in my own password 35942 g) Generate random password 35943 n) No leave this optional password blank 35944 y/g/n> y 35945 Enter the password: 35946 password: 35947 Confirm the password: 35948 password: 35949 Bearer token instead of user/pass (e.g. a Macaroon) 35950 bearer_token> 35951 Remote config 35952 -------------------- 35953 [remote] 35954 type = webdav 35955 url = https://example.com/remote.php/webdav/ 35956 vendor = nextcloud 35957 user = user 35958 pass = *** ENCRYPTED *** 35959 bearer_token = 35960 -------------------- 35961 y) Yes this is OK 35962 e) Edit this remote 35963 d) Delete this remote 35964 y/e/d> y</code></pre> 35965 <p>Once configured you can then use <code>rclone</code> like this,</p> 35966 <p>List directories in top level of your WebDAV</p> 35967 <pre><code>rclone lsd remote:</code></pre> 35968 <p>List all the files in your WebDAV</p> 35969 <pre><code>rclone ls remote:</code></pre> 35970 <p>To copy a local directory to an WebDAV directory called backup</p> 35971 <pre><code>rclone copy /home/source remote:backup</code></pre> 35972 <h3 id="modification-times-and-hashes-14">Modification times and hashes</h3> 35973 <p>Plain WebDAV does not support modified times. However when used with Fastmail Files, Owncloud or Nextcloud rclone will support modified times.</p> 35974 <p>Likewise plain WebDAV does not support hashes, however when used with Fastmail Files, 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> 35975 <h3 id="standard-options-22">Standard options</h3> 35976 <p>Here are the Standard options specific to webdav (WebDAV).</p> 35977 <h4 id="webdav-url">--webdav-url</h4> 35978 <p>URL of http host to connect to.</p> 35979 <p>E.g. https://example.com.</p> 35980 <p>Properties:</p> 35981 <ul> 35982 <li>Config: url</li> 35983 <li>Env Var: RCLONE_WEBDAV_URL</li> 35984 <li>Type: string</li> 35985 <li>Required: true</li> 35986 </ul> 35987 <h4 id="webdav-vendor">--webdav-vendor</h4> 35988 <p>Name of the WebDAV site/service/software you are using.</p> 35989 <p>Properties:</p> 35990 <ul> 35991 <li>Config: vendor</li> 35992 <li>Env Var: RCLONE_WEBDAV_VENDOR</li> 35993 <li>Type: string</li> 35994 <li>Required: false</li> 35995 <li>Examples: 35996 <ul> 35997 <li>"fastmail" 35998 <ul> 35999 <li>Fastmail Files</li> 36000 </ul></li> 36001 <li>"nextcloud" 36002 <ul> 36003 <li>Nextcloud</li> 36004 </ul></li> 36005 <li>"owncloud" 36006 <ul> 36007 <li>Owncloud</li> 36008 </ul></li> 36009 <li>"sharepoint" 36010 <ul> 36011 <li>Sharepoint Online, authenticated by Microsoft account</li> 36012 </ul></li> 36013 <li>"sharepoint-ntlm" 36014 <ul> 36015 <li>Sharepoint with NTLM authentication, usually self-hosted or on-premises</li> 36016 </ul></li> 36017 <li>"rclone" 36018 <ul> 36019 <li>rclone WebDAV server to serve a remote over HTTP via the WebDAV protocol</li> 36020 </ul></li> 36021 <li>"other" 36022 <ul> 36023 <li>Other site/service or software</li> 36024 </ul></li> 36025 </ul></li> 36026 </ul> 36027 <h4 id="webdav-user">--webdav-user</h4> 36028 <p>User name.</p> 36029 <p>In case NTLM authentication is used, the username should be in the format 'Domain'.</p> 36030 <p>Properties:</p> 36031 <ul> 36032 <li>Config: user</li> 36033 <li>Env Var: RCLONE_WEBDAV_USER</li> 36034 <li>Type: string</li> 36035 <li>Required: false</li> 36036 </ul> 36037 <h4 id="webdav-pass">--webdav-pass</h4> 36038 <p>Password.</p> 36039 <p><strong>NB</strong> Input to this must be obscured - see <a href="https://rclone.org/commands/rclone_obscure/">rclone obscure</a>.</p> 36040 <p>Properties:</p> 36041 <ul> 36042 <li>Config: pass</li> 36043 <li>Env Var: RCLONE_WEBDAV_PASS</li> 36044 <li>Type: string</li> 36045 <li>Required: false</li> 36046 </ul> 36047 <h4 id="webdav-bearer-token">--webdav-bearer-token</h4> 36048 <p>Bearer token instead of user/pass (e.g. a Macaroon).</p> 36049 <p>Properties:</p> 36050 <ul> 36051 <li>Config: bearer_token</li> 36052 <li>Env Var: RCLONE_WEBDAV_BEARER_TOKEN</li> 36053 <li>Type: string</li> 36054 <li>Required: false</li> 36055 </ul> 36056 <h3 id="advanced-options-22">Advanced options</h3> 36057 <p>Here are the Advanced options specific to webdav (WebDAV).</p> 36058 <h4 id="webdav-bearer-token-command">--webdav-bearer-token-command</h4> 36059 <p>Command to run to get a bearer token.</p> 36060 <p>Properties:</p> 36061 <ul> 36062 <li>Config: bearer_token_command</li> 36063 <li>Env Var: RCLONE_WEBDAV_BEARER_TOKEN_COMMAND</li> 36064 <li>Type: string</li> 36065 <li>Required: false</li> 36066 </ul> 36067 <h4 id="webdav-encoding">--webdav-encoding</h4> 36068 <p>The encoding for the backend.</p> 36069 <p>See the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 36070 <p>Default encoding is Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Hash,Percent,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8 for sharepoint-ntlm or identity otherwise.</p> 36071 <p>Properties:</p> 36072 <ul> 36073 <li>Config: encoding</li> 36074 <li>Env Var: RCLONE_WEBDAV_ENCODING</li> 36075 <li>Type: string</li> 36076 <li>Required: false</li> 36077 </ul> 36078 <h4 id="webdav-headers">--webdav-headers</h4> 36079 <p>Set HTTP headers for all transactions.</p> 36080 <p>Use this to set additional HTTP headers for all transactions</p> 36081 <p>The input format is comma separated list of key,value pairs. Standard <a href="https://godoc.org/encoding/csv">CSV encoding</a> may be used.</p> 36082 <p>For example, to set a Cookie use 'Cookie,name=value', or '"Cookie","name=value"'.</p> 36083 <p>You can set multiple headers, e.g. '"Cookie","name=value","Authorization","xxx"'.</p> 36084 <p>Properties:</p> 36085 <ul> 36086 <li>Config: headers</li> 36087 <li>Env Var: RCLONE_WEBDAV_HEADERS</li> 36088 <li>Type: CommaSepList</li> 36089 <li>Default:</li> 36090 </ul> 36091 <h4 id="webdav-pacer-min-sleep">--webdav-pacer-min-sleep</h4> 36092 <p>Minimum time to sleep between API calls.</p> 36093 <p>Properties:</p> 36094 <ul> 36095 <li>Config: pacer_min_sleep</li> 36096 <li>Env Var: RCLONE_WEBDAV_PACER_MIN_SLEEP</li> 36097 <li>Type: Duration</li> 36098 <li>Default: 10ms</li> 36099 </ul> 36100 <h4 id="webdav-nextcloud-chunk-size">--webdav-nextcloud-chunk-size</h4> 36101 <p>Nextcloud upload chunk size.</p> 36102 <p>We recommend configuring your NextCloud instance to increase the max chunk size to 1 GB for better upload performances. See https://docs.nextcloud.com/server/latest/admin_manual/configuration_files/big_file_upload_configuration.html#adjust-chunk-size-on-nextcloud-side</p> 36103 <p>Set to 0 to disable chunked uploading.</p> 36104 <p>Properties:</p> 36105 <ul> 36106 <li>Config: nextcloud_chunk_size</li> 36107 <li>Env Var: RCLONE_WEBDAV_NEXTCLOUD_CHUNK_SIZE</li> 36108 <li>Type: SizeSuffix</li> 36109 <li>Default: 10Mi</li> 36110 </ul> 36111 <h4 id="webdav-owncloud-exclude-shares">--webdav-owncloud-exclude-shares</h4> 36112 <p>Exclude ownCloud shares</p> 36113 <p>Properties:</p> 36114 <ul> 36115 <li>Config: owncloud_exclude_shares</li> 36116 <li>Env Var: RCLONE_WEBDAV_OWNCLOUD_EXCLUDE_SHARES</li> 36117 <li>Type: bool</li> 36118 <li>Default: false</li> 36119 </ul> 36120 <h4 id="webdav-description">--webdav-description</h4> 36121 <p>Description of the remote</p> 36122 <p>Properties:</p> 36123 <ul> 36124 <li>Config: description</li> 36125 <li>Env Var: RCLONE_WEBDAV_DESCRIPTION</li> 36126 <li>Type: string</li> 36127 <li>Required: false</li> 36128 </ul> 36129 <h2 id="provider-notes">Provider notes</h2> 36130 <p>See below for notes on specific providers.</p> 36131 <h3 id="fastmail-files">Fastmail Files</h3> 36132 <p>Use <code>https://webdav.fastmail.com/</code> or a subdirectory as the URL, and your Fastmail email <code>username@domain.tld</code> as the username. Follow <a href="https://www.fastmail.help/hc/en-us/articles/360058752854-App-passwords">this documentation</a> to create an app password with access to <code>Files (WebDAV)</code> and use this as the password.</p> 36133 <p>Fastmail supports modified times using the <code>X-OC-Mtime</code> header.</p> 36134 <h3 id="owncloud">Owncloud</h3> 36135 <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> 36136 <p>Owncloud supports modified times using the <code>X-OC-Mtime</code> header.</p> 36137 <h3 id="nextcloud">Nextcloud</h3> 36138 <p>This is configured in an identical way to Owncloud. Note that Nextcloud initially did not support streaming of files (<code>rcat</code>) whereas Owncloud did, but <a href="https://github.com/nextcloud/nextcloud-snap/issues/365">this</a> seems to be fixed as of 2020-11-27 (tested with rclone v1.53.1 and Nextcloud Server v19).</p> 36139 <h3 id="sharepoint-online">Sharepoint Online</h3> 36140 <p>Rclone can be used with Sharepoint provided by OneDrive for Business or Office365 Education Accounts. This feature is only needed for a few of these Accounts, mostly Office365 Education ones. These accounts are sometimes not verified by the domain owner <a href="https://github.com/rclone/rclone/issues/1975">github#1975</a></p> 36141 <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> 36142 <p>To use a sharepoint remote with rclone, add it like this: First, you need to get your remote's URL:</p> 36143 <ul> 36144 <li>Go <a href="https://onedrive.live.com/about/en-us/signin/">here</a> to open your OneDrive or to sign in</li> 36145 <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> 36146 </ul> 36147 <p>You'll only need this URL up to the email address. After that, you'll most likely want to add "/Documents". That subdirectory contains the actual data stored on your OneDrive.</p> 36148 <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> 36149 <p>Your config file should look like this:</p> 36150 <pre><code>[sharepoint] 36151 type = webdav 36152 url = https://[YOUR-DOMAIN]-my.sharepoint.com/personal/[YOUR-EMAIL]/Documents 36153 vendor = sharepoint 36154 user = YourEmailAddress 36155 pass = encryptedpassword</code></pre> 36156 <h3 id="sharepoint-with-ntlm-authentication">Sharepoint with NTLM Authentication</h3> 36157 <p>Use this option in case your (hosted) Sharepoint is not tied to OneDrive accounts and uses NTLM authentication.</p> 36158 <p>To get the <code>url</code> configuration, similarly to the above, first navigate to the desired directory in your browser to get the URL, then strip everything after the name of the opened directory.</p> 36159 <p>Example: If the URL is: https://example.sharepoint.com/sites/12345/Documents/Forms/AllItems.aspx</p> 36160 <p>The configuration to use would be: https://example.sharepoint.com/sites/12345/Documents</p> 36161 <p>Set the <code>vendor</code> to <code>sharepoint-ntlm</code>.</p> 36162 <p>NTLM uses domain and user name combination for authentication, set <code>user</code> to <code>DOMAIN\username</code>.</p> 36163 <p>Your config file should look like this:</p> 36164 <pre><code>[sharepoint] 36165 type = webdav 36166 url = https://[YOUR-DOMAIN]/some-path-to/Documents 36167 vendor = sharepoint-ntlm 36168 user = DOMAIN\user 36169 pass = encryptedpassword</code></pre> 36170 <h4 id="required-flags-for-sharepoint">Required Flags for SharePoint</h4> 36171 <p>As SharePoint does some special things with uploaded documents, you won't be able to use the documents size or the documents hash to compare if a file has been changed since the upload / which file is newer.</p> 36172 <p>For Rclone calls copying files (especially Office files such as .docx, .xlsx, etc.) from/to SharePoint (like copy, sync, etc.), you should append these flags to ensure Rclone uses the "Last Modified" datetime property to compare your documents:</p> 36173 <pre><code>--ignore-size --ignore-checksum --update</code></pre> 36174 <h2 id="rclone-1">Rclone</h2> 36175 <p>Use this option if you are hosting remotes over WebDAV provided by rclone. Read <a href="commands/rclone_serve_webdav/">rclone serve webdav</a> for more details.</p> 36176 <p>rclone serve supports modified times using the <code>X-OC-Mtime</code> header.</p> 36177 <h3 id="dcache">dCache</h3> 36178 <p>dCache is a storage system that supports many protocols and authentication/authorisation schemes. For WebDAV clients, it allows users to authenticate with username and password (BASIC), X.509, Kerberos, and various bearer tokens, including <a href="https://www.dcache.org/manuals/workshop-2017-05-29-Umea/000-Final/anupam_macaroons_v02.pdf">Macaroons</a> and <a href="https://en.wikipedia.org/wiki/OpenID_Connect">OpenID-Connect</a> access tokens.</p> 36179 <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> 36180 <p>The config will end up looking something like this.</p> 36181 <pre><code>[dcache] 36182 type = webdav 36183 url = https://dcache... 36184 vendor = other 36185 user = 36186 pass = 36187 bearer_token = your-macaroon</code></pre> 36188 <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> 36189 <p>Macaroons may also be obtained from the dCacheView web-browser/JavaScript client that comes with dCache.</p> 36190 <h3 id="openid-connect">OpenID-Connect</h3> 36191 <p>dCache also supports authenticating with OpenID-Connect access tokens. OpenID-Connect is a protocol (based on OAuth 2.0) that allows services to identify users who have authenticated with some central service.</p> 36192 <p>Support for OpenID-Connect in rclone is currently achieved using another software package called <a href="https://github.com/indigo-dc/oidc-agent">oidc-agent</a>. This is a command-line tool that facilitates obtaining an access token. Once installed and configured, an access token is obtained by running the <code>oidc-token</code> command. The following example shows a (shortened) access token obtained from the <em>XDC</em> OIDC Provider.</p> 36193 <pre><code>paul@celebrimbor:~$ oidc-token XDC 36194 eyJraWQ[...]QFXDt0 36195 paul@celebrimbor:~$</code></pre> 36196 <p><strong>Note</strong> Before the <code>oidc-token</code> command will work, the refresh token must be loaded into the oidc agent. This is done with the <code>oidc-add</code> command (e.g., <code>oidc-add XDC</code>). This is typically done once per login session. Full details on this and how to register oidc-agent with your OIDC Provider are provided in the <a href="https://indigo-dc.gitbooks.io/oidc-agent/">oidc-agent documentation</a>.</p> 36197 <p>The rclone <code>bearer_token_command</code> configuration option is used to fetch the access token from oidc-agent.</p> 36198 <p>Configure as a normal WebDAV endpoint, using the 'other' vendor, leaving the username and password empty. When prompted, choose to edit the advanced config and enter the command to get a bearer token (e.g., <code>oidc-agent XDC</code>).</p> 36199 <p>The following example config shows a WebDAV endpoint that uses oidc-agent to supply an access token from the <em>XDC</em> OIDC Provider.</p> 36200 <pre><code>[dcache] 36201 type = webdav 36202 url = https://dcache.example.org/ 36203 vendor = other 36204 bearer_token_command = oidc-token XDC</code></pre> 36205 <h1 id="yandex-disk">Yandex Disk</h1> 36206 <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> 36207 <h2 id="configuration-21">Configuration</h2> 36208 <p>Here is an example of making a yandex configuration. First run</p> 36209 <pre><code>rclone config</code></pre> 36210 <p>This will guide you through an interactive setup process:</p> 36211 <pre><code>No remotes found, make a new one? 36212 n) New remote 36213 s) Set configuration password 36214 n/s> n 36215 name> remote 36216 Type of storage to configure. 36217 Choose a number from below, or type in your own value 36218 [snip] 36219 XX / Yandex Disk 36220 \ "yandex" 36221 [snip] 36222 Storage> yandex 36223 Yandex Client Id - leave blank normally. 36224 client_id> 36225 Yandex Client Secret - leave blank normally. 36226 client_secret> 36227 Remote config 36228 Use web browser to automatically authenticate rclone with remote? 36229 * Say Y if the machine running rclone has a web browser you can use 36230 * Say N if running rclone on a (remote) machine without web browser access 36231 If not sure try Y. If Y failed, try N. 36232 y) Yes 36233 n) No 36234 y/n> y 36235 If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth 36236 Log in and authorize rclone for access 36237 Waiting for code... 36238 Got code 36239 -------------------- 36240 [remote] 36241 client_id = 36242 client_secret = 36243 token = {"access_token":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","token_type":"OAuth","expiry":"2016-12-29T12:27:11.362788025Z"} 36244 -------------------- 36245 y) Yes this is OK 36246 e) Edit this remote 36247 d) Delete this remote 36248 y/e/d> y</code></pre> 36249 <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> 36250 <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> 36251 <p>Once configured you can then use <code>rclone</code> like this,</p> 36252 <p>See top level directories</p> 36253 <pre><code>rclone lsd remote:</code></pre> 36254 <p>Make a new directory</p> 36255 <pre><code>rclone mkdir remote:directory</code></pre> 36256 <p>List the contents of a directory</p> 36257 <pre><code>rclone ls remote:directory</code></pre> 36258 <p>Sync <code>/home/local/directory</code> to the remote path, deleting any excess files in the path.</p> 36259 <pre><code>rclone sync --interactive /home/local/directory remote:directory</code></pre> 36260 <p>Yandex paths may be as deep as required, e.g. <code>remote:directory/subdirectory</code>.</p> 36261 <h3 id="modification-times-and-hashes-15">Modification times and hashes</h3> 36262 <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> 36263 <p>The MD5 hash algorithm is natively supported by Yandex Disk.</p> 36264 <h3 id="emptying-trash">Emptying Trash</h3> 36265 <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> 36266 <h3 id="quota-information">Quota information</h3> 36267 <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> 36268 <h3 id="restricted-filename-characters-14">Restricted filename characters</h3> 36269 <p>The <a href="https://rclone.org/overview/#restricted-characters">default restricted characters set</a> are replaced.</p> 36270 <p>Invalid UTF-8 bytes will also be <a href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they can't be used in JSON strings.</p> 36271 <h3 id="standard-options-23">Standard options</h3> 36272 <p>Here are the Standard options specific to yandex (Yandex Disk).</p> 36273 <h4 id="yandex-client-id">--yandex-client-id</h4> 36274 <p>OAuth Client Id.</p> 36275 <p>Leave blank normally.</p> 36276 <p>Properties:</p> 36277 <ul> 36278 <li>Config: client_id</li> 36279 <li>Env Var: RCLONE_YANDEX_CLIENT_ID</li> 36280 <li>Type: string</li> 36281 <li>Required: false</li> 36282 </ul> 36283 <h4 id="yandex-client-secret">--yandex-client-secret</h4> 36284 <p>OAuth Client Secret.</p> 36285 <p>Leave blank normally.</p> 36286 <p>Properties:</p> 36287 <ul> 36288 <li>Config: client_secret</li> 36289 <li>Env Var: RCLONE_YANDEX_CLIENT_SECRET</li> 36290 <li>Type: string</li> 36291 <li>Required: false</li> 36292 </ul> 36293 <h3 id="advanced-options-23">Advanced options</h3> 36294 <p>Here are the Advanced options specific to yandex (Yandex Disk).</p> 36295 <h4 id="yandex-token">--yandex-token</h4> 36296 <p>OAuth Access Token as a JSON blob.</p> 36297 <p>Properties:</p> 36298 <ul> 36299 <li>Config: token</li> 36300 <li>Env Var: RCLONE_YANDEX_TOKEN</li> 36301 <li>Type: string</li> 36302 <li>Required: false</li> 36303 </ul> 36304 <h4 id="yandex-auth-url">--yandex-auth-url</h4> 36305 <p>Auth server URL.</p> 36306 <p>Leave blank to use the provider defaults.</p> 36307 <p>Properties:</p> 36308 <ul> 36309 <li>Config: auth_url</li> 36310 <li>Env Var: RCLONE_YANDEX_AUTH_URL</li> 36311 <li>Type: string</li> 36312 <li>Required: false</li> 36313 </ul> 36314 <h4 id="yandex-token-url">--yandex-token-url</h4> 36315 <p>Token server url.</p> 36316 <p>Leave blank to use the provider defaults.</p> 36317 <p>Properties:</p> 36318 <ul> 36319 <li>Config: token_url</li> 36320 <li>Env Var: RCLONE_YANDEX_TOKEN_URL</li> 36321 <li>Type: string</li> 36322 <li>Required: false</li> 36323 </ul> 36324 <h4 id="yandex-hard-delete">--yandex-hard-delete</h4> 36325 <p>Delete files permanently rather than putting them into the trash.</p> 36326 <p>Properties:</p> 36327 <ul> 36328 <li>Config: hard_delete</li> 36329 <li>Env Var: RCLONE_YANDEX_HARD_DELETE</li> 36330 <li>Type: bool</li> 36331 <li>Default: false</li> 36332 </ul> 36333 <h4 id="yandex-encoding">--yandex-encoding</h4> 36334 <p>The encoding for the backend.</p> 36335 <p>See the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 36336 <p>Properties:</p> 36337 <ul> 36338 <li>Config: encoding</li> 36339 <li>Env Var: RCLONE_YANDEX_ENCODING</li> 36340 <li>Type: Encoding</li> 36341 <li>Default: Slash,Del,Ctl,InvalidUtf8,Dot</li> 36342 </ul> 36343 <h4 id="yandex-description">--yandex-description</h4> 36344 <p>Description of the remote</p> 36345 <p>Properties:</p> 36346 <ul> 36347 <li>Config: description</li> 36348 <li>Env Var: RCLONE_YANDEX_DESCRIPTION</li> 36349 <li>Type: string</li> 36350 <li>Required: false</li> 36351 </ul> 36352 <h2 id="limitations-21">Limitations</h2> 36353 <p>When uploading very large files (bigger than about 5 GiB) 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 GiB should be enough, so if you want to upload a 30 GiB file set a timeout of <code>2 * 30 = 60m</code>, that is <code>--timeout 60m</code>.</p> 36354 <p>Having a Yandex Mail account is mandatory to use the Yandex.Disk subscription. Token generation will work without a mail account, but Rclone won't be able to complete any actions.</p> 36355 <pre><code>[403 - DiskUnsupportedUserAccountTypeError] User account type is not supported.</code></pre> 36356 <h1 id="zoho-workdrive">Zoho Workdrive</h1> 36357 <p><a href="https://www.zoho.com/workdrive/">Zoho WorkDrive</a> is a cloud storage solution created by <a href="https://zoho.com">Zoho</a>.</p> 36358 <h2 id="configuration-22">Configuration</h2> 36359 <p>Here is an example of making a zoho configuration. First run</p> 36360 <pre><code>rclone config</code></pre> 36361 <p>This will guide you through an interactive setup process:</p> 36362 <pre><code>No remotes found, make a new one? 36363 n) New remote 36364 s) Set configuration password 36365 n/s> n 36366 name> remote 36367 Type of storage to configure. 36368 Enter a string value. Press Enter for the default (""). 36369 Choose a number from below, or type in your own value 36370 [snip] 36371 XX / Zoho 36372 \ "zoho" 36373 [snip] 36374 Storage> zoho 36375 ** See help for zoho backend at: https://rclone.org/zoho/ ** 36376 36377 OAuth Client Id 36378 Leave blank normally. 36379 Enter a string value. Press Enter for the default (""). 36380 client_id> 36381 OAuth Client Secret 36382 Leave blank normally. 36383 Enter a string value. Press Enter for the default (""). 36384 client_secret> 36385 Edit advanced config? (y/n) 36386 y) Yes 36387 n) No (default) 36388 y/n> n 36389 Remote config 36390 Use web browser to automatically authenticate rclone with remote? 36391 * Say Y if the machine running rclone has a web browser you can use 36392 * Say N if running rclone on a (remote) machine without web browser access 36393 If not sure try Y. If Y failed, try N. 36394 y) Yes (default) 36395 n) No 36396 y/n> 36397 If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth?state=LVn0IHzxej1ZkmQw31d0wQ 36398 Log in and authorize rclone for access 36399 Waiting for code... 36400 Got code 36401 Choose a number from below, or type in your own value 36402 1 / MyTeam 36403 \ "4u28602177065ff22426787a6745dba8954eb" 36404 Enter a Team ID> 1 36405 Choose a number from below, or type in your own value 36406 1 / General 36407 \ "4u2869d2aa6fca04f4f2f896b6539243b85b1" 36408 Enter a Workspace ID> 1 36409 -------------------- 36410 [remote] 36411 type = zoho 36412 token = {"access_token":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","token_type":"Zoho-oauthtoken","refresh_token":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","expiry":"2020-10-12T00:54:52.370275223+02:00"} 36413 root_folder_id = xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 36414 -------------------- 36415 y) Yes this is OK (default) 36416 e) Edit this remote 36417 d) Delete this remote 36418 y/e/d> </code></pre> 36419 <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> 36420 <p>Rclone runs a webserver on your local computer to collect the authorization token from Zoho Workdrive. This is only from the moment your browser is opened until the token is returned. The webserver runs on <code>http://127.0.0.1:53682/</code>. If local port <code>53682</code> is protected by a firewall you may need to temporarily unblock the firewall to complete authorization.</p> 36421 <p>Once configured you can then use <code>rclone</code> like this,</p> 36422 <p>See top level directories</p> 36423 <pre><code>rclone lsd remote:</code></pre> 36424 <p>Make a new directory</p> 36425 <pre><code>rclone mkdir remote:directory</code></pre> 36426 <p>List the contents of a directory</p> 36427 <pre><code>rclone ls remote:directory</code></pre> 36428 <p>Sync <code>/home/local/directory</code> to the remote path, deleting any excess files in the path.</p> 36429 <pre><code>rclone sync --interactive /home/local/directory remote:directory</code></pre> 36430 <p>Zoho paths may be as deep as required, eg <code>remote:directory/subdirectory</code>.</p> 36431 <h3 id="modification-times-and-hashes-16">Modification times and hashes</h3> 36432 <p>Modified times are currently not supported for Zoho Workdrive</p> 36433 <p>No hash algorithms are supported.</p> 36434 <h3 id="usage-information">Usage information</h3> 36435 <p>To view your current quota you can use the <code>rclone about remote:</code> command which will display your current usage.</p> 36436 <h3 id="restricted-filename-characters-15">Restricted filename characters</h3> 36437 <p>Only control characters and invalid UTF-8 are replaced. In addition most Unicode full-width characters are not supported at all and will be removed from filenames during upload.</p> 36438 <h3 id="standard-options-24">Standard options</h3> 36439 <p>Here are the Standard options specific to zoho (Zoho).</p> 36440 <h4 id="zoho-client-id">--zoho-client-id</h4> 36441 <p>OAuth Client Id.</p> 36442 <p>Leave blank normally.</p> 36443 <p>Properties:</p> 36444 <ul> 36445 <li>Config: client_id</li> 36446 <li>Env Var: RCLONE_ZOHO_CLIENT_ID</li> 36447 <li>Type: string</li> 36448 <li>Required: false</li> 36449 </ul> 36450 <h4 id="zoho-client-secret">--zoho-client-secret</h4> 36451 <p>OAuth Client Secret.</p> 36452 <p>Leave blank normally.</p> 36453 <p>Properties:</p> 36454 <ul> 36455 <li>Config: client_secret</li> 36456 <li>Env Var: RCLONE_ZOHO_CLIENT_SECRET</li> 36457 <li>Type: string</li> 36458 <li>Required: false</li> 36459 </ul> 36460 <h4 id="zoho-region">--zoho-region</h4> 36461 <p>Zoho region to connect to.</p> 36462 <p>You'll have to use the region your organization is registered in. If not sure use the same top level domain as you connect to in your browser.</p> 36463 <p>Properties:</p> 36464 <ul> 36465 <li>Config: region</li> 36466 <li>Env Var: RCLONE_ZOHO_REGION</li> 36467 <li>Type: string</li> 36468 <li>Required: false</li> 36469 <li>Examples: 36470 <ul> 36471 <li>"com" 36472 <ul> 36473 <li>United states / Global</li> 36474 </ul></li> 36475 <li>"eu" 36476 <ul> 36477 <li>Europe</li> 36478 </ul></li> 36479 <li>"in" 36480 <ul> 36481 <li>India</li> 36482 </ul></li> 36483 <li>"jp" 36484 <ul> 36485 <li>Japan</li> 36486 </ul></li> 36487 <li>"com.cn" 36488 <ul> 36489 <li>China</li> 36490 </ul></li> 36491 <li>"com.au" 36492 <ul> 36493 <li>Australia</li> 36494 </ul></li> 36495 </ul></li> 36496 </ul> 36497 <h3 id="advanced-options-24">Advanced options</h3> 36498 <p>Here are the Advanced options specific to zoho (Zoho).</p> 36499 <h4 id="zoho-token">--zoho-token</h4> 36500 <p>OAuth Access Token as a JSON blob.</p> 36501 <p>Properties:</p> 36502 <ul> 36503 <li>Config: token</li> 36504 <li>Env Var: RCLONE_ZOHO_TOKEN</li> 36505 <li>Type: string</li> 36506 <li>Required: false</li> 36507 </ul> 36508 <h4 id="zoho-auth-url">--zoho-auth-url</h4> 36509 <p>Auth server URL.</p> 36510 <p>Leave blank to use the provider defaults.</p> 36511 <p>Properties:</p> 36512 <ul> 36513 <li>Config: auth_url</li> 36514 <li>Env Var: RCLONE_ZOHO_AUTH_URL</li> 36515 <li>Type: string</li> 36516 <li>Required: false</li> 36517 </ul> 36518 <h4 id="zoho-token-url">--zoho-token-url</h4> 36519 <p>Token server url.</p> 36520 <p>Leave blank to use the provider defaults.</p> 36521 <p>Properties:</p> 36522 <ul> 36523 <li>Config: token_url</li> 36524 <li>Env Var: RCLONE_ZOHO_TOKEN_URL</li> 36525 <li>Type: string</li> 36526 <li>Required: false</li> 36527 </ul> 36528 <h4 id="zoho-encoding">--zoho-encoding</h4> 36529 <p>The encoding for the backend.</p> 36530 <p>See the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 36531 <p>Properties:</p> 36532 <ul> 36533 <li>Config: encoding</li> 36534 <li>Env Var: RCLONE_ZOHO_ENCODING</li> 36535 <li>Type: Encoding</li> 36536 <li>Default: Del,Ctl,InvalidUtf8</li> 36537 </ul> 36538 <h4 id="zoho-description">--zoho-description</h4> 36539 <p>Description of the remote</p> 36540 <p>Properties:</p> 36541 <ul> 36542 <li>Config: description</li> 36543 <li>Env Var: RCLONE_ZOHO_DESCRIPTION</li> 36544 <li>Type: string</li> 36545 <li>Required: false</li> 36546 </ul> 36547 <h2 id="setting-up-your-own-client_id">Setting up your own client_id</h2> 36548 <p>For Zoho we advise you to set up your own client_id. To do so you have to complete the following steps.</p> 36549 <ol type="1"> 36550 <li><p>Log in to the <a href="https://api-console.zoho.com">Zoho API Console</a></p></li> 36551 <li><p>Create a new client of type "Server-based Application". The name and website don't matter, but you must add the redirect URL <code>http://localhost:53682/</code>.</p></li> 36552 <li><p>Once the client is created, you can go to the settings tab and enable it in other regions.</p></li> 36553 </ol> 36554 <p>The client id and client secret can now be used with rclone.</p> 36555 <h1 id="local-filesystem">Local Filesystem</h1> 36556 <p>Local paths are specified as normal filesystem paths, e.g. <code>/path/to/wherever</code>, so</p> 36557 <pre><code>rclone sync --interactive /home/source /tmp/destination</code></pre> 36558 <p>Will sync <code>/home/source</code> to <code>/tmp/destination</code>.</p> 36559 <h2 id="configuration-23">Configuration</h2> 36560 <p>For consistencies sake one can also configure a remote of type <code>local</code> in the config file, and access the local filesystem using rclone remote paths, e.g. <code>remote:path/to/wherever</code>, but it is probably easier not to.</p> 36561 <h3 id="modification-times-2">Modification times</h3> 36562 <p>Rclone reads and writes the modification times using an accuracy determined by the OS. Typically this is 1ns on Linux, 10 ns on Windows and 1 Second on OS X.</p> 36563 <h3 id="filenames">Filenames</h3> 36564 <p>Filenames should be encoded in UTF-8 on disk. This is the normal case for Windows and OS X.</p> 36565 <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 (e.g. 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> 36566 <p>If an invalid (non-UTF8) filename is read, the invalid characters will be replaced with a quoted representation of the invalid bytes. The name <code>gro\xdf</code> will be transferred as <code>gro‛DF</code>. <code>rclone</code> will emit a debug message in this case (use <code>-v</code> to see), e.g.</p> 36567 <pre><code>Local file system at .: Replacing invalid UTF-8 characters in "gro\xdf"</code></pre> 36568 <h4 id="restricted-characters-1">Restricted characters</h4> 36569 <p>With the local backend, restrictions on the characters that are usable in file or directory names depend on the operating system. To check what rclone will replace by default on your system, run <code>rclone help flags local-encoding</code>.</p> 36570 <p>On non Windows platforms the following characters are replaced when handling file names.</p> 36571 <table> 36572 <thead> 36573 <tr class="header"> 36574 <th>Character</th> 36575 <th style="text-align: center;">Value</th> 36576 <th style="text-align: center;">Replacement</th> 36577 </tr> 36578 </thead> 36579 <tbody> 36580 <tr class="odd"> 36581 <td>NUL</td> 36582 <td style="text-align: center;">0x00</td> 36583 <td style="text-align: center;">␀</td> 36584 </tr> 36585 <tr class="even"> 36586 <td>/</td> 36587 <td style="text-align: center;">0x2F</td> 36588 <td style="text-align: center;">／</td> 36589 </tr> 36590 </tbody> 36591 </table> 36592 <p>When running on Windows the following characters are replaced. This list is based on the <a href="https://docs.microsoft.com/de-de/windows/desktop/FileIO/naming-a-file#naming-conventions">Windows file naming conventions</a>.</p> 36593 <table> 36594 <thead> 36595 <tr class="header"> 36596 <th>Character</th> 36597 <th style="text-align: center;">Value</th> 36598 <th style="text-align: center;">Replacement</th> 36599 </tr> 36600 </thead> 36601 <tbody> 36602 <tr class="odd"> 36603 <td>NUL</td> 36604 <td style="text-align: center;">0x00</td> 36605 <td style="text-align: center;">␀</td> 36606 </tr> 36607 <tr class="even"> 36608 <td>SOH</td> 36609 <td style="text-align: center;">0x01</td> 36610 <td style="text-align: center;">␁</td> 36611 </tr> 36612 <tr class="odd"> 36613 <td>STX</td> 36614 <td style="text-align: center;">0x02</td> 36615 <td style="text-align: center;">␂</td> 36616 </tr> 36617 <tr class="even"> 36618 <td>ETX</td> 36619 <td style="text-align: center;">0x03</td> 36620 <td style="text-align: center;">␃</td> 36621 </tr> 36622 <tr class="odd"> 36623 <td>EOT</td> 36624 <td style="text-align: center;">0x04</td> 36625 <td style="text-align: center;">␄</td> 36626 </tr> 36627 <tr class="even"> 36628 <td>ENQ</td> 36629 <td style="text-align: center;">0x05</td> 36630 <td style="text-align: center;">␅</td> 36631 </tr> 36632 <tr class="odd"> 36633 <td>ACK</td> 36634 <td style="text-align: center;">0x06</td> 36635 <td style="text-align: center;">␆</td> 36636 </tr> 36637 <tr class="even"> 36638 <td>BEL</td> 36639 <td style="text-align: center;">0x07</td> 36640 <td style="text-align: center;">␇</td> 36641 </tr> 36642 <tr class="odd"> 36643 <td>BS</td> 36644 <td style="text-align: center;">0x08</td> 36645 <td style="text-align: center;">␈</td> 36646 </tr> 36647 <tr class="even"> 36648 <td>HT</td> 36649 <td style="text-align: center;">0x09</td> 36650 <td style="text-align: center;">␉</td> 36651 </tr> 36652 <tr class="odd"> 36653 <td>LF</td> 36654 <td style="text-align: center;">0x0A</td> 36655 <td style="text-align: center;">␊</td> 36656 </tr> 36657 <tr class="even"> 36658 <td>VT</td> 36659 <td style="text-align: center;">0x0B</td> 36660 <td style="text-align: center;">␋</td> 36661 </tr> 36662 <tr class="odd"> 36663 <td>FF</td> 36664 <td style="text-align: center;">0x0C</td> 36665 <td style="text-align: center;">␌</td> 36666 </tr> 36667 <tr class="even"> 36668 <td>CR</td> 36669 <td style="text-align: center;">0x0D</td> 36670 <td style="text-align: center;">␍</td> 36671 </tr> 36672 <tr class="odd"> 36673 <td>SO</td> 36674 <td style="text-align: center;">0x0E</td> 36675 <td style="text-align: center;">␎</td> 36676 </tr> 36677 <tr class="even"> 36678 <td>SI</td> 36679 <td style="text-align: center;">0x0F</td> 36680 <td style="text-align: center;">␏</td> 36681 </tr> 36682 <tr class="odd"> 36683 <td>DLE</td> 36684 <td style="text-align: center;">0x10</td> 36685 <td style="text-align: center;">␐</td> 36686 </tr> 36687 <tr class="even"> 36688 <td>DC1</td> 36689 <td style="text-align: center;">0x11</td> 36690 <td style="text-align: center;">␑</td> 36691 </tr> 36692 <tr class="odd"> 36693 <td>DC2</td> 36694 <td style="text-align: center;">0x12</td> 36695 <td style="text-align: center;">␒</td> 36696 </tr> 36697 <tr class="even"> 36698 <td>DC3</td> 36699 <td style="text-align: center;">0x13</td> 36700 <td style="text-align: center;">␓</td> 36701 </tr> 36702 <tr class="odd"> 36703 <td>DC4</td> 36704 <td style="text-align: center;">0x14</td> 36705 <td style="text-align: center;">␔</td> 36706 </tr> 36707 <tr class="even"> 36708 <td>NAK</td> 36709 <td style="text-align: center;">0x15</td> 36710 <td style="text-align: center;">␕</td> 36711 </tr> 36712 <tr class="odd"> 36713 <td>SYN</td> 36714 <td style="text-align: center;">0x16</td> 36715 <td style="text-align: center;">␖</td> 36716 </tr> 36717 <tr class="even"> 36718 <td>ETB</td> 36719 <td style="text-align: center;">0x17</td> 36720 <td style="text-align: center;">␗</td> 36721 </tr> 36722 <tr class="odd"> 36723 <td>CAN</td> 36724 <td style="text-align: center;">0x18</td> 36725 <td style="text-align: center;">␘</td> 36726 </tr> 36727 <tr class="even"> 36728 <td>EM</td> 36729 <td style="text-align: center;">0x19</td> 36730 <td style="text-align: center;">␙</td> 36731 </tr> 36732 <tr class="odd"> 36733 <td>SUB</td> 36734 <td style="text-align: center;">0x1A</td> 36735 <td style="text-align: center;">␚</td> 36736 </tr> 36737 <tr class="even"> 36738 <td>ESC</td> 36739 <td style="text-align: center;">0x1B</td> 36740 <td style="text-align: center;">␛</td> 36741 </tr> 36742 <tr class="odd"> 36743 <td>FS</td> 36744 <td style="text-align: center;">0x1C</td> 36745 <td style="text-align: center;">␜</td> 36746 </tr> 36747 <tr class="even"> 36748 <td>GS</td> 36749 <td style="text-align: center;">0x1D</td> 36750 <td style="text-align: center;">␝</td> 36751 </tr> 36752 <tr class="odd"> 36753 <td>RS</td> 36754 <td style="text-align: center;">0x1E</td> 36755 <td style="text-align: center;">␞</td> 36756 </tr> 36757 <tr class="even"> 36758 <td>US</td> 36759 <td style="text-align: center;">0x1F</td> 36760 <td style="text-align: center;">␟</td> 36761 </tr> 36762 <tr class="odd"> 36763 <td>/</td> 36764 <td style="text-align: center;">0x2F</td> 36765 <td style="text-align: center;">／</td> 36766 </tr> 36767 <tr class="even"> 36768 <td>"</td> 36769 <td style="text-align: center;">0x22</td> 36770 <td style="text-align: center;">＂</td> 36771 </tr> 36772 <tr class="odd"> 36773 <td>*</td> 36774 <td style="text-align: center;">0x2A</td> 36775 <td style="text-align: center;">＊</td> 36776 </tr> 36777 <tr class="even"> 36778 <td>:</td> 36779 <td style="text-align: center;">0x3A</td> 36780 <td style="text-align: center;">：</td> 36781 </tr> 36782 <tr class="odd"> 36783 <td><</td> 36784 <td style="text-align: center;">0x3C</td> 36785 <td style="text-align: center;">＜</td> 36786 </tr> 36787 <tr class="even"> 36788 <td>></td> 36789 <td style="text-align: center;">0x3E</td> 36790 <td style="text-align: center;">＞</td> 36791 </tr> 36792 <tr class="odd"> 36793 <td>?</td> 36794 <td style="text-align: center;">0x3F</td> 36795 <td style="text-align: center;">？</td> 36796 </tr> 36797 <tr class="even"> 36798 <td>\</td> 36799 <td style="text-align: center;">0x5C</td> 36800 <td style="text-align: center;">＼</td> 36801 </tr> 36802 <tr class="odd"> 36803 <td>|</td> 36804 <td style="text-align: center;">0x7C</td> 36805 <td style="text-align: center;">｜</td> 36806 </tr> 36807 </tbody> 36808 </table> 36809 <p>File names on Windows can also not end with the following characters. These only get replaced if they are the last character in the name:</p> 36810 <table> 36811 <thead> 36812 <tr class="header"> 36813 <th>Character</th> 36814 <th style="text-align: center;">Value</th> 36815 <th style="text-align: center;">Replacement</th> 36816 </tr> 36817 </thead> 36818 <tbody> 36819 <tr class="odd"> 36820 <td>SP</td> 36821 <td style="text-align: center;">0x20</td> 36822 <td style="text-align: center;">␠</td> 36823 </tr> 36824 <tr class="even"> 36825 <td>.</td> 36826 <td style="text-align: center;">0x2E</td> 36827 <td style="text-align: center;">．</td> 36828 </tr> 36829 </tbody> 36830 </table> 36831 <p>Invalid UTF-8 bytes will also be <a href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they can't be converted to UTF-16.</p> 36832 <h3 id="paths-on-windows">Paths on Windows</h3> 36833 <p>On Windows there are many ways of specifying a path to a file system resource. Local paths can be absolute, like <code>C:\path\to\wherever</code>, or relative, like <code>..\wherever</code>. Network paths in UNC format, <code>\\server\share</code>, are also supported. Path separator can be either <code>\</code> (as in <code>C:\path\to\wherever</code>) or <code>/</code> (as in <code>C:/path/to/wherever</code>). Length of these paths are limited to 259 characters for files and 247 characters for directories, but there is an alternative extended-length path format increasing the limit to (approximately) 32,767 characters. This format requires absolute paths and the use of prefix <code>\\?\</code>, e.g. <code>\\?\D:\some\very\long\path</code>. For convenience rclone will automatically convert regular paths into the corresponding extended-length paths, so in most cases you do not have to worry about this (read more <a href="#long-paths">below</a>).</p> 36834 <p>Note that Windows supports using the same prefix <code>\\?\</code> to specify path to volumes identified by their GUID, e.g. <code>\\?\Volume{b75e2c83-0000-0000-0000-602f00000000}\some\path</code>. This is <em>not</em> supported in rclone, due to an <a href="https://github.com/golang/go/issues/39785">issue</a> in go.</p> 36835 <h4 id="long-paths">Long paths</h4> 36836 <p>Rclone handles long paths automatically, by converting all paths to <a href="https://docs.microsoft.com/en-us/windows/win32/fileio/maximum-file-path-limitation">extended-length path format</a>, which allows paths up to 32,767 characters.</p> 36837 <p>This conversion will ensure paths are absolute and prefix them with the <code>\\?\</code>. This is why you will see that your paths, for instance <code>.\files</code> is shown as path <code>\\?\C:\files</code> in the output, and <code>\\server\share</code> as <code>\\?\UNC\server\share</code>.</p> 36838 <p>However, in rare cases this may cause problems with buggy file system drivers like <a href="https://github.com/rclone/rclone/issues/261">EncFS</a>. To disable UNC conversion globally, add this to your <code>.rclone.conf</code> file:</p> 36839 <pre><code>[local] 36840 nounc = true</code></pre> 36841 <p>If you want to selectively disable UNC, you can add it to a separate entry like this:</p> 36842 <pre><code>[nounc] 36843 type = local 36844 nounc = true</code></pre> 36845 <p>And use rclone like this:</p> 36846 <p><code>rclone copy c:\src nounc:z:\dst</code></p> 36847 <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 259 characters on z, so only use this option if you have to.</p> 36848 <h3 id="symlinks-junction-points">Symlinks / Junction points</h3> 36849 <p>Normally rclone will ignore symlinks or junction points (which behave like symlinks under Windows).</p> 36850 <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> 36851 <p>This flag applies to all commands.</p> 36852 <p>For example, supposing you have a directory structure like this</p> 36853 <pre><code>$ tree /tmp/a 36854 /tmp/a 36855 ├── b -> ../b 36856 ├── expected -> ../expected 36857 ├── one 36858 └── two 36859 └── three</code></pre> 36860 <p>Then you can see the difference with and without the flag like this</p> 36861 <pre><code>$ rclone ls /tmp/a 36862 6 one 36863 6 two/three</code></pre> 36864 <p>and</p> 36865 <pre><code>$ rclone -L ls /tmp/a 36866 4174 expected 36867 6 one 36868 6 two/three 36869 6 b/two 36870 6 b/one</code></pre> 36871 <h4 id="links--l">--links, -l</h4> 36872 <p>Normally rclone will ignore symlinks or junction points (which behave like symlinks under Windows).</p> 36873 <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> 36874 <p>The text file will contain the target of the symbolic link (see example).</p> 36875 <p>This flag applies to all commands.</p> 36876 <p>For example, supposing you have a directory structure like this</p> 36877 <pre><code>$ tree /tmp/a 36878 /tmp/a 36879 ├── file1 -> ./file4 36880 └── file2 -> /home/user/file3</code></pre> 36881 <p>Copying the entire directory with '-l'</p> 36882 <pre><code>$ rclone copyto -l /tmp/a/file1 remote:/tmp/a/</code></pre> 36883 <p>The remote files are created with a '.rclonelink' suffix</p> 36884 <pre><code>$ rclone ls remote:/tmp/a 36885 5 file1.rclonelink 36886 14 file2.rclonelink</code></pre> 36887 <p>The remote files will contain the target of the symbolic links</p> 36888 <pre><code>$ rclone cat remote:/tmp/a/file1.rclonelink 36889 ./file4 36890 36891 $ rclone cat remote:/tmp/a/file2.rclonelink 36892 /home/user/file3</code></pre> 36893 <p>Copying them back with '-l'</p> 36894 <pre><code>$ rclone copyto -l remote:/tmp/a/ /tmp/b/ 36895 36896 $ tree /tmp/b 36897 /tmp/b 36898 ├── file1 -> ./file4 36899 └── file2 -> /home/user/file3</code></pre> 36900 <p>However, if copied back without '-l'</p> 36901 <pre><code>$ rclone copyto remote:/tmp/a/ /tmp/b/ 36902 36903 $ tree /tmp/b 36904 /tmp/b 36905 ├── file1.rclonelink 36906 └── file2.rclonelink</code></pre> 36907 <p>Note that this flag is incompatible with <code>-copy-links</code> / <code>-L</code>.</p> 36908 <h3 id="restricting-filesystems-with---one-file-system">Restricting filesystems with --one-file-system</h3> 36909 <p>Normally rclone will recurse through filesystems as mounted.</p> 36910 <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> 36911 <p>For example if you have a directory hierarchy like this</p> 36912 <pre><code>root 36913 ├── disk1 - disk1 mounted on the root 36914 │ └── file3 - stored on disk1 36915 ├── disk2 - disk2 mounted on the root 36916 │ └── file4 - stored on disk12 36917 ├── file1 - stored on the root disk 36918 └── file2 - stored on the root disk</code></pre> 36919 <p>Using <code>rclone --one-file-system copy root remote:</code> will only copy <code>file1</code> and <code>file2</code>. Eg</p> 36920 <pre><code>$ rclone -q --one-file-system ls root 36921 0 file1 36922 0 file2</code></pre> 36923 <pre><code>$ rclone -q ls root 36924 0 disk1/file3 36925 0 disk2/file4 36926 0 file1 36927 0 file2</code></pre> 36928 <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> 36929 <p><strong>NB</strong> This flag is only available on Unix based systems. On systems where it isn't supported (e.g. Windows) it will be ignored.</p> 36930 <h3 id="advanced-options-25">Advanced options</h3> 36931 <p>Here are the Advanced options specific to local (Local Disk).</p> 36932 <h4 id="local-nounc">--local-nounc</h4> 36933 <p>Disable UNC (long path names) conversion on Windows.</p> 36934 <p>Properties:</p> 36935 <ul> 36936 <li>Config: nounc</li> 36937 <li>Env Var: RCLONE_LOCAL_NOUNC</li> 36938 <li>Type: bool</li> 36939 <li>Default: false</li> 36940 <li>Examples: 36941 <ul> 36942 <li>"true" 36943 <ul> 36944 <li>Disables long file names.</li> 36945 </ul></li> 36946 </ul></li> 36947 </ul> 36948 <h4 id="copy-links--l">--copy-links / -L</h4> 36949 <p>Follow symlinks and copy the pointed to item.</p> 36950 <p>Properties:</p> 36951 <ul> 36952 <li>Config: copy_links</li> 36953 <li>Env Var: RCLONE_LOCAL_COPY_LINKS</li> 36954 <li>Type: bool</li> 36955 <li>Default: false</li> 36956 </ul> 36957 <h4 id="links--l-1">--links / -l</h4> 36958 <p>Translate symlinks to/from regular files with a '.rclonelink' extension.</p> 36959 <p>Properties:</p> 36960 <ul> 36961 <li>Config: links</li> 36962 <li>Env Var: RCLONE_LOCAL_LINKS</li> 36963 <li>Type: bool</li> 36964 <li>Default: false</li> 36965 </ul> 36966 <h4 id="skip-links">--skip-links</h4> 36967 <p>Don't warn about skipped symlinks.</p> 36968 <p>This flag disables warning messages on skipped symlinks or junction points, as you explicitly acknowledge that they should be skipped.</p> 36969 <p>Properties:</p> 36970 <ul> 36971 <li>Config: skip_links</li> 36972 <li>Env Var: RCLONE_LOCAL_SKIP_LINKS</li> 36973 <li>Type: bool</li> 36974 <li>Default: false</li> 36975 </ul> 36976 <h4 id="local-zero-size-links">--local-zero-size-links</h4> 36977 <p>Assume the Stat size of links is zero (and read them instead) (deprecated).</p> 36978 <p>Rclone used to use the Stat size of links as the link size, but this fails in quite a few places:</p> 36979 <ul> 36980 <li>Windows</li> 36981 <li>On some virtual filesystems (such ash LucidLink)</li> 36982 <li>Android</li> 36983 </ul> 36984 <p>So rclone now always reads the link.</p> 36985 <p>Properties:</p> 36986 <ul> 36987 <li>Config: zero_size_links</li> 36988 <li>Env Var: RCLONE_LOCAL_ZERO_SIZE_LINKS</li> 36989 <li>Type: bool</li> 36990 <li>Default: false</li> 36991 </ul> 36992 <h4 id="local-unicode-normalization">--local-unicode-normalization</h4> 36993 <p>Apply unicode NFC normalization to paths and filenames.</p> 36994 <p>This flag can be used to normalize file names into unicode NFC form that are read from the local filesystem.</p> 36995 <p>Rclone does not normally touch the encoding of file names it reads from the file system.</p> 36996 <p>This can be useful when using macOS as it normally provides decomposed (NFD) unicode which in some language (eg Korean) doesn't display properly on some OSes.</p> 36997 <p>Note that rclone compares filenames with unicode normalization in the sync routine so this flag shouldn't normally be used.</p> 36998 <p>Properties:</p> 36999 <ul> 37000 <li>Config: unicode_normalization</li> 37001 <li>Env Var: RCLONE_LOCAL_UNICODE_NORMALIZATION</li> 37002 <li>Type: bool</li> 37003 <li>Default: false</li> 37004 </ul> 37005 <h4 id="local-no-check-updated">--local-no-check-updated</h4> 37006 <p>Don't check to see if the files change during upload.</p> 37007 <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> 37008 <p>However on some file systems this modification time check may fail (e.g. <a href="https://github.com/rclone/rclone/issues/2206">Glusterfs #2206</a>) so this check can be disabled with this flag.</p> 37009 <p>If this flag is set, rclone will use its best efforts to transfer a file which is being updated. If the file is only having things appended to it (e.g. a log) then rclone will transfer the log file with the size it had the first time rclone saw it.</p> 37010 <p>If the file is being modified throughout (not just appended to) then the transfer may fail with a hash check failure.</p> 37011 <p>In detail, once the file has had stat() called on it for the first time we:</p> 37012 <ul> 37013 <li>Only transfer the size that stat gave</li> 37014 <li>Only checksum the size that stat gave</li> 37015 <li>Don't update the stat info for the file</li> 37016 </ul> 37017 <p><strong>NB</strong> do not use this flag on a Windows Volume Shadow (VSS). For some unknown reason, files in a VSS sometimes show different sizes from the directory listing (where the initial stat value comes from on Windows) and when stat is called on them directly. Other copy tools always use the direct stat value and setting this flag will disable that.</p> 37018 <p>Properties:</p> 37019 <ul> 37020 <li>Config: no_check_updated</li> 37021 <li>Env Var: RCLONE_LOCAL_NO_CHECK_UPDATED</li> 37022 <li>Type: bool</li> 37023 <li>Default: false</li> 37024 </ul> 37025 <h4 id="one-file-system--x">--one-file-system / -x</h4> 37026 <p>Don't cross filesystem boundaries (unix/macOS only).</p> 37027 <p>Properties:</p> 37028 <ul> 37029 <li>Config: one_file_system</li> 37030 <li>Env Var: RCLONE_LOCAL_ONE_FILE_SYSTEM</li> 37031 <li>Type: bool</li> 37032 <li>Default: false</li> 37033 </ul> 37034 <h4 id="local-case-sensitive">--local-case-sensitive</h4> 37035 <p>Force the filesystem to report itself as case sensitive.</p> 37036 <p>Normally the local backend declares itself as case insensitive on Windows/macOS and case sensitive for everything else. Use this flag to override the default choice.</p> 37037 <p>Properties:</p> 37038 <ul> 37039 <li>Config: case_sensitive</li> 37040 <li>Env Var: RCLONE_LOCAL_CASE_SENSITIVE</li> 37041 <li>Type: bool</li> 37042 <li>Default: false</li> 37043 </ul> 37044 <h4 id="local-case-insensitive">--local-case-insensitive</h4> 37045 <p>Force the filesystem to report itself as case insensitive.</p> 37046 <p>Normally the local backend declares itself as case insensitive on Windows/macOS and case sensitive for everything else. Use this flag to override the default choice.</p> 37047 <p>Properties:</p> 37048 <ul> 37049 <li>Config: case_insensitive</li> 37050 <li>Env Var: RCLONE_LOCAL_CASE_INSENSITIVE</li> 37051 <li>Type: bool</li> 37052 <li>Default: false</li> 37053 </ul> 37054 <h4 id="local-no-preallocate">--local-no-preallocate</h4> 37055 <p>Disable preallocation of disk space for transferred files.</p> 37056 <p>Preallocation of disk space helps prevent filesystem fragmentation. However, some virtual filesystem layers (such as Google Drive File Stream) may incorrectly set the actual file size equal to the preallocated space, causing checksum and file size checks to fail. Use this flag to disable preallocation.</p> 37057 <p>Properties:</p> 37058 <ul> 37059 <li>Config: no_preallocate</li> 37060 <li>Env Var: RCLONE_LOCAL_NO_PREALLOCATE</li> 37061 <li>Type: bool</li> 37062 <li>Default: false</li> 37063 </ul> 37064 <h4 id="local-no-sparse">--local-no-sparse</h4> 37065 <p>Disable sparse files for multi-thread downloads.</p> 37066 <p>On Windows platforms rclone will make sparse files when doing multi-thread downloads. This avoids long pauses on large files where the OS zeros the file. However sparse files may be undesirable as they cause disk fragmentation and can be slow to work with.</p> 37067 <p>Properties:</p> 37068 <ul> 37069 <li>Config: no_sparse</li> 37070 <li>Env Var: RCLONE_LOCAL_NO_SPARSE</li> 37071 <li>Type: bool</li> 37072 <li>Default: false</li> 37073 </ul> 37074 <h4 id="local-no-set-modtime">--local-no-set-modtime</h4> 37075 <p>Disable setting modtime.</p> 37076 <p>Normally rclone updates modification time of files after they are done uploading. This can cause permissions issues on Linux platforms when the user rclone is running as does not own the file uploaded, such as when copying to a CIFS mount owned by another user. If this option is enabled, rclone will no longer update the modtime after copying a file.</p> 37077 <p>Properties:</p> 37078 <ul> 37079 <li>Config: no_set_modtime</li> 37080 <li>Env Var: RCLONE_LOCAL_NO_SET_MODTIME</li> 37081 <li>Type: bool</li> 37082 <li>Default: false</li> 37083 </ul> 37084 <h4 id="local-encoding">--local-encoding</h4> 37085 <p>The encoding for the backend.</p> 37086 <p>See the <a href="https://rclone.org/overview/#encoding">encoding section in the overview</a> for more info.</p> 37087 <p>Properties:</p> 37088 <ul> 37089 <li>Config: encoding</li> 37090 <li>Env Var: RCLONE_LOCAL_ENCODING</li> 37091 <li>Type: Encoding</li> 37092 <li>Default: Slash,Dot</li> 37093 </ul> 37094 <h4 id="local-description">--local-description</h4> 37095 <p>Description of the remote</p> 37096 <p>Properties:</p> 37097 <ul> 37098 <li>Config: description</li> 37099 <li>Env Var: RCLONE_LOCAL_DESCRIPTION</li> 37100 <li>Type: string</li> 37101 <li>Required: false</li> 37102 </ul> 37103 <h3 id="metadata-5">Metadata</h3> 37104 <p>Depending on which OS is in use the local backend may return only some of the system metadata. Setting system metadata is supported on all OSes but setting user metadata is only supported on linux, freebsd, netbsd, macOS and Solaris. It is <strong>not</strong> supported on Windows yet (<a href="https://github.com/pkg/xattr/issues/47">see pkg/attrs#47</a>).</p> 37105 <p>User metadata is stored as extended attributes (which may not be supported by all file systems) under the "user.*" prefix.</p> 37106 <p>Metadata is supported on files and directories.</p> 37107 <p>Here are the possible system metadata items for the local backend.</p> 37108 <table> 37109 <colgroup> 37110 <col style="width: 15%" /> 37111 <col style="width: 15%" /> 37112 <col style="width: 15%" /> 37113 <col style="width: 23%" /> 37114 <col style="width: 28%" /> 37115 </colgroup> 37116 <thead> 37117 <tr class="header"> 37118 <th>Name</th> 37119 <th>Help</th> 37120 <th>Type</th> 37121 <th>Example</th> 37122 <th>Read Only</th> 37123 </tr> 37124 </thead> 37125 <tbody> 37126 <tr class="odd"> 37127 <td>atime</td> 37128 <td>Time of last access</td> 37129 <td>RFC 3339</td> 37130 <td>2006-01-02T15:04:05.999999999Z07:00</td> 37131 <td>N</td> 37132 </tr> 37133 <tr class="even"> 37134 <td>btime</td> 37135 <td>Time of file birth (creation)</td> 37136 <td>RFC 3339</td> 37137 <td>2006-01-02T15:04:05.999999999Z07:00</td> 37138 <td>N</td> 37139 </tr> 37140 <tr class="odd"> 37141 <td>gid</td> 37142 <td>Group ID of owner</td> 37143 <td>decimal number</td> 37144 <td>500</td> 37145 <td>N</td> 37146 </tr> 37147 <tr class="even"> 37148 <td>mode</td> 37149 <td>File type and mode</td> 37150 <td>octal, unix style</td> 37151 <td>0100664</td> 37152 <td>N</td> 37153 </tr> 37154 <tr class="odd"> 37155 <td>mtime</td> 37156 <td>Time of last modification</td> 37157 <td>RFC 3339</td> 37158 <td>2006-01-02T15:04:05.999999999Z07:00</td> 37159 <td>N</td> 37160 </tr> 37161 <tr class="even"> 37162 <td>rdev</td> 37163 <td>Device ID (if special file)</td> 37164 <td>hexadecimal</td> 37165 <td>1abc</td> 37166 <td>N</td> 37167 </tr> 37168 <tr class="odd"> 37169 <td>uid</td> 37170 <td>User ID of owner</td> 37171 <td>decimal number</td> 37172 <td>500</td> 37173 <td>N</td> 37174 </tr> 37175 </tbody> 37176 </table> 37177 <p>See the <a href="https://rclone.org/docs/#metadata">metadata</a> docs for more info.</p> 37178 <h2 id="backend-commands-3">Backend commands</h2> 37179 <p>Here are the commands specific to the local backend.</p> 37180 <p>Run them with</p> 37181 <pre><code>rclone backend COMMAND remote:</code></pre> 37182 <p>The help below will explain what arguments each command takes.</p> 37183 <p>See the <a href="https://rclone.org/commands/rclone_backend/">backend</a> command for more info on how to pass options and arguments.</p> 37184 <p>These can be run on a running backend using the rc command <a href="https://rclone.org/rc/#backend-command">backend/command</a>.</p> 37185 <h3 id="noop">noop</h3> 37186 <p>A null operation for testing backend commands</p> 37187 <pre><code>rclone backend noop remote: [options] [<arguments>+]</code></pre> 37188 <p>This is a test command which has some options you can try to change the output.</p> 37189 <p>Options:</p> 37190 <ul> 37191 <li>"echo": echo the input arguments</li> 37192 <li>"error": return an error based on option value</li> 37193 </ul> 37194 <h1 id="changelog-1">Changelog</h1> 37195 <h2 id="v1.66.0---2024-03-10">v1.66.0 - 2024-03-10</h2> 37196 <p><a href="https://github.com/rclone/rclone/compare/v1.65.0...v1.66.0">See commits</a></p> 37197 <ul> 37198 <li>Major features 37199 <ul> 37200 <li>Rclone will now sync directory modification times if the backend supports it. 37201 <ul> 37202 <li>This can be disabled with <a href="https://rclone.org/docs/#no-update-dir-modtime">--no-update-dir-modtime</a></li> 37203 <li>See <a href="https://rclone.org/overview/#features">the overview</a> and look for the <code>D</code> flags in the <code>ModTime</code> column to see which backends support it.</li> 37204 </ul></li> 37205 <li>Rclone will now sync directory metadata if the backend supports it when <code>-M</code>/<code>--metadata</code> is in use. 37206 <ul> 37207 <li>See <a href="https://rclone.org/overview/#features">the overview</a> and look for the <code>D</code> flags in the <code>Metadata</code> column to see which backends support it.</li> 37208 </ul></li> 37209 <li>Bisync has received many updates see below for more details or <a href="https://rclone.org/bisync/#changelog">bisync's changelog</a></li> 37210 </ul></li> 37211 <li>Removed backends 37212 <ul> 37213 <li>amazonclouddrive: Remove Amazon Drive backend code and docs (Nick Craig-Wood)</li> 37214 </ul></li> 37215 <li>New Features 37216 <ul> 37217 <li>backend 37218 <ul> 37219 <li>Add description field for all backends (Paul Stern)</li> 37220 </ul></li> 37221 <li>build 37222 <ul> 37223 <li>Update to go1.22 and make go1.20 the minimum required version (Nick Craig-Wood)</li> 37224 <li>Fix <code>CVE-2024-24786</code> by upgrading <code>google.golang.org/protobuf</code> (Nick Craig-Wood)</li> 37225 </ul></li> 37226 <li>check: Respect <code>--no-unicode-normalization</code> and <code>--ignore-case-sync</code> for <code>--checkfile</code> (nielash)</li> 37227 <li>cmd: Much improved shell auto completion which reduces the size of the completion file and works faster (Nick Craig-Wood)</li> 37228 <li>doc updates (albertony, ben-ba, Eli, emyarod, huajin tong, Jack Provance, kapitainsky, keongalvin, Nick Craig-Wood, nielash, rarspace01, rzitzer, Tera, Vincent Murphy)</li> 37229 <li>fs: Add more detailed logging for file includes/excludes (Kyle Reynolds)</li> 37230 <li>lsf 37231 <ul> 37232 <li>Add <code>--time-format</code> flag (nielash)</li> 37233 <li>Make metadata appear for directories (Nick Craig-Wood)</li> 37234 </ul></li> 37235 <li>lsjson: Make metadata appear for directories (Nick Craig-Wood)</li> 37236 <li>rc 37237 <ul> 37238 <li>Add <code>srcFs</code> and <code>dstFs</code> to <code>core/stats</code> and <code>core/transferred</code> stats (Nick Craig-Wood)</li> 37239 <li>Add <code>operations/hashsum</code> to the rc as <code>rclone hashsum</code> equivalent (Nick Craig-Wood)</li> 37240 <li>Add <code>config/paths</code> to the rc as <code>rclone config paths</code> equivalent (Nick Craig-Wood)</li> 37241 </ul></li> 37242 <li>sync 37243 <ul> 37244 <li>Optionally report list of synced paths to file (nielash)</li> 37245 <li>Implement directory sync for mod times and metadata (Nick Craig-Wood)</li> 37246 <li>Don't set directory modtimes if already set (nielash)</li> 37247 <li>Don't sync directory modtimes from backends which don't have directories (Nick Craig-Wood)</li> 37248 </ul></li> 37249 </ul></li> 37250 <li>Bug Fixes 37251 <ul> 37252 <li>backend 37253 <ul> 37254 <li>Make backends which use oauth implement the <code>Shutdown</code> and shutdown the oauth properly (rkonfj)</li> 37255 </ul></li> 37256 <li>bisync 37257 <ul> 37258 <li>Handle unicode and case normalization consistently (nielash)</li> 37259 <li>Partial uploads known issue on <code>local</code>/<code>ftp</code>/<code>sftp</code> has been resolved (unless using <code>--inplace</code>) (nielash)</li> 37260 <li>Fixed handling of unicode normalization and case insensitivity, support for <a href="https://rclone.org/docs/#fix-case"><code>--fix-case</code></a>, <a href="/docs/#ignore-case-sync"><code>--ignore-case-sync</code></a>, <a href="/docs/#no-unicode-normalization"><code>--no-unicode-normalization</code></a> (nielash)</li> 37261 <li>Bisync no longer fails to find the correct listing file when configs are overridden with backend-specific flags. (nielash)</li> 37262 </ul></li> 37263 <li>nfsmount 37264 <ul> 37265 <li>Fix exit after external unmount (nielash)</li> 37266 <li>Fix <code>--volname</code> being ignored (nielash)</li> 37267 </ul></li> 37268 <li>operations 37269 <ul> 37270 <li>Fix renaming a file on macOS (nielash)</li> 37271 <li>Fix case-insensitive moves in operations.Move (nielash)</li> 37272 <li>Fix TestCaseInsensitiveMoveFileDryRun on chunker integration tests (nielash)</li> 37273 <li>Fix TestMkdirModTime test (Nick Craig-Wood)</li> 37274 <li>Fix TestSetDirModTime for backends with SetDirModTime but not Metadata (Nick Craig-Wood)</li> 37275 <li>Fix typo in log messages (nielash)</li> 37276 </ul></li> 37277 <li>serve nfs: Fix writing files via Finder on macOS (nielash)</li> 37278 <li>serve restic: Fix error handling (Michael Eischer)</li> 37279 <li>serve webdav: Fix <code>--baseurl</code> without leading / (Nick Craig-Wood)</li> 37280 <li>stats: Fix race between ResetCounters and stopAverageLoop called from time.AfterFunc (Nick Craig-Wood)</li> 37281 <li>sync 37282 <ul> 37283 <li><code>--fix-case</code> flag to rename case insensitive dest (nielash)</li> 37284 <li>Use operations.DirMove instead of sync.MoveDir for <code>--fix-case</code> (nielash)</li> 37285 </ul></li> 37286 <li>systemd: Fix detection and switch to the coreos package everywhere rather than having 2 separate libraries (Anagh Kumar Baranwal)</li> 37287 </ul></li> 37288 <li>Mount 37289 <ul> 37290 <li>Fix macOS not noticing errors with <code>--daemon</code> (Nick Craig-Wood)</li> 37291 <li>Notice daemon dying much quicker (Nick Craig-Wood)</li> 37292 </ul></li> 37293 <li>VFS 37294 <ul> 37295 <li>Fix unicode normalization on macOS (nielash)</li> 37296 </ul></li> 37297 <li>Bisync 37298 <ul> 37299 <li>Copies and deletes are now handled in one operation instead of two (nielash)</li> 37300 <li><code>--track-renames</code> and <code>--backup-dir</code> are now supported (nielash)</li> 37301 <li>Final listings are now generated from sync results, to avoid needing to re-list (nielash)</li> 37302 <li>Bisync is now much more resilient to changes that happen during a bisync run, and far less prone to critical errors / undetected changes (nielash)</li> 37303 <li>Bisync is now capable of rolling a file listing back in cases of uncertainty, essentially marking the file as needing to be rechecked next time. (nielash)</li> 37304 <li>A few basic terminal colors are now supported, controllable with <a href="https://rclone.org/docs/#color-when"><code>--color</code></a> (<code>AUTO</code>|<code>NEVER</code>|<code>ALWAYS</code>) (nielash)</li> 37305 <li>Initial listing snapshots of Path1 and Path2 are now generated concurrently, using the same "march" infrastructure as <code>check</code> and <code>sync</code>, for performance improvements and less risk of error. (nielash)</li> 37306 <li><code>--resync</code> is now much more efficient (especially for users of <code>--create-empty-src-dirs</code>) (nielash)</li> 37307 <li>Google Docs (and other files of unknown size) are now supported (with the same options as in <code>sync</code>) (nielash)</li> 37308 <li>Equality checks before a sync conflict rename now fall back to <code>cryptcheck</code> (when possible) or <code>--download</code>, (nielash) instead of of <code>--size-only</code>, when <code>check</code> is not available.</li> 37309 <li>Bisync now fully supports comparing based on any combination of size, modtime, and checksum, lifting the prior restriction on backends without modtime support. (nielash)</li> 37310 <li>Bisync now supports a "Graceful Shutdown" mode to cleanly cancel a run early without requiring <code>--resync</code>. (nielash)</li> 37311 <li>New <code>--recover</code> flag allows robust recovery in the event of interruptions, without requiring <code>--resync</code>. (nielash)</li> 37312 <li>A new <code>--max-lock</code> setting allows lock files to automatically renew and expire, for better automatic recovery when a run is interrupted. (nielash)</li> 37313 <li>Bisync now supports auto-resolving sync conflicts and customizing rename behavior with new <a href="#conflict-resolve"><code>--conflict-resolve</code></a>, <a href="#conflict-loser"><code>--conflict-loser</code></a>, and <a href="#conflict-suffix"><code>--conflict-suffix</code></a> flags. (nielash)</li> 37314 <li>A new <a href="#resync-mode"><code>--resync-mode</code></a> flag allows more control over which version of a file gets kept during a <code>--resync</code>. (nielash)</li> 37315 <li>Bisync now supports <a href="https://rclone.org/docs/#retries-int"><code>--retries</code></a> and <a href="/docs/#retries-sleep-time"><code>--retries-sleep</code></a> (when <a href="#resilient"><code>--resilient</code></a> is set.) (nielash)</li> 37316 <li>Clarify file operation directions in dry-run logs (Kyle Reynolds)</li> 37317 </ul></li> 37318 <li>Local 37319 <ul> 37320 <li>Fix cleanRootPath on Windows after go1.21.4 stdlib update (nielash)</li> 37321 <li>Implement setting modification time on directories (nielash)</li> 37322 <li>Implement modtime and metadata for directories (Nick Craig-Wood)</li> 37323 <li>Fix setting of btime on directories on Windows (Nick Craig-Wood)</li> 37324 <li>Delete backend implementation of Purge to speed up and make stats (Nick Craig-Wood)</li> 37325 <li>Support metadata setting and mapping on server side Move (Nick Craig-Wood)</li> 37326 </ul></li> 37327 <li>Cache 37328 <ul> 37329 <li>Implement setting modification time on directories (if supported by wrapped remote) (nielash)</li> 37330 <li>Implement setting metadata on directories (Nick Craig-Wood)</li> 37331 </ul></li> 37332 <li>Crypt 37333 <ul> 37334 <li>Implement setting modification time on directories (if supported by wrapped remote) (nielash)</li> 37335 <li>Implement setting metadata on directories (Nick Craig-Wood)</li> 37336 <li>Improve handling of undecryptable file names (nielash)</li> 37337 <li>Add missing error check spotted by linter (Nick Craig-Wood)</li> 37338 </ul></li> 37339 <li>Azure Blob 37340 <ul> 37341 <li>Implement <code>--azureblob-delete-snapshots</code> (Nick Craig-Wood)</li> 37342 </ul></li> 37343 <li>B2 37344 <ul> 37345 <li>Clarify exactly what <code>--b2-download-auth-duration</code> does in the docs (Nick Craig-Wood)</li> 37346 </ul></li> 37347 <li>Chunker 37348 <ul> 37349 <li>Implement setting modification time on directories (if supported by wrapped remote) (nielash)</li> 37350 <li>Implement setting metadata on directories (Nick Craig-Wood)</li> 37351 </ul></li> 37352 <li>Combine 37353 <ul> 37354 <li>Implement setting modification time on directories (if supported by wrapped remote) (nielash)</li> 37355 <li>Implement setting metadata on directories (Nick Craig-Wood)</li> 37356 <li>Fix directory metadata error on upstream root (nielash)</li> 37357 <li>Fix directory move across upstreams (nielash)</li> 37358 </ul></li> 37359 <li>Compress 37360 <ul> 37361 <li>Implement setting modification time on directories (if supported by wrapped remote) (nielash)</li> 37362 <li>Implement setting metadata on directories (Nick Craig-Wood)</li> 37363 </ul></li> 37364 <li>Drive 37365 <ul> 37366 <li>Implement setting modification time on directories (nielash)</li> 37367 <li>Implement modtime and metadata setting for directories (Nick Craig-Wood)</li> 37368 <li>Support metadata setting and mapping on server side Move,Copy (Nick Craig-Wood)</li> 37369 </ul></li> 37370 <li>FTP 37371 <ul> 37372 <li>Fix mkdir with rsftp which is returning the wrong code (Nick Craig-Wood)</li> 37373 </ul></li> 37374 <li>Hasher 37375 <ul> 37376 <li>Implement setting modification time on directories (if supported by wrapped remote) (nielash)</li> 37377 <li>Implement setting metadata on directories (Nick Craig-Wood)</li> 37378 <li>Fix error from trying to stop an already-stopped db (nielash)</li> 37379 <li>Look for cached hash if passed hash unexpectedly blank (nielash)</li> 37380 </ul></li> 37381 <li>Imagekit 37382 <ul> 37383 <li>Updated docs and web content (Harshit Budhraja)</li> 37384 <li>Updated overview - supported operations (Harshit Budhraja)</li> 37385 </ul></li> 37386 <li>Mega 37387 <ul> 37388 <li>Fix panic with go1.22 (Nick Craig-Wood)</li> 37389 </ul></li> 37390 <li>Netstorage 37391 <ul> 37392 <li>Fix Root to return correct directory when pointing to a file (Nick Craig-Wood)</li> 37393 </ul></li> 37394 <li>Onedrive 37395 <ul> 37396 <li>Add metadata support (nielash)</li> 37397 </ul></li> 37398 <li>Opendrive 37399 <ul> 37400 <li>Fix moving file/folder within the same parent dir (nielash)</li> 37401 </ul></li> 37402 <li>Oracle Object Storage 37403 <ul> 37404 <li>Support <code>backend restore</code> command (Nikhil Ahuja)</li> 37405 <li>Support workload identity authentication for OKE (Anders Swanson)</li> 37406 </ul></li> 37407 <li>Protondrive 37408 <ul> 37409 <li>Fix encoding of Root method (Nick Craig-Wood)</li> 37410 </ul></li> 37411 <li>Quatrix 37412 <ul> 37413 <li>Fix <code>Content-Range</code> header (Volodymyr)</li> 37414 <li>Add option to skip project folders (Oksana Zhykina)</li> 37415 <li>Fix Root to return correct directory when pointing to a file (Nick Craig-Wood)</li> 37416 </ul></li> 37417 <li>S3 37418 <ul> 37419 <li>Add <code>--s3-version-deleted</code> to show delete markers in listings when using versions. (Nick Craig-Wood)</li> 37420 <li>Add IPv6 support with option <code>--s3-use-dual-stack</code> (Anthony Metzidis)</li> 37421 <li>Copy parts in parallel when doing chunked server side copy (Nick Craig-Wood)</li> 37422 <li>GCS provider: fix server side copy of files bigger than 5G (Nick Craig-Wood)</li> 37423 <li>Support metadata setting and mapping on server side Copy (Nick Craig-Wood)</li> 37424 </ul></li> 37425 <li>Seafile 37426 <ul> 37427 <li>Fix download/upload error when <code>FILE_SERVER_ROOT</code> is relative (DanielEgbers)</li> 37428 <li>Fix Root to return correct directory when pointing to a file (Nick Craig-Wood)</li> 37429 </ul></li> 37430 <li>SFTP 37431 <ul> 37432 <li>Implement setting modification time on directories (nielash)</li> 37433 <li>Set directory modtimes update on write flag (Nick Craig-Wood)</li> 37434 <li>Shorten wait delay for external ssh binaries now that we are using go1.20 (Nick Craig-Wood)</li> 37435 </ul></li> 37436 <li>Swift 37437 <ul> 37438 <li>Avoid unnecessary container versioning check (Joe Cai)</li> 37439 </ul></li> 37440 <li>Union 37441 <ul> 37442 <li>Implement setting modification time on directories (if supported by wrapped remote) (nielash)</li> 37443 <li>Implement setting metadata on directories (Nick Craig-Wood)</li> 37444 </ul></li> 37445 <li>WebDAV 37446 <ul> 37447 <li>Reduce priority of chunks upload log (Gabriel Ramos)</li> 37448 <li>owncloud: Add config <code>owncloud_exclude_shares</code> which allows to exclude shared files and folders when listing remote resources (Thomas Müller)</li> 37449 </ul></li> 37450 </ul> 37451 <h2 id="v1.65.2---2024-01-24">v1.65.2 - 2024-01-24</h2> 37452 <p><a href="https://github.com/rclone/rclone/compare/v1.65.1...v1.65.2">See commits</a></p> 37453 <ul> 37454 <li>Bug Fixes 37455 <ul> 37456 <li>build: bump github.com/cloudflare/circl from 1.3.6 to 1.3.7 (dependabot)</li> 37457 <li>docs updates (Nick Craig-Wood, kapitainsky, nielash, Tera, Harshit Budhraja)</li> 37458 </ul></li> 37459 <li>VFS 37460 <ul> 37461 <li>Fix stale data when using <code>--vfs-cache-mode</code> full (Nick Craig-Wood)</li> 37462 </ul></li> 37463 <li>Azure Blob 37464 <ul> 37465 <li><strong>IMPORTANT</strong> Fix data corruption bug - see <a href="https://github.com/rclone/rclone/issues/7590">#7590</a> (Nick Craig-Wood)</li> 37466 </ul></li> 37467 </ul> 37468 <h2 id="v1.65.1---2024-01-08">v1.65.1 - 2024-01-08</h2> 37469 <p><a href="https://github.com/rclone/rclone/compare/v1.65.0...v1.65.1">See commits</a></p> 37470 <ul> 37471 <li>Bug Fixes 37472 <ul> 37473 <li>build 37474 <ul> 37475 <li>Bump golang.org/x/crypto to fix ssh terrapin CVE-2023-48795 (dependabot)</li> 37476 <li>Update to go1.21.5 to fix Windows path problems (Nick Craig-Wood)</li> 37477 <li>Fix docker build on arm/v6 (Nick Craig-Wood)</li> 37478 </ul></li> 37479 <li>install.sh: fix harmless error message on install (Nick Craig-Wood)</li> 37480 <li>accounting: fix stats to show server side transfers (Nick Craig-Wood)</li> 37481 <li>doc fixes (albertony, ben-ba, Eli Orzitzer, emyarod, keongalvin, rarspace01)</li> 37482 <li>nfsmount: Compile for all unix oses, add <code>--sudo</code> and fix error/option handling (Nick Craig-Wood)</li> 37483 <li>operations: Fix files moved by rclone move not being counted as transfers (Nick Craig-Wood)</li> 37484 <li>oauthutil: Avoid panic when <code>*token</code> and <code>*ts.token</code> are the same (rkonfj)</li> 37485 <li>serve s3: Fix listing oddities (Nick Craig-Wood)</li> 37486 </ul></li> 37487 <li>VFS 37488 <ul> 37489 <li>Note that <code>--vfs-refresh</code> runs in the background (Nick Craig-Wood)</li> 37490 </ul></li> 37491 <li>Azurefiles 37492 <ul> 37493 <li>Fix storage base url (Oksana)</li> 37494 </ul></li> 37495 <li>Crypt 37496 <ul> 37497 <li>Fix rclone move a file over itself deleting the file (Nick Craig-Wood)</li> 37498 </ul></li> 37499 <li>Chunker 37500 <ul> 37501 <li>Fix rclone move a file over itself deleting the file (Nick Craig-Wood)</li> 37502 </ul></li> 37503 <li>Compress 37504 <ul> 37505 <li>Fix rclone move a file over itself deleting the file (Nick Craig-Wood)</li> 37506 </ul></li> 37507 <li>Dropbox 37508 <ul> 37509 <li>Fix used space on dropbox team accounts (Nick Craig-Wood)</li> 37510 </ul></li> 37511 <li>FTP 37512 <ul> 37513 <li>Fix multi-thread copy (WeidiDeng)</li> 37514 </ul></li> 37515 <li>Googlephotos 37516 <ul> 37517 <li>Fix nil pointer exception when batch failed (Nick Craig-Wood)</li> 37518 </ul></li> 37519 <li>Hasher 37520 <ul> 37521 <li>Fix rclone move a file over itself deleting the file (Nick Craig-Wood)</li> 37522 <li>Fix invalid memory address error when MaxAge == 0 (nielash)</li> 37523 </ul></li> 37524 <li>Onedrive 37525 <ul> 37526 <li>Fix error listing: unknown object type <code><nil></code> (Nick Craig-Wood)</li> 37527 <li>Fix "unauthenticated: Unauthenticated" errors when uploading (Nick Craig-Wood)</li> 37528 </ul></li> 37529 <li>Oracleobjectstorage 37530 <ul> 37531 <li>Fix object storage endpoint for custom endpoints (Manoj Ghosh)</li> 37532 <li>Multipart copy create bucket if it doesn't exist. (Manoj Ghosh)</li> 37533 </ul></li> 37534 <li>Protondrive 37535 <ul> 37536 <li>Fix CVE-2023-45286 / GHSA-xwh9-gc39-5298 (Nick Craig-Wood)</li> 37537 </ul></li> 37538 <li>S3 37539 <ul> 37540 <li>Fix crash if no UploadId in multipart upload (Nick Craig-Wood)</li> 37541 </ul></li> 37542 <li>Smb 37543 <ul> 37544 <li>Fix shares not listed by updating go-smb2 (halms)</li> 37545 </ul></li> 37546 <li>Union 37547 <ul> 37548 <li>Fix rclone move a file over itself deleting the file (Nick Craig-Wood)</li> 37549 </ul></li> 37550 </ul> 37551 <h2 id="v1.65.0---2023-11-26">v1.65.0 - 2023-11-26</h2> 37552 <p><a href="https://github.com/rclone/rclone/compare/v1.64.0...v1.65.0">See commits</a></p> 37553 <ul> 37554 <li>New backends 37555 <ul> 37556 <li>Azure Files (karan, moongdal, Nick Craig-Wood)</li> 37557 <li>ImageKit (Abhinav Dhiman)</li> 37558 <li>Linkbox (viktor, Nick Craig-Wood)</li> 37559 </ul></li> 37560 <li>New commands 37561 <ul> 37562 <li><code>serve s3</code>: Let rclone act as an S3 compatible server (Mikubill, Artur Neumann, Saw-jan, Nick Craig-Wood)</li> 37563 <li><code>nfsmount</code>: mount command to provide mount mechanism on macOS without FUSE (Saleh Dindar)</li> 37564 <li><code>serve nfs</code>: to serve a remote for use by <code>nfsmount</code> (Saleh Dindar)</li> 37565 </ul></li> 37566 <li>New Features 37567 <ul> 37568 <li>install.sh: Clean up temp files in install script (Jacob Hands)</li> 37569 <li>build 37570 <ul> 37571 <li>Update all dependencies (Nick Craig-Wood)</li> 37572 <li>Refactor version info and icon resource handling on windows (albertony)</li> 37573 </ul></li> 37574 <li>doc updates (albertony, alfish2000, asdffdsazqqq, Dimitri Papadopoulos, Herby Gillot, Joda Stößer, Manoj Ghosh, Nick Craig-Wood)</li> 37575 <li>Implement <code>--metadata-mapper</code> to transform metatadata with a user supplied program (Nick Craig-Wood)</li> 37576 <li>Add <code>ChunkWriterDoesntSeek</code> feature flag and set it for b2 (Nick Craig-Wood)</li> 37577 <li>lib/http: Export basic go string functions for use in <code>--template</code> (Gabriel Espinoza)</li> 37578 <li>makefile: Use POSIX compatible install arguments (Mina Galić)</li> 37579 <li>operations 37580 <ul> 37581 <li>Use less memory when doing multithread uploads (Nick Craig-Wood)</li> 37582 <li>Implement <code>--partial-suffix</code> to control extension of temporary file names (Volodymyr)</li> 37583 </ul></li> 37584 <li>rc 37585 <ul> 37586 <li>Add <code>operations/check</code> to the rc API (Nick Craig-Wood)</li> 37587 <li>Always report an error as JSON (Nick Craig-Wood)</li> 37588 <li>Set <code>Last-Modified</code> header for files served by <code>--rc-serve</code> (Nikita Shoshin)</li> 37589 </ul></li> 37590 <li>size: Dont show duplicate object count when less than 1k (albertony)</li> 37591 </ul></li> 37592 <li>Bug Fixes 37593 <ul> 37594 <li>fshttp: Fix <code>--contimeout</code> being ignored (你知道未来吗)</li> 37595 <li>march: Fix excessive parallelism when using <code>--no-traverse</code> (Nick Craig-Wood)</li> 37596 <li>ncdu: Fix crash when re-entering changed directory after rescan (Nick Craig-Wood)</li> 37597 <li>operations 37598 <ul> 37599 <li>Fix overwrite of destination when multi-thread transfer fails (Nick Craig-Wood)</li> 37600 <li>Fix invalid UTF-8 when truncating file names when not using <code>--inplace</code> (Nick Craig-Wood)</li> 37601 </ul></li> 37602 <li>serve dnla: Fix crash on graceful exit (wuxingzhong)</li> 37603 </ul></li> 37604 <li>Mount 37605 <ul> 37606 <li>Disable mount for freebsd and alias cmount as mount on that platform (Nick Craig-Wood)</li> 37607 </ul></li> 37608 <li>VFS 37609 <ul> 37610 <li>Add <code>--vfs-refresh</code> flag to read all the directories on start (Beyond Meat)</li> 37611 <li>Implement Name() method in WriteFileHandle and ReadFileHandle (Saleh Dindar)</li> 37612 <li>Add go-billy dependency and make sure vfs.Handle implements billy.File (Saleh Dindar)</li> 37613 <li>Error out early if can't upload 0 length file (Nick Craig-Wood)</li> 37614 </ul></li> 37615 <li>Local 37616 <ul> 37617 <li>Fix copying from Windows Volume Shadows (Nick Craig-Wood)</li> 37618 </ul></li> 37619 <li>Azure Blob 37620 <ul> 37621 <li>Add support for cold tier (Ivan Yanitra)</li> 37622 </ul></li> 37623 <li>B2 37624 <ul> 37625 <li>Implement "rclone backend lifecycle" to read and set bucket lifecycles (Nick Craig-Wood)</li> 37626 <li>Implement <code>--b2-lifecycle</code> to control lifecycle when creating buckets (Nick Craig-Wood)</li> 37627 <li>Fix listing all buckets when not needed (Nick Craig-Wood)</li> 37628 <li>Fix multi-thread upload with copyto going to wrong name (Nick Craig-Wood)</li> 37629 <li>Fix server side chunked copy when file size was exactly <code>--b2-copy-cutoff</code> (Nick Craig-Wood)</li> 37630 <li>Fix streaming chunked files an exact multiple of chunk size (Nick Craig-Wood)</li> 37631 </ul></li> 37632 <li>Box 37633 <ul> 37634 <li>Filter more EventIDs when polling (David Sze)</li> 37635 <li>Add more logging for polling (David Sze)</li> 37636 <li>Fix performance problem reading metadata for single files (Nick Craig-Wood)</li> 37637 </ul></li> 37638 <li>Drive 37639 <ul> 37640 <li>Add read/write metadata support (Nick Craig-Wood)</li> 37641 <li>Add support for SHA-1 and SHA-256 checksums (rinsuki)</li> 37642 <li>Add <code>--drive-show-all-gdocs</code> to allow unexportable gdocs to be server side copied (Nick Craig-Wood)</li> 37643 <li>Add a note that <code>--drive-scope</code> accepts comma-separated list of scopes (Keigo Imai)</li> 37644 <li>Fix error updating created time metadata on existing object (Nick Craig-Wood)</li> 37645 <li>Fix integration tests by enabling metadata support from the context (Nick Craig-Wood)</li> 37646 </ul></li> 37647 <li>Dropbox 37648 <ul> 37649 <li>Factor batcher into lib/batcher (Nick Craig-Wood)</li> 37650 <li>Fix missing encoding for rclone purge (Nick Craig-Wood)</li> 37651 </ul></li> 37652 <li>Google Cloud Storage 37653 <ul> 37654 <li>Fix 400 Bad request errors when using multi-thread copy (Nick Craig-Wood)</li> 37655 </ul></li> 37656 <li>Googlephotos 37657 <ul> 37658 <li>Implement batcher for uploads (Nick Craig-Wood)</li> 37659 </ul></li> 37660 <li>Hdfs 37661 <ul> 37662 <li>Added support for list of namenodes in hdfs remote config (Tayo-pasedaRJ)</li> 37663 </ul></li> 37664 <li>HTTP 37665 <ul> 37666 <li>Implement set backend command to update running backend (Nick Craig-Wood)</li> 37667 <li>Enable methods used with WebDAV (Alen Šiljak)</li> 37668 </ul></li> 37669 <li>Jottacloud 37670 <ul> 37671 <li>Add support for reading and writing metadata (albertony)</li> 37672 </ul></li> 37673 <li>Onedrive 37674 <ul> 37675 <li>Implement ListR method which gives <code>--fast-list</code> support (Nick Craig-Wood) 37676 <ul> 37677 <li>This must be enabled with the <code>--onedrive-delta</code> flag</li> 37678 </ul></li> 37679 </ul></li> 37680 <li>Quatrix 37681 <ul> 37682 <li>Add partial upload support (Oksana Zhykina)</li> 37683 <li>Overwrite files on conflict during server-side move (Oksana Zhykina)</li> 37684 </ul></li> 37685 <li>S3 37686 <ul> 37687 <li>Add Linode provider (Nick Craig-Wood)</li> 37688 <li>Add docs on how to add a new provider (Nick Craig-Wood)</li> 37689 <li>Fix no error being returned when creating a bucket we don't own (Nick Craig-Wood)</li> 37690 <li>Emit a debug message if anonymous credentials are in use (Nick Craig-Wood)</li> 37691 <li>Add <code>--s3-disable-multipart-uploads</code> flag (Nick Craig-Wood)</li> 37692 <li>Detect looping when using gcs and versions (Nick Craig-Wood)</li> 37693 </ul></li> 37694 <li>SFTP 37695 <ul> 37696 <li>Implement <code>--sftp-copy-is-hardlink</code> to server side copy as hardlink (Nick Craig-Wood)</li> 37697 </ul></li> 37698 <li>Smb 37699 <ul> 37700 <li>Fix incorrect <code>about</code> size by switching to <code>github.com/cloudsoda/go-smb2</code> fork (Nick Craig-Wood)</li> 37701 <li>Fix modtime of multithread uploads by setting PartialUploads (Nick Craig-Wood)</li> 37702 </ul></li> 37703 <li>WebDAV 37704 <ul> 37705 <li>Added an rclone vendor to work with <code>rclone serve webdav</code> (Adithya Kumar)</li> 37706 </ul></li> 37707 </ul> 37708 <h2 id="v1.64.2---2023-10-19">v1.64.2 - 2023-10-19</h2> 37709 <p><a href="https://github.com/rclone/rclone/compare/v1.64.1...v1.64.2">See commits</a></p> 37710 <ul> 37711 <li>Bug Fixes 37712 <ul> 37713 <li>selfupdate: Fix "invalid hashsum signature" error (Nick Craig-Wood)</li> 37714 <li>build: Fix docker build running out of space (Nick Craig-Wood)</li> 37715 </ul></li> 37716 </ul> 37717 <h2 id="v1.64.1---2023-10-17">v1.64.1 - 2023-10-17</h2> 37718 <p><a href="https://github.com/rclone/rclone/compare/v1.64.0...v1.64.1">See commits</a></p> 37719 <ul> 37720 <li>Bug Fixes 37721 <ul> 37722 <li>cmd: Make <code>--progress</code> output logs in the same format as without (Nick Craig-Wood)</li> 37723 <li>docs fixes (Dimitri Papadopoulos Orfanos, Herby Gillot, Manoj Ghosh, Nick Craig-Wood)</li> 37724 <li>lsjson: Make sure we set the global metadata flag too (Nick Craig-Wood)</li> 37725 <li>operations 37726 <ul> 37727 <li>Ensure concurrency is no greater than the number of chunks (Pat Patterson)</li> 37728 <li>Fix OpenOptions ignored in copy if operation was a multiThreadCopy (Vitor Gomes)</li> 37729 <li>Fix error message on delete to have file name (Nick Craig-Wood)</li> 37730 </ul></li> 37731 <li>serve sftp: Return not supported error for not supported commands (Nick Craig-Wood)</li> 37732 <li>build: Upgrade golang.org/x/net to v0.17.0 to fix HTTP/2 rapid reset (Nick Craig-Wood)</li> 37733 <li>pacer: Fix b2 deadlock by defaulting max connections to unlimited (Nick Craig-Wood)</li> 37734 </ul></li> 37735 <li>Mount 37736 <ul> 37737 <li>Fix automount not detecting drive is ready (Nick Craig-Wood)</li> 37738 </ul></li> 37739 <li>VFS 37740 <ul> 37741 <li>Fix update dir modification time (Saleh Dindar)</li> 37742 </ul></li> 37743 <li>Azure Blob 37744 <ul> 37745 <li>Fix "fatal error: concurrent map writes" (Nick Craig-Wood)</li> 37746 </ul></li> 37747 <li>B2 37748 <ul> 37749 <li>Fix multipart upload: corrupted on transfer: sizes differ XXX vs 0 (Nick Craig-Wood)</li> 37750 <li>Fix locking window when getting mutipart upload URL (Nick Craig-Wood)</li> 37751 <li>Fix server side copies greater than 4GB (Nick Craig-Wood)</li> 37752 <li>Fix chunked streaming uploads (Nick Craig-Wood)</li> 37753 <li>Reduce default <code>--b2-upload-concurrency</code> to 4 to reduce memory usage (Nick Craig-Wood)</li> 37754 </ul></li> 37755 <li>Onedrive 37756 <ul> 37757 <li>Fix the configurator to allow <code>/teams/ID</code> in the config (Nick Craig-Wood)</li> 37758 </ul></li> 37759 <li>Oracleobjectstorage 37760 <ul> 37761 <li>Fix OpenOptions being ignored in uploadMultipart with chunkWriter (Nick Craig-Wood)</li> 37762 </ul></li> 37763 <li>S3 37764 <ul> 37765 <li>Fix slice bounds out of range error when listing (Nick Craig-Wood)</li> 37766 <li>Fix OpenOptions being ignored in uploadMultipart with chunkWriter (Vitor Gomes)</li> 37767 </ul></li> 37768 <li>Storj 37769 <ul> 37770 <li>Update storj.io/uplink to v1.12.0 (Kaloyan Raev)</li> 37771 </ul></li> 37772 </ul> 37773 <h2 id="v1.64.0---2023-09-11">v1.64.0 - 2023-09-11</h2> 37774 <p><a href="https://github.com/rclone/rclone/compare/v1.63.0...v1.64.0">See commits</a></p> 37775 <ul> 37776 <li>New backends 37777 <ul> 37778 <li><a href="https://rclone.org/protondrive/">Proton Drive</a> (Chun-Hung Tseng)</li> 37779 <li><a href="https://rclone.org/quatrix/">Quatrix</a> (Oksana, Volodymyr Kit)</li> 37780 <li>New S3 providers 37781 <ul> 37782 <li><a href="https://rclone.org/s3/#synology-c2">Synology C2</a> (BakaWang)</li> 37783 <li><a href="https://rclone.org/s3/#leviia">Leviia</a> (Benjamin)</li> 37784 </ul></li> 37785 <li>New Jottacloud providers 37786 <ul> 37787 <li><a href="https://rclone.org/jottacloud/">Onlime</a> (Fjodor42)</li> 37788 <li><a href="https://rclone.org/jottacloud/">Telia Sky</a> (NoLooseEnds)</li> 37789 </ul></li> 37790 </ul></li> 37791 <li>Major changes 37792 <ul> 37793 <li>Multi-thread transfers (Vitor Gomes, Nick Craig-Wood, Manoj Ghosh, Edwin Mackenzie-Owen) 37794 <ul> 37795 <li>Multi-thread transfers are now available when transferring to: 37796 <ul> 37797 <li><code>local</code>, <code>s3</code>, <code>azureblob</code>, <code>b2</code>, <code>oracleobjectstorage</code> and <code>smb</code></li> 37798 </ul></li> 37799 <li>This greatly improves transfer speed between two network sources.</li> 37800 <li>In memory buffering has been unified between all backends and should share memory better.</li> 37801 <li>See <a href="https://rclone.org/docs/#multi-thread-cutoff">--multi-thread docs</a> for more info</li> 37802 </ul></li> 37803 </ul></li> 37804 <li>New commands 37805 <ul> 37806 <li><code>rclone config redacted</code> support mechanism for showing redacted config (Nick Craig-Wood)</li> 37807 </ul></li> 37808 <li>New Features 37809 <ul> 37810 <li>accounting 37811 <ul> 37812 <li>Show server side stats in own lines and not as bytes transferred (Nick Craig-Wood)</li> 37813 </ul></li> 37814 <li>bisync 37815 <ul> 37816 <li>Add new <code>--ignore-listing-checksum</code> flag to distinguish from <code>--ignore-checksum</code> (nielash)</li> 37817 <li>Add experimental <code>--resilient</code> mode to allow recovery from self-correctable errors (nielash)</li> 37818 <li>Add support for <code>--create-empty-src-dirs</code> (nielash)</li> 37819 <li>Dry runs no longer commit filter changes (nielash)</li> 37820 <li>Enforce <code>--check-access</code> during <code>--resync</code> (nielash)</li> 37821 <li>Apply filters correctly during deletes (nielash)</li> 37822 <li>Equality check before renaming (leave identical files alone) (nielash)</li> 37823 <li>Fix <code>dryRun</code> rc parameter being ignored (nielash)</li> 37824 </ul></li> 37825 <li>build 37826 <ul> 37827 <li>Update to <code>go1.21</code> and make <code>go1.19</code> the minimum required version (Anagh Kumar Baranwal, Nick Craig-Wood)</li> 37828 <li>Update dependencies (Nick Craig-Wood)</li> 37829 <li>Add snap installation (hideo aoyama)</li> 37830 <li>Change Winget Releaser job to <code>ubuntu-latest</code> (sitiom)</li> 37831 </ul></li> 37832 <li>cmd: Refactor and use sysdnotify in more commands (eNV25)</li> 37833 <li>config: Add <code>--multi-thread-chunk-size</code> flag (Vitor Gomes)</li> 37834 <li>doc updates (antoinetran, Benjamin, Bjørn Smith, Dean Attali, gabriel-suela, James Braza, Justin Hellings, kapitainsky, Mahad, Masamune3210, Nick Craig-Wood, Nihaal Sangha, Niklas Hambüchen, Raymond Berger, r-ricci, Sawada Tsunayoshi, Tiago Boeing, Vladislav Vorobev)</li> 37835 <li>fs 37836 <ul> 37837 <li>Use atomic types everywhere (Roberto Ricci)</li> 37838 <li>When <code>--max-transfer</code> limit is reached exit with code (10) (kapitainsky)</li> 37839 <li>Add rclone completion powershell - basic implementation only (Nick Craig-Wood)</li> 37840 </ul></li> 37841 <li>http servers: Allow CORS to be set with <code>--allow-origin</code> flag (yuudi)</li> 37842 <li>lib/rest: Remove unnecessary <code>nil</code> check (Eng Zer Jun)</li> 37843 <li>ncdu: Add keybinding to rescan filesystem (eNV25)</li> 37844 <li>rc 37845 <ul> 37846 <li>Add <code>executeId</code> to job listings (yuudi)</li> 37847 <li>Add <code>core/du</code> to measure local disk usage (Nick Craig-Wood)</li> 37848 <li>Add <code>operations/settier</code> to API (Drew Stinnett)</li> 37849 </ul></li> 37850 <li>rclone test info: Add <code>--check-base32768</code> flag to check can store all base32768 characters (Nick Craig-Wood)</li> 37851 <li>rmdirs: Remove directories concurrently controlled by <code>--checkers</code> (Nick Craig-Wood)</li> 37852 </ul></li> 37853 <li>Bug Fixes 37854 <ul> 37855 <li>accounting: Don't stop calculating average transfer speed until the operation is complete (Jacob Hands)</li> 37856 <li>fs: Fix <code>transferTime</code> not being set in JSON logs (Jacob Hands)</li> 37857 <li>fshttp: Fix <code>--bind 0.0.0.0</code> allowing IPv6 and <code>--bind ::0</code> allowing IPv4 (Nick Craig-Wood)</li> 37858 <li>operations: Fix overlapping check on case insensitive file systems (Nick Craig-Wood)</li> 37859 <li>serve dlna: Fix MIME type if backend can't identify it (Nick Craig-Wood)</li> 37860 <li>serve ftp: Fix race condition when using the auth proxy (Nick Craig-Wood)</li> 37861 <li>serve sftp: Fix hash calculations with <code>--vfs-cache-mode full</code> (Nick Craig-Wood)</li> 37862 <li>serve webdav: Fix error: Expecting fs.Object or fs.Directory, got <code>nil</code> (Nick Craig-Wood)</li> 37863 <li>sync: Fix lockup with <code>--cutoff-mode=soft</code> and <code>--max-duration</code> (Nick Craig-Wood)</li> 37864 </ul></li> 37865 <li>Mount 37866 <ul> 37867 <li>fix: Mount parsing for linux (Anagh Kumar Baranwal)</li> 37868 </ul></li> 37869 <li>VFS 37870 <ul> 37871 <li>Add <code>--vfs-cache-min-free-space</code> to control minimum free space on the disk containing the cache (Nick Craig-Wood)</li> 37872 <li>Added cache cleaner for directories to reduce memory usage (Anagh Kumar Baranwal)</li> 37873 <li>Update parent directory modtimes on vfs actions (David Pedersen)</li> 37874 <li>Keep virtual directory status accurate and reduce deadlock potential (Anagh Kumar Baranwal)</li> 37875 <li>Make sure struct field is aligned for atomic access (Roberto Ricci)</li> 37876 </ul></li> 37877 <li>Local 37878 <ul> 37879 <li>Rmdir return an error if the path is not a dir (zjx20)</li> 37880 </ul></li> 37881 <li>Azure Blob 37882 <ul> 37883 <li>Implement <code>OpenChunkWriter</code> and multi-thread uploads (Nick Craig-Wood)</li> 37884 <li>Fix creation of directory markers (Nick Craig-Wood)</li> 37885 <li>Fix purging with directory markers (Nick Craig-Wood)</li> 37886 </ul></li> 37887 <li>B2 37888 <ul> 37889 <li>Implement <code>OpenChunkWriter</code> and multi-thread uploads (Nick Craig-Wood)</li> 37890 <li>Fix rclone link when object path contains special characters (Alishan Ladhani)</li> 37891 </ul></li> 37892 <li>Box 37893 <ul> 37894 <li>Add polling support (David Sze)</li> 37895 <li>Add <code>--box-impersonate</code> to impersonate a user ID (Nick Craig-Wood)</li> 37896 <li>Fix unhelpful decoding of error messages into decimal numbers (Nick Craig-Wood)</li> 37897 </ul></li> 37898 <li>Chunker 37899 <ul> 37900 <li>Update documentation to mention issue with small files (Ricardo D'O. Albanus)</li> 37901 </ul></li> 37902 <li>Compress 37903 <ul> 37904 <li>Fix ChangeNotify (Nick Craig-Wood)</li> 37905 </ul></li> 37906 <li>Drive 37907 <ul> 37908 <li>Add <code>--drive-fast-list-bug-fix</code> to control ListR bug workaround (Nick Craig-Wood)</li> 37909 </ul></li> 37910 <li>Fichier 37911 <ul> 37912 <li>Implement <code>DirMove</code> (Nick Craig-Wood)</li> 37913 <li>Fix error code parsing (alexia)</li> 37914 </ul></li> 37915 <li>FTP 37916 <ul> 37917 <li>Add socks_proxy support for SOCKS5 proxies (Zach)</li> 37918 <li>Fix 425 "TLS session of data connection not resumed" errors (Nick Craig-Wood)</li> 37919 </ul></li> 37920 <li>Hdfs 37921 <ul> 37922 <li>Retry "replication in progress" errors when uploading (Nick Craig-Wood)</li> 37923 <li>Fix uploading to the wrong object on Update with overridden remote name (Nick Craig-Wood)</li> 37924 </ul></li> 37925 <li>HTTP 37926 <ul> 37927 <li>CORS should not be sent if not set (yuudi)</li> 37928 <li>Fix webdav OPTIONS response (yuudi)</li> 37929 </ul></li> 37930 <li>Opendrive 37931 <ul> 37932 <li>Fix List on a just deleted and remade directory (Nick Craig-Wood)</li> 37933 </ul></li> 37934 <li>Oracleobjectstorage 37935 <ul> 37936 <li>Use rclone's rate limiter in multipart transfers (Manoj Ghosh)</li> 37937 <li>Implement <code>OpenChunkWriter</code> and multi-thread uploads (Manoj Ghosh)</li> 37938 </ul></li> 37939 <li>S3 37940 <ul> 37941 <li>Refactor multipart upload to use <code>OpenChunkWriter</code> and <code>ChunkWriter</code> (Vitor Gomes)</li> 37942 <li>Factor generic multipart upload into <code>lib/multipart</code> (Nick Craig-Wood)</li> 37943 <li>Fix purging of root directory with <code>--s3-directory-markers</code> (Nick Craig-Wood)</li> 37944 <li>Add <code>rclone backend set</code> command to update the running config (Nick Craig-Wood)</li> 37945 <li>Add <code>rclone backend restore-status</code> command (Nick Craig-Wood)</li> 37946 </ul></li> 37947 <li>SFTP 37948 <ul> 37949 <li>Stop uploads re-using the same ssh connection to improve performance (Nick Craig-Wood)</li> 37950 <li>Add <code>--sftp-ssh</code> to specify an external ssh binary to use (Nick Craig-Wood)</li> 37951 <li>Add socks_proxy support for SOCKS5 proxies (Zach)</li> 37952 <li>Support dynamic <code>--sftp-path-override</code> (nielash)</li> 37953 <li>Fix spurious warning when using <code>--sftp-ssh</code> (Nick Craig-Wood)</li> 37954 </ul></li> 37955 <li>Smb 37956 <ul> 37957 <li>Implement multi-threaded writes for copies to smb (Edwin Mackenzie-Owen)</li> 37958 </ul></li> 37959 <li>Storj 37960 <ul> 37961 <li>Performance improvement for large file uploads (Kaloyan Raev)</li> 37962 </ul></li> 37963 <li>Swift 37964 <ul> 37965 <li>Fix HEADing 0-length objects when <code>--swift-no-large-objects</code> set (Julian Lepinski)</li> 37966 </ul></li> 37967 <li>Union 37968 <ul> 37969 <li>Add <code>:writback</code> to act as a simple cache (Nick Craig-Wood)</li> 37970 </ul></li> 37971 <li>WebDAV 37972 <ul> 37973 <li>Nextcloud: fix segment violation in low-level retry (Paul)</li> 37974 </ul></li> 37975 <li>Zoho 37976 <ul> 37977 <li>Remove Range requests workarounds to fix integration tests (Nick Craig-Wood)</li> 37978 </ul></li> 37979 </ul> 37980 <h2 id="v1.63.1---2023-07-17">v1.63.1 - 2023-07-17</h2> 37981 <p><a href="https://github.com/rclone/rclone/compare/v1.63.0...v1.63.1">See commits</a></p> 37982 <ul> 37983 <li>Bug Fixes 37984 <ul> 37985 <li>build: Fix macos builds for versions < 12 (Anagh Kumar Baranwal)</li> 37986 <li>dirtree: Fix performance with large directories of directories and <code>--fast-list</code> (Nick Craig-Wood)</li> 37987 <li>operations 37988 <ul> 37989 <li>Fix deadlock when using <code>lsd</code>/<code>ls</code> with <code>--progress</code> (Nick Craig-Wood)</li> 37990 <li>Fix <code>.rclonelink</code> files not being converted back to symlinks (Nick Craig-Wood)</li> 37991 </ul></li> 37992 <li>doc fixes (Dean Attali, Mahad, Nick Craig-Wood, Sawada Tsunayoshi, Vladislav Vorobev)</li> 37993 </ul></li> 37994 <li>Local 37995 <ul> 37996 <li>Fix partial directory read for corrupted filesystem (Nick Craig-Wood)</li> 37997 </ul></li> 37998 <li>Box 37999 <ul> 38000 <li>Fix reconnect failing with HTTP 400 Bad Request (albertony)</li> 38001 </ul></li> 38002 <li>Smb 38003 <ul> 38004 <li>Fix "Statfs failed: bucket or container name is needed" when mounting (Nick Craig-Wood)</li> 38005 </ul></li> 38006 <li>WebDAV 38007 <ul> 38008 <li>Nextcloud: fix must use /dav/files/USER endpoint not /webdav error (Paul)</li> 38009 <li>Nextcloud chunking: add more guidance for the user to check the config (darix)</li> 38010 </ul></li> 38011 </ul> 38012 <h2 id="v1.63.0---2023-06-30">v1.63.0 - 2023-06-30</h2> 38013 <p><a href="https://github.com/rclone/rclone/compare/v1.62.0...v1.63.0">See commits</a></p> 38014 <ul> 38015 <li>New backends 38016 <ul> 38017 <li><a href="https://rclone.org/pikpak/">Pikpak</a> (wiserain)</li> 38018 <li>New S3 providers 38019 <ul> 38020 <li><a href="https://rclone.org/s3/#petabox">petabox.io</a> (Andrei Smirnov)</li> 38021 <li><a href="https://rclone.org/s3/#google-cloud-storage">Google Cloud Storage</a> (Anthony Pessy)</li> 38022 </ul></li> 38023 <li>New WebDAV providers 38024 <ul> 38025 <li><a href="https://rclone.org/webdav/#fastmail-files">Fastmail</a> (Arnavion)</li> 38026 </ul></li> 38027 </ul></li> 38028 <li>Major changes 38029 <ul> 38030 <li>Files will be copied to a temporary name ending in <code>.partial</code> when copying to <code>local</code>,<code>ftp</code>,<code>sftp</code> then renamed at the end of the transfer. (Janne Hellsten, Nick Craig-Wood) 38031 <ul> 38032 <li>This helps with data integrity as we don't delete the existing file until the new one is complete.</li> 38033 <li>It can be disabled with the <a href="https://rclone.org/docs/#inplace">--inplace</a> flag.</li> 38034 <li>This behaviour will also happen if the backend is wrapped, for example <code>sftp</code> wrapped with <code>crypt</code>.</li> 38035 </ul></li> 38036 <li>The <a href="https://rclone.org/s3/#s3-directory-markers">s3</a>, <a href="/azureblob/#azureblob-directory-markers">azureblob</a> and <a href="/googlecloudstorage/#gcs-directory-markers">gcs</a> backends now support directory markers so empty directories are supported (Jānis Bebrītis, Nick Craig-Wood)</li> 38037 <li>The <a href="https://rclone.org/docs/#default-time-time">--default-time</a> flag now controls the unknown modification time of files/dirs (Nick Craig-Wood) 38038 <ul> 38039 <li>If a file or directory does not have a modification time rclone can read then rclone will display this fixed time instead.</li> 38040 <li>For the old behaviour use <code>--default-time 0s</code> which will set this time to the time rclone started up.</li> 38041 </ul></li> 38042 </ul></li> 38043 <li>New Features 38044 <ul> 38045 <li>build 38046 <ul> 38047 <li>Modernise linters in use and fixup all affected code (albertony)</li> 38048 <li>Push docker beta to GHCR (GitHub container registry) (Richard Tweed)</li> 38049 </ul></li> 38050 <li>cat: Add <code>--separator</code> option to cat command (Loren Gordon)</li> 38051 <li>config 38052 <ul> 38053 <li>Do not remove/overwrite other files during config file save (albertony)</li> 38054 <li>Do not overwrite config file symbolic link (albertony)</li> 38055 <li>Stop <code>config create</code> making invalid config files (Nick Craig-Wood)</li> 38056 </ul></li> 38057 <li>doc updates (Adam K, Aditya Basu, albertony, asdffdsazqqq, Damo, danielkrajnik, Dimitri Papadopoulos, dlitster, Drew Parsons, jumbi77, kapitainsky, mac-15, Mariusz Suchodolski, Nick Craig-Wood, NickIAm, Rintze Zelle, Stanislav Gromov, Tareq Sharafy, URenko, yuudi, Zach Kipp)</li> 38058 <li>fs 38059 <ul> 38060 <li>Add <code>size</code> to JSON logs when moving or copying an object (Nick Craig-Wood)</li> 38061 <li>Allow boolean features to be enabled with <code>--disable !Feature</code> (Nick Craig-Wood)</li> 38062 </ul></li> 38063 <li>genautocomplete: Rename to <code>completion</code> with alias to the old name (Nick Craig-Wood)</li> 38064 <li>librclone: Added example on using <code>librclone</code> with Go (alankrit)</li> 38065 <li>lsjson: Make <code>--stat</code> more efficient (Nick Craig-Wood)</li> 38066 <li>operations 38067 <ul> 38068 <li>Implement <code>--multi-thread-write-buffer-size</code> for speed improvements on downloads (Paulo Schreiner)</li> 38069 <li>Reopen downloads on error when using <code>check --download</code> and <code>cat</code> (Nick Craig-Wood)</li> 38070 </ul></li> 38071 <li>rc: <code>config/listremotes</code> includes remotes defined with environment variables (kapitainsky)</li> 38072 <li>selfupdate: Obey <code>--no-check-certificate</code> flag (Nick Craig-Wood)</li> 38073 <li>serve restic: Trigger systemd notify (Shyim)</li> 38074 <li>serve webdav: Implement owncloud checksum and modtime extensions (WeidiDeng)</li> 38075 <li>sync: <code>--suffix-keep-extension</code> preserve 2 part extensions like .tar.gz (Nick Craig-Wood)</li> 38076 </ul></li> 38077 <li>Bug Fixes 38078 <ul> 38079 <li>accounting 38080 <ul> 38081 <li>Fix Prometheus metrics to be the same as <code>core/stats</code> (Nick Craig-Wood)</li> 38082 <li>Bwlimit signal handler should always start (Sam Lai)</li> 38083 </ul></li> 38084 <li>bisync: Fix <code>maxDelete</code> parameter being ignored via the rc (Nick Craig-Wood)</li> 38085 <li>cmd/ncdu: Fix screen corruption when logging (eNV25)</li> 38086 <li>filter: Fix deadlock with errors on <code>--files-from</code> (douchen)</li> 38087 <li>fs 38088 <ul> 38089 <li>Fix interaction between <code>--progress</code> and <code>--interactive</code> (Nick Craig-Wood)</li> 38090 <li>Fix infinite recursive call in pacer ModifyCalculator (fixes issue reported by the staticcheck linter) (albertony)</li> 38091 </ul></li> 38092 <li>lib/atexit: Ensure OnError only calls cancel function once (Nick Craig-Wood)</li> 38093 <li>lib/rest: Fix problems re-using HTTP connections (Nick Craig-Wood)</li> 38094 <li>rc 38095 <ul> 38096 <li>Fix <code>operations/stat</code> with trailing <code>/</code> (Nick Craig-Wood)</li> 38097 <li>Fix missing <code>--rc</code> flags (Nick Craig-Wood)</li> 38098 <li>Fix output of Time values in <code>options/get</code> (Nick Craig-Wood)</li> 38099 </ul></li> 38100 <li>serve dlna: Fix potential data race (Nick Craig-Wood)</li> 38101 <li>version: Fix reported os/kernel version for windows (albertony)</li> 38102 </ul></li> 38103 <li>Mount 38104 <ul> 38105 <li>Add <code>--mount-case-insensitive</code> to force the mount to be case insensitive (Nick Craig-Wood)</li> 38106 <li>Removed unnecessary byte slice allocation for reads (Anagh Kumar Baranwal)</li> 38107 <li>Clarify rclone mount error when installed via homebrew (Nick Craig-Wood)</li> 38108 <li>Added _netdev to the example mount so it gets treated as a remote-fs rather than local-fs (Anagh Kumar Baranwal)</li> 38109 </ul></li> 38110 <li>Mount2 38111 <ul> 38112 <li>Updated go-fuse version (Anagh Kumar Baranwal)</li> 38113 <li>Fixed statfs (Anagh Kumar Baranwal)</li> 38114 <li>Disable xattrs (Anagh Kumar Baranwal)</li> 38115 </ul></li> 38116 <li>VFS 38117 <ul> 38118 <li>Add MkdirAll function to make a directory and all beneath (Nick Craig-Wood)</li> 38119 <li>Fix reload: failed to add virtual dir entry: file does not exist (Nick Craig-Wood)</li> 38120 <li>Fix writing to a read only directory creating spurious directory entries (WeidiDeng)</li> 38121 <li>Fix potential data race (Nick Craig-Wood)</li> 38122 <li>Fix backends being Shutdown too early when startup takes a long time (Nick Craig-Wood)</li> 38123 </ul></li> 38124 <li>Local 38125 <ul> 38126 <li>Fix filtering of symlinks with <code>-l</code>/<code>--links</code> flag (Nick Craig-Wood)</li> 38127 <li>Fix /path/to/file.rclonelink when <code>-l</code>/<code>--links</code> is in use (Nick Craig-Wood)</li> 38128 <li>Fix crash with <code>--metadata</code> on Android (Nick Craig-Wood)</li> 38129 </ul></li> 38130 <li>Cache 38131 <ul> 38132 <li>Fix backends shutting down when in use when used via the rc (Nick Craig-Wood)</li> 38133 </ul></li> 38134 <li>Crypt 38135 <ul> 38136 <li>Add <code>--crypt-suffix</code> option to set a custom suffix for encrypted files (jladbrook)</li> 38137 <li>Add <code>--crypt-pass-bad-blocks</code> to allow corrupted file output (Nick Craig-Wood)</li> 38138 <li>Fix reading 0 length files (Nick Craig-Wood)</li> 38139 <li>Try not to return "unexpected EOF" error (Nick Craig-Wood)</li> 38140 <li>Reduce allocations (albertony)</li> 38141 <li>Recommend Dropbox for <code>base32768</code> encoding (Nick Craig-Wood)</li> 38142 </ul></li> 38143 <li>Azure Blob 38144 <ul> 38145 <li>Empty directory markers (Nick Craig-Wood)</li> 38146 <li>Support azure workload identities (Tareq Sharafy)</li> 38147 <li>Fix azure blob uploads with multiple bits of metadata (Nick Craig-Wood)</li> 38148 <li>Fix azurite compatibility by sending nil tier if set to empty string (Roel Arents)</li> 38149 </ul></li> 38150 <li>Combine 38151 <ul> 38152 <li>Implement missing methods (Nick Craig-Wood)</li> 38153 <li>Fix goroutine stack overflow on bad object (Nick Craig-Wood)</li> 38154 </ul></li> 38155 <li>Drive 38156 <ul> 38157 <li>Add <code>--drive-env-auth</code> to get IAM credentials from runtime (Peter Brunner)</li> 38158 <li>Update drive service account guide (Juang, Yi-Lin)</li> 38159 <li>Fix change notify picking up files outside the root (Nick Craig-Wood)</li> 38160 <li>Fix trailing slash mis-identificaton of folder as file (Nick Craig-Wood)</li> 38161 <li>Fix incorrect remote after Update on object (Nick Craig-Wood)</li> 38162 </ul></li> 38163 <li>Dropbox 38164 <ul> 38165 <li>Implement <code>--dropbox-pacer-min-sleep</code> flag (Nick Craig-Wood)</li> 38166 <li>Fix the dropbox batcher stalling (Misty)</li> 38167 </ul></li> 38168 <li>Fichier 38169 <ul> 38170 <li>Add <code>--ficicher-cdn</code> option to use the CDN for download (Nick Craig-Wood)</li> 38171 </ul></li> 38172 <li>FTP 38173 <ul> 38174 <li>Lower log message priority when <code>SetModTime</code> is not supported to debug (Tobias Gion)</li> 38175 <li>Fix "unsupported LIST line" errors on startup (Nick Craig-Wood)</li> 38176 <li>Fix "501 Not a valid pathname." errors when creating directories (Nick Craig-Wood)</li> 38177 </ul></li> 38178 <li>Google Cloud Storage 38179 <ul> 38180 <li>Empty directory markers (Jānis Bebrītis, Nick Craig-Wood)</li> 38181 <li>Added <code>--gcs-user-project</code> needed for requester pays (Christopher Merry)</li> 38182 </ul></li> 38183 <li>HTTP 38184 <ul> 38185 <li>Add client certificate user auth middleware. This can auth <code>serve restic</code> from the username in the client cert. (Peter Fern)</li> 38186 </ul></li> 38187 <li>Jottacloud 38188 <ul> 38189 <li>Fix vfs writeback stuck in a failed upload loop with file versioning disabled (albertony)</li> 38190 </ul></li> 38191 <li>Onedrive 38192 <ul> 38193 <li>Add <code>--onedrive-av-override</code> flag to download files flagged as virus (Nick Craig-Wood)</li> 38194 <li>Fix quickxorhash on 32 bit architectures (Nick Craig-Wood)</li> 38195 <li>Report any list errors during <code>rclone cleanup</code> (albertony)</li> 38196 </ul></li> 38197 <li>Putio 38198 <ul> 38199 <li>Fix uploading to the wrong object on Update with overridden remote name (Nick Craig-Wood)</li> 38200 <li>Fix modification times not being preserved for server side copy and move (Nick Craig-Wood)</li> 38201 <li>Fix server side copy failures (400 errors) (Nick Craig-Wood)</li> 38202 </ul></li> 38203 <li>S3 38204 <ul> 38205 <li>Empty directory markers (Jānis Bebrītis, Nick Craig-Wood)</li> 38206 <li>Update Scaleway storage classes (Brian Starkey)</li> 38207 <li>Fix <code>--s3-versions</code> on individual objects (Nick Craig-Wood)</li> 38208 <li>Fix hang on aborting multipart upload with iDrive e2 (Nick Craig-Wood)</li> 38209 <li>Fix missing "tier" metadata (Nick Craig-Wood)</li> 38210 <li>Fix V3sign: add missing subresource delete (cc)</li> 38211 <li>Fix Arvancloud Domain and region changes and alphabetise the provider (Ehsan Tadayon)</li> 38212 <li>Fix Qiniu KODO quirks virtualHostStyle is false (zzq)</li> 38213 </ul></li> 38214 <li>SFTP 38215 <ul> 38216 <li>Add <code>--sftp-host-key-algorithms</code> to allow specifying SSH host key algorithms (Joel)</li> 38217 <li>Fix using <code>--sftp-key-use-agent</code> and <code>--sftp-key-file</code> together needing private key file (Arnav Singh)</li> 38218 <li>Fix move to allow overwriting existing files (Nick Craig-Wood)</li> 38219 <li>Don't stat directories before listing them (Nick Craig-Wood)</li> 38220 <li>Don't check remote points to a file if it ends with / (Nick Craig-Wood)</li> 38221 </ul></li> 38222 <li>Sharefile 38223 <ul> 38224 <li>Disable streamed transfers as they no longer work (Nick Craig-Wood)</li> 38225 </ul></li> 38226 <li>Smb 38227 <ul> 38228 <li>Code cleanup to avoid overwriting ctx before first use (fixes issue reported by the staticcheck linter) (albertony)</li> 38229 </ul></li> 38230 <li>Storj 38231 <ul> 38232 <li>Fix "uplink: too many requests" errors when uploading to the same file (Nick Craig-Wood)</li> 38233 <li>Fix uploading to the wrong object on Update with overridden remote name (Nick Craig-Wood)</li> 38234 </ul></li> 38235 <li>Swift 38236 <ul> 38237 <li>Ignore 404 error when deleting an object (Nick Craig-Wood)</li> 38238 </ul></li> 38239 <li>Union 38240 <ul> 38241 <li>Implement missing methods (Nick Craig-Wood)</li> 38242 <li>Allow errors to be unwrapped for inspection (Nick Craig-Wood)</li> 38243 </ul></li> 38244 <li>Uptobox 38245 <ul> 38246 <li>Add <code>--uptobox-private</code> flag to make all uploaded files private (Nick Craig-Wood)</li> 38247 <li>Fix improper regex (Aaron Gokaslan)</li> 38248 <li>Fix Update returning the wrong object (Nick Craig-Wood)</li> 38249 <li>Fix rmdir declaring that directories weren't empty (Nick Craig-Wood)</li> 38250 </ul></li> 38251 <li>WebDAV 38252 <ul> 38253 <li>nextcloud: Add support for chunked uploads (Paul)</li> 38254 <li>Set modtime using propset for owncloud and nextcloud (WeidiDeng)</li> 38255 <li>Make pacer minSleep configurable with <code>--webdav-pacer-min-sleep</code> (ed)</li> 38256 <li>Fix server side copy/move not overwriting (WeidiDeng)</li> 38257 <li>Fix modtime on server side copy for owncloud and nextcloud (Nick Craig-Wood)</li> 38258 </ul></li> 38259 <li>Yandex 38260 <ul> 38261 <li>Fix 400 Bad Request on transfer failure (Nick Craig-Wood)</li> 38262 </ul></li> 38263 <li>Zoho 38264 <ul> 38265 <li>Fix downloads with <code>Range:</code> header returning the wrong data (Nick Craig-Wood)</li> 38266 </ul></li> 38267 </ul> 38268 <h2 id="v1.62.2---2023-03-16">v1.62.2 - 2023-03-16</h2> 38269 <p><a href="https://github.com/rclone/rclone/compare/v1.62.1...v1.62.2">See commits</a></p> 38270 <ul> 38271 <li>Bug Fixes 38272 <ul> 38273 <li>docker volume plugin: Add missing fuse3 dependency (Nick Craig-Wood)</li> 38274 <li>docs: Fix size documentation (asdffdsazqqq)</li> 38275 </ul></li> 38276 <li>FTP 38277 <ul> 38278 <li>Fix 426 errors on downloads with vsftpd (Lesmiscore)</li> 38279 </ul></li> 38280 </ul> 38281 <h2 id="v1.62.1---2023-03-15">v1.62.1 - 2023-03-15</h2> 38282 <p><a href="https://github.com/rclone/rclone/compare/v1.62.0...v1.62.1">See commits</a></p> 38283 <ul> 38284 <li>Bug Fixes 38285 <ul> 38286 <li>docker: Add missing fuse3 dependency (cycneuramus)</li> 38287 <li>build: Update release docs to be more careful with the tag (Nick Craig-Wood)</li> 38288 <li>build: Set Github release to draft while uploading binaries (Nick Craig-Wood)</li> 38289 </ul></li> 38290 </ul> 38291 <h2 id="v1.62.0---2023-03-14">v1.62.0 - 2023-03-14</h2> 38292 <p><a href="https://github.com/rclone/rclone/compare/v1.61.0...v1.62.0">See commits</a></p> 38293 <ul> 38294 <li>New Features 38295 <ul> 38296 <li>accounting: Make checkers show what they are doing (Nick Craig-Wood)</li> 38297 <li>authorize: Add support for custom templates (Hunter Wittenborn)</li> 38298 <li>build 38299 <ul> 38300 <li>Update to go1.20 (Nick Craig-Wood, Anagh Kumar Baranwal)</li> 38301 <li>Add winget releaser workflow (Ryan Caezar Itang)</li> 38302 <li>Add dependabot (Ryan Caezar Itang)</li> 38303 </ul></li> 38304 <li>doc updates (albertony, Bryan Kaplan, Gerard Bosch, IMTheNachoMan, Justin Winokur, Manoj Ghosh, Nick Craig-Wood, Ole Frost, Peter Brunner, piyushgarg, Ryan Caezar Itang, Simmon Li, ToBeFree)</li> 38305 <li>filter: Emit INFO message when can't work out directory filters (Nick Craig-Wood)</li> 38306 <li>fs 38307 <ul> 38308 <li>Added multiple ca certificate support. (alankrit)</li> 38309 <li>Add <code>--max-delete-size</code> a delete size threshold (Leandro Sacchet)</li> 38310 </ul></li> 38311 <li>fspath: Allow the symbols <code>@</code> and <code>+</code> in remote names (albertony)</li> 38312 <li>lib/terminal: Enable windows console virtual terminal sequences processing (ANSI/VT100 colors) (albertony)</li> 38313 <li>move: If <code>--check-first</code> and <code>--order-by</code> are set then delete with perfect ordering (Nick Craig-Wood)</li> 38314 <li>serve http: Support <code>--auth-proxy</code> (Matthias Baur)</li> 38315 </ul></li> 38316 <li>Bug Fixes 38317 <ul> 38318 <li>accounting 38319 <ul> 38320 <li>Avoid negative ETA values for very slow speeds (albertony)</li> 38321 <li>Limit length of ETA string (albertony)</li> 38322 <li>Show human readable elapsed time when longer than a day (albertony)</li> 38323 </ul></li> 38324 <li>all: Apply codeql fixes (Aaron Gokaslan)</li> 38325 <li>build 38326 <ul> 38327 <li>Fix condition for manual workflow run (albertony)</li> 38328 <li>Fix building for ARMv5 and ARMv6 (albertony) 38329 <ul> 38330 <li>selfupdate: Consider ARM version</li> 38331 <li>install.sh: fix ARMv6 download</li> 38332 <li>version: Report ARM version</li> 38333 </ul></li> 38334 </ul></li> 38335 <li>deletefile: Return error code 4 if file does not exist (Nick Craig-Wood)</li> 38336 <li>docker: Fix volume plugin does not remount volume on docker restart (logopk)</li> 38337 <li>fs: Fix race conditions in <code>--max-delete</code> and <code>--max-delete-size</code> (Nick Craig-Wood)</li> 38338 <li>lib/oauthutil: Handle fatal errors better (Alex Chen)</li> 38339 <li>mount2: Fix <code>--allow-non-empty</code> (Nick Craig-Wood)</li> 38340 <li>operations: Fix concurrency: use <code>--checkers</code> unless transferring files (Nick Craig-Wood)</li> 38341 <li>serve ftp: Fix timestamps older than 1 year in listings (Nick Craig-Wood)</li> 38342 <li>sync: Fix concurrency: use <code>--checkers</code> unless transferring files (Nick Craig-Wood)</li> 38343 <li>tree 38344 <ul> 38345 <li>Fix nil pointer exception on stat failure (Nick Craig-Wood)</li> 38346 <li>Fix colored output on windows (albertony)</li> 38347 <li>Fix display of files with illegal Windows file system names (Nick Craig-Wood)</li> 38348 </ul></li> 38349 </ul></li> 38350 <li>Mount 38351 <ul> 38352 <li>Fix creating and renaming files on case insensitive backends (Nick Craig-Wood)</li> 38353 <li>Do not treat <code>\\?\</code> prefixed paths as network share paths on windows (albertony)</li> 38354 <li>Fix check for empty mount point on Linux (Nick Craig-Wood)</li> 38355 <li>Fix <code>--allow-non-empty</code> (Nick Craig-Wood)</li> 38356 <li>Avoid incorrect or premature overlap check on windows (albertony)</li> 38357 <li>Update to fuse3 after bazil.org/fuse update (Nick Craig-Wood)</li> 38358 </ul></li> 38359 <li>VFS 38360 <ul> 38361 <li>Make uploaded files retain modtime with non-modtime backends (Nick Craig-Wood)</li> 38362 <li>Fix incorrect modtime on fs which don't support setting modtime (Nick Craig-Wood)</li> 38363 <li>Fix rename of directory containing files to be uploaded (Nick Craig-Wood)</li> 38364 </ul></li> 38365 <li>Local 38366 <ul> 38367 <li>Fix <code>%!w(<nil>)</code> in "failed to read directory" error (Marks Polakovs)</li> 38368 <li>Fix exclusion of dangling symlinks with -L/--copy-links (Nick Craig-Wood)</li> 38369 </ul></li> 38370 <li>Crypt 38371 <ul> 38372 <li>Obey <code>--ignore-checksum</code> (Nick Craig-Wood)</li> 38373 <li>Fix for unencrypted directory names on case insensitive remotes (Ole Frost)</li> 38374 </ul></li> 38375 <li>Azure Blob 38376 <ul> 38377 <li>Remove workarounds for SDK bugs after v0.6.1 update (Nick Craig-Wood)</li> 38378 </ul></li> 38379 <li>B2 38380 <ul> 38381 <li>Fix uploading files bigger than 1TiB (Nick Craig-Wood)</li> 38382 </ul></li> 38383 <li>Drive 38384 <ul> 38385 <li>Note that <code>--drive-acknowledge-abuse</code> needs SA Manager permission (Nick Craig-Wood)</li> 38386 <li>Make <code>--drive-stop-on-upload-limit</code> to respond to storageQuotaExceeded (Ninh Pham)</li> 38387 </ul></li> 38388 <li>FTP 38389 <ul> 38390 <li>Retry 426 errors (Nick Craig-Wood)</li> 38391 <li>Retry errors when initiating downloads (Nick Craig-Wood)</li> 38392 <li>Revert to upstream <code>github.com/jlaffaye/ftp</code> now fix is merged (Nick Craig-Wood)</li> 38393 </ul></li> 38394 <li>Google Cloud Storage 38395 <ul> 38396 <li>Add <code>--gcs-env-auth</code> to pick up IAM credentials from env/instance (Peter Brunner)</li> 38397 </ul></li> 38398 <li>Mega 38399 <ul> 38400 <li>Add <code>--mega-use-https</code> flag (NodudeWasTaken)</li> 38401 </ul></li> 38402 <li>Onedrive 38403 <ul> 38404 <li>Default onedrive personal to QuickXorHash as Microsoft is removing SHA1 (Nick Craig-Wood)</li> 38405 <li>Add <code>--onedrive-hash-type</code> to change the hash in use (Nick Craig-Wood)</li> 38406 <li>Improve speed of QuickXorHash (LXY)</li> 38407 </ul></li> 38408 <li>Oracle Object Storage 38409 <ul> 38410 <li>Speed up operations by using S3 pacer and setting minsleep to 10ms (Manoj Ghosh)</li> 38411 <li>Expose the <code>storage_tier</code> option in config (Manoj Ghosh)</li> 38412 <li>Bring your own encryption keys (Manoj Ghosh)</li> 38413 </ul></li> 38414 <li>S3 38415 <ul> 38416 <li>Check multipart upload ETag when <code>--s3-no-head</code> is in use (Nick Craig-Wood)</li> 38417 <li>Add <code>--s3-sts-endpoint</code> to specify STS endpoint (Nick Craig-Wood)</li> 38418 <li>Fix incorrect tier support for StorJ and IDrive when pointing at a file (Ole Frost)</li> 38419 <li>Fix AWS STS failing if <code>--s3-endpoint</code> is set (Nick Craig-Wood)</li> 38420 <li>Make purge remove directory markers too (Nick Craig-Wood)</li> 38421 </ul></li> 38422 <li>Seafile 38423 <ul> 38424 <li>Renew library password (Fred)</li> 38425 </ul></li> 38426 <li>SFTP 38427 <ul> 38428 <li>Fix uploads being 65% slower than they should be with crypt (Nick Craig-Wood)</li> 38429 </ul></li> 38430 <li>Smb 38431 <ul> 38432 <li>Allow SPN (service principal name) to be configured (Nick Craig-Wood)</li> 38433 <li>Check smb connection is closed (happyxhw)</li> 38434 </ul></li> 38435 <li>Storj 38436 <ul> 38437 <li>Implement <code>rclone link</code> (Kaloyan Raev)</li> 38438 <li>Implement <code>rclone purge</code> (Kaloyan Raev)</li> 38439 <li>Update satellite urls and labels (Kaloyan Raev)</li> 38440 </ul></li> 38441 <li>WebDAV 38442 <ul> 38443 <li>Fix interop with davrods server (Nick Craig-Wood)</li> 38444 </ul></li> 38445 </ul> 38446 <h2 id="v1.61.1---2022-12-23">v1.61.1 - 2022-12-23</h2> 38447 <p><a href="https://github.com/rclone/rclone/compare/v1.61.0...v1.61.1">See commits</a></p> 38448 <ul> 38449 <li>Bug Fixes 38450 <ul> 38451 <li>docs: 38452 <ul> 38453 <li>Show only significant parts of version number in version introduced label (albertony)</li> 38454 <li>Fix unescaped HTML (Nick Craig-Wood)</li> 38455 </ul></li> 38456 <li>lib/http: Shutdown all servers on exit to remove unix socket (Nick Craig-Wood)</li> 38457 <li>rc: Fix <code>--rc-addr</code> flag (which is an alternate for <code>--url</code>) (Anagh Kumar Baranwal)</li> 38458 <li>serve restic 38459 <ul> 38460 <li>Don't serve via http if serving via <code>--stdio</code> (Nick Craig-Wood)</li> 38461 <li>Fix immediate exit when not using stdio (Nick Craig-Wood)</li> 38462 </ul></li> 38463 <li>serve webdav 38464 <ul> 38465 <li>Fix <code>--baseurl</code> handling after <code>lib/http</code> refactor (Nick Craig-Wood)</li> 38466 <li>Fix running duplicate Serve call (Nick Craig-Wood)</li> 38467 </ul></li> 38468 </ul></li> 38469 <li>Azure Blob 38470 <ul> 38471 <li>Fix "409 Public access is not permitted on this storage account" (Nick Craig-Wood)</li> 38472 </ul></li> 38473 <li>S3 38474 <ul> 38475 <li>storj: Update endpoints (Kaloyan Raev)</li> 38476 </ul></li> 38477 </ul> 38478 <h2 id="v1.61.0---2022-12-20">v1.61.0 - 2022-12-20</h2> 38479 <p><a href="https://github.com/rclone/rclone/compare/v1.60.0...v1.61.0">See commits</a></p> 38480 <ul> 38481 <li>New backends 38482 <ul> 38483 <li>New S3 providers 38484 <ul> 38485 <li><a href="https://rclone.org/s3/#liara-cloud">Liara LOS</a> (MohammadReza)</li> 38486 </ul></li> 38487 </ul></li> 38488 <li>New Features 38489 <ul> 38490 <li>build: Add vulnerability testing using govulncheck (albertony)</li> 38491 <li>cmd: Enable <code>SIGINFO</code> (Ctrl-T) handler on FreeBSD, NetBSD, OpenBSD and Dragonfly BSD (x3-apptech)</li> 38492 <li>config: Add <a href="https://rclone.org/rc/#config-setpath">config/setpath</a> for setting config path via rc/librclone (Nick Craig-Wood)</li> 38493 <li>dedupe 38494 <ul> 38495 <li>Count Checks in the stats while scanning for duplicates (Nick Craig-Wood)</li> 38496 <li>Make dedupe obey the filters (Nick Craig-Wood)</li> 38497 </ul></li> 38498 <li>dlna: Properly attribute code used from https://github.com/anacrolix/dms (Nick Craig-Wood)</li> 38499 <li>docs 38500 <ul> 38501 <li>Add minimum versions and status badges to backend and command docs (Nick Craig-Wood, albertony)</li> 38502 <li>Remote names may not start or end with space (albertony)</li> 38503 </ul></li> 38504 <li>filter: Add metadata filters <a href="https://rclone.org/filtering/#metadata">--metadata-include/exclude/filter</a> and friends (Nick Craig-Wood)</li> 38505 <li>fs 38506 <ul> 38507 <li>Make all duration flags take <code>y</code>, <code>M</code>, <code>w</code>, <code>d</code> etc suffixes (Nick Craig-Wood)</li> 38508 <li>Add global flag <code>--color</code> to control terminal colors (Kevin Verstaen)</li> 38509 </ul></li> 38510 <li>fspath: Allow unicode numbers and letters in remote names (albertony)</li> 38511 <li>lib/file: Improve error message for creating dir on non-existent network host on windows (albertony)</li> 38512 <li>lib/http: Finish port of rclone servers to <code>lib/http</code> (Tom Mombourquette, Nick Craig-Wood)</li> 38513 <li>lib/oauthutil: Improved usability of config flows needing web browser (Ole Frost)</li> 38514 <li>ncdu 38515 <ul> 38516 <li>Add support for modification time (albertony)</li> 38517 <li>Fallback to sort by name also for sort by average size (albertony)</li> 38518 <li>Rework to use tcell directly instead of the termbox wrapper (eNV25)</li> 38519 </ul></li> 38520 <li>rc: Add commands to set <a href="https://rclone.org/rc/#debug-set-gc-percent">GC Percent</a> & <a href="/rc/#debug-set-soft-memory-limit">Memory Limit</a> (go 1.19+) (Anagh Kumar Baranwal)</li> 38521 <li>rcat: Preserve metadata when Copy falls back to Rcat (Nick Craig-Wood)</li> 38522 <li>rcd: Refactor rclone rc server to use <code>lib/http</code> (Nick Craig-Wood)</li> 38523 <li>rcserver: Avoid generating default credentials with htpasswd (Kamui)</li> 38524 <li>restic: Refactor to use <code>lib/http</code> (Nolan Woods)</li> 38525 <li>serve http: Support unix sockets and multiple listeners (Tom Mombourquette)</li> 38526 <li>serve webdav: Refactor to use <code>lib/http</code> (Nick Craig-Wood)</li> 38527 <li>test: Replace defer cleanup with <code>t.Cleanup</code> (Eng Zer Jun)</li> 38528 <li>test memory: Read metadata if <code>-M</code> flag is specified (Nick Craig-Wood)</li> 38529 <li>wasm: Comply with <code>wasm_exec.js</code> licence terms (Matthew Vernon)</li> 38530 </ul></li> 38531 <li>Bug Fixes 38532 <ul> 38533 <li>build: Update <code>golang.org/x/net/http2</code> to fix GO-2022-1144 (Nick Craig-Wood)</li> 38534 <li>restic: Fix typo in docs 'remove' should be 'remote' (asdffdsazqqq)</li> 38535 <li>serve dlna: Fix panic: Logger uninitialized. (Nick Craig-Wood)</li> 38536 </ul></li> 38537 <li>Mount 38538 <ul> 38539 <li>Update cgofuse for FUSE-T support for mounting volumes on Mac (Nick Craig-Wood)</li> 38540 </ul></li> 38541 <li>VFS 38542 <ul> 38543 <li>Windows: fix slow opening of exe files by not truncating files when not necessary (Nick Craig-Wood)</li> 38544 <li>Fix IO Error opening a file with <code>O_CREATE|O_RDONLY</code> in <code>--vfs-cache-mode</code> not full (Nick Craig-Wood)</li> 38545 </ul></li> 38546 <li>Crypt 38547 <ul> 38548 <li>Fix compress wrapping crypt giving upload errors (Nick Craig-Wood)</li> 38549 </ul></li> 38550 <li>Azure Blob 38551 <ul> 38552 <li>Port to new SDK (Nick Craig-Wood) 38553 <ul> 38554 <li>Revamp authentication to include all methods and docs (Nick Craig-Wood)</li> 38555 <li>Port old authentication methods to new SDK (Nick Craig-Wood, Brad Ackerman)</li> 38556 <li>Thanks to <a href="https://www.stonebranch.com/">Stonebranch</a> for sponsoring this work.</li> 38557 </ul></li> 38558 <li>Add <code>--azureblob-no-check-container</code> to assume container exists (Nick Craig-Wood)</li> 38559 <li>Add <code>--use-server-modtime</code> support (Abdullah Saglam)</li> 38560 <li>Add support for custom upload headers (rkettelerij)</li> 38561 <li>Allow emulator account/key override (Roel Arents)</li> 38562 <li>Support simple "environment credentials" (Nathaniel Wesley Filardo)</li> 38563 <li>Ignore <code>AuthorizationFailure</code> when trying to create a create a container (Nick Craig-Wood)</li> 38564 </ul></li> 38565 <li>Box 38566 <ul> 38567 <li>Added note on Box API rate limits (Ole Frost)</li> 38568 </ul></li> 38569 <li>Drive 38570 <ul> 38571 <li>Handle shared drives with leading/trailing space in name (related to) (albertony)</li> 38572 </ul></li> 38573 <li>FTP 38574 <ul> 38575 <li>Update help text of implicit/explicit TLS options to refer to FTPS instead of FTP (ycdtosa)</li> 38576 <li>Improve performance to speed up <code>--files-from</code> and <code>NewObject</code> (Anthony Pessy)</li> 38577 </ul></li> 38578 <li>HTTP 38579 <ul> 38580 <li>Parse GET responses when <code>no_head</code> is set (Arnie97)</li> 38581 <li>Do not update object size based on <code>Range</code> requests (Arnie97)</li> 38582 <li>Support <code>Content-Range</code> response header (Arnie97)</li> 38583 </ul></li> 38584 <li>Onedrive 38585 <ul> 38586 <li>Document workaround for shared with me files (vanplus)</li> 38587 </ul></li> 38588 <li>S3 38589 <ul> 38590 <li>Add Liara LOS to provider list (MohammadReza)</li> 38591 <li>Add DigitalOcean Spaces regions <code>sfo3</code>, <code>fra1</code>, <code>syd1</code> (Jack)</li> 38592 <li>Avoid privileged <code>GetBucketLocation</code> to resolve s3 region (Anthony Pessy)</li> 38593 <li>Stop setting object and bucket ACL to <code>private</code> if it is an empty string (Philip Harvey)</li> 38594 <li>If bucket or object ACL is empty string then don't add <code>X-Amz-Acl:</code> header (Nick Craig-Wood)</li> 38595 <li>Reduce memory consumption for s3 objects (Erik Agterdenbos)</li> 38596 <li>Fix listing loop when using v2 listing on v1 server (Nick Craig-Wood)</li> 38597 <li>Fix nil pointer exception when using Versions (Nick Craig-Wood)</li> 38598 <li>Fix excess memory usage when using versions (Nick Craig-Wood)</li> 38599 <li>Ignore versionIDs from uploads unless using <code>--s3-versions</code> or <code>--s3-versions-at</code> (Nick Craig-Wood)</li> 38600 </ul></li> 38601 <li>SFTP 38602 <ul> 38603 <li>Add configuration options to set ssh Ciphers / MACs / KeyExchange (dgouju)</li> 38604 <li>Auto-detect shell type for fish (albertony)</li> 38605 <li>Fix NewObject with leading / (Nick Craig-Wood)</li> 38606 </ul></li> 38607 <li>Smb 38608 <ul> 38609 <li>Fix issue where spurious dot directory is created (albertony)</li> 38610 </ul></li> 38611 <li>Storj 38612 <ul> 38613 <li>Implement server side Copy (Kaloyan Raev)</li> 38614 </ul></li> 38615 </ul> 38616 <h2 id="v1.60.1---2022-11-17">v1.60.1 - 2022-11-17</h2> 38617 <p><a href="https://github.com/rclone/rclone/compare/v1.60.0...v1.60.1">See commits</a></p> 38618 <ul> 38619 <li>Bug Fixes 38620 <ul> 38621 <li>lib/cache: Fix alias backend shutting down too soon (Nick Craig-Wood)</li> 38622 <li>wasm: Fix walltime link error by adding up-to-date wasm_exec.js (João Henrique Franco)</li> 38623 <li>docs 38624 <ul> 38625 <li>Update faq.md with bisync (Samuel Johnson)</li> 38626 <li>Corrected download links in windows install docs (coultonluke)</li> 38627 <li>Add direct download link for windows arm64 (albertony)</li> 38628 <li>Remove link to rclone slack as it is no longer supported (Nick Craig-Wood)</li> 38629 <li>Faq: how to use a proxy server that requires a username and password (asdffdsazqqq)</li> 38630 <li>Oracle-object-storage: doc fix (Manoj Ghosh)</li> 38631 <li>Fix typo <code>remove</code> in rclone_serve_restic command (Joda Stößer)</li> 38632 <li>Fix character that was incorrectly interpreted as markdown (Clément Notin)</li> 38633 </ul></li> 38634 </ul></li> 38635 <li>VFS 38636 <ul> 38637 <li>Fix deadlock caused by cache cleaner and upload finishing (Nick Craig-Wood)</li> 38638 </ul></li> 38639 <li>Local 38640 <ul> 38641 <li>Clean absolute paths (albertony)</li> 38642 <li>Fix -L/--copy-links with filters missing directories (Nick Craig-Wood)</li> 38643 </ul></li> 38644 <li>Mailru 38645 <ul> 38646 <li>Note that an app password is now needed (Nick Craig-Wood)</li> 38647 <li>Allow timestamps to be before the epoch 1970-01-01 (Nick Craig-Wood)</li> 38648 </ul></li> 38649 <li>S3 38650 <ul> 38651 <li>Add provider quirk <code>--s3-might-gzip</code> to fix corrupted on transfer: sizes differ (Nick Craig-Wood)</li> 38652 <li>Allow Storj to server side copy since it seems to work now (Nick Craig-Wood)</li> 38653 <li>Fix for unchecked err value in s3 listv2 (Aaron Gokaslan)</li> 38654 <li>Add additional Wasabi locations (techknowlogick)</li> 38655 </ul></li> 38656 <li>Smb 38657 <ul> 38658 <li>Fix <code>Failed to sync: context canceled</code> at the end of syncs (Nick Craig-Wood)</li> 38659 </ul></li> 38660 <li>WebDAV 38661 <ul> 38662 <li>Fix Move/Copy/DirMove when using -server-side-across-configs (Nick Craig-Wood)</li> 38663 </ul></li> 38664 </ul> 38665 <h2 id="v1.60.0---2022-10-21">v1.60.0 - 2022-10-21</h2> 38666 <p><a href="https://github.com/rclone/rclone/compare/v1.59.0...v1.60.0">See commits</a></p> 38667 <ul> 38668 <li>New backends 38669 <ul> 38670 <li><a href="https://rclone.org/oracleobjectstorage/">Oracle object storage</a> (Manoj Ghosh)</li> 38671 <li><a href="https://rclone.org/smb/">SMB</a> / CIFS (Windows file sharing) (Lesmiscore)</li> 38672 <li>New S3 providers 38673 <ul> 38674 <li><a href="https://rclone.org/s3/#ionos">IONOS Cloud Storage</a> (Dmitry Deniskin)</li> 38675 <li><a href="https://rclone.org/s3/#qiniu">Qiniu KODO</a> (Bachue Zhou)</li> 38676 </ul></li> 38677 </ul></li> 38678 <li>New Features 38679 <ul> 38680 <li>build 38681 <ul> 38682 <li>Update to go1.19 and make go1.17 the minimum required version (Nick Craig-Wood)</li> 38683 <li>Install.sh: fix arm-v7 download (Ole Frost)</li> 38684 </ul></li> 38685 <li>fs: Warn the user when using an existing remote name without a colon (Nick Craig-Wood)</li> 38686 <li>httplib: Add <code>--xxx-min-tls-version</code> option to select minimum TLS version for HTTP servers (Robert Newson)</li> 38687 <li>librclone: Add PHP bindings and test program (Jordi Gonzalez Muñoz)</li> 38688 <li>operations 38689 <ul> 38690 <li>Add <code>--server-side-across-configs</code> global flag for any backend (Nick Craig-Wood)</li> 38691 <li>Optimise <code>--copy-dest</code> and <code>--compare-dest</code> (Nick Craig-Wood)</li> 38692 </ul></li> 38693 <li>rc: add <code>job/stopgroup</code> to stop group (Evan Spensley)</li> 38694 <li>serve dlna 38695 <ul> 38696 <li>Add <code>--announce-interval</code> to control SSDP Announce Interval (YanceyChiew)</li> 38697 <li>Add <code>--interface</code> to Specify SSDP interface names line (Simon Bos)</li> 38698 <li>Add support for more external subtitles (YanceyChiew)</li> 38699 <li>Add verification of addresses (YanceyChiew)</li> 38700 </ul></li> 38701 <li>sync: Optimise <code>--copy-dest</code> and <code>--compare-dest</code> (Nick Craig-Wood)</li> 38702 <li>doc updates (albertony, Alexander Knorr, anonion, João Henrique Franco, Josh Soref, Lorenzo Milesi, Marco Molteni, Mark Trolley, Ole Frost, partev, Ryan Morey, Tom Mombourquette, YFdyh000)</li> 38703 </ul></li> 38704 <li>Bug Fixes 38705 <ul> 38706 <li>filter 38707 <ul> 38708 <li>Fix incorrect filtering with <code>UseFilter</code> context flag and wrapping backends (Nick Craig-Wood)</li> 38709 <li>Make sure we check <code>--files-from</code> when looking for a single file (Nick Craig-Wood)</li> 38710 </ul></li> 38711 <li>rc 38712 <ul> 38713 <li>Fix <code>mount/listmounts</code> not returning the full Fs entered in <code>mount/mount</code> (Tom Mombourquette)</li> 38714 <li>Handle external unmount when mounting (Isaac Aymerich)</li> 38715 <li>Validate Daemon option is not set when mounting a volume via RC (Isaac Aymerich)</li> 38716 </ul></li> 38717 <li>sync: Update docs and error messages to reflect fixes to overlap checks (Nick Naumann)</li> 38718 </ul></li> 38719 <li>VFS 38720 <ul> 38721 <li>Reduce memory use by embedding <code>sync.Cond</code> (Nick Craig-Wood)</li> 38722 <li>Reduce memory usage by re-ordering commonly used structures (Nick Craig-Wood)</li> 38723 <li>Fix excess CPU used by VFS cache cleaner looping (Nick Craig-Wood)</li> 38724 </ul></li> 38725 <li>Local 38726 <ul> 38727 <li>Obey file filters in listing to fix errors on excluded files (Nick Craig-Wood)</li> 38728 <li>Fix "Failed to read metadata: function not implemented" on old Linux kernels (Nick Craig-Wood)</li> 38729 </ul></li> 38730 <li>Compress 38731 <ul> 38732 <li>Fix crash due to nil metadata (Nick Craig-Wood)</li> 38733 <li>Fix error handling to not use or return nil objects (Nick Craig-Wood)</li> 38734 </ul></li> 38735 <li>Drive 38736 <ul> 38737 <li>Make <code>--drive-stop-on-upload-limit</code> obey quota exceeded error (Steve Kowalik)</li> 38738 </ul></li> 38739 <li>FTP 38740 <ul> 38741 <li>Add <code>--ftp-force-list-hidden</code> option to show hidden items (Øyvind Heddeland Instefjord)</li> 38742 <li>Fix hang when using ExplicitTLS to certain servers. (Nick Craig-Wood)</li> 38743 </ul></li> 38744 <li>Google Cloud Storage 38745 <ul> 38746 <li>Add <code>--gcs-endpoint</code> flag and config parameter (Nick Craig-Wood)</li> 38747 </ul></li> 38748 <li>Hubic 38749 <ul> 38750 <li>Remove backend as service has now shut down (Nick Craig-Wood)</li> 38751 </ul></li> 38752 <li>Onedrive 38753 <ul> 38754 <li>Rename Onedrive(cn) 21Vianet to Vnet Group (Yen Hu)</li> 38755 <li>Disable change notify in China region since it is not supported (Nick Craig-Wood)</li> 38756 </ul></li> 38757 <li>S3 38758 <ul> 38759 <li>Implement <code>--s3-versions</code> flag to show old versions of objects if enabled (Nick Craig-Wood)</li> 38760 <li>Implement <code>--s3-version-at</code> flag to show versions of objects at a particular time (Nick Craig-Wood)</li> 38761 <li>Implement <code>backend versioning</code> command to get/set bucket versioning (Nick Craig-Wood)</li> 38762 <li>Implement <code>Purge</code> to purge versions and <code>backend cleanup-hidden</code> (Nick Craig-Wood)</li> 38763 <li>Add <code>--s3-decompress</code> flag to decompress gzip-encoded files (Nick Craig-Wood)</li> 38764 <li>Add <code>--s3-sse-customer-key-base64</code> to supply keys with binary data (Richard Bateman)</li> 38765 <li>Try to keep the maximum precision in ModTime with <code>--user-server-modtime</code> (Nick Craig-Wood)</li> 38766 <li>Drop binary metadata with an ERROR message as it can't be stored (Nick Craig-Wood)</li> 38767 <li>Add <code>--s3-no-system-metadata</code> to suppress read and write of system metadata (Nick Craig-Wood)</li> 38768 </ul></li> 38769 <li>SFTP 38770 <ul> 38771 <li>Fix directory creation races (Lesmiscore)</li> 38772 </ul></li> 38773 <li>Swift 38774 <ul> 38775 <li>Add <code>--swift-no-large-objects</code> to reduce HEAD requests (Nick Craig-Wood)</li> 38776 </ul></li> 38777 <li>Union 38778 <ul> 38779 <li>Propagate SlowHash feature to fix hasher interaction (Lesmiscore)</li> 38780 </ul></li> 38781 </ul> 38782 <h2 id="v1.59.2---2022-09-15">v1.59.2 - 2022-09-15</h2> 38783 <p><a href="https://github.com/rclone/rclone/compare/v1.59.1...v1.59.2">See commits</a></p> 38784 <ul> 38785 <li>Bug Fixes 38786 <ul> 38787 <li>config: Move locking to fix fatal error: concurrent map read and map write (Nick Craig-Wood)</li> 38788 </ul></li> 38789 <li>Local 38790 <ul> 38791 <li>Disable xattr support if the filesystems indicates it is not supported (Nick Craig-Wood)</li> 38792 </ul></li> 38793 <li>Azure Blob 38794 <ul> 38795 <li>Fix chunksize calculations producing too many parts (Nick Craig-Wood)</li> 38796 </ul></li> 38797 <li>B2 38798 <ul> 38799 <li>Fix chunksize calculations producing too many parts (Nick Craig-Wood)</li> 38800 </ul></li> 38801 <li>S3 38802 <ul> 38803 <li>Fix chunksize calculations producing too many parts (Nick Craig-Wood)</li> 38804 </ul></li> 38805 </ul> 38806 <h2 id="v1.59.1---2022-08-08">v1.59.1 - 2022-08-08</h2> 38807 <p><a href="https://github.com/rclone/rclone/compare/v1.59.0...v1.59.1">See commits</a></p> 38808 <ul> 38809 <li>Bug Fixes 38810 <ul> 38811 <li>accounting: Fix panic in core/stats-reset with unknown group (Nick Craig-Wood)</li> 38812 <li>build: Fix android build after GitHub actions change (Nick Craig-Wood)</li> 38813 <li>dlna: Fix SOAP action header parsing (Joram Schrijver)</li> 38814 <li>docs: Fix links to mount command from install docs (albertony)</li> 38815 <li>dropbox: Fix ChangeNotify was unable to decrypt errors (Nick Craig-Wood)</li> 38816 <li>fs: Fix parsing of times and durations of the form "YYYY-MM-DD HH:MM:SS" (Nick Craig-Wood)</li> 38817 <li>serve sftp: Fix checksum detection (Nick Craig-Wood)</li> 38818 <li>sync: Add accidentally missed filter-sensitivity to --backup-dir option (Nick Naumann)</li> 38819 </ul></li> 38820 <li>Combine 38821 <ul> 38822 <li>Fix docs showing <code>remote=</code> instead of <code>upstreams=</code> (Nick Craig-Wood)</li> 38823 <li>Throw error if duplicate directory name is specified (Nick Craig-Wood)</li> 38824 <li>Fix errors with backends shutting down while in use (Nick Craig-Wood)</li> 38825 </ul></li> 38826 <li>Dropbox 38827 <ul> 38828 <li>Fix hang on quit with --dropbox-batch-mode off (Nick Craig-Wood)</li> 38829 <li>Fix infinite loop on uploading a corrupted file (Nick Craig-Wood)</li> 38830 </ul></li> 38831 <li>Internetarchive 38832 <ul> 38833 <li>Ignore checksums for files using the different method (Lesmiscore)</li> 38834 <li>Handle hash symbol in the middle of filename (Lesmiscore)</li> 38835 </ul></li> 38836 <li>Jottacloud 38837 <ul> 38838 <li>Fix working with whitelabel Elgiganten Cloud</li> 38839 <li>Do not store username in config when using standard auth (albertony)</li> 38840 </ul></li> 38841 <li>Mega 38842 <ul> 38843 <li>Fix nil pointer exception when bad node received (Nick Craig-Wood)</li> 38844 </ul></li> 38845 <li>S3 38846 <ul> 38847 <li>Fix --s3-no-head panic: reflect: Elem of invalid type s3.PutObjectInput (Nick Craig-Wood)</li> 38848 </ul></li> 38849 <li>SFTP 38850 <ul> 38851 <li>Fix issue with WS_FTP by working around failing RealPath (albertony)</li> 38852 </ul></li> 38853 <li>Union 38854 <ul> 38855 <li>Fix duplicated files when using directories with leading / (Nick Craig-Wood)</li> 38856 <li>Fix multiple files being uploaded when roots don't exist (Nick Craig-Wood)</li> 38857 <li>Fix panic due to misalignment of struct field in 32 bit architectures (r-ricci)</li> 38858 </ul></li> 38859 </ul> 38860 <h2 id="v1.59.0---2022-07-09">v1.59.0 - 2022-07-09</h2> 38861 <p><a href="https://github.com/rclone/rclone/compare/v1.58.0...v1.59.0">See commits</a></p> 38862 <ul> 38863 <li>New backends 38864 <ul> 38865 <li><a href="/combine">Combine</a> multiple remotes in one directory tree (Nick Craig-Wood)</li> 38866 <li><a href="https://rclone.org/hidrive/">Hidrive</a> (Ovidiu Victor Tatar)</li> 38867 <li><a href="https://rclone.org/internetarchive/">Internet Archive</a> (Lesmiscore (Naoya Ozaki))</li> 38868 <li>New S3 providers 38869 <ul> 38870 <li><a href="https://rclone.org/s3/#arvan-cloud">ArvanCloud AOS</a> (ehsantdy)</li> 38871 <li><a href="https://rclone.org/s3/#cloudflare-r2">Cloudflare R2</a> (Nick Craig-Wood)</li> 38872 <li><a href="https://rclone.org/s3/#huawei-obs">Huawei OBS</a> (m00594701)</li> 38873 <li><a href="https://rclone.org/s3/#idrive-e2">IDrive e2</a> (vyloy)</li> 38874 </ul></li> 38875 </ul></li> 38876 <li>New commands 38877 <ul> 38878 <li><a href="https://rclone.org/commands/rclone_test_makefile/">test makefile</a>: Create a single file for testing (Nick Craig-Wood)</li> 38879 </ul></li> 38880 <li>New Features 38881 <ul> 38882 <li><a href="https://rclone.org/docs/#metadata">Metadata framework</a> to read and write system and user metadata on backends (Nick Craig-Wood) 38883 <ul> 38884 <li>Implemented initially for <code>local</code>, <code>s3</code> and <code>internetarchive</code> backends</li> 38885 <li><code>--metadata</code>/<code>-M</code> flag to control whether metadata is copied</li> 38886 <li><code>--metadata-set</code> flag to specify metadata for uploads</li> 38887 <li>Thanks to <a href="https://manz-solutions.at/">Manz Solutions</a> for sponsoring this work.</li> 38888 </ul></li> 38889 <li>build 38890 <ul> 38891 <li>Update to go1.18 and make go1.16 the minimum required version (Nick Craig-Wood)</li> 38892 <li>Update android go build to 1.18.x and NDK to 23.1.7779620 (Nick Craig-Wood)</li> 38893 <li>All windows binaries now no longer CGO (Nick Craig-Wood)</li> 38894 <li>Add <code>linux/arm/v6</code> to docker images (Nick Craig-Wood)</li> 38895 <li>A huge number of fixes found with <a href="https://staticcheck.io/">staticcheck</a> (albertony)</li> 38896 <li>Configurable version suffix independent of version number (albertony)</li> 38897 </ul></li> 38898 <li>check: Implement <code>--no-traverse</code> and <code>--no-unicode-normalization</code> (Nick Craig-Wood)</li> 38899 <li>config: Readability improvements (albertony)</li> 38900 <li>copyurl: Add <code>--header-filename</code> to honor the HTTP header filename directive (J-P Treen)</li> 38901 <li>filter: Allow multiple <code>--exclude-if-present</code> flags (albertony)</li> 38902 <li>fshttp: Add <code>--disable-http-keep-alives</code> to disable HTTP Keep Alives (Nick Craig-Wood)</li> 38903 <li>install.sh 38904 <ul> 38905 <li>Set the modes on the files and/or directories on macOS (Michael C Tiernan - MIT-Research Computing Project)</li> 38906 <li>Pre verify sudo authorization <code>-v</code> before calling curl. (Michael C Tiernan - MIT-Research Computing Project)</li> 38907 </ul></li> 38908 <li>lib/encoder: Add Semicolon encoding (Nick Craig-Wood)</li> 38909 <li>lsf: Add metadata support with <code>M</code> flag (Nick Craig-Wood)</li> 38910 <li>lsjson: Add <code>--metadata</code>/<code>-M</code> flag (Nick Craig-Wood)</li> 38911 <li>ncdu 38912 <ul> 38913 <li>Implement multi selection (CrossR)</li> 38914 <li>Replace termbox with tcell's termbox wrapper (eNV25)</li> 38915 <li>Display correct path in delete confirmation dialog (Roberto Ricci)</li> 38916 </ul></li> 38917 <li>operations 38918 <ul> 38919 <li>Speed up hash checking by aborting the other hash if first returns nothing (Nick Craig-Wood)</li> 38920 <li>Use correct src/dst in some log messages (zzr93)</li> 38921 </ul></li> 38922 <li>rcat: Check checksums by default like copy does (Nick Craig-Wood)</li> 38923 <li>selfupdate: Replace deprecated <code>x/crypto/openpgp</code> package with <code>ProtonMail/go-crypto</code> (albertony)</li> 38924 <li>serve ftp: Check <code>--passive-port</code> arguments are correct (Nick Craig-Wood)</li> 38925 <li>size: Warn about inaccurate results when objects with unknown size (albertony)</li> 38926 <li>sync: Overlap check is now filter-sensitive so <code>--backup-dir</code> can be in the root provided it is filtered (Nick)</li> 38927 <li>test info: Check file name lengths using 1,2,3,4 byte unicode characters (Nick Craig-Wood)</li> 38928 <li>test makefile(s): <code>--sparse</code>, <code>--zero</code>, <code>--pattern</code>, <code>--ascii</code>, <code>--chargen</code> flags to control file contents (Nick Craig-Wood)</li> 38929 <li>Make sure we call the <code>Shutdown</code> method on backends (Martin Czygan)</li> 38930 </ul></li> 38931 <li>Bug Fixes 38932 <ul> 38933 <li>accounting: Fix unknown length file transfers counting 3 transfers each (buda)</li> 38934 <li>ncdu: Fix issue where dir size is summed when file sizes are -1 (albertony)</li> 38935 <li>sync/copy/move 38936 <ul> 38937 <li>Fix <code>--fast-list</code> <code>--create-empty-src-dirs</code> and <code>--exclude</code> (Nick Craig-Wood)</li> 38938 <li>Fix <code>--max-duration</code> and <code>--cutoff-mode soft</code> (Nick Craig-Wood)</li> 38939 </ul></li> 38940 <li>Fix fs cache unpin (Martin Czygan)</li> 38941 <li>Set proper exit code for errors that are not low-level retried (e.g. size/timestamp changing) (albertony)</li> 38942 </ul></li> 38943 <li>Mount 38944 <ul> 38945 <li>Support <code>windows/arm64</code> (may still be problems - see <a href="https://github.com/rclone/rclone/issues/5828">#5828</a>) (Nick Craig-Wood)</li> 38946 <li>Log IO errors at ERROR level (Nick Craig-Wood)</li> 38947 <li>Ignore <code>_netdev</code> mount argument (Hugal31)</li> 38948 </ul></li> 38949 <li>VFS 38950 <ul> 38951 <li>Add <code>--vfs-fast-fingerprint</code> for less accurate but faster fingerprints (Nick Craig-Wood)</li> 38952 <li>Add <code>--vfs-disk-space-total-size</code> option to manually set the total disk space (Claudio Maradonna)</li> 38953 <li>vfscache: Fix fatal error: sync: unlock of unlocked mutex error (Nick Craig-Wood)</li> 38954 </ul></li> 38955 <li>Local 38956 <ul> 38957 <li>Fix parsing of <code>--local-nounc</code> flag (Nick Craig-Wood)</li> 38958 <li>Add Metadata support (Nick Craig-Wood)</li> 38959 </ul></li> 38960 <li>Crypt 38961 <ul> 38962 <li>Support metadata (Nick Craig-Wood)</li> 38963 </ul></li> 38964 <li>Azure Blob 38965 <ul> 38966 <li>Calculate Chunksize/blocksize to stay below maxUploadParts (Leroy van Logchem)</li> 38967 <li>Use chunksize lib to determine chunksize dynamically (Derek Battams)</li> 38968 <li>Case insensitive access tier (Rob Pickerill)</li> 38969 <li>Allow remote emulator (azurite) (Lorenzo Maiorfi)</li> 38970 </ul></li> 38971 <li>B2 38972 <ul> 38973 <li>Add <code>--b2-version-at</code> flag to show file versions at time specified (SwazRGB)</li> 38974 <li>Use chunksize lib to determine chunksize dynamically (Derek Battams)</li> 38975 </ul></li> 38976 <li>Chunker 38977 <ul> 38978 <li>Mark as not supporting metadata (Nick Craig-Wood)</li> 38979 </ul></li> 38980 <li>Compress 38981 <ul> 38982 <li>Support metadata (Nick Craig-Wood)</li> 38983 </ul></li> 38984 <li>Drive 38985 <ul> 38986 <li>Make <code>backend config -o config</code> add a combined <code>AllDrives:</code> remote (Nick Craig-Wood)</li> 38987 <li>Make <code>--drive-shared-with-me</code> work with shared drives (Nick Craig-Wood)</li> 38988 <li>Add <code>--drive-resource-key</code> for accessing link-shared files (Nick Craig-Wood)</li> 38989 <li>Add backend commands <code>exportformats</code> and <code>importformats</code> for debugging (Nick Craig-Wood)</li> 38990 <li>Fix 404 errors on copy/server side copy objects from public folder (Nick Craig-Wood)</li> 38991 <li>Update Internal OAuth consent screen docs (Phil Shackleton)</li> 38992 <li>Moved <code>root_folder_id</code> to advanced section (Abhiraj)</li> 38993 </ul></li> 38994 <li>Dropbox 38995 <ul> 38996 <li>Migrate from deprecated api (m8rge)</li> 38997 <li>Add logs to show when poll interval limits are exceeded (Nick Craig-Wood)</li> 38998 <li>Fix nil pointer exception on dropbox impersonate user not found (Nick Craig-Wood)</li> 38999 </ul></li> 39000 <li>Fichier 39001 <ul> 39002 <li>Parse api error codes and them accordingly (buengese)</li> 39003 </ul></li> 39004 <li>FTP 39005 <ul> 39006 <li>Add support for <code>disable_utf8</code> option (Jason Zheng)</li> 39007 <li>Revert to upstream <code>github.com/jlaffaye/ftp</code> from our fork (Nick Craig-Wood)</li> 39008 </ul></li> 39009 <li>Google Cloud Storage 39010 <ul> 39011 <li>Add <code>--gcs-no-check-bucket</code> to minimise transactions and perms (Nick Gooding)</li> 39012 <li>Add <code>--gcs-decompress</code> flag to decompress gzip-encoded files (Nick Craig-Wood) 39013 <ul> 39014 <li>by default these will be downloaded compressed (which previously failed)</li> 39015 </ul></li> 39016 </ul></li> 39017 <li>Hasher 39018 <ul> 39019 <li>Support metadata (Nick Craig-Wood)</li> 39020 </ul></li> 39021 <li>HTTP 39022 <ul> 39023 <li>Fix missing response when using custom auth handler (albertony)</li> 39024 </ul></li> 39025 <li>Jottacloud 39026 <ul> 39027 <li>Add support for upload to custom device and mountpoint (albertony)</li> 39028 <li>Always store username in config and use it to avoid initial API request (albertony)</li> 39029 <li>Fix issue with server-side copy when destination is in trash (albertony)</li> 39030 <li>Fix listing output of remote with special characters (albertony)</li> 39031 </ul></li> 39032 <li>Mailru 39033 <ul> 39034 <li>Fix timeout by using int instead of time.Duration for keeping number of seconds (albertony)</li> 39035 </ul></li> 39036 <li>Mega 39037 <ul> 39038 <li>Document using MEGAcmd to help with login failures (Art M. Gallagher)</li> 39039 </ul></li> 39040 <li>Onedrive 39041 <ul> 39042 <li>Implement <code>--poll-interval</code> for onedrive (Hugo Laloge)</li> 39043 <li>Add access scopes option (Sven Gerber)</li> 39044 </ul></li> 39045 <li>Opendrive 39046 <ul> 39047 <li>Resolve lag and truncate bugs (Scott Grimes)</li> 39048 </ul></li> 39049 <li>Pcloud 39050 <ul> 39051 <li>Fix about with no free space left (buengese)</li> 39052 <li>Fix cleanup (buengese)</li> 39053 </ul></li> 39054 <li>S3 39055 <ul> 39056 <li>Use PUT Object instead of presigned URLs to upload single part objects (Nick Craig-Wood)</li> 39057 <li>Backend restore command to skip non-GLACIER objects (Vincent Murphy)</li> 39058 <li>Use chunksize lib to determine chunksize dynamically (Derek Battams)</li> 39059 <li>Retry RequestTimeout errors (Nick Craig-Wood)</li> 39060 <li>Implement reading and writing of metadata (Nick Craig-Wood)</li> 39061 </ul></li> 39062 <li>SFTP 39063 <ul> 39064 <li>Add support for about and hashsum on windows server (albertony)</li> 39065 <li>Use vendor-specific VFS statistics extension for about if available (albertony)</li> 39066 <li>Add <code>--sftp-chunk-size</code> to control packets sizes for high latency links (Nick Craig-Wood)</li> 39067 <li>Add <code>--sftp-concurrency</code> to improve high latency transfers (Nick Craig-Wood)</li> 39068 <li>Add <code>--sftp-set-env</code> option to set environment variables (Nick Craig-Wood)</li> 39069 <li>Add Hetzner Storage Boxes to supported sftp backends (Anthrazz)</li> 39070 </ul></li> 39071 <li>Storj 39072 <ul> 39073 <li>Fix put which lead to the file being unreadable when using mount (Erik van Velzen)</li> 39074 </ul></li> 39075 <li>Union 39076 <ul> 39077 <li>Add <code>min_free_space</code> option for <code>lfs</code>/<code>eplfs</code> policies (Nick Craig-Wood)</li> 39078 <li>Fix uploading files to union of all bucket based remotes (Nick Craig-Wood)</li> 39079 <li>Fix get free space for remotes which don't support it (Nick Craig-Wood)</li> 39080 <li>Fix <code>eplus</code> policy to select correct entry for existing files (Nick Craig-Wood)</li> 39081 <li>Support metadata (Nick Craig-Wood)</li> 39082 </ul></li> 39083 <li>Uptobox 39084 <ul> 39085 <li>Fix root path handling (buengese)</li> 39086 </ul></li> 39087 <li>WebDAV 39088 <ul> 39089 <li>Add SharePoint in other specific regions support (Noah Hsu)</li> 39090 </ul></li> 39091 <li>Yandex 39092 <ul> 39093 <li>Handle api error on server-side move (albertony)</li> 39094 </ul></li> 39095 <li>Zoho 39096 <ul> 39097 <li>Add Japan and China regions (buengese)</li> 39098 </ul></li> 39099 </ul> 39100 <h2 id="v1.58.1---2022-04-29">v1.58.1 - 2022-04-29</h2> 39101 <p><a href="https://github.com/rclone/rclone/compare/v1.58.0...v1.58.1">See commits</a></p> 39102 <ul> 39103 <li>Bug Fixes 39104 <ul> 39105 <li>build: Update github.com/billziss-gh to github.com/winfsp (Nick Craig-Wood)</li> 39106 <li>filter: Fix timezone of <code>--min-age</code>/<code>-max-age</code> from UTC to local as documented (Nick Craig-Wood)</li> 39107 <li>rc/js: Correct RC method names (Sơn Trần-Nguyễn)</li> 39108 <li>docs 39109 <ul> 39110 <li>Fix some links to command pages (albertony)</li> 39111 <li>Add <code>--multi-thread-streams</code> note to <code>--transfers</code>. (Zsolt Ero)</li> 39112 </ul></li> 39113 </ul></li> 39114 <li>Mount 39115 <ul> 39116 <li>Fix <code>--devname</code> and fusermount: unknown option 'fsname' when mounting via rc (Nick Craig-Wood)</li> 39117 </ul></li> 39118 <li>VFS 39119 <ul> 39120 <li>Remove wording which suggests VFS is only for mounting (Nick Craig-Wood)</li> 39121 </ul></li> 39122 <li>Dropbox 39123 <ul> 39124 <li>Fix retries of multipart uploads with incorrect_offset error (Nick Craig-Wood)</li> 39125 </ul></li> 39126 <li>Google Cloud Storage 39127 <ul> 39128 <li>Use the s3 pacer to speed up transactions (Nick Craig-Wood)</li> 39129 <li>pacer: Default the Google pacer to a burst of 100 to fix gcs pacing (Nick Craig-Wood)</li> 39130 </ul></li> 39131 <li>Jottacloud 39132 <ul> 39133 <li>Fix scope in token request (albertony)</li> 39134 </ul></li> 39135 <li>Netstorage 39136 <ul> 39137 <li>Fix unescaped HTML in documentation (Nick Craig-Wood)</li> 39138 <li>Make levels of headings consistent (Nick Craig-Wood)</li> 39139 <li>Add support contacts to netstorage doc (Nil Alexandrov)</li> 39140 </ul></li> 39141 <li>Onedrive 39142 <ul> 39143 <li>Note that sharepoint also changes web files (.html, .aspx) (GH)</li> 39144 </ul></li> 39145 <li>Putio 39146 <ul> 39147 <li>Handle rate limit errors (Berkan Teber)</li> 39148 <li>Fix multithread download and other ranged requests (rafma0)</li> 39149 </ul></li> 39150 <li>S3 39151 <ul> 39152 <li>Add ChinaMobile EOS to provider list (GuoXingbin)</li> 39153 <li>Sync providers in config description with providers (Nick Craig-Wood)</li> 39154 </ul></li> 39155 <li>SFTP 39156 <ul> 39157 <li>Fix OpenSSH 8.8+ RSA keys incompatibility (KARBOWSKI Piotr)</li> 39158 <li>Note that Scaleway C14 is deprecating SFTP in favor of S3 (Adrien Rey-Jarthon)</li> 39159 </ul></li> 39160 <li>Storj 39161 <ul> 39162 <li>Fix bucket creation on Move (Nick Craig-Wood)</li> 39163 </ul></li> 39164 <li>WebDAV 39165 <ul> 39166 <li>Don't override Referer if user sets it (Nick Craig-Wood)</li> 39167 </ul></li> 39168 </ul> 39169 <h2 id="v1.58.0---2022-03-18">v1.58.0 - 2022-03-18</h2> 39170 <p><a href="https://github.com/rclone/rclone/compare/v1.57.0...v1.58.0">See commits</a></p> 39171 <ul> 39172 <li>New backends 39173 <ul> 39174 <li><a href="/netstorage">Akamai Netstorage</a> (Nil Alexandrov)</li> 39175 <li><a href="https://rclone.org/s3/#lyve">Seagate Lyve</a>, <a href="/s3/#seaweedfs">SeaweedFS</a>, <a href="/s3/#storj">Storj</a>, <a href="/s3/#RackCorp">RackCorp</a> via s3 backend</li> 39176 <li><a href="https://rclone.org/storj/">Storj</a> (renamed from Tardigrade - your old config files will continue working)</li> 39177 </ul></li> 39178 <li>New commands 39179 <ul> 39180 <li><a href="https://rclone.org/bisync/">bisync</a> - experimental bidirectional cloud sync (Ivan Andreev, Chris Nelson)</li> 39181 </ul></li> 39182 <li>New Features 39183 <ul> 39184 <li>build 39185 <ul> 39186 <li>Add <code>windows/arm64</code> build (<code>rclone mount</code> not supported yet) (Nick Craig-Wood)</li> 39187 <li>Raise minimum go version to go1.15 (Nick Craig-Wood)</li> 39188 </ul></li> 39189 <li>config: Allow dot in remote names and improve config editing (albertony)</li> 39190 <li>dedupe: Add quit as a choice in interactive mode (albertony)</li> 39191 <li>dlna: Change icons to the newest ones. (Alain Nussbaumer)</li> 39192 <li>filter: Add <a href="https://rclone.org/filtering/#regexp"><code>{{ regexp }}</code> syntax</a> to pattern matches (Nick Craig-Wood)</li> 39193 <li>fshttp: Add prometheus metrics for HTTP status code (Michał Matczuk)</li> 39194 <li>hashsum: Support creating hash from data received on stdin (albertony)</li> 39195 <li>librclone 39196 <ul> 39197 <li>Allow empty string or null input instead of empty json object (albertony)</li> 39198 <li>Add support for mount commands (albertony)</li> 39199 </ul></li> 39200 <li>operations: Add server-side moves to stats (Ole Frost)</li> 39201 <li>rc: Allow user to disable authentication for web gui (negative0)</li> 39202 <li>tree: Remove obsolete <code>--human</code> replaced by global <code>--human-readable</code> (albertony)</li> 39203 <li>version: Report correct friendly-name for newer Windows 10/11 versions (albertony)</li> 39204 </ul></li> 39205 <li>Bug Fixes 39206 <ul> 39207 <li>build 39208 <ul> 39209 <li>Fix ARM architecture version in .deb packages after nfpm change (Nick Craig-Wood)</li> 39210 <li>Hard fork <code>github.com/jlaffaye/ftp</code> to fix <code>go get github.com/rclone/rclone</code> (Nick Craig-Wood)</li> 39211 </ul></li> 39212 <li>oauthutil: Fix crash when webbrowser requests <code>/robots.txt</code> (Nick Craig-Wood)</li> 39213 <li>operations: Fix goroutine leak in case of copy retry (Ankur Gupta)</li> 39214 <li>rc: 39215 <ul> 39216 <li>Fix <code>operations/publiclink</code> default for <code>expires</code> parameter (Nick Craig-Wood)</li> 39217 <li>Fix missing computation of <code>transferQueueSize</code> when summing up statistics group (Carlo Mion)</li> 39218 <li>Fix missing <code>StatsInfo</code> fields in the computation of the group sum (Carlo Mion)</li> 39219 </ul></li> 39220 <li>sync: Fix <code>--max-duration</code> so it doesn't retry when the duration is exceeded (Nick Craig-Wood)</li> 39221 <li>touch: Fix issue where a directory is created instead of a file (albertony)</li> 39222 </ul></li> 39223 <li>Mount 39224 <ul> 39225 <li>Add <code>--devname</code> to set the device name sent to FUSE for mount display (Nick Craig-Wood)</li> 39226 </ul></li> 39227 <li>VFS 39228 <ul> 39229 <li>Add <code>vfs/stats</code> remote control to show statistics (Nick Craig-Wood)</li> 39230 <li>Fix <code>failed to _ensure cache internal error: downloaders is nil error</code> (Nick Craig-Wood)</li> 39231 <li>Fix handling of special characters in file names (Bumsu Hyeon)</li> 39232 </ul></li> 39233 <li>Local 39234 <ul> 39235 <li>Fix hash invalidation which caused errors with local crypt mount (Nick Craig-Wood)</li> 39236 </ul></li> 39237 <li>Crypt 39238 <ul> 39239 <li>Add <code>base64</code> and <code>base32768</code> filename encoding options (Max Sum, Sinan Tan)</li> 39240 </ul></li> 39241 <li>Azure Blob 39242 <ul> 39243 <li>Implement <code>--azureblob-upload-concurrency</code> parameter to speed uploads (Nick Craig-Wood)</li> 39244 <li>Remove 100MB upper limit on <code>chunk_size</code> as it is no longer needed (Nick Craig-Wood)</li> 39245 <li>Raise <code>--azureblob-upload-concurrency</code> to 16 by default (Nick Craig-Wood)</li> 39246 <li>Fix crash with SAS URL and no container (Nick Craig-Wood)</li> 39247 </ul></li> 39248 <li>Compress 39249 <ul> 39250 <li>Fix crash if metadata upload failed (Nick Craig-Wood)</li> 39251 <li>Fix memory leak (Nick Craig-Wood)</li> 39252 </ul></li> 39253 <li>Drive 39254 <ul> 39255 <li>Added <code>--drive-copy-shortcut-content</code> (Abhiraj)</li> 39256 <li>Disable OAuth OOB flow (copy a token) due to Google deprecation (Nick Craig-Wood) 39257 <ul> 39258 <li>See <a href="https://developers.googleblog.com/2022/02/making-oauth-flows-safer.html#disallowed-oob">the deprecation note</a>.</li> 39259 </ul></li> 39260 <li>Add <code>--drive-skip-dangling-shortcuts</code> flag (Nick Craig-Wood)</li> 39261 <li>When using a link type <code>--drive-export-formats</code> shows all doc types (Nick Craig-Wood)</li> 39262 </ul></li> 39263 <li>Dropbox 39264 <ul> 39265 <li>Speed up directory listings by specifying 1000 items in a chunk (Nick Craig-Wood)</li> 39266 <li>Save an API request when at the root (Nick Craig-Wood)</li> 39267 </ul></li> 39268 <li>Fichier 39269 <ul> 39270 <li>Implemented About functionality (Gourav T)</li> 39271 </ul></li> 39272 <li>FTP 39273 <ul> 39274 <li>Add <code>--ftp-ask-password</code> to prompt for password when needed (Borna Butkovic)</li> 39275 </ul></li> 39276 <li>Google Cloud Storage 39277 <ul> 39278 <li>Add missing regions (Nick Craig-Wood)</li> 39279 <li>Disable OAuth OOB flow (copy a token) due to Google deprecation (Nick Craig-Wood) 39280 <ul> 39281 <li>See <a href="https://developers.googleblog.com/2022/02/making-oauth-flows-safer.html#disallowed-oob">the deprecation note</a>.</li> 39282 </ul></li> 39283 </ul></li> 39284 <li>Googlephotos 39285 <ul> 39286 <li>Disable OAuth OOB flow (copy a token) due to Google deprecation (Nick Craig-Wood) 39287 <ul> 39288 <li>See <a href="https://developers.googleblog.com/2022/02/making-oauth-flows-safer.html#disallowed-oob">the deprecation note</a>.</li> 39289 </ul></li> 39290 </ul></li> 39291 <li>Hasher 39292 <ul> 39293 <li>Fix crash on object not found (Nick Craig-Wood)</li> 39294 </ul></li> 39295 <li>Hdfs 39296 <ul> 39297 <li>Add file (Move) and directory move (DirMove) support (Andy Jackson)</li> 39298 </ul></li> 39299 <li>HTTP 39300 <ul> 39301 <li>Improved recognition of URL pointing to a single file (albertony)</li> 39302 </ul></li> 39303 <li>Jottacloud 39304 <ul> 39305 <li>Change API used by recursive list (ListR) (Kim)</li> 39306 <li>Add support for Tele2 Cloud (Fredric Arklid)</li> 39307 </ul></li> 39308 <li>Koofr 39309 <ul> 39310 <li>Add Digistorage service as a Koofr provider. (jaKa)</li> 39311 </ul></li> 39312 <li>Mailru 39313 <ul> 39314 <li>Fix int32 overflow on arm32 (Ivan Andreev)</li> 39315 </ul></li> 39316 <li>Onedrive 39317 <ul> 39318 <li>Add config option for oauth scope <code>Sites.Read.All</code> (Charlie Jiang)</li> 39319 <li>Minor optimization of quickxorhash (Isaac Levy)</li> 39320 <li>Add <code>--onedrive-root-folder-id</code> flag (Nick Craig-Wood)</li> 39321 <li>Do not retry on <code>400 pathIsTooLong</code> error (ctrl-q)</li> 39322 </ul></li> 39323 <li>Pcloud 39324 <ul> 39325 <li>Add support for recursive list (ListR) (Niels van de Weem)</li> 39326 <li>Fix pre-1970 time stamps (Nick Craig-Wood)</li> 39327 </ul></li> 39328 <li>S3 39329 <ul> 39330 <li>Use <code>ListObjectsV2</code> for faster listings (Felix Bünemann) 39331 <ul> 39332 <li>Fallback to <code>ListObject</code> v1 on unsupported providers (Nick Craig-Wood)</li> 39333 </ul></li> 39334 <li>Use the <code>ETag</code> on multipart transfers to verify the transfer was OK (Nick Craig-Wood) 39335 <ul> 39336 <li>Add <code>--s3-use-multipart-etag</code> provider quirk to disable this on unsupported providers (Nick Craig-Wood)</li> 39337 </ul></li> 39338 <li>New Providers 39339 <ul> 39340 <li>RackCorp object storage (bbabich)</li> 39341 <li>Seagate Lyve Cloud storage (Nick Craig-Wood)</li> 39342 <li>SeaweedFS (Chris Lu)</li> 39343 <li>Storj Shared gateways (Márton Elek, Nick Craig-Wood)</li> 39344 </ul></li> 39345 <li>Add Wasabi AP Northeast 2 endpoint info (lindwurm)</li> 39346 <li>Add <code>GLACIER_IR</code> storage class (Yunhai Luo)</li> 39347 <li>Document <code>Content-MD5</code> workaround for object-lock enabled buckets (Paulo Martins)</li> 39348 <li>Fix multipart upload with <code>--no-head</code> flag (Nick Craig-Wood)</li> 39349 <li>Simplify content length processing in s3 with download url (Logeshwaran Murugesan)</li> 39350 </ul></li> 39351 <li>SFTP 39352 <ul> 39353 <li>Add rclone to list of supported <code>md5sum</code>/<code>sha1sum</code> commands to look for (albertony)</li> 39354 <li>Refactor so we only have one way of running remote commands (Nick Craig-Wood)</li> 39355 <li>Fix timeout on hashing large files by sending keepalives (Nick Craig-Wood)</li> 39356 <li>Fix unnecessary seeking when uploading and downloading files (Nick Craig-Wood)</li> 39357 <li>Update docs on how to create <code>known_hosts</code> file (Nick Craig-Wood)</li> 39358 </ul></li> 39359 <li>Storj 39360 <ul> 39361 <li>Rename tardigrade backend to storj backend (Nick Craig-Wood)</li> 39362 <li>Implement server side Move for files (Nick Craig-Wood)</li> 39363 <li>Update docs to explain differences between s3 and this backend (Elek, Márton)</li> 39364 </ul></li> 39365 <li>Swift 39366 <ul> 39367 <li>Fix About so it shows info about the current container only (Nick Craig-Wood)</li> 39368 </ul></li> 39369 <li>Union 39370 <ul> 39371 <li>Fix treatment of remotes with <code>//</code> in (Nick Craig-Wood)</li> 39372 <li>Fix deadlock when one part of a multi-upload fails (Nick Craig-Wood)</li> 39373 <li>Fix eplus policy returned nil (Vitor Arruda)</li> 39374 </ul></li> 39375 <li>Yandex 39376 <ul> 39377 <li>Add permanent deletion support (deinferno)</li> 39378 </ul></li> 39379 </ul> 39380 <h2 id="v1.57.0---2021-11-01">v1.57.0 - 2021-11-01</h2> 39381 <p><a href="https://github.com/rclone/rclone/compare/v1.56.0...v1.57.0">See commits</a></p> 39382 <ul> 39383 <li>New backends 39384 <ul> 39385 <li>Sia: for Sia decentralized cloud (Ian Levesque, Matthew Sevey, Ivan Andreev)</li> 39386 <li>Hasher: caches hashes and enable hashes for backends that don't support them (Ivan Andreev)</li> 39387 </ul></li> 39388 <li>New commands 39389 <ul> 39390 <li>lsjson --stat: to get info about a single file/dir and <code>operations/stat</code> api (Nick Craig-Wood)</li> 39391 <li>config paths: show configured paths (albertony)</li> 39392 </ul></li> 39393 <li>New Features 39394 <ul> 39395 <li>about: Make human-readable output more consistent with other commands (albertony)</li> 39396 <li>build 39397 <ul> 39398 <li>Use go1.17 for building and make go1.14 the minimum supported (Nick Craig-Wood)</li> 39399 <li>Update Go to 1.16 and NDK to 22b for Android builds (x0b)</li> 39400 </ul></li> 39401 <li>config 39402 <ul> 39403 <li>Support hyphen in remote name from environment variable (albertony)</li> 39404 <li>Make temporary directory user-configurable (albertony)</li> 39405 <li>Convert <code>--cache-dir</code> value to an absolute path (albertony)</li> 39406 <li>Do not override MIME types from OS defaults (albertony)</li> 39407 </ul></li> 39408 <li>docs 39409 <ul> 39410 <li>Toc styling and header levels cleanup (albertony)</li> 39411 <li>Extend documentation on valid remote names (albertony)</li> 39412 <li>Mention make for building and cmount tag for macos (Alex Chen)</li> 39413 <li>...and many more contributions to numerous to mention!</li> 39414 </ul></li> 39415 <li>fs: Move with <code>--ignore-existing</code> will not delete skipped files (Nathan Collins)</li> 39416 <li>hashsum 39417 <ul> 39418 <li>Treat hash values in sum file as case insensitive (Ivan Andreev)</li> 39419 <li>Don't put <code>ERROR</code> or <code>UNSUPPORTED</code> in output (Ivan Andreev)</li> 39420 </ul></li> 39421 <li>lib/encoder: Add encoding of square brackets (Ivan Andreev)</li> 39422 <li>lib/file: Improve error message when attempting to create dir on nonexistent drive on windows (albertony)</li> 39423 <li>lib/http: Factor password hash salt into options with default (Nolan Woods)</li> 39424 <li>lib/kv: Add key-value database api (Ivan Andreev)</li> 39425 <li>librclone 39426 <ul> 39427 <li>Add <code>RcloneFreeString</code> function (albertony)</li> 39428 <li>Free strings in python example (albertony)</li> 39429 </ul></li> 39430 <li>log: Optionally print pid in logs (Ivan Andreev)</li> 39431 <li>ls: Introduce <code>--human-readable</code> global option to print human-readable sizes (albertony)</li> 39432 <li>ncdu: Introduce key <code>u</code> to toggle human-readable (albertony)</li> 39433 <li>operations: Add <code>rmdirs -v</code> output (Justin Winokur)</li> 39434 <li>serve sftp 39435 <ul> 39436 <li>Generate an ECDSA server key as well as RSA (Nick Craig-Wood)</li> 39437 <li>Generate an Ed25519 server key as well as ECDSA and RSA (albertony)</li> 39438 </ul></li> 39439 <li>serve docker 39440 <ul> 39441 <li>Allow to customize proxy settings of docker plugin (Ivan Andreev)</li> 39442 <li>Build docker plugin for multiple platforms (Thomas Stachl)</li> 39443 </ul></li> 39444 <li>size: Include human-readable count (albertony)</li> 39445 <li>touch: Add support for touching files in directory, with recursive option, filtering and <code>--dry-run</code>/<code>-i</code> (albertony)</li> 39446 <li>tree: Option to print human-readable sizes removed in favor of global option (albertony)</li> 39447 </ul></li> 39448 <li>Bug Fixes 39449 <ul> 39450 <li>lib/http 39451 <ul> 39452 <li>Fix bad username check in single auth secret provider (Nolan Woods)</li> 39453 <li>Fix handling of SSL credentials (Nolan Woods)</li> 39454 </ul></li> 39455 <li>serve ftp: Ensure modtime is passed as UTC always to fix timezone oddities (Nick Craig-Wood)</li> 39456 <li>serve sftp: Fix generation of server keys on windows (albertony)</li> 39457 <li>serve docker: Fix octal umask (Ivan Andreev)</li> 39458 </ul></li> 39459 <li>Mount 39460 <ul> 39461 <li>Enable rclone to be run as mount helper direct from the fstab (Ivan Andreev)</li> 39462 <li>Use procfs to validate mount on linux (Ivan Andreev)</li> 39463 <li>Correctly daemonize for compatibility with automount (Ivan Andreev)</li> 39464 </ul></li> 39465 <li>VFS 39466 <ul> 39467 <li>Ensure names used in cache path are legal on current OS (albertony)</li> 39468 <li>Ignore <code>ECLOSED</code> when truncating file handles to fix intermittent bad file descriptor error (Nick Craig-Wood)</li> 39469 </ul></li> 39470 <li>Local 39471 <ul> 39472 <li>Refactor default OS encoding out from local backend into shared encoder lib (albertony)</li> 39473 </ul></li> 39474 <li>Crypt 39475 <ul> 39476 <li>Return wrapped object even with <code>--crypt-no-data-encryption</code> (Ivan Andreev)</li> 39477 <li>Fix uploads with <code>--crypt-no-data-encryption</code> (Nick Craig-Wood)</li> 39478 </ul></li> 39479 <li>Azure Blob 39480 <ul> 39481 <li>Add <code>--azureblob-no-head-object</code> (Tatsuya Noyori)</li> 39482 </ul></li> 39483 <li>Box 39484 <ul> 39485 <li>Make listings of heavily used directories more reliable (Nick Craig-Wood)</li> 39486 <li>When doing cleanup delete as much as possible (Nick Craig-Wood)</li> 39487 <li>Add <code>--box-list-chunk</code> to control listing chunk size (Nick Craig-Wood)</li> 39488 <li>Delete items in parallel in cleanup using <code>--checkers</code> threads (Nick Craig-Wood)</li> 39489 <li>Add <code>--box-owned-by</code> to only show items owned by the login passed (Nick Craig-Wood)</li> 39490 <li>Retry <code>operation_blocked_temporary</code> errors (Nick Craig-Wood)</li> 39491 </ul></li> 39492 <li>Chunker 39493 <ul> 39494 <li>Md5all must create metadata if base hash is slow (Ivan Andreev)</li> 39495 </ul></li> 39496 <li>Drive 39497 <ul> 39498 <li>Speed up directory listings by constraining the API listing using the current filters (fotile96, Ivan Andreev)</li> 39499 <li>Fix buffering for single request upload for files smaller than <code>--drive-upload-cutoff</code> (YenForYang)</li> 39500 <li>Add <code>-o config</code> option to <code>backend drives</code> to make config for all shared drives (Nick Craig-Wood)</li> 39501 </ul></li> 39502 <li>Dropbox 39503 <ul> 39504 <li>Add <code>--dropbox-batch-commit-timeout</code> to control batch timeout (Nick Craig-Wood)</li> 39505 </ul></li> 39506 <li>Filefabric 39507 <ul> 39508 <li>Make backoff exponential for error_background to fix errors (Nick Craig-Wood)</li> 39509 <li>Fix directory move after API change (Nick Craig-Wood)</li> 39510 </ul></li> 39511 <li>FTP 39512 <ul> 39513 <li>Enable tls session cache by default (Ivan Andreev)</li> 39514 <li>Add option to disable tls13 (Ivan Andreev)</li> 39515 <li>Fix timeout after long uploads (Ivan Andreev)</li> 39516 <li>Add support for precise time (Ivan Andreev)</li> 39517 <li>Enable CI for ProFtpd, PureFtpd, VsFtpd (Ivan Andreev)</li> 39518 </ul></li> 39519 <li>Googlephotos 39520 <ul> 39521 <li>Use encoder for album names to fix albums with control characters (Parth Shukla)</li> 39522 </ul></li> 39523 <li>Jottacloud 39524 <ul> 39525 <li>Implement <code>SetModTime</code> to support modtime-only changes (albertony)</li> 39526 <li>Improved error handling with <code>SetModTime</code> and corrupt files in general (albertony)</li> 39527 <li>Add support for <code>UserInfo</code> (<code>rclone config userinfo</code>) feature (albertony)</li> 39528 <li>Return direct download link from <code>rclone link</code> command (albertony)</li> 39529 </ul></li> 39530 <li>Koofr 39531 <ul> 39532 <li>Create direct share link (Dmitry Bogatov)</li> 39533 </ul></li> 39534 <li>Pcloud 39535 <ul> 39536 <li>Add sha256 support (Ken Enrique Morel)</li> 39537 </ul></li> 39538 <li>Premiumizeme 39539 <ul> 39540 <li>Fix directory listing after API changes (Nick Craig-Wood)</li> 39541 <li>Fix server side move after API change (Nick Craig-Wood)</li> 39542 <li>Fix server side directory move after API changes (Nick Craig-Wood)</li> 39543 </ul></li> 39544 <li>S3 39545 <ul> 39546 <li>Add support to use CDN URL to download the file (Logeshwaran)</li> 39547 <li>Add AWS Snowball Edge to providers examples (r0kk3rz)</li> 39548 <li>Use a combination of SDK retries and rclone retries (Nick Craig-Wood)</li> 39549 <li>Fix IAM Role for Service Account not working and other auth problems (Nick Craig-Wood)</li> 39550 <li>Fix <code>shared_credentials_file</code> auth after reverting incorrect fix (Nick Craig-Wood)</li> 39551 <li>Fix corrupted on transfer: sizes differ 0 vs xxxx with Ceph (Nick Craig-Wood)</li> 39552 </ul></li> 39553 <li>Seafile 39554 <ul> 39555 <li>Fix error when not configured for 2fa (Fred)</li> 39556 </ul></li> 39557 <li>SFTP 39558 <ul> 39559 <li>Fix timeout when doing MD5SUM of large file (Nick Craig-Wood)</li> 39560 </ul></li> 39561 <li>Swift 39562 <ul> 39563 <li>Update OCI URL (David Liu)</li> 39564 <li>Document OVH Cloud Archive (HNGamingUK)</li> 39565 </ul></li> 39566 <li>Union 39567 <ul> 39568 <li>Fix rename not working with union of local disk and bucket based remote (Nick Craig-Wood)</li> 39569 </ul></li> 39570 </ul> 39571 <h2 id="v1.56.2---2021-10-01">v1.56.2 - 2021-10-01</h2> 39572 <p><a href="https://github.com/rclone/rclone/compare/v1.56.1...v1.56.2">See commits</a></p> 39573 <ul> 39574 <li>Bug Fixes 39575 <ul> 39576 <li>serve http: Re-add missing auth to http service (Nolan Woods)</li> 39577 <li>build: Update golang.org/x/sys to fix crash on macOS when compiled with go1.17 (Herby Gillot)</li> 39578 </ul></li> 39579 <li>FTP 39580 <ul> 39581 <li>Fix deadlock after failed update when concurrency=1 (Ivan Andreev)</li> 39582 </ul></li> 39583 </ul> 39584 <h2 id="v1.56.1---2021-09-19">v1.56.1 - 2021-09-19</h2> 39585 <p><a href="https://github.com/rclone/rclone/compare/v1.56.0...v1.56.1">See commits</a></p> 39586 <ul> 39587 <li>Bug Fixes 39588 <ul> 39589 <li>accounting: Fix maximum bwlimit by scaling scale max token bucket size (Nick Craig-Wood)</li> 39590 <li>rc: Fix speed does not update in core/stats (negative0)</li> 39591 <li>selfupdate: Fix <code>--quiet</code> option, not quite quiet (yedamo)</li> 39592 <li>serve http: Fix <code>serve http</code> exiting directly after starting (Cnly)</li> 39593 <li>build 39594 <ul> 39595 <li>Apply gofmt from golang 1.17 (Ivan Andreev)</li> 39596 <li>Update Go to 1.16 and NDK to 22b for android/any (x0b)</li> 39597 </ul></li> 39598 </ul></li> 39599 <li>Mount 39600 <ul> 39601 <li>Fix <code>--daemon</code> mode (Ivan Andreev)</li> 39602 </ul></li> 39603 <li>VFS 39604 <ul> 39605 <li>Fix duplicates on rename (Nick Craig-Wood)</li> 39606 <li>Fix crash when truncating a just uploaded object (Nick Craig-Wood)</li> 39607 <li>Fix issue where empty dirs would build up in cache meta dir (albertony)</li> 39608 </ul></li> 39609 <li>Drive 39610 <ul> 39611 <li>Fix instructions for auto config (Greg Sadetsky)</li> 39612 <li>Fix lsf example without drive-impersonate (Greg Sadetsky)</li> 39613 </ul></li> 39614 <li>Onedrive 39615 <ul> 39616 <li>Handle HTTP 400 better in PublicLink (Alex Chen)</li> 39617 <li>Clarification of the process for creating custom client_id (Mariano Absatz)</li> 39618 </ul></li> 39619 <li>Pcloud 39620 <ul> 39621 <li>Return an early error when Put is called with an unknown size (Nick Craig-Wood)</li> 39622 <li>Try harder to delete a failed upload (Nick Craig-Wood)</li> 39623 </ul></li> 39624 <li>S3 39625 <ul> 39626 <li>Add Wasabi's AP-Northeast endpoint info (hota)</li> 39627 <li>Fix typo in s3 documentation (Greg Sadetsky)</li> 39628 </ul></li> 39629 <li>Seafile 39630 <ul> 39631 <li>Fix 2fa config state machine (Fred)</li> 39632 </ul></li> 39633 <li>SFTP 39634 <ul> 39635 <li>Remove spurious error message on <code>--sftp-disable-concurrent-reads</code> (Nick Craig-Wood)</li> 39636 </ul></li> 39637 <li>Sugarsync 39638 <ul> 39639 <li>Fix initial connection after config re-arrangement (Nick Craig-Wood)</li> 39640 </ul></li> 39641 </ul> 39642 <h2 id="v1.56.0---2021-07-20">v1.56.0 - 2021-07-20</h2> 39643 <p><a href="https://github.com/rclone/rclone/compare/v1.55.0...v1.56.0">See commits</a></p> 39644 <ul> 39645 <li>New backends 39646 <ul> 39647 <li><a href="https://rclone.org/uptobox/">Uptobox</a> (buengese)</li> 39648 </ul></li> 39649 <li>New commands 39650 <ul> 39651 <li><a href="https://rclone.org/commands/rclone_serve_docker/">serve docker</a> (Antoine GIRARD) (Ivan Andreev) 39652 <ul> 39653 <li>and accompanying <a href="https://rclone.org/docker/">docker volume plugin</a></li> 39654 </ul></li> 39655 <li><a href="https://rclone.org/commands/rclone_checksum/">checksum</a> to check files against a file of checksums (Ivan Andreev) 39656 <ul> 39657 <li>this is also available as <code>rclone md5sum -C</code> etc</li> 39658 </ul></li> 39659 <li><a href="https://rclone.org/commands/rclone_config_touch/">config touch</a>: ensure config exists at configured location (albertony)</li> 39660 <li><a href="https://rclone.org/commands/rclone_test_changenotify/">test changenotify</a>: command to help debugging changenotify (Nick Craig-Wood)</li> 39661 </ul></li> 39662 <li>Deprecations 39663 <ul> 39664 <li><code>dbhashsum</code>: Remove command deprecated a year ago (Ivan Andreev)</li> 39665 <li><code>cache</code>: Deprecate cache backend (Ivan Andreev)</li> 39666 </ul></li> 39667 <li>New Features 39668 <ul> 39669 <li>rework config system so it can be used non-interactively via cli and rc API. 39670 <ul> 39671 <li>See docs in <a href="https://rclone.org/commands/rclone_config_create/">config create</a></li> 39672 <li>This is a very big change to all the backends so may cause breakages - please file bugs!</li> 39673 </ul></li> 39674 <li>librclone - export the rclone RC as a C library (lewisxy) (Nick Craig-Wood) 39675 <ul> 39676 <li>Link a C-API rclone shared object into your project</li> 39677 <li>Use the RC as an in memory interface</li> 39678 <li>Python example supplied</li> 39679 <li>Also supports Android and gomobile</li> 39680 </ul></li> 39681 <li>fs 39682 <ul> 39683 <li>Add <code>--disable-http2</code> for global http2 disable (Nick Craig-Wood)</li> 39684 <li>Make <code>--dump</code> imply <code>-vv</code> (Alex Chen)</li> 39685 <li>Use binary prefixes for size and rate units (albertony)</li> 39686 <li>Use decimal prefixes for counts (albertony)</li> 39687 <li>Add google search widget to rclone.org (Ivan Andreev)</li> 39688 </ul></li> 39689 <li>accounting: Calculate rolling average speed (Haochen Tong)</li> 39690 <li>atexit: Terminate with non-zero status after receiving signal (Michael Hanselmann)</li> 39691 <li>build 39692 <ul> 39693 <li>Only run event-based workflow scripts under rclone repo with manual override (Mathieu Carbou)</li> 39694 <li>Add Android build with gomobile (x0b)</li> 39695 </ul></li> 39696 <li>check: Log the hash in use like cryptcheck does (Nick Craig-Wood)</li> 39697 <li>version: Print os/version, kernel and bitness (Ivan Andreev)</li> 39698 <li>config 39699 <ul> 39700 <li>Prevent use of Windows reserved names in config file name (albertony)</li> 39701 <li>Create config file in windows appdata directory by default (albertony)</li> 39702 <li>Treat any config file paths with filename notfound as memory-only config (albertony)</li> 39703 <li>Delay load config file (albertony)</li> 39704 <li>Replace defaultConfig with a thread-safe in-memory implementation (Chris Macklin)</li> 39705 <li>Allow <code>config create</code> and friends to take <code>key=value</code> parameters (Nick Craig-Wood)</li> 39706 <li>Fixed issues with flags/options set by environment vars. (Ole Frost)</li> 39707 </ul></li> 39708 <li>fshttp: Implement graceful DSCP error handling (Tyson Moore)</li> 39709 <li>lib/http - provides an abstraction for a central http server that services can bind routes to (Nolan Woods) 39710 <ul> 39711 <li>Add <code>--template</code> config and flags to serve/data (Nolan Woods)</li> 39712 <li>Add default 404 handler (Nolan Woods)</li> 39713 </ul></li> 39714 <li>link: Use "off" value for unset expiry (Nick Craig-Wood)</li> 39715 <li>oauthutil: Raise fatal error if token expired without refresh token (Alex Chen)</li> 39716 <li>rcat: Add <code>--size</code> flag for more efficient uploads of known size (Nazar Mishturak)</li> 39717 <li>serve sftp: Add <code>--stdio</code> flag to serve via stdio (Tom)</li> 39718 <li>sync: Don't warn about <code>--no-traverse</code> when <code>--files-from</code> is set (Nick Gaya)</li> 39719 <li><code>test makefiles</code> 39720 <ul> 39721 <li>Add <code>--seed</code> flag and make data generated repeatable (Nick Craig-Wood)</li> 39722 <li>Add log levels and speed summary (Nick Craig-Wood)</li> 39723 </ul></li> 39724 </ul></li> 39725 <li>Bug Fixes 39726 <ul> 39727 <li>accounting: Fix startTime of statsGroups.sum (Haochen Tong)</li> 39728 <li>cmd/ncdu: Fix out of range panic in delete (buengese)</li> 39729 <li>config 39730 <ul> 39731 <li>Fix issues with memory-only config file paths (albertony)</li> 39732 <li>Fix in memory config not saving on the fly backend config (Nick Craig-Wood)</li> 39733 </ul></li> 39734 <li>fshttp: Fix address parsing for DSCP (Tyson Moore)</li> 39735 <li>ncdu: Update termbox-go library to fix crash (Nick Craig-Wood)</li> 39736 <li>oauthutil: Fix old authorize result not recognised (Cnly)</li> 39737 <li>operations: Don't update timestamps of files in <code>--compare-dest</code> (Nick Gaya)</li> 39738 <li>selfupdate: fix archive name on macos (Ivan Andreev)</li> 39739 </ul></li> 39740 <li>Mount 39741 <ul> 39742 <li>Refactor before adding serve docker (Antoine GIRARD)</li> 39743 </ul></li> 39744 <li>VFS 39745 <ul> 39746 <li>Add cache reset for <code>--vfs-cache-max-size</code> handling at cache poll interval (Leo Luan)</li> 39747 <li>Fix modtime changing when reading file into cache (Nick Craig-Wood)</li> 39748 <li>Avoid unnecessary subdir in cache path (albertony)</li> 39749 <li>Fix that umask option cannot be set as environment variable (albertony)</li> 39750 <li>Do not print notice about missing poll-interval support when set to 0 (albertony)</li> 39751 </ul></li> 39752 <li>Local 39753 <ul> 39754 <li>Always use readlink to read symlink size for better compatibility (Nick Craig-Wood)</li> 39755 <li>Add <code>--local-unicode-normalization</code> (and remove <code>--local-no-unicode-normalization</code>) (Nick Craig-Wood)</li> 39756 <li>Skip entries removed concurrently with List() (Ivan Andreev)</li> 39757 </ul></li> 39758 <li>Crypt 39759 <ul> 39760 <li>Support timestamped filenames from <code>--b2-versions</code> (Dominik Mydlil)</li> 39761 </ul></li> 39762 <li>B2 39763 <ul> 39764 <li>Don't include the bucket name in public link file prefixes (Jeffrey Tolar)</li> 39765 <li>Fix versions and .files with no extension (Nick Craig-Wood)</li> 39766 <li>Factor version handling into lib/version (Dominik Mydlil)</li> 39767 </ul></li> 39768 <li>Box 39769 <ul> 39770 <li>Use upload preflight check to avoid listings in file uploads (Nick Craig-Wood)</li> 39771 <li>Return errors instead of calling log.Fatal with them (Nick Craig-Wood)</li> 39772 </ul></li> 39773 <li>Drive 39774 <ul> 39775 <li>Switch to the Drives API for looking up shared drives (Nick Craig-Wood)</li> 39776 <li>Fix some google docs being treated as files (Nick Craig-Wood)</li> 39777 </ul></li> 39778 <li>Dropbox 39779 <ul> 39780 <li>Add <code>--dropbox-batch-mode</code> flag to speed up uploading (Nick Craig-Wood) 39781 <ul> 39782 <li>Read the <a href="https://rclone.org/dropbox/#batch-mode">batch mode</a> docs for more info</li> 39783 </ul></li> 39784 <li>Set visibility in link sharing when <code>--expire</code> is set (Nick Craig-Wood)</li> 39785 <li>Simplify chunked uploads (Alexey Ivanov)</li> 39786 <li>Improve "own App IP" instructions (Ivan Andreev)</li> 39787 </ul></li> 39788 <li>Fichier 39789 <ul> 39790 <li>Check if more than one upload link is returned (Nick Craig-Wood)</li> 39791 <li>Support downloading password protected files and folders (Florian Penzkofer)</li> 39792 <li>Make error messages report text from the API (Nick Craig-Wood)</li> 39793 <li>Fix move of files in the same directory (Nick Craig-Wood)</li> 39794 <li>Check that we actually got a download token and retry if we didn't (buengese)</li> 39795 </ul></li> 39796 <li>Filefabric 39797 <ul> 39798 <li>Fix listing after change of from field from "int" to int. (Nick Craig-Wood)</li> 39799 </ul></li> 39800 <li>FTP 39801 <ul> 39802 <li>Make upload error 250 indicate success (Nick Craig-Wood)</li> 39803 </ul></li> 39804 <li>GCS 39805 <ul> 39806 <li>Make compatible with gsutil's mtime metadata (database64128)</li> 39807 <li>Clean up time format constants (database64128)</li> 39808 </ul></li> 39809 <li>Google Photos 39810 <ul> 39811 <li>Fix read only scope not being used properly (Nick Craig-Wood)</li> 39812 </ul></li> 39813 <li>HTTP 39814 <ul> 39815 <li>Replace httplib with lib/http (Nolan Woods)</li> 39816 <li>Clean up Bind to better use middleware (Nolan Woods)</li> 39817 </ul></li> 39818 <li>Jottacloud 39819 <ul> 39820 <li>Fix legacy auth with state based config system (buengese)</li> 39821 <li>Fix invalid url in output from link command (albertony)</li> 39822 <li>Add no versions option (buengese)</li> 39823 </ul></li> 39824 <li>Onedrive 39825 <ul> 39826 <li>Add <code>list_chunk option</code> (Nick Gaya)</li> 39827 <li>Also report root error if unable to cancel multipart upload (Cnly)</li> 39828 <li>Fix failed to configure: empty token found error (Nick Craig-Wood)</li> 39829 <li>Make link return direct download link (Xuanchen Wu)</li> 39830 </ul></li> 39831 <li>S3 39832 <ul> 39833 <li>Add <code>--s3-no-head-object</code> (Tatsuya Noyori)</li> 39834 <li>Remove WebIdentityRoleProvider to fix crash on auth (Nick Craig-Wood)</li> 39835 <li>Don't check to see if remote is object if it ends with / (Nick Craig-Wood)</li> 39836 <li>Add SeaweedFS (Chris Lu)</li> 39837 <li>Update Alibaba OSS endpoints (Chuan Zh)</li> 39838 </ul></li> 39839 <li>SFTP 39840 <ul> 39841 <li>Fix performance regression by re-enabling concurrent writes (Nick Craig-Wood)</li> 39842 <li>Expand tilde and environment variables in configured <code>known_hosts_file</code> (albertony)</li> 39843 </ul></li> 39844 <li>Tardigrade 39845 <ul> 39846 <li>Upgrade to uplink v1.4.6 (Caleb Case)</li> 39847 <li>Use negative offset (Caleb Case)</li> 39848 <li>Add warning about <code>too many open files</code> (acsfer)</li> 39849 </ul></li> 39850 <li>WebDAV 39851 <ul> 39852 <li>Fix sharepoint auth over http (Nick Craig-Wood)</li> 39853 <li>Add headers option (Antoon Prins)</li> 39854 </ul></li> 39855 </ul> 39856 <h2 id="v1.55.1---2021-04-26">v1.55.1 - 2021-04-26</h2> 39857 <p><a href="https://github.com/rclone/rclone/compare/v1.55.0...v1.55.1">See commits</a></p> 39858 <ul> 39859 <li>Bug Fixes 39860 <ul> 39861 <li>selfupdate 39862 <ul> 39863 <li>Dont detect FUSE if build is static (Ivan Andreev)</li> 39864 <li>Add build tag noselfupdate (Ivan Andreev)</li> 39865 </ul></li> 39866 <li>sync: Fix incorrect error reported by graceful cutoff (Nick Craig-Wood)</li> 39867 <li>install.sh: fix macOS arm64 download (Nick Craig-Wood)</li> 39868 <li>build: Fix version numbers in android branch builds (Nick Craig-Wood)</li> 39869 <li>docs 39870 <ul> 39871 <li>Contributing.md: update setup instructions for go1.16 (Nick Gaya)</li> 39872 <li>WinFsp 2021 is out of beta (albertony)</li> 39873 <li>Minor cleanup of space around code section (albertony)</li> 39874 <li>Fixed some typos (albertony)</li> 39875 </ul></li> 39876 </ul></li> 39877 <li>VFS 39878 <ul> 39879 <li>Fix a code path which allows dirty data to be removed causing data loss (Nick Craig-Wood)</li> 39880 </ul></li> 39881 <li>Compress 39882 <ul> 39883 <li>Fix compressed name regexp (buengese)</li> 39884 </ul></li> 39885 <li>Drive 39886 <ul> 39887 <li>Fix backend copyid of google doc to directory (Nick Craig-Wood)</li> 39888 <li>Don't open browser when service account... (Ansh Mittal)</li> 39889 </ul></li> 39890 <li>Dropbox 39891 <ul> 39892 <li>Add missing team_data.member scope for use with --impersonate (Nick Craig-Wood)</li> 39893 <li>Fix About after scopes changes - rclone config reconnect needed (Nick Craig-Wood)</li> 39894 <li>Fix Unable to decrypt returned paths from changeNotify (Nick Craig-Wood)</li> 39895 </ul></li> 39896 <li>FTP 39897 <ul> 39898 <li>Fix implicit TLS (Ivan Andreev)</li> 39899 </ul></li> 39900 <li>Onedrive 39901 <ul> 39902 <li>Work around for random "Unable to initialize RPS" errors (OleFrost)</li> 39903 </ul></li> 39904 <li>SFTP 39905 <ul> 39906 <li>Revert sftp library to v1.12.0 from v1.13.0 to fix performance regression (Nick Craig-Wood)</li> 39907 <li>Fix Update ReadFrom failed: failed to send packet: EOF errors (Nick Craig-Wood)</li> 39908 </ul></li> 39909 <li>Zoho 39910 <ul> 39911 <li>Fix error when region isn't set (buengese)</li> 39912 <li>Do not ask for mountpoint twice when using headless setup (buengese)</li> 39913 </ul></li> 39914 </ul> 39915 <h2 id="v1.55.0---2021-03-31">v1.55.0 - 2021-03-31</h2> 39916 <p><a href="https://github.com/rclone/rclone/compare/v1.54.0...v1.55.0">See commits</a></p> 39917 <ul> 39918 <li>New commands 39919 <ul> 39920 <li><a href="https://rclone.org/commands/rclone_selfupdate/">selfupdate</a> (Ivan Andreev) 39921 <ul> 39922 <li>Allows rclone to update itself in-place or via a package (using <code>--package</code> flag)</li> 39923 <li>Reads cryptographically signed signatures for non beta releases</li> 39924 <li>Works on all OSes.</li> 39925 </ul></li> 39926 <li><a href="https://rclone.org/commands/rclone_test/">test</a> - these are test commands - use with care! 39927 <ul> 39928 <li><code>histogram</code> - Makes a histogram of file name characters.</li> 39929 <li><code>info</code> - Discovers file name or other limitations for paths.</li> 39930 <li><code>makefiles</code> - Make a random file hierarchy for testing.</li> 39931 <li><code>memory</code> - Load all the objects at remote:path into memory and report memory stats.</li> 39932 </ul></li> 39933 </ul></li> 39934 <li>New Features 39935 <ul> 39936 <li><a href="https://rclone.org/docs/#connection-strings">Connection strings</a> 39937 <ul> 39938 <li>Config parameters can now be passed as part of the remote name as a connection string.</li> 39939 <li>For example, to do the equivalent of <code>--drive-shared-with-me</code> use <code>drive,shared_with_me:</code></li> 39940 <li>Make sure we don't save on the fly remote config to the config file (Nick Craig-Wood)</li> 39941 <li>Make sure backends with additional config have a different name for caching (Nick Craig-Wood)</li> 39942 <li>This work was sponsored by CERN, through the <a href="https://cs3mesh4eosc.eu/">CS3MESH4EOSC Project</a>. 39943 <ul> 39944 <li>CS3MESH4EOSC has received funding from the European Union’s Horizon 2020</li> 39945 <li>research and innovation programme under Grant Agreement no. 863353.</li> 39946 </ul></li> 39947 </ul></li> 39948 <li>build 39949 <ul> 39950 <li>Update go build version to go1.16 and raise minimum go version to go1.13 (Nick Craig-Wood)</li> 39951 <li>Make a macOS ARM64 build to support Apple Silicon (Nick Craig-Wood)</li> 39952 <li>Install macfuse 4.x instead of osxfuse 3.x (Nick Craig-Wood)</li> 39953 <li>Use <code>GO386=softfloat</code> instead of deprecated <code>GO386=387</code> for 386 builds (Nick Craig-Wood)</li> 39954 <li>Disable IOS builds for the time being (Nick Craig-Wood)</li> 39955 <li>Androids builds made with up to date NDK (x0b)</li> 39956 <li>Add an rclone user to the Docker image but don't use it by default (cynthia kwok)</li> 39957 </ul></li> 39958 <li>dedupe: Make largest directory primary to minimize data moved (Saksham Khanna)</li> 39959 <li>config 39960 <ul> 39961 <li>Wrap config library in an interface (Fionera)</li> 39962 <li>Make config file system pluggable (Nick Craig-Wood)</li> 39963 <li><code>--config ""</code> or <code>"/notfound"</code> for in memory config only (Nick Craig-Wood)</li> 39964 <li>Clear fs cache of stale entries when altering config (Nick Craig-Wood)</li> 39965 </ul></li> 39966 <li>copyurl: Add option to print resulting auto-filename (albertony)</li> 39967 <li>delete: Make <code>--rmdirs</code> obey the filters (Nick Craig-Wood)</li> 39968 <li>docs - many fixes and reworks from edwardxml, albertony, pvalls, Ivan Andreev, Evan Harris, buengese, Alexey Tabakman</li> 39969 <li>encoder/filename - add SCSU as tables (Klaus Post)</li> 39970 <li>Add multiple paths support to <code>--compare-dest</code> and <code>--copy-dest</code> flag (K265)</li> 39971 <li>filter: Make <code>--exclude "dir/"</code> equivalent to <code>--exclude "dir/**"</code> (Nick Craig-Wood)</li> 39972 <li>fshttp: Add DSCP support with <code>--dscp</code> for QoS with differentiated services (Max Sum)</li> 39973 <li>lib/cache: Add Delete and DeletePrefix methods (Nick Craig-Wood)</li> 39974 <li>lib/file 39975 <ul> 39976 <li>Make pre-allocate detect disk full errors and return them (Nick Craig-Wood)</li> 39977 <li>Don't run preallocate concurrently (Nick Craig-Wood)</li> 39978 <li>Retry preallocate on EINTR (Nick Craig-Wood)</li> 39979 </ul></li> 39980 <li>operations: Made copy and sync operations obey a RetryAfterError (Ankur Gupta)</li> 39981 <li>rc 39982 <ul> 39983 <li>Add string alternatives for setting options over the rc (Nick Craig-Wood)</li> 39984 <li>Add <code>options/local</code> to see the options configured in the context (Nick Craig-Wood)</li> 39985 <li>Add <code>_config</code> parameter to set global config for just this rc call (Nick Craig-Wood)</li> 39986 <li>Implement passing filter config with <code>_filter</code> parameter (Nick Craig-Wood)</li> 39987 <li>Add <code>fscache/clear</code> and <code>fscache/entries</code> to control the fs cache (Nick Craig-Wood)</li> 39988 <li>Avoid +Inf value for speed in <code>core/stats</code> (albertony)</li> 39989 <li>Add a full set of stats to <code>core/stats</code> (Nick Craig-Wood)</li> 39990 <li>Allow <code>fs=</code> params to be a JSON blob (Nick Craig-Wood)</li> 39991 </ul></li> 39992 <li>rcd: Added systemd notification during the <code>rclone rcd</code> command. (Naveen Honest Raj)</li> 39993 <li>rmdirs: Make <code>--rmdirs</code> obey the filters (Nick Craig-Wood)</li> 39994 <li>version: Show build tags and type of executable (Ivan Andreev)</li> 39995 </ul></li> 39996 <li>Bug Fixes 39997 <ul> 39998 <li>install.sh: make it fail on download errors (Ivan Andreev)</li> 39999 <li>Fix excessive retries missing <code>--max-duration</code> timeout (Nick Craig-Wood)</li> 40000 <li>Fix crash when <code>--low-level-retries=0</code> (Nick Craig-Wood)</li> 40001 <li>Fix failed token refresh on mounts created via the rc (Nick Craig-Wood)</li> 40002 <li>fshttp: Fix bandwidth limiting after bad merge (Nick Craig-Wood)</li> 40003 <li>lib/atexit 40004 <ul> 40005 <li>Unregister interrupt handler once it has fired so users can interrupt again (Nick Craig-Wood)</li> 40006 <li>Fix occasional failure to unmount with CTRL-C (Nick Craig-Wood)</li> 40007 <li>Fix deadlock calling Finalise while Run is running (Nick Craig-Wood)</li> 40008 </ul></li> 40009 <li>lib/rest: Fix multipart uploads not stopping on context cancel (Nick Craig-Wood)</li> 40010 </ul></li> 40011 <li>Mount 40012 <ul> 40013 <li>Allow mounting to root directory on windows (albertony)</li> 40014 <li>Improved handling of relative paths on windows (albertony)</li> 40015 <li>Fix unicode issues with accented characters on macOS (Nick Craig-Wood)</li> 40016 <li>Docs: document the new FileSecurity option in WinFsp 2021 (albertony)</li> 40017 <li>Docs: add note about volume path syntax on windows (albertony)</li> 40018 <li>Fix caching of old directories after renaming them (Nick Craig-Wood)</li> 40019 <li>Update cgofuse to the latest version to bring in macfuse 4 fix (Nick Craig-Wood)</li> 40020 </ul></li> 40021 <li>VFS 40022 <ul> 40023 <li><code>--vfs-used-is-size</code> to report used space using recursive scan (tYYGH)</li> 40024 <li>Don't set modification time if it was already correct (Nick Craig-Wood)</li> 40025 <li>Fix Create causing windows explorer to truncate files on CTRL-C CTRL-V (Nick Craig-Wood)</li> 40026 <li>Fix modtimes not updating when writing via cache (Nick Craig-Wood)</li> 40027 <li>Fix modtimes changing by fractional seconds after upload (Nick Craig-Wood)</li> 40028 <li>Fix modtime set if <code>--vfs-cache-mode writes</code>/<code>full</code> and no write (Nick Craig-Wood)</li> 40029 <li>Rename files in cache and cancel uploads on directory rename (Nick Craig-Wood)</li> 40030 <li>Fix directory renaming by renaming dirs cached in memory (Nick Craig-Wood)</li> 40031 </ul></li> 40032 <li>Local 40033 <ul> 40034 <li>Add flag <code>--local-no-preallocate</code> (David Sze)</li> 40035 <li>Make <code>nounc</code> an advanced option except on Windows (albertony)</li> 40036 <li>Don't ignore preallocate disk full errors (Nick Craig-Wood)</li> 40037 </ul></li> 40038 <li>Cache 40039 <ul> 40040 <li>Add <code>--fs-cache-expire-duration</code> to control the fs cache (Nick Craig-Wood)</li> 40041 </ul></li> 40042 <li>Crypt 40043 <ul> 40044 <li>Add option to not encrypt data (Vesnyx)</li> 40045 <li>Log hash ok on upload (albertony)</li> 40046 </ul></li> 40047 <li>Azure Blob 40048 <ul> 40049 <li>Add container public access level support. (Manish Kumar)</li> 40050 </ul></li> 40051 <li>B2 40052 <ul> 40053 <li>Fix HTML files downloaded via cloudflare (Nick Craig-Wood)</li> 40054 </ul></li> 40055 <li>Box 40056 <ul> 40057 <li>Fix transfers getting stuck on token expiry after API change (Nick Craig-Wood)</li> 40058 </ul></li> 40059 <li>Chunker 40060 <ul> 40061 <li>Partially implement no-rename transactions (Maxwell Calman)</li> 40062 </ul></li> 40063 <li>Drive 40064 <ul> 40065 <li>Don't stop server side copy if couldn't read description (Nick Craig-Wood)</li> 40066 <li>Pass context on to drive SDK - to help with cancellation (Nick Craig-Wood)</li> 40067 </ul></li> 40068 <li>Dropbox 40069 <ul> 40070 <li>Add polling for changes support (Robert Thomas)</li> 40071 <li>Make <code>--timeout 0</code> work properly (Nick Craig-Wood)</li> 40072 <li>Raise priority of rate limited message to INFO to make it more noticeable (Nick Craig-Wood)</li> 40073 </ul></li> 40074 <li>Fichier 40075 <ul> 40076 <li>Implement copy & move (buengese)</li> 40077 <li>Implement public link (buengese)</li> 40078 </ul></li> 40079 <li>FTP 40080 <ul> 40081 <li>Implement Shutdown method (Nick Craig-Wood)</li> 40082 <li>Close idle connections after <code>--ftp-idle-timeout</code> (1m by default) (Nick Craig-Wood)</li> 40083 <li>Make <code>--timeout 0</code> work properly (Nick Craig-Wood)</li> 40084 <li>Add <code>--ftp-close-timeout</code> flag for use with awkward ftp servers (Nick Craig-Wood)</li> 40085 <li>Retry connections and logins on 421 errors (Nick Craig-Wood)</li> 40086 </ul></li> 40087 <li>Hdfs 40088 <ul> 40089 <li>Fix permissions for when directory is created (Lucas Messenger)</li> 40090 </ul></li> 40091 <li>Onedrive 40092 <ul> 40093 <li>Make <code>--timeout 0</code> work properly (Nick Craig-Wood)</li> 40094 </ul></li> 40095 <li>S3 40096 <ul> 40097 <li>Fix <code>--s3-profile</code> which wasn't working (Nick Craig-Wood)</li> 40098 </ul></li> 40099 <li>SFTP 40100 <ul> 40101 <li>Close idle connections after <code>--sftp-idle-timeout</code> (1m by default) (Nick Craig-Wood)</li> 40102 <li>Fix "file not found" errors for read once servers (Nick Craig-Wood)</li> 40103 <li>Fix SetModTime stat failed: object not found with <code>--sftp-set-modtime=false</code> (Nick Craig-Wood)</li> 40104 </ul></li> 40105 <li>Swift 40106 <ul> 40107 <li>Update github.com/ncw/swift to v2.0.0 (Nick Craig-Wood)</li> 40108 <li>Implement copying large objects (nguyenhuuluan434)</li> 40109 </ul></li> 40110 <li>Union 40111 <ul> 40112 <li>Fix crash when using epff policy (Nick Craig-Wood)</li> 40113 <li>Fix union attempting to update files on a read only file system (Nick Craig-Wood)</li> 40114 <li>Refactor to use fspath.SplitFs instead of fs.ParseRemote (Nick Craig-Wood)</li> 40115 <li>Fix initialisation broken in refactor (Nick Craig-Wood)</li> 40116 </ul></li> 40117 <li>WebDAV 40118 <ul> 40119 <li>Add support for sharepoint with NTLM authentication (Rauno Ots)</li> 40120 <li>Make sharepoint-ntlm docs more consistent (Alex Chen)</li> 40121 <li>Improve terminology in sharepoint-ntlm docs (Ivan Andreev)</li> 40122 <li>Disable HTTP/2 for NTLM authentication (georne)</li> 40123 <li>Fix sharepoint-ntlm error 401 for parallel actions (Ivan Andreev)</li> 40124 <li>Check that purged directory really exists (Ivan Andreev)</li> 40125 </ul></li> 40126 <li>Yandex 40127 <ul> 40128 <li>Make <code>--timeout 0</code> work properly (Nick Craig-Wood)</li> 40129 </ul></li> 40130 <li>Zoho 40131 <ul> 40132 <li>Replace client id - you will need to <code>rclone config reconnect</code> after this (buengese)</li> 40133 <li>Add forgotten setupRegion() to NewFs - this finally fixes regions other than EU (buengese)</li> 40134 </ul></li> 40135 </ul> 40136 <h2 id="v1.54.1---2021-03-08">v1.54.1 - 2021-03-08</h2> 40137 <p><a href="https://github.com/rclone/rclone/compare/v1.54.0...v1.54.1">See commits</a></p> 40138 <ul> 40139 <li>Bug Fixes 40140 <ul> 40141 <li>accounting: Fix --bwlimit when up or down is off (Nick Craig-Wood)</li> 40142 <li>docs 40143 <ul> 40144 <li>Fix nesting of brackets and backticks in ftp docs (edwardxml)</li> 40145 <li>Fix broken link in sftp page (edwardxml)</li> 40146 <li>Fix typo in crypt.md (Romeo Kienzler)</li> 40147 <li>Changelog: Correct link to digitalis.io (Alex JOST)</li> 40148 <li>Replace #file-caching with #vfs-file-caching (Miron Veryanskiy)</li> 40149 <li>Convert bogus example link to code (edwardxml)</li> 40150 <li>Remove dead link from rc.md (edwardxml)</li> 40151 </ul></li> 40152 <li>rc: Sync,copy,move: document createEmptySrcDirs parameter (Nick Craig-Wood)</li> 40153 <li>lsjson: Fix unterminated JSON in the presence of errors (Nick Craig-Wood)</li> 40154 </ul></li> 40155 <li>Mount 40156 <ul> 40157 <li>Fix mount dropping on macOS by setting --daemon-timeout 10m (Nick Craig-Wood)</li> 40158 </ul></li> 40159 <li>VFS 40160 <ul> 40161 <li>Document simultaneous usage with the same cache shouldn't be used (Nick Craig-Wood)</li> 40162 </ul></li> 40163 <li>B2 40164 <ul> 40165 <li>Automatically raise upload cutoff to avoid spurious error (Nick Craig-Wood)</li> 40166 <li>Fix failed to create file system with application key limited to a prefix (Nick Craig-Wood)</li> 40167 </ul></li> 40168 <li>Drive 40169 <ul> 40170 <li>Refer to Shared Drives instead of Team Drives (Nick Craig-Wood)</li> 40171 </ul></li> 40172 <li>Dropbox 40173 <ul> 40174 <li>Add scopes to oauth request and optionally "members.read" (Nick Craig-Wood)</li> 40175 </ul></li> 40176 <li>S3 40177 <ul> 40178 <li>Fix failed to create file system with folder level permissions policy (Nick Craig-Wood)</li> 40179 <li>Fix Wasabi HEAD requests returning stale data by using only 1 transport (Nick Craig-Wood)</li> 40180 <li>Fix shared_credentials_file auth (Dmitry Chepurovskiy)</li> 40181 <li>Add --s3-no-head to reducing costs docs (Nick Craig-Wood)</li> 40182 </ul></li> 40183 <li>Union 40184 <ul> 40185 <li>Fix mkdir at root with remote:/ (Nick Craig-Wood)</li> 40186 </ul></li> 40187 <li>Zoho 40188 <ul> 40189 <li>Fix custom client id's (buengese)</li> 40190 </ul></li> 40191 </ul> 40192 <h2 id="v1.54.0---2021-02-02">v1.54.0 - 2021-02-02</h2> 40193 <p><a href="https://github.com/rclone/rclone/compare/v1.53.0...v1.54.0">See commits</a></p> 40194 <ul> 40195 <li>New backends 40196 <ul> 40197 <li>Compression remote (experimental) (buengese)</li> 40198 <li>Enterprise File Fabric (Nick Craig-Wood) 40199 <ul> 40200 <li>This work was sponsored by <a href="https://storagemadeeasy.com/">Storage Made Easy</a></li> 40201 </ul></li> 40202 <li>HDFS (Hadoop Distributed File System) (Yury Stankevich)</li> 40203 <li>Zoho workdrive (buengese)</li> 40204 </ul></li> 40205 <li>New Features 40206 <ul> 40207 <li>Deglobalise the config (Nick Craig-Wood) 40208 <ul> 40209 <li>Global config now read from the context</li> 40210 <li>This will enable passing of global config via the rc</li> 40211 <li>This work was sponsored by <a href="https://digitalis.io/">Digitalis</a></li> 40212 </ul></li> 40213 <li>Add <code>--bwlimit</code> for upload and download (Nick Craig-Wood) 40214 <ul> 40215 <li>Obey bwlimit in http Transport for better limiting</li> 40216 </ul></li> 40217 <li>Enhance systemd integration (Hekmon) 40218 <ul> 40219 <li>log level identification, manual activation with flag, automatic systemd launch detection</li> 40220 <li>Don't compile systemd log integration for non unix systems (Benjamin Gustin)</li> 40221 </ul></li> 40222 <li>Add a <code>--download</code> flag to md5sum/sha1sum/hashsum to force rclone to download and hash files locally (lostheli)</li> 40223 <li>Add <code>--progress-terminal-title</code> to print ETA to terminal title (LaSombra)</li> 40224 <li>Make backend env vars show in help as the defaults for backend flags (Nick Craig-Wood)</li> 40225 <li>build 40226 <ul> 40227 <li>Raise minimum go version to go1.12 (Nick Craig-Wood)</li> 40228 </ul></li> 40229 <li>dedupe 40230 <ul> 40231 <li>Add <code>--by-hash</code> to dedupe on content hash not file name (Nick Craig-Wood)</li> 40232 <li>Add <code>--dedupe-mode list</code> to just list dupes, changing nothing (Nick Craig-Wood)</li> 40233 <li>Add warning if used on a remote which can't have duplicate names (Nick Craig-Wood)</li> 40234 </ul></li> 40235 <li>fs 40236 <ul> 40237 <li>Add Shutdown optional method for backends (Nick Craig-Wood)</li> 40238 <li>When using <code>--files-from</code> check files concurrently (zhucan)</li> 40239 <li>Accumulate stats when using <code>--dry-run</code> (Ingo Weiss)</li> 40240 <li>Always show stats when using <code>--dry-run</code> or <code>--interactive</code> (Nick Craig-Wood)</li> 40241 <li>Add support for flag <code>--no-console</code> on windows to hide the console window (albertony)</li> 40242 </ul></li> 40243 <li>genautocomplete: Add support to output to stdout (Ingo)</li> 40244 <li>ncdu 40245 <ul> 40246 <li>Highlight read errors instead of aborting (Claudio Bantaloukas)</li> 40247 <li>Add sort by average size in directory (Adam Plánský)</li> 40248 <li>Add toggle option for average s3ize in directory - key 'a' (Adam Plánský)</li> 40249 <li>Add empty folder flag into ncdu browser (Adam Plánský)</li> 40250 <li>Add <code>!</code> (error) and <code>.</code> (unreadable) file flags to go with <code>e</code> (empty) (Nick Craig-Wood)</li> 40251 </ul></li> 40252 <li>obscure: Make <code>rclone obscure -</code> ignore newline at end of line (Nick Craig-Wood)</li> 40253 <li>operations 40254 <ul> 40255 <li>Add logs when need to upload files to set mod times (Nick Craig-Wood)</li> 40256 <li>Move and copy log name of the destination object in verbose (Adam Plánský)</li> 40257 <li>Add size if known to skipped items and JSON log (Nick Craig-Wood)</li> 40258 </ul></li> 40259 <li>rc 40260 <ul> 40261 <li>Prefer actual listener address if using ":port" or "addr:0" only (Nick Craig-Wood)</li> 40262 <li>Add listener for finished jobs (Aleksandar Jankovic)</li> 40263 </ul></li> 40264 <li>serve ftp: Add options to enable TLS (Deepak Sah)</li> 40265 <li>serve http/webdav: Redirect requests to the base url without the / (Nick Craig-Wood)</li> 40266 <li>serve restic: Implement object cache (Nick Craig-Wood)</li> 40267 <li>stats: Add counter for deleted directories (Nick Craig-Wood)</li> 40268 <li>sync: Only print "There was nothing to transfer" if no errors (Nick Craig-Wood)</li> 40269 <li>webui 40270 <ul> 40271 <li>Prompt user for updating webui if an update is available (Chaitanya Bankanhal)</li> 40272 <li>Fix plugins initialization (negative0)</li> 40273 </ul></li> 40274 </ul></li> 40275 <li>Bug Fixes 40276 <ul> 40277 <li>fs 40278 <ul> 40279 <li>Fix nil pointer on copy & move operations directly to remote (Anagh Kumar Baranwal)</li> 40280 <li>Fix parsing of .. when joining remotes (Nick Craig-Wood)</li> 40281 </ul></li> 40282 <li>log: Fix enabling systemd logging when using <code>--log-file</code> (Nick Craig-Wood)</li> 40283 <li>check 40284 <ul> 40285 <li>Make the error count match up in the log message (Nick Craig-Wood)</li> 40286 </ul></li> 40287 <li>move: Fix data loss when source and destination are the same object (Nick Craig-Wood)</li> 40288 <li>operations 40289 <ul> 40290 <li>Fix <code>--cutoff-mode</code> hard not cutting off immediately (Nick Craig-Wood)</li> 40291 <li>Fix <code>--immutable</code> error message (Nick Craig-Wood)</li> 40292 </ul></li> 40293 <li>sync 40294 <ul> 40295 <li>Fix <code>--cutoff-mode</code> soft & cautious so it doesn't end the transfer early (Nick Craig-Wood)</li> 40296 <li>Fix <code>--immutable</code> errors retrying many times (Nick Craig-Wood)</li> 40297 </ul></li> 40298 </ul></li> 40299 <li>Docs 40300 <ul> 40301 <li>Many fixes and a rewrite of the filtering docs (edwardxml)</li> 40302 <li>Many spelling and grammar fixes (Josh Soref)</li> 40303 <li>Doc fixes for commands delete, purge, rmdir, rmdirs and mount (albertony)</li> 40304 <li>And thanks to these people for many doc fixes too numerous to list 40305 <ul> 40306 <li>Ameer Dawood, Antoine GIRARD, Bob Bagwill, Christopher Stewart</li> 40307 <li>CokeMine, David, Dov Murik, Durval Menezes, Evan Harris, gtorelly</li> 40308 <li>Ilyess Bachiri, Janne Johansson, Kerry Su, Marcin Zelent,</li> 40309 <li>Martin Michlmayr, Milly, Sơn Trần-Nguyễn</li> 40310 </ul></li> 40311 </ul></li> 40312 <li>Mount 40313 <ul> 40314 <li>Update systemd status with cache stats (Hekmon)</li> 40315 <li>Disable bazil/fuse based mount on macOS (Nick Craig-Wood) 40316 <ul> 40317 <li>Make <code>rclone mount</code> actually run <code>rclone cmount</code> under macOS (Nick Craig-Wood)</li> 40318 </ul></li> 40319 <li>Implement mknod to make NFS file creation work (Nick Craig-Wood)</li> 40320 <li>Make sure we don't call umount more than once (Nick Craig-Wood)</li> 40321 <li>More user friendly mounting as network drive on windows (albertony)</li> 40322 <li>Detect if uid or gid are set in same option string: -o uid=123,gid=456 (albertony)</li> 40323 <li>Don't attempt to unmount if fs has been destroyed already (Nick Craig-Wood)</li> 40324 </ul></li> 40325 <li>VFS 40326 <ul> 40327 <li>Fix virtual entries causing deleted files to still appear (Nick Craig-Wood)</li> 40328 <li>Fix "file already exists" error for stale cache files (Nick Craig-Wood)</li> 40329 <li>Fix file leaks with <code>--vfs-cache-mode</code> full and <code>--buffer-size 0</code> (Nick Craig-Wood)</li> 40330 <li>Fix invalid cache path on windows when using :backend: as remote (albertony)</li> 40331 </ul></li> 40332 <li>Local 40333 <ul> 40334 <li>Continue listing files/folders when a circular symlink is detected (Manish Gupta)</li> 40335 <li>New flag <code>--local-zero-size-links</code> to fix sync on some virtual filesystems (Riccardo Iaconelli)</li> 40336 </ul></li> 40337 <li>Azure Blob 40338 <ul> 40339 <li>Add support for service principals (James Lim)</li> 40340 <li>Add support for managed identities (Brad Ackerman)</li> 40341 <li>Add examples for access tier (Bob Pusateri)</li> 40342 <li>Utilize the streaming capabilities from the SDK for multipart uploads (Denis Neuling)</li> 40343 <li>Fix setting of mime types (Nick Craig-Wood)</li> 40344 <li>Fix crash when listing outside a SAS URL's root (Nick Craig-Wood)</li> 40345 <li>Delete archive tier blobs before update if <code>--azureblob-archive-tier-delete</code> (Nick Craig-Wood)</li> 40346 <li>Fix crash on startup (Nick Craig-Wood)</li> 40347 <li>Fix memory usage by upgrading the SDK to v0.13.0 and implementing a TransferManager (Nick Craig-Wood)</li> 40348 <li>Require go1.14+ to compile due to SDK changes (Nick Craig-Wood)</li> 40349 </ul></li> 40350 <li>B2 40351 <ul> 40352 <li>Make NewObject use less expensive API calls (Nick Craig-Wood) 40353 <ul> 40354 <li>This will improve <code>--files-from</code> and <code>restic serve</code> in particular</li> 40355 </ul></li> 40356 <li>Fixed crash on an empty file name (lluuaapp)</li> 40357 </ul></li> 40358 <li>Box 40359 <ul> 40360 <li>Fix NewObject for files that differ in case (Nick Craig-Wood)</li> 40361 <li>Fix finding directories in a case insensitive way (Nick Craig-Wood)</li> 40362 </ul></li> 40363 <li>Chunker 40364 <ul> 40365 <li>Skip long local hashing, hash in-transit (fixes) (Ivan Andreev)</li> 40366 <li>Set Features ReadMimeType to false as Object.MimeType not supported (Nick Craig-Wood)</li> 40367 <li>Fix case-insensitive NewObject, test metadata detection (Ivan Andreev)</li> 40368 </ul></li> 40369 <li>Drive 40370 <ul> 40371 <li>Implement <code>rclone backend copyid</code> command for copying files by ID (Nick Craig-Wood)</li> 40372 <li>Added flag <code>--drive-stop-on-download-limit</code> to stop transfers when the download limit is exceeded (Anagh Kumar Baranwal)</li> 40373 <li>Implement CleanUp workaround for team drives (buengese)</li> 40374 <li>Allow shortcut resolution and creation to be retried (Nick Craig-Wood)</li> 40375 <li>Log that emptying the trash can take some time (Nick Craig-Wood)</li> 40376 <li>Add xdg office icons to xdg desktop files (Pau Rodriguez-Estivill)</li> 40377 </ul></li> 40378 <li>Dropbox 40379 <ul> 40380 <li>Add support for viewing shared files and folders (buengese)</li> 40381 <li>Enable short lived access tokens (Nick Craig-Wood)</li> 40382 <li>Implement IDer on Objects so <code>rclone lsf</code> etc can read the IDs (buengese)</li> 40383 <li>Set Features ReadMimeType to false as Object.MimeType not supported (Nick Craig-Wood)</li> 40384 <li>Make malformed_path errors from too long files not retriable (Nick Craig-Wood)</li> 40385 <li>Test file name length before upload to fix upload loop (Nick Craig-Wood)</li> 40386 </ul></li> 40387 <li>Fichier 40388 <ul> 40389 <li>Set Features ReadMimeType to true as Object.MimeType is supported (Nick Craig-Wood)</li> 40390 </ul></li> 40391 <li>FTP 40392 <ul> 40393 <li>Add <code>--ftp-disable-msld</code> option to ignore MLSD for really old servers (Nick Craig-Wood)</li> 40394 <li>Make <code>--tpslimit apply</code> (Nick Craig-Wood)</li> 40395 </ul></li> 40396 <li>Google Cloud Storage 40397 <ul> 40398 <li>Storage class object header support (Laurens Janssen)</li> 40399 <li>Fix anonymous client to use rclone's HTTP client (Nick Craig-Wood)</li> 40400 <li>Fix <code>Entry doesn't belong in directory "" (same as directory) - ignoring</code> (Nick Craig-Wood)</li> 40401 </ul></li> 40402 <li>Googlephotos 40403 <ul> 40404 <li>New flag <code>--gphotos-include-archived</code> to show archived photos as well (Nicolas Rueff)</li> 40405 </ul></li> 40406 <li>Jottacloud 40407 <ul> 40408 <li>Don't erroneously report support for writing mime types (buengese)</li> 40409 <li>Add support for Telia Cloud (Patrik Nordlén)</li> 40410 </ul></li> 40411 <li>Mailru 40412 <ul> 40413 <li>Accept special folders eg camera-upload (Ivan Andreev)</li> 40414 <li>Avoid prehashing of large local files (Ivan Andreev)</li> 40415 <li>Fix uploads after recent changes on server (Ivan Andreev)</li> 40416 <li>Fix range requests after June 2020 changes on server (Ivan Andreev)</li> 40417 <li>Fix invalid timestamp on corrupted files (fixes) (Ivan Andreev)</li> 40418 <li>Remove deprecated protocol quirks (Ivan Andreev)</li> 40419 </ul></li> 40420 <li>Memory 40421 <ul> 40422 <li>Fix setting of mime types (Nick Craig-Wood)</li> 40423 </ul></li> 40424 <li>Onedrive 40425 <ul> 40426 <li>Add support for China region operated by 21vianet and other regional suppliers (NyaMisty)</li> 40427 <li>Warn on gateway timeout errors (Nick Craig-Wood)</li> 40428 <li>Fall back to normal copy if server-side copy unavailable (Alex Chen)</li> 40429 <li>Fix server-side copy completely disabled on OneDrive for Business (Cnly)</li> 40430 <li>(business only) workaround to replace existing file on server-side copy (Alex Chen)</li> 40431 <li>Enhance link creation with expiry, scope, type and password (Nick Craig-Wood)</li> 40432 <li>Remove % and # from the set of encoded characters (Alex Chen)</li> 40433 <li>Support addressing site by server-relative URL (kice)</li> 40434 </ul></li> 40435 <li>Opendrive 40436 <ul> 40437 <li>Fix finding directories in a case insensitive way (Nick Craig-Wood)</li> 40438 </ul></li> 40439 <li>Pcloud 40440 <ul> 40441 <li>Fix setting of mime types (Nick Craig-Wood)</li> 40442 </ul></li> 40443 <li>Premiumizeme 40444 <ul> 40445 <li>Fix finding directories in a case insensitive way (Nick Craig-Wood)</li> 40446 </ul></li> 40447 <li>Qingstor 40448 <ul> 40449 <li>Fix error propagation in CleanUp (Nick Craig-Wood)</li> 40450 <li>Fix rclone cleanup (Nick Craig-Wood)</li> 40451 </ul></li> 40452 <li>S3 40453 <ul> 40454 <li>Added <code>--s3-disable-http2</code> to disable http/2 (Anagh Kumar Baranwal)</li> 40455 <li>Complete SSE-C implementation (Nick Craig-Wood) 40456 <ul> 40457 <li>Fix hashes on small files with AWS:KMS and SSE-C (Nick Craig-Wood)</li> 40458 <li>Add MD5 metadata to objects uploaded with SSE-AWS/SSE-C (Nick Craig-Wood)</li> 40459 </ul></li> 40460 <li>Add <code>--s3-no-head parameter</code> to minimise transactions on upload (Nick Craig-Wood)</li> 40461 <li>Update docs with a Reducing Costs section (Nick Craig-Wood)</li> 40462 <li>Added error handling for error code 429 indicating too many requests (Anagh Kumar Baranwal)</li> 40463 <li>Add requester pays option (kelv)</li> 40464 <li>Fix copy multipart with v2 auth failing with 'SignatureDoesNotMatch' (Louis Koo)</li> 40465 </ul></li> 40466 <li>SFTP 40467 <ul> 40468 <li>Allow cert based auth via optional pubkey (Stephen Harris)</li> 40469 <li>Allow user to optionally check server hosts key to add security (Stephen Harris)</li> 40470 <li>Defer asking for user passwords until the SSH connection succeeds (Stephen Harris)</li> 40471 <li>Remember entered password in AskPass mode (Stephen Harris)</li> 40472 <li>Implement Shutdown method (Nick Craig-Wood)</li> 40473 <li>Implement keyboard interactive authentication (Nick Craig-Wood)</li> 40474 <li>Make <code>--tpslimit</code> apply (Nick Craig-Wood)</li> 40475 <li>Implement <code>--sftp-use-fstat</code> for unusual SFTP servers (Nick Craig-Wood)</li> 40476 </ul></li> 40477 <li>Sugarsync 40478 <ul> 40479 <li>Fix NewObject for files that differ in case (Nick Craig-Wood)</li> 40480 <li>Fix finding directories in a case insensitive way (Nick Craig-Wood)</li> 40481 </ul></li> 40482 <li>Swift 40483 <ul> 40484 <li>Fix deletion of parts of Static Large Object (SLO) (Nguyễn Hữu Luân)</li> 40485 <li>Ensure partially uploaded large files are uploaded unless <code>--swift-leave-parts-on-error</code> (Nguyễn Hữu Luân)</li> 40486 </ul></li> 40487 <li>Tardigrade 40488 <ul> 40489 <li>Upgrade to uplink v1.4.1 (Caleb Case)</li> 40490 </ul></li> 40491 <li>WebDAV 40492 <ul> 40493 <li>Updated docs to show streaming to nextcloud is working (Durval Menezes)</li> 40494 </ul></li> 40495 <li>Yandex 40496 <ul> 40497 <li>Set Features WriteMimeType to false as Yandex ignores mime types (Nick Craig-Wood)</li> 40498 </ul></li> 40499 </ul> 40500 <h2 id="v1.53.4---2021-01-20">v1.53.4 - 2021-01-20</h2> 40501 <p><a href="https://github.com/rclone/rclone/compare/v1.53.3...v1.53.4">See commits</a></p> 40502 <ul> 40503 <li>Bug Fixes 40504 <ul> 40505 <li>accounting: Fix data race in Transferred() (Maciej Zimnoch)</li> 40506 <li>build 40507 <ul> 40508 <li>Stop tagged releases making a current beta (Nick Craig-Wood)</li> 40509 <li>Upgrade docker buildx action (Matteo Pietro Dazzi)</li> 40510 <li>Add -buildmode to cross-compile.go (Nick Craig-Wood)</li> 40511 <li>Fix docker build by upgrading ilteoood/docker_buildx (Nick Craig-Wood)</li> 40512 <li>Revert GitHub actions brew fix since this is now fixed (Nick Craig-Wood)</li> 40513 <li>Fix brew install --cask syntax for macOS build (Nick Craig-Wood)</li> 40514 <li>Update nfpm syntax to fix build of .deb/.rpm packages (Nick Craig-Wood)</li> 40515 <li>Fix for Windows build errors (Ivan Andreev)</li> 40516 </ul></li> 40517 <li>fs: Parseduration: fixed tests to use UTC time (Ankur Gupta)</li> 40518 <li>fshttp: Prevent overlap of HTTP headers in logs (Nathan Collins)</li> 40519 <li>rc 40520 <ul> 40521 <li>Fix core/command giving 500 internal error (Nick Craig-Wood)</li> 40522 <li>Add Copy method to rc.Params (Nick Craig-Wood)</li> 40523 <li>Fix 500 error when marshalling errors from core/command (Nick Craig-Wood)</li> 40524 <li>plugins: Create plugins files only if webui is enabled. (negative0)</li> 40525 </ul></li> 40526 <li>serve http: Fix serving files of unknown length (Nick Craig-Wood)</li> 40527 <li>serve sftp: Fix authentication on one connection blocking others (Nick Craig-Wood)</li> 40528 </ul></li> 40529 <li>Mount 40530 <ul> 40531 <li>Add optional <code>brew</code> tag to throw an error when using mount in the binaries installed via Homebrew (Anagh Kumar Baranwal)</li> 40532 <li>Add "." and ".." to directories to match cmount and expectations (Nick Craig-Wood)</li> 40533 </ul></li> 40534 <li>VFS 40535 <ul> 40536 <li>Make cache dir absolute before using it to fix path too long errors (Nick Craig-Wood)</li> 40537 </ul></li> 40538 <li>Chunker 40539 <ul> 40540 <li>Improve detection of incompatible metadata (Ivan Andreev)</li> 40541 </ul></li> 40542 <li>Google Cloud Storage 40543 <ul> 40544 <li>Fix server side copy of large objects (Nick Craig-Wood)</li> 40545 </ul></li> 40546 <li>Jottacloud 40547 <ul> 40548 <li>Fix token renewer to fix long uploads (Nick Craig-Wood)</li> 40549 <li>Fix token refresh failed: is not a regular file error (Nick Craig-Wood)</li> 40550 </ul></li> 40551 <li>Pcloud 40552 <ul> 40553 <li>Only use SHA1 hashes in EU region (Nick Craig-Wood)</li> 40554 </ul></li> 40555 <li>Sharefile 40556 <ul> 40557 <li>Undo Fix backend due to API swapping integers for strings (Nick Craig-Wood)</li> 40558 </ul></li> 40559 <li>WebDAV 40560 <ul> 40561 <li>Fix Open Range requests to fix 4shared mount (Nick Craig-Wood)</li> 40562 <li>Add "Depth: 0" to GET requests to fix bitrix (Nick Craig-Wood)</li> 40563 </ul></li> 40564 </ul> 40565 <h2 id="v1.53.3---2020-11-19">v1.53.3 - 2020-11-19</h2> 40566 <p><a href="https://github.com/rclone/rclone/compare/v1.53.2...v1.53.3">See commits</a></p> 40567 <ul> 40568 <li>Bug Fixes 40569 <ul> 40570 <li>random: Fix incorrect use of math/rand instead of crypto/rand CVE-2020-28924 (Nick Craig-Wood) 40571 <ul> 40572 <li>Passwords you have generated with <code>rclone config</code> may be insecure</li> 40573 <li>See <a href="https://github.com/rclone/rclone/issues/4783">issue #4783</a> for more details and a checking tool</li> 40574 </ul></li> 40575 <li>random: Seed math/rand in one place with crypto strong seed (Nick Craig-Wood)</li> 40576 </ul></li> 40577 <li>VFS 40578 <ul> 40579 <li>Fix vfs/refresh calls with fs= parameter (Nick Craig-Wood)</li> 40580 </ul></li> 40581 <li>Sharefile 40582 <ul> 40583 <li>Fix backend due to API swapping integers for strings (Nick Craig-Wood)</li> 40584 </ul></li> 40585 </ul> 40586 <h2 id="v1.53.2---2020-10-26">v1.53.2 - 2020-10-26</h2> 40587 <p><a href="https://github.com/rclone/rclone/compare/v1.53.1...v1.53.2">See commits</a></p> 40588 <ul> 40589 <li>Bug Fixes 40590 <ul> 40591 <li>accounting 40592 <ul> 40593 <li>Fix incorrect speed and transferTime in core/stats (Nick Craig-Wood)</li> 40594 <li>Stabilize display order of transfers on Windows (Nick Craig-Wood)</li> 40595 </ul></li> 40596 <li>operations 40597 <ul> 40598 <li>Fix use of --suffix without --backup-dir (Nick Craig-Wood)</li> 40599 <li>Fix spurious "--checksum is in use but the source and destination have no hashes in common" (Nick Craig-Wood)</li> 40600 </ul></li> 40601 <li>build 40602 <ul> 40603 <li>Work around GitHub actions brew problem (Nick Craig-Wood)</li> 40604 <li>Stop using set-env and set-path in the GitHub actions (Nick Craig-Wood)</li> 40605 </ul></li> 40606 </ul></li> 40607 <li>Mount 40608 <ul> 40609 <li>mount2: Fix the swapped UID / GID values (Russell Cattelan)</li> 40610 </ul></li> 40611 <li>VFS 40612 <ul> 40613 <li>Detect and recover from a file being removed externally from the cache (Nick Craig-Wood)</li> 40614 <li>Fix a deadlock vulnerability in downloaders.Close (Leo Luan)</li> 40615 <li>Fix a race condition in retryFailedResets (Leo Luan)</li> 40616 <li>Fix missed concurrency control between some item operations and reset (Leo Luan)</li> 40617 <li>Add exponential backoff during ENOSPC retries (Leo Luan)</li> 40618 <li>Add a missed update of used cache space (Leo Luan)</li> 40619 <li>Fix --no-modtime to not attempt to set modtimes (as documented) (Nick Craig-Wood)</li> 40620 </ul></li> 40621 <li>Local 40622 <ul> 40623 <li>Fix sizes and syncing with --links option on Windows (Nick Craig-Wood)</li> 40624 </ul></li> 40625 <li>Chunker 40626 <ul> 40627 <li>Disable ListR to fix missing files on GDrive (workaround) (Ivan Andreev)</li> 40628 <li>Fix upload over crypt (Ivan Andreev)</li> 40629 </ul></li> 40630 <li>Fichier 40631 <ul> 40632 <li>Increase maximum file size from 100GB to 300GB (gyutw)</li> 40633 </ul></li> 40634 <li>Jottacloud 40635 <ul> 40636 <li>Remove clientSecret from config when upgrading to token based authentication (buengese)</li> 40637 <li>Avoid double url escaping of device/mountpoint (albertony)</li> 40638 <li>Remove DirMove workaround as it's not required anymore - also (buengese)</li> 40639 </ul></li> 40640 <li>Mailru 40641 <ul> 40642 <li>Fix uploads after recent changes on server (Ivan Andreev)</li> 40643 <li>Fix range requests after june changes on server (Ivan Andreev)</li> 40644 <li>Fix invalid timestamp on corrupted files (fixes) (Ivan Andreev)</li> 40645 </ul></li> 40646 <li>Onedrive 40647 <ul> 40648 <li>Fix disk usage for sharepoint (Nick Craig-Wood)</li> 40649 </ul></li> 40650 <li>S3 40651 <ul> 40652 <li>Add missing regions for AWS (Anagh Kumar Baranwal)</li> 40653 </ul></li> 40654 <li>Seafile 40655 <ul> 40656 <li>Fix accessing libraries > 2GB on 32 bit systems (Muffin King)</li> 40657 </ul></li> 40658 <li>SFTP 40659 <ul> 40660 <li>Always convert the checksum to lower case (buengese)</li> 40661 </ul></li> 40662 <li>Union 40663 <ul> 40664 <li>Create root directories if none exist (Nick Craig-Wood)</li> 40665 </ul></li> 40666 </ul> 40667 <h2 id="v1.53.1---2020-09-13">v1.53.1 - 2020-09-13</h2> 40668 <p><a href="https://github.com/rclone/rclone/compare/v1.53.0...v1.53.1">See commits</a></p> 40669 <ul> 40670 <li>Bug Fixes 40671 <ul> 40672 <li>accounting: Remove new line from end of --stats-one-line display (Nick Craig-Wood)</li> 40673 <li>check 40674 <ul> 40675 <li>Add back missing --download flag (Nick Craig-Wood)</li> 40676 <li>Fix docs (Nick Craig-Wood)</li> 40677 </ul></li> 40678 <li>docs 40679 <ul> 40680 <li>Note --log-file does append (Nick Craig-Wood)</li> 40681 <li>Add full stops for consistency in rclone --help (edwardxml)</li> 40682 <li>Add Tencent COS to s3 provider list (wjielai)</li> 40683 <li>Updated mount command to reflect that it requires Go 1.13 or newer (Evan Harris)</li> 40684 <li>jottacloud: Mention that uploads from local disk will not need to cache files to disk for md5 calculation (albertony)</li> 40685 <li>Fix formatting of rc docs page (Nick Craig-Wood)</li> 40686 </ul></li> 40687 <li>build 40688 <ul> 40689 <li>Include vendor tar ball in release and fix startdev (Nick Craig-Wood)</li> 40690 <li>Fix "Illegal instruction" error for ARMv6 builds (Nick Craig-Wood)</li> 40691 <li>Fix architecture name in ARMv7 build (Nick Craig-Wood)</li> 40692 </ul></li> 40693 </ul></li> 40694 <li>VFS 40695 <ul> 40696 <li>Fix spurious error "vfs cache: failed to _ensure cache EOF" (Nick Craig-Wood)</li> 40697 <li>Log an ERROR if we fail to set the file to be sparse (Nick Craig-Wood)</li> 40698 </ul></li> 40699 <li>Local 40700 <ul> 40701 <li>Log an ERROR if we fail to set the file to be sparse (Nick Craig-Wood)</li> 40702 </ul></li> 40703 <li>Drive 40704 <ul> 40705 <li>Re-adds special oauth help text (Tim Gallant)</li> 40706 </ul></li> 40707 <li>Opendrive 40708 <ul> 40709 <li>Do not retry 400 errors (Evan Harris)</li> 40710 </ul></li> 40711 </ul> 40712 <h2 id="v1.53.0---2020-09-02">v1.53.0 - 2020-09-02</h2> 40713 <p><a href="https://github.com/rclone/rclone/compare/v1.52.0...v1.53.0">See commits</a></p> 40714 <ul> 40715 <li>New Features 40716 <ul> 40717 <li>The <a href="https://rclone.org/commands/rclone_mount/#vfs-virtual-file-system">VFS layer</a> was heavily reworked for this release - see below for more details</li> 40718 <li>Interactive mode <a href="https://rclone.org/docs/#interactive">-i/--interactive</a> for destructive operations (fishbullet)</li> 40719 <li>Add <a href="https://rclone.org/docs/#bwlimit-file-bandwidth-spec">--bwlimit-file</a> flag to limit speeds of individual file transfers (Nick Craig-Wood)</li> 40720 <li>Transfers are sorted by start time in the stats and progress output (Max Sum)</li> 40721 <li>Make sure backends expand <code>~</code> and environment vars in file names they use (Nick Craig-Wood)</li> 40722 <li>Add <a href="https://rclone.org/docs/#refresh-times">--refresh-times</a> flag to set modtimes on hashless backends (Nick Craig-Wood)</li> 40723 <li>build 40724 <ul> 40725 <li>Remove vendor directory in favour of Go modules (Nick Craig-Wood)</li> 40726 <li>Build with go1.15.x by default (Nick Craig-Wood)</li> 40727 <li>Drop macOS 386 build as it is no longer supported by go1.15 (Nick Craig-Wood)</li> 40728 <li>Add ARMv7 to the supported builds (Nick Craig-Wood)</li> 40729 <li>Enable <code>rclone cmount</code> on macOS (Nick Craig-Wood)</li> 40730 <li>Make rclone build with gccgo (Nick Craig-Wood)</li> 40731 <li>Make rclone build with wasm (Nick Craig-Wood)</li> 40732 <li>Change beta numbering to be semver compatible (Nick Craig-Wood)</li> 40733 <li>Add file properties and icon to Windows executable (albertony)</li> 40734 <li>Add experimental interface for integrating rclone into browsers (Nick Craig-Wood)</li> 40735 </ul></li> 40736 <li>lib: Add file name compression (Klaus Post)</li> 40737 <li>rc 40738 <ul> 40739 <li>Allow installation and use of plugins and test plugins with rclone-webui (Chaitanya Bankanhal)</li> 40740 <li>Add reverse proxy pluginsHandler for serving plugins (Chaitanya Bankanhal)</li> 40741 <li>Add <code>mount/listmounts</code> option for listing current mounts (Chaitanya Bankanhal)</li> 40742 <li>Add <code>operations/uploadfile</code> to upload a file through rc using encoding multipart/form-data (Chaitanya Bankanhal)</li> 40743 <li>Add <code>core/command</code> to execute rclone terminal commands. (Chaitanya Bankanhal)</li> 40744 </ul></li> 40745 <li><code>rclone check</code> 40746 <ul> 40747 <li>Add reporting of filenames for same/missing/changed (Nick Craig-Wood)</li> 40748 <li>Make check command obey <code>--dry-run</code>/<code>-i</code>/<code>--interactive</code> (Nick Craig-Wood)</li> 40749 <li>Make check do <code>--checkers</code> files concurrently (Nick Craig-Wood)</li> 40750 <li>Retry downloads if they fail when using the <code>--download</code> flag (Nick Craig-Wood)</li> 40751 <li>Make it show stats by default (Nick Craig-Wood)</li> 40752 </ul></li> 40753 <li><code>rclone obscure</code>: Allow obscure command to accept password on STDIN (David Ibarra)</li> 40754 <li><code>rclone config</code> 40755 <ul> 40756 <li>Set RCLONE_CONFIG_DIR for use in config files and subprocesses (Nick Craig-Wood)</li> 40757 <li>Reject remote names starting with a dash. (jtagcat)</li> 40758 </ul></li> 40759 <li><code>rclone cryptcheck</code>: Add reporting of filenames for same/missing/changed (Nick Craig-Wood)</li> 40760 <li><code>rclone dedupe</code>: Make it obey the <code>--size-only</code> flag for duplicate detection (Nick Craig-Wood)</li> 40761 <li><code>rclone link</code>: Add <code>--expire</code> and <code>--unlink</code> flags (Roman Kredentser)</li> 40762 <li><code>rclone mkdir</code>: Warn when using mkdir on remotes which can't have empty directories (Nick Craig-Wood)</li> 40763 <li><code>rclone rc</code>: Allow JSON parameters to simplify command line usage (Nick Craig-Wood)</li> 40764 <li><code>rclone serve ftp</code> 40765 <ul> 40766 <li>Don't compile on < go1.13 after dependency update (Nick Craig-Wood)</li> 40767 <li>Add error message if auth proxy fails (Nick Craig-Wood)</li> 40768 <li>Use refactored goftp.io/server library for binary shrink (Nick Craig-Wood)</li> 40769 </ul></li> 40770 <li><code>rclone serve restic</code>: Expose interfaces so that rclone can be used as a library from within restic (Jack)</li> 40771 <li><code>rclone sync</code>: Add <code>--track-renames-strategy leaf</code> (Nick Craig-Wood)</li> 40772 <li><code>rclone touch</code>: Add ability to set nanosecond resolution times (Nick Craig-Wood)</li> 40773 <li><code>rclone tree</code>: Remove <code>-i</code> shorthand for <code>--noindent</code> as it conflicts with <code>-i</code>/<code>--interactive</code> (Nick Craig-Wood)</li> 40774 </ul></li> 40775 <li>Bug Fixes 40776 <ul> 40777 <li>accounting 40778 <ul> 40779 <li>Fix documentation for <code>speed</code>/<code>speedAvg</code> (Nick Craig-Wood)</li> 40780 <li>Fix elapsed time not show actual time since beginning (Chaitanya Bankanhal)</li> 40781 <li>Fix deadlock in stats printing (Nick Craig-Wood)</li> 40782 </ul></li> 40783 <li>build 40784 <ul> 40785 <li>Fix file handle leak in GitHub release tool (Garrett Squire)</li> 40786 </ul></li> 40787 <li><code>rclone check</code>: Fix successful retries with <code>--download</code> counting errors (Nick Craig-Wood)</li> 40788 <li><code>rclone dedupe</code>: Fix logging to be easier to understand (Nick Craig-Wood)</li> 40789 </ul></li> 40790 <li>Mount 40791 <ul> 40792 <li>Warn macOS users that mount implementation is changing (Nick Craig-Wood) 40793 <ul> 40794 <li>to test the new implementation use <code>rclone cmount</code> instead of <code>rclone mount</code></li> 40795 <li>this is because the library rclone uses has dropped macOS support</li> 40796 </ul></li> 40797 <li>rc interface 40798 <ul> 40799 <li>Add call for unmount all (Chaitanya Bankanhal)</li> 40800 <li>Make <code>mount/mount</code> remote control take vfsOpt option (Nick Craig-Wood)</li> 40801 <li>Add mountOpt to <code>mount/mount</code> (Nick Craig-Wood)</li> 40802 <li>Add VFS and Mount options to <code>mount/listmounts</code> (Nick Craig-Wood)</li> 40803 </ul></li> 40804 <li>Catch panics in cgofuse initialization and turn into error messages (Nick Craig-Wood)</li> 40805 <li>Always supply stat information in Readdir (Nick Craig-Wood)</li> 40806 <li>Add support for reading unknown length files using direct IO (Windows) (Nick Craig-Wood)</li> 40807 <li>Fix On Windows don't add <code>-o uid/gid=-1</code> if user supplies <code>-o uid/gid</code>. (Nick Craig-Wood)</li> 40808 <li>Fix macOS losing directory contents in cmount (Nick Craig-Wood)</li> 40809 <li>Fix volume name broken in recent refactor (Nick Craig-Wood)</li> 40810 </ul></li> 40811 <li>VFS 40812 <ul> 40813 <li>Implement partial reads for <code>--vfs-cache-mode full</code> (Nick Craig-Wood)</li> 40814 <li>Add <code>--vfs-writeback</code> option to delay writes back to cloud storage (Nick Craig-Wood)</li> 40815 <li>Add <code>--vfs-read-ahead</code> parameter for use with <code>--vfs-cache-mode full</code> (Nick Craig-Wood)</li> 40816 <li>Restart pending uploads on restart of the cache (Nick Craig-Wood)</li> 40817 <li>Support synchronous cache space recovery upon ENOSPC (Leo Luan)</li> 40818 <li>Allow ReadAt and WriteAt to run concurrently with themselves (Nick Craig-Wood)</li> 40819 <li>Change modtime of file before upload to current (Rob Calistri)</li> 40820 <li>Recommend <code>--vfs-cache-modes writes</code> on backends which can't stream (Nick Craig-Wood)</li> 40821 <li>Add an optional <code>fs</code> parameter to vfs rc methods (Nick Craig-Wood)</li> 40822 <li>Fix errors when using > 260 char files in the cache in Windows (Nick Craig-Wood)</li> 40823 <li>Fix renaming of items while they are being uploaded (Nick Craig-Wood)</li> 40824 <li>Fix very high load caused by slow directory listings (Nick Craig-Wood)</li> 40825 <li>Fix renamed files not being uploaded with <code>--vfs-cache-mode minimal</code> (Nick Craig-Wood)</li> 40826 <li>Fix directory locking caused by slow directory listings (Nick Craig-Wood)</li> 40827 <li>Fix saving from chrome without <code>--vfs-cache-mode writes</code> (Nick Craig-Wood)</li> 40828 </ul></li> 40829 <li>Local 40830 <ul> 40831 <li>Add <code>--local-no-updated</code> to provide a consistent view of changing objects (Nick Craig-Wood)</li> 40832 <li>Add <code>--local-no-set-modtime</code> option to prevent modtime changes (tyhuber1)</li> 40833 <li>Fix race conditions updating and reading Object metadata (Nick Craig-Wood)</li> 40834 </ul></li> 40835 <li>Cache 40836 <ul> 40837 <li>Make any created backends be cached to fix rc problems (Nick Craig-Wood)</li> 40838 <li>Fix dedupe on caches wrapping drives (Nick Craig-Wood)</li> 40839 </ul></li> 40840 <li>Crypt 40841 <ul> 40842 <li>Add <code>--crypt-server-side-across-configs</code> flag (Nick Craig-Wood)</li> 40843 <li>Make any created backends be cached to fix rc problems (Nick Craig-Wood)</li> 40844 </ul></li> 40845 <li>Alias 40846 <ul> 40847 <li>Make any created backends be cached to fix rc problems (Nick Craig-Wood)</li> 40848 </ul></li> 40849 <li>Azure Blob 40850 <ul> 40851 <li>Don't compile on < go1.13 after dependency update (Nick Craig-Wood)</li> 40852 </ul></li> 40853 <li>B2 40854 <ul> 40855 <li>Implement server-side copy for files > 5GB (Nick Craig-Wood)</li> 40856 <li>Cancel in progress multipart uploads and copies on rclone exit (Nick Craig-Wood)</li> 40857 <li>Note that b2's encoding now allows but rclone's hasn't changed (Nick Craig-Wood)</li> 40858 <li>Fix transfers when using download_url (Nick Craig-Wood)</li> 40859 </ul></li> 40860 <li>Box 40861 <ul> 40862 <li>Implement rclone cleanup (buengese)</li> 40863 <li>Cancel in progress multipart uploads and copies on rclone exit (Nick Craig-Wood)</li> 40864 <li>Allow authentication with access token (David)</li> 40865 </ul></li> 40866 <li>Chunker 40867 <ul> 40868 <li>Make any created backends be cached to fix rc problems (Nick Craig-Wood)</li> 40869 </ul></li> 40870 <li>Drive 40871 <ul> 40872 <li>Add <code>rclone backend drives</code> to list shared drives (teamdrives) (Nick Craig-Wood)</li> 40873 <li>Implement <code>rclone backend untrash</code> (Nick Craig-Wood)</li> 40874 <li>Work around drive bug which didn't set modtime of copied docs (Nick Craig-Wood)</li> 40875 <li>Added <code>--drive-starred-only</code> to only show starred files (Jay McEntire)</li> 40876 <li>Deprecate <code>--drive-alternate-export</code> as it is no longer needed (themylogin)</li> 40877 <li>Fix duplication of Google docs on server-side copy (Nick Craig-Wood)</li> 40878 <li>Fix "panic: send on closed channel" when recycling dir entries (Nick Craig-Wood)</li> 40879 </ul></li> 40880 <li>Dropbox 40881 <ul> 40882 <li>Add copyright detector info in limitations section in the docs (Alex Guerrero)</li> 40883 <li>Fix <code>rclone link</code> by removing expires parameter (Nick Craig-Wood)</li> 40884 </ul></li> 40885 <li>Fichier 40886 <ul> 40887 <li>Detect Flood detected: IP Locked error and sleep for 30s (Nick Craig-Wood)</li> 40888 </ul></li> 40889 <li>FTP 40890 <ul> 40891 <li>Add explicit TLS support (Heiko Bornholdt)</li> 40892 <li>Add support for <code>--dump bodies</code> and <code>--dump auth</code> for debugging (Nick Craig-Wood)</li> 40893 <li>Fix interoperation with pure-ftpd (Nick Craig-Wood)</li> 40894 </ul></li> 40895 <li>Google Cloud Storage 40896 <ul> 40897 <li>Add support for anonymous access (Kai Lüke)</li> 40898 </ul></li> 40899 <li>Jottacloud 40900 <ul> 40901 <li>Bring back legacy authentication for use with whitelabel versions (buengese)</li> 40902 <li>Switch to new api root - also implement a very ugly workaround for the DirMove failures (buengese)</li> 40903 </ul></li> 40904 <li>Onedrive 40905 <ul> 40906 <li>Rework cancel of multipart uploads on rclone exit (Nick Craig-Wood)</li> 40907 <li>Implement rclone cleanup (Nick Craig-Wood)</li> 40908 <li>Add <code>--onedrive-no-versions</code> flag to remove old versions (Nick Craig-Wood)</li> 40909 </ul></li> 40910 <li>Pcloud 40911 <ul> 40912 <li>Implement <code>rclone link</code> for public link creation (buengese)</li> 40913 </ul></li> 40914 <li>Qingstor 40915 <ul> 40916 <li>Cancel in progress multipart uploads on rclone exit (Nick Craig-Wood)</li> 40917 </ul></li> 40918 <li>S3 40919 <ul> 40920 <li>Preserve metadata when doing multipart copy (Nick Craig-Wood)</li> 40921 <li>Cancel in progress multipart uploads and copies on rclone exit (Nick Craig-Wood)</li> 40922 <li>Add <code>rclone link</code> for public link sharing (Roman Kredentser)</li> 40923 <li>Add <code>rclone backend restore</code> command to restore objects from GLACIER (Nick Craig-Wood)</li> 40924 <li>Add <code>rclone cleanup</code> and <code>rclone backend cleanup</code> to clean unfinished multipart uploads (Nick Craig-Wood)</li> 40925 <li>Add <code>rclone backend list-multipart-uploads</code> to list unfinished multipart uploads (Nick Craig-Wood)</li> 40926 <li>Add <code>--s3-max-upload-parts</code> support (Kamil Trzciński)</li> 40927 <li>Add <code>--s3-no-check-bucket</code> for minimising rclone transactions and perms (Nick Craig-Wood)</li> 40928 <li>Add <code>--s3-profile</code> and <code>--s3-shared-credentials-file</code> options (Nick Craig-Wood)</li> 40929 <li>Use regional s3 us-east-1 endpoint (David)</li> 40930 <li>Add Scaleway provider (Vincent Feltz)</li> 40931 <li>Update IBM COS endpoints (Egor Margineanu)</li> 40932 <li>Reduce the default <code>--s3-copy-cutoff</code> to < 5GB for Backblaze S3 compatibility (Nick Craig-Wood)</li> 40933 <li>Fix detection of bucket existing (Nick Craig-Wood)</li> 40934 </ul></li> 40935 <li>SFTP 40936 <ul> 40937 <li>Use the absolute path instead of the relative path for listing for improved compatibility (Nick Craig-Wood)</li> 40938 <li>Add <code>--sftp-subsystem</code> and <code>--sftp-server-command</code> options (aus)</li> 40939 </ul></li> 40940 <li>Swift 40941 <ul> 40942 <li>Fix dangling large objects breaking the listing (Nick Craig-Wood)</li> 40943 <li>Fix purge not deleting directory markers (Nick Craig-Wood)</li> 40944 <li>Fix update multipart object removing all of its own parts (Nick Craig-Wood)</li> 40945 <li>Fix missing hash from object returned from upload (Nick Craig-Wood)</li> 40946 </ul></li> 40947 <li>Tardigrade 40948 <ul> 40949 <li>Upgrade to uplink v1.2.0 (Kaloyan Raev)</li> 40950 </ul></li> 40951 <li>Union 40952 <ul> 40953 <li>Fix writing with the all policy (Nick Craig-Wood)</li> 40954 </ul></li> 40955 <li>WebDAV 40956 <ul> 40957 <li>Fix directory creation with 4shared (Nick Craig-Wood)</li> 40958 </ul></li> 40959 </ul> 40960 <h2 id="v1.52.3---2020-08-07">v1.52.3 - 2020-08-07</h2> 40961 <p><a href="https://github.com/rclone/rclone/compare/v1.52.2...v1.52.3">See commits</a></p> 40962 <ul> 40963 <li>Bug Fixes 40964 <ul> 40965 <li>docs 40966 <ul> 40967 <li>Disable smart typography (e.g. en-dash) in MANUAL.* and man page (Nick Craig-Wood)</li> 40968 <li>Update install.md to reflect minimum Go version (Evan Harris)</li> 40969 <li>Update install from source instructions (Nick Craig-Wood)</li> 40970 <li>make_manual: Support SOURCE_DATE_EPOCH (Morten Linderud)</li> 40971 </ul></li> 40972 <li>log: Fix --use-json-log going to stderr not --log-file on Windows (Nick Craig-Wood)</li> 40973 <li>serve dlna: Fix file list on Samsung Series 6+ TVs (Matteo Pietro Dazzi)</li> 40974 <li>sync: Fix deadlock with --track-renames-strategy modtime (Nick Craig-Wood)</li> 40975 </ul></li> 40976 <li>Cache 40977 <ul> 40978 <li>Fix moveto/copyto remote:file remote:file2 (Nick Craig-Wood)</li> 40979 </ul></li> 40980 <li>Drive 40981 <ul> 40982 <li>Stop using root_folder_id as a cache (Nick Craig-Wood)</li> 40983 <li>Make dangling shortcuts appear in listings (Nick Craig-Wood)</li> 40984 <li>Drop "Disabling ListR" messages down to debug (Nick Craig-Wood)</li> 40985 <li>Workaround and policy for Google Drive API (Dmitry Ustalov)</li> 40986 </ul></li> 40987 <li>FTP 40988 <ul> 40989 <li>Add note to docs about home vs root directory selection (Nick Craig-Wood)</li> 40990 </ul></li> 40991 <li>Onedrive 40992 <ul> 40993 <li>Fix reverting to Copy when Move would have worked (Nick Craig-Wood)</li> 40994 <li>Avoid comma rendered in URL in onedrive.md (Kevin)</li> 40995 </ul></li> 40996 <li>Pcloud 40997 <ul> 40998 <li>Fix oauth on European region "eapi.pcloud.com" (Nick Craig-Wood)</li> 40999 </ul></li> 41000 <li>S3 41001 <ul> 41002 <li>Fix bucket Region auto detection when Region unset in config (Nick Craig-Wood)</li> 41003 </ul></li> 41004 </ul> 41005 <h2 id="v1.52.2---2020-06-24">v1.52.2 - 2020-06-24</h2> 41006 <p><a href="https://github.com/rclone/rclone/compare/v1.52.1...v1.52.2">See commits</a></p> 41007 <ul> 41008 <li>Bug Fixes 41009 <ul> 41010 <li>build 41011 <ul> 41012 <li>Fix docker release build action (Nick Craig-Wood)</li> 41013 <li>Fix custom timezone in Docker image (NoLooseEnds)</li> 41014 </ul></li> 41015 <li>check: Fix misleading message which printed errors instead of differences (Nick Craig-Wood)</li> 41016 <li>errors: Add WSAECONNREFUSED and more to the list of retriable Windows errors (Nick Craig-Wood)</li> 41017 <li>rcd: Fix incorrect prometheus metrics (Gary Kim)</li> 41018 <li>serve restic: Fix flags so they use environment variables (Nick Craig-Wood)</li> 41019 <li>serve webdav: Fix flags so they use environment variables (Nick Craig-Wood)</li> 41020 <li>sync: Fix --track-renames-strategy modtime (Nick Craig-Wood)</li> 41021 </ul></li> 41022 <li>Drive 41023 <ul> 41024 <li>Fix not being able to delete a directory with a trashed shortcut (Nick Craig-Wood)</li> 41025 <li>Fix creating a directory inside a shortcut (Nick Craig-Wood)</li> 41026 <li>Fix --drive-impersonate with cached root_folder_id (Nick Craig-Wood)</li> 41027 </ul></li> 41028 <li>SFTP 41029 <ul> 41030 <li>Fix SSH key PEM loading (Zac Rubin)</li> 41031 </ul></li> 41032 <li>Swift 41033 <ul> 41034 <li>Speed up deletes by not retrying segment container deletes (Nick Craig-Wood)</li> 41035 </ul></li> 41036 <li>Tardigrade 41037 <ul> 41038 <li>Upgrade to uplink v1.1.1 (Caleb Case)</li> 41039 </ul></li> 41040 <li>WebDAV 41041 <ul> 41042 <li>Fix free/used display for rclone about/df for certain backends (Nick Craig-Wood)</li> 41043 </ul></li> 41044 </ul> 41045 <h2 id="v1.52.1---2020-06-10">v1.52.1 - 2020-06-10</h2> 41046 <p><a href="https://github.com/rclone/rclone/compare/v1.52.0...v1.52.1">See commits</a></p> 41047 <ul> 41048 <li>Bug Fixes 41049 <ul> 41050 <li>lib/file: Fix SetSparse on Windows 7 which fixes downloads of files > 250MB (Nick Craig-Wood)</li> 41051 <li>build 41052 <ul> 41053 <li>Update go.mod to go1.14 to enable -mod=vendor build (Nick Craig-Wood)</li> 41054 <li>Remove quicktest from Dockerfile (Nick Craig-Wood)</li> 41055 <li>Build Docker images with GitHub actions (Matteo Pietro Dazzi)</li> 41056 <li>Update Docker build workflows (Nick Craig-Wood)</li> 41057 <li>Set user_allow_other in /etc/fuse.conf in the Docker image (Nick Craig-Wood)</li> 41058 <li>Fix xgo build after go1.14 go.mod update (Nick Craig-Wood)</li> 41059 </ul></li> 41060 <li>docs 41061 <ul> 41062 <li>Add link to source and modified time to footer of every page (Nick Craig-Wood)</li> 41063 <li>Remove manually set dates and use git dates instead (Nick Craig-Wood)</li> 41064 <li>Minor tense, punctuation, brevity and positivity changes for the home page (edwardxml)</li> 41065 <li>Remove leading slash in page reference in footer when present (Nick Craig-Wood)</li> 41066 <li>Note commands which need obscured input in the docs (Nick Craig-Wood)</li> 41067 <li>obscure: Write more help as we are referencing it elsewhere (Nick Craig-Wood)</li> 41068 </ul></li> 41069 </ul></li> 41070 <li>VFS 41071 <ul> 41072 <li>Fix OS vs Unix path confusion - fixes ChangeNotify on Windows (Nick Craig-Wood)</li> 41073 </ul></li> 41074 <li>Drive 41075 <ul> 41076 <li>Fix missing items when listing using --fast-list / ListR (Nick Craig-Wood)</li> 41077 </ul></li> 41078 <li>Putio 41079 <ul> 41080 <li>Fix panic on Object.Open (Cenk Alti)</li> 41081 </ul></li> 41082 <li>S3 41083 <ul> 41084 <li>Fix upload of single files into buckets without create permission (Nick Craig-Wood)</li> 41085 <li>Fix --header-upload (Nick Craig-Wood)</li> 41086 </ul></li> 41087 <li>Tardigrade 41088 <ul> 41089 <li>Fix listing bug by upgrading to v1.0.7</li> 41090 <li>Set UserAgent to rclone (Caleb Case)</li> 41091 </ul></li> 41092 </ul> 41093 <h2 id="v1.52.0---2020-05-27">v1.52.0 - 2020-05-27</h2> 41094 <p>Special thanks to Martin Michlmayr for proof reading and correcting all the docs and Edward Barker for helping re-write the front page.</p> 41095 <p><a href="https://github.com/rclone/rclone/compare/v1.51.0...v1.52.0">See commits</a></p> 41096 <ul> 41097 <li>New backends 41098 <ul> 41099 <li><a href="https://rclone.org/tardigrade/">Tardigrade</a> backend for use with storj.io (Caleb Case)</li> 41100 <li><a href="https://rclone.org/union/">Union</a> re-write to have multiple writable remotes (Max Sum)</li> 41101 <li><a href="/seafile">Seafile</a> for Seafile server (Fred <span class="citation" data-cites="creativeprojects">@creativeprojects</span>)</li> 41102 </ul></li> 41103 <li>New commands 41104 <ul> 41105 <li>backend: command for backend-specific commands (see backends) (Nick Craig-Wood)</li> 41106 <li>cachestats: Deprecate in favour of <code>rclone backend stats cache:</code> (Nick Craig-Wood)</li> 41107 <li>dbhashsum: Deprecate in favour of <code>rclone hashsum DropboxHash</code> (Nick Craig-Wood)</li> 41108 </ul></li> 41109 <li>New Features 41110 <ul> 41111 <li>Add <code>--header-download</code> and <code>--header-upload</code> flags for setting HTTP headers when uploading/downloading (Tim Gallant)</li> 41112 <li>Add <code>--header</code> flag to add HTTP headers to every HTTP transaction (Nick Craig-Wood)</li> 41113 <li>Add <code>--check-first</code> to do all checking before starting transfers (Nick Craig-Wood)</li> 41114 <li>Add <code>--track-renames-strategy</code> for configurable matching criteria for <code>--track-renames</code> (Bernd Schoolmann)</li> 41115 <li>Add <code>--cutoff-mode</code> hard,soft,cautious (Shing Kit Chan & Franklyn Tackitt)</li> 41116 <li>Filter flags (e.g. <code>--files-from -</code>) can read from stdin (fishbullet)</li> 41117 <li>Add <code>--error-on-no-transfer</code> option (Jon Fautley)</li> 41118 <li>Implement <code>--order-by xxx,mixed</code> for copying some small and some big files (Nick Craig-Wood)</li> 41119 <li>Allow <code>--max-backlog</code> to be negative meaning as large as possible (Nick Craig-Wood)</li> 41120 <li>Added <code>--no-unicode-normalization</code> flag to allow Unicode filenames to remain unique (Ben Zenker)</li> 41121 <li>Allow <code>--min-age</code>/<code>--max-age</code> to take a date as well as a duration (Nick Craig-Wood)</li> 41122 <li>Add rename statistics for file and directory renames (Nick Craig-Wood)</li> 41123 <li>Add statistics output to JSON log (reddi)</li> 41124 <li>Make stats be printed on non-zero exit code (Nick Craig-Wood)</li> 41125 <li>When running <code>--password-command</code> allow use of stdin (Sébastien Gross)</li> 41126 <li>Stop empty strings being a valid remote path (Nick Craig-Wood)</li> 41127 <li>accounting: support WriterTo for less memory copying (Nick Craig-Wood)</li> 41128 <li>build 41129 <ul> 41130 <li>Update to use go1.14 for the build (Nick Craig-Wood)</li> 41131 <li>Add <code>-trimpath</code> to release build for reproduceable builds (Nick Craig-Wood)</li> 41132 <li>Remove GOOS and GOARCH from Dockerfile (Brandon Philips)</li> 41133 </ul></li> 41134 <li>config 41135 <ul> 41136 <li>Fsync the config file after writing to save more reliably (Nick Craig-Wood)</li> 41137 <li>Add <code>--obscure</code> and <code>--no-obscure</code> flags to <code>config create</code>/<code>update</code> (Nick Craig-Wood)</li> 41138 <li>Make <code>config show</code> take <code>remote:</code> as well as <code>remote</code> (Nick Craig-Wood)</li> 41139 </ul></li> 41140 <li>copyurl: Add <code>--no-clobber</code> flag (Denis)</li> 41141 <li>delete: Added <code>--rmdirs</code> flag to delete directories as well (Kush)</li> 41142 <li>filter: Added <code>--files-from-raw</code> flag (Ankur Gupta)</li> 41143 <li>genautocomplete: Add support for fish shell (Matan Rosenberg)</li> 41144 <li>log: Add support for syslog LOCAL facilities (Patryk Jakuszew)</li> 41145 <li>lsjson: Add <code>--hash-type</code> parameter and use it in lsf to speed up hashing (Nick Craig-Wood)</li> 41146 <li>rc 41147 <ul> 41148 <li>Add <code>-o</code>/<code>--opt</code> and <code>-a</code>/<code>--arg</code> for more structured input (Nick Craig-Wood)</li> 41149 <li>Implement <code>backend/command</code> for running backend-specific commands remotely (Nick Craig-Wood)</li> 41150 <li>Add <code>mount/mount</code> command for starting <code>rclone mount</code> via the API (Chaitanya)</li> 41151 </ul></li> 41152 <li>rcd: Add Prometheus metrics support (Gary Kim)</li> 41153 <li>serve http 41154 <ul> 41155 <li>Added a <code>--template</code> flag for user defined markup (calistri)</li> 41156 <li>Add Last-Modified headers to files and directories (Nick Craig-Wood)</li> 41157 </ul></li> 41158 <li>serve sftp: Add support for multiple host keys by repeating <code>--key</code> flag (Maxime Suret)</li> 41159 <li>touch: Add <code>--localtime</code> flag to make <code>--timestamp</code> localtime not UTC (Nick Craig-Wood)</li> 41160 </ul></li> 41161 <li>Bug Fixes 41162 <ul> 41163 <li>accounting 41164 <ul> 41165 <li>Restore "Max number of stats groups reached" log line (Michał Matczuk)</li> 41166 <li>Correct exitcode on Transfer Limit Exceeded flag. (Anuar Serdaliyev)</li> 41167 <li>Reset bytes read during copy retry (Ankur Gupta)</li> 41168 <li>Fix race clearing stats (Nick Craig-Wood)</li> 41169 </ul></li> 41170 <li>copy: Only create empty directories when they don't exist on the remote (Ishuah Kariuki)</li> 41171 <li>dedupe: Stop dedupe deleting files with identical IDs (Nick Craig-Wood)</li> 41172 <li>oauth 41173 <ul> 41174 <li>Use custom http client so that <code>--no-check-certificate</code> is honored by oauth token fetch (Mark Spieth)</li> 41175 <li>Replace deprecated oauth2.NoContext (Lars Lehtonen)</li> 41176 </ul></li> 41177 <li>operations 41178 <ul> 41179 <li>Fix setting the timestamp on Windows for multithread copy (Nick Craig-Wood)</li> 41180 <li>Make rcat obey <code>--ignore-checksum</code> (Nick Craig-Wood)</li> 41181 <li>Make <code>--max-transfer</code> more accurate (Nick Craig-Wood)</li> 41182 </ul></li> 41183 <li>rc 41184 <ul> 41185 <li>Fix dropped error (Lars Lehtonen)</li> 41186 <li>Fix misplaced http server config (Xiaoxing Ye)</li> 41187 <li>Disable duplicate log (ElonH)</li> 41188 </ul></li> 41189 <li>serve dlna 41190 <ul> 41191 <li>Cds: don't specify childCount at all when unknown (Dan Walters)</li> 41192 <li>Cds: use modification time as date in dlna metadata (Dan Walters)</li> 41193 </ul></li> 41194 <li>serve restic: Fix tests after restic project removed vendoring (Nick Craig-Wood)</li> 41195 <li>sync 41196 <ul> 41197 <li>Fix incorrect "nothing to transfer" message using <code>--delete-before</code> (Nick Craig-Wood)</li> 41198 <li>Only create empty directories when they don't exist on the remote (Ishuah Kariuki)</li> 41199 </ul></li> 41200 </ul></li> 41201 <li>Mount 41202 <ul> 41203 <li>Add <code>--async-read</code> flag to disable asynchronous reads (Nick Craig-Wood)</li> 41204 <li>Ignore <code>--allow-root</code> flag with a warning as it has been removed upstream (Nick Craig-Wood)</li> 41205 <li>Warn if <code>--allow-non-empty</code> used on Windows and clarify docs (Nick Craig-Wood)</li> 41206 <li>Constrain to go1.13 or above otherwise bazil.org/fuse fails to compile (Nick Craig-Wood)</li> 41207 <li>Fix fail because of too long volume name (evileye)</li> 41208 <li>Report 1PB free for unknown disk sizes (Nick Craig-Wood)</li> 41209 <li>Map more rclone errors into file systems errors (Nick Craig-Wood)</li> 41210 <li>Fix disappearing cwd problem (Nick Craig-Wood)</li> 41211 <li>Use ReaddirPlus on Windows to improve directory listing performance (Nick Craig-Wood)</li> 41212 <li>Send a hint as to whether the filesystem is case insensitive or not (Nick Craig-Wood)</li> 41213 <li>Add rc command <code>mount/types</code> (Nick Craig-Wood)</li> 41214 <li>Change maximum leaf name length to 1024 bytes (Nick Craig-Wood)</li> 41215 </ul></li> 41216 <li>VFS 41217 <ul> 41218 <li>Add <code>--vfs-read-wait</code> and <code>--vfs-write-wait</code> flags to control time waiting for a sequential read/write (Nick Craig-Wood)</li> 41219 <li>Change default <code>--vfs-read-wait</code> to 20ms (it was 5ms and not configurable) (Nick Craig-Wood)</li> 41220 <li>Make <code>df</code> output more consistent on a rclone mount. (Yves G)</li> 41221 <li>Report 1PB free for unknown disk sizes (Nick Craig-Wood)</li> 41222 <li>Fix race condition caused by unlocked reading of Dir.path (Nick Craig-Wood)</li> 41223 <li>Make File lock and Dir lock not overlap to avoid deadlock (Nick Craig-Wood)</li> 41224 <li>Implement lock ordering between File and Dir to eliminate deadlocks (Nick Craig-Wood)</li> 41225 <li>Factor the vfs cache into its own package (Nick Craig-Wood)</li> 41226 <li>Pin the Fs in use in the Fs cache (Nick Craig-Wood)</li> 41227 <li>Add SetSys() methods to Node to allow caching stuff on a node (Nick Craig-Wood)</li> 41228 <li>Ignore file not found errors from Hash in Read.Release (Nick Craig-Wood)</li> 41229 <li>Fix hang in read wait code (Nick Craig-Wood)</li> 41230 </ul></li> 41231 <li>Local 41232 <ul> 41233 <li>Speed up multi thread downloads by using sparse files on Windows (Nick Craig-Wood)</li> 41234 <li>Implement <code>--local-no-sparse</code> flag for disabling sparse files (Nick Craig-Wood)</li> 41235 <li>Implement <code>rclone backend noop</code> for testing purposes (Nick Craig-Wood)</li> 41236 <li>Fix "file not found" errors on post transfer Hash calculation (Nick Craig-Wood)</li> 41237 </ul></li> 41238 <li>Cache 41239 <ul> 41240 <li>Implement <code>rclone backend stats</code> command (Nick Craig-Wood)</li> 41241 <li>Fix Server Side Copy with Temp Upload (Brandon McNama)</li> 41242 <li>Remove Unused Functions (Lars Lehtonen)</li> 41243 <li>Disable race tests until bbolt is fixed (Nick Craig-Wood)</li> 41244 <li>Move methods used for testing into test file (greatroar)</li> 41245 <li>Add Pin and Unpin and canonicalised lookup (Nick Craig-Wood)</li> 41246 <li>Use proper import path go.etcd.io/bbolt (Robert-André Mauchin)</li> 41247 </ul></li> 41248 <li>Crypt 41249 <ul> 41250 <li>Calculate hashes for uploads from local disk (Nick Craig-Wood) 41251 <ul> 41252 <li>This allows encrypted Jottacloud uploads without using local disk</li> 41253 <li>This means encrypted s3/b2 uploads will now have hashes</li> 41254 </ul></li> 41255 <li>Added <code>rclone backend decode</code>/<code>encode</code> commands to replicate functionality of <code>cryptdecode</code> (Anagh Kumar Baranwal)</li> 41256 <li>Get rid of the unused Cipher interface as it obfuscated the code (Nick Craig-Wood)</li> 41257 </ul></li> 41258 <li>Azure Blob 41259 <ul> 41260 <li>Implement streaming of unknown sized files so <code>rcat</code> is now supported (Nick Craig-Wood)</li> 41261 <li>Implement memory pooling to control memory use (Nick Craig-Wood)</li> 41262 <li>Add <code>--azureblob-disable-checksum</code> flag (Nick Craig-Wood)</li> 41263 <li>Retry <code>InvalidBlobOrBlock</code> error as it may indicate block concurrency problems (Nick Craig-Wood)</li> 41264 <li>Remove unused <code>Object.parseTimeString()</code> (Lars Lehtonen)</li> 41265 <li>Fix permission error on SAS URL limited to container (Nick Craig-Wood)</li> 41266 </ul></li> 41267 <li>B2 41268 <ul> 41269 <li>Add support for <code>--header-upload</code> and <code>--header-download</code> (Tim Gallant)</li> 41270 <li>Ignore directory markers at the root also (Nick Craig-Wood)</li> 41271 <li>Force the case of the SHA1 to lowercase (Nick Craig-Wood)</li> 41272 <li>Remove unused <code>largeUpload.clearUploadURL()</code> (Lars Lehtonen)</li> 41273 </ul></li> 41274 <li>Box 41275 <ul> 41276 <li>Add support for <code>--header-upload</code> and <code>--header-download</code> (Tim Gallant)</li> 41277 <li>Implement About to read size used (Nick Craig-Wood)</li> 41278 <li>Add token renew function for jwt auth (David Bramwell)</li> 41279 <li>Added support for interchangeable root folder for Box backend (Sunil Patra)</li> 41280 <li>Remove unnecessary iat from jws claims (David)</li> 41281 </ul></li> 41282 <li>Drive 41283 <ul> 41284 <li>Follow shortcuts by default, skip with <code>--drive-skip-shortcuts</code> (Nick Craig-Wood)</li> 41285 <li>Implement <code>rclone backend shortcut</code> command for creating shortcuts (Nick Craig-Wood)</li> 41286 <li>Added <code>rclone backend</code> command to change <code>service_account_file</code> and <code>chunk_size</code> (Anagh Kumar Baranwal)</li> 41287 <li>Fix missing files when using <code>--fast-list</code> and <code>--drive-shared-with-me</code> (Nick Craig-Wood)</li> 41288 <li>Fix duplicate items when using <code>--drive-shared-with-me</code> (Nick Craig-Wood)</li> 41289 <li>Extend <code>--drive-stop-on-upload-limit</code> to respond to <code>teamDriveFileLimitExceeded</code>. (harry)</li> 41290 <li>Don't delete files with multiple parents to avoid data loss (Nick Craig-Wood)</li> 41291 <li>Server side copy docs use default description if empty (Nick Craig-Wood)</li> 41292 </ul></li> 41293 <li>Dropbox 41294 <ul> 41295 <li>Make error insufficient space to be fatal (harry)</li> 41296 <li>Add info about required redirect url (Elan Ruusamäe)</li> 41297 </ul></li> 41298 <li>Fichier 41299 <ul> 41300 <li>Add support for <code>--header-upload</code> and <code>--header-download</code> (Tim Gallant)</li> 41301 <li>Implement custom pacer to deal with the new rate limiting (buengese)</li> 41302 </ul></li> 41303 <li>FTP 41304 <ul> 41305 <li>Fix lockup when using concurrency limit on failed connections (Nick Craig-Wood)</li> 41306 <li>Fix lockup on failed upload when using concurrency limit (Nick Craig-Wood)</li> 41307 <li>Fix lockup on Close failures when using concurrency limit (Nick Craig-Wood)</li> 41308 <li>Work around pureftp sending spurious 150 messages (Nick Craig-Wood)</li> 41309 </ul></li> 41310 <li>Google Cloud Storage 41311 <ul> 41312 <li>Add support for <code>--header-upload</code> and <code>--header-download</code> (Nick Craig-Wood)</li> 41313 <li>Add <code>ARCHIVE</code> storage class to help (Adam Stroud)</li> 41314 <li>Ignore directory markers at the root (Nick Craig-Wood)</li> 41315 </ul></li> 41316 <li>Googlephotos 41317 <ul> 41318 <li>Make the start year configurable (Daven)</li> 41319 <li>Add support for <code>--header-upload</code> and <code>--header-download</code> (Tim Gallant)</li> 41320 <li>Create feature/favorites directory (Brandon Philips)</li> 41321 <li>Fix "concurrent map write" error (Nick Craig-Wood)</li> 41322 <li>Don't put an image in error message (Nick Craig-Wood)</li> 41323 </ul></li> 41324 <li>HTTP 41325 <ul> 41326 <li>Improved directory listing with new template from Caddy project (calisro)</li> 41327 </ul></li> 41328 <li>Jottacloud 41329 <ul> 41330 <li>Implement <code>--jottacloud-trashed-only</code> (buengese)</li> 41331 <li>Add support for <code>--header-upload</code> and <code>--header-download</code> (Tim Gallant)</li> 41332 <li>Use <code>RawURLEncoding</code> when decoding base64 encoded login token (buengese)</li> 41333 <li>Implement cleanup (buengese)</li> 41334 <li>Update docs regarding cleanup, removed remains from old auth, and added warning about special mountpoints. (albertony)</li> 41335 </ul></li> 41336 <li>Mailru 41337 <ul> 41338 <li>Describe 2FA requirements (valery1707)</li> 41339 </ul></li> 41340 <li>Onedrive 41341 <ul> 41342 <li>Implement <code>--onedrive-server-side-across-configs</code> (Nick Craig-Wood)</li> 41343 <li>Add support for <code>--header-upload</code> and <code>--header-download</code> (Tim Gallant)</li> 41344 <li>Fix occasional 416 errors on multipart uploads (Nick Craig-Wood)</li> 41345 <li>Added maximum chunk size limit warning in the docs (Harry)</li> 41346 <li>Fix missing drive on config (Nick Craig-Wood)</li> 41347 <li>Make error <code>quotaLimitReached</code> to be fatal (harry)</li> 41348 </ul></li> 41349 <li>Opendrive 41350 <ul> 41351 <li>Add support for <code>--header-upload</code> and <code>--header-download</code> (Tim Gallant)</li> 41352 </ul></li> 41353 <li>Pcloud 41354 <ul> 41355 <li>Added support for interchangeable root folder for pCloud backend (Sunil Patra)</li> 41356 <li>Add support for <code>--header-upload</code> and <code>--header-download</code> (Tim Gallant)</li> 41357 <li>Fix initial config "Auth state doesn't match" message (Nick Craig-Wood)</li> 41358 </ul></li> 41359 <li>Premiumizeme 41360 <ul> 41361 <li>Add support for <code>--header-upload</code> and <code>--header-download</code> (Tim Gallant)</li> 41362 <li>Prune unused functions (Lars Lehtonen)</li> 41363 </ul></li> 41364 <li>Putio 41365 <ul> 41366 <li>Add support for <code>--header-upload</code> and <code>--header-download</code> (Nick Craig-Wood)</li> 41367 <li>Make downloading files use the rclone http Client (Nick Craig-Wood)</li> 41368 <li>Fix parsing of remotes with leading and trailing / (Nick Craig-Wood)</li> 41369 </ul></li> 41370 <li>Qingstor 41371 <ul> 41372 <li>Make <code>rclone cleanup</code> remove pending multipart uploads older than 24h (Nick Craig-Wood)</li> 41373 <li>Try harder to cancel failed multipart uploads (Nick Craig-Wood)</li> 41374 <li>Prune <code>multiUploader.list()</code> (Lars Lehtonen)</li> 41375 <li>Lint fix (Lars Lehtonen)</li> 41376 </ul></li> 41377 <li>S3 41378 <ul> 41379 <li>Add support for <code>--header-upload</code> and <code>--header-download</code> (Tim Gallant)</li> 41380 <li>Use memory pool for buffer allocations (Maciej Zimnoch)</li> 41381 <li>Add SSE-C support for AWS, Ceph, and MinIO (Jack Anderson)</li> 41382 <li>Fail fast multipart upload (Michał Matczuk)</li> 41383 <li>Report errors on bucket creation (mkdir) correctly (Nick Craig-Wood)</li> 41384 <li>Specify that Minio supports URL encoding in listings (Nick Craig-Wood)</li> 41385 <li>Added 500 as retryErrorCode (Michał Matczuk)</li> 41386 <li>Use <code>--low-level-retries</code> as the number of SDK retries (Aleksandar Janković)</li> 41387 <li>Fix multipart abort context (Aleksandar Jankovic)</li> 41388 <li>Replace deprecated <code>session.New()</code> with <code>session.NewSession()</code> (Lars Lehtonen)</li> 41389 <li>Use the provided size parameter when allocating a new memory pool (Joachim Brandon LeBlanc)</li> 41390 <li>Use rclone's low level retries instead of AWS SDK to fix listing retries (Nick Craig-Wood)</li> 41391 <li>Ignore directory markers at the root also (Nick Craig-Wood)</li> 41392 <li>Use single memory pool (Michał Matczuk)</li> 41393 <li>Do not resize buf on put to memBuf (Michał Matczuk)</li> 41394 <li>Improve docs for <code>--s3-disable-checksum</code> (Nick Craig-Wood)</li> 41395 <li>Don't leak memory or tokens in edge cases for multipart upload (Nick Craig-Wood)</li> 41396 </ul></li> 41397 <li>Seafile 41398 <ul> 41399 <li>Implement 2FA (Fred)</li> 41400 </ul></li> 41401 <li>SFTP 41402 <ul> 41403 <li>Added <code>--sftp-pem-key</code> to support inline key files (calisro)</li> 41404 <li>Fix post transfer copies failing with 0 size when using <code>set_modtime=false</code> (Nick Craig-Wood)</li> 41405 </ul></li> 41406 <li>Sharefile 41407 <ul> 41408 <li>Add support for <code>--header-upload</code> and <code>--header-download</code> (Tim Gallant)</li> 41409 </ul></li> 41410 <li>Sugarsync 41411 <ul> 41412 <li>Add support for <code>--header-upload</code> and <code>--header-download</code> (Tim Gallant)</li> 41413 </ul></li> 41414 <li>Swift 41415 <ul> 41416 <li>Add support for <code>--header-upload</code> and <code>--header-download</code> (Nick Craig-Wood)</li> 41417 <li>Fix cosmetic issue in error message (Martin Michlmayr)</li> 41418 </ul></li> 41419 <li>Union 41420 <ul> 41421 <li>Implement multiple writable remotes (Max Sum)</li> 41422 <li>Fix server-side copy (Max Sum)</li> 41423 <li>Implement ListR (Max Sum)</li> 41424 <li>Enable ListR when upstreams contain local (Max Sum)</li> 41425 </ul></li> 41426 <li>WebDAV 41427 <ul> 41428 <li>Add support for <code>--header-upload</code> and <code>--header-download</code> (Tim Gallant)</li> 41429 <li>Fix <code>X-OC-Mtime</code> header for Transip compatibility (Nick Craig-Wood)</li> 41430 <li>Report full and consistent usage with <code>about</code> (Yves G)</li> 41431 </ul></li> 41432 <li>Yandex 41433 <ul> 41434 <li>Add support for <code>--header-upload</code> and <code>--header-download</code> (Tim Gallant)</li> 41435 </ul></li> 41436 </ul> 41437 <h2 id="v1.51.0---2020-02-01">v1.51.0 - 2020-02-01</h2> 41438 <ul> 41439 <li>New backends 41440 <ul> 41441 <li><a href="https://rclone.org/memory/">Memory</a> (Nick Craig-Wood)</li> 41442 <li><a href="https://rclone.org/sugarsync/">Sugarsync</a> (Nick Craig-Wood)</li> 41443 </ul></li> 41444 <li>New Features 41445 <ul> 41446 <li>Adjust all backends to have <code>--backend-encoding</code> parameter (Nick Craig-Wood) 41447 <ul> 41448 <li>this enables the encoding for special characters to be adjusted or disabled</li> 41449 </ul></li> 41450 <li>Add <code>--max-duration</code> flag to control the maximum duration of a transfer session (boosh)</li> 41451 <li>Add <code>--expect-continue-timeout</code> flag, default 1s (Nick Craig-Wood)</li> 41452 <li>Add <code>--no-check-dest</code> flag for copying without testing the destination (Nick Craig-Wood)</li> 41453 <li>Implement <code>--order-by</code> flag to order transfers (Nick Craig-Wood)</li> 41454 <li>accounting 41455 <ul> 41456 <li>Don't show entries in both transferring and checking (Nick Craig-Wood)</li> 41457 <li>Add option to delete stats (Aleksandar Jankovic)</li> 41458 </ul></li> 41459 <li>build 41460 <ul> 41461 <li>Compress the test builds with gzip (Nick Craig-Wood)</li> 41462 <li>Implement a framework for starting test servers during tests (Nick Craig-Wood)</li> 41463 </ul></li> 41464 <li>cmd: Always print elapsed time to tenth place seconds in progress (Gary Kim)</li> 41465 <li>config 41466 <ul> 41467 <li>Add <code>--password-command</code> to allow dynamic config password (Damon Permezel)</li> 41468 <li>Give config questions default values (Nick Craig-Wood)</li> 41469 <li>Check a remote exists when creating a new one (Nick Craig-Wood)</li> 41470 </ul></li> 41471 <li>copyurl: Add <code>--stdout</code> flag to write to stdout (Nick Craig-Wood)</li> 41472 <li>dedupe: Implement keep smallest too (Nick Craig-Wood)</li> 41473 <li>hashsum: Add flag <code>--base64</code> flag (landall)</li> 41474 <li>lsf: Speed up on s3/swift/etc by not reading mimetype by default (Nick Craig-Wood)</li> 41475 <li>lsjson: Add <code>--no-mimetype</code> flag (Nick Craig-Wood)</li> 41476 <li>rc: Add methods to turn on blocking and mutex profiling (Nick Craig-Wood)</li> 41477 <li>rcd 41478 <ul> 41479 <li>Adding group parameter to stats (Chaitanya)</li> 41480 <li>Move webgui apart; option to disable browser (Xiaoxing Ye)</li> 41481 </ul></li> 41482 <li>serve sftp: Add support for public key with auth proxy (Paul Tinsley)</li> 41483 <li>stats: Show deletes in stats and hide zero stats (anuar45)</li> 41484 </ul></li> 41485 <li>Bug Fixes 41486 <ul> 41487 <li>accounting 41488 <ul> 41489 <li>Fix error counter counting multiple times (Ankur Gupta)</li> 41490 <li>Fix error count shown as checks (Cnly)</li> 41491 <li>Clear finished transfer in stats-reset (Maciej Zimnoch)</li> 41492 <li>Added StatsInfo locking in statsGroups sum function (Michał Matczuk)</li> 41493 </ul></li> 41494 <li>asyncreader: Fix EOF error (buengese)</li> 41495 <li>check: Fix <code>--one-way</code> recursing more directories than it needs to (Nick Craig-Wood)</li> 41496 <li>chunkedreader: Disable hash calculation for first segment (Nick Craig-Wood)</li> 41497 <li>config 41498 <ul> 41499 <li>Do not open browser on headless on drive/gcs/google photos (Xiaoxing Ye)</li> 41500 <li>SetValueAndSave ignore error if config section does not exist yet (buengese)</li> 41501 </ul></li> 41502 <li>cmd: Fix completion with an encrypted config (Danil Semelenov)</li> 41503 <li>dbhashsum: Stop it returning UNSUPPORTED on dropbox (Nick Craig-Wood)</li> 41504 <li>dedupe: Add missing modes to help string (Nick Craig-Wood)</li> 41505 <li>operations 41506 <ul> 41507 <li>Fix dedupe continuing on errors like insufficientFilePersimmon (SezalAgrawal)</li> 41508 <li>Clear accounting before low level retry (Maciej Zimnoch)</li> 41509 <li>Write debug message when hashes could not be checked (Ole Schütt)</li> 41510 <li>Move interface assertion to tests to remove pflag dependency (Nick Craig-Wood)</li> 41511 <li>Make NewOverrideObjectInfo public and factor uses (Nick Craig-Wood)</li> 41512 </ul></li> 41513 <li>proxy: Replace use of bcrypt with sha256 (Nick Craig-Wood)</li> 41514 <li>vendor 41515 <ul> 41516 <li>Update bazil.org/fuse to fix FreeBSD 12.1 (Nick Craig-Wood)</li> 41517 <li>Update github.com/t3rm1n4l/go-mega to fix mega "illegal base64 data at input byte 22" (Nick Craig-Wood)</li> 41518 <li>Update termbox-go to fix ncdu command on FreeBSD (Kuang-che Wu)</li> 41519 <li>Update t3rm1n4l/go-mega - fixes mega: couldn't login: crypto/aes: invalid key size 0 (Nick Craig-Wood)</li> 41520 </ul></li> 41521 </ul></li> 41522 <li>Mount 41523 <ul> 41524 <li>Enable async reads for a 20% speedup (Nick Craig-Wood)</li> 41525 <li>Replace use of WriteAt with Write for cache mode >= writes and O_APPEND (Brett Dutro)</li> 41526 <li>Make sure we call unmount when exiting (Nick Craig-Wood)</li> 41527 <li>Don't build on go1.10 as bazil/fuse no longer supports it (Nick Craig-Wood)</li> 41528 <li>When setting dates discard out of range dates (Nick Craig-Wood)</li> 41529 </ul></li> 41530 <li>VFS 41531 <ul> 41532 <li>Add a newly created file straight into the directory (Nick Craig-Wood)</li> 41533 <li>Only calculate one hash for reads for a speedup (Nick Craig-Wood)</li> 41534 <li>Make ReadAt for non cached files work better with non-sequential reads (Nick Craig-Wood)</li> 41535 <li>Fix edge cases when reading ModTime from file (Nick Craig-Wood)</li> 41536 <li>Make sure existing files opened for write show correct size (Nick Craig-Wood)</li> 41537 <li>Don't cache the path in RW file objects to fix renaming (Nick Craig-Wood)</li> 41538 <li>Fix rename of open files when using the VFS cache (Nick Craig-Wood)</li> 41539 <li>When renaming files in the cache, rename the cache item in memory too (Nick Craig-Wood)</li> 41540 <li>Fix open file renaming on drive when using <code>--vfs-cache-mode writes</code> (Nick Craig-Wood)</li> 41541 <li>Fix incorrect modtime for mv into mount with <code>--vfs-cache-modes writes</code> (Nick Craig-Wood)</li> 41542 <li>On rename, rename in cache too if the file exists (Anagh Kumar Baranwal)</li> 41543 </ul></li> 41544 <li>Local 41545 <ul> 41546 <li>Make source file being updated errors be NoLowLevelRetry errors (Nick Craig-Wood)</li> 41547 <li>Fix update of hidden files on Windows (Nick Craig-Wood)</li> 41548 </ul></li> 41549 <li>Cache 41550 <ul> 41551 <li>Follow move of upstream library github.com/coreos/bbolt github.com/etcd-io/bbolt (Nick Craig-Wood)</li> 41552 <li>Fix <code>fatal error: concurrent map writes</code> (Nick Craig-Wood)</li> 41553 </ul></li> 41554 <li>Crypt 41555 <ul> 41556 <li>Reorder the filename encryption options (Thomas Eales)</li> 41557 <li>Correctly handle trailing dot (buengese)</li> 41558 </ul></li> 41559 <li>Chunker 41560 <ul> 41561 <li>Reduce length of temporary suffix (Ivan Andreev)</li> 41562 </ul></li> 41563 <li>Drive 41564 <ul> 41565 <li>Add <code>--drive-stop-on-upload-limit</code> flag to stop syncs when upload limit reached (Nick Craig-Wood)</li> 41566 <li>Add <code>--drive-use-shared-date</code> to use date file was shared instead of modified date (Garry McNulty)</li> 41567 <li>Make sure invalid auth for teamdrives always reports an error (Nick Craig-Wood)</li> 41568 <li>Fix <code>--fast-list</code> when using appDataFolder (Nick Craig-Wood)</li> 41569 <li>Use multipart resumable uploads for streaming and uploads in mount (Nick Craig-Wood)</li> 41570 <li>Log an ERROR if an incomplete search is returned (Nick Craig-Wood)</li> 41571 <li>Hide dangerous config from the configurator (Nick Craig-Wood)</li> 41572 </ul></li> 41573 <li>Dropbox 41574 <ul> 41575 <li>Treat <code>insufficient_space</code> errors as non retriable errors (Nick Craig-Wood)</li> 41576 </ul></li> 41577 <li>Jottacloud 41578 <ul> 41579 <li>Use new auth method used by official client (buengese)</li> 41580 <li>Add URL to generate Login Token to config wizard (Nick Craig-Wood)</li> 41581 <li>Add support whitelabel versions (buengese)</li> 41582 </ul></li> 41583 <li>Koofr 41584 <ul> 41585 <li>Use rclone HTTP client. (jaKa)</li> 41586 </ul></li> 41587 <li>Onedrive 41588 <ul> 41589 <li>Add Sites.Read.All permission (Benjamin Richter)</li> 41590 <li>Add support "Retry-After" header (Motonori IWAMURO)</li> 41591 </ul></li> 41592 <li>Opendrive 41593 <ul> 41594 <li>Implement <code>--opendrive-chunk-size</code> (Nick Craig-Wood)</li> 41595 </ul></li> 41596 <li>S3 41597 <ul> 41598 <li>Re-implement multipart upload to fix memory issues (Nick Craig-Wood)</li> 41599 <li>Add <code>--s3-copy-cutoff</code> for size to switch to multipart copy (Nick Craig-Wood)</li> 41600 <li>Add new region Asia Pacific (Hong Kong) (Outvi V)</li> 41601 <li>Reduce memory usage streaming files by reducing max stream upload size (Nick Craig-Wood)</li> 41602 <li>Add <code>--s3-list-chunk</code> option for bucket listing (Thomas Kriechbaumer)</li> 41603 <li>Force path style bucket access to off for AWS deprecation (Nick Craig-Wood)</li> 41604 <li>Use AWS web identity role provider if available (Tennix)</li> 41605 <li>Add StackPath Object Storage Support (Dave Koston)</li> 41606 <li>Fix ExpiryWindow value (Aleksandar Jankovic)</li> 41607 <li>Fix DisableChecksum condition (Aleksandar Janković)</li> 41608 <li>Fix URL decoding of NextMarker (Nick Craig-Wood)</li> 41609 </ul></li> 41610 <li>SFTP 41611 <ul> 41612 <li>Add <code>--sftp-skip-links</code> to skip symlinks and non regular files (Nick Craig-Wood)</li> 41613 <li>Retry Creation of Connection (Sebastian Brandt)</li> 41614 <li>Fix "failed to parse private key file: ssh: not an encrypted key" error (Nick Craig-Wood)</li> 41615 <li>Open files for update write only to fix AWS SFTP interop (Nick Craig-Wood)</li> 41616 </ul></li> 41617 <li>Swift 41618 <ul> 41619 <li>Reserve segments of dynamic large object when delete objects in container what was enabled versioning. (Nguyễn Hữu Luân)</li> 41620 <li>Fix parsing of X-Object-Manifest (Nick Craig-Wood)</li> 41621 <li>Update OVH API endpoint (unbelauscht)</li> 41622 </ul></li> 41623 <li>WebDAV 41624 <ul> 41625 <li>Make nextcloud only upload SHA1 checksums (Nick Craig-Wood)</li> 41626 <li>Fix case of "Bearer" in Authorization: header to agree with RFC (Nick Craig-Wood)</li> 41627 <li>Add Referer header to fix problems with WAFs (Nick Craig-Wood)</li> 41628 </ul></li> 41629 </ul> 41630 <h2 id="v1.50.2---2019-11-19">v1.50.2 - 2019-11-19</h2> 41631 <ul> 41632 <li>Bug Fixes 41633 <ul> 41634 <li>accounting: Fix memory leak on retries operations (Nick Craig-Wood)</li> 41635 </ul></li> 41636 <li>Drive 41637 <ul> 41638 <li>Fix listing of the root directory with drive.files scope (Nick Craig-Wood)</li> 41639 <li>Fix --drive-root-folder-id with team/shared drives (Nick Craig-Wood)</li> 41640 </ul></li> 41641 </ul> 41642 <h2 id="v1.50.1---2019-11-02">v1.50.1 - 2019-11-02</h2> 41643 <ul> 41644 <li>Bug Fixes 41645 <ul> 41646 <li>hash: Fix accidentally changed hash names for <code>DropboxHash</code> and <code>CRC-32</code> (Nick Craig-Wood)</li> 41647 <li>fshttp: Fix error reporting on tpslimit token bucket errors (Nick Craig-Wood)</li> 41648 <li>fshttp: Don't print token bucket errors on context cancelled (Nick Craig-Wood)</li> 41649 </ul></li> 41650 <li>Local 41651 <ul> 41652 <li>Fix listings of . on Windows (Nick Craig-Wood)</li> 41653 </ul></li> 41654 <li>Onedrive 41655 <ul> 41656 <li>Fix DirMove/Move after Onedrive change (Xiaoxing Ye)</li> 41657 </ul></li> 41658 </ul> 41659 <h2 id="v1.50.0---2019-10-26">v1.50.0 - 2019-10-26</h2> 41660 <ul> 41661 <li>New backends 41662 <ul> 41663 <li><a href="https://rclone.org/sharefile/">Citrix Sharefile</a> (Nick Craig-Wood)</li> 41664 <li><a href="https://rclone.org/chunker/">Chunker</a> - an overlay backend to split files into smaller parts (Ivan Andreev)</li> 41665 <li><a href="https://rclone.org/mailru/">Mail.ru Cloud</a> (Ivan Andreev)</li> 41666 </ul></li> 41667 <li>New Features 41668 <ul> 41669 <li>encodings (Fabian Möller & Nick Craig-Wood) 41670 <ul> 41671 <li>All backends now use file name encoding to ensure any file name can be written to any backend.</li> 41672 <li>See the <a href="https://rclone.org/overview/#restricted-filenames">restricted file name docs</a> for more info and the <a href="/local/#filenames">local backend docs</a>.</li> 41673 <li>Some file names may look different in rclone if you are using any control characters in names or <a href="https://en.wikipedia.org/wiki/Halfwidth_and_Fullwidth_Forms_(Unicode_block)">unicode FULLWIDTH symbols</a>.</li> 41674 </ul></li> 41675 <li>build 41676 <ul> 41677 <li>Update to use go1.13 for the build (Nick Craig-Wood)</li> 41678 <li>Drop support for go1.9 (Nick Craig-Wood)</li> 41679 <li>Build rclone with GitHub actions (Nick Craig-Wood)</li> 41680 <li>Convert python scripts to python3 (Nick Craig-Wood)</li> 41681 <li>Swap Azure/go-ansiterm for mattn/go-colorable (Nick Craig-Wood)</li> 41682 <li>Dockerfile fixes (Matei David)</li> 41683 <li>Add <a href="https://github.com/rclone/rclone/blob/master/CONTRIBUTING.md#writing-a-plugin">plugin support</a> for backends and commands (Richard Patel)</li> 41684 </ul></li> 41685 <li>config 41686 <ul> 41687 <li>Use alternating Red/Green in config to make more obvious (Nick Craig-Wood)</li> 41688 </ul></li> 41689 <li>contrib 41690 <ul> 41691 <li>Add sample DLNA server Docker Compose manifest. (pataquets)</li> 41692 <li>Add sample WebDAV server Docker Compose manifest. (pataquets)</li> 41693 </ul></li> 41694 <li>copyurl 41695 <ul> 41696 <li>Add <code>--auto-filename</code> flag for using file name from URL in destination path (Denis)</li> 41697 </ul></li> 41698 <li>serve dlna: 41699 <ul> 41700 <li>Many compatibility improvements (Dan Walters)</li> 41701 <li>Support for external srt subtitles (Dan Walters)</li> 41702 </ul></li> 41703 <li>rc 41704 <ul> 41705 <li>Added command core/quit (Saksham Khanna)</li> 41706 </ul></li> 41707 </ul></li> 41708 <li>Bug Fixes 41709 <ul> 41710 <li>sync 41711 <ul> 41712 <li>Make <code>--update</code>/<code>-u</code> not transfer files that haven't changed (Nick Craig-Wood)</li> 41713 <li>Free objects after they come out of the transfer pipe to save memory (Nick Craig-Wood)</li> 41714 <li>Fix <code>--files-from without --no-traverse</code> doing a recursive scan (Nick Craig-Wood)</li> 41715 </ul></li> 41716 <li>operations 41717 <ul> 41718 <li>Fix accounting for server-side copies (Nick Craig-Wood)</li> 41719 <li>Display 'All duplicates removed' only if dedupe successful (Sezal Agrawal)</li> 41720 <li>Display 'Deleted X extra copies' only if dedupe successful (Sezal Agrawal)</li> 41721 </ul></li> 41722 <li>accounting 41723 <ul> 41724 <li>Only allow up to 100 completed transfers in the accounting list to save memory (Nick Craig-Wood)</li> 41725 <li>Cull the old time ranges when possible to save memory (Nick Craig-Wood)</li> 41726 <li>Fix panic due to server-side copy fallback (Ivan Andreev)</li> 41727 <li>Fix memory leak noticeable for transfers of large numbers of objects (Nick Craig-Wood)</li> 41728 <li>Fix total duration calculation (Nick Craig-Wood)</li> 41729 </ul></li> 41730 <li>cmd 41731 <ul> 41732 <li>Fix environment variables not setting command line flags (Nick Craig-Wood)</li> 41733 <li>Make autocomplete compatible with bash's posix mode for macOS (Danil Semelenov)</li> 41734 <li>Make <code>--progress</code> work in git bash on Windows (Nick Craig-Wood)</li> 41735 <li>Fix 'compopt: command not found' on autocomplete on macOS (Danil Semelenov)</li> 41736 </ul></li> 41737 <li>config 41738 <ul> 41739 <li>Fix setting of non top level flags from environment variables (Nick Craig-Wood)</li> 41740 <li>Check config names more carefully and report errors (Nick Craig-Wood)</li> 41741 <li>Remove error: can't use <code>--size-only</code> and <code>--ignore-size</code> together. (Nick Craig-Wood)</li> 41742 </ul></li> 41743 <li>filter: Prevent mixing options when <code>--files-from</code> is in use (Michele Caci)</li> 41744 <li>serve sftp: Fix crash on unsupported operations (e.g. Readlink) (Nick Craig-Wood)</li> 41745 </ul></li> 41746 <li>Mount 41747 <ul> 41748 <li>Allow files of unknown size to be read properly (Nick Craig-Wood)</li> 41749 <li>Skip tests on <= 2 CPUs to avoid lockup (Nick Craig-Wood)</li> 41750 <li>Fix panic on File.Open (Nick Craig-Wood)</li> 41751 <li>Fix "mount_fusefs: -o timeout=: option not supported" on FreeBSD (Nick Craig-Wood)</li> 41752 <li>Don't pass huge filenames (>4k) to FUSE as it can't cope (Nick Craig-Wood)</li> 41753 </ul></li> 41754 <li>VFS 41755 <ul> 41756 <li>Add flag <code>--vfs-case-insensitive</code> for windows/macOS mounts (Ivan Andreev)</li> 41757 <li>Make objects of unknown size readable through the VFS (Nick Craig-Wood)</li> 41758 <li>Move writeback of dirty data out of close() method into its own method (FlushWrites) and remove close() call from Flush() (Brett Dutro)</li> 41759 <li>Stop empty dirs disappearing when renamed on bucket-based remotes (Nick Craig-Wood)</li> 41760 <li>Stop change notify polling clearing so much of the directory cache (Nick Craig-Wood)</li> 41761 </ul></li> 41762 <li>Azure Blob 41763 <ul> 41764 <li>Disable logging to the Windows event log (Nick Craig-Wood)</li> 41765 </ul></li> 41766 <li>B2 41767 <ul> 41768 <li>Remove <code>unverified:</code> prefix on sha1 to improve interop (e.g. with CyberDuck) (Nick Craig-Wood)</li> 41769 </ul></li> 41770 <li>Box 41771 <ul> 41772 <li>Add options to get access token via JWT auth (David)</li> 41773 </ul></li> 41774 <li>Drive 41775 <ul> 41776 <li>Disable HTTP/2 by default to work around INTERNAL_ERROR problems (Nick Craig-Wood)</li> 41777 <li>Make sure that drive root ID is always canonical (Nick Craig-Wood)</li> 41778 <li>Fix <code>--drive-shared-with-me</code> from the root with lsand <code>--fast-list</code> (Nick Craig-Wood)</li> 41779 <li>Fix ChangeNotify polling for shared drives (Nick Craig-Wood)</li> 41780 <li>Fix change notify polling when using appDataFolder (Nick Craig-Wood)</li> 41781 </ul></li> 41782 <li>Dropbox 41783 <ul> 41784 <li>Make disallowed filenames errors not retry (Nick Craig-Wood)</li> 41785 <li>Fix nil pointer exception on restricted files (Nick Craig-Wood)</li> 41786 </ul></li> 41787 <li>Fichier 41788 <ul> 41789 <li>Fix accessing files > 2GB on 32 bit systems (Nick Craig-Wood)</li> 41790 </ul></li> 41791 <li>FTP 41792 <ul> 41793 <li>Allow disabling EPSV mode (Jon Fautley)</li> 41794 </ul></li> 41795 <li>HTTP 41796 <ul> 41797 <li>HEAD directory entries in parallel to speedup (Nick Craig-Wood)</li> 41798 <li>Add <code>--http-no-head</code> to stop rclone doing HEAD in listings (Nick Craig-Wood)</li> 41799 </ul></li> 41800 <li>Putio 41801 <ul> 41802 <li>Add ability to resume uploads (Cenk Alti)</li> 41803 </ul></li> 41804 <li>S3 41805 <ul> 41806 <li>Fix signature v2_auth headers (Anthony Rusdi)</li> 41807 <li>Fix encoding for control characters (Nick Craig-Wood)</li> 41808 <li>Only ask for URL encoded directory listings if we need them on Ceph (Nick Craig-Wood)</li> 41809 <li>Add option for multipart failure behaviour (Aleksandar Jankovic)</li> 41810 <li>Support for multipart copy (庄天翼)</li> 41811 <li>Fix nil pointer reference if no metadata returned for object (Nick Craig-Wood)</li> 41812 </ul></li> 41813 <li>SFTP 41814 <ul> 41815 <li>Fix <code>--sftp-ask-password</code> trying to contact the ssh agent (Nick Craig-Wood)</li> 41816 <li>Fix hashes of files with backslashes (Nick Craig-Wood)</li> 41817 <li>Include more ciphers with <code>--sftp-use-insecure-cipher</code> (Carlos Ferreyra)</li> 41818 </ul></li> 41819 <li>WebDAV 41820 <ul> 41821 <li>Parse and return Sharepoint error response (Henning Surmeier)</li> 41822 </ul></li> 41823 </ul> 41824 <h2 id="v1.49.5---2019-10-05">v1.49.5 - 2019-10-05</h2> 41825 <ul> 41826 <li>Bug Fixes 41827 <ul> 41828 <li>Revert back to go1.12.x for the v1.49.x builds as go1.13.x was causing issues (Nick Craig-Wood)</li> 41829 <li>Fix rpm packages by using master builds of nfpm (Nick Craig-Wood)</li> 41830 <li>Fix macOS build after brew changes (Nick Craig-Wood)</li> 41831 </ul></li> 41832 </ul> 41833 <h2 id="v1.49.4---2019-09-29">v1.49.4 - 2019-09-29</h2> 41834 <ul> 41835 <li>Bug Fixes 41836 <ul> 41837 <li>cmd/rcd: Address ZipSlip vulnerability (Richard Patel)</li> 41838 <li>accounting: Fix file handle leak on errors (Nick Craig-Wood)</li> 41839 <li>oauthutil: Fix security problem when running with two users on the same machine (Nick Craig-Wood)</li> 41840 </ul></li> 41841 <li>FTP 41842 <ul> 41843 <li>Fix listing of an empty root returning: error dir not found (Nick Craig-Wood)</li> 41844 </ul></li> 41845 <li>S3 41846 <ul> 41847 <li>Fix SetModTime on GLACIER/ARCHIVE objects and implement set/get tier (Nick Craig-Wood)</li> 41848 </ul></li> 41849 </ul> 41850 <h2 id="v1.49.3---2019-09-15">v1.49.3 - 2019-09-15</h2> 41851 <ul> 41852 <li>Bug Fixes 41853 <ul> 41854 <li>accounting 41855 <ul> 41856 <li>Fix total duration calculation (Aleksandar Jankovic)</li> 41857 <li>Fix "file already closed" on transfer retries (Nick Craig-Wood)</li> 41858 </ul></li> 41859 </ul></li> 41860 </ul> 41861 <h2 id="v1.49.2---2019-09-08">v1.49.2 - 2019-09-08</h2> 41862 <ul> 41863 <li>New Features 41864 <ul> 41865 <li>build: Add Docker workflow support (Alfonso Montero)</li> 41866 </ul></li> 41867 <li>Bug Fixes 41868 <ul> 41869 <li>accounting: Fix locking in Transfer to avoid deadlock with <code>--progress</code> (Nick Craig-Wood)</li> 41870 <li>docs: Fix template argument for mktemp in install.sh (Cnly)</li> 41871 <li>operations: Fix <code>-u</code>/<code>--update</code> with google photos / files of unknown size (Nick Craig-Wood)</li> 41872 <li>rc: Fix docs for config/create /update /password (Nick Craig-Wood)</li> 41873 </ul></li> 41874 <li>Google Cloud Storage 41875 <ul> 41876 <li>Fix need for elevated permissions on SetModTime (Nick Craig-Wood)</li> 41877 </ul></li> 41878 </ul> 41879 <h2 id="v1.49.1---2019-08-28">v1.49.1 - 2019-08-28</h2> 41880 <ul> 41881 <li>Bug Fixes 41882 <ul> 41883 <li>config: Fix generated passwords being stored as empty password (Nick Craig-Wood)</li> 41884 <li>rcd: Added missing parameter for web-gui info logs. (Chaitanya)</li> 41885 </ul></li> 41886 <li>Googlephotos 41887 <ul> 41888 <li>Fix crash on error response (Nick Craig-Wood)</li> 41889 </ul></li> 41890 <li>Onedrive 41891 <ul> 41892 <li>Fix crash on error response (Nick Craig-Wood)</li> 41893 </ul></li> 41894 </ul> 41895 <h2 id="v1.49.0---2019-08-26">v1.49.0 - 2019-08-26</h2> 41896 <ul> 41897 <li>New backends 41898 <ul> 41899 <li><a href="https://rclone.org/fichier/">1fichier</a> (Laura Hausmann)</li> 41900 <li><a href="https://rclone.org/googlephotos/">Google Photos</a> (Nick Craig-Wood)</li> 41901 <li><a href="https://rclone.org/putio/">Putio</a> (Cenk Alti)</li> 41902 <li><a href="https://rclone.org/premiumizeme/">premiumize.me</a> (Nick Craig-Wood)</li> 41903 </ul></li> 41904 <li>New Features 41905 <ul> 41906 <li>Experimental <a href="https://rclone.org/gui/">web GUI</a> (Chaitanya Bankanhal)</li> 41907 <li>Implement <code>--compare-dest</code> & <code>--copy-dest</code> (yparitcher)</li> 41908 <li>Implement <code>--suffix</code> without <code>--backup-dir</code> for backup to current dir (yparitcher)</li> 41909 <li><code>config reconnect</code> to re-login (re-run the oauth login) for the backend. (Nick Craig-Wood)</li> 41910 <li><code>config userinfo</code> to discover which user you are logged in as. (Nick Craig-Wood)</li> 41911 <li><code>config disconnect</code> to disconnect you (log out) from the backend. (Nick Craig-Wood)</li> 41912 <li>Add <code>--use-json-log</code> for JSON logging (justinalin)</li> 41913 <li>Add context propagation to rclone (Aleksandar Jankovic)</li> 41914 <li>Reworking internal statistics interfaces so they work with rc jobs (Aleksandar Jankovic)</li> 41915 <li>Add Higher units for ETA (AbelThar)</li> 41916 <li>Update rclone logos to new design (Andreas Chlupka)</li> 41917 <li>hash: Add CRC-32 support (Cenk Alti)</li> 41918 <li>help showbackend: Fixed advanced option category when there are no standard options (buengese)</li> 41919 <li>ncdu: Display/Copy to Clipboard Current Path (Gary Kim)</li> 41920 <li>operations: 41921 <ul> 41922 <li>Run hashing operations in parallel (Nick Craig-Wood)</li> 41923 <li>Don't calculate checksums when using <code>--ignore-checksum</code> (Nick Craig-Wood)</li> 41924 <li>Check transfer hashes when using <code>--size-only</code> mode (Nick Craig-Wood)</li> 41925 <li>Disable multi thread copy for local to local copies (Nick Craig-Wood)</li> 41926 <li>Debug successful hashes as well as failures (Nick Craig-Wood)</li> 41927 </ul></li> 41928 <li>rc 41929 <ul> 41930 <li>Add ability to stop async jobs (Aleksandar Jankovic)</li> 41931 <li>Return current settings if core/bwlimit called without parameters (Nick Craig-Wood)</li> 41932 <li>Rclone-WebUI integration with rclone (Chaitanya Bankanhal)</li> 41933 <li>Added command line parameter to control the cross origin resource sharing (CORS) in the rcd. (Security Improvement) (Chaitanya Bankanhal)</li> 41934 <li>Add anchor tags to the docs so links are consistent (Nick Craig-Wood)</li> 41935 <li>Remove _async key from input parameters after parsing so later operations won't get confused (buengese)</li> 41936 <li>Add call to clear stats (Aleksandar Jankovic)</li> 41937 </ul></li> 41938 <li>rcd 41939 <ul> 41940 <li>Auto-login for web-gui (Chaitanya Bankanhal)</li> 41941 <li>Implement <code>--baseurl</code> for rcd and web-gui (Chaitanya Bankanhal)</li> 41942 </ul></li> 41943 <li>serve dlna 41944 <ul> 41945 <li>Only select interfaces which can multicast for SSDP (Nick Craig-Wood)</li> 41946 <li>Add more builtin mime types to cover standard audio/video (Nick Craig-Wood)</li> 41947 <li>Fix missing mime types on Android causing missing videos (Nick Craig-Wood)</li> 41948 </ul></li> 41949 <li>serve ftp 41950 <ul> 41951 <li>Refactor to bring into line with other serve commands (Nick Craig-Wood)</li> 41952 <li>Implement <code>--auth-proxy</code> (Nick Craig-Wood)</li> 41953 </ul></li> 41954 <li>serve http: Implement <code>--baseurl</code> (Nick Craig-Wood)</li> 41955 <li>serve restic: Implement <code>--baseurl</code> (Nick Craig-Wood)</li> 41956 <li>serve sftp 41957 <ul> 41958 <li>Implement auth proxy (Nick Craig-Wood)</li> 41959 <li>Fix detection of whether server is authorized (Nick Craig-Wood)</li> 41960 </ul></li> 41961 <li>serve webdav 41962 <ul> 41963 <li>Implement <code>--baseurl</code> (Nick Craig-Wood)</li> 41964 <li>Support <code>--auth-proxy</code> (Nick Craig-Wood)</li> 41965 </ul></li> 41966 </ul></li> 41967 <li>Bug Fixes 41968 <ul> 41969 <li>Make "bad record MAC" a retriable error (Nick Craig-Wood)</li> 41970 <li>copyurl: Fix copying files that return HTTP errors (Nick Craig-Wood)</li> 41971 <li>march: Fix checking sub-directories when using <code>--no-traverse</code> (buengese)</li> 41972 <li>rc 41973 <ul> 41974 <li>Fix unmarshalable http.AuthFn in options and put in test for marshalability (Nick Craig-Wood)</li> 41975 <li>Move job expire flags to rc to fix initialization problem (Nick Craig-Wood)</li> 41976 <li>Fix <code>--loopback</code> with rc/list and others (Nick Craig-Wood)</li> 41977 </ul></li> 41978 <li>rcat: Fix slowdown on systems with multiple hashes (Nick Craig-Wood)</li> 41979 <li>rcd: Fix permissions problems on cache directory with web gui download (Nick Craig-Wood)</li> 41980 </ul></li> 41981 <li>Mount 41982 <ul> 41983 <li>Default <code>--daemon-timeout</code> to 15 minutes on macOS and FreeBSD (Nick Craig-Wood)</li> 41984 <li>Update docs to show mounting from root OK for bucket-based (Nick Craig-Wood)</li> 41985 <li>Remove nonseekable flag from write files (Nick Craig-Wood)</li> 41986 </ul></li> 41987 <li>VFS 41988 <ul> 41989 <li>Make write without cache more efficient (Nick Craig-Wood)</li> 41990 <li>Fix <code>--vfs-cache-mode minimal</code> and <code>writes</code> ignoring cached files (Nick Craig-Wood)</li> 41991 </ul></li> 41992 <li>Local 41993 <ul> 41994 <li>Add <code>--local-case-sensitive</code> and <code>--local-case-insensitive</code> (Nick Craig-Wood)</li> 41995 <li>Avoid polluting page cache when uploading local files to remote backends (Michał Matczuk)</li> 41996 <li>Don't calculate any hashes by default (Nick Craig-Wood)</li> 41997 <li>Fadvise run syscall on a dedicated go routine (Michał Matczuk)</li> 41998 </ul></li> 41999 <li>Azure Blob 42000 <ul> 42001 <li>Azure Storage Emulator support (Sandeep)</li> 42002 <li>Updated config help details to remove connection string references (Sandeep)</li> 42003 <li>Make all operations work from the root (Nick Craig-Wood)</li> 42004 </ul></li> 42005 <li>B2 42006 <ul> 42007 <li>Implement link sharing (yparitcher)</li> 42008 <li>Enable server-side copy to copy between buckets (Nick Craig-Wood)</li> 42009 <li>Make all operations work from the root (Nick Craig-Wood)</li> 42010 </ul></li> 42011 <li>Drive 42012 <ul> 42013 <li>Fix server-side copy of big files (Nick Craig-Wood)</li> 42014 <li>Update API for teamdrive use (Nick Craig-Wood)</li> 42015 <li>Add error for purge with <code>--drive-trashed-only</code> (ginvine)</li> 42016 </ul></li> 42017 <li>Fichier 42018 <ul> 42019 <li>Make FolderID int and adjust related code (buengese)</li> 42020 </ul></li> 42021 <li>Google Cloud Storage 42022 <ul> 42023 <li>Reduce oauth scope requested as suggested by Google (Nick Craig-Wood)</li> 42024 <li>Make all operations work from the root (Nick Craig-Wood)</li> 42025 </ul></li> 42026 <li>HTTP 42027 <ul> 42028 <li>Add <code>--http-headers</code> flag for setting arbitrary headers (Nick Craig-Wood)</li> 42029 </ul></li> 42030 <li>Jottacloud 42031 <ul> 42032 <li>Use new api for retrieving internal username (buengese)</li> 42033 <li>Refactor configuration and minor cleanup (buengese)</li> 42034 </ul></li> 42035 <li>Koofr 42036 <ul> 42037 <li>Support setting modification times on Koofr backend. (jaKa)</li> 42038 </ul></li> 42039 <li>Opendrive 42040 <ul> 42041 <li>Refactor to use existing lib/rest facilities for uploads (Nick Craig-Wood)</li> 42042 </ul></li> 42043 <li>Qingstor 42044 <ul> 42045 <li>Upgrade to v3 SDK and fix listing loop (Nick Craig-Wood)</li> 42046 <li>Make all operations work from the root (Nick Craig-Wood)</li> 42047 </ul></li> 42048 <li>S3 42049 <ul> 42050 <li>Add INTELLIGENT_TIERING storage class (Matti Niemenmaa)</li> 42051 <li>Make all operations work from the root (Nick Craig-Wood)</li> 42052 </ul></li> 42053 <li>SFTP 42054 <ul> 42055 <li>Add missing interface check and fix About (Nick Craig-Wood)</li> 42056 <li>Completely ignore all modtime checks if SetModTime=false (Jon Fautley)</li> 42057 <li>Support md5/sha1 with rsync.net (Nick Craig-Wood)</li> 42058 <li>Save the md5/sha1 command in use to the config file for efficiency (Nick Craig-Wood)</li> 42059 <li>Opt-in support for diffie-hellman-group-exchange-sha256 diffie-hellman-group-exchange-sha1 (Yi FU)</li> 42060 </ul></li> 42061 <li>Swift 42062 <ul> 42063 <li>Use FixRangeOption to fix 0 length files via the VFS (Nick Craig-Wood)</li> 42064 <li>Fix upload when using no_chunk to return the correct size (Nick Craig-Wood)</li> 42065 <li>Make all operations work from the root (Nick Craig-Wood)</li> 42066 <li>Fix segments leak during failed large file uploads. (nguyenhuuluan434)</li> 42067 </ul></li> 42068 <li>WebDAV 42069 <ul> 42070 <li>Add <code>--webdav-bearer-token-command</code> (Nick Craig-Wood)</li> 42071 <li>Refresh token when it expires with <code>--webdav-bearer-token-command</code> (Nick Craig-Wood)</li> 42072 <li>Add docs for using bearer_token_command with oidc-agent (Paul Millar)</li> 42073 </ul></li> 42074 </ul> 42075 <h2 id="v1.48.0---2019-06-15">v1.48.0 - 2019-06-15</h2> 42076 <ul> 42077 <li>New commands 42078 <ul> 42079 <li>serve sftp: Serve an rclone remote over SFTP (Nick Craig-Wood)</li> 42080 </ul></li> 42081 <li>New Features 42082 <ul> 42083 <li>Multi threaded downloads to local storage (Nick Craig-Wood) 42084 <ul> 42085 <li>controlled with <code>--multi-thread-cutoff</code> and <code>--multi-thread-streams</code></li> 42086 </ul></li> 42087 <li>Use rclone.conf from rclone executable directory to enable portable use (albertony)</li> 42088 <li>Allow sync of a file and a directory with the same name (forgems) 42089 <ul> 42090 <li>this is common on bucket-based remotes, e.g. s3, gcs</li> 42091 </ul></li> 42092 <li>Add <code>--ignore-case-sync</code> for forced case insensitivity (garry415)</li> 42093 <li>Implement <code>--stats-one-line-date</code> and <code>--stats-one-line-date-format</code> (Peter Berbec)</li> 42094 <li>Log an ERROR for all commands which exit with non-zero status (Nick Craig-Wood)</li> 42095 <li>Use go-homedir to read the home directory more reliably (Nick Craig-Wood)</li> 42096 <li>Enable creating encrypted config through external script invocation (Wojciech Smigielski)</li> 42097 <li>build: Drop support for go1.8 (Nick Craig-Wood)</li> 42098 <li>config: Make config create/update encrypt passwords where necessary (Nick Craig-Wood)</li> 42099 <li>copyurl: Honor <code>--no-check-certificate</code> (Stefan Breunig)</li> 42100 <li>install: Linux skip man pages if no mandb (didil)</li> 42101 <li>lsf: Support showing the Tier of the object (Nick Craig-Wood)</li> 42102 <li>lsjson 42103 <ul> 42104 <li>Added EncryptedPath to output (calisro)</li> 42105 <li>Support showing the Tier of the object (Nick Craig-Wood)</li> 42106 <li>Add IsBucket field for bucket-based remote listing of the root (Nick Craig-Wood)</li> 42107 </ul></li> 42108 <li>rc 42109 <ul> 42110 <li>Add <code>--loopback</code> flag to run commands directly without a server (Nick Craig-Wood)</li> 42111 <li>Add operations/fsinfo: Return information about the remote (Nick Craig-Wood)</li> 42112 <li>Skip auth for OPTIONS request (Nick Craig-Wood)</li> 42113 <li>cmd/providers: Add DefaultStr, ValueStr and Type fields (Nick Craig-Wood)</li> 42114 <li>jobs: Make job expiry timeouts configurable (Aleksandar Jankovic)</li> 42115 </ul></li> 42116 <li>serve dlna reworked and improved (Dan Walters)</li> 42117 <li>serve ftp: add <code>--ftp-public-ip</code> flag to specify public IP (calistri)</li> 42118 <li>serve restic: Add support for <code>--private-repos</code> in <code>serve restic</code> (Florian Apolloner)</li> 42119 <li>serve webdav: Combine serve webdav and serve http (Gary Kim)</li> 42120 <li>size: Ignore negative sizes when calculating total (Garry McNulty)</li> 42121 </ul></li> 42122 <li>Bug Fixes 42123 <ul> 42124 <li>Make move and copy individual files obey <code>--backup-dir</code> (Nick Craig-Wood)</li> 42125 <li>If <code>--ignore-checksum</code> is in effect, don't calculate checksum (Nick Craig-Wood)</li> 42126 <li>moveto: Fix case-insensitive same remote move (Gary Kim)</li> 42127 <li>rc: Fix serving bucket-based objects with <code>--rc-serve</code> (Nick Craig-Wood)</li> 42128 <li>serve webdav: Fix serveDir not being updated with changes from webdav (Gary Kim)</li> 42129 </ul></li> 42130 <li>Mount 42131 <ul> 42132 <li>Fix poll interval documentation (Animosity022)</li> 42133 </ul></li> 42134 <li>VFS 42135 <ul> 42136 <li>Make WriteAt for non cached files work with non-sequential writes (Nick Craig-Wood)</li> 42137 </ul></li> 42138 <li>Local 42139 <ul> 42140 <li>Only calculate the required hashes for big speedup (Nick Craig-Wood)</li> 42141 <li>Log errors when listing instead of returning an error (Nick Craig-Wood)</li> 42142 <li>Fix preallocate warning on Linux with ZFS (Nick Craig-Wood)</li> 42143 </ul></li> 42144 <li>Crypt 42145 <ul> 42146 <li>Make rclone dedupe work through crypt (Nick Craig-Wood)</li> 42147 <li>Fix wrapping of ChangeNotify to decrypt directories properly (Nick Craig-Wood)</li> 42148 <li>Support PublicLink (rclone link) of underlying backend (Nick Craig-Wood)</li> 42149 <li>Implement Optional methods SetTier, GetTier (Nick Craig-Wood)</li> 42150 </ul></li> 42151 <li>B2 42152 <ul> 42153 <li>Implement server-side copy (Nick Craig-Wood)</li> 42154 <li>Implement SetModTime (Nick Craig-Wood)</li> 42155 </ul></li> 42156 <li>Drive 42157 <ul> 42158 <li>Fix move and copy from TeamDrive to GDrive (Fionera)</li> 42159 <li>Add notes that cleanup works in the background on drive (Nick Craig-Wood)</li> 42160 <li>Add <code>--drive-server-side-across-configs</code> to default back to old server-side copy semantics by default (Nick Craig-Wood)</li> 42161 <li>Add <code>--drive-size-as-quota</code> to show storage quota usage for file size (Garry McNulty)</li> 42162 </ul></li> 42163 <li>FTP 42164 <ul> 42165 <li>Add FTP List timeout (Jeff Quinn)</li> 42166 <li>Add FTP over TLS support (Gary Kim)</li> 42167 <li>Add <code>--ftp-no-check-certificate</code> option for FTPS (Gary Kim)</li> 42168 </ul></li> 42169 <li>Google Cloud Storage 42170 <ul> 42171 <li>Fix upload errors when uploading pre 1970 files (Nick Craig-Wood)</li> 42172 </ul></li> 42173 <li>Jottacloud 42174 <ul> 42175 <li>Add support for selecting device and mountpoint. (buengese)</li> 42176 </ul></li> 42177 <li>Mega 42178 <ul> 42179 <li>Add cleanup support (Gary Kim)</li> 42180 </ul></li> 42181 <li>Onedrive 42182 <ul> 42183 <li>More accurately check if root is found (Cnly)</li> 42184 </ul></li> 42185 <li>S3 42186 <ul> 42187 <li>Support S3 Accelerated endpoints with <code>--s3-use-accelerate-endpoint</code> (Nick Craig-Wood)</li> 42188 <li>Add config info for Wasabi's EU Central endpoint (Robert Marko)</li> 42189 <li>Make SetModTime work for GLACIER while syncing (Philip Harvey)</li> 42190 </ul></li> 42191 <li>SFTP 42192 <ul> 42193 <li>Add About support (Gary Kim)</li> 42194 <li>Fix about parsing of <code>df</code> results so it can cope with -ve results (Nick Craig-Wood)</li> 42195 <li>Send custom client version and debug server version (Nick Craig-Wood)</li> 42196 </ul></li> 42197 <li>WebDAV 42198 <ul> 42199 <li>Retry on 423 Locked errors (Nick Craig-Wood)</li> 42200 </ul></li> 42201 </ul> 42202 <h2 id="v1.47.0---2019-04-13">v1.47.0 - 2019-04-13</h2> 42203 <ul> 42204 <li>New backends 42205 <ul> 42206 <li>Backend for Koofr cloud storage service. (jaKa)</li> 42207 </ul></li> 42208 <li>New Features 42209 <ul> 42210 <li>Resume downloads if the reader fails in copy (Nick Craig-Wood) 42211 <ul> 42212 <li>this means rclone will restart transfers if the source has an error</li> 42213 <li>this is most useful for downloads or cloud to cloud copies</li> 42214 </ul></li> 42215 <li>Use <code>--fast-list</code> for listing operations where it won't use more memory (Nick Craig-Wood) 42216 <ul> 42217 <li>this should speed up the following operations on remotes which support <code>ListR</code></li> 42218 <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> 42219 <li>use <code>--disable ListR</code> to get old behaviour if required</li> 42220 </ul></li> 42221 <li>Make <code>--files-from</code> traverse the destination unless <code>--no-traverse</code> is set (Nick Craig-Wood) 42222 <ul> 42223 <li>this fixes <code>--files-from</code> with Google drive and excessive API use in general.</li> 42224 </ul></li> 42225 <li>Make server-side copy account bytes and obey <code>--max-transfer</code> (Nick Craig-Wood)</li> 42226 <li>Add <code>--create-empty-src-dirs</code> flag and default to not creating empty dirs (ishuah)</li> 42227 <li>Add client side TLS/SSL flags <code>--ca-cert</code>/<code>--client-cert</code>/<code>--client-key</code> (Nick Craig-Wood)</li> 42228 <li>Implement <code>--suffix-keep-extension</code> for use with <code>--suffix</code> (Nick Craig-Wood)</li> 42229 <li>build: 42230 <ul> 42231 <li>Switch to semver compliant version tags to be go modules compliant (Nick Craig-Wood)</li> 42232 <li>Update to use go1.12.x for the build (Nick Craig-Wood)</li> 42233 </ul></li> 42234 <li>serve dlna: Add connection manager service description to improve compatibility (Dan Walters)</li> 42235 <li>lsf: Add 'e' format to show encrypted names and 'o' for original IDs (Nick Craig-Wood)</li> 42236 <li>lsjson: Added <code>--files-only</code> and <code>--dirs-only</code> flags (calistri)</li> 42237 <li>rc: Implement operations/publiclink the equivalent of <code>rclone link</code> (Nick Craig-Wood)</li> 42238 </ul></li> 42239 <li>Bug Fixes 42240 <ul> 42241 <li>accounting: Fix total ETA when <code>--stats-unit bits</code> is in effect (Nick Craig-Wood)</li> 42242 <li>Bash TAB completion 42243 <ul> 42244 <li>Use private custom func to fix clash between rclone and kubectl (Nick Craig-Wood)</li> 42245 <li>Fix for remotes with underscores in their names (Six)</li> 42246 <li>Fix completion of remotes (Florian Gamböck)</li> 42247 <li>Fix autocompletion of remote paths with spaces (Danil Semelenov)</li> 42248 </ul></li> 42249 <li>serve dlna: Fix root XML service descriptor (Dan Walters)</li> 42250 <li>ncdu: Fix display corruption with Chinese characters (Nick Craig-Wood)</li> 42251 <li>Add SIGTERM to signals which run the exit handlers on unix (Nick Craig-Wood)</li> 42252 <li>rc: Reload filter when the options are set via the rc (Nick Craig-Wood)</li> 42253 </ul></li> 42254 <li>VFS / Mount 42255 <ul> 42256 <li>Fix FreeBSD: Ignore Truncate if called with no readers and already the correct size (Nick Craig-Wood)</li> 42257 <li>Read directory and check for a file before mkdir (Nick Craig-Wood)</li> 42258 <li>Shorten the locking window for vfs/refresh (Nick Craig-Wood)</li> 42259 </ul></li> 42260 <li>Azure Blob 42261 <ul> 42262 <li>Enable MD5 checksums when uploading files bigger than the "Cutoff" (Dr.Rx)</li> 42263 <li>Fix SAS URL support (Nick Craig-Wood)</li> 42264 </ul></li> 42265 <li>B2 42266 <ul> 42267 <li>Allow manual configuration of backblaze downloadUrl (Vince)</li> 42268 <li>Ignore already_hidden error on remove (Nick Craig-Wood)</li> 42269 <li>Ignore malformed <code>src_last_modified_millis</code> (Nick Craig-Wood)</li> 42270 </ul></li> 42271 <li>Drive 42272 <ul> 42273 <li>Add <code>--skip-checksum-gphotos</code> to ignore incorrect checksums on Google Photos (Nick Craig-Wood)</li> 42274 <li>Allow server-side move/copy between different remotes. (Fionera)</li> 42275 <li>Add docs on team drives and <code>--fast-list</code> eventual consistency (Nestar47)</li> 42276 <li>Fix imports of text files (Nick Craig-Wood)</li> 42277 <li>Fix range requests on 0 length files (Nick Craig-Wood)</li> 42278 <li>Fix creation of duplicates with server-side copy (Nick Craig-Wood)</li> 42279 </ul></li> 42280 <li>Dropbox 42281 <ul> 42282 <li>Retry blank errors to fix long listings (Nick Craig-Wood)</li> 42283 </ul></li> 42284 <li>FTP 42285 <ul> 42286 <li>Add <code>--ftp-concurrency</code> to limit maximum number of connections (Nick Craig-Wood)</li> 42287 </ul></li> 42288 <li>Google Cloud Storage 42289 <ul> 42290 <li>Fall back to default application credentials (marcintustin)</li> 42291 <li>Allow bucket policy only buckets (Nick Craig-Wood)</li> 42292 </ul></li> 42293 <li>HTTP 42294 <ul> 42295 <li>Add <code>--http-no-slash</code> for websites with directories with no slashes (Nick Craig-Wood)</li> 42296 <li>Remove duplicates from listings (Nick Craig-Wood)</li> 42297 <li>Fix socket leak on 404 errors (Nick Craig-Wood)</li> 42298 </ul></li> 42299 <li>Jottacloud 42300 <ul> 42301 <li>Fix token refresh (Sebastian Bünger)</li> 42302 <li>Add device registration (Oliver Heyme)</li> 42303 </ul></li> 42304 <li>Onedrive 42305 <ul> 42306 <li>Implement graceful cancel of multipart uploads if rclone is interrupted (Cnly)</li> 42307 <li>Always add trailing colon to path when addressing items, (Cnly)</li> 42308 <li>Return errors instead of panic for invalid uploads (Fabian Möller)</li> 42309 </ul></li> 42310 <li>S3 42311 <ul> 42312 <li>Add support for "Glacier Deep Archive" storage class (Manu)</li> 42313 <li>Update Dreamhost endpoint (Nick Craig-Wood)</li> 42314 <li>Note incompatibility with CEPH Jewel (Nick Craig-Wood)</li> 42315 </ul></li> 42316 <li>SFTP 42317 <ul> 42318 <li>Allow custom ssh client config (Alexandru Bumbacea)</li> 42319 </ul></li> 42320 <li>Swift 42321 <ul> 42322 <li>Obey Retry-After to enable OVH restore from cold storage (Nick Craig-Wood)</li> 42323 <li>Work around token expiry on CEPH (Nick Craig-Wood)</li> 42324 </ul></li> 42325 <li>WebDAV 42326 <ul> 42327 <li>Allow IsCollection property to be integer or boolean (Nick Craig-Wood)</li> 42328 <li>Fix race when creating directories (Nick Craig-Wood)</li> 42329 <li>Fix About/df when reading the available/total returns 0 (Nick Craig-Wood)</li> 42330 </ul></li> 42331 </ul> 42332 <h2 id="v1.46---2019-02-09">v1.46 - 2019-02-09</h2> 42333 <ul> 42334 <li>New backends 42335 <ul> 42336 <li>Support Alibaba Cloud (Aliyun) OSS via the s3 backend (Nick Craig-Wood)</li> 42337 </ul></li> 42338 <li>New commands 42339 <ul> 42340 <li>serve dlna: serves a remove via DLNA for the local network (nicolov)</li> 42341 </ul></li> 42342 <li>New Features 42343 <ul> 42344 <li>copy, move: Restore deprecated <code>--no-traverse</code> flag (Nick Craig-Wood) 42345 <ul> 42346 <li>This is useful for when transferring a small number of files into a large destination</li> 42347 </ul></li> 42348 <li>genautocomplete: Add remote path completion for bash completion (Christopher Peterson & Danil Semelenov)</li> 42349 <li>Buffer memory handling reworked to return memory to the OS better (Nick Craig-Wood) 42350 <ul> 42351 <li>Buffer recycling library to replace sync.Pool</li> 42352 <li>Optionally use memory mapped memory for better memory shrinking</li> 42353 <li>Enable with <code>--use-mmap</code> if having memory problems - not default yet</li> 42354 </ul></li> 42355 <li>Parallelise reading of files specified by <code>--files-from</code> (Nick Craig-Wood)</li> 42356 <li>check: Add stats showing total files matched. (Dario Guzik)</li> 42357 <li>Allow rename/delete open files under Windows (Nick Craig-Wood)</li> 42358 <li>lsjson: Use exactly the correct number of decimal places in the seconds (Nick Craig-Wood)</li> 42359 <li>Add cookie support with cmdline switch <code>--use-cookies</code> for all HTTP based remotes (qip)</li> 42360 <li>Warn if <code>--checksum</code> is set but there are no hashes available (Nick Craig-Wood)</li> 42361 <li>Rework rate limiting (pacer) to be more accurate and allow bursting (Nick Craig-Wood)</li> 42362 <li>Improve error reporting for too many/few arguments in commands (Nick Craig-Wood)</li> 42363 <li>listremotes: Remove <code>-l</code> short flag as it conflicts with the new global flag (weetmuts)</li> 42364 <li>Make http serving with auth generate INFO messages on auth fail (Nick Craig-Wood)</li> 42365 </ul></li> 42366 <li>Bug Fixes 42367 <ul> 42368 <li>Fix layout of stats (Nick Craig-Wood)</li> 42369 <li>Fix <code>--progress</code> crash under Windows Jenkins (Nick Craig-Wood)</li> 42370 <li>Fix transfer of google/onedrive docs by calling Rcat in Copy when size is -1 (Cnly)</li> 42371 <li>copyurl: Fix checking of <code>--dry-run</code> (Denis Skovpen)</li> 42372 </ul></li> 42373 <li>Mount 42374 <ul> 42375 <li>Check that mountpoint and local directory to mount don't overlap (Nick Craig-Wood)</li> 42376 <li>Fix mount size under 32 bit Windows (Nick Craig-Wood)</li> 42377 </ul></li> 42378 <li>VFS 42379 <ul> 42380 <li>Implement renaming of directories for backends without DirMove (Nick Craig-Wood) 42381 <ul> 42382 <li>now all backends except b2 support renaming directories</li> 42383 </ul></li> 42384 <li>Implement <code>--vfs-cache-max-size</code> to limit the total size of the cache (Nick Craig-Wood)</li> 42385 <li>Add <code>--dir-perms</code> and <code>--file-perms</code> flags to set default permissions (Nick Craig-Wood)</li> 42386 <li>Fix deadlock on concurrent operations on a directory (Nick Craig-Wood)</li> 42387 <li>Fix deadlock between RWFileHandle.close and File.Remove (Nick Craig-Wood)</li> 42388 <li>Fix renaming/deleting open files with cache mode "writes" under Windows (Nick Craig-Wood)</li> 42389 <li>Fix panic on rename with <code>--dry-run</code> set (Nick Craig-Wood)</li> 42390 <li>Fix vfs/refresh with recurse=true needing the <code>--fast-list</code> flag</li> 42391 </ul></li> 42392 <li>Local 42393 <ul> 42394 <li>Add support for <code>-l</code>/<code>--links</code> (symbolic link translation) (yair@unicorn) 42395 <ul> 42396 <li>this works by showing links as <code>link.rclonelink</code> - see local backend docs for more info</li> 42397 <li>this errors if used with <code>-L</code>/<code>--copy-links</code></li> 42398 </ul></li> 42399 <li>Fix renaming/deleting open files on Windows (Nick Craig-Wood)</li> 42400 </ul></li> 42401 <li>Crypt 42402 <ul> 42403 <li>Check for maximum length before decrypting filename to fix panic (Garry McNulty)</li> 42404 </ul></li> 42405 <li>Azure Blob 42406 <ul> 42407 <li>Allow building azureblob backend on *BSD (themylogin)</li> 42408 <li>Use the rclone HTTP client to support <code>--dump headers</code>, <code>--tpslimit</code>, etc. (Nick Craig-Wood)</li> 42409 <li>Use the s3 pacer for 0 delay in non error conditions (Nick Craig-Wood)</li> 42410 <li>Ignore directory markers (Nick Craig-Wood)</li> 42411 <li>Stop Mkdir attempting to create existing containers (Nick Craig-Wood)</li> 42412 </ul></li> 42413 <li>B2 42414 <ul> 42415 <li>cleanup: will remove unfinished large files >24hrs old (Garry McNulty)</li> 42416 <li>For a bucket limited application key check the bucket name (Nick Craig-Wood) 42417 <ul> 42418 <li>before this, rclone would use the authorised bucket regardless of what you put on the command line</li> 42419 </ul></li> 42420 <li>Added <code>--b2-disable-checksum</code> flag (Wojciech Smigielski) 42421 <ul> 42422 <li>this enables large files to be uploaded without a SHA-1 hash for speed reasons</li> 42423 </ul></li> 42424 </ul></li> 42425 <li>Drive 42426 <ul> 42427 <li>Set default pacer to 100ms for 10 tps (Nick Craig-Wood) 42428 <ul> 42429 <li>This fits the Google defaults much better and reduces the 403 errors massively</li> 42430 <li>Add <code>--drive-pacer-min-sleep</code> and <code>--drive-pacer-burst</code> to control the pacer</li> 42431 </ul></li> 42432 <li>Improve ChangeNotify support for items with multiple parents (Fabian Möller)</li> 42433 <li>Fix ListR for items with multiple parents - this fixes oddities with <code>vfs/refresh</code> (Fabian Möller)</li> 42434 <li>Fix using <code>--drive-impersonate</code> and appfolders (Nick Craig-Wood)</li> 42435 <li>Fix google docs in rclone mount for some (not all) applications (Nick Craig-Wood)</li> 42436 </ul></li> 42437 <li>Dropbox 42438 <ul> 42439 <li>Retry-After support for Dropbox backend (Mathieu Carbou)</li> 42440 </ul></li> 42441 <li>FTP 42442 <ul> 42443 <li>Wait for 60 seconds for a connection to Close then declare it dead (Nick Craig-Wood) 42444 <ul> 42445 <li>helps with indefinite hangs on some FTP servers</li> 42446 </ul></li> 42447 </ul></li> 42448 <li>Google Cloud Storage 42449 <ul> 42450 <li>Update google cloud storage endpoints (weetmuts)</li> 42451 </ul></li> 42452 <li>HTTP 42453 <ul> 42454 <li>Add an example with username and password which is supported but wasn't documented (Nick Craig-Wood)</li> 42455 <li>Fix backend with <code>--files-from</code> and nonexistent files (Nick Craig-Wood)</li> 42456 </ul></li> 42457 <li>Hubic 42458 <ul> 42459 <li>Make error message more informative if authentication fails (Nick Craig-Wood)</li> 42460 </ul></li> 42461 <li>Jottacloud 42462 <ul> 42463 <li>Resume and deduplication support (Oliver Heyme)</li> 42464 <li>Use token auth for all API requests Don't store password anymore (Sebastian Bünger)</li> 42465 <li>Add support for 2-factor authentication (Sebastian Bünger)</li> 42466 </ul></li> 42467 <li>Mega 42468 <ul> 42469 <li>Implement v2 account login which fixes logins for newer Mega accounts (Nick Craig-Wood)</li> 42470 <li>Return error if an unknown length file is attempted to be uploaded (Nick Craig-Wood)</li> 42471 <li>Add new error codes for better error reporting (Nick Craig-Wood)</li> 42472 </ul></li> 42473 <li>Onedrive 42474 <ul> 42475 <li>Fix broken support for "shared with me" folders (Alex Chen)</li> 42476 <li>Fix root ID not normalised (Cnly)</li> 42477 <li>Return err instead of panic on unknown-sized uploads (Cnly)</li> 42478 </ul></li> 42479 <li>Qingstor 42480 <ul> 42481 <li>Fix go routine leak on multipart upload errors (Nick Craig-Wood)</li> 42482 <li>Add upload chunk size/concurrency/cutoff control (Nick Craig-Wood)</li> 42483 <li>Default <code>--qingstor-upload-concurrency</code> to 1 to work around bug (Nick Craig-Wood)</li> 42484 </ul></li> 42485 <li>S3 42486 <ul> 42487 <li>Implement <code>--s3-upload-cutoff</code> for single part uploads below this (Nick Craig-Wood)</li> 42488 <li>Change <code>--s3-upload-concurrency</code> default to 4 to increase performance (Nick Craig-Wood)</li> 42489 <li>Add <code>--s3-bucket-acl</code> to control bucket ACL (Nick Craig-Wood)</li> 42490 <li>Auto detect region for buckets on operation failure (Nick Craig-Wood)</li> 42491 <li>Add GLACIER storage class (William Cocker)</li> 42492 <li>Add Scaleway to s3 documentation (Rémy Léone)</li> 42493 <li>Add AWS endpoint eu-north-1 (weetmuts)</li> 42494 </ul></li> 42495 <li>SFTP 42496 <ul> 42497 <li>Add support for PEM encrypted private keys (Fabian Möller)</li> 42498 <li>Add option to force the usage of an ssh-agent (Fabian Möller)</li> 42499 <li>Perform environment variable expansion on key-file (Fabian Möller)</li> 42500 <li>Fix rmdir on Windows based servers (e.g. CrushFTP) (Nick Craig-Wood)</li> 42501 <li>Fix rmdir deleting directory contents on some SFTP servers (Nick Craig-Wood)</li> 42502 <li>Fix error on dangling symlinks (Nick Craig-Wood)</li> 42503 </ul></li> 42504 <li>Swift 42505 <ul> 42506 <li>Add <code>--swift-no-chunk</code> to disable segmented uploads in rcat/mount (Nick Craig-Wood)</li> 42507 <li>Introduce application credential auth support (kayrus)</li> 42508 <li>Fix memory usage by slimming Object (Nick Craig-Wood)</li> 42509 <li>Fix extra requests on upload (Nick Craig-Wood)</li> 42510 <li>Fix reauth on big files (Nick Craig-Wood)</li> 42511 </ul></li> 42512 <li>Union 42513 <ul> 42514 <li>Fix poll-interval not working (Nick Craig-Wood)</li> 42515 </ul></li> 42516 <li>WebDAV 42517 <ul> 42518 <li>Support About which means rclone mount will show the correct disk size (Nick Craig-Wood)</li> 42519 <li>Support MD5 and SHA1 hashes with Owncloud and Nextcloud (Nick Craig-Wood)</li> 42520 <li>Fail soft on time parsing errors (Nick Craig-Wood)</li> 42521 <li>Fix infinite loop on failed directory creation (Nick Craig-Wood)</li> 42522 <li>Fix identification of directories for Bitrix Site Manager (Nick Craig-Wood)</li> 42523 <li>Fix upload of 0 length files on some servers (Nick Craig-Wood)</li> 42524 <li>Fix if MKCOL fails with 423 Locked assume the directory exists (Nick Craig-Wood)</li> 42525 </ul></li> 42526 </ul> 42527 <h2 id="v1.45---2018-11-24">v1.45 - 2018-11-24</h2> 42528 <ul> 42529 <li>New backends 42530 <ul> 42531 <li>The Yandex backend was re-written - see below for details (Sebastian Bünger)</li> 42532 </ul></li> 42533 <li>New commands 42534 <ul> 42535 <li>rcd: New command just to serve the remote control API (Nick Craig-Wood)</li> 42536 </ul></li> 42537 <li>New Features 42538 <ul> 42539 <li>The remote control API (rc) was greatly expanded to allow full control over rclone (Nick Craig-Wood) 42540 <ul> 42541 <li>sensitive operations require authorization or the <code>--rc-no-auth</code> flag</li> 42542 <li>config/* operations to configure rclone</li> 42543 <li>options/* for reading/setting command line flags</li> 42544 <li>operations/* for all low level operations, e.g. copy file, list directory</li> 42545 <li>sync/* for sync, copy and move</li> 42546 <li><code>--rc-files</code> flag to serve files on the rc http server 42547 <ul> 42548 <li>this is for building web native GUIs for rclone</li> 42549 </ul></li> 42550 <li>Optionally serving objects on the rc http server</li> 42551 <li>Ensure rclone fails to start up if the <code>--rc</code> port is in use already</li> 42552 <li>See <a href="https://rclone.org/rc/">the rc docs</a> for more info</li> 42553 </ul></li> 42554 <li>sync/copy/move 42555 <ul> 42556 <li>Make <code>--files-from</code> only read the objects specified and don't scan directories (Nick Craig-Wood) 42557 <ul> 42558 <li>This is a huge speed improvement for destinations with lots of files</li> 42559 </ul></li> 42560 </ul></li> 42561 <li>filter: Add <code>--ignore-case</code> flag (Nick Craig-Wood)</li> 42562 <li>ncdu: Add remove function ('d' key) (Henning Surmeier)</li> 42563 <li>rc command 42564 <ul> 42565 <li>Add <code>--json</code> flag for structured JSON input (Nick Craig-Wood)</li> 42566 <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> 42567 </ul></li> 42568 <li>build 42569 <ul> 42570 <li>Require go1.8 or later for compilation (Nick Craig-Wood)</li> 42571 <li>Enable softfloat on MIPS arch (Scott Edlund)</li> 42572 <li>Integration test framework revamped with a better report and better retries (Nick Craig-Wood)</li> 42573 </ul></li> 42574 </ul></li> 42575 <li>Bug Fixes 42576 <ul> 42577 <li>cmd: Make <code>--progress</code> update the stats correctly at the end (Nick Craig-Wood)</li> 42578 <li>config: Create config directory on save if it is missing (Nick Craig-Wood)</li> 42579 <li>dedupe: Check for existing filename before renaming a dupe file (ssaqua)</li> 42580 <li>move: Don't create directories with <code>--dry-run</code> (Nick Craig-Wood)</li> 42581 <li>operations: Fix Purge and Rmdirs when dir is not the root (Nick Craig-Wood)</li> 42582 <li>serve http/webdav/restic: Ensure rclone exits if the port is in use (Nick Craig-Wood)</li> 42583 </ul></li> 42584 <li>Mount 42585 <ul> 42586 <li>Make <code>--volname</code> work for Windows and macOS (Nick Craig-Wood)</li> 42587 </ul></li> 42588 <li>Azure Blob 42589 <ul> 42590 <li>Avoid context deadline exceeded error by setting a large TryTimeout value (brused27)</li> 42591 <li>Fix erroneous Rmdir error "directory not empty" (Nick Craig-Wood)</li> 42592 <li>Wait for up to 60s to create a just deleted container (Nick Craig-Wood)</li> 42593 </ul></li> 42594 <li>Dropbox 42595 <ul> 42596 <li>Add dropbox impersonate support (Jake Coggiano)</li> 42597 </ul></li> 42598 <li>Jottacloud 42599 <ul> 42600 <li>Fix bug in <code>--fast-list</code> handing of empty folders (albertony)</li> 42601 </ul></li> 42602 <li>Opendrive 42603 <ul> 42604 <li>Fix transfer of files with <code>+</code> and <code>&</code> in (Nick Craig-Wood)</li> 42605 <li>Fix retries of upload chunks (Nick Craig-Wood)</li> 42606 </ul></li> 42607 <li>S3 42608 <ul> 42609 <li>Set ACL for server-side copies to that provided by the user (Nick Craig-Wood)</li> 42610 <li>Fix role_arn, credential_source, ... (Erik Swanson)</li> 42611 <li>Add config info for Wasabi's US-West endpoint (Henry Ptasinski)</li> 42612 </ul></li> 42613 <li>SFTP 42614 <ul> 42615 <li>Ensure file hash checking is really disabled (Jon Fautley)</li> 42616 </ul></li> 42617 <li>Swift 42618 <ul> 42619 <li>Add pacer for retries to make swift more reliable (Nick Craig-Wood)</li> 42620 </ul></li> 42621 <li>WebDAV 42622 <ul> 42623 <li>Add Content-Type to PUT requests (Nick Craig-Wood)</li> 42624 <li>Fix config parsing so <code>--webdav-user</code> and <code>--webdav-pass</code> flags work (Nick Craig-Wood)</li> 42625 <li>Add RFC3339 date format (Ralf Hemberger)</li> 42626 </ul></li> 42627 <li>Yandex 42628 <ul> 42629 <li>The yandex backend was re-written (Sebastian Bünger) 42630 <ul> 42631 <li>This implements low level retries (Sebastian Bünger)</li> 42632 <li>Copy, Move, DirMove, PublicLink and About optional interfaces (Sebastian Bünger)</li> 42633 <li>Improved general error handling (Sebastian Bünger)</li> 42634 <li>Removed ListR for now due to inconsistent behaviour (Sebastian Bünger)</li> 42635 </ul></li> 42636 </ul></li> 42637 </ul> 42638 <h2 id="v1.44---2018-10-15">v1.44 - 2018-10-15</h2> 42639 <ul> 42640 <li>New commands 42641 <ul> 42642 <li>serve ftp: Add ftp server (Antoine GIRARD)</li> 42643 <li>settier: perform storage tier changes on supported remotes (sandeepkru)</li> 42644 </ul></li> 42645 <li>New Features 42646 <ul> 42647 <li>Reworked command line help 42648 <ul> 42649 <li>Make default help less verbose (Nick Craig-Wood)</li> 42650 <li>Split flags up into global and backend flags (Nick Craig-Wood)</li> 42651 <li>Implement specialised help for flags and backends (Nick Craig-Wood)</li> 42652 <li>Show URL of backend help page when starting config (Nick Craig-Wood)</li> 42653 </ul></li> 42654 <li>stats: Long names now split in center (Joanna Marek)</li> 42655 <li>Add <code>--log-format</code> flag for more control over log output (dcpu)</li> 42656 <li>rc: Add support for OPTIONS and basic CORS (frenos)</li> 42657 <li>stats: show FatalErrors and NoRetryErrors in stats (Cédric Connes)</li> 42658 </ul></li> 42659 <li>Bug Fixes 42660 <ul> 42661 <li>Fix -P not ending with a new line (Nick Craig-Wood)</li> 42662 <li>config: don't create default config dir when user supplies <code>--config</code> (albertony)</li> 42663 <li>Don't print non-ASCII characters with <code>--progress</code> on windows (Nick Craig-Wood)</li> 42664 <li>Correct logs for excluded items (ssaqua)</li> 42665 </ul></li> 42666 <li>Mount 42667 <ul> 42668 <li>Remove EXPERIMENTAL tags (Nick Craig-Wood)</li> 42669 </ul></li> 42670 <li>VFS 42671 <ul> 42672 <li>Fix race condition detected by serve ftp tests (Nick Craig-Wood)</li> 42673 <li>Add vfs/poll-interval rc command (Fabian Möller)</li> 42674 <li>Enable rename for nearly all remotes using server-side Move or Copy (Nick Craig-Wood)</li> 42675 <li>Reduce directory cache cleared by poll-interval (Fabian Möller)</li> 42676 <li>Remove EXPERIMENTAL tags (Nick Craig-Wood)</li> 42677 </ul></li> 42678 <li>Local 42679 <ul> 42680 <li>Skip bad symlinks in dir listing with -L enabled (Cédric Connes)</li> 42681 <li>Preallocate files on Windows to reduce fragmentation (Nick Craig-Wood)</li> 42682 <li>Preallocate files on linux with fallocate(2) (Nick Craig-Wood)</li> 42683 </ul></li> 42684 <li>Cache 42685 <ul> 42686 <li>Add cache/fetch rc function (Fabian Möller)</li> 42687 <li>Fix worker scale down (Fabian Möller)</li> 42688 <li>Improve performance by not sending info requests for cached chunks (dcpu)</li> 42689 <li>Fix error return value of cache/fetch rc method (Fabian Möller)</li> 42690 <li>Documentation fix for cache-chunk-total-size (Anagh Kumar Baranwal)</li> 42691 <li>Preserve leading / in wrapped remote path (Fabian Möller)</li> 42692 <li>Add plex_insecure option to skip certificate validation (Fabian Möller)</li> 42693 <li>Remove entries that no longer exist in the source (dcpu)</li> 42694 </ul></li> 42695 <li>Crypt 42696 <ul> 42697 <li>Preserve leading / in wrapped remote path (Fabian Möller)</li> 42698 </ul></li> 42699 <li>Alias 42700 <ul> 42701 <li>Fix handling of Windows network paths (Nick Craig-Wood)</li> 42702 </ul></li> 42703 <li>Azure Blob 42704 <ul> 42705 <li>Add <code>--azureblob-list-chunk</code> parameter (Santiago Rodríguez)</li> 42706 <li>Implemented settier command support on azureblob remote. (sandeepkru)</li> 42707 <li>Work around SDK bug which causes errors for chunk-sized files (Nick Craig-Wood)</li> 42708 </ul></li> 42709 <li>Box 42710 <ul> 42711 <li>Implement link sharing. (Sebastian Bünger)</li> 42712 </ul></li> 42713 <li>Drive 42714 <ul> 42715 <li>Add <code>--drive-import-formats</code> - google docs can now be imported (Fabian Möller) 42716 <ul> 42717 <li>Rewrite mime type and extension handling (Fabian Möller)</li> 42718 <li>Add document links (Fabian Möller)</li> 42719 <li>Add support for multipart document extensions (Fabian Möller)</li> 42720 <li>Add support for apps-script to json export (Fabian Möller)</li> 42721 <li>Fix escaped chars in documents during list (Fabian Möller)</li> 42722 </ul></li> 42723 <li>Add <code>--drive-v2-download-min-size</code> a workaround for slow downloads (Fabian Möller)</li> 42724 <li>Improve directory notifications in ChangeNotify (Fabian Möller)</li> 42725 <li>When listing team drives in config, continue on failure (Nick Craig-Wood)</li> 42726 </ul></li> 42727 <li>FTP 42728 <ul> 42729 <li>Add a small pause after failed upload before deleting file (Nick Craig-Wood)</li> 42730 </ul></li> 42731 <li>Google Cloud Storage 42732 <ul> 42733 <li>Fix service_account_file being ignored (Fabian Möller)</li> 42734 </ul></li> 42735 <li>Jottacloud 42736 <ul> 42737 <li>Minor improvement in quota info (omit if unlimited) (albertony)</li> 42738 <li>Add <code>--fast-list</code> support (albertony)</li> 42739 <li>Add permanent delete support: <code>--jottacloud-hard-delete</code> (albertony)</li> 42740 <li>Add link sharing support (albertony)</li> 42741 <li>Fix handling of reserved characters. (Sebastian Bünger)</li> 42742 <li>Fix socket leak on Object.Remove (Nick Craig-Wood)</li> 42743 </ul></li> 42744 <li>Onedrive 42745 <ul> 42746 <li>Rework to support Microsoft Graph (Cnly) 42747 <ul> 42748 <li><strong>NB</strong> this will require re-authenticating the remote</li> 42749 </ul></li> 42750 <li>Removed upload cutoff and always do session uploads (Oliver Heyme)</li> 42751 <li>Use single-part upload for empty files (Cnly)</li> 42752 <li>Fix new fields not saved when editing old config (Alex Chen)</li> 42753 <li>Fix sometimes special chars in filenames not replaced (Alex Chen)</li> 42754 <li>Ignore OneNote files by default (Alex Chen)</li> 42755 <li>Add link sharing support (jackyzy823)</li> 42756 </ul></li> 42757 <li>S3 42758 <ul> 42759 <li>Use custom pacer, to retry operations when reasonable (Craig Miskell)</li> 42760 <li>Use configured server-side-encryption and storage class options when calling CopyObject() (Paul Kohout)</li> 42761 <li>Make <code>--s3-v2-auth</code> flag (Nick Craig-Wood)</li> 42762 <li>Fix v2 auth on files with spaces (Nick Craig-Wood)</li> 42763 </ul></li> 42764 <li>Union 42765 <ul> 42766 <li>Implement union backend which reads from multiple backends (Felix Brucker)</li> 42767 <li>Implement optional interfaces (Move, DirMove, Copy, etc.) (Nick Craig-Wood)</li> 42768 <li>Fix ChangeNotify to support multiple remotes (Fabian Möller)</li> 42769 <li>Fix <code>--backup-dir</code> on union backend (Nick Craig-Wood)</li> 42770 </ul></li> 42771 <li>WebDAV 42772 <ul> 42773 <li>Add another time format (Nick Craig-Wood)</li> 42774 <li>Add a small pause after failed upload before deleting file (Nick Craig-Wood)</li> 42775 <li>Add workaround for missing mtime (buergi)</li> 42776 <li>Sharepoint: Renew cookies after 12hrs (Henning Surmeier)</li> 42777 </ul></li> 42778 <li>Yandex 42779 <ul> 42780 <li>Remove redundant nil checks (teresy)</li> 42781 </ul></li> 42782 </ul> 42783 <h2 id="v1.43.1---2018-09-07">v1.43.1 - 2018-09-07</h2> 42784 <p>Point release to fix hubic and azureblob backends.</p> 42785 <ul> 42786 <li>Bug Fixes 42787 <ul> 42788 <li>ncdu: Return error instead of log.Fatal in Show (Fabian Möller)</li> 42789 <li>cmd: Fix crash with <code>--progress</code> and <code>--stats 0</code> (Nick Craig-Wood)</li> 42790 <li>docs: Tidy website display (Anagh Kumar Baranwal)</li> 42791 </ul></li> 42792 <li>Azure Blob: 42793 <ul> 42794 <li>Fix multi-part uploads. (sandeepkru)</li> 42795 </ul></li> 42796 <li>Hubic 42797 <ul> 42798 <li>Fix uploads (Nick Craig-Wood)</li> 42799 <li>Retry auth fetching if it fails to make hubic more reliable (Nick Craig-Wood)</li> 42800 </ul></li> 42801 </ul> 42802 <h2 id="v1.43---2018-09-01">v1.43 - 2018-09-01</h2> 42803 <ul> 42804 <li>New backends 42805 <ul> 42806 <li>Jottacloud (Sebastian Bünger)</li> 42807 </ul></li> 42808 <li>New commands 42809 <ul> 42810 <li>copyurl: copies a URL to a remote (Denis)</li> 42811 </ul></li> 42812 <li>New Features 42813 <ul> 42814 <li>Reworked config for backends (Nick Craig-Wood) 42815 <ul> 42816 <li>All backend config can now be supplied by command line, env var or config file</li> 42817 <li>Advanced section in the config wizard for the optional items</li> 42818 <li>A large step towards rclone backends being usable in other go software</li> 42819 <li>Allow on the fly remotes with :backend: syntax</li> 42820 </ul></li> 42821 <li>Stats revamp 42822 <ul> 42823 <li>Add <code>--progress</code>/<code>-P</code> flag to show interactive progress (Nick Craig-Wood)</li> 42824 <li>Show the total progress of the sync in the stats (Nick Craig-Wood)</li> 42825 <li>Add <code>--stats-one-line</code> flag for single line stats (Nick Craig-Wood)</li> 42826 </ul></li> 42827 <li>Added weekday schedule into <code>--bwlimit</code> (Mateusz)</li> 42828 <li>lsjson: Add option to show the original object IDs (Fabian Möller)</li> 42829 <li>serve webdav: Make Content-Type without reading the file and add <code>--etag-hash</code> (Nick Craig-Wood)</li> 42830 <li>build 42831 <ul> 42832 <li>Build macOS with native compiler (Nick Craig-Wood)</li> 42833 <li>Update to use go1.11 for the build (Nick Craig-Wood)</li> 42834 </ul></li> 42835 <li>rc 42836 <ul> 42837 <li>Added core/stats to return the stats (reddi1)</li> 42838 </ul></li> 42839 <li><code>version --check</code>: Prints the current release and beta versions (Nick Craig-Wood)</li> 42840 </ul></li> 42841 <li>Bug Fixes 42842 <ul> 42843 <li>accounting 42844 <ul> 42845 <li>Fix time to completion estimates (Nick Craig-Wood)</li> 42846 <li>Fix moving average speed for file stats (Nick Craig-Wood)</li> 42847 </ul></li> 42848 <li>config: Fix error reading password from piped input (Nick Craig-Wood)</li> 42849 <li>move: Fix <code>--delete-empty-src-dirs</code> flag to delete all empty dirs on move (ishuah)</li> 42850 </ul></li> 42851 <li>Mount 42852 <ul> 42853 <li>Implement <code>--daemon-timeout</code> flag for OSXFUSE (Nick Craig-Wood)</li> 42854 <li>Fix mount <code>--daemon</code> not working with encrypted config (Alex Chen)</li> 42855 <li>Clip the number of blocks to 2^32-1 on macOS - fixes borg backup (Nick Craig-Wood)</li> 42856 </ul></li> 42857 <li>VFS 42858 <ul> 42859 <li>Enable vfs-read-chunk-size by default (Fabian Möller)</li> 42860 <li>Add the vfs/refresh rc command (Fabian Möller)</li> 42861 <li>Add non recursive mode to vfs/refresh rc command (Fabian Möller)</li> 42862 <li>Try to seek buffer on read only files (Fabian Möller)</li> 42863 </ul></li> 42864 <li>Local 42865 <ul> 42866 <li>Fix crash when deprecated <code>--local-no-unicode-normalization</code> is supplied (Nick Craig-Wood)</li> 42867 <li>Fix mkdir error when trying to copy files to the root of a drive on windows (Nick Craig-Wood)</li> 42868 </ul></li> 42869 <li>Cache 42870 <ul> 42871 <li>Fix nil pointer deref when using lsjson on cached directory (Nick Craig-Wood)</li> 42872 <li>Fix nil pointer deref for occasional crash on playback (Nick Craig-Wood)</li> 42873 </ul></li> 42874 <li>Crypt 42875 <ul> 42876 <li>Fix accounting when checking hashes on upload (Nick Craig-Wood)</li> 42877 </ul></li> 42878 <li>Amazon Cloud Drive 42879 <ul> 42880 <li>Make very clear in the docs that rclone has no ACD keys (Nick Craig-Wood)</li> 42881 </ul></li> 42882 <li>Azure Blob 42883 <ul> 42884 <li>Add connection string and SAS URL auth (Nick Craig-Wood)</li> 42885 <li>List the container to see if it exists (Nick Craig-Wood)</li> 42886 <li>Port new Azure Blob Storage SDK (sandeepkru)</li> 42887 <li>Added blob tier, tier between Hot, Cool and Archive. (sandeepkru)</li> 42888 <li>Remove leading / from paths (Nick Craig-Wood)</li> 42889 </ul></li> 42890 <li>B2 42891 <ul> 42892 <li>Support Application Keys (Nick Craig-Wood)</li> 42893 <li>Remove leading / from paths (Nick Craig-Wood)</li> 42894 </ul></li> 42895 <li>Box 42896 <ul> 42897 <li>Fix upload of > 2GB files on 32 bit platforms (Nick Craig-Wood)</li> 42898 <li>Make <code>--box-commit-retries</code> flag defaulting to 100 to fix large uploads (Nick Craig-Wood)</li> 42899 </ul></li> 42900 <li>Drive 42901 <ul> 42902 <li>Add <code>--drive-keep-revision-forever</code> flag (lewapm)</li> 42903 <li>Handle gdocs when filtering file names in list (Fabian Möller)</li> 42904 <li>Support using <code>--fast-list</code> for large speedups (Fabian Möller)</li> 42905 </ul></li> 42906 <li>FTP 42907 <ul> 42908 <li>Fix Put mkParentDir failed: 521 for BunnyCDN (Nick Craig-Wood)</li> 42909 </ul></li> 42910 <li>Google Cloud Storage 42911 <ul> 42912 <li>Fix index out of range error with <code>--fast-list</code> (Nick Craig-Wood)</li> 42913 </ul></li> 42914 <li>Jottacloud 42915 <ul> 42916 <li>Fix MD5 error check (Oliver Heyme)</li> 42917 <li>Handle empty time values (Martin Polden)</li> 42918 <li>Calculate missing MD5s (Oliver Heyme)</li> 42919 <li>Docs, fixes and tests for MD5 calculation (Nick Craig-Wood)</li> 42920 <li>Add optional MimeTyper interface. (Sebastian Bünger)</li> 42921 <li>Implement optional About interface (for <code>df</code> support). (Sebastian Bünger)</li> 42922 </ul></li> 42923 <li>Mega 42924 <ul> 42925 <li>Wait for events instead of arbitrary sleeping (Nick Craig-Wood)</li> 42926 <li>Add <code>--mega-hard-delete</code> flag (Nick Craig-Wood)</li> 42927 <li>Fix failed logins with upper case chars in email (Nick Craig-Wood)</li> 42928 </ul></li> 42929 <li>Onedrive 42930 <ul> 42931 <li>Shared folder support (Yoni Jah)</li> 42932 <li>Implement DirMove (Cnly)</li> 42933 <li>Fix rmdir sometimes deleting directories with contents (Nick Craig-Wood)</li> 42934 </ul></li> 42935 <li>Pcloud 42936 <ul> 42937 <li>Delete half uploaded files on upload error (Nick Craig-Wood)</li> 42938 </ul></li> 42939 <li>Qingstor 42940 <ul> 42941 <li>Remove leading / from paths (Nick Craig-Wood)</li> 42942 </ul></li> 42943 <li>S3 42944 <ul> 42945 <li>Fix index out of range error with <code>--fast-list</code> (Nick Craig-Wood)</li> 42946 <li>Add <code>--s3-force-path-style</code> (Nick Craig-Wood)</li> 42947 <li>Add support for KMS Key ID (bsteiss)</li> 42948 <li>Remove leading / from paths (Nick Craig-Wood)</li> 42949 </ul></li> 42950 <li>Swift 42951 <ul> 42952 <li>Add <code>storage_policy</code> (Ruben Vandamme)</li> 42953 <li>Make it so just <code>storage_url</code> or <code>auth_token</code> can be overridden (Nick Craig-Wood)</li> 42954 <li>Fix server-side copy bug for unusual file names (Nick Craig-Wood)</li> 42955 <li>Remove leading / from paths (Nick Craig-Wood)</li> 42956 </ul></li> 42957 <li>WebDAV 42958 <ul> 42959 <li>Ensure we call MKCOL with a URL with a trailing / for QNAP interop (Nick Craig-Wood)</li> 42960 <li>If root ends with / then don't check if it is a file (Nick Craig-Wood)</li> 42961 <li>Don't accept redirects when reading metadata (Nick Craig-Wood)</li> 42962 <li>Add bearer token (Macaroon) support for dCache (Nick Craig-Wood)</li> 42963 <li>Document dCache and Macaroons (Onno Zweers)</li> 42964 <li>Sharepoint recursion with different depth (Henning)</li> 42965 <li>Attempt to remove failed uploads (Nick Craig-Wood)</li> 42966 </ul></li> 42967 <li>Yandex 42968 <ul> 42969 <li>Fix listing/deleting files in the root (Nick Craig-Wood)</li> 42970 </ul></li> 42971 </ul> 42972 <h2 id="v1.42---2018-06-16">v1.42 - 2018-06-16</h2> 42973 <ul> 42974 <li>New backends 42975 <ul> 42976 <li>OpenDrive (Oliver Heyme, Jakub Karlicek, ncw)</li> 42977 </ul></li> 42978 <li>New commands 42979 <ul> 42980 <li>deletefile command (Filip Bartodziej)</li> 42981 </ul></li> 42982 <li>New Features 42983 <ul> 42984 <li>copy, move: Copy single files directly, don't use <code>--files-from</code> work-around 42985 <ul> 42986 <li>this makes them much more efficient</li> 42987 </ul></li> 42988 <li>Implement <code>--max-transfer</code> flag to quit transferring at a limit 42989 <ul> 42990 <li>make exit code 8 for <code>--max-transfer</code> exceeded</li> 42991 </ul></li> 42992 <li>copy: copy empty source directories to destination (Ishuah Kariuki)</li> 42993 <li>check: Add <code>--one-way</code> flag (Kasper Byrdal Nielsen)</li> 42994 <li>Add siginfo handler for macOS for ctrl-T stats (kubatasiemski)</li> 42995 <li>rc 42996 <ul> 42997 <li>add core/gc to run a garbage collection on demand</li> 42998 <li>enable go profiling by default on the <code>--rc</code> port</li> 42999 <li>return error from remote on failure</li> 43000 </ul></li> 43001 <li>lsf 43002 <ul> 43003 <li>Add <code>--absolute</code> flag to add a leading / onto path names</li> 43004 <li>Add <code>--csv</code> flag for compliant CSV output</li> 43005 <li>Add 'm' format specifier to show the MimeType</li> 43006 <li>Implement 'i' format for showing object ID</li> 43007 </ul></li> 43008 <li>lsjson 43009 <ul> 43010 <li>Add MimeType to the output</li> 43011 <li>Add ID field to output to show Object ID</li> 43012 </ul></li> 43013 <li>Add <code>--retries-sleep</code> flag (Benjamin Joseph Dag)</li> 43014 <li>Oauth tidy up web page and error handling (Henning Surmeier)</li> 43015 </ul></li> 43016 <li>Bug Fixes 43017 <ul> 43018 <li>Password prompt output with <code>--log-file</code> fixed for unix (Filip Bartodziej)</li> 43019 <li>Calculate ModifyWindow each time on the fly to fix various problems (Stefan Breunig)</li> 43020 </ul></li> 43021 <li>Mount 43022 <ul> 43023 <li>Only print "File.rename error" if there actually is an error (Stefan Breunig)</li> 43024 <li>Delay rename if file has open writers instead of failing outright (Stefan Breunig)</li> 43025 <li>Ensure atexit gets run on interrupt</li> 43026 <li>macOS enhancements 43027 <ul> 43028 <li>Make <code>--noappledouble</code> <code>--noapplexattr</code></li> 43029 <li>Add <code>--volname</code> flag and remove special chars from it</li> 43030 <li>Make Get/List/Set/Remove xattr return ENOSYS for efficiency</li> 43031 <li>Make <code>--daemon</code> work for macOS without CGO</li> 43032 </ul></li> 43033 </ul></li> 43034 <li>VFS 43035 <ul> 43036 <li>Add <code>--vfs-read-chunk-size</code> and <code>--vfs-read-chunk-size-limit</code> (Fabian Möller)</li> 43037 <li>Fix ChangeNotify for new or changed folders (Fabian Möller)</li> 43038 </ul></li> 43039 <li>Local 43040 <ul> 43041 <li>Fix symlink/junction point directory handling under Windows 43042 <ul> 43043 <li><strong>NB</strong> you will need to add <code>-L</code> to your command line to copy files with reparse points</li> 43044 </ul></li> 43045 </ul></li> 43046 <li>Cache 43047 <ul> 43048 <li>Add non cached dirs on notifications (Remus Bunduc)</li> 43049 <li>Allow root to be expired from rc (Remus Bunduc)</li> 43050 <li>Clean remaining empty folders from temp upload path (Remus Bunduc)</li> 43051 <li>Cache lists using batch writes (Remus Bunduc)</li> 43052 <li>Use secure websockets for HTTPS Plex addresses (John Clayton)</li> 43053 <li>Reconnect plex websocket on failures (Remus Bunduc)</li> 43054 <li>Fix panic when running without plex configs (Remus Bunduc)</li> 43055 <li>Fix root folder caching (Remus Bunduc)</li> 43056 </ul></li> 43057 <li>Crypt 43058 <ul> 43059 <li>Check the encrypted hash of files when uploading for extra data security</li> 43060 </ul></li> 43061 <li>Dropbox 43062 <ul> 43063 <li>Make Dropbox for business folders accessible using an initial <code>/</code> in the path</li> 43064 </ul></li> 43065 <li>Google Cloud Storage 43066 <ul> 43067 <li>Low level retry all operations if necessary</li> 43068 </ul></li> 43069 <li>Google Drive 43070 <ul> 43071 <li>Add <code>--drive-acknowledge-abuse</code> to download flagged files</li> 43072 <li>Add <code>--drive-alternate-export</code> to fix large doc export</li> 43073 <li>Don't attempt to choose Team Drives when using rclone config create</li> 43074 <li>Fix change list polling with team drives</li> 43075 <li>Fix ChangeNotify for folders (Fabian Möller)</li> 43076 <li>Fix about (and df on a mount) for team drives</li> 43077 </ul></li> 43078 <li>Onedrive 43079 <ul> 43080 <li>Errorhandler for onedrive for business requests (Henning Surmeier)</li> 43081 </ul></li> 43082 <li>S3 43083 <ul> 43084 <li>Adjust upload concurrency with <code>--s3-upload-concurrency</code> (themylogin)</li> 43085 <li>Fix <code>--s3-chunk-size</code> which was always using the minimum</li> 43086 </ul></li> 43087 <li>SFTP 43088 <ul> 43089 <li>Add <code>--ssh-path-override</code> flag (Piotr Oleszczyk)</li> 43090 <li>Fix slow downloads for long latency connections</li> 43091 </ul></li> 43092 <li>Webdav 43093 <ul> 43094 <li>Add workarounds for biz.mail.ru</li> 43095 <li>Ignore Reason-Phrase in status line to fix 4shared (Rodrigo)</li> 43096 <li>Better error message generation</li> 43097 </ul></li> 43098 </ul> 43099 <h2 id="v1.41---2018-04-28">v1.41 - 2018-04-28</h2> 43100 <ul> 43101 <li>New backends 43102 <ul> 43103 <li>Mega support added</li> 43104 <li>Webdav now supports SharePoint cookie authentication (hensur)</li> 43105 </ul></li> 43106 <li>New commands 43107 <ul> 43108 <li>link: create public link to files and folders (Stefan Breunig)</li> 43109 <li>about: gets quota info from a remote (a-roussos, ncw)</li> 43110 <li>hashsum: a generic tool for any hash to produce md5sum like output</li> 43111 </ul></li> 43112 <li>New Features 43113 <ul> 43114 <li>lsd: Add -R flag and fix and update docs for all ls commands</li> 43115 <li>ncdu: added a "refresh" key - CTRL-L (Keith Goldfarb)</li> 43116 <li>serve restic: Add append-only mode (Steve Kriss)</li> 43117 <li>serve restic: Disallow overwriting files in append-only mode (Alexander Neumann)</li> 43118 <li>serve restic: Print actual listener address (Matt Holt)</li> 43119 <li>size: Add --json flag (Matthew Holt)</li> 43120 <li>sync: implement --ignore-errors (Mateusz Pabian)</li> 43121 <li>dedupe: Add dedupe largest functionality (Richard Yang)</li> 43122 <li>fs: Extend SizeSuffix to include TB and PB for rclone about</li> 43123 <li>fs: add --dump goroutines and --dump openfiles for debugging</li> 43124 <li>rc: implement core/memstats to print internal memory usage info</li> 43125 <li>rc: new call rc/pid (Michael P. Dubner)</li> 43126 </ul></li> 43127 <li>Compile 43128 <ul> 43129 <li>Drop support for go1.6</li> 43130 </ul></li> 43131 <li>Release 43132 <ul> 43133 <li>Fix <code>make tarball</code> (Chih-Hsuan Yen)</li> 43134 </ul></li> 43135 <li>Bug Fixes 43136 <ul> 43137 <li>filter: fix --min-age and --max-age together check</li> 43138 <li>fs: limit MaxIdleConns and MaxIdleConnsPerHost in transport</li> 43139 <li>lsd,lsf: make sure all times we output are in local time</li> 43140 <li>rc: fix setting bwlimit to unlimited</li> 43141 <li>rc: take note of the --rc-addr flag too as per the docs</li> 43142 </ul></li> 43143 <li>Mount 43144 <ul> 43145 <li>Use About to return the correct disk total/used/free (e.g. in <code>df</code>)</li> 43146 <li>Set <code>--attr-timeout default</code> to <code>1s</code> - fixes: 43147 <ul> 43148 <li>rclone using too much memory</li> 43149 <li>rclone not serving files to samba</li> 43150 <li>excessive time listing directories</li> 43151 </ul></li> 43152 <li>Fix <code>df -i</code> (upstream fix)</li> 43153 </ul></li> 43154 <li>VFS 43155 <ul> 43156 <li>Filter files <code>.</code> and <code>..</code> from directory listing</li> 43157 <li>Only make the VFS cache if --vfs-cache-mode > Off</li> 43158 </ul></li> 43159 <li>Local 43160 <ul> 43161 <li>Add --local-no-check-updated to disable updated file checks</li> 43162 <li>Retry remove on Windows sharing violation error</li> 43163 </ul></li> 43164 <li>Cache 43165 <ul> 43166 <li>Flush the memory cache after close</li> 43167 <li>Purge file data on notification</li> 43168 <li>Always forget parent dir for notifications</li> 43169 <li>Integrate with Plex websocket</li> 43170 <li>Add rc cache/stats (seuffert)</li> 43171 <li>Add info log on notification</li> 43172 </ul></li> 43173 <li>Box 43174 <ul> 43175 <li>Fix failure reading large directories - parse file/directory size as float</li> 43176 </ul></li> 43177 <li>Dropbox 43178 <ul> 43179 <li>Fix crypt+obfuscate on dropbox</li> 43180 <li>Fix repeatedly uploading the same files</li> 43181 </ul></li> 43182 <li>FTP 43183 <ul> 43184 <li>Work around strange response from box FTP server</li> 43185 <li>More workarounds for FTP servers to fix mkParentDir error</li> 43186 <li>Fix no error on listing nonexistent directory</li> 43187 </ul></li> 43188 <li>Google Cloud Storage 43189 <ul> 43190 <li>Add service_account_credentials (Matt Holt)</li> 43191 <li>Detect bucket presence by listing it - minimises permissions needed</li> 43192 <li>Ignore zero length directory markers</li> 43193 </ul></li> 43194 <li>Google Drive 43195 <ul> 43196 <li>Add service_account_credentials (Matt Holt)</li> 43197 <li>Fix directory move leaving a hardlinked directory behind</li> 43198 <li>Return proper google errors when Opening files</li> 43199 <li>When initialized with a filepath, optional features used incorrect root path (Stefan Breunig)</li> 43200 </ul></li> 43201 <li>HTTP 43202 <ul> 43203 <li>Fix sync for servers which don't return Content-Length in HEAD</li> 43204 </ul></li> 43205 <li>Onedrive 43206 <ul> 43207 <li>Add QuickXorHash support for OneDrive for business</li> 43208 <li>Fix socket leak in multipart session upload</li> 43209 </ul></li> 43210 <li>S3 43211 <ul> 43212 <li>Look in S3 named profile files for credentials</li> 43213 <li>Add <code>--s3-disable-checksum</code> to disable checksum uploading (Chris Redekop)</li> 43214 <li>Hierarchical configuration support (Giri Badanahatti)</li> 43215 <li>Add in config for all the supported S3 providers</li> 43216 <li>Add One Zone Infrequent Access storage class (Craig Rachel)</li> 43217 <li>Add --use-server-modtime support (Peter Baumgartner)</li> 43218 <li>Add --s3-chunk-size option to control multipart uploads</li> 43219 <li>Ignore zero length directory markers</li> 43220 </ul></li> 43221 <li>SFTP 43222 <ul> 43223 <li>Update docs to match code, fix typos and clarify disable_hashcheck prompt (Michael G. Noll)</li> 43224 <li>Update docs with Synology quirks</li> 43225 <li>Fail soft with a debug on hash failure</li> 43226 </ul></li> 43227 <li>Swift 43228 <ul> 43229 <li>Add --use-server-modtime support (Peter Baumgartner)</li> 43230 </ul></li> 43231 <li>Webdav 43232 <ul> 43233 <li>Support SharePoint cookie authentication (hensur)</li> 43234 <li>Strip leading and trailing / off root</li> 43235 </ul></li> 43236 </ul> 43237 <h2 id="v1.40---2018-03-19">v1.40 - 2018-03-19</h2> 43238 <ul> 43239 <li>New backends 43240 <ul> 43241 <li>Alias backend to create aliases for existing remote names (Fabian Möller)</li> 43242 </ul></li> 43243 <li>New commands 43244 <ul> 43245 <li><code>lsf</code>: list for parsing purposes (Jakub Tasiemski) 43246 <ul> 43247 <li>by default this is a simple non recursive list of files and directories</li> 43248 <li>it can be configured to add more info in an easy to parse way</li> 43249 </ul></li> 43250 <li><code>serve restic</code>: for serving a remote as a Restic REST endpoint 43251 <ul> 43252 <li>This enables restic to use any backends that rclone can access</li> 43253 <li>Thanks Alexander Neumann for help, patches and review</li> 43254 </ul></li> 43255 <li><code>rc</code>: enable the remote control of a running rclone 43256 <ul> 43257 <li>The running rclone must be started with --rc and related flags.</li> 43258 <li>Currently there is support for bwlimit, and flushing for mount and cache.</li> 43259 </ul></li> 43260 </ul></li> 43261 <li>New Features 43262 <ul> 43263 <li><code>--max-delete</code> flag to add a delete threshold (Bjørn Erik Pedersen)</li> 43264 <li>All backends now support RangeOption for ranged Open 43265 <ul> 43266 <li><code>cat</code>: Use RangeOption for limited fetches to make more efficient</li> 43267 <li><code>cryptcheck</code>: make reading of nonce more efficient with RangeOption</li> 43268 </ul></li> 43269 <li>serve http/webdav/restic 43270 <ul> 43271 <li>support SSL/TLS</li> 43272 <li>add <code>--user</code> <code>--pass</code> and <code>--htpasswd</code> for authentication</li> 43273 </ul></li> 43274 <li><code>copy</code>/<code>move</code>: detect file size change during copy/move and abort transfer (ishuah)</li> 43275 <li><code>cryptdecode</code>: added option to return encrypted file names. (ishuah)</li> 43276 <li><code>lsjson</code>: add <code>--encrypted</code> to show encrypted name (Jakub Tasiemski)</li> 43277 <li>Add <code>--stats-file-name-length</code> to specify the printed file name length for stats (Will Gunn)</li> 43278 </ul></li> 43279 <li>Compile 43280 <ul> 43281 <li>Code base was shuffled and factored 43282 <ul> 43283 <li>backends moved into a backend directory</li> 43284 <li>large packages split up</li> 43285 <li>See the CONTRIBUTING.md doc for info as to what lives where now</li> 43286 </ul></li> 43287 <li>Update to using go1.10 as the default go version</li> 43288 <li>Implement daily <a href="https://pub.rclone.org/integration-tests/">full integration tests</a></li> 43289 </ul></li> 43290 <li>Release 43291 <ul> 43292 <li>Include a source tarball and sign it and the binaries</li> 43293 <li>Sign the git tags as part of the release process</li> 43294 <li>Add .deb and .rpm packages as part of the build</li> 43295 <li>Make a beta release for all branches on the main repo (but not pull requests)</li> 43296 </ul></li> 43297 <li>Bug Fixes 43298 <ul> 43299 <li>config: fixes errors on nonexistent config by loading config file only on first access</li> 43300 <li>config: retry saving the config after failure (Mateusz)</li> 43301 <li>sync: when using <code>--backup-dir</code> don't delete files if we can't set their modtime 43302 <ul> 43303 <li>this fixes odd behaviour with Dropbox and <code>--backup-dir</code></li> 43304 </ul></li> 43305 <li>fshttp: fix idle timeouts for HTTP connections</li> 43306 <li><code>serve http</code>: fix serving files with : in - fixes</li> 43307 <li>Fix <code>--exclude-if-present</code> to ignore directories which it doesn't have permission for (Iakov Davydov)</li> 43308 <li>Make accounting work properly with crypt and b2</li> 43309 <li>remove <code>--no-traverse</code> flag because it is obsolete</li> 43310 </ul></li> 43311 <li>Mount 43312 <ul> 43313 <li>Add <code>--attr-timeout</code> flag to control attribute caching in kernel 43314 <ul> 43315 <li>this now defaults to 0 which is correct but less efficient</li> 43316 <li>see <a href="https://rclone.org/commands/rclone_mount/#attribute-caching">the mount docs</a> for more info</li> 43317 </ul></li> 43318 <li>Add <code>--daemon</code> flag to allow mount to run in the background (ishuah)</li> 43319 <li>Fix: Return ENOSYS rather than EIO on attempted link 43320 <ul> 43321 <li>This fixes FileZilla accessing an rclone mount served over sftp.</li> 43322 </ul></li> 43323 <li>Fix setting modtime twice</li> 43324 <li>Mount tests now run on CI for Linux (mount & cmount)/Mac/Windows</li> 43325 <li>Many bugs fixed in the VFS layer - see below</li> 43326 </ul></li> 43327 <li>VFS 43328 <ul> 43329 <li>Many fixes for <code>--vfs-cache-mode</code> writes and above 43330 <ul> 43331 <li>Update cached copy if we know it has changed (fixes stale data)</li> 43332 <li>Clean path names before using them in the cache</li> 43333 <li>Disable cache cleaner if <code>--vfs-cache-poll-interval=0</code></li> 43334 <li>Fill and clean the cache immediately on startup</li> 43335 </ul></li> 43336 <li>Fix Windows opening every file when it stats the file</li> 43337 <li>Fix applying modtime for an open Write Handle</li> 43338 <li>Fix creation of files when truncating</li> 43339 <li>Write 0 bytes when flushing unwritten handles to avoid race conditions in FUSE</li> 43340 <li>Downgrade "poll-interval is not supported" message to Info</li> 43341 <li>Make OpenFile and friends return EINVAL if O_RDONLY and O_TRUNC</li> 43342 </ul></li> 43343 <li>Local 43344 <ul> 43345 <li>Downgrade "invalid cross-device link: trying copy" to debug</li> 43346 <li>Make DirMove return fs.ErrorCantDirMove to allow fallback to Copy for cross device</li> 43347 <li>Fix race conditions updating the hashes</li> 43348 </ul></li> 43349 <li>Cache 43350 <ul> 43351 <li>Add support for polling - cache will update when remote changes on supported backends</li> 43352 <li>Reduce log level for Plex api</li> 43353 <li>Fix dir cache issue</li> 43354 <li>Implement <code>--cache-db-wait-time</code> flag</li> 43355 <li>Improve efficiency with RangeOption and RangeSeek</li> 43356 <li>Fix dirmove with temp fs enabled</li> 43357 <li>Notify vfs when using temp fs</li> 43358 <li>Offline uploading</li> 43359 <li>Remote control support for path flushing</li> 43360 </ul></li> 43361 <li>Amazon cloud drive 43362 <ul> 43363 <li>Rclone no longer has any working keys - disable integration tests</li> 43364 <li>Implement DirChangeNotify to notify cache/vfs/mount of changes</li> 43365 </ul></li> 43366 <li>Azureblob 43367 <ul> 43368 <li>Don't check for bucket/container presence if listing was OK 43369 <ul> 43370 <li>this makes rclone do one less request per invocation</li> 43371 </ul></li> 43372 <li>Improve accounting for chunked uploads</li> 43373 </ul></li> 43374 <li>Backblaze B2 43375 <ul> 43376 <li>Don't check for bucket/container presence if listing was OK 43377 <ul> 43378 <li>this makes rclone do one less request per invocation</li> 43379 </ul></li> 43380 </ul></li> 43381 <li>Box 43382 <ul> 43383 <li>Improve accounting for chunked uploads</li> 43384 </ul></li> 43385 <li>Dropbox 43386 <ul> 43387 <li>Fix custom oauth client parameters</li> 43388 </ul></li> 43389 <li>Google Cloud Storage 43390 <ul> 43391 <li>Don't check for bucket/container presence if listing was OK 43392 <ul> 43393 <li>this makes rclone do one less request per invocation</li> 43394 </ul></li> 43395 </ul></li> 43396 <li>Google Drive 43397 <ul> 43398 <li>Migrate to api v3 (Fabian Möller)</li> 43399 <li>Add scope configuration and root folder selection</li> 43400 <li>Add <code>--drive-impersonate</code> for service accounts 43401 <ul> 43402 <li>thanks to everyone who tested, explored and contributed docs</li> 43403 </ul></li> 43404 <li>Add <code>--drive-use-created-date</code> to use created date as modified date (nbuchanan)</li> 43405 <li>Request the export formats only when required 43406 <ul> 43407 <li>This makes rclone quicker when there are no google docs</li> 43408 </ul></li> 43409 <li>Fix finding paths with latin1 chars (a workaround for a drive bug)</li> 43410 <li>Fix copying of a single Google doc file</li> 43411 <li>Fix <code>--drive-auth-owner-only</code> to look in all directories</li> 43412 </ul></li> 43413 <li>HTTP 43414 <ul> 43415 <li>Fix handling of directories with & in</li> 43416 </ul></li> 43417 <li>Onedrive 43418 <ul> 43419 <li>Removed upload cutoff and always do session uploads 43420 <ul> 43421 <li>this stops the creation of multiple versions on business onedrive</li> 43422 </ul></li> 43423 <li>Overwrite object size value with real size when reading file. (Victor) 43424 <ul> 43425 <li>this fixes oddities when onedrive misreports the size of images</li> 43426 </ul></li> 43427 </ul></li> 43428 <li>Pcloud 43429 <ul> 43430 <li>Remove unused chunked upload flag and code</li> 43431 </ul></li> 43432 <li>Qingstor 43433 <ul> 43434 <li>Don't check for bucket/container presence if listing was OK 43435 <ul> 43436 <li>this makes rclone do one less request per invocation</li> 43437 </ul></li> 43438 </ul></li> 43439 <li>S3 43440 <ul> 43441 <li>Support hashes for multipart files (Chris Redekop)</li> 43442 <li>Initial support for IBM COS (S3) (Giri Badanahatti)</li> 43443 <li>Update docs to discourage use of v2 auth with CEPH and others</li> 43444 <li>Don't check for bucket/container presence if listing was OK 43445 <ul> 43446 <li>this makes rclone do one less request per invocation</li> 43447 </ul></li> 43448 <li>Fix server-side copy and set modtime on files with + in</li> 43449 </ul></li> 43450 <li>SFTP 43451 <ul> 43452 <li>Add option to disable remote hash check command execution (Jon Fautley)</li> 43453 <li>Add <code>--sftp-ask-password</code> flag to prompt for password when needed (Leo R. Lundgren)</li> 43454 <li>Add <code>set_modtime</code> configuration option</li> 43455 <li>Fix following of symlinks</li> 43456 <li>Fix reading config file outside of Fs setup</li> 43457 <li>Fix reading $USER in username fallback not $HOME</li> 43458 <li>Fix running under crontab - Use correct OS way of reading username</li> 43459 </ul></li> 43460 <li>Swift 43461 <ul> 43462 <li>Fix refresh of authentication token 43463 <ul> 43464 <li>in v1.39 a bug was introduced which ignored new tokens - this fixes it</li> 43465 </ul></li> 43466 <li>Fix extra HEAD transaction when uploading a new file</li> 43467 <li>Don't check for bucket/container presence if listing was OK 43468 <ul> 43469 <li>this makes rclone do one less request per invocation</li> 43470 </ul></li> 43471 </ul></li> 43472 <li>Webdav 43473 <ul> 43474 <li>Add new time formats to support mydrive.ch and others</li> 43475 </ul></li> 43476 </ul> 43477 <h2 id="v1.39---2017-12-23">v1.39 - 2017-12-23</h2> 43478 <ul> 43479 <li>New backends 43480 <ul> 43481 <li>WebDAV 43482 <ul> 43483 <li>tested with nextcloud, owncloud, put.io and others!</li> 43484 </ul></li> 43485 <li>Pcloud</li> 43486 <li>cache - wraps a cache around other backends (Remus Bunduc) 43487 <ul> 43488 <li>useful in combination with mount</li> 43489 <li>NB this feature is in beta so use with care</li> 43490 </ul></li> 43491 </ul></li> 43492 <li>New commands 43493 <ul> 43494 <li>serve command with subcommands: 43495 <ul> 43496 <li>serve webdav: this implements a webdav server for any rclone remote.</li> 43497 <li>serve http: command to serve a remote over HTTP</li> 43498 </ul></li> 43499 <li>config: add sub commands for full config file management 43500 <ul> 43501 <li>create/delete/dump/edit/file/password/providers/show/update</li> 43502 </ul></li> 43503 <li>touch: to create or update the timestamp of a file (Jakub Tasiemski)</li> 43504 </ul></li> 43505 <li>New Features 43506 <ul> 43507 <li>curl install for rclone (Filip Bartodziej)</li> 43508 <li>--stats now shows percentage, size, rate and ETA in condensed form (Ishuah Kariuki)</li> 43509 <li>--exclude-if-present to exclude a directory if a file is present (Iakov Davydov)</li> 43510 <li>rmdirs: add --leave-root flag (lewapm)</li> 43511 <li>move: add --delete-empty-src-dirs flag to remove dirs after move (Ishuah Kariuki)</li> 43512 <li>Add --dump flag, introduce --dump requests, responses and remove --dump-auth, --dump-filters 43513 <ul> 43514 <li>Obscure X-Auth-Token: from headers when dumping too</li> 43515 </ul></li> 43516 <li>Document and implement exit codes for different failure modes (Ishuah Kariuki)</li> 43517 </ul></li> 43518 <li>Compile</li> 43519 <li>Bug Fixes 43520 <ul> 43521 <li>Retry lots more different types of errors to make multipart transfers more reliable</li> 43522 <li>Save the config before asking for a token, fixes disappearing oauth config</li> 43523 <li>Warn the user if --include and --exclude are used together (Ernest Borowski)</li> 43524 <li>Fix duplicate files (e.g. on Google drive) causing spurious copies</li> 43525 <li>Allow trailing and leading whitespace for passwords (Jason Rose)</li> 43526 <li>ncdu: fix crashes on empty directories</li> 43527 <li>rcat: fix goroutine leak</li> 43528 <li>moveto/copyto: Fix to allow copying to the same name</li> 43529 </ul></li> 43530 <li>Mount 43531 <ul> 43532 <li>--vfs-cache mode to make writes into mounts more reliable. 43533 <ul> 43534 <li>this requires caching files on the disk (see --cache-dir)</li> 43535 <li>As this is a new feature, use with care</li> 43536 </ul></li> 43537 <li>Use sdnotify to signal systemd the mount is ready (Fabian Möller)</li> 43538 <li>Check if directory is not empty before mounting (Ernest Borowski)</li> 43539 </ul></li> 43540 <li>Local 43541 <ul> 43542 <li>Add error message for cross file system moves</li> 43543 <li>Fix equality check for times</li> 43544 </ul></li> 43545 <li>Dropbox 43546 <ul> 43547 <li>Rework multipart upload 43548 <ul> 43549 <li>buffer the chunks when uploading large files so they can be retried</li> 43550 <li>change default chunk size to 48MB now we are buffering them in memory</li> 43551 <li>retry every error after the first chunk is done successfully</li> 43552 </ul></li> 43553 <li>Fix error when renaming directories</li> 43554 </ul></li> 43555 <li>Swift 43556 <ul> 43557 <li>Fix crash on bad authentication</li> 43558 </ul></li> 43559 <li>Google Drive 43560 <ul> 43561 <li>Add service account support (Tim Cooijmans)</li> 43562 </ul></li> 43563 <li>S3 43564 <ul> 43565 <li>Make it work properly with Digital Ocean Spaces (Andrew Starr-Bochicchio)</li> 43566 <li>Fix crash if a bad listing is received</li> 43567 <li>Add support for ECS task IAM roles (David Minor)</li> 43568 </ul></li> 43569 <li>Backblaze B2 43570 <ul> 43571 <li>Fix multipart upload retries</li> 43572 <li>Fix --hard-delete to make it work 100% of the time</li> 43573 </ul></li> 43574 <li>Swift 43575 <ul> 43576 <li>Allow authentication with storage URL and auth key (Giovanni Pizzi)</li> 43577 <li>Add new fields for swift configuration to support IBM Bluemix Swift (Pierre Carlson)</li> 43578 <li>Add OS_TENANT_ID and OS_USER_ID to config</li> 43579 <li>Allow configs with user id instead of user name</li> 43580 <li>Check if swift segments container exists before creating (John Leach)</li> 43581 <li>Fix memory leak in swift transfers (upstream fix)</li> 43582 </ul></li> 43583 <li>SFTP 43584 <ul> 43585 <li>Add option to enable the use of aes128-cbc cipher (Jon Fautley)</li> 43586 </ul></li> 43587 <li>Amazon cloud drive 43588 <ul> 43589 <li>Fix download of large files failing with "Only one auth mechanism allowed"</li> 43590 </ul></li> 43591 <li>crypt 43592 <ul> 43593 <li>Option to encrypt directory names or leave them intact</li> 43594 <li>Implement DirChangeNotify (Fabian Möller)</li> 43595 </ul></li> 43596 <li>onedrive 43597 <ul> 43598 <li>Add option to choose resourceURL during setup of OneDrive Business account if more than one is available for user</li> 43599 </ul></li> 43600 </ul> 43601 <h2 id="v1.38---2017-09-30">v1.38 - 2017-09-30</h2> 43602 <ul> 43603 <li>New backends 43604 <ul> 43605 <li>Azure Blob Storage (thanks Andrei Dragomir)</li> 43606 <li>Box</li> 43607 <li>Onedrive for Business (thanks Oliver Heyme)</li> 43608 <li>QingStor from QingCloud (thanks wuyu)</li> 43609 </ul></li> 43610 <li>New commands 43611 <ul> 43612 <li><code>rcat</code> - read from standard input and stream upload</li> 43613 <li><code>tree</code> - shows a nicely formatted recursive listing</li> 43614 <li><code>cryptdecode</code> - decode encrypted file names (thanks ishuah)</li> 43615 <li><code>config show</code> - print the config file</li> 43616 <li><code>config file</code> - print the config file location</li> 43617 </ul></li> 43618 <li>New Features 43619 <ul> 43620 <li>Empty directories are deleted on <code>sync</code></li> 43621 <li><code>dedupe</code> - implement merging of duplicate directories</li> 43622 <li><code>check</code> and <code>cryptcheck</code> made more consistent and use less memory</li> 43623 <li><code>cleanup</code> for remaining remotes (thanks ishuah)</li> 43624 <li><code>--immutable</code> for ensuring that files don't change (thanks Jacob McNamee)</li> 43625 <li><code>--user-agent</code> option (thanks Alex McGrath Kraak)</li> 43626 <li><code>--disable</code> flag to disable optional features</li> 43627 <li><code>--bind</code> flag for choosing the local addr on outgoing connections</li> 43628 <li>Support for zsh auto-completion (thanks bpicode)</li> 43629 <li>Stop normalizing file names but do a normalized compare in <code>sync</code></li> 43630 </ul></li> 43631 <li>Compile 43632 <ul> 43633 <li>Update to using go1.9 as the default go version</li> 43634 <li>Remove snapd build due to maintenance problems</li> 43635 </ul></li> 43636 <li>Bug Fixes 43637 <ul> 43638 <li>Improve retriable error detection which makes multipart uploads better</li> 43639 <li>Make <code>check</code> obey <code>--ignore-size</code></li> 43640 <li>Fix bwlimit toggle in conjunction with schedules (thanks cbruegg)</li> 43641 <li><code>config</code> ensures newly written config is on the same mount</li> 43642 </ul></li> 43643 <li>Local 43644 <ul> 43645 <li>Revert to copy when moving file across file system boundaries</li> 43646 <li><code>--skip-links</code> to suppress symlink warnings (thanks Zhiming Wang)</li> 43647 </ul></li> 43648 <li>Mount 43649 <ul> 43650 <li>Reuse <code>rcat</code> internals to support uploads from all remotes</li> 43651 </ul></li> 43652 <li>Dropbox 43653 <ul> 43654 <li>Fix "entry doesn't belong in directory" error</li> 43655 <li>Stop using deprecated API methods</li> 43656 </ul></li> 43657 <li>Swift 43658 <ul> 43659 <li>Fix server-side copy to empty container with <code>--fast-list</code></li> 43660 </ul></li> 43661 <li>Google Drive 43662 <ul> 43663 <li>Change the default for <code>--drive-use-trash</code> to <code>true</code></li> 43664 </ul></li> 43665 <li>S3 43666 <ul> 43667 <li>Set session token when using STS (thanks Girish Ramakrishnan)</li> 43668 <li>Glacier docs and error messages (thanks Jan Varho)</li> 43669 <li>Read 1000 (not 1024) items in dir listings to fix Wasabi</li> 43670 </ul></li> 43671 <li>Backblaze B2 43672 <ul> 43673 <li>Fix SHA1 mismatch when downloading files with no SHA1</li> 43674 <li>Calculate missing hashes on the fly instead of spooling</li> 43675 <li><code>--b2-hard-delete</code> to permanently delete (not hide) files (thanks John Papandriopoulos)</li> 43676 </ul></li> 43677 <li>Hubic 43678 <ul> 43679 <li>Fix creating containers - no longer have to use the <code>default</code> container</li> 43680 </ul></li> 43681 <li>Swift 43682 <ul> 43683 <li>Optionally configure from a standard set of OpenStack environment vars</li> 43684 <li>Add <code>endpoint_type</code> config</li> 43685 </ul></li> 43686 <li>Google Cloud Storage 43687 <ul> 43688 <li>Fix bucket creation to work with limited permission users</li> 43689 </ul></li> 43690 <li>SFTP 43691 <ul> 43692 <li>Implement connection pooling for multiple ssh connections</li> 43693 <li>Limit new connections per second</li> 43694 <li>Add support for MD5 and SHA1 hashes where available (thanks Christian Brüggemann)</li> 43695 </ul></li> 43696 <li>HTTP 43697 <ul> 43698 <li>Fix URL encoding issues</li> 43699 <li>Fix directories with <code>:</code> in</li> 43700 <li>Fix panic with URL encoded content</li> 43701 </ul></li> 43702 </ul> 43703 <h2 id="v1.37---2017-07-22">v1.37 - 2017-07-22</h2> 43704 <ul> 43705 <li>New backends 43706 <ul> 43707 <li>FTP - thanks to Antonio Messina</li> 43708 <li>HTTP - thanks to Vasiliy Tolstov</li> 43709 </ul></li> 43710 <li>New commands 43711 <ul> 43712 <li>rclone ncdu - for exploring a remote with a text based user interface.</li> 43713 <li>rclone lsjson - for listing with a machine-readable output</li> 43714 <li>rclone dbhashsum - to show Dropbox style hashes of files (local or Dropbox)</li> 43715 </ul></li> 43716 <li>New Features 43717 <ul> 43718 <li>Implement --fast-list flag 43719 <ul> 43720 <li>This allows remotes to list recursively if they can</li> 43721 <li>This uses less transactions (important if you pay for them)</li> 43722 <li>This may or may not be quicker</li> 43723 <li>This will use more memory as it has to hold the listing in memory</li> 43724 <li>--old-sync-method deprecated - the remaining uses are covered by --fast-list</li> 43725 <li>This involved a major re-write of all the listing code</li> 43726 </ul></li> 43727 <li>Add --tpslimit and --tpslimit-burst to limit transactions per second 43728 <ul> 43729 <li>this is useful in conjunction with <code>rclone mount</code> to limit external apps</li> 43730 </ul></li> 43731 <li>Add --stats-log-level so can see --stats without -v</li> 43732 <li>Print password prompts to stderr - Hraban Luyat</li> 43733 <li>Warn about duplicate files when syncing</li> 43734 <li>Oauth improvements 43735 <ul> 43736 <li>allow auth_url and token_url to be set in the config file</li> 43737 <li>Print redirection URI if using own credentials.</li> 43738 </ul></li> 43739 <li>Don't Mkdir at the start of sync to save transactions</li> 43740 </ul></li> 43741 <li>Compile 43742 <ul> 43743 <li>Update build to go1.8.3</li> 43744 <li>Require go1.6 for building rclone</li> 43745 <li>Compile 386 builds with "GO386=387" for maximum compatibility</li> 43746 </ul></li> 43747 <li>Bug Fixes 43748 <ul> 43749 <li>Fix menu selection when no remotes</li> 43750 <li>Config saving reworked to not kill the file if disk gets full</li> 43751 <li>Don't delete remote if name does not change while renaming</li> 43752 <li>moveto, copyto: report transfers and checks as per move and copy</li> 43753 </ul></li> 43754 <li>Local 43755 <ul> 43756 <li>Add --local-no-unicode-normalization flag - Bob Potter</li> 43757 </ul></li> 43758 <li>Mount 43759 <ul> 43760 <li>Now supported on Windows using cgofuse and WinFsp - thanks to Bill Zissimopoulos for much help</li> 43761 <li>Compare checksums on upload/download via FUSE</li> 43762 <li>Unmount when program ends with SIGINT (Ctrl+C) or SIGTERM - Jérôme Vizcaino</li> 43763 <li>On read only open of file, make open pending until first read</li> 43764 <li>Make --read-only reject modify operations</li> 43765 <li>Implement ModTime via FUSE for remotes that support it</li> 43766 <li>Allow modTime to be changed even before all writers are closed</li> 43767 <li>Fix panic on renames</li> 43768 <li>Fix hang on errored upload</li> 43769 </ul></li> 43770 <li>Crypt 43771 <ul> 43772 <li>Report the name:root as specified by the user</li> 43773 <li>Add an "obfuscate" option for filename encryption - Stephen Harris</li> 43774 </ul></li> 43775 <li>Amazon Drive 43776 <ul> 43777 <li>Fix initialization order for token renewer</li> 43778 <li>Remove revoked credentials, allow oauth proxy config and update docs</li> 43779 </ul></li> 43780 <li>B2 43781 <ul> 43782 <li>Reduce minimum chunk size to 5MB</li> 43783 </ul></li> 43784 <li>Drive 43785 <ul> 43786 <li>Add team drive support</li> 43787 <li>Reduce bandwidth by adding fields for partial responses - Martin Kristensen</li> 43788 <li>Implement --drive-shared-with-me flag to view shared with me files - Danny Tsai</li> 43789 <li>Add --drive-trashed-only to read only the files in the trash</li> 43790 <li>Remove obsolete --drive-full-list</li> 43791 <li>Add missing seek to start on retries of chunked uploads</li> 43792 <li>Fix stats accounting for upload</li> 43793 <li>Convert / in names to a unicode equivalent (／)</li> 43794 <li>Poll for Google Drive changes when mounted</li> 43795 </ul></li> 43796 <li>OneDrive 43797 <ul> 43798 <li>Fix the uploading of files with spaces</li> 43799 <li>Fix initialization order for token renewer</li> 43800 <li>Display speeds accurately when uploading - Yoni Jah</li> 43801 <li>Swap to using http://localhost:53682/ as redirect URL - Michael Ledin</li> 43802 <li>Retry on token expired error, reset upload body on retry - Yoni Jah</li> 43803 </ul></li> 43804 <li>Google Cloud Storage 43805 <ul> 43806 <li>Add ability to specify location and storage class via config and command line - thanks gdm85</li> 43807 <li>Create container if necessary on server-side copy</li> 43808 <li>Increase directory listing chunk to 1000 to increase performance</li> 43809 <li>Obtain a refresh token for GCS - Steven Lu</li> 43810 </ul></li> 43811 <li>Yandex 43812 <ul> 43813 <li>Fix the name reported in log messages (was empty)</li> 43814 <li>Correct error return for listing empty directory</li> 43815 </ul></li> 43816 <li>Dropbox 43817 <ul> 43818 <li>Rewritten to use the v2 API 43819 <ul> 43820 <li>Now supports ModTime 43821 <ul> 43822 <li>Can only set by uploading the file again</li> 43823 <li>If you uploaded with an old rclone, rclone may upload everything again</li> 43824 <li>Use <code>--size-only</code> or <code>--checksum</code> to avoid this</li> 43825 </ul></li> 43826 <li>Now supports the Dropbox content hashing scheme</li> 43827 <li>Now supports low level retries</li> 43828 </ul></li> 43829 </ul></li> 43830 <li>S3 43831 <ul> 43832 <li>Work around eventual consistency in bucket creation</li> 43833 <li>Create container if necessary on server-side copy</li> 43834 <li>Add us-east-2 (Ohio) and eu-west-2 (London) S3 regions - Zahiar Ahmed</li> 43835 </ul></li> 43836 <li>Swift, Hubic 43837 <ul> 43838 <li>Fix zero length directory markers showing in the subdirectory listing 43839 <ul> 43840 <li>this caused lots of duplicate transfers</li> 43841 </ul></li> 43842 <li>Fix paged directory listings 43843 <ul> 43844 <li>this caused duplicate directory errors</li> 43845 </ul></li> 43846 <li>Create container if necessary on server-side copy</li> 43847 <li>Increase directory listing chunk to 1000 to increase performance</li> 43848 <li>Make sensible error if the user forgets the container</li> 43849 </ul></li> 43850 <li>SFTP 43851 <ul> 43852 <li>Add support for using ssh key files</li> 43853 <li>Fix under Windows</li> 43854 <li>Fix ssh agent on Windows</li> 43855 <li>Adapt to latest version of library - Igor Kharin</li> 43856 </ul></li> 43857 </ul> 43858 <h2 id="v1.36---2017-03-18">v1.36 - 2017-03-18</h2> 43859 <ul> 43860 <li>New Features 43861 <ul> 43862 <li>SFTP remote (Jack Schmidt)</li> 43863 <li>Re-implement sync routine to work a directory at a time reducing memory usage</li> 43864 <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> 43865 <li>Implement --backup-dir and --suffix</li> 43866 <li>Implement --track-renames (initial implementation by Bjørn Erik Pedersen)</li> 43867 <li>Add time-based bandwidth limits (Lukas Loesche)</li> 43868 <li>rclone cryptcheck: checks integrity of crypt remotes</li> 43869 <li>Allow all config file variables and options to be set from environment variables</li> 43870 <li>Add --buffer-size parameter to control buffer size for copy</li> 43871 <li>Make --delete-after the default</li> 43872 <li>Add --ignore-checksum flag (fixed by Hisham Zarka)</li> 43873 <li>rclone check: Add --download flag to check all the data, not just hashes</li> 43874 <li>rclone cat: add --head, --tail, --offset, --count and --discard</li> 43875 <li>rclone config: when choosing from a list, allow the value to be entered too</li> 43876 <li>rclone config: allow rename and copy of remotes</li> 43877 <li>rclone obscure: for generating encrypted passwords for rclone's config (T.C. Ferguson)</li> 43878 <li>Comply with XDG Base Directory specification (Dario Giovannetti) 43879 <ul> 43880 <li>this moves the default location of the config file in a backwards compatible way</li> 43881 </ul></li> 43882 <li>Release changes 43883 <ul> 43884 <li>Ubuntu snap support (Dedsec1)</li> 43885 <li>Compile with go 1.8</li> 43886 <li>MIPS/Linux big and little endian support</li> 43887 </ul></li> 43888 </ul></li> 43889 <li>Bug Fixes 43890 <ul> 43891 <li>Fix copyto copying things to the wrong place if the destination dir didn't exist</li> 43892 <li>Fix parsing of remotes in moveto and copyto</li> 43893 <li>Fix --delete-before deleting files on copy</li> 43894 <li>Fix --files-from with an empty file copying everything</li> 43895 <li>Fix sync: don't update mod times if --dry-run set</li> 43896 <li>Fix MimeType propagation</li> 43897 <li>Fix filters to add ** rules to directory rules</li> 43898 </ul></li> 43899 <li>Local 43900 <ul> 43901 <li>Implement -L, --copy-links flag to allow rclone to follow symlinks</li> 43902 <li>Open files in write only mode so rclone can write to an rclone mount</li> 43903 <li>Fix unnormalised unicode causing problems reading directories</li> 43904 <li>Fix interaction between -x flag and --max-depth</li> 43905 </ul></li> 43906 <li>Mount 43907 <ul> 43908 <li>Implement proper directory handling (mkdir, rmdir, renaming)</li> 43909 <li>Make include and exclude filters apply to mount</li> 43910 <li>Implement read and write async buffers - control with --buffer-size</li> 43911 <li>Fix fsync on for directories</li> 43912 <li>Fix retry on network failure when reading off crypt</li> 43913 </ul></li> 43914 <li>Crypt 43915 <ul> 43916 <li>Add --crypt-show-mapping to show encrypted file mapping</li> 43917 <li>Fix crypt writer getting stuck in a loop 43918 <ul> 43919 <li><strong>IMPORTANT</strong> this bug had the potential to cause data corruption when 43920 <ul> 43921 <li>reading data from a network based remote and</li> 43922 <li>writing to a crypt on Google Drive</li> 43923 </ul></li> 43924 <li>Use the cryptcheck command to validate your data if you are concerned</li> 43925 <li>If syncing two crypt remotes, sync the unencrypted remote</li> 43926 </ul></li> 43927 </ul></li> 43928 <li>Amazon Drive 43929 <ul> 43930 <li>Fix panics on Move (rename)</li> 43931 <li>Fix panic on token expiry</li> 43932 </ul></li> 43933 <li>B2 43934 <ul> 43935 <li>Fix inconsistent listings and rclone check</li> 43936 <li>Fix uploading empty files with go1.8</li> 43937 <li>Constrain memory usage when doing multipart uploads</li> 43938 <li>Fix upload url not being refreshed properly</li> 43939 </ul></li> 43940 <li>Drive 43941 <ul> 43942 <li>Fix Rmdir on directories with trashed files</li> 43943 <li>Fix "Ignoring unknown object" when downloading</li> 43944 <li>Add --drive-list-chunk</li> 43945 <li>Add --drive-skip-gdocs (Károly Oláh)</li> 43946 </ul></li> 43947 <li>OneDrive 43948 <ul> 43949 <li>Implement Move</li> 43950 <li>Fix Copy 43951 <ul> 43952 <li>Fix overwrite detection in Copy</li> 43953 <li>Fix waitForJob to parse errors correctly</li> 43954 </ul></li> 43955 <li>Use token renewer to stop auth errors on long uploads</li> 43956 <li>Fix uploading empty files with go1.8</li> 43957 </ul></li> 43958 <li>Google Cloud Storage 43959 <ul> 43960 <li>Fix depth 1 directory listings</li> 43961 </ul></li> 43962 <li>Yandex 43963 <ul> 43964 <li>Fix single level directory listing</li> 43965 </ul></li> 43966 <li>Dropbox 43967 <ul> 43968 <li>Normalise the case for single level directory listings</li> 43969 <li>Fix depth 1 listing</li> 43970 </ul></li> 43971 <li>S3 43972 <ul> 43973 <li>Added ca-central-1 region (Jon Yergatian)</li> 43974 </ul></li> 43975 </ul> 43976 <h2 id="v1.35---2017-01-02">v1.35 - 2017-01-02</h2> 43977 <ul> 43978 <li>New Features 43979 <ul> 43980 <li>moveto and copyto commands for choosing a destination name on copy/move</li> 43981 <li>rmdirs command to recursively delete empty directories</li> 43982 <li>Allow repeated --include/--exclude/--filter options</li> 43983 <li>Only show transfer stats on commands which transfer stuff 43984 <ul> 43985 <li>show stats on any command using the <code>--stats</code> flag</li> 43986 </ul></li> 43987 <li>Allow overlapping directories in move when server-side dir move is supported</li> 43988 <li>Add --stats-unit option - thanks Scott McGillivray</li> 43989 </ul></li> 43990 <li>Bug Fixes 43991 <ul> 43992 <li>Fix the config file being overwritten when two rclone instances are running</li> 43993 <li>Make rclone lsd obey the filters properly</li> 43994 <li>Fix compilation on mips</li> 43995 <li>Fix not transferring files that don't differ in size</li> 43996 <li>Fix panic on nil retry/fatal error</li> 43997 </ul></li> 43998 <li>Mount 43999 <ul> 44000 <li>Retry reads on error - should help with reliability a lot</li> 44001 <li>Report the modification times for directories from the remote</li> 44002 <li>Add bandwidth accounting and limiting (fixes --bwlimit)</li> 44003 <li>If --stats provided will show stats and which files are transferring</li> 44004 <li>Support R/W files if truncate is set.</li> 44005 <li>Implement statfs interface so df works</li> 44006 <li>Note that write is now supported on Amazon Drive</li> 44007 <li>Report number of blocks in a file - thanks Stefan Breunig</li> 44008 </ul></li> 44009 <li>Crypt 44010 <ul> 44011 <li>Prevent the user pointing crypt at itself</li> 44012 <li>Fix failed to authenticate decrypted block errors 44013 <ul> 44014 <li>these will now return the underlying unexpected EOF instead</li> 44015 </ul></li> 44016 </ul></li> 44017 <li>Amazon Drive 44018 <ul> 44019 <li>Add support for server-side move and directory move - thanks Stefan Breunig</li> 44020 <li>Fix nil pointer deref on size attribute</li> 44021 </ul></li> 44022 <li>B2 44023 <ul> 44024 <li>Use new prefix and delimiter parameters in directory listings 44025 <ul> 44026 <li>This makes --max-depth 1 dir listings as used in mount much faster</li> 44027 </ul></li> 44028 <li>Reauth the account while doing uploads too - should help with token expiry</li> 44029 </ul></li> 44030 <li>Drive 44031 <ul> 44032 <li>Make DirMove more efficient and complain about moving the root</li> 44033 <li>Create destination directory on Move()</li> 44034 </ul></li> 44035 </ul> 44036 <h2 id="v1.34---2016-11-06">v1.34 - 2016-11-06</h2> 44037 <ul> 44038 <li>New Features 44039 <ul> 44040 <li>Stop single file and <code>--files-from</code> operations iterating through the source bucket.</li> 44041 <li>Stop removing failed upload to cloud storage remotes</li> 44042 <li>Make ContentType be preserved for cloud to cloud copies</li> 44043 <li>Add support to toggle bandwidth limits via SIGUSR2 - thanks Marco Paganini</li> 44044 <li><code>rclone check</code> shows count of hashes that couldn't be checked</li> 44045 <li><code>rclone listremotes</code> command</li> 44046 <li>Support linux/arm64 build - thanks Fredrik Fornwall</li> 44047 <li>Remove <code>Authorization:</code> lines from <code>--dump-headers</code> output</li> 44048 </ul></li> 44049 <li>Bug Fixes 44050 <ul> 44051 <li>Ignore files with control characters in the names</li> 44052 <li>Fix <code>rclone move</code> command 44053 <ul> 44054 <li>Delete src files which already existed in dst</li> 44055 <li>Fix deletion of src file when dst file older</li> 44056 </ul></li> 44057 <li>Fix <code>rclone check</code> on encrypted file systems</li> 44058 <li>Make failed uploads not count as "Transferred"</li> 44059 <li>Make sure high level retries show with <code>-q</code></li> 44060 <li>Use a vendor directory with godep for repeatable builds</li> 44061 </ul></li> 44062 <li><code>rclone mount</code> - FUSE 44063 <ul> 44064 <li>Implement FUSE mount options 44065 <ul> 44066 <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> 44067 <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> 44068 </ul></li> 44069 <li>Add <code>--dir-cache-time</code> to control caching of directory entries</li> 44070 <li>Implement seek for files opened for read (useful for video players) 44071 <ul> 44072 <li>with <code>-no-seek</code> flag to disable</li> 44073 </ul></li> 44074 <li>Fix crash on 32 bit ARM (alignment of 64 bit counter)</li> 44075 <li>...and many more internal fixes and improvements!</li> 44076 </ul></li> 44077 <li>Crypt 44078 <ul> 44079 <li>Don't show encrypted password in configurator to stop confusion</li> 44080 </ul></li> 44081 <li>Amazon Drive 44082 <ul> 44083 <li>New wait for upload option <code>--acd-upload-wait-per-gb</code> 44084 <ul> 44085 <li>upload timeouts scale by file size and can be disabled</li> 44086 </ul></li> 44087 <li>Add 502 Bad Gateway to list of errors we retry</li> 44088 <li>Fix overwriting a file with a zero length file</li> 44089 <li>Fix ACD file size warning limit - thanks Felix Bünemann</li> 44090 </ul></li> 44091 <li>Local 44092 <ul> 44093 <li>Unix: implement <code>-x</code>/<code>--one-file-system</code> to stay on a single file system 44094 <ul> 44095 <li>thanks Durval Menezes and Luiz Carlos Rumbelsperger Viana</li> 44096 </ul></li> 44097 <li>Windows: ignore the symlink bit on files</li> 44098 <li>Windows: Ignore directory-based junction points</li> 44099 </ul></li> 44100 <li>B2 44101 <ul> 44102 <li>Make sure each upload has at least one upload slot - fixes strange upload stats</li> 44103 <li>Fix uploads when using crypt</li> 44104 <li>Fix download of large files (sha1 mismatch)</li> 44105 <li>Return error when we try to create a bucket which someone else owns</li> 44106 <li>Update B2 docs with Data usage, and Crypt section - thanks Tomasz Mazur</li> 44107 </ul></li> 44108 <li>S3 44109 <ul> 44110 <li>Command line and config file support for 44111 <ul> 44112 <li>Setting/overriding ACL - thanks Radek Šenfeld</li> 44113 <li>Setting storage class - thanks Asko Tamm</li> 44114 </ul></li> 44115 </ul></li> 44116 <li>Drive 44117 <ul> 44118 <li>Make exponential backoff work exactly as per Google specification</li> 44119 <li>add <code>.epub</code>, <code>.odp</code> and <code>.tsv</code> as export formats.</li> 44120 </ul></li> 44121 <li>Swift 44122 <ul> 44123 <li>Don't read metadata for directory marker objects</li> 44124 </ul></li> 44125 </ul> 44126 <h2 id="v1.33---2016-08-24">v1.33 - 2016-08-24</h2> 44127 <ul> 44128 <li>New Features 44129 <ul> 44130 <li>Implement encryption 44131 <ul> 44132 <li>data encrypted in NACL secretbox format</li> 44133 <li>with optional file name encryption</li> 44134 </ul></li> 44135 <li>New commands 44136 <ul> 44137 <li>rclone mount - implements FUSE mounting of remotes (EXPERIMENTAL) 44138 <ul> 44139 <li>works on Linux, FreeBSD and OS X (need testers for the last 2!)</li> 44140 </ul></li> 44141 <li>rclone cat - outputs remote file or files to the terminal</li> 44142 <li>rclone genautocomplete - command to make a bash completion script for rclone</li> 44143 </ul></li> 44144 <li>Editing a remote using <code>rclone config</code> now goes through the wizard</li> 44145 <li>Compile with go 1.7 - this fixes rclone on macOS Sierra and on 386 processors</li> 44146 <li>Use cobra for sub commands and docs generation</li> 44147 </ul></li> 44148 <li>drive 44149 <ul> 44150 <li>Document how to make your own client_id</li> 44151 </ul></li> 44152 <li>s3 44153 <ul> 44154 <li>User-configurable Amazon S3 ACL (thanks Radek Šenfeld)</li> 44155 </ul></li> 44156 <li>b2 44157 <ul> 44158 <li>Fix stats accounting for upload - no more jumping to 100% done</li> 44159 <li>On cleanup delete hide marker if it is the current file</li> 44160 <li>New B2 API endpoint (thanks Per Cederberg)</li> 44161 <li>Set maximum backoff to 5 Minutes</li> 44162 </ul></li> 44163 <li>onedrive 44164 <ul> 44165 <li>Fix URL escaping in file names - e.g. uploading files with <code>+</code> in them.</li> 44166 </ul></li> 44167 <li>amazon cloud drive 44168 <ul> 44169 <li>Fix token expiry during large uploads</li> 44170 <li>Work around 408 REQUEST_TIMEOUT and 504 GATEWAY_TIMEOUT errors</li> 44171 </ul></li> 44172 <li>local 44173 <ul> 44174 <li>Fix filenames with invalid UTF-8 not being uploaded</li> 44175 <li>Fix problem with some UTF-8 characters on OS X</li> 44176 </ul></li> 44177 </ul> 44178 <h2 id="v1.32---2016-07-13">v1.32 - 2016-07-13</h2> 44179 <ul> 44180 <li>Backblaze B2 44181 <ul> 44182 <li>Fix upload of files large files not in root</li> 44183 </ul></li> 44184 </ul> 44185 <h2 id="v1.31---2016-07-13">v1.31 - 2016-07-13</h2> 44186 <ul> 44187 <li>New Features 44188 <ul> 44189 <li>Reduce memory on sync by about 50%</li> 44190 <li>Implement --no-traverse flag to stop copy traversing the destination remote. 44191 <ul> 44192 <li>This can be used to reduce memory usage down to the smallest possible.</li> 44193 <li>Useful to copy a small number of files into a large destination folder.</li> 44194 </ul></li> 44195 <li>Implement cleanup command for emptying trash / removing old versions of files 44196 <ul> 44197 <li>Currently B2 only</li> 44198 </ul></li> 44199 <li>Single file handling improved 44200 <ul> 44201 <li>Now copied with --files-from</li> 44202 <li>Automatically sets --no-traverse when copying a single file</li> 44203 </ul></li> 44204 <li>Info on using installing with ansible - thanks Stefan Weichinger</li> 44205 <li>Implement --no-update-modtime flag to stop rclone fixing the remote modified times.</li> 44206 </ul></li> 44207 <li>Bug Fixes 44208 <ul> 44209 <li>Fix move command - stop it running for overlapping Fses - this was causing data loss.</li> 44210 </ul></li> 44211 <li>Local 44212 <ul> 44213 <li>Fix incomplete hashes - this was causing problems for B2.</li> 44214 </ul></li> 44215 <li>Amazon Drive 44216 <ul> 44217 <li>Rename Amazon Cloud Drive to Amazon Drive - no changes to config file needed.</li> 44218 </ul></li> 44219 <li>Swift 44220 <ul> 44221 <li>Add support for non-default project domain - thanks Antonio Messina.</li> 44222 </ul></li> 44223 <li>S3 44224 <ul> 44225 <li>Add instructions on how to use rclone with minio.</li> 44226 <li>Add ap-northeast-2 (Seoul) and ap-south-1 (Mumbai) regions.</li> 44227 <li>Skip setting the modified time for objects > 5GB as it isn't possible.</li> 44228 </ul></li> 44229 <li>Backblaze B2 44230 <ul> 44231 <li>Add --b2-versions flag so old versions can be listed and retrieved.</li> 44232 <li>Treat 403 errors (e.g. cap exceeded) as fatal.</li> 44233 <li>Implement cleanup command for deleting old file versions.</li> 44234 <li>Make error handling compliant with B2 integrations notes.</li> 44235 <li>Fix handling of token expiry.</li> 44236 <li>Implement --b2-test-mode to set <code>X-Bz-Test-Mode</code> header.</li> 44237 <li>Set cutoff for chunked upload to 200MB as per B2 guidelines.</li> 44238 <li>Make upload multi-threaded.</li> 44239 </ul></li> 44240 <li>Dropbox 44241 <ul> 44242 <li>Don't retry 461 errors.</li> 44243 </ul></li> 44244 </ul> 44245 <h2 id="v1.30---2016-06-18">v1.30 - 2016-06-18</h2> 44246 <ul> 44247 <li>New Features 44248 <ul> 44249 <li>Directory listing code reworked for more features and better error reporting (thanks to Klaus Post for help). This enables 44250 <ul> 44251 <li>Directory include filtering for efficiency</li> 44252 <li>--max-depth parameter</li> 44253 <li>Better error reporting</li> 44254 <li>More to come</li> 44255 </ul></li> 44256 <li>Retry more errors</li> 44257 <li>Add --ignore-size flag - for uploading images to onedrive</li> 44258 <li>Log -v output to stdout by default</li> 44259 <li>Display the transfer stats in more human-readable form</li> 44260 <li>Make 0 size files specifiable with <code>--max-size 0b</code></li> 44261 <li>Add <code>b</code> suffix so we can specify bytes in --bwlimit, --min-size, etc.</li> 44262 <li>Use "password:" instead of "password>" prompt - thanks Klaus Post and Leigh Klotz</li> 44263 </ul></li> 44264 <li>Bug Fixes 44265 <ul> 44266 <li>Fix retry doing one too many retries</li> 44267 </ul></li> 44268 <li>Local 44269 <ul> 44270 <li>Fix problems with OS X and UTF-8 characters</li> 44271 </ul></li> 44272 <li>Amazon Drive 44273 <ul> 44274 <li>Check a file exists before uploading to help with 408 Conflict errors</li> 44275 <li>Reauth on 401 errors - this has been causing a lot of problems</li> 44276 <li>Work around spurious 403 errors</li> 44277 <li>Restart directory listings on error</li> 44278 </ul></li> 44279 <li>Google Drive 44280 <ul> 44281 <li>Check a file exists before uploading to help with duplicates</li> 44282 <li>Fix retry of multipart uploads</li> 44283 </ul></li> 44284 <li>Backblaze B2 44285 <ul> 44286 <li>Implement large file uploading</li> 44287 </ul></li> 44288 <li>S3 44289 <ul> 44290 <li>Add AES256 server-side encryption for - thanks Justin R. Wilson</li> 44291 </ul></li> 44292 <li>Google Cloud Storage 44293 <ul> 44294 <li>Make sure we don't use conflicting content types on upload</li> 44295 <li>Add service account support - thanks Michal Witkowski</li> 44296 </ul></li> 44297 <li>Swift 44298 <ul> 44299 <li>Add auth version parameter</li> 44300 <li>Add domain option for openstack (v3 auth) - thanks Fabian Ruff</li> 44301 </ul></li> 44302 </ul> 44303 <h2 id="v1.29---2016-04-18">v1.29 - 2016-04-18</h2> 44304 <ul> 44305 <li>New Features 44306 <ul> 44307 <li>Implement <code>-I, --ignore-times</code> for unconditional upload</li> 44308 <li>Improve <code>dedupe</code>command 44309 <ul> 44310 <li>Now removes identical copies without asking</li> 44311 <li>Now obeys <code>--dry-run</code></li> 44312 <li>Implement <code>--dedupe-mode</code> for non interactive running 44313 <ul> 44314 <li><code>--dedupe-mode interactive</code> - interactive the default.</li> 44315 <li><code>--dedupe-mode skip</code> - removes identical files then skips anything left.</li> 44316 <li><code>--dedupe-mode first</code> - removes identical files then keeps the first one.</li> 44317 <li><code>--dedupe-mode newest</code> - removes identical files then keeps the newest one.</li> 44318 <li><code>--dedupe-mode oldest</code> - removes identical files then keeps the oldest one.</li> 44319 <li><code>--dedupe-mode rename</code> - removes identical files then renames the rest to be different.</li> 44320 </ul></li> 44321 </ul></li> 44322 </ul></li> 44323 <li>Bug fixes 44324 <ul> 44325 <li>Make rclone check obey the <code>--size-only</code> flag.</li> 44326 <li>Use "application/octet-stream" if discovered mime type is invalid.</li> 44327 <li>Fix missing "quit" option when there are no remotes.</li> 44328 </ul></li> 44329 <li>Google Drive 44330 <ul> 44331 <li>Increase default chunk size to 8 MB - increases upload speed of big files</li> 44332 <li>Speed up directory listings and make more reliable</li> 44333 <li>Add missing retries for Move and DirMove - increases reliability</li> 44334 <li>Preserve mime type on file update</li> 44335 </ul></li> 44336 <li>Backblaze B2 44337 <ul> 44338 <li>Enable mod time syncing 44339 <ul> 44340 <li>This means that B2 will now check modification times</li> 44341 <li>It will upload new files to update the modification times</li> 44342 <li>(there isn't an API to just set the mod time.)</li> 44343 <li>If you want the old behaviour use <code>--size-only</code>.</li> 44344 </ul></li> 44345 <li>Update API to new version</li> 44346 <li>Fix parsing of mod time when not in metadata</li> 44347 </ul></li> 44348 <li>Swift/Hubic 44349 <ul> 44350 <li>Don't return an MD5SUM for static large objects</li> 44351 </ul></li> 44352 <li>S3 44353 <ul> 44354 <li>Fix uploading files bigger than 50GB</li> 44355 </ul></li> 44356 </ul> 44357 <h2 id="v1.28---2016-03-01">v1.28 - 2016-03-01</h2> 44358 <ul> 44359 <li>New Features 44360 <ul> 44361 <li>Configuration file encryption - thanks Klaus Post</li> 44362 <li>Improve <code>rclone config</code> adding more help and making it easier to understand</li> 44363 <li>Implement <code>-u</code>/<code>--update</code> so creation times can be used on all remotes</li> 44364 <li>Implement <code>--low-level-retries</code> flag</li> 44365 <li>Optionally disable gzip compression on downloads with <code>--no-gzip-encoding</code></li> 44366 </ul></li> 44367 <li>Bug fixes 44368 <ul> 44369 <li>Don't make directories if <code>--dry-run</code> set</li> 44370 <li>Fix and document the <code>move</code> command</li> 44371 <li>Fix redirecting stderr on unix-like OSes when using <code>--log-file</code></li> 44372 <li>Fix <code>delete</code> command to wait until all finished - fixes missing deletes.</li> 44373 </ul></li> 44374 <li>Backblaze B2 44375 <ul> 44376 <li>Use one upload URL per go routine fixes <code>more than one upload using auth token</code></li> 44377 <li>Add pacing, retries and reauthentication - fixes token expiry problems</li> 44378 <li>Upload without using a temporary file from local (and remotes which support SHA1)</li> 44379 <li>Fix reading metadata for all files when it shouldn't have been</li> 44380 </ul></li> 44381 <li>Drive 44382 <ul> 44383 <li>Fix listing drive documents at root</li> 44384 <li>Disable copy and move for Google docs</li> 44385 </ul></li> 44386 <li>Swift 44387 <ul> 44388 <li>Fix uploading of chunked files with non ASCII characters</li> 44389 <li>Allow setting of <code>storage_url</code> in the config - thanks Xavier Lucas</li> 44390 </ul></li> 44391 <li>S3 44392 <ul> 44393 <li>Allow IAM role and credentials from environment variables - thanks Brian Stengaard</li> 44394 <li>Allow low privilege users to use S3 (check if directory exists during Mkdir) - thanks Jakub Gedeon</li> 44395 </ul></li> 44396 <li>Amazon Drive 44397 <ul> 44398 <li>Retry on more things to make directory listings more reliable</li> 44399 </ul></li> 44400 </ul> 44401 <h2 id="v1.27---2016-01-31">v1.27 - 2016-01-31</h2> 44402 <ul> 44403 <li>New Features 44404 <ul> 44405 <li>Easier headless configuration with <code>rclone authorize</code></li> 44406 <li>Add support for multiple hash types - we now check SHA1 as well as MD5 hashes.</li> 44407 <li><code>delete</code> command which does obey the filters (unlike <code>purge</code>)</li> 44408 <li><code>dedupe</code> command to deduplicate a remote. Useful with Google Drive.</li> 44409 <li>Add <code>--ignore-existing</code> flag to skip all files that exist on destination.</li> 44410 <li>Add <code>--delete-before</code>, <code>--delete-during</code>, <code>--delete-after</code> flags.</li> 44411 <li>Add <code>--memprofile</code> flag to debug memory use.</li> 44412 <li>Warn the user about files with same name but different case</li> 44413 <li>Make <code>--include</code> rules add their implicit exclude * at the end of the filter list</li> 44414 <li>Deprecate compiling with go1.3</li> 44415 </ul></li> 44416 <li>Amazon Drive 44417 <ul> 44418 <li>Fix download of files > 10 GB</li> 44419 <li>Fix directory traversal ("Next token is expired") for large directory listings</li> 44420 <li>Remove 409 conflict from error codes we will retry - stops very long pauses</li> 44421 </ul></li> 44422 <li>Backblaze B2 44423 <ul> 44424 <li>SHA1 hashes now checked by rclone core</li> 44425 </ul></li> 44426 <li>Drive 44427 <ul> 44428 <li>Add <code>--drive-auth-owner-only</code> to only consider files owned by the user - thanks Björn Harrtell</li> 44429 <li>Export Google documents</li> 44430 </ul></li> 44431 <li>Dropbox 44432 <ul> 44433 <li>Make file exclusion error controllable with -q</li> 44434 </ul></li> 44435 <li>Swift 44436 <ul> 44437 <li>Fix upload from unprivileged user.</li> 44438 </ul></li> 44439 <li>S3 44440 <ul> 44441 <li>Fix updating of mod times of files with <code>+</code> in.</li> 44442 </ul></li> 44443 <li>Local 44444 <ul> 44445 <li>Add local file system option to disable UNC on Windows.</li> 44446 </ul></li> 44447 </ul> 44448 <h2 id="v1.26---2016-01-02">v1.26 - 2016-01-02</h2> 44449 <ul> 44450 <li>New Features 44451 <ul> 44452 <li>Yandex storage backend - thank you Dmitry Burdeev ("dibu")</li> 44453 <li>Implement Backblaze B2 storage backend</li> 44454 <li>Add --min-age and --max-age flags - thank you Adriano Aurélio Meirelles</li> 44455 <li>Make ls/lsl/md5sum/size/check obey includes and excludes</li> 44456 </ul></li> 44457 <li>Fixes 44458 <ul> 44459 <li>Fix crash in http logging</li> 44460 <li>Upload releases to github too</li> 44461 </ul></li> 44462 <li>Swift 44463 <ul> 44464 <li>Fix sync for chunked files</li> 44465 </ul></li> 44466 <li>OneDrive 44467 <ul> 44468 <li>Re-enable server-side copy</li> 44469 <li>Don't mask HTTP error codes with JSON decode error</li> 44470 </ul></li> 44471 <li>S3 44472 <ul> 44473 <li>Fix corrupting Content-Type on mod time update (thanks Joseph Spurrier)</li> 44474 </ul></li> 44475 </ul> 44476 <h2 id="v1.25---2015-11-14">v1.25 - 2015-11-14</h2> 44477 <ul> 44478 <li>New features 44479 <ul> 44480 <li>Implement Hubic storage system</li> 44481 </ul></li> 44482 <li>Fixes 44483 <ul> 44484 <li>Fix deletion of some excluded files without --delete-excluded 44485 <ul> 44486 <li>This could have deleted files unexpectedly on sync</li> 44487 <li>Always check first with <code>--dry-run</code>!</li> 44488 </ul></li> 44489 </ul></li> 44490 <li>Swift 44491 <ul> 44492 <li>Stop SetModTime losing metadata (e.g. X-Object-Manifest) 44493 <ul> 44494 <li>This could have caused data loss for files > 5GB in size</li> 44495 </ul></li> 44496 <li>Use ContentType from Object to avoid lookups in listings</li> 44497 </ul></li> 44498 <li>OneDrive 44499 <ul> 44500 <li>disable server-side copy as it seems to be broken at Microsoft</li> 44501 </ul></li> 44502 </ul> 44503 <h2 id="v1.24---2015-11-07">v1.24 - 2015-11-07</h2> 44504 <ul> 44505 <li>New features 44506 <ul> 44507 <li>Add support for Microsoft OneDrive</li> 44508 <li>Add <code>--no-check-certificate</code> option to disable server certificate verification</li> 44509 <li>Add async readahead buffer for faster transfer of big files</li> 44510 </ul></li> 44511 <li>Fixes 44512 <ul> 44513 <li>Allow spaces in remotes and check remote names for validity at creation time</li> 44514 <li>Allow '&' and disallow ':' in Windows filenames.</li> 44515 </ul></li> 44516 <li>Swift 44517 <ul> 44518 <li>Ignore directory marker objects where appropriate - allows working with Hubic</li> 44519 <li>Don't delete the container if fs wasn't at root</li> 44520 </ul></li> 44521 <li>S3 44522 <ul> 44523 <li>Don't delete the bucket if fs wasn't at root</li> 44524 </ul></li> 44525 <li>Google Cloud Storage 44526 <ul> 44527 <li>Don't delete the bucket if fs wasn't at root</li> 44528 </ul></li> 44529 </ul> 44530 <h2 id="v1.23---2015-10-03">v1.23 - 2015-10-03</h2> 44531 <ul> 44532 <li>New features 44533 <ul> 44534 <li>Implement <code>rclone size</code> for measuring remotes</li> 44535 </ul></li> 44536 <li>Fixes 44537 <ul> 44538 <li>Fix headless config for drive and gcs</li> 44539 <li>Tell the user they should try again if the webserver method failed</li> 44540 <li>Improve output of <code>--dump-headers</code></li> 44541 </ul></li> 44542 <li>S3 44543 <ul> 44544 <li>Allow anonymous access to public buckets</li> 44545 </ul></li> 44546 <li>Swift 44547 <ul> 44548 <li>Stop chunked operations logging "Failed to read info: Object Not Found"</li> 44549 <li>Use Content-Length on uploads for extra reliability</li> 44550 </ul></li> 44551 </ul> 44552 <h2 id="v1.22---2015-09-28">v1.22 - 2015-09-28</h2> 44553 <ul> 44554 <li>Implement rsync like include and exclude flags</li> 44555 <li>swift 44556 <ul> 44557 <li>Support files > 5GB - thanks Sergey Tolmachev</li> 44558 </ul></li> 44559 </ul> 44560 <h2 id="v1.21---2015-09-22">v1.21 - 2015-09-22</h2> 44561 <ul> 44562 <li>New features 44563 <ul> 44564 <li>Display individual transfer progress</li> 44565 <li>Make lsl output times in localtime</li> 44566 </ul></li> 44567 <li>Fixes 44568 <ul> 44569 <li>Fix allowing user to override credentials again in Drive, GCS and ACD</li> 44570 </ul></li> 44571 <li>Amazon Drive 44572 <ul> 44573 <li>Implement compliant pacing scheme</li> 44574 </ul></li> 44575 <li>Google Drive 44576 <ul> 44577 <li>Make directory reads concurrent for increased speed.</li> 44578 </ul></li> 44579 </ul> 44580 <h2 id="v1.20---2015-09-15">v1.20 - 2015-09-15</h2> 44581 <ul> 44582 <li>New features 44583 <ul> 44584 <li>Amazon Drive support</li> 44585 <li>Oauth support redone - fix many bugs and improve usability 44586 <ul> 44587 <li>Use "golang.org/x/oauth2" as oauth library of choice</li> 44588 <li>Improve oauth usability for smoother initial signup</li> 44589 <li>drive, googlecloudstorage: optionally use auto config for the oauth token</li> 44590 </ul></li> 44591 <li>Implement --dump-headers and --dump-bodies debug flags</li> 44592 <li>Show multiple matched commands if abbreviation too short</li> 44593 <li>Implement server-side move where possible</li> 44594 </ul></li> 44595 <li>local 44596 <ul> 44597 <li>Always use UNC paths internally on Windows - fixes a lot of bugs</li> 44598 </ul></li> 44599 <li>dropbox 44600 <ul> 44601 <li>force use of our custom transport which makes timeouts work</li> 44602 </ul></li> 44603 <li>Thanks to Klaus Post for lots of help with this release</li> 44604 </ul> 44605 <h2 id="v1.19---2015-08-28">v1.19 - 2015-08-28</h2> 44606 <ul> 44607 <li>New features 44608 <ul> 44609 <li>Server side copies for s3/swift/drive/dropbox/gcs</li> 44610 <li>Move command - uses server-side copies if it can</li> 44611 <li>Implement --retries flag - tries 3 times by default</li> 44612 <li>Build for plan9/amd64 and solaris/amd64 too</li> 44613 </ul></li> 44614 <li>Fixes 44615 <ul> 44616 <li>Make a current version download with a fixed URL for scripting</li> 44617 <li>Ignore rmdir in limited fs rather than throwing error</li> 44618 </ul></li> 44619 <li>dropbox 44620 <ul> 44621 <li>Increase chunk size to improve upload speeds massively</li> 44622 <li>Issue an error message when trying to upload bad file name</li> 44623 </ul></li> 44624 </ul> 44625 <h2 id="v1.18---2015-08-17">v1.18 - 2015-08-17</h2> 44626 <ul> 44627 <li>drive 44628 <ul> 44629 <li>Add <code>--drive-use-trash</code> flag so rclone trashes instead of deletes</li> 44630 <li>Add "Forbidden to download" message for files with no downloadURL</li> 44631 </ul></li> 44632 <li>dropbox 44633 <ul> 44634 <li>Remove datastore 44635 <ul> 44636 <li>This was deprecated and it caused a lot of problems</li> 44637 <li>Modification times and MD5SUMs no longer stored</li> 44638 </ul></li> 44639 <li>Fix uploading files > 2GB</li> 44640 </ul></li> 44641 <li>s3 44642 <ul> 44643 <li>use official AWS SDK from github.com/aws/aws-sdk-go</li> 44644 <li><strong>NB</strong> will most likely require you to delete and recreate remote</li> 44645 <li>enable multipart upload which enables files > 5GB</li> 44646 <li>tested with Ceph / RadosGW / S3 emulation</li> 44647 <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> 44648 </ul></li> 44649 <li>misc 44650 <ul> 44651 <li>Show errors when reading the config file</li> 44652 <li>Do not print stats in quiet mode - thanks Leonid Shalupov</li> 44653 <li>Add FAQ</li> 44654 <li>Fix created directories not obeying umask</li> 44655 <li>Linux installation instructions - thanks Shimon Doodkin</li> 44656 </ul></li> 44657 </ul> 44658 <h2 id="v1.17---2015-06-14">v1.17 - 2015-06-14</h2> 44659 <ul> 44660 <li>dropbox: fix case insensitivity issues - thanks Leonid Shalupov</li> 44661 </ul> 44662 <h2 id="v1.16---2015-06-09">v1.16 - 2015-06-09</h2> 44663 <ul> 44664 <li>Fix uploading big files which was causing timeouts or panics</li> 44665 <li>Don't check md5sum after download with --size-only</li> 44666 </ul> 44667 <h2 id="v1.15---2015-06-06">v1.15 - 2015-06-06</h2> 44668 <ul> 44669 <li>Add --checksum flag to only discard transfers by MD5SUM - thanks Alex Couper</li> 44670 <li>Implement --size-only flag to sync on size not checksum & modtime</li> 44671 <li>Expand docs and remove duplicated information</li> 44672 <li>Document rclone's limitations with directories</li> 44673 <li>dropbox: update docs about case insensitivity</li> 44674 </ul> 44675 <h2 id="v1.14---2015-05-21">v1.14 - 2015-05-21</h2> 44676 <ul> 44677 <li>local: fix encoding of non utf-8 file names - fixes a duplicate file problem</li> 44678 <li>drive: docs about rate limiting</li> 44679 <li>google cloud storage: Fix compile after API change in "google.golang.org/api/storage/v1"</li> 44680 </ul> 44681 <h2 id="v1.13---2015-05-10">v1.13 - 2015-05-10</h2> 44682 <ul> 44683 <li>Revise documentation (especially sync)</li> 44684 <li>Implement --timeout and --conntimeout</li> 44685 <li>s3: ignore etags from multipart uploads which aren't md5sums</li> 44686 </ul> 44687 <h2 id="v1.12---2015-03-15">v1.12 - 2015-03-15</h2> 44688 <ul> 44689 <li>drive: Use chunked upload for files above a certain size</li> 44690 <li>drive: add --drive-chunk-size and --drive-upload-cutoff parameters</li> 44691 <li>drive: switch to insert from update when a failed copy deletes the upload</li> 44692 <li>core: Log duplicate files if they are detected</li> 44693 </ul> 44694 <h2 id="v1.11---2015-03-04">v1.11 - 2015-03-04</h2> 44695 <ul> 44696 <li>swift: add region parameter</li> 44697 <li>drive: fix crash on failed to update remote mtime</li> 44698 <li>In remote paths, change native directory separators to /</li> 44699 <li>Add synchronization to ls/lsl/lsd output to stop corruptions</li> 44700 <li>Ensure all stats/log messages to go stderr</li> 44701 <li>Add --log-file flag to log everything (including panics) to file</li> 44702 <li>Make it possible to disable stats printing with --stats=0</li> 44703 <li>Implement --bwlimit to limit data transfer bandwidth</li> 44704 </ul> 44705 <h2 id="v1.10---2015-02-12">v1.10 - 2015-02-12</h2> 44706 <ul> 44707 <li>s3: list an unlimited number of items</li> 44708 <li>Fix getting stuck in the configurator</li> 44709 </ul> 44710 <h2 id="v1.09---2015-02-07">v1.09 - 2015-02-07</h2> 44711 <ul> 44712 <li>windows: Stop drive letters (e.g. C:) getting mixed up with remotes (e.g. drive:)</li> 44713 <li>local: Fix directory separators on Windows</li> 44714 <li>drive: fix rate limit exceeded errors</li> 44715 </ul> 44716 <h2 id="v1.08---2015-02-04">v1.08 - 2015-02-04</h2> 44717 <ul> 44718 <li>drive: fix subdirectory listing to not list entire drive</li> 44719 <li>drive: Fix SetModTime</li> 44720 <li>dropbox: adapt code to recent library changes</li> 44721 </ul> 44722 <h2 id="v1.07---2014-12-23">v1.07 - 2014-12-23</h2> 44723 <ul> 44724 <li>google cloud storage: fix memory leak</li> 44725 </ul> 44726 <h2 id="v1.06---2014-12-12">v1.06 - 2014-12-12</h2> 44727 <ul> 44728 <li>Fix "Couldn't find home directory" on OSX</li> 44729 <li>swift: Add tenant parameter</li> 44730 <li>Use new location of Google API packages</li> 44731 </ul> 44732 <h2 id="v1.05---2014-08-09">v1.05 - 2014-08-09</h2> 44733 <ul> 44734 <li>Improved tests and consequently lots of minor fixes</li> 44735 <li>core: Fix race detected by go race detector</li> 44736 <li>core: Fixes after running errcheck</li> 44737 <li>drive: reset root directory on Rmdir and Purge</li> 44738 <li>fs: Document that Purger returns error on empty directory, test and fix</li> 44739 <li>google cloud storage: fix ListDir on subdirectory</li> 44740 <li>google cloud storage: re-read metadata in SetModTime</li> 44741 <li>s3: make reading metadata more reliable to work around eventual consistency problems</li> 44742 <li>s3: strip trailing / from ListDir()</li> 44743 <li>swift: return directories without / in ListDir</li> 44744 </ul> 44745 <h2 id="v1.04---2014-07-21">v1.04 - 2014-07-21</h2> 44746 <ul> 44747 <li>google cloud storage: Fix crash on Update</li> 44748 </ul> 44749 <h2 id="v1.03---2014-07-20">v1.03 - 2014-07-20</h2> 44750 <ul> 44751 <li>swift, s3, dropbox: fix updated files being marked as corrupted</li> 44752 <li>Make compile with go 1.1 again</li> 44753 </ul> 44754 <h2 id="v1.02---2014-07-19">v1.02 - 2014-07-19</h2> 44755 <ul> 44756 <li>Implement Dropbox remote</li> 44757 <li>Implement Google Cloud Storage remote</li> 44758 <li>Verify Md5sums and Sizes after copies</li> 44759 <li>Remove times from "ls" command - lists sizes only</li> 44760 <li>Add add "lsl" - lists times and sizes</li> 44761 <li>Add "md5sum" command</li> 44762 </ul> 44763 <h2 id="v1.01---2014-07-04">v1.01 - 2014-07-04</h2> 44764 <ul> 44765 <li>drive: fix transfer of big files using up lots of memory</li> 44766 </ul> 44767 <h2 id="v1.00---2014-07-03">v1.00 - 2014-07-03</h2> 44768 <ul> 44769 <li>drive: fix whole second dates</li> 44770 </ul> 44771 <h2 id="v0.99---2014-06-26">v0.99 - 2014-06-26</h2> 44772 <ul> 44773 <li>Fix --dry-run not working</li> 44774 <li>Make compatible with go 1.1</li> 44775 </ul> 44776 <h2 id="v0.98---2014-05-30">v0.98 - 2014-05-30</h2> 44777 <ul> 44778 <li>s3: Treat missing Content-Length as 0 for some ceph installations</li> 44779 <li>rclonetest: add file with a space in</li> 44780 </ul> 44781 <h2 id="v0.97---2014-05-05">v0.97 - 2014-05-05</h2> 44782 <ul> 44783 <li>Implement copying of single files</li> 44784 <li>s3 & swift: support paths inside containers/buckets</li> 44785 </ul> 44786 <h2 id="v0.96---2014-04-24">v0.96 - 2014-04-24</h2> 44787 <ul> 44788 <li>drive: Fix multiple files of same name being created</li> 44789 <li>drive: Use o.Update and fs.Put to optimise transfers</li> 44790 <li>Add version number, -V and --version</li> 44791 </ul> 44792 <h2 id="v0.95---2014-03-28">v0.95 - 2014-03-28</h2> 44793 <ul> 44794 <li>rclone.org: website, docs and graphics</li> 44795 <li>drive: fix path parsing</li> 44796 </ul> 44797 <h2 id="v0.94---2014-03-27">v0.94 - 2014-03-27</h2> 44798 <ul> 44799 <li>Change remote format one last time</li> 44800 <li>GNU style flags</li> 44801 </ul> 44802 <h2 id="v0.93---2014-03-16">v0.93 - 2014-03-16</h2> 44803 <ul> 44804 <li>drive: store token in config file</li> 44805 <li>cross compile other versions</li> 44806 <li>set strict permissions on config file</li> 44807 </ul> 44808 <h2 id="v0.92---2014-03-15">v0.92 - 2014-03-15</h2> 44809 <ul> 44810 <li>Config fixes and --config option</li> 44811 </ul> 44812 <h2 id="v0.91---2014-03-15">v0.91 - 2014-03-15</h2> 44813 <ul> 44814 <li>Make config file</li> 44815 </ul> 44816 <h2 id="v0.90---2013-06-27">v0.90 - 2013-06-27</h2> 44817 <ul> 44818 <li>Project named rclone</li> 44819 </ul> 44820 <h2 id="v0.00---2012-11-18">v0.00 - 2012-11-18</h2> 44821 <ul> 44822 <li>Project started</li> 44823 </ul> 44824 <h1 id="bugs-and-limitations">Bugs and Limitations</h1> 44825 <h2 id="limitations-22">Limitations</h2> 44826 <h3 id="directory-timestamps-arent-preserved-on-some-backends">Directory timestamps aren't preserved on some backends</h3> 44827 <p>As of <code>v1.66</code>, rclone supports syncing directory modtimes, if the backend supports it. Some backends do not support it -- see <a href="https://rclone.org/overview/">overview</a> for a complete list. Additionally, note that empty directories are not synced by default (this can be enabled with <code>--create-empty-src-dirs</code>.)</p> 44828 <h3 id="rclone-struggles-with-millions-of-files-in-a-directorybucket">Rclone struggles with millions of files in a directory/bucket</h3> 44829 <p>Currently rclone loads each directory/bucket entirely into memory before using it. Since each rclone object takes 0.5k-1k of memory this can take a very long time and use a large amount of memory.</p> 44830 <p>Millions of files in a directory tends to occur on bucket-based remotes (e.g. S3 buckets) since those remotes do not segregate subdirectories within the bucket.</p> 44831 <h3 id="bucket-based-remotes-and-folders">Bucket-based remotes and folders</h3> 44832 <p>Bucket-based remotes (e.g. S3/GCS/Swift/B2) do not have a concept of directories. Rclone therefore cannot create directories in them which means that empty directories on a bucket-based remote will tend to disappear.</p> 44833 <p>Some software creates empty keys ending in <code>/</code> as directory markers. Rclone doesn't do this as it potentially creates more objects and costs more. This ability may be added in the future (probably via a flag/option).</p> 44834 <h2 id="bugs-1">Bugs</h2> 44835 <p>Bugs are stored in rclone's GitHub project:</p> 44836 <ul> 44837 <li><a href="https://github.com/rclone/rclone/issues?q=is%3Aopen+is%3Aissue+label%3Abug">Reported bugs</a></li> 44838 <li><a href="https://github.com/rclone/rclone/issues?q=is%3Aopen+is%3Aissue+milestone%3A%22Known+Problem%22">Known issues</a></li> 44839 </ul> 44840 <h1 id="frequently-asked-questions">Frequently Asked Questions</h1> 44841 <h3 id="do-all-cloud-storage-systems-support-all-rclone-commands">Do all cloud storage systems support all rclone commands</h3> 44842 <p>Yes they do. All the rclone commands (e.g. <code>sync</code>, <code>copy</code>, etc.) will work on all the remote storage systems.</p> 44843 <h3 id="can-i-copy-the-config-from-one-machine-to-another">Can I copy the config from one machine to another</h3> 44844 <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> 44845 <p>See the <a href="https://rclone.org/remote_setup/">remote setup docs</a> for more info.</p> 44846 <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> 44847 <p>This has now been documented in its own <a href="https://rclone.org/remote_setup/">remote setup page</a>.</p> 44848 <h3 id="can-rclone-sync-directly-from-drive-to-s3">Can rclone sync directly from drive to s3</h3> 44849 <p>Rclone can sync between two remote cloud storage systems just fine.</p> 44850 <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> 44851 <p>The syncs would be incremental (on a file by file basis).</p> 44852 <p>e.g.</p> 44853 <pre><code>rclone sync --interactive drive:Folder s3:bucket</code></pre> 44854 <h3 id="using-rclone-from-multiple-locations-at-the-same-time">Using rclone from multiple locations at the same time</h3> 44855 <p>You can use rclone from multiple places at the same time if you choose different subdirectory for the output, e.g.</p> 44856 <pre><code>Server A> rclone sync --interactive /tmp/whatever remote:ServerA 44857 Server B> rclone sync --interactive /tmp/whatever remote:ServerB</code></pre> 44858 <p>If you sync to the same directory then you should use rclone copy otherwise the two instances of rclone may delete each other's files, e.g.</p> 44859 <pre><code>Server A> rclone copy /tmp/whatever remote:Backup 44860 Server B> rclone copy /tmp/whatever remote:Backup</code></pre> 44861 <p>The file names you upload from Server A and Server B should be different in this case, otherwise some file systems (e.g. Drive) may make duplicates.</p> 44862 <h3 id="why-doesnt-rclone-support-partial-transfers-binary-diffs-like-rsync">Why doesn't rclone support partial transfers / binary diffs like rsync?</h3> 44863 <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 (e.g. 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> 44864 <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> 44865 <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> 44866 <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> 44867 <h3 id="can-rclone-do-bi-directional-sync">Can rclone do bi-directional sync?</h3> 44868 <p>Yes, since rclone v1.58.0, <a href="https://rclone.org/bisync/">bidirectional cloud sync</a> is available.</p> 44869 <h3 id="can-i-use-rclone-with-an-http-proxy">Can I use rclone with an HTTP proxy?</h3> 44870 <p>Yes. rclone will follow the standard environment variables for proxies, similar to cURL and other programs.</p> 44871 <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> 44872 <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> 44873 <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> 44874 <pre><code>export http_proxy=http://proxyserver:12345 44875 export https_proxy=$http_proxy 44876 export HTTP_PROXY=$http_proxy 44877 export HTTPS_PROXY=$http_proxy</code></pre> 44878 <p>Note: If the proxy server requires a username and password, then use</p> 44879 <pre><code>export http_proxy=http://username:password@proxyserver:12345 44880 export https_proxy=$http_proxy 44881 export HTTP_PROXY=$http_proxy 44882 export HTTPS_PROXY=$http_proxy</code></pre> 44883 <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> 44884 <p>e.g.</p> 44885 <pre><code>export no_proxy=localhost,127.0.0.0/8,my.host.name 44886 export NO_PROXY=$no_proxy</code></pre> 44887 <p>Note that the FTP backend does not support <code>ftp_proxy</code> yet.</p> 44888 <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> 44889 <p>This means that <code>rclone</code> can't find 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> 44890 <p>Rclone (via the Go runtime) tries to load the root certificates from these places on Linux.</p> 44891 <pre><code>"/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu/Gentoo etc. 44892 "/etc/pki/tls/certs/ca-bundle.crt", // Fedora/RHEL 44893 "/etc/ssl/ca-bundle.pem", // OpenSUSE 44894 "/etc/pki/tls/cacert.pem", // OpenELEC</code></pre> 44895 <p>So doing something like this should fix the problem. It also sets the time which is important for SSL to work properly.</p> 44896 <pre><code>mkdir -p /etc/ssl/certs/ 44897 curl -o /etc/ssl/certs/ca-certificates.crt https://raw.githubusercontent.com/bagder/ca-bundle/master/ca-bundle.crt 44898 ntpclient -s -h pool.ntp.org</code></pre> 44899 <p>The two environment variables <code>SSL_CERT_FILE</code> and <code>SSL_CERT_DIR</code>, mentioned in the <a href="https://godoc.org/crypto/x509">x509 package</a>, provide an additional way to provide the SSL root certificates.</p> 44900 <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> 44901 <pre><code>curl --insecure -o /etc/ssl/certs/ca-certificates.crt https://raw.githubusercontent.com/bagder/ca-bundle/master/ca-bundle.crt</code></pre> 44902 <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> 44903 <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> 44904 <p>See the <a href="https://golang.org/doc/install">system requirements section in the go install docs</a> for full details.</p> 44905 <h3 id="all-my-uploaded-docxxlsxpptx-files-appear-as-archivezip">All my uploaded docx/xlsx/pptx files appear as archive/zip</h3> 44906 <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> 44907 <h3 id="tcp-lookup-some.domain.com-no-such-host">tcp lookup some.domain.com no such host</h3> 44908 <p>This happens when rclone cannot resolve a domain. Please check that your DNS setup is generally working, e.g.</p> 44909 <pre><code># both should print a long list of possible IP addresses 44910 dig www.googleapis.com # resolve using your default DNS 44911 dig www.googleapis.com @8.8.8.8 # resolve with Google's DNS server</code></pre> 44912 <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> 44913 <p>The Go resolver decision can be influenced with the <code>GODEBUG=netdns=...</code> environment variable. This also allows to resolve certain issues with DNS resolution. On Windows or MacOS systems, try forcing use of the internal Go resolver by setting <code>GODEBUG=netdns=go</code> at runtime. On other systems (Linux, *BSD, etc) try forcing use of the system name resolver by setting <code>GODEBUG=netdns=cgo</code> (and recompile rclone from source with CGO enabled if necessary). See the <a href="https://golang.org/pkg/net/#hdr-Name_Resolution">name resolution section in the go docs</a>.</p> 44914 <h3 id="failed-to-start-auth-webserver-on-windows">Failed to start auth webserver on Windows</h3> 44915 <pre><code>Error: config failed to refresh token: failed to start auth webserver: listen tcp 127.0.0.1:53682: bind: An attempt was made to access a socket in a way forbidden by its access permissions. 44916 ... 44917 yyyy/mm/dd hh:mm:ss Fatal error: config failed to refresh token: failed to start auth webserver: listen tcp 127.0.0.1:53682: bind: An attempt was made to access a socket in a way forbidden by its access permissions.</code></pre> 44918 <p>This is sometimes caused by the Host Network Service causing issues with opening the port on the host.</p> 44919 <p>A simple solution may be restarting the Host Network Service with eg. Powershell</p> 44920 <pre><code>Restart-Service hns</code></pre> 44921 <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> 44922 <p>It is likely you have more than 10,000 files that need to be synced. By default, rclone only gets 10,000 files ahead in a sync so as not to use up too much memory. You can change this default with the <a href="https://rclone.org/docs/#max-backlog-n">--max-backlog</a> flag.</p> 44923 <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> 44924 <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> 44925 <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> 44926 <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> 44927 <h3 id="rclone-changes-fullwidth-unicode-punctuation-marks-in-file-names">Rclone changes fullwidth Unicode punctuation marks in file names</h3> 44928 <p>For example: On a Windows system, you have a file with name <code>Test：1.jpg</code>, where <code>：</code> is the Unicode fullwidth colon symbol. When using rclone to copy this to your Google Drive, you will notice that the file gets renamed to <code>Test:1.jpg</code>, where <code>:</code> is the regular (halfwidth) colon.</p> 44929 <p>The reason for such renames is the way rclone handles different <a href="https://rclone.org/overview/#restricted-filenames">restricted filenames</a> on different cloud storage systems. It tries to avoid ambiguous file names as much and allow moving files between many cloud storage systems transparently, by replacing invalid characters with similar looking Unicode characters when transferring to one storage system, and replacing back again when transferring to a different storage system where the original characters are supported. When the same Unicode characters are intentionally used in file names, this replacement strategy leads to unwanted renames. Read more <a href="https://rclone.org/overview/#restricted-filenames-caveats">here</a>.</p> 44930 <h1 id="license">License</h1> 44931 <p>This is free software under the terms of the MIT license (check the COPYING file included with the source code).</p> 44932 <pre><code>Copyright (C) 2019 by Nick Craig-Wood https://www.craig-wood.com/nick/ 44933 44934 Permission is hereby granted, free of charge, to any person obtaining a copy 44935 of this software and associated documentation files (the "Software"), to deal 44936 in the Software without restriction, including without limitation the rights 44937 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 44938 copies of the Software, and to permit persons to whom the Software is 44939 furnished to do so, subject to the following conditions: 44940 44941 The above copyright notice and this permission notice shall be included in 44942 all copies or substantial portions of the Software. 44943 44944 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 44945 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 44946 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 44947 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 44948 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 44949 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 44950 THE SOFTWARE.</code></pre> 44951 <h1 id="authors-and-contributors">Authors and contributors</h1> 44952 <h2 id="authors">Authors</h2> 44953 <ul> 44954 <li>Nick Craig-Wood <a href="mailto:nick@craig-wood.com" class="email">nick@craig-wood.com</a></li> 44955 </ul> 44956 <h2 id="contributors">Contributors</h2> 44957 <p>{{< rem <code>email addresses removed from here need to be added to bin/.ignore-emails to make sure update-authors.py doesn't immediately put them back in again.</code> >}}</p> 44958 <ul> 44959 <li>Alex Couper <a href="mailto:amcouper@gmail.com" class="email">amcouper@gmail.com</a></li> 44960 <li>Leonid Shalupov <a href="mailto:leonid@shalupov.com" class="email">leonid@shalupov.com</a> <a href="mailto:shalupov@diverse.org.ru" class="email">shalupov@diverse.org.ru</a></li> 44961 <li>Shimon Doodkin <a href="mailto:helpmepro1@gmail.com" class="email">helpmepro1@gmail.com</a></li> 44962 <li>Colin Nicholson <a href="mailto:colin@colinn.com" class="email">colin@colinn.com</a></li> 44963 <li>Klaus Post <a href="mailto:klauspost@gmail.com" class="email">klauspost@gmail.com</a></li> 44964 <li>Sergey Tolmachev <a href="mailto:tolsi.ru@gmail.com" class="email">tolsi.ru@gmail.com</a></li> 44965 <li>Adriano Aurélio Meirelles <a href="mailto:adriano@atinge.com" class="email">adriano@atinge.com</a></li> 44966 <li>C. Bess <a href="mailto:cbess@users.noreply.github.com" class="email">cbess@users.noreply.github.com</a></li> 44967 <li>Dmitry Burdeev <a href="mailto:dibu28@gmail.com" class="email">dibu28@gmail.com</a></li> 44968 <li>Joseph Spurrier <a href="mailto:github@josephspurrier.com" class="email">github@josephspurrier.com</a></li> 44969 <li>Björn Harrtell <a href="mailto:bjorn@wololo.org" class="email">bjorn@wololo.org</a></li> 44970 <li>Xavier Lucas <a href="mailto:xavier.lucas@corp.ovh.com" class="email">xavier.lucas@corp.ovh.com</a></li> 44971 <li>Werner Beroux <a href="mailto:werner@beroux.com" class="email">werner@beroux.com</a></li> 44972 <li>Brian Stengaard <a href="mailto:brian@stengaard.eu" class="email">brian@stengaard.eu</a></li> 44973 <li>Jakub Gedeon <a href="mailto:jgedeon@sofi.com" class="email">jgedeon@sofi.com</a></li> 44974 <li>Jim Tittsler <a href="mailto:jwt@onjapan.net" class="email">jwt@onjapan.net</a></li> 44975 <li>Michal Witkowski <a href="mailto:michal@improbable.io" class="email">michal@improbable.io</a></li> 44976 <li>Fabian Ruff <a href="mailto:fabian.ruff@sap.com" class="email">fabian.ruff@sap.com</a></li> 44977 <li>Leigh Klotz <a href="mailto:klotz@quixey.com" class="email">klotz@quixey.com</a></li> 44978 <li>Romain Lapray <a href="mailto:lapray.romain@gmail.com" class="email">lapray.romain@gmail.com</a></li> 44979 <li>Justin R. Wilson <a href="mailto:jrw972@gmail.com" class="email">jrw972@gmail.com</a></li> 44980 <li>Antonio Messina <a href="mailto:antonio.s.messina@gmail.com" class="email">antonio.s.messina@gmail.com</a></li> 44981 <li>Stefan G. Weichinger <a href="mailto:office@oops.co.at" class="email">office@oops.co.at</a></li> 44982 <li>Per Cederberg <a href="mailto:cederberg@gmail.com" class="email">cederberg@gmail.com</a></li> 44983 <li>Radek Šenfeld <a href="mailto:rush@logic.cz" class="email">rush@logic.cz</a></li> 44984 <li>Fredrik Fornwall <a href="mailto:fredrik@fornwall.net" class="email">fredrik@fornwall.net</a></li> 44985 <li>Asko Tamm <a href="mailto:asko@deekit.net" class="email">asko@deekit.net</a></li> 44986 <li>xor-zz <a href="mailto:xor@gstocco.com" class="email">xor@gstocco.com</a></li> 44987 <li>Tomasz Mazur <a href="mailto:tmazur90@gmail.com" class="email">tmazur90@gmail.com</a></li> 44988 <li>Marco Paganini <a href="mailto:paganini@paganini.net" class="email">paganini@paganini.net</a></li> 44989 <li>Felix Bünemann <a href="mailto:buenemann@louis.info" class="email">buenemann@louis.info</a></li> 44990 <li>Durval Menezes <a href="mailto:jmrclone@durval.com" class="email">jmrclone@durval.com</a></li> 44991 <li>Luiz Carlos Rumbelsperger Viana <a href="mailto:maxd13_luiz_carlos@hotmail.com" class="email">maxd13_luiz_carlos@hotmail.com</a></li> 44992 <li>Stefan Breunig <a href="mailto:stefan-github@yrden.de" class="email">stefan-github@yrden.de</a></li> 44993 <li>Alishan Ladhani <a href="mailto:ali-l@users.noreply.github.com" class="email">ali-l@users.noreply.github.com</a></li> 44994 <li>0xJAKE <a href="mailto:0xJAKE@users.noreply.github.com" class="email">0xJAKE@users.noreply.github.com</a></li> 44995 <li>Thibault Molleman <a href="mailto:thibaultmol@users.noreply.github.com" class="email">thibaultmol@users.noreply.github.com</a></li> 44996 <li>Scott McGillivray <a href="mailto:scott.mcgillivray@gmail.com" class="email">scott.mcgillivray@gmail.com</a></li> 44997 <li>Bjørn Erik Pedersen <a href="mailto:bjorn.erik.pedersen@gmail.com" class="email">bjorn.erik.pedersen@gmail.com</a></li> 44998 <li>Lukas Loesche <a href="mailto:lukas@mesosphere.io" class="email">lukas@mesosphere.io</a></li> 44999 <li>emyarod <a href="mailto:emyarod@users.noreply.github.com" class="email">emyarod@users.noreply.github.com</a></li> 45000 <li>T.C. Ferguson <a href="mailto:tcf909@gmail.com" class="email">tcf909@gmail.com</a></li> 45001 <li>Brandur <a href="mailto:brandur@mutelight.org" class="email">brandur@mutelight.org</a></li> 45002 <li>Dario Giovannetti <a href="mailto:dev@dariogiovannetti.net" class="email">dev@dariogiovannetti.net</a></li> 45003 <li>Károly Oláh <a href="mailto:okaresz@aol.com" class="email">okaresz@aol.com</a></li> 45004 <li>Jon Yergatian <a href="mailto:jon@macfanatic.ca" class="email">jon@macfanatic.ca</a></li> 45005 <li>Jack Schmidt <a href="mailto:github@mowsey.org" class="email">github@mowsey.org</a></li> 45006 <li>Dedsec1 <a href="mailto:Dedsec1@users.noreply.github.com" class="email">Dedsec1@users.noreply.github.com</a></li> 45007 <li>Hisham Zarka <a href="mailto:hzarka@gmail.com" class="email">hzarka@gmail.com</a></li> 45008 <li>Jérôme Vizcaino <a href="mailto:jerome.vizcaino@gmail.com" class="email">jerome.vizcaino@gmail.com</a></li> 45009 <li>Mike Tesch <a href="mailto:mjt6129@rit.edu" class="email">mjt6129@rit.edu</a></li> 45010 <li>Marvin Watson <a href="mailto:marvwatson@users.noreply.github.com" class="email">marvwatson@users.noreply.github.com</a></li> 45011 <li>Danny Tsai <a href="mailto:danny8376@gmail.com" class="email">danny8376@gmail.com</a></li> 45012 <li>Yoni Jah <a href="mailto:yonjah+git@gmail.com" class="email">yonjah+git@gmail.com</a> <a href="mailto:yonjah+github@gmail.com" class="email">yonjah+github@gmail.com</a></li> 45013 <li>Stephen Harris <a href="mailto:github@spuddy.org" class="email">github@spuddy.org</a> <a href="mailto:sweharris@users.noreply.github.com" class="email">sweharris@users.noreply.github.com</a></li> 45014 <li>Ihor Dvoretskyi <a href="mailto:ihor.dvoretskyi@gmail.com" class="email">ihor.dvoretskyi@gmail.com</a></li> 45015 <li>Jon Craton <a href="mailto:jncraton@gmail.com" class="email">jncraton@gmail.com</a></li> 45016 <li>Hraban Luyat <a href="mailto:hraban@0brg.net" class="email">hraban@0brg.net</a></li> 45017 <li>Michael Ledin <a href="mailto:mledin89@gmail.com" class="email">mledin89@gmail.com</a></li> 45018 <li>Martin Kristensen <a href="mailto:me@azgul.com" class="email">me@azgul.com</a></li> 45019 <li>Too Much IO <a href="mailto:toomuchio@users.noreply.github.com" class="email">toomuchio@users.noreply.github.com</a></li> 45020 <li>Anisse Astier <a href="mailto:anisse@astier.eu" class="email">anisse@astier.eu</a></li> 45021 <li>Zahiar Ahmed <a href="mailto:zahiar@live.com" class="email">zahiar@live.com</a></li> 45022 <li>Igor Kharin <a href="mailto:igorkharin@gmail.com" class="email">igorkharin@gmail.com</a></li> 45023 <li>Bill Zissimopoulos <a href="mailto:billziss@navimatics.com" class="email">billziss@navimatics.com</a></li> 45024 <li>Bob Potter <a href="mailto:bobby.potter@gmail.com" class="email">bobby.potter@gmail.com</a></li> 45025 <li>Steven Lu <a href="mailto:tacticalazn@gmail.com" class="email">tacticalazn@gmail.com</a></li> 45026 <li>Sjur Fredriksen <a href="mailto:sjurtf@ifi.uio.no" class="email">sjurtf@ifi.uio.no</a></li> 45027 <li>Ruwbin <a href="mailto:hubus12345@gmail.com" class="email">hubus12345@gmail.com</a></li> 45028 <li>Fabian Möller <a href="mailto:fabianm88@gmail.com" class="email">fabianm88@gmail.com</a> <a href="mailto:f.moeller@nynex.de" class="email">f.moeller@nynex.de</a></li> 45029 <li>Edward Q. Bridges <a href="mailto:github@eqbridges.com" class="email">github@eqbridges.com</a></li> 45030 <li>Vasiliy Tolstov <a href="mailto:v.tolstov@selfip.ru" class="email">v.tolstov@selfip.ru</a></li> 45031 <li>Harshavardhana <a href="mailto:harsha@minio.io" class="email">harsha@minio.io</a></li> 45032 <li>sainaen <a href="mailto:sainaen@gmail.com" class="email">sainaen@gmail.com</a></li> 45033 <li>gdm85 <a href="mailto:gdm85@users.noreply.github.com" class="email">gdm85@users.noreply.github.com</a></li> 45034 <li>Yaroslav Halchenko <a href="mailto:debian@onerussian.com" class="email">debian@onerussian.com</a></li> 45035 <li>John Papandriopoulos <a href="mailto:jpap@users.noreply.github.com" class="email">jpap@users.noreply.github.com</a></li> 45036 <li>Zhiming Wang <a href="mailto:zmwangx@gmail.com" class="email">zmwangx@gmail.com</a></li> 45037 <li>Andy Pilate <a href="mailto:cubox@cubox.me" class="email">cubox@cubox.me</a></li> 45038 <li>Oliver Heyme <a href="mailto:olihey@googlemail.com" class="email">olihey@googlemail.com</a> <a href="mailto:olihey@users.noreply.github.com" class="email">olihey@users.noreply.github.com</a> <a href="mailto:de8olihe@lego.com" class="email">de8olihe@lego.com</a></li> 45039 <li>wuyu <a href="mailto:wuyu@yunify.com" class="email">wuyu@yunify.com</a></li> 45040 <li>Andrei Dragomir <a href="mailto:adragomi@adobe.com" class="email">adragomi@adobe.com</a></li> 45041 <li>Christian Brüggemann <a href="mailto:mail@cbruegg.com" class="email">mail@cbruegg.com</a></li> 45042 <li>Alex McGrath Kraak <a href="mailto:amkdude@gmail.com" class="email">amkdude@gmail.com</a></li> 45043 <li>bpicode <a href="mailto:bjoern.pirnay@googlemail.com" class="email">bjoern.pirnay@googlemail.com</a></li> 45044 <li>Daniel Jagszent <a href="mailto:daniel@jagszent.de" class="email">daniel@jagszent.de</a></li> 45045 <li>Josiah White <a href="mailto:thegenius2009@gmail.com" class="email">thegenius2009@gmail.com</a></li> 45046 <li>Ishuah Kariuki <a href="mailto:kariuki@ishuah.com" class="email">kariuki@ishuah.com</a> <a href="mailto:ishuah91@gmail.com" class="email">ishuah91@gmail.com</a></li> 45047 <li>Jan Varho <a href="mailto:jan@varho.org" class="email">jan@varho.org</a></li> 45048 <li>Girish Ramakrishnan <a href="mailto:girish@cloudron.io" class="email">girish@cloudron.io</a></li> 45049 <li>LingMan <a href="mailto:LingMan@users.noreply.github.com" class="email">LingMan@users.noreply.github.com</a></li> 45050 <li>Jacob McNamee <a href="mailto:jacobmcnamee@gmail.com" class="email">jacobmcnamee@gmail.com</a></li> 45051 <li>jersou <a href="mailto:jertux@gmail.com" class="email">jertux@gmail.com</a></li> 45052 <li>thierry <a href="mailto:thierry@substantiel.fr" class="email">thierry@substantiel.fr</a></li> 45053 <li>Simon Leinen <a href="mailto:simon.leinen@gmail.com" class="email">simon.leinen@gmail.com</a> <a href="mailto:ubuntu@s3-test.novalocal" class="email">ubuntu@s3-test.novalocal</a></li> 45054 <li>Dan Dascalescu <a href="mailto:ddascalescu+github@gmail.com" class="email">ddascalescu+github@gmail.com</a></li> 45055 <li>Jason Rose <a href="mailto:jason@jro.io" class="email">jason@jro.io</a></li> 45056 <li>Andrew Starr-Bochicchio <a href="mailto:a.starr.b@gmail.com" class="email">a.starr.b@gmail.com</a></li> 45057 <li>John Leach <a href="mailto:john@johnleach.co.uk" class="email">john@johnleach.co.uk</a></li> 45058 <li>Corban Raun <a href="mailto:craun@instructure.com" class="email">craun@instructure.com</a></li> 45059 <li>Pierre Carlson <a href="mailto:mpcarl@us.ibm.com" class="email">mpcarl@us.ibm.com</a></li> 45060 <li>Ernest Borowski <a href="mailto:er.borowski@gmail.com" class="email">er.borowski@gmail.com</a></li> 45061 <li>Remus Bunduc <a href="mailto:remus.bunduc@gmail.com" class="email">remus.bunduc@gmail.com</a></li> 45062 <li>Iakov Davydov <a href="mailto:iakov.davydov@unil.ch" class="email">iakov.davydov@unil.ch</a> <a href="mailto:dav05.gith@myths.ru" class="email">dav05.gith@myths.ru</a></li> 45063 <li>Jakub Tasiemski <a href="mailto:tasiemski@gmail.com" class="email">tasiemski@gmail.com</a></li> 45064 <li>David Minor <a href="mailto:dminor@saymedia.com" class="email">dminor@saymedia.com</a></li> 45065 <li>Tim Cooijmans <a href="mailto:cooijmans.tim@gmail.com" class="email">cooijmans.tim@gmail.com</a></li> 45066 <li>Laurence <a href="mailto:liuxy6@gmail.com" class="email">liuxy6@gmail.com</a></li> 45067 <li>Giovanni Pizzi <a href="mailto:gio.piz@gmail.com" class="email">gio.piz@gmail.com</a></li> 45068 <li>Filip Bartodziej <a href="mailto:filipbartodziej@gmail.com" class="email">filipbartodziej@gmail.com</a></li> 45069 <li>Jon Fautley <a href="mailto:jon@dead.li" class="email">jon@dead.li</a></li> 45070 <li>lewapm <a href="mailto:32110057+lewapm@users.noreply.github.com" class="email">32110057+lewapm@users.noreply.github.com</a></li> 45071 <li>Yassine Imounachen <a href="mailto:yassine256@gmail.com" class="email">yassine256@gmail.com</a></li> 45072 <li>Chris Redekop <a href="mailto:chris-redekop@users.noreply.github.com" class="email">chris-redekop@users.noreply.github.com</a> <a href="mailto:chris.redekop@gmail.com" class="email">chris.redekop@gmail.com</a></li> 45073 <li>Jon Fautley <a href="mailto:jon@adenoid.appstal.co.uk" class="email">jon@adenoid.appstal.co.uk</a></li> 45074 <li>Will Gunn <a href="mailto:WillGunn@users.noreply.github.com" class="email">WillGunn@users.noreply.github.com</a></li> 45075 <li>Lucas Bremgartner <a href="mailto:lucas@bremis.ch" class="email">lucas@bremis.ch</a></li> 45076 <li>Jody Frankowski <a href="mailto:jody.frankowski@gmail.com" class="email">jody.frankowski@gmail.com</a></li> 45077 <li>Andreas Roussos <a href="mailto:arouss1980@gmail.com" class="email">arouss1980@gmail.com</a></li> 45078 <li>nbuchanan <a href="mailto:nbuchanan@utah.gov" class="email">nbuchanan@utah.gov</a></li> 45079 <li>Durval Menezes <a href="mailto:rclone@durval.com" class="email">rclone@durval.com</a></li> 45080 <li>Victor <a href="mailto:vb-github@viblo.se" class="email">vb-github@viblo.se</a></li> 45081 <li>Mateusz <a href="mailto:pabian.mateusz@gmail.com" class="email">pabian.mateusz@gmail.com</a></li> 45082 <li>Daniel Loader <a href="mailto:spicypixel@gmail.com" class="email">spicypixel@gmail.com</a></li> 45083 <li>David0rk <a href="mailto:davidork@gmail.com" class="email">davidork@gmail.com</a></li> 45084 <li>Alexander Neumann <a href="mailto:alexander@bumpern.de" class="email">alexander@bumpern.de</a></li> 45085 <li>Giri Badanahatti <a href="mailto:gbadanahatti@us.ibm.com@Giris-MacBook-Pro.local" class="email">gbadanahatti@us.ibm.com@Giris-MacBook-Pro.local</a></li> 45086 <li>Leo R. Lundgren <a href="mailto:leo@finalresort.org" class="email">leo@finalresort.org</a></li> 45087 <li>wolfv <a href="mailto:wolfv6@users.noreply.github.com" class="email">wolfv6@users.noreply.github.com</a></li> 45088 <li>Dave Pedu <a href="mailto:dave@davepedu.com" class="email">dave@davepedu.com</a></li> 45089 <li>Stefan Lindblom <a href="mailto:lindblom@spotify.com" class="email">lindblom@spotify.com</a></li> 45090 <li>seuffert <a href="mailto:oliver@seuffert.biz" class="email">oliver@seuffert.biz</a></li> 45091 <li>gbadanahatti <a href="mailto:37121690+gbadanahatti@users.noreply.github.com" class="email">37121690+gbadanahatti@users.noreply.github.com</a></li> 45092 <li>Keith Goldfarb <a href="mailto:barkofdelight@gmail.com" class="email">barkofdelight@gmail.com</a></li> 45093 <li>Steve Kriss <a href="mailto:steve@heptio.com" class="email">steve@heptio.com</a></li> 45094 <li>Chih-Hsuan Yen <a href="mailto:yan12125@gmail.com" class="email">yan12125@gmail.com</a></li> 45095 <li>Alexander Neumann <a href="mailto:fd0@users.noreply.github.com" class="email">fd0@users.noreply.github.com</a></li> 45096 <li>Matt Holt <a href="mailto:mholt@users.noreply.github.com" class="email">mholt@users.noreply.github.com</a></li> 45097 <li>Eri Bastos <a href="mailto:bastos.eri@gmail.com" class="email">bastos.eri@gmail.com</a></li> 45098 <li>Michael P. Dubner <a href="mailto:pywebmail@list.ru" class="email">pywebmail@list.ru</a></li> 45099 <li>Antoine GIRARD <a href="mailto:sapk@users.noreply.github.com" class="email">sapk@users.noreply.github.com</a></li> 45100 <li>Mateusz Piotrowski <a href="mailto:mpp302@gmail.com" class="email">mpp302@gmail.com</a></li> 45101 <li>Animosity022 <a href="mailto:animosity22@users.noreply.github.com" class="email">animosity22@users.noreply.github.com</a> <a href="mailto:earl.texter@gmail.com" class="email">earl.texter@gmail.com</a></li> 45102 <li>Peter Baumgartner <a href="mailto:pete@lincolnloop.com" class="email">pete@lincolnloop.com</a></li> 45103 <li>Craig Rachel <a href="mailto:craig@craigrachel.com" class="email">craig@craigrachel.com</a></li> 45104 <li>Michael G. Noll <a href="mailto:miguno@users.noreply.github.com" class="email">miguno@users.noreply.github.com</a></li> 45105 <li>hensur <a href="mailto:me@hensur.de" class="email">me@hensur.de</a></li> 45106 <li>Oliver Heyme <a href="mailto:de8olihe@lego.com" class="email">de8olihe@lego.com</a></li> 45107 <li>Richard Yang <a href="mailto:richard@yenforyang.com" class="email">richard@yenforyang.com</a></li> 45108 <li>Piotr Oleszczyk <a href="mailto:piotr.oleszczyk@gmail.com" class="email">piotr.oleszczyk@gmail.com</a></li> 45109 <li>Rodrigo <a href="mailto:rodarima@gmail.com" class="email">rodarima@gmail.com</a></li> 45110 <li>NoLooseEnds <a href="mailto:NoLooseEnds@users.noreply.github.com" class="email">NoLooseEnds@users.noreply.github.com</a></li> 45111 <li>Jakub Karlicek <a href="mailto:jakub@karlicek.me" class="email">jakub@karlicek.me</a></li> 45112 <li>John Clayton <a href="mailto:john@codemonkeylabs.com" class="email">john@codemonkeylabs.com</a></li> 45113 <li>Kasper Byrdal Nielsen <a href="mailto:byrdal76@gmail.com" class="email">byrdal76@gmail.com</a></li> 45114 <li>Benjamin Joseph Dag <a href="mailto:bjdag1234@users.noreply.github.com" class="email">bjdag1234@users.noreply.github.com</a></li> 45115 <li>themylogin <a href="mailto:themylogin@gmail.com" class="email">themylogin@gmail.com</a></li> 45116 <li>Onno Zweers <a href="mailto:onno.zweers@surfsara.nl" class="email">onno.zweers@surfsara.nl</a></li> 45117 <li>Jasper Lievisse Adriaanse <a href="mailto:jasper@humppa.nl" class="email">jasper@humppa.nl</a></li> 45118 <li>sandeepkru <a href="mailto:sandeep.ummadi@gmail.com" class="email">sandeep.ummadi@gmail.com</a> <a href="mailto:sandeepkru@users.noreply.github.com" class="email">sandeepkru@users.noreply.github.com</a></li> 45119 <li>HerrH <a href="mailto:atomtigerzoo@users.noreply.github.com" class="email">atomtigerzoo@users.noreply.github.com</a></li> 45120 <li>Andrew <a href="mailto:4030760+sparkyman215@users.noreply.github.com" class="email">4030760+sparkyman215@users.noreply.github.com</a></li> 45121 <li>dan smith <a href="mailto:XX1011@gmail.com" class="email">XX1011@gmail.com</a></li> 45122 <li>Oleg Kovalov <a href="mailto:iamolegkovalov@gmail.com" class="email">iamolegkovalov@gmail.com</a></li> 45123 <li>Ruben Vandamme <a href="mailto:github-com-00ff86@vandamme.email" class="email">github-com-00ff86@vandamme.email</a></li> 45124 <li>Cnly <a href="mailto:minecnly@gmail.com" class="email">minecnly@gmail.com</a></li> 45125 <li>Andres Alvarez <a href="mailto:1671935+kir4h@users.noreply.github.com" class="email">1671935+kir4h@users.noreply.github.com</a></li> 45126 <li>reddi1 <a href="mailto:xreddi@gmail.com" class="email">xreddi@gmail.com</a></li> 45127 <li>Matt Tucker <a href="mailto:matthewtckr@gmail.com" class="email">matthewtckr@gmail.com</a></li> 45128 <li>Sebastian Bünger <a href="mailto:buengese@gmail.com" class="email">buengese@gmail.com</a> <a href="mailto:buengese@protonmail.com" class="email">buengese@protonmail.com</a></li> 45129 <li>Martin Polden <a href="mailto:mpolden@mpolden.no" class="email">mpolden@mpolden.no</a></li> 45130 <li>Alex Chen <a href="mailto:Cnly@users.noreply.github.com" class="email">Cnly@users.noreply.github.com</a></li> 45131 <li>Denis <a href="mailto:deniskovpen@gmail.com" class="email">deniskovpen@gmail.com</a></li> 45132 <li>bsteiss <a href="mailto:35940619+bsteiss@users.noreply.github.com" class="email">35940619+bsteiss@users.noreply.github.com</a></li> 45133 <li>Cédric Connes <a href="mailto:cedric.connes@gmail.com" class="email">cedric.connes@gmail.com</a></li> 45134 <li>Dr. Tobias Quathamer <a href="mailto:toddy15@users.noreply.github.com" class="email">toddy15@users.noreply.github.com</a></li> 45135 <li>dcpu <a href="mailto:42736967+dcpu@users.noreply.github.com" class="email">42736967+dcpu@users.noreply.github.com</a></li> 45136 <li>Sheldon Rupp <a href="mailto:me@shel.io" class="email">me@shel.io</a></li> 45137 <li>albertony <a href="mailto:12441419+albertony@users.noreply.github.com" class="email">12441419+albertony@users.noreply.github.com</a></li> 45138 <li>cron410 <a href="mailto:cron410@gmail.com" class="email">cron410@gmail.com</a></li> 45139 <li>Anagh Kumar Baranwal <a href="mailto:6824881+darthShadow@users.noreply.github.com" class="email">6824881+darthShadow@users.noreply.github.com</a></li> 45140 <li>Felix Brucker <a href="mailto:felix@felixbrucker.com" class="email">felix@felixbrucker.com</a></li> 45141 <li>Santiago Rodríguez <a href="mailto:scollazo@users.noreply.github.com" class="email">scollazo@users.noreply.github.com</a></li> 45142 <li>Craig Miskell <a href="mailto:craig.miskell@fluxfederation.com" class="email">craig.miskell@fluxfederation.com</a></li> 45143 <li>Antoine GIRARD <a href="mailto:sapk@sapk.fr" class="email">sapk@sapk.fr</a></li> 45144 <li>Joanna Marek <a href="mailto:joanna.marek@u2i.com" class="email">joanna.marek@u2i.com</a></li> 45145 <li>frenos <a href="mailto:frenos@users.noreply.github.com" class="email">frenos@users.noreply.github.com</a></li> 45146 <li>ssaqua <a href="mailto:ssaqua@users.noreply.github.com" class="email">ssaqua@users.noreply.github.com</a></li> 45147 <li>xnaas <a href="mailto:me@xnaas.info" class="email">me@xnaas.info</a></li> 45148 <li>Frantisek Fuka <a href="mailto:fuka@fuxoft.cz" class="email">fuka@fuxoft.cz</a></li> 45149 <li>Paul Kohout <a href="mailto:pauljkohout@yahoo.com" class="email">pauljkohout@yahoo.com</a></li> 45150 <li>dcpu <a href="mailto:43330287+dcpu@users.noreply.github.com" class="email">43330287+dcpu@users.noreply.github.com</a></li> 45151 <li>jackyzy823 <a href="mailto:jackyzy823@gmail.com" class="email">jackyzy823@gmail.com</a></li> 45152 <li>David Haguenauer <a href="mailto:ml@kurokatta.org" class="email">ml@kurokatta.org</a></li> 45153 <li>teresy <a href="mailto:hi.teresy@gmail.com" class="email">hi.teresy@gmail.com</a></li> 45154 <li>buergi <a href="mailto:patbuergi@gmx.de" class="email">patbuergi@gmx.de</a></li> 45155 <li>Florian Gamboeck <a href="mailto:mail@floga.de" class="email">mail@floga.de</a></li> 45156 <li>Ralf Hemberger <a href="mailto:10364191+rhemberger@users.noreply.github.com" class="email">10364191+rhemberger@users.noreply.github.com</a></li> 45157 <li>Scott Edlund <a href="mailto:sedlund@users.noreply.github.com" class="email">sedlund@users.noreply.github.com</a></li> 45158 <li>Erik Swanson <a href="mailto:erik@retailnext.net" class="email">erik@retailnext.net</a></li> 45159 <li>Jake Coggiano <a href="mailto:jake@stripe.com" class="email">jake@stripe.com</a></li> 45160 <li>brused27 <a href="mailto:brused27@noemailaddress" class="email">brused27@noemailaddress</a></li> 45161 <li>Peter Kaminski <a href="mailto:kaminski@istori.com" class="email">kaminski@istori.com</a></li> 45162 <li>Henry Ptasinski <a href="mailto:henry@logout.com" class="email">henry@logout.com</a></li> 45163 <li>Alexander <a href="mailto:kharkovalexander@gmail.com" class="email">kharkovalexander@gmail.com</a></li> 45164 <li>Garry McNulty <a href="mailto:garrmcnu@gmail.com" class="email">garrmcnu@gmail.com</a></li> 45165 <li>Mathieu Carbou <a href="mailto:mathieu.carbou@gmail.com" class="email">mathieu.carbou@gmail.com</a></li> 45166 <li>Mark Otway <a href="mailto:mark@otway.com" class="email">mark@otway.com</a></li> 45167 <li>William Cocker <a href="mailto:37018962+WilliamCocker@users.noreply.github.com" class="email">37018962+WilliamCocker@users.noreply.github.com</a></li> 45168 <li>François Leurent <a href="mailto:131.js@cloudyks.org" class="email">131.js@cloudyks.org</a></li> 45169 <li>Arkadius Stefanski <a href="mailto:arkste@gmail.com" class="email">arkste@gmail.com</a></li> 45170 <li>Jay <a href="mailto:dev@jaygoel.com" class="email">dev@jaygoel.com</a></li> 45171 <li>andrea rota <a href="mailto:a@xelera.eu" class="email">a@xelera.eu</a></li> 45172 <li>nicolov <a href="mailto:nicolov@users.noreply.github.com" class="email">nicolov@users.noreply.github.com</a></li> 45173 <li>Matt Joiner <a href="mailto:anacrolix@gmail.com" class="email">anacrolix@gmail.com</a></li> 45174 <li>Dario Guzik <a href="mailto:dario@guzik.com.ar" class="email">dario@guzik.com.ar</a></li> 45175 <li>qip <a href="mailto:qip@users.noreply.github.com" class="email">qip@users.noreply.github.com</a></li> 45176 <li>yair@unicorn <a href="mailto:yair@unicorn" class="email">yair@unicorn</a></li> 45177 <li>Matt Robinson <a href="mailto:brimstone@the.narro.ws" class="email">brimstone@the.narro.ws</a></li> 45178 <li>kayrus <a href="mailto:kay.diam@gmail.com" class="email">kay.diam@gmail.com</a></li> 45179 <li>Rémy Léone <a href="mailto:remy.leone@gmail.com" class="email">remy.leone@gmail.com</a></li> 45180 <li>Wojciech Smigielski <a href="mailto:wojciech.hieronim.smigielski@gmail.com" class="email">wojciech.hieronim.smigielski@gmail.com</a></li> 45181 <li>weetmuts <a href="mailto:oehrstroem@gmail.com" class="email">oehrstroem@gmail.com</a></li> 45182 <li>Jonathan <a href="mailto:vanillajonathan@users.noreply.github.com" class="email">vanillajonathan@users.noreply.github.com</a></li> 45183 <li>James Carpenter <a href="mailto:orbsmiv@users.noreply.github.com" class="email">orbsmiv@users.noreply.github.com</a></li> 45184 <li>Vince <a href="mailto:vince0villamora@gmail.com" class="email">vince0villamora@gmail.com</a></li> 45185 <li>Nestar47 <a href="mailto:47841759+Nestar47@users.noreply.github.com" class="email">47841759+Nestar47@users.noreply.github.com</a></li> 45186 <li>Six <a href="mailto:brbsix@gmail.com" class="email">brbsix@gmail.com</a></li> 45187 <li>Alexandru Bumbacea <a href="mailto:alexandru.bumbacea@booking.com" class="email">alexandru.bumbacea@booking.com</a></li> 45188 <li>calisro <a href="mailto:robert.calistri@gmail.com" class="email">robert.calistri@gmail.com</a></li> 45189 <li>Dr.Rx <a href="mailto:david.rey@nventive.com" class="email">david.rey@nventive.com</a></li> 45190 <li>marcintustin <a href="mailto:marcintustin@users.noreply.github.com" class="email">marcintustin@users.noreply.github.com</a></li> 45191 <li>jaKa Močnik <a href="mailto:jaka@koofr.net" class="email">jaka@koofr.net</a></li> 45192 <li>Fionera <a href="mailto:fionera@fionera.de" class="email">fionera@fionera.de</a></li> 45193 <li>Dan Walters <a href="mailto:dan@walters.io" class="email">dan@walters.io</a></li> 45194 <li>Danil Semelenov <a href="mailto:sgtpep@users.noreply.github.com" class="email">sgtpep@users.noreply.github.com</a></li> 45195 <li>xopez <a href="mailto:28950736+xopez@users.noreply.github.com" class="email">28950736+xopez@users.noreply.github.com</a></li> 45196 <li>Ben Boeckel <a href="mailto:mathstuf@gmail.com" class="email">mathstuf@gmail.com</a></li> 45197 <li>Manu <a href="mailto:manu@snapdragon.cc" class="email">manu@snapdragon.cc</a></li> 45198 <li>Kyle E. Mitchell <a href="mailto:kyle@kemitchell.com" class="email">kyle@kemitchell.com</a></li> 45199 <li>Gary Kim <a href="mailto:gary@garykim.dev" class="email">gary@garykim.dev</a></li> 45200 <li>Jon <a href="mailto:jonathn@github.com" class="email">jonathn@github.com</a></li> 45201 <li>Jeff Quinn <a href="mailto:jeffrey.quinn@bluevoyant.com" class="email">jeffrey.quinn@bluevoyant.com</a></li> 45202 <li>Peter Berbec <a href="mailto:peter@berbec.com" class="email">peter@berbec.com</a></li> 45203 <li>didil <a href="mailto:1284255+didil@users.noreply.github.com" class="email">1284255+didil@users.noreply.github.com</a></li> 45204 <li>id01 <a href="mailto:gaviniboom@gmail.com" class="email">gaviniboom@gmail.com</a></li> 45205 <li>Robert Marko <a href="mailto:robimarko@gmail.com" class="email">robimarko@gmail.com</a></li> 45206 <li>Philip Harvey <a href="mailto:32467456+pharveybattelle@users.noreply.github.com" class="email">32467456+pharveybattelle@users.noreply.github.com</a></li> 45207 <li>JorisE <a href="mailto:JorisE@users.noreply.github.com" class="email">JorisE@users.noreply.github.com</a></li> 45208 <li>garry415 <a href="mailto:garry.415@gmail.com" class="email">garry.415@gmail.com</a></li> 45209 <li>forgems <a href="mailto:forgems@gmail.com" class="email">forgems@gmail.com</a></li> 45210 <li>Florian Apolloner <a href="mailto:florian@apolloner.eu" class="email">florian@apolloner.eu</a></li> 45211 <li>Aleksandar Janković <a href="mailto:office@ajankovic.com" class="email">office@ajankovic.com</a> <a href="mailto:ajankovic@users.noreply.github.com" class="email">ajankovic@users.noreply.github.com</a></li> 45212 <li>Maran <a href="mailto:maran@protonmail.com" class="email">maran@protonmail.com</a></li> 45213 <li>nguyenhuuluan434 <a href="mailto:nguyenhuuluan434@gmail.com" class="email">nguyenhuuluan434@gmail.com</a></li> 45214 <li>Laura Hausmann <a href="mailto:zotan@zotan.pw" class="email">zotan@zotan.pw</a> <a href="mailto:laura@hausmann.dev" class="email">laura@hausmann.dev</a></li> 45215 <li>yparitcher <a href="mailto:y@paritcher.com" class="email">y@paritcher.com</a></li> 45216 <li>AbelThar <a href="mailto:abela.tharen@gmail.com" class="email">abela.tharen@gmail.com</a></li> 45217 <li>Matti Niemenmaa <a href="mailto:matti.niemenmaa+git@iki.fi" class="email">matti.niemenmaa+git@iki.fi</a></li> 45218 <li>Russell Davis <a href="mailto:russelldavis@users.noreply.github.com" class="email">russelldavis@users.noreply.github.com</a></li> 45219 <li>Yi FU <a href="mailto:yi.fu@tink.se" class="email">yi.fu@tink.se</a></li> 45220 <li>Paul Millar <a href="mailto:paul.millar@desy.de" class="email">paul.millar@desy.de</a></li> 45221 <li>justinalin <a href="mailto:justinalin@qnap.com" class="email">justinalin@qnap.com</a></li> 45222 <li>EliEron <a href="mailto:subanimehd@gmail.com" class="email">subanimehd@gmail.com</a></li> 45223 <li>justina777 <a href="mailto:chiahuei.lin@gmail.com" class="email">chiahuei.lin@gmail.com</a></li> 45224 <li>Chaitanya Bankanhal <a href="mailto:bchaitanya15@gmail.com" class="email">bchaitanya15@gmail.com</a></li> 45225 <li>Michał Matczuk <a href="mailto:michal@scylladb.com" class="email">michal@scylladb.com</a></li> 45226 <li>Macavirus <a href="mailto:macavirus@zoho.com" class="email">macavirus@zoho.com</a></li> 45227 <li>Abhinav Sharma <a href="mailto:abhi18av@outlook.com" class="email">abhi18av@outlook.com</a></li> 45228 <li>ginvine <a href="mailto:34869051+ginvine@users.noreply.github.com" class="email">34869051+ginvine@users.noreply.github.com</a></li> 45229 <li>Patrick Wang <a href="mailto:mail6543210@yahoo.com.tw" class="email">mail6543210@yahoo.com.tw</a></li> 45230 <li>Cenk Alti <a href="mailto:cenkalti@gmail.com" class="email">cenkalti@gmail.com</a></li> 45231 <li>Andreas Chlupka <a href="mailto:andy@chlupka.com" class="email">andy@chlupka.com</a></li> 45232 <li>Alfonso Montero <a href="mailto:amontero@tinet.org" class="email">amontero@tinet.org</a></li> 45233 <li>Ivan Andreev <a href="mailto:ivandeex@gmail.com" class="email">ivandeex@gmail.com</a></li> 45234 <li>David Baumgold <a href="mailto:david@davidbaumgold.com" class="email">david@davidbaumgold.com</a></li> 45235 <li>Lars Lehtonen <a href="mailto:lars.lehtonen@gmail.com" class="email">lars.lehtonen@gmail.com</a></li> 45236 <li>Matei David <a href="mailto:matei.david@gmail.com" class="email">matei.david@gmail.com</a></li> 45237 <li>David <a href="mailto:david.bramwell@endemolshine.com" class="email">david.bramwell@endemolshine.com</a></li> 45238 <li>Anthony Rusdi <a href="mailto:33247310+antrusd@users.noreply.github.com" class="email">33247310+antrusd@users.noreply.github.com</a></li> 45239 <li>Richard Patel <a href="mailto:me@terorie.dev" class="email">me@terorie.dev</a></li> 45240 <li>庄天翼 <a href="mailto:zty0826@gmail.com" class="email">zty0826@gmail.com</a></li> 45241 <li>SwitchJS <a href="mailto:dev@switchjs.com" class="email">dev@switchjs.com</a></li> 45242 <li>Raphael <a href="mailto:PowershellNinja@users.noreply.github.com" class="email">PowershellNinja@users.noreply.github.com</a></li> 45243 <li>Sezal Agrawal <a href="mailto:sezalagrawal@gmail.com" class="email">sezalagrawal@gmail.com</a></li> 45244 <li>Tyler <a href="mailto:TylerNakamura@users.noreply.github.com" class="email">TylerNakamura@users.noreply.github.com</a></li> 45245 <li>Brett Dutro <a href="mailto:brett.dutro@gmail.com" class="email">brett.dutro@gmail.com</a></li> 45246 <li>Vighnesh SK <a href="mailto:booterror99@gmail.com" class="email">booterror99@gmail.com</a></li> 45247 <li>Arijit Biswas <a href="mailto:dibbyo456@gmail.com" class="email">dibbyo456@gmail.com</a></li> 45248 <li>Michele Caci <a href="mailto:michele.caci@gmail.com" class="email">michele.caci@gmail.com</a></li> 45249 <li>AlexandrBoltris <a href="mailto:ua2fgb@gmail.com" class="email">ua2fgb@gmail.com</a></li> 45250 <li>Bryce Larson <a href="mailto:blarson@saltstack.com" class="email">blarson@saltstack.com</a></li> 45251 <li>Carlos Ferreyra <a href="mailto:crypticmind@gmail.com" class="email">crypticmind@gmail.com</a></li> 45252 <li>Saksham Khanna <a href="mailto:sakshamkhanna@outlook.com" class="email">sakshamkhanna@outlook.com</a></li> 45253 <li>dausruddin <a href="mailto:5763466+dausruddin@users.noreply.github.com" class="email">5763466+dausruddin@users.noreply.github.com</a></li> 45254 <li>zero-24 <a href="mailto:zero-24@users.noreply.github.com" class="email">zero-24@users.noreply.github.com</a></li> 45255 <li>Xiaoxing Ye <a href="mailto:ye@xiaoxing.us" class="email">ye@xiaoxing.us</a></li> 45256 <li>Barry Muldrey <a href="mailto:barry@muldrey.net" class="email">barry@muldrey.net</a></li> 45257 <li>Sebastian Brandt <a href="mailto:sebastian.brandt@friday.de" class="email">sebastian.brandt@friday.de</a></li> 45258 <li>Marco Molteni <a href="mailto:marco.molteni@mailbox.org" class="email">marco.molteni@mailbox.org</a></li> 45259 <li>Ankur Gupta <a href="mailto:7876747+ankur0493@users.noreply.github.com" class="email">7876747+ankur0493@users.noreply.github.com</a></li> 45260 <li>Maciej Zimnoch <a href="mailto:maciej@scylladb.com" class="email">maciej@scylladb.com</a></li> 45261 <li>anuar45 <a href="mailto:serdaliyev.anuar@gmail.com" class="email">serdaliyev.anuar@gmail.com</a></li> 45262 <li>Fernando <a href="mailto:ferferga@users.noreply.github.com" class="email">ferferga@users.noreply.github.com</a></li> 45263 <li>David Cole <a href="mailto:david.cole@sohonet.com" class="email">david.cole@sohonet.com</a></li> 45264 <li>Wei He <a href="mailto:git@weispot.com" class="email">git@weispot.com</a></li> 45265 <li>Outvi V <a href="mailto:19144373+outloudvi@users.noreply.github.com" class="email">19144373+outloudvi@users.noreply.github.com</a></li> 45266 <li>Thomas Kriechbaumer <a href="mailto:thomas@kriechbaumer.name" class="email">thomas@kriechbaumer.name</a></li> 45267 <li>Tennix <a href="mailto:tennix@users.noreply.github.com" class="email">tennix@users.noreply.github.com</a></li> 45268 <li>Ole Schütt <a href="mailto:ole@schuett.name" class="email">ole@schuett.name</a></li> 45269 <li>Kuang-che Wu <a href="mailto:kcwu@csie.org" class="email">kcwu@csie.org</a></li> 45270 <li>Thomas Eales <a href="mailto:wingsuit@users.noreply.github.com" class="email">wingsuit@users.noreply.github.com</a></li> 45271 <li>Paul Tinsley <a href="mailto:paul.tinsley@vitalsource.com" class="email">paul.tinsley@vitalsource.com</a></li> 45272 <li>Felix Hungenberg <a href="mailto:git@shiftgeist.com" class="email">git@shiftgeist.com</a></li> 45273 <li>Benjamin Richter <a href="mailto:github@dev.telepath.de" class="email">github@dev.telepath.de</a></li> 45274 <li>landall <a href="mailto:cst_zf@qq.com" class="email">cst_zf@qq.com</a></li> 45275 <li>thestigma <a href="mailto:thestigma@gmail.com" class="email">thestigma@gmail.com</a></li> 45276 <li>jtagcat <a href="mailto:38327267+jtagcat@users.noreply.github.com" class="email">38327267+jtagcat@users.noreply.github.com</a></li> 45277 <li>Damon Permezel <a href="mailto:permezel@me.com" class="email">permezel@me.com</a></li> 45278 <li>boosh <a href="mailto:boosh@users.noreply.github.com" class="email">boosh@users.noreply.github.com</a></li> 45279 <li>unbelauscht <a href="mailto:58393353+unbelauscht@users.noreply.github.com" class="email">58393353+unbelauscht@users.noreply.github.com</a></li> 45280 <li>Motonori IWAMURO <a href="mailto:vmi@nifty.com" class="email">vmi@nifty.com</a></li> 45281 <li>Benjapol Worakan <a href="mailto:benwrk@live.com" class="email">benwrk@live.com</a></li> 45282 <li>Dave Koston <a href="mailto:dave.koston@stackpath.com" class="email">dave.koston@stackpath.com</a></li> 45283 <li>Durval Menezes <a href="mailto:DurvalMenezes@users.noreply.github.com" class="email">DurvalMenezes@users.noreply.github.com</a></li> 45284 <li>Tim Gallant <a href="mailto:me@timgallant.us" class="email">me@timgallant.us</a></li> 45285 <li>Frederick Zhang <a href="mailto:frederick888@tsundere.moe" class="email">frederick888@tsundere.moe</a></li> 45286 <li>valery1707 <a href="mailto:valery1707@gmail.com" class="email">valery1707@gmail.com</a></li> 45287 <li>Yves G <a href="mailto:theYinYeti@yalis.fr" class="email">theYinYeti@yalis.fr</a></li> 45288 <li>Shing Kit Chan <a href="mailto:chanshingkit@gmail.com" class="email">chanshingkit@gmail.com</a></li> 45289 <li>Franklyn Tackitt <a href="mailto:franklyn@tackitt.net" class="email">franklyn@tackitt.net</a></li> 45290 <li>Robert-André Mauchin <a href="mailto:zebob.m@gmail.com" class="email">zebob.m@gmail.com</a></li> 45291 <li>evileye <a href="mailto:48332831+ibiruai@users.noreply.github.com" class="email">48332831+ibiruai@users.noreply.github.com</a></li> 45292 <li>Joachim Brandon LeBlanc <a href="mailto:brandon@leblanc.codes" class="email">brandon@leblanc.codes</a></li> 45293 <li>Patryk Jakuszew <a href="mailto:patryk.jakuszew@gmail.com" class="email">patryk.jakuszew@gmail.com</a></li> 45294 <li>fishbullet <a href="mailto:shindu666@gmail.com" class="email">shindu666@gmail.com</a></li> 45295 <li>greatroar <@></li> 45296 <li>Bernd Schoolmann <a href="mailto:mail@quexten.com" class="email">mail@quexten.com</a></li> 45297 <li>Elan Ruusamäe <a href="mailto:glen@pld-linux.org" class="email">glen@pld-linux.org</a></li> 45298 <li>Max Sum <a href="mailto:max@lolyculture.com" class="email">max@lolyculture.com</a></li> 45299 <li>Mark Spieth <a href="mailto:mspieth@users.noreply.github.com" class="email">mspieth@users.noreply.github.com</a></li> 45300 <li>harry <a href="mailto:me@harry.plus" class="email">me@harry.plus</a></li> 45301 <li>Samantha McVey <a href="mailto:samantham@posteo.net" class="email">samantham@posteo.net</a></li> 45302 <li>Jack Anderson <a href="mailto:jack.anderson@metaswitch.com" class="email">jack.anderson@metaswitch.com</a></li> 45303 <li>Michael G <a href="mailto:draget@speciesm.net" class="email">draget@speciesm.net</a></li> 45304 <li>Brandon Philips <a href="mailto:brandon@ifup.org" class="email">brandon@ifup.org</a></li> 45305 <li>Daven <a href="mailto:dooven@users.noreply.github.com" class="email">dooven@users.noreply.github.com</a></li> 45306 <li>Martin Stone <a href="mailto:martin@d7415.co.uk" class="email">martin@d7415.co.uk</a></li> 45307 <li>David Bramwell <a href="mailto:13053834+dbramwell@users.noreply.github.com" class="email">13053834+dbramwell@users.noreply.github.com</a></li> 45308 <li>Sunil Patra <a href="mailto:snl_su@live.com" class="email">snl_su@live.com</a></li> 45309 <li>Adam Stroud <a href="mailto:adam.stroud@gmail.com" class="email">adam.stroud@gmail.com</a></li> 45310 <li>Kush <a href="mailto:kushsharma@users.noreply.github.com" class="email">kushsharma@users.noreply.github.com</a></li> 45311 <li>Matan Rosenberg <a href="mailto:matan129@gmail.com" class="email">matan129@gmail.com</a></li> 45312 <li>gitch1 <a href="mailto:63495046+gitch1@users.noreply.github.com" class="email">63495046+gitch1@users.noreply.github.com</a></li> 45313 <li>ElonH <a href="mailto:elonhhuang@gmail.com" class="email">elonhhuang@gmail.com</a></li> 45314 <li>Fred <a href="mailto:fred@creativeprojects.tech" class="email">fred@creativeprojects.tech</a></li> 45315 <li>Sébastien Gross <a href="mailto:renard@users.noreply.github.com" class="email">renard@users.noreply.github.com</a></li> 45316 <li>Maxime Suret <a href="mailto:11944422+msuret@users.noreply.github.com" class="email">11944422+msuret@users.noreply.github.com</a></li> 45317 <li>Caleb Case <a href="mailto:caleb@storj.io" class="email">caleb@storj.io</a> <a href="mailto:calebcase@gmail.com" class="email">calebcase@gmail.com</a></li> 45318 <li>Ben Zenker <a href="mailto:imbenzenker@gmail.com" class="email">imbenzenker@gmail.com</a></li> 45319 <li>Martin Michlmayr <a href="mailto:tbm@cyrius.com" class="email">tbm@cyrius.com</a></li> 45320 <li>Brandon McNama <a href="mailto:bmcnama@pagerduty.com" class="email">bmcnama@pagerduty.com</a></li> 45321 <li>Daniel Slyman <a href="mailto:github@skylayer.eu" class="email">github@skylayer.eu</a></li> 45322 <li>Alex Guerrero <a href="mailto:guerrero@users.noreply.github.com" class="email">guerrero@users.noreply.github.com</a></li> 45323 <li>Matteo Pietro Dazzi <a href="mailto:matteopietro.dazzi@gft.com" class="email">matteopietro.dazzi@gft.com</a></li> 45324 <li>edwardxml <a href="mailto:56691903+edwardxml@users.noreply.github.com" class="email">56691903+edwardxml@users.noreply.github.com</a></li> 45325 <li>Roman Kredentser <a href="mailto:shareed2k@gmail.com" class="email">shareed2k@gmail.com</a></li> 45326 <li>Kamil Trzciński <a href="mailto:ayufan@ayufan.eu" class="email">ayufan@ayufan.eu</a></li> 45327 <li>Zac Rubin <a href="mailto:z-0@users.noreply.github.com" class="email">z-0@users.noreply.github.com</a></li> 45328 <li>Vincent Feltz <a href="mailto:psycho@feltzv.fr" class="email">psycho@feltzv.fr</a></li> 45329 <li>Heiko Bornholdt <a href="mailto:bornholdt@informatik.uni-hamburg.de" class="email">bornholdt@informatik.uni-hamburg.de</a></li> 45330 <li>Matteo Pietro Dazzi <a href="mailto:matteopietro.dazzi@gmail.com" class="email">matteopietro.dazzi@gmail.com</a></li> 45331 <li>jtagcat <a href="mailto:gitlab@c7.ee" class="email">gitlab@c7.ee</a></li> 45332 <li>Petri Salminen <a href="mailto:petri@salminen.dev" class="email">petri@salminen.dev</a></li> 45333 <li>Tim Burke <a href="mailto:tim.burke@gmail.com" class="email">tim.burke@gmail.com</a></li> 45334 <li>Kai Lüke <a href="mailto:kai@kinvolk.io" class="email">kai@kinvolk.io</a></li> 45335 <li>Garrett Squire <a href="mailto:github@garrettsquire.com" class="email">github@garrettsquire.com</a></li> 45336 <li>Evan Harris <a href="mailto:eharris@puremagic.com" class="email">eharris@puremagic.com</a></li> 45337 <li>Kevin <a href="mailto:keyam@microsoft.com" class="email">keyam@microsoft.com</a></li> 45338 <li>Morten Linderud <a href="mailto:morten@linderud.pw" class="email">morten@linderud.pw</a></li> 45339 <li>Dmitry Ustalov <a href="mailto:dmitry.ustalov@gmail.com" class="email">dmitry.ustalov@gmail.com</a></li> 45340 <li>Jack <a href="mailto:196648+jdeng@users.noreply.github.com" class="email">196648+jdeng@users.noreply.github.com</a></li> 45341 <li>kcris <a href="mailto:cristian.tarsoaga@gmail.com" class="email">cristian.tarsoaga@gmail.com</a></li> 45342 <li>tyhuber1 <a href="mailto:68970760+tyhuber1@users.noreply.github.com" class="email">68970760+tyhuber1@users.noreply.github.com</a></li> 45343 <li>David Ibarra <a href="mailto:david.ibarra@realty.com" class="email">david.ibarra@realty.com</a></li> 45344 <li>Tim Gallant <a href="mailto:tim@lilt.com" class="email">tim@lilt.com</a></li> 45345 <li>Kaloyan Raev <a href="mailto:kaloyan@storj.io" class="email">kaloyan@storj.io</a></li> 45346 <li>Jay McEntire <a href="mailto:jay.mcentire@gmail.com" class="email">jay.mcentire@gmail.com</a></li> 45347 <li>Leo Luan <a href="mailto:leoluan@us.ibm.com" class="email">leoluan@us.ibm.com</a></li> 45348 <li>aus <a href="mailto:549081+aus@users.noreply.github.com" class="email">549081+aus@users.noreply.github.com</a></li> 45349 <li>Aaron Gokaslan <a href="mailto:agokaslan@fb.com" class="email">agokaslan@fb.com</a></li> 45350 <li>Egor Margineanu <a href="mailto:egmar@users.noreply.github.com" class="email">egmar@users.noreply.github.com</a></li> 45351 <li>Lucas Kanashiro <a href="mailto:lucas.kanashiro@canonical.com" class="email">lucas.kanashiro@canonical.com</a></li> 45352 <li>WarpedPixel <a href="mailto:WarpedPixel@users.noreply.github.com" class="email">WarpedPixel@users.noreply.github.com</a></li> 45353 <li>Sam Edwards <a href="mailto:sam@samedwards.ca" class="email">sam@samedwards.ca</a></li> 45354 <li>wjielai <a href="mailto:gouki0123@gmail.com" class="email">gouki0123@gmail.com</a></li> 45355 <li>Muffin King <a href="mailto:jinxz_k@live.com" class="email">jinxz_k@live.com</a></li> 45356 <li>Christopher Stewart <a href="mailto:6573710+1f47a@users.noreply.github.com" class="email">6573710+1f47a@users.noreply.github.com</a></li> 45357 <li>Russell Cattelan <a href="mailto:cattelan@digitalelves.com" class="email">cattelan@digitalelves.com</a></li> 45358 <li>gyutw <a href="mailto:30371241+gyutw@users.noreply.github.com" class="email">30371241+gyutw@users.noreply.github.com</a></li> 45359 <li>Hekmon <a href="mailto:edouardhur@gmail.com" class="email">edouardhur@gmail.com</a></li> 45360 <li>LaSombra <a href="mailto:lasombra@users.noreply.github.com" class="email">lasombra@users.noreply.github.com</a></li> 45361 <li>Dov Murik <a href="mailto:dov.murik@gmail.com" class="email">dov.murik@gmail.com</a></li> 45362 <li>Ameer Dawood <a href="mailto:ameer1234567890@gmail.com" class="email">ameer1234567890@gmail.com</a></li> 45363 <li>Dan Hipschman <a href="mailto:dan.hipschman@opendoor.com" class="email">dan.hipschman@opendoor.com</a></li> 45364 <li>Josh Soref <a href="mailto:jsoref@users.noreply.github.com" class="email">jsoref@users.noreply.github.com</a></li> 45365 <li>David <a href="mailto:david@staron.nl" class="email">david@staron.nl</a></li> 45366 <li>Ingo <a href="mailto:ingo@hoffmann.cx" class="email">ingo@hoffmann.cx</a></li> 45367 <li>Adam Plánský <a href="mailto:adamplansky@users.noreply.github.com" class="email">adamplansky@users.noreply.github.com</a> <a href="mailto:adamplansky@gmail.com" class="email">adamplansky@gmail.com</a></li> 45368 <li>Manish Gupta <a href="mailto:manishgupta.ait@gmail.com" class="email">manishgupta.ait@gmail.com</a></li> 45369 <li>Deepak Sah <a href="mailto:sah.sslpu@gmail.com" class="email">sah.sslpu@gmail.com</a></li> 45370 <li>Marcin Zelent <a href="mailto:marcin@zelent.net" class="email">marcin@zelent.net</a></li> 45371 <li>zhucan <a href="mailto:zhucan.k8s@gmail.com" class="email">zhucan.k8s@gmail.com</a></li> 45372 <li>James Lim <a href="mailto:james.lim@samsara.com" class="email">james.lim@samsara.com</a></li> 45373 <li>Laurens Janssen <a href="mailto:BD69BM@insim.biz" class="email">BD69BM@insim.biz</a></li> 45374 <li>Bob Bagwill <a href="mailto:bobbagwill@gmail.com" class="email">bobbagwill@gmail.com</a></li> 45375 <li>Nathan Collins <a href="mailto:colli372@msu.edu" class="email">colli372@msu.edu</a></li> 45376 <li>lostheli</li> 45377 <li>kelv <a href="mailto:kelvin@acks.org" class="email">kelvin@acks.org</a></li> 45378 <li>Milly <a href="mailto:milly.ca@gmail.com" class="email">milly.ca@gmail.com</a></li> 45379 <li>gtorelly <a href="mailto:gtorelly@gmail.com" class="email">gtorelly@gmail.com</a></li> 45380 <li>Brad Ackerman <a href="mailto:brad@facefault.org" class="email">brad@facefault.org</a></li> 45381 <li>Mitsuo Heijo <a href="mailto:mitsuo.heijo@gmail.com" class="email">mitsuo.heijo@gmail.com</a></li> 45382 <li>Claudio Bantaloukas <a href="mailto:rockdreamer@gmail.com" class="email">rockdreamer@gmail.com</a></li> 45383 <li>Benjamin Gustin <a href="mailto:gustin.ben@gmail.com" class="email">gustin.ben@gmail.com</a></li> 45384 <li>Ingo Weiss <a href="mailto:ingo@redhat.com" class="email">ingo@redhat.com</a></li> 45385 <li>Kerry Su <a href="mailto:me@sshockwave.net" class="email">me@sshockwave.net</a></li> 45386 <li>Ilyess Bachiri <a href="mailto:ilyess.bachiri@sonder.com" class="email">ilyess.bachiri@sonder.com</a></li> 45387 <li>Yury Stankevich <a href="mailto:urykhy@gmail.com" class="email">urykhy@gmail.com</a></li> 45388 <li>kice <a href="mailto:wslikerqs@gmail.com" class="email">wslikerqs@gmail.com</a></li> 45389 <li>Denis Neuling <a href="mailto:denisneuling@gmail.com" class="email">denisneuling@gmail.com</a></li> 45390 <li>Janne Johansson <a href="mailto:icepic.dz@gmail.com" class="email">icepic.dz@gmail.com</a></li> 45391 <li>Patrik Nordlén <a href="mailto:patriki@gmail.com" class="email">patriki@gmail.com</a></li> 45392 <li>CokeMine <a href="mailto:aptx4561@gmail.com" class="email">aptx4561@gmail.com</a></li> 45393 <li>Sơn Trần-Nguyễn <a href="mailto:github@sntran.com" class="email">github@sntran.com</a></li> 45394 <li>lluuaapp <a href="mailto:266615+lluuaapp@users.noreply.github.com" class="email">266615+lluuaapp@users.noreply.github.com</a></li> 45395 <li>Zach Kipp <a href="mailto:kipp.zach@gmail.com" class="email">kipp.zach@gmail.com</a></li> 45396 <li>Riccardo Iaconelli <a href="mailto:riccardo@kde.org" class="email">riccardo@kde.org</a></li> 45397 <li>Sakuragawa Misty <a href="mailto:gyc990326@gmail.com" class="email">gyc990326@gmail.com</a></li> 45398 <li>Nicolas Rueff <a href="mailto:nicolas@rueff.fr" class="email">nicolas@rueff.fr</a></li> 45399 <li>Pau Rodriguez-Estivill <a href="mailto:prodrigestivill@gmail.com" class="email">prodrigestivill@gmail.com</a></li> 45400 <li>Bob Pusateri <a href="mailto:BobPusateri@users.noreply.github.com" class="email">BobPusateri@users.noreply.github.com</a></li> 45401 <li>Alex JOST <a href="mailto:25005220+dimejo@users.noreply.github.com" class="email">25005220+dimejo@users.noreply.github.com</a></li> 45402 <li>Alexey Tabakman <a href="mailto:samosad.ru@gmail.com" class="email">samosad.ru@gmail.com</a></li> 45403 <li>David Sze <a href="mailto:sze.david@gmail.com" class="email">sze.david@gmail.com</a></li> 45404 <li>cynthia kwok <a href="mailto:cynthia.m.kwok@gmail.com" class="email">cynthia.m.kwok@gmail.com</a></li> 45405 <li>Miron Veryanskiy <a href="mailto:MironVeryanskiy@gmail.com" class="email">MironVeryanskiy@gmail.com</a></li> 45406 <li>K265 <a href="mailto:k.265@qq.com" class="email">k.265@qq.com</a></li> 45407 <li>Vesnyx <a href="mailto:Vesnyx@users.noreply.github.com" class="email">Vesnyx@users.noreply.github.com</a></li> 45408 <li>Dmitry Chepurovskiy <a href="mailto:me@dm3ch.net" class="email">me@dm3ch.net</a></li> 45409 <li>Rauno Ots <a href="mailto:rauno.ots@cgi.com" class="email">rauno.ots@cgi.com</a></li> 45410 <li>Georg Neugschwandtner <a href="mailto:georg.neugschwandtner@gmx.net" class="email">georg.neugschwandtner@gmx.net</a></li> 45411 <li>pvalls <a href="mailto:polvallsrue@gmail.com" class="email">polvallsrue@gmail.com</a></li> 45412 <li>Robert Thomas <a href="mailto:31854736+wolveix@users.noreply.github.com" class="email">31854736+wolveix@users.noreply.github.com</a></li> 45413 <li>Romeo Kienzler <a href="mailto:romeo.kienzler@gmail.com" class="email">romeo.kienzler@gmail.com</a></li> 45414 <li>tYYGH <a href="mailto:tYYGH@users.noreply.github.com" class="email">tYYGH@users.noreply.github.com</a></li> 45415 <li>georne <a href="mailto:77802995+georne@users.noreply.github.com" class="email">77802995+georne@users.noreply.github.com</a></li> 45416 <li>Maxwell Calman <a href="mailto:mcalman@MacBook-Pro.local" class="email">mcalman@MacBook-Pro.local</a></li> 45417 <li>Naveen Honest Raj <a href="mailto:naveendurai19@gmail.com" class="email">naveendurai19@gmail.com</a></li> 45418 <li>Lucas Messenger <a href="mailto:lmesseng@cisco.com" class="email">lmesseng@cisco.com</a></li> 45419 <li>Manish Kumar <a href="mailto:krmanish260@gmail.com" class="email">krmanish260@gmail.com</a></li> 45420 <li>x0b <a href="mailto:x0bdev@gmail.com" class="email">x0bdev@gmail.com</a></li> 45421 <li>CERN through the CS3MESH4EOSC Project</li> 45422 <li>Nick Gaya <a href="mailto:nicholasgaya+github@gmail.com" class="email">nicholasgaya+github@gmail.com</a></li> 45423 <li>Ashok Gelal <a href="mailto:401055+ashokgelal@users.noreply.github.com" class="email">401055+ashokgelal@users.noreply.github.com</a></li> 45424 <li>Dominik Mydlil <a href="mailto:dominik.mydlil@outlook.com" class="email">dominik.mydlil@outlook.com</a></li> 45425 <li>Nazar Mishturak <a href="mailto:nazarmx@gmail.com" class="email">nazarmx@gmail.com</a></li> 45426 <li>Ansh Mittal <a href="mailto:iamAnshMittal@gmail.com" class="email">iamAnshMittal@gmail.com</a></li> 45427 <li>noabody <a href="mailto:noabody@yahoo.com" class="email">noabody@yahoo.com</a></li> 45428 <li>OleFrost <a href="mailto:82263101+olefrost@users.noreply.github.com" class="email">82263101+olefrost@users.noreply.github.com</a></li> 45429 <li>Kenny Parsons <a href="mailto:kennyparsons93@gmail.com" class="email">kennyparsons93@gmail.com</a></li> 45430 <li>Jeffrey Tolar <a href="mailto:tolar.jeffrey@gmail.com" class="email">tolar.jeffrey@gmail.com</a></li> 45431 <li>jtagcat <a href="mailto:git-514635f7@jtag.cat" class="email">git-514635f7@jtag.cat</a></li> 45432 <li>Tatsuya Noyori <a href="mailto:63089076+public-tatsuya-noyori@users.noreply.github.com" class="email">63089076+public-tatsuya-noyori@users.noreply.github.com</a></li> 45433 <li>lewisxy <a href="mailto:lewisxy@users.noreply.github.com" class="email">lewisxy@users.noreply.github.com</a></li> 45434 <li>Nolan Woods <a href="mailto:nolan_w@sfu.ca" class="email">nolan_w@sfu.ca</a></li> 45435 <li>Gautam Kumar <a href="mailto:25435568+gautamajay52@users.noreply.github.com" class="email">25435568+gautamajay52@users.noreply.github.com</a></li> 45436 <li>Chris Macklin <a href="mailto:chris.macklin@10xgenomics.com" class="email">chris.macklin@10xgenomics.com</a></li> 45437 <li>Antoon Prins <a href="mailto:antoon.prins@surfsara.nl" class="email">antoon.prins@surfsara.nl</a></li> 45438 <li>Alexey Ivanov <a href="mailto:rbtz@dropbox.com" class="email">rbtz@dropbox.com</a></li> 45439 <li>Serge Pouliquen <a href="mailto:sp31415@free.fr" class="email">sp31415@free.fr</a></li> 45440 <li>acsfer <a href="mailto:carlos@reendex.com" class="email">carlos@reendex.com</a></li> 45441 <li>Tom <a href="mailto:tom@tom-fitzhenry.me.uk" class="email">tom@tom-fitzhenry.me.uk</a></li> 45442 <li>Tyson Moore <a href="mailto:tyson@tyson.me" class="email">tyson@tyson.me</a></li> 45443 <li>database64128 <a href="mailto:free122448@hotmail.com" class="email">free122448@hotmail.com</a></li> 45444 <li>Chris Lu <a href="mailto:chrislusf@users.noreply.github.com" class="email">chrislusf@users.noreply.github.com</a></li> 45445 <li>Reid Buzby <a href="mailto:reid@rethink.software" class="email">reid@rethink.software</a></li> 45446 <li>darrenrhs <a href="mailto:darrenrhs@gmail.com" class="email">darrenrhs@gmail.com</a></li> 45447 <li>Florian Penzkofer <a href="mailto:fp@nullptr.de" class="email">fp@nullptr.de</a></li> 45448 <li>Xuanchen Wu <a href="mailto:117010292@link.cuhk.edu.cn" class="email">117010292@link.cuhk.edu.cn</a></li> 45449 <li>partev <a href="mailto:petrosyan@gmail.com" class="email">petrosyan@gmail.com</a></li> 45450 <li>Dmitry Sitnikov <a href="mailto:fo2@inbox.ru" class="email">fo2@inbox.ru</a></li> 45451 <li>Haochen Tong <a href="mailto:i@hexchain.org" class="email">i@hexchain.org</a></li> 45452 <li>Michael Hanselmann <a href="mailto:public@hansmi.ch" class="email">public@hansmi.ch</a></li> 45453 <li>Chuan Zh <a href="mailto:zhchuan7@gmail.com" class="email">zhchuan7@gmail.com</a></li> 45454 <li>Antoine GIRARD <a href="mailto:antoine.girard@sapk.fr" class="email">antoine.girard@sapk.fr</a></li> 45455 <li>Justin Winokur (Jwink3101) <a href="mailto:Jwink3101@users.noreply.github.com" class="email">Jwink3101@users.noreply.github.com</a></li> 45456 <li>Mariano Absatz (git) <a href="mailto:scm@baby.com.ar" class="email">scm@baby.com.ar</a></li> 45457 <li>Greg Sadetsky <a href="mailto:lepetitg@gmail.com" class="email">lepetitg@gmail.com</a></li> 45458 <li>yedamo <a href="mailto:logindaveye@gmail.com" class="email">logindaveye@gmail.com</a></li> 45459 <li>hota <a href="mailto:lindwurm.q@gmail.com" class="email">lindwurm.q@gmail.com</a></li> 45460 <li>vinibali <a href="mailto:vinibali1@gmail.com" class="email">vinibali1@gmail.com</a></li> 45461 <li>Ken Enrique Morel <a href="mailto:ken.morel.santana@gmail.com" class="email">ken.morel.santana@gmail.com</a></li> 45462 <li>Justin Hellings <a href="mailto:justin.hellings@gmail.com" class="email">justin.hellings@gmail.com</a></li> 45463 <li>Parth Shukla <a href="mailto:pparth@pparth.net" class="email">pparth@pparth.net</a></li> 45464 <li>wzl <a href="mailto:wangzl31@outlook.com" class="email">wangzl31@outlook.com</a></li> 45465 <li>HNGamingUK <a href="mailto:connor@earnshawhome.co.uk" class="email">connor@earnshawhome.co.uk</a></li> 45466 <li>Jonta <a href="mailto:359397+Jonta@users.noreply.github.com" class="email">359397+Jonta@users.noreply.github.com</a></li> 45467 <li>YenForYang <a href="mailto:YenForYang@users.noreply.github.com" class="email">YenForYang@users.noreply.github.com</a></li> 45468 <li>SimJoSt / Joda Stößer <a href="mailto:git@simjo.st" class="email">git@simjo.st</a></li> 45469 <li>Logeshwaran <a href="mailto:waranlogesh@gmail.com" class="email">waranlogesh@gmail.com</a></li> 45470 <li>Rajat Goel <a href="mailto:rajat@dropbox.com" class="email">rajat@dropbox.com</a></li> 45471 <li>r0kk3rz <a href="mailto:r0kk3rz@gmail.com" class="email">r0kk3rz@gmail.com</a></li> 45472 <li>Matthew Sevey <a href="mailto:mjsevey@gmail.com" class="email">mjsevey@gmail.com</a></li> 45473 <li>Filip Rysavy <a href="mailto:fil@siasky.net" class="email">fil@siasky.net</a></li> 45474 <li>Ian Levesque <a href="mailto:ian@ianlevesque.org" class="email">ian@ianlevesque.org</a></li> 45475 <li>Thomas Stachl <a href="mailto:thomas@stachl.me" class="email">thomas@stachl.me</a></li> 45476 <li>Dmitry Bogatov <a href="mailto:git#v1@kaction.cc" class="email">git#v1@kaction.cc</a></li> 45477 <li>thomae <a href="mailto:4493560+thomae@users.noreply.github.com" class="email">4493560+thomae@users.noreply.github.com</a></li> 45478 <li>trevyn <a href="mailto:trevyn-git@protonmail.com" class="email">trevyn-git@protonmail.com</a></li> 45479 <li>David Liu <a href="mailto:david.yx.liu@oracle.com" class="email">david.yx.liu@oracle.com</a></li> 45480 <li>Chris Nelson <a href="mailto:stuff@cjnaz.com" class="email">stuff@cjnaz.com</a></li> 45481 <li>Felix Bünemann <a href="mailto:felix.buenemann@gmail.com" class="email">felix.buenemann@gmail.com</a></li> 45482 <li>Atílio Antônio <a href="mailto:atiliodadalto@hotmail.com" class="email">atiliodadalto@hotmail.com</a></li> 45483 <li>Carlo Mion <a href="mailto:mion00@gmail.com" class="email">mion00@gmail.com</a></li> 45484 <li>Chris Lu <a href="mailto:chris.lu@gmail.com" class="email">chris.lu@gmail.com</a></li> 45485 <li>Vitor Arruda <a href="mailto:vitor.pimenta.arruda@gmail.com" class="email">vitor.pimenta.arruda@gmail.com</a></li> 45486 <li>bbabich <a href="mailto:bbabich@datamossa.com" class="email">bbabich@datamossa.com</a></li> 45487 <li>David <a href="mailto:dp.davide.palma@gmail.com" class="email">dp.davide.palma@gmail.com</a></li> 45488 <li>Borna Butkovic <a href="mailto:borna@favicode.net" class="email">borna@favicode.net</a></li> 45489 <li>Fredric Arklid <a href="mailto:fredric.arklid@consid.se" class="email">fredric.arklid@consid.se</a></li> 45490 <li>Andy Jackson <a href="mailto:Andrew.Jackson@bl.uk" class="email">Andrew.Jackson@bl.uk</a></li> 45491 <li>Sinan Tan <a href="mailto:i@tinytangent.com" class="email">i@tinytangent.com</a></li> 45492 <li>deinferno <a href="mailto:14363193+deinferno@users.noreply.github.com" class="email">14363193+deinferno@users.noreply.github.com</a></li> 45493 <li>rsapkf <a href="mailto:rsapkfff@pm.me" class="email">rsapkfff@pm.me</a></li> 45494 <li>Will Holtz <a href="mailto:wholtz@gmail.com" class="email">wholtz@gmail.com</a></li> 45495 <li>GGG KILLER <a href="mailto:gggkiller2@gmail.com" class="email">gggkiller2@gmail.com</a></li> 45496 <li>Logeshwaran Murugesan <a href="mailto:logeshwaran@testpress.in" class="email">logeshwaran@testpress.in</a></li> 45497 <li>Lu Wang <a href="mailto:coolwanglu@gmail.com" class="email">coolwanglu@gmail.com</a></li> 45498 <li>Bumsu Hyeon <a href="mailto:ksitht@gmail.com" class="email">ksitht@gmail.com</a></li> 45499 <li>Shmz Ozggrn <a href="mailto:98463324+ShmzOzggrn@users.noreply.github.com" class="email">98463324+ShmzOzggrn@users.noreply.github.com</a></li> 45500 <li>Kim <a href="mailto:kim@jotta.no" class="email">kim@jotta.no</a></li> 45501 <li>Niels van de Weem <a href="mailto:n.van.de.weem@smile.nl" class="email">n.van.de.weem@smile.nl</a></li> 45502 <li>Koopa <a href="mailto:codingkoopa@gmail.com" class="email">codingkoopa@gmail.com</a></li> 45503 <li>Yunhai Luo <a href="mailto:yunhai-luo@hotmail.com" class="email">yunhai-luo@hotmail.com</a></li> 45504 <li>Charlie Jiang <a href="mailto:w@chariri.moe" class="email">w@chariri.moe</a></li> 45505 <li>Alain Nussbaumer <a href="mailto:alain.nussbaumer@alleluia.ch" class="email">alain.nussbaumer@alleluia.ch</a></li> 45506 <li>Vanessasaurus <a href="mailto:814322+vsoch@users.noreply.github.com" class="email">814322+vsoch@users.noreply.github.com</a></li> 45507 <li>Isaac Levy <a href="mailto:isaac.r.levy@gmail.com" class="email">isaac.r.levy@gmail.com</a></li> 45508 <li>Gourav T <a href="mailto:workflowautomation@protonmail.com" class="email">workflowautomation@protonmail.com</a></li> 45509 <li>Paulo Martins <a href="mailto:paulo.pontes.m@gmail.com" class="email">paulo.pontes.m@gmail.com</a></li> 45510 <li>viveknathani <a href="mailto:viveknathani2402@gmail.com" class="email">viveknathani2402@gmail.com</a></li> 45511 <li>Eng Zer Jun <a href="mailto:engzerjun@gmail.com" class="email">engzerjun@gmail.com</a></li> 45512 <li>Abhiraj <a href="mailto:abhiraj.official15@gmail.com" class="email">abhiraj.official15@gmail.com</a></li> 45513 <li>Márton Elek <a href="mailto:elek@apache.org" class="email">elek@apache.org</a> <a href="mailto:elek@users.noreply.github.com" class="email">elek@users.noreply.github.com</a></li> 45514 <li>Vincent Murphy <a href="mailto:vdm@vdm.ie" class="email">vdm@vdm.ie</a></li> 45515 <li>ctrl-q <a href="mailto:34975747+ctrl-q@users.noreply.github.com" class="email">34975747+ctrl-q@users.noreply.github.com</a></li> 45516 <li>Nil Alexandrov <a href="mailto:nalexand@akamai.com" class="email">nalexand@akamai.com</a></li> 45517 <li>GuoXingbin <a href="mailto:101376330+guoxingbin@users.noreply.github.com" class="email">101376330+guoxingbin@users.noreply.github.com</a></li> 45518 <li>Berkan Teber <a href="mailto:berkan@berkanteber.com" class="email">berkan@berkanteber.com</a></li> 45519 <li>Tobias Klauser <a href="mailto:tklauser@distanz.ch" class="email">tklauser@distanz.ch</a></li> 45520 <li>KARBOWSKI Piotr <a href="mailto:piotr.karbowski@gmail.com" class="email">piotr.karbowski@gmail.com</a></li> 45521 <li>GH <a href="mailto:geeklihui@foxmail.com" class="email">geeklihui@foxmail.com</a></li> 45522 <li>rafma0 <a href="mailto:int.main@gmail.com" class="email">int.main@gmail.com</a></li> 45523 <li>Adrien Rey-Jarthon <a href="mailto:jobs@adrienjarthon.com" class="email">jobs@adrienjarthon.com</a></li> 45524 <li>Nick Gooding <a href="mailto:73336146+nickgooding@users.noreply.github.com" class="email">73336146+nickgooding@users.noreply.github.com</a></li> 45525 <li>Leroy van Logchem <a href="mailto:lr.vanlogchem@gmail.com" class="email">lr.vanlogchem@gmail.com</a></li> 45526 <li>Zsolt Ero <a href="mailto:zsolt.ero@gmail.com" class="email">zsolt.ero@gmail.com</a></li> 45527 <li>Lesmiscore <a href="mailto:nao20010128@gmail.com" class="email">nao20010128@gmail.com</a></li> 45528 <li>ehsantdy <a href="mailto:ehsan.tadayon@arvancloud.com" class="email">ehsan.tadayon@arvancloud.com</a> <a href="mailto:ehsantadayon85@gmail.com" class="email">ehsantadayon85@gmail.com</a></li> 45529 <li>SwazRGB <a href="mailto:65694696+swazrgb@users.noreply.github.com" class="email">65694696+swazrgb@users.noreply.github.com</a></li> 45530 <li>Mateusz Puczyński <a href="mailto:mati6095@gmail.com" class="email">mati6095@gmail.com</a></li> 45531 <li>Michael C Tiernan - MIT-Research Computing Project <a href="mailto:mtiernan@mit.edu" class="email">mtiernan@mit.edu</a></li> 45532 <li>Kaspian <a href="mailto:34658474+KaspianDev@users.noreply.github.com" class="email">34658474+KaspianDev@users.noreply.github.com</a></li> 45533 <li>Werner <a href="mailto:EvilOlaf@users.noreply.github.com" class="email">EvilOlaf@users.noreply.github.com</a></li> 45534 <li>Hugal31 <a href="mailto:hugo.laloge@gmail.com" class="email">hugo.laloge@gmail.com</a></li> 45535 <li>Christian Galo <a href="mailto:36752715+cgalo5758@users.noreply.github.com" class="email">36752715+cgalo5758@users.noreply.github.com</a></li> 45536 <li>Erik van Velzen <a href="mailto:erik@evanv.nl" class="email">erik@evanv.nl</a></li> 45537 <li>Derek Battams <a href="mailto:derek@battams.ca" class="email">derek@battams.ca</a></li> 45538 <li>Paul <a href="mailto:devnoname120@gmail.com" class="email">devnoname120@gmail.com</a></li> 45539 <li>SimonLiu <a href="mailto:simonliu009@users.noreply.github.com" class="email">simonliu009@users.noreply.github.com</a></li> 45540 <li>Hugo Laloge <a href="mailto:hla@lescompanions.com" class="email">hla@lescompanions.com</a></li> 45541 <li>Mr-Kanister <a href="mailto:68117355+Mr-Kanister@users.noreply.github.com" class="email">68117355+Mr-Kanister@users.noreply.github.com</a></li> 45542 <li>Rob Pickerill <a href="mailto:r.pickerill@gmail.com" class="email">r.pickerill@gmail.com</a></li> 45543 <li>Andrey <a href="mailto:to.merge@gmail.com" class="email">to.merge@gmail.com</a></li> 45544 <li>Eric Wolf <a href="mailto:19wolf@gmail.com" class="email">19wolf@gmail.com</a></li> 45545 <li>Nick <a href="mailto:nick.naumann@mailbox.tu-dresden.de" class="email">nick.naumann@mailbox.tu-dresden.de</a></li> 45546 <li>Jason Zheng <a href="mailto:jszheng17@gmail.com" class="email">jszheng17@gmail.com</a></li> 45547 <li>Matthew Vernon <a href="mailto:mvernon@wikimedia.org" class="email">mvernon@wikimedia.org</a></li> 45548 <li>Noah Hsu <a href="mailto:i@nn.ci" class="email">i@nn.ci</a></li> 45549 <li>m00594701 <a href="mailto:mengpengbo@huawei.com" class="email">mengpengbo@huawei.com</a></li> 45550 <li>Art M. Gallagher <a href="mailto:artmg50@gmail.com" class="email">artmg50@gmail.com</a></li> 45551 <li>Sven Gerber <a href="mailto:49589423+svengerber@users.noreply.github.com" class="email">49589423+svengerber@users.noreply.github.com</a></li> 45552 <li>CrossR <a href="mailto:r.cross@lancaster.ac.uk" class="email">r.cross@lancaster.ac.uk</a></li> 45553 <li>Maciej Radzikowski <a href="mailto:maciej@radzikowski.com.pl" class="email">maciej@radzikowski.com.pl</a></li> 45554 <li>Scott Grimes <a href="mailto:scott.grimes@spaciq.com" class="email">scott.grimes@spaciq.com</a></li> 45555 <li>Phil Shackleton <a href="mailto:71221528+philshacks@users.noreply.github.com" class="email">71221528+philshacks@users.noreply.github.com</a></li> 45556 <li>eNV25 <a href="mailto:env252525@gmail.com" class="email">env252525@gmail.com</a></li> 45557 <li>Caleb <a href="mailto:inventor96@users.noreply.github.com" class="email">inventor96@users.noreply.github.com</a></li> 45558 <li>J-P Treen <a href="mailto:jp@wraptious.com" class="email">jp@wraptious.com</a></li> 45559 <li>Martin Czygan <a href="mailto:53705+miku@users.noreply.github.com" class="email">53705+miku@users.noreply.github.com</a></li> 45560 <li>buda <a href="mailto:sandrojijavadze@protonmail.com" class="email">sandrojijavadze@protonmail.com</a></li> 45561 <li>mirekphd <a href="mailto:36706320+mirekphd@users.noreply.github.com" class="email">36706320+mirekphd@users.noreply.github.com</a></li> 45562 <li>vyloy <a href="mailto:vyloy@qq.com" class="email">vyloy@qq.com</a></li> 45563 <li>Anthrazz <a href="mailto:25553648+Anthrazz@users.noreply.github.com" class="email">25553648+Anthrazz@users.noreply.github.com</a></li> 45564 <li>zzr93 <a href="mailto:34027824+zzr93@users.noreply.github.com" class="email">34027824+zzr93@users.noreply.github.com</a></li> 45565 <li>Paul Norman <a href="mailto:penorman@mac.com" class="email">penorman@mac.com</a></li> 45566 <li>Lorenzo Maiorfi <a href="mailto:maiorfi@gmail.com" class="email">maiorfi@gmail.com</a></li> 45567 <li>Claudio Maradonna <a href="mailto:penguyman@stronzi.org" class="email">penguyman@stronzi.org</a></li> 45568 <li>Ovidiu Victor Tatar <a href="mailto:ovi.tatar@googlemail.com" class="email">ovi.tatar@googlemail.com</a></li> 45569 <li>Evan Spensley <a href="mailto:epspensley@gmail.com" class="email">epspensley@gmail.com</a></li> 45570 <li>Yen Hu <a href="mailto:61753151+0x59656e@users.noreply.github.com" class="email">61753151+0x59656e@users.noreply.github.com</a></li> 45571 <li>Steve Kowalik <a href="mailto:steven@wedontsleep.org" class="email">steven@wedontsleep.org</a></li> 45572 <li>Jordi Gonzalez Muñoz <a href="mailto:jordigonzm@gmail.com" class="email">jordigonzm@gmail.com</a></li> 45573 <li>Joram Schrijver <a href="mailto:i@joram.io" class="email">i@joram.io</a></li> 45574 <li>Mark Trolley <a href="mailto:marktrolley@gmail.com" class="email">marktrolley@gmail.com</a></li> 45575 <li>João Henrique Franco <a href="mailto:joaohenrique.franco@gmail.com" class="email">joaohenrique.franco@gmail.com</a></li> 45576 <li>anonion <a href="mailto:aman207@users.noreply.github.com" class="email">aman207@users.noreply.github.com</a></li> 45577 <li>Ryan Morey <a href="mailto:4590343+rmorey@users.noreply.github.com" class="email">4590343+rmorey@users.noreply.github.com</a></li> 45578 <li>Simon Bos <a href="mailto:simonbos9@gmail.com" class="email">simonbos9@gmail.com</a></li> 45579 <li>YFdyh000 <a href="mailto:yfdyh000@gmail.com" class="email">yfdyh000@gmail.com</a> * Josh Soref <a href="mailto:2119212+jsoref@users.noreply.github.com" class="email">2119212+jsoref@users.noreply.github.com</a></li> 45580 <li>Øyvind Heddeland Instefjord <a href="mailto:instefjord@outlook.com" class="email">instefjord@outlook.com</a></li> 45581 <li>Dmitry Deniskin <a href="mailto:110819396+ddeniskin@users.noreply.github.com" class="email">110819396+ddeniskin@users.noreply.github.com</a></li> 45582 <li>Alexander Knorr <a href="mailto:106825+opexxx@users.noreply.github.com" class="email">106825+opexxx@users.noreply.github.com</a></li> 45583 <li>Richard Bateman <a href="mailto:richard@batemansr.us" class="email">richard@batemansr.us</a></li> 45584 <li>Dimitri Papadopoulos Orfanos <a href="mailto:3234522+DimitriPapadopoulos@users.noreply.github.com" class="email">3234522+DimitriPapadopoulos@users.noreply.github.com</a></li> 45585 <li>Lorenzo Milesi <a href="mailto:lorenzo.milesi@yetopen.com" class="email">lorenzo.milesi@yetopen.com</a></li> 45586 <li>Isaac Aymerich <a href="mailto:isaac.aymerich@gmail.com" class="email">isaac.aymerich@gmail.com</a></li> 45587 <li>YanceyChiew <a href="mailto:35898533+YanceyChiew@users.noreply.github.com" class="email">35898533+YanceyChiew@users.noreply.github.com</a></li> 45588 <li>Manoj Ghosh <a href="mailto:msays2000@gmail.com" class="email">msays2000@gmail.com</a></li> 45589 <li>Bachue Zhou <a href="mailto:bachue.shu@gmail.com" class="email">bachue.shu@gmail.com</a></li> 45590 <li>Manoj Ghosh <a href="mailto:manoj.ghosh@oracle.com" class="email">manoj.ghosh@oracle.com</a></li> 45591 <li>Tom Mombourquette <a href="mailto:tom@devnode.com" class="email">tom@devnode.com</a></li> 45592 <li>Robert Newson <a href="mailto:rnewson@apache.org" class="email">rnewson@apache.org</a></li> 45593 <li>Samuel Johnson <a href="mailto:esamueljohnson@gmail.com" class="email">esamueljohnson@gmail.com</a></li> 45594 <li>coultonluke <a href="mailto:luke@luke.org.uk" class="email">luke@luke.org.uk</a></li> 45595 <li>Anthony Pessy <a href="mailto:anthony@cogniteev.com" class="email">anthony@cogniteev.com</a></li> 45596 <li>Philip Harvey <a href="mailto:pharvey@battelleecology.org" class="email">pharvey@battelleecology.org</a></li> 45597 <li>dgouju <a href="mailto:dgouju@users.noreply.github.com" class="email">dgouju@users.noreply.github.com</a></li> 45598 <li>Clément Notin <a href="mailto:clement.notin@gmail.com" class="email">clement.notin@gmail.com</a></li> 45599 <li>x3-apptech <a href="mailto:66947598+x3-apptech@users.noreply.github.com" class="email">66947598+x3-apptech@users.noreply.github.com</a></li> 45600 <li>Arnie97 <a href="mailto:arnie97@gmail.com" class="email">arnie97@gmail.com</a></li> 45601 <li>Roel Arents <a href="mailto:2691308+roelarents@users.noreply.github.com" class="email">2691308+roelarents@users.noreply.github.com</a></li> 45602 <li>Aaron Gokaslan <a href="mailto:aaronGokaslan@gmail.com" class="email">aaronGokaslan@gmail.com</a></li> 45603 <li>techknowlogick <a href="mailto:matti@mdranta.net" class="email">matti@mdranta.net</a></li> 45604 <li>rkettelerij <a href="mailto:richard@mindloops.nl" class="email">richard@mindloops.nl</a></li> 45605 <li>Kamui <a href="mailto:fin-kamui@pm.me" class="email">fin-kamui@pm.me</a></li> 45606 <li>asdffdsazqqq <a href="mailto:90116442+asdffdsazqqq@users.noreply.github.com" class="email">90116442+asdffdsazqqq@users.noreply.github.com</a></li> 45607 <li>Nathaniel Wesley Filardo <a href="mailto:nfilardo@microsoft.com" class="email">nfilardo@microsoft.com</a></li> 45608 <li>ycdtosa <a href="mailto:ycdtosa@users.noreply.github.com" class="email">ycdtosa@users.noreply.github.com</a></li> 45609 <li>Erik Agterdenbos <a href="mailto:agterdenbos@users.noreply.github.com" class="email">agterdenbos@users.noreply.github.com</a></li> 45610 <li>Kevin Verstaen <a href="mailto:48050031+kverstae@users.noreply.github.com" class="email">48050031+kverstae@users.noreply.github.com</a></li> 45611 <li>MohammadReza <a href="mailto:mrvashian@gmail.com" class="email">mrvashian@gmail.com</a></li> 45612 <li>vanplus <a href="mailto:60313789+vanplus@users.noreply.github.com" class="email">60313789+vanplus@users.noreply.github.com</a></li> 45613 <li>Jack <a href="mailto:16779171+jkpe@users.noreply.github.com" class="email">16779171+jkpe@users.noreply.github.com</a></li> 45614 <li>Abdullah Saglam <a href="mailto:abdullah.saglam@stonebranch.com" class="email">abdullah.saglam@stonebranch.com</a></li> 45615 <li>Marks Polakovs <a href="mailto:github@markspolakovs.me" class="email">github@markspolakovs.me</a></li> 45616 <li>piyushgarg <a href="mailto:piyushgarg80@gmail.com" class="email">piyushgarg80@gmail.com</a></li> 45617 <li>Kaloyan Raev <a href="mailto:kaloyan-raev@users.noreply.github.com" class="email">kaloyan-raev@users.noreply.github.com</a></li> 45618 <li>IMTheNachoMan <a href="mailto:imthenachoman@gmail.com" class="email">imthenachoman@gmail.com</a></li> 45619 <li>alankrit <a href="mailto:alankrit@google.com" class="email">alankrit@google.com</a></li> 45620 <li>Bryan Kaplan <#<span class="citation" data-cites="bryankaplan.com">@bryankaplan.com</span>></li> 45621 <li>LXY <a href="mailto:767763591@qq.com" class="email">767763591@qq.com</a></li> 45622 <li>Simmon Li (he/him) <a href="mailto:li.simmon@gmail.com" class="email">li.simmon@gmail.com</a></li> 45623 <li>happyxhw <a href="mailto:44490504+happyxhw@users.noreply.github.com" class="email">44490504+happyxhw@users.noreply.github.com</a></li> 45624 <li>Simmon Li (he/him) <a href="mailto:hello@crespire.dev" class="email">hello@crespire.dev</a></li> 45625 <li>Matthias Baur <a href="mailto:baurmatt@users.noreply.github.com" class="email">baurmatt@users.noreply.github.com</a></li> 45626 <li>Hunter Wittenborn <a href="mailto:hunter@hunterwittenborn.com" class="email">hunter@hunterwittenborn.com</a></li> 45627 <li>logopk <a href="mailto:peter@kreuser.name" class="email">peter@kreuser.name</a></li> 45628 <li>Gerard Bosch <a href="mailto:30733556+gerardbosch@users.noreply.github.com" class="email">30733556+gerardbosch@users.noreply.github.com</a></li> 45629 <li>ToBeFree <a href="mailto:github@tfrei.de" class="email">github@tfrei.de</a></li> 45630 <li>NodudeWasTaken <a href="mailto:75137537+NodudeWasTaken@users.noreply.github.com" class="email">75137537+NodudeWasTaken@users.noreply.github.com</a></li> 45631 <li>Peter Brunner <a href="mailto:peter@lugoues.net" class="email">peter@lugoues.net</a></li> 45632 <li>Ninh Pham <a href="mailto:dongian.rapclubkhtn@gmail.com" class="email">dongian.rapclubkhtn@gmail.com</a></li> 45633 <li>Ryan Caezar Itang <a href="mailto:sitiom@proton.me" class="email">sitiom@proton.me</a></li> 45634 <li>Peter Brunner <a href="mailto:peter@psykhe.com" class="email">peter@psykhe.com</a></li> 45635 <li>Leandro Sacchet <a href="mailto:leandro.sacchet@animati.com.br" class="email">leandro.sacchet@animati.com.br</a></li> 45636 <li>dependabot[bot] <49699333+dependabot[bot]<span class="citation" data-cites="users.noreply.github.com">@users.noreply.github.com</span>></li> 45637 <li>cycneuramus <a href="mailto:56681631+cycneuramus@users.noreply.github.com" class="email">56681631+cycneuramus@users.noreply.github.com</a></li> 45638 <li>Arnavion <a href="mailto:me@arnavion.dev" class="email">me@arnavion.dev</a></li> 45639 <li>Christopher Merry <a href="mailto:christopher.merry@mlb.com" class="email">christopher.merry@mlb.com</a></li> 45640 <li>Thibault Coupin <a href="mailto:thibault.coupin@gmail.com" class="email">thibault.coupin@gmail.com</a></li> 45641 <li>Richard Tweed <a href="mailto:RichardoC@users.noreply.github.com" class="email">RichardoC@users.noreply.github.com</a></li> 45642 <li>Zach Kipp <a href="mailto:Zacho2@users.noreply.github.com" class="email">Zacho2@users.noreply.github.com</a></li> 45643 <li>yuudi <a href="mailto:26199752+yuudi@users.noreply.github.com" class="email">26199752+yuudi@users.noreply.github.com</a></li> 45644 <li>NickIAm <a href="mailto:NickIAm@users.noreply.github.com" class="email">NickIAm@users.noreply.github.com</a></li> 45645 <li>Juang, Yi-Lin <a href="mailto:frankyjuang@gmail.com" class="email">frankyjuang@gmail.com</a></li> 45646 <li>jumbi77 <a href="mailto:jumbi77@users.noreply.github.com" class="email">jumbi77@users.noreply.github.com</a></li> 45647 <li>Aditya Basu <a href="mailto:ab.aditya.basu@gmail.com" class="email">ab.aditya.basu@gmail.com</a></li> 45648 <li>ed <a href="mailto:s@ocv.me" class="email">s@ocv.me</a></li> 45649 <li>Drew Parsons <a href="mailto:dparsons@emerall.com" class="email">dparsons@emerall.com</a></li> 45650 <li>Joel <a href="mailto:joelnb@users.noreply.github.com" class="email">joelnb@users.noreply.github.com</a></li> 45651 <li>wiserain <a href="mailto:mail275@gmail.com" class="email">mail275@gmail.com</a></li> 45652 <li>Roel Arents <a href="mailto:roel.arents@kadaster.nl" class="email">roel.arents@kadaster.nl</a></li> 45653 <li>Shyim <a href="mailto:github@shyim.de" class="email">github@shyim.de</a></li> 45654 <li>Rintze Zelle <a href="mailto:78232505+rzelle-lallemand@users.noreply.github.com" class="email">78232505+rzelle-lallemand@users.noreply.github.com</a></li> 45655 <li>Damo <a href="mailto:damoclark@users.noreply.github.com" class="email">damoclark@users.noreply.github.com</a></li> 45656 <li>WeidiDeng <a href="mailto:weidi_deng@icloud.com" class="email">weidi_deng@icloud.com</a></li> 45657 <li>Brian Starkey <a href="mailto:stark3y@gmail.com" class="email">stark3y@gmail.com</a></li> 45658 <li>jladbrook <a href="mailto:jhladbrook@gmail.com" class="email">jhladbrook@gmail.com</a></li> 45659 <li>Loren Gordon <a href="mailto:lorengordon@users.noreply.github.com" class="email">lorengordon@users.noreply.github.com</a></li> 45660 <li>dlitster <a href="mailto:davidlitster@gmail.com" class="email">davidlitster@gmail.com</a></li> 45661 <li>Tobias Gion <a href="mailto:tobias@gion.io" class="email">tobias@gion.io</a></li> 45662 <li>Jānis Bebrītis <a href="mailto:janis.bebritis@wunder.io" class="email">janis.bebritis@wunder.io</a></li> 45663 <li>Adam K <a href="mailto:github.com@ak.tidy.email" class="email">github.com@ak.tidy.email</a></li> 45664 <li>Andrei Smirnov <a href="mailto:smirnov.captain@gmail.com" class="email">smirnov.captain@gmail.com</a></li> 45665 <li>Janne Hellsten <a href="mailto:jjhellst@gmail.com" class="email">jjhellst@gmail.com</a></li> 45666 <li>cc <a href="mailto:12904584+shvc@users.noreply.github.com" class="email">12904584+shvc@users.noreply.github.com</a></li> 45667 <li>Tareq Sharafy <a href="mailto:tareq.sha@gmail.com" class="email">tareq.sha@gmail.com</a></li> 45668 <li>kapitainsky <a href="mailto:dariuszb@me.com" class="email">dariuszb@me.com</a></li> 45669 <li>douchen <a href="mailto:playgoobug@gmail.com" class="email">playgoobug@gmail.com</a></li> 45670 <li>Sam Lai <a href="mailto:70988+slai@users.noreply.github.com" class="email">70988+slai@users.noreply.github.com</a></li> 45671 <li>URenko <a href="mailto:18209292+URenko@users.noreply.github.com" class="email">18209292+URenko@users.noreply.github.com</a></li> 45672 <li>Stanislav Gromov <a href="mailto:kullfar@gmail.com" class="email">kullfar@gmail.com</a></li> 45673 <li>Paulo Schreiner <a href="mailto:paulo.schreiner@delivion.de" class="email">paulo.schreiner@delivion.de</a></li> 45674 <li>Mariusz Suchodolski <a href="mailto:mariusz@suchodol.ski" class="email">mariusz@suchodol.ski</a></li> 45675 <li>danielkrajnik <a href="mailto:dan94kra@gmail.com" class="email">dan94kra@gmail.com</a></li> 45676 <li>Peter Fern <a href="mailto:github@0xc0dedbad.com" class="email">github@0xc0dedbad.com</a></li> 45677 <li>zzq <a href="mailto:i@zhangzqs.cn" class="email">i@zhangzqs.cn</a></li> 45678 <li>mac-15 <a href="mailto:usman.ilamdin@phpstudios.com" class="email">usman.ilamdin@phpstudios.com</a></li> 45679 <li>Sawada Tsunayoshi <a href="mailto:34431649+TsunayoshiSawada@users.noreply.github.com" class="email">34431649+TsunayoshiSawada@users.noreply.github.com</a></li> 45680 <li>Dean Attali <a href="mailto:daattali@gmail.com" class="email">daattali@gmail.com</a></li> 45681 <li>Fjodor42 <a href="mailto:molgaard@gmail.com" class="email">molgaard@gmail.com</a></li> 45682 <li>BakaWang <a href="mailto:wa11579@hotmail.com" class="email">wa11579@hotmail.com</a></li> 45683 <li>Mahad <a href="mailto:56235065+Mahad-lab@users.noreply.github.com" class="email">56235065+Mahad-lab@users.noreply.github.com</a></li> 45684 <li>Vladislav Vorobev <a href="mailto:x.miere@gmail.com" class="email">x.miere@gmail.com</a></li> 45685 <li>darix <a href="mailto:darix@users.noreply.github.com" class="email">darix@users.noreply.github.com</a></li> 45686 <li>Benjamin <a href="mailto:36415086+bbenjamin-sys@users.noreply.github.com" class="email">36415086+bbenjamin-sys@users.noreply.github.com</a></li> 45687 <li>Chun-Hung Tseng <a href="mailto:henrybear327@users.noreply.github.com" class="email">henrybear327@users.noreply.github.com</a></li> 45688 <li>Ricardo D'O. Albanus <a href="mailto:rdalbanus@users.noreply.github.com" class="email">rdalbanus@users.noreply.github.com</a></li> 45689 <li>gabriel-suela <a href="mailto:gscsuela@gmail.com" class="email">gscsuela@gmail.com</a></li> 45690 <li>Tiago Boeing <a href="mailto:contato@tiagoboeing.com" class="email">contato@tiagoboeing.com</a></li> 45691 <li>Edwin Mackenzie-Owen <a href="mailto:edwin.mowen@gmail.com" class="email">edwin.mowen@gmail.com</a></li> 45692 <li>Niklas Hambüchen <a href="mailto:mail@nh2.me" class="email">mail@nh2.me</a></li> 45693 <li>yuudi <a href="mailto:yuudi@users.noreply.github.com" class="email">yuudi@users.noreply.github.com</a></li> 45694 <li>Zach <a href="mailto:github@prozach.org" class="email">github@prozach.org</a></li> 45695 <li>nielash <a href="mailto:31582349+nielash@users.noreply.github.com" class="email">31582349+nielash@users.noreply.github.com</a></li> 45696 <li>Julian Lepinski <a href="mailto:lepinsk@users.noreply.github.com" class="email">lepinsk@users.noreply.github.com</a></li> 45697 <li>Raymond Berger <a href="mailto:RayBB@users.noreply.github.com" class="email">RayBB@users.noreply.github.com</a></li> 45698 <li>Nihaal Sangha <a href="mailto:nihaal.git@gmail.com" class="email">nihaal.git@gmail.com</a></li> 45699 <li>Masamune3210 <a href="mailto:1053504+Masamune3210@users.noreply.github.com" class="email">1053504+Masamune3210@users.noreply.github.com</a></li> 45700 <li>James Braza <a href="mailto:jamesbraza@gmail.com" class="email">jamesbraza@gmail.com</a></li> 45701 <li>antoinetran <a href="mailto:antoinetran@users.noreply.github.com" class="email">antoinetran@users.noreply.github.com</a></li> 45702 <li>alexia <a href="mailto:me@alexia.lol" class="email">me@alexia.lol</a></li> 45703 <li>nielash <a href="mailto:nielronash@gmail.com" class="email">nielronash@gmail.com</a></li> 45704 <li>Vitor Gomes <a href="mailto:vitor.gomes@delivion.de" class="email">vitor.gomes@delivion.de</a> <a href="mailto:mail@vitorgomes.com" class="email">mail@vitorgomes.com</a></li> 45705 <li>Jacob Hands <a href="mailto:jacob@gogit.io" class="email">jacob@gogit.io</a></li> 45706 <li>hideo aoyama <a href="mailto:100831251+boukendesho@users.noreply.github.com" class="email">100831251+boukendesho@users.noreply.github.com</a></li> 45707 <li>Roberto Ricci <a href="mailto:io@r-ricci.it" class="email">io@r-ricci.it</a></li> 45708 <li>Bjørn Smith <a href="mailto:bjornsmith@gmail.com" class="email">bjornsmith@gmail.com</a></li> 45709 <li>Alishan Ladhani <a href="mailto:8869764+aladh@users.noreply.github.com" class="email">8869764+aladh@users.noreply.github.com</a></li> 45710 <li>zjx20 <a href="mailto:zhoujianxiong2@gmail.com" class="email">zhoujianxiong2@gmail.com</a></li> 45711 <li>Oksana <a href="mailto:142890647+oks-maytech@users.noreply.github.com" class="email">142890647+oks-maytech@users.noreply.github.com</a></li> 45712 <li>Volodymyr Kit <a href="mailto:v.kit@maytech.net" class="email">v.kit@maytech.net</a></li> 45713 <li>David Pedersen <a href="mailto:limero@me.com" class="email">limero@me.com</a></li> 45714 <li>Drew Stinnett <a href="mailto:drew@drewlink.com" class="email">drew@drewlink.com</a></li> 45715 <li>Pat Patterson <a href="mailto:pat@backblaze.com" class="email">pat@backblaze.com</a></li> 45716 <li>Herby Gillot <a href="mailto:herby.gillot@gmail.com" class="email">herby.gillot@gmail.com</a></li> 45717 <li>Nikita Shoshin <a href="mailto:shoshin_nikita@fastmail.com" class="email">shoshin_nikita@fastmail.com</a></li> 45718 <li>rinsuki <a href="mailto:428rinsuki+git@gmail.com" class="email">428rinsuki+git@gmail.com</a></li> 45719 <li>Beyond Meat <a href="mailto:51850644+beyondmeat@users.noreply.github.com" class="email">51850644+beyondmeat@users.noreply.github.com</a></li> 45720 <li>Saleh Dindar <a href="mailto:salh@fb.com" class="email">salh@fb.com</a></li> 45721 <li>Volodymyr <a href="mailto:142890760+vkit-maytech@users.noreply.github.com" class="email">142890760+vkit-maytech@users.noreply.github.com</a></li> 45722 <li>Gabriel Espinoza <a href="mailto:31670639+gspinoza@users.noreply.github.com" class="email">31670639+gspinoza@users.noreply.github.com</a></li> 45723 <li>Keigo Imai <a href="mailto:keigo.imai@gmail.com" class="email">keigo.imai@gmail.com</a></li> 45724 <li>Ivan Yanitra <a href="mailto:iyanitra@tesla-consulting.com" class="email">iyanitra@tesla-consulting.com</a></li> 45725 <li>alfish2000 <a href="mailto:alfish2000@gmail.com" class="email">alfish2000@gmail.com</a></li> 45726 <li>wuxingzhong <a href="mailto:qq330332812@gmail.com" class="email">qq330332812@gmail.com</a></li> 45727 <li>Adithya Kumar <a href="mailto:akumar42@protonmail.com" class="email">akumar42@protonmail.com</a></li> 45728 <li>Tayo-pasedaRJ <a href="mailto:138471223+Tayo-pasedaRJ@users.noreply.github.com" class="email">138471223+Tayo-pasedaRJ@users.noreply.github.com</a></li> 45729 <li>Peter Kreuser <a href="mailto:logo@kreuser.name" class="email">logo@kreuser.name</a></li> 45730 <li>Piyush <piyushgarg80></li> 45731 <li>fotile96 <a href="mailto:fotile96@users.noreply.github.com" class="email">fotile96@users.noreply.github.com</a></li> 45732 <li>Luc Ritchie <a href="mailto:luc.ritchie@gmail.com" class="email">luc.ritchie@gmail.com</a></li> 45733 <li>cynful <a href="mailto:cynful@users.noreply.github.com" class="email">cynful@users.noreply.github.com</a></li> 45734 <li>wjielai <a href="mailto:wjielai@tencent.com" class="email">wjielai@tencent.com</a></li> 45735 <li>Jack Deng <a href="mailto:jackdeng@gmail.com" class="email">jackdeng@gmail.com</a></li> 45736 <li>Mikubill <a href="mailto:31246794+Mikubill@users.noreply.github.com" class="email">31246794+Mikubill@users.noreply.github.com</a></li> 45737 <li>Artur Neumann <a href="mailto:artur@jankaritech.com" class="email">artur@jankaritech.com</a></li> 45738 <li>Saw-jan <a href="mailto:saw.jan.grg3e@gmail.com" class="email">saw.jan.grg3e@gmail.com</a></li> 45739 <li>Oksana Zhykina <a href="mailto:o.zhykina@maytech.net" class="email">o.zhykina@maytech.net</a></li> 45740 <li>karan <a href="mailto:karan.gupta92@gmail.com" class="email">karan.gupta92@gmail.com</a></li> 45741 <li>viktor <a href="mailto:viktor@yakovchuk.net" class="email">viktor@yakovchuk.net</a></li> 45742 <li>moongdal <a href="mailto:moongdal@tutanota.com" class="email">moongdal@tutanota.com</a></li> 45743 <li>Mina Galić <a href="mailto:freebsd@igalic.co" class="email">freebsd@igalic.co</a></li> 45744 <li>Alen Šiljak <a href="mailto:dev@alensiljak.eu.org" class="email">dev@alensiljak.eu.org</a></li> 45745 <li>你知道未来吗 <a href="mailto:rkonfj@gmail.com" class="email">rkonfj@gmail.com</a></li> 45746 <li>Abhinav Dhiman <a href="mailto:8640877+ahnv@users.noreply.github.com" class="email">8640877+ahnv@users.noreply.github.com</a></li> 45747 <li>halms <a href="mailto:7513146+halms@users.noreply.github.com" class="email">7513146+halms@users.noreply.github.com</a></li> 45748 <li>ben-ba <a href="mailto:benjamin.brauner@gmx.de" class="email">benjamin.brauner@gmx.de</a></li> 45749 <li>Eli Orzitzer <a href="mailto:e_orz@yahoo.com" class="email">e_orz@yahoo.com</a></li> 45750 <li>Anthony Metzidis <a href="mailto:anthony.metzidis@gmail.com" class="email">anthony.metzidis@gmail.com</a></li> 45751 <li>emyarod <a href="mailto:afw5059@gmail.com" class="email">afw5059@gmail.com</a></li> 45752 <li>keongalvin <a href="mailto:keongalvin@gmail.com" class="email">keongalvin@gmail.com</a></li> 45753 <li>rarspace01 <a href="mailto:rarspace01@users.noreply.github.com" class="email">rarspace01@users.noreply.github.com</a></li> 45754 <li>Paul Stern <a href="mailto:paulstern45@gmail.com" class="email">paulstern45@gmail.com</a></li> 45755 <li>Nikhil Ahuja <a href="mailto:nikhilahuja@live.com" class="email">nikhilahuja@live.com</a></li> 45756 <li>Harshit Budhraja <a href="mailto:52413945+harshit-budhraja@users.noreply.github.com" class="email">52413945+harshit-budhraja@users.noreply.github.com</a></li> 45757 <li>Tera <a href="mailto:24725862+teraa@users.noreply.github.com" class="email">24725862+teraa@users.noreply.github.com</a></li> 45758 <li>Kyle Reynolds <a href="mailto:kylereynoldsdev@gmail.com" class="email">kylereynoldsdev@gmail.com</a></li> 45759 <li>Michael Eischer <a href="mailto:michael.eischer@gmx.de" class="email">michael.eischer@gmx.de</a></li> 45760 <li>Thomas Müller <a href="mailto:1005065+DeepDiver1975@users.noreply.github.com" class="email">1005065+DeepDiver1975@users.noreply.github.com</a></li> 45761 <li>DanielEgbers <a href="mailto:27849724+DanielEgbers@users.noreply.github.com" class="email">27849724+DanielEgbers@users.noreply.github.com</a></li> 45762 <li>Jack Provance <a href="mailto:49460795+njprov@users.noreply.github.com" class="email">49460795+njprov@users.noreply.github.com</a></li> 45763 <li>Gabriel Ramos <a href="mailto:109390599+gabrielramos02@users.noreply.github.com" class="email">109390599+gabrielramos02@users.noreply.github.com</a></li> 45764 <li>Dan McArdle <a href="mailto:d@nmcardle.com" class="email">d@nmcardle.com</a></li> 45765 <li>Joe Cai <a href="mailto:joe.cai@bigcommerce.com" class="email">joe.cai@bigcommerce.com</a></li> 45766 <li>Anders Swanson <a href="mailto:anders.swanson@oracle.com" class="email">anders.swanson@oracle.com</a></li> 45767 <li>huajin tong <a href="mailto:137764712+thirdkeyword@users.noreply.github.com" class="email">137764712+thirdkeyword@users.noreply.github.com</a></li> 45768 </ul> 45769 <h1 id="contact-the-rclone-project">Contact the rclone project</h1> 45770 <h2 id="forum">Forum</h2> 45771 <p>Forum for questions and general discussion:</p> 45772 <ul> 45773 <li>https://forum.rclone.org</li> 45774 </ul> 45775 <h2 id="business-support">Business support</h2> 45776 <p>For business support or sponsorship enquiries please see:</p> 45777 <ul> 45778 <li>https://rclone.com/</li> 45779 <li>sponsorship@rclone.com</li> 45780 </ul> 45781 <h2 id="github-repository">GitHub repository</h2> 45782 <p>The project's repository is located at:</p> 45783 <ul> 45784 <li>https://github.com/rclone/rclone</li> 45785 </ul> 45786 <p>There you can file bug reports or contribute with pull requests.</p> 45787 <h2 id="twitter">Twitter</h2> 45788 <p>You can also follow Nick on twitter for rclone announcements:</p> 45789 <ul> 45790 <li><span class="citation" data-cites="njcw">[@njcw]</span>(https://twitter.com/njcw)</li> 45791 </ul> 45792 <h2 id="email">Email</h2> 45793 <p>Or if all else fails or you want to ask something private or confidential</p> 45794 <ul> 45795 <li>info@rclone.com</li> 45796 </ul> 45797 <p>Please don't email requests for help to this address - those are better directed to the forum unless you'd like to sign up for business support.</p> 45798 </body> 45799 </html>