Enhanced PHP File Manager

⬆️ Go Up (..)

📊 Server Information

Server:

nginx/1.28.0

System:

Linux 6.8.0-90-generic

PHP Version:

8.4.15

User:

alqudsvolunteers

Directory:

/home/alqudsvolunteers/rootlink/usr/share/doc/rclone

Free Space:

81.61 GB

🔧 Quick Actions

✏️ Editing: MANUAL.html

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang="">
<head>
  <meta charset="utf-8" />
  <meta name="generator" content="pandoc" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
  <meta name="author" content="Nick Craig-Wood" />
  <title>rclone(1) User Manual</title>
  <style>
    html {
      color: #1a1a1a;
      background-color: #fdfdfd;
    }
    body {
      margin: 0 auto;
      max-width: 36em;
      padding-left: 50px;
      padding-right: 50px;
      padding-top: 50px;
      padding-bottom: 50px;
      hyphens: auto;
      overflow-wrap: break-word;
      text-rendering: optimizeLegibility;
      font-kerning: normal;
    }
    @media (max-width: 600px) {
      body {
        font-size: 0.9em;
        padding: 12px;
      }
      h1 {
        font-size: 1.8em;
      }
    }
    @media print {
      html {
        background-color: white;
      }
      body {
        background-color: transparent;
        color: black;
        font-size: 12pt;
      }
      p, h2, h3 {
        orphans: 3;
        widows: 3;
      }
      h2, h3, h4 {
        page-break-after: avoid;
      }
    }
    p {
      margin: 1em 0;
    }
    a {
      color: #1a1a1a;
    }
    a:visited {
      color: #1a1a1a;
    }
    img {
      max-width: 100%;
    }
    h1, h2, h3, h4, h5, h6 {
      margin-top: 1.4em;
    }
    h5, h6 {
      font-size: 1em;
      font-style: italic;
    }
    h6 {
      font-weight: normal;
    }
    ol, ul {
      padding-left: 1.7em;
      margin-top: 1em;
    }
    li > ol, li > ul {
      margin-top: 0;
    }
    blockquote {
      margin: 1em 0 1em 1.7em;
      padding-left: 1em;
      border-left: 2px solid #e6e6e6;
      color: #606060;
    }
    code {
      font-family: Menlo, Monaco, Consolas, 'Lucida Console', monospace;
      font-size: 85%;
      margin: 0;
      hyphens: manual;
    }
    pre {
      margin: 1em 0;
      overflow: auto;
    }
    pre code {
      padding: 0;
      overflow: visible;
      overflow-wrap: normal;
    }
    .sourceCode {
     background-color: transparent;
     overflow: visible;
    }
    hr {
      background-color: #1a1a1a;
      border: none;
      height: 1px;
      margin: 1em 0;
    }
    table {
      margin: 1em 0;
      border-collapse: collapse;
      width: 100%;
      overflow-x: auto;
      display: block;
      font-variant-numeric: lining-nums tabular-nums;
    }
    table caption {
      margin-bottom: 0.75em;
    }
    tbody {
      margin-top: 0.5em;
      border-top: 1px solid #1a1a1a;
      border-bottom: 1px solid #1a1a1a;
    }
    th {
      border-top: 1px solid #1a1a1a;
      padding: 0.25em 0.5em 0.25em 0.5em;
    }
    td {
      padding: 0.125em 0.5em 0.25em 0.5em;
    }
    header {
      margin-bottom: 4em;
      text-align: center;
    }
    #TOC li {
      list-style: none;
    }
    #TOC ul {
      padding-left: 1.3em;
    }
    #TOC > ul {
      padding-left: 0;
    }
    #TOC a:not(:hover) {
      text-decoration: none;
    }
    code{white-space: pre-wrap;}
    span.smallcaps{font-variant: small-caps;}
    div.columns{display: flex; gap: min(4vw, 1.5em);}
    div.column{flex: auto; overflow-x: auto;}
    div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
    /* The extra [class] is a hack that increases specificity enough to
       override a similar rule in reveal.js */
    ul.task-list[class]{list-style: none;}
    ul.task-list li input[type="checkbox"] {
      font-size: inherit;
      width: 0.8em;
      margin: 0 0.8em 0.2em -1.6em;
      vertical-align: middle;
    }
    .display.math{display: block; text-align: center; margin: 0.5rem auto;}
  </style>
</head>
<body>
<header id="title-block-header">
<h1 class="title">rclone(1) User Manual</h1>
<p class="author">Nick Craig-Wood</p>
<p class="date">Sep 09, 2025</p>
</header>
<h1 id="rclone-syncs-your-files-to-cloud-storage">Rclone syncs your
files to cloud storage</h1>
<p><img width="50%" src="logo_on_light__horizontal_color.svg" alt="rclone logo" style="float:right; padding: 5px;" ></p>
<ul>
<li><a href="#about">About rclone</a></li>
<li><a href="#what">What can rclone do for you?</a></li>
<li><a href="#features">What features does rclone have?</a></li>
<li><a href="#providers">What providers does rclone support?</a></li>
<li><a href="https://rclone.org/downloads/">Download</a></li>
<li><a href="https://rclone.org/install/">Install</a></li>
<li><a href="https://rclone.org/donate/">Donate.</a></li>
</ul>
<h2 id="about">About rclone</h2>
<p>Rclone is a command-line program to manage files on cloud storage. It
is a feature-rich alternative to cloud vendors’ web storage interfaces.
<a href="#providers">Over 40 cloud storage products</a> support rclone
including S3 object stores, business &amp; consumer file storage
services, as well as standard transfer protocols.</p>
<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>
<p>Users call rclone <em>“The Swiss army knife of cloud storage”</em>,
and <em>“Technology indistinguishable from magic”</em>.</p>
<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>
<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>
<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>
<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>
<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>
<p>Rclone does the heavy lifting of communicating with cloud
storage.</p>
<h2 id="what">What can rclone do for you?</h2>
<p>Rclone helps you:</p>
<ul>
<li>Backup (and encrypt) files to cloud storage</li>
<li>Restore (and decrypt) files from cloud storage</li>
<li>Mirror cloud data to other cloud services or locally</li>
<li>Migrate data to the cloud, or between cloud storage vendors</li>
<li>Mount multiple, encrypted, cached or diverse cloud storage as a
disk</li>
<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>
<li><a href="https://rclone.org/union/">Union</a> file systems together
to present multiple local and/or cloud file systems as one</li>
</ul>
<h2 id="features">Features</h2>
<ul>
<li>Transfers
<ul>
<li>MD5, SHA1 hashes are checked at all times for file integrity</li>
<li>Timestamps are preserved on files</li>
<li>Operations can be restarted at any time</li>
<li>Can be to and from network, e.g. two different cloud providers</li>
<li>Can use multi-threaded downloads to local disk</li>
</ul></li>
<li><a href="https://rclone.org/commands/rclone_copy/">Copy</a> new or
changed files to cloud storage</li>
<li><a href="https://rclone.org/commands/rclone_sync/">Sync</a> (one
way) to make a directory identical</li>
<li><a href="https://rclone.org/commands/rclone_move/">Move</a> files to
cloud storage deleting the local after verification</li>
<li><a href="https://rclone.org/commands/rclone_check/">Check</a> hashes
and for missing/extra files</li>
<li><a href="https://rclone.org/commands/rclone_mount/">Mount</a> your
cloud storage as a network disk</li>
<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>
<li>Experimental <a href="https://rclone.org/gui/">Web based
GUI</a></li>
</ul>
<h2 id="providers">Supported providers</h2>
<p>(There are many others, built on standard protocols such as WebDAV or
S3, that work out of the box.)</p>
<ul>
<li>1Fichier</li>
<li>Akamai Netstorage</li>
<li>Alibaba Cloud (Aliyun) Object Storage System (OSS)</li>
<li>Amazon Drive</li>
<li>Amazon S3</li>
<li>Backblaze B2</li>
<li>Box</li>
<li>Ceph</li>
<li>China Mobile Ecloud Elastic Object Storage (EOS)</li>
<li>Arvan Cloud Object Storage (AOS)</li>
<li>Citrix ShareFile</li>
<li>Cloudflare R2</li>
<li>DigitalOcean Spaces</li>
<li>Digi Storage</li>
<li>Dreamhost</li>
<li>Dropbox</li>
<li>Enterprise File Fabric</li>
<li>FTP</li>
<li>Google Cloud Storage</li>
<li>Google Drive</li>
<li>Google Photos</li>
<li>HDFS</li>
<li>Hetzner Storage Box</li>
<li>HiDrive</li>
<li>HTTP</li>
<li>Internet Archive</li>
<li>Jottacloud</li>
<li>IBM COS S3</li>
<li>IDrive e2</li>
<li>IONOS Cloud</li>
<li>Koofr</li>
<li>Mail.ru Cloud</li>
<li>Memset Memstore</li>
<li>Mega</li>
<li>Memory</li>
<li>Microsoft Azure Blob Storage</li>
<li>Microsoft OneDrive</li>
<li>Minio</li>
<li>Nextcloud</li>
<li>OVH</li>
<li>OpenDrive</li>
<li>OpenStack Swift</li>
<li>Oracle Cloud Storage Swift</li>
<li>Oracle Object Storage</li>
<li>ownCloud</li>
<li>pCloud</li>
<li>premiumize.me</li>
<li>put.io</li>
<li>QingStor</li>
<li>Qiniu Cloud Object Storage (Kodo)</li>
<li>Rackspace Cloud Files</li>
<li>rsync.net</li>
<li>Scaleway</li>
<li>Seafile</li>
<li>Seagate Lyve Cloud</li>
<li>SeaweedFS</li>
<li>SFTP</li>
<li>Sia</li>
<li>SMB / CIFS</li>
<li>StackPath</li>
<li>Storj</li>
<li>SugarSync</li>
<li>Tencent Cloud Object Storage (COS)</li>
<li>Uptobox</li>
<li>Wasabi</li>
<li>WebDAV</li>
<li>Yandex Disk</li>
<li>Zoho WorkDrive</li>
<li>The local filesystem</li>
</ul>
<h2 id="virtual-providers">Virtual providers</h2>
<p>These backends adapt or modify other storage providers:</p>
<ul>
<li>Alias: Rename existing remotes</li>
<li>Cache: Cache remotes (DEPRECATED)</li>
<li>Chunker: Split large files</li>
<li>Combine: Combine multiple remotes into a directory tree</li>
<li>Compress: Compress files</li>
<li>Crypt: Encrypt files</li>
<li>Hasher: Hash files</li>
<li>Union: Join multiple remotes to work together</li>
</ul>
<h2 id="links">Links</h2>
<ul>
<li><a href="https://rclone.org/">Home page</a></li>
<li><a href="https://github.com/rclone/rclone">GitHub project page for
source and bug tracker</a></li>
<li><a href="https://forum.rclone.org">Rclone Forum</a></li>
<li><a href="https://rclone.org/downloads/">Downloads</a></li>
</ul>
<h1 id="usage">Usage</h1>
<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>
<h2 id="configure">Configure</h2>
<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>
<p>The easiest way to make the config is to run rclone with the config
option:</p>
<pre><code>rclone config</code></pre>
<p>See the following for detailed instructions for</p>
<ul>
<li><a href="https://rclone.org/fichier/">1Fichier</a></li>
<li><a href="https://rclone.org/netstorage/">Akamai Netstorage</a></li>
<li><a href="https://rclone.org/alias/">Alias</a></li>
<li><a href="https://rclone.org/amazonclouddrive/">Amazon Drive</a></li>
<li><a href="https://rclone.org/s3/">Amazon S3</a></li>
<li><a href="https://rclone.org/b2/">Backblaze B2</a></li>
<li><a href="https://rclone.org/box/">Box</a></li>
<li><a href="https://rclone.org/chunker/">Chunker</a> - transparently
splits large files for other remotes</li>
<li><a href="https://rclone.org/sharefile/">Citrix ShareFile</a></li>
<li><a href="https://rclone.org/compress/">Compress</a></li>
<li><a href="https://rclone.org/combine/">Combine</a></li>
<li><a href="https://rclone.org/crypt/">Crypt</a> - to encrypt other
remotes</li>
<li><a href="https://rclone.org/s3/#digitalocean-spaces">DigitalOcean
Spaces</a></li>
<li><a href="https://rclone.org/koofr/#digi-storage">Digi
Storage</a></li>
<li><a href="https://rclone.org/dropbox/">Dropbox</a></li>
<li><a href="https://rclone.org/filefabric/">Enterprise File
Fabric</a></li>
<li><a href="https://rclone.org/ftp/">FTP</a></li>
<li><a href="https://rclone.org/googlecloudstorage/">Google Cloud
Storage</a></li>
<li><a href="https://rclone.org/drive/">Google Drive</a></li>
<li><a href="https://rclone.org/googlephotos/">Google Photos</a></li>
<li><a href="https://rclone.org/hasher/">Hasher</a> - to handle
checksums for other remotes</li>
<li><a href="https://rclone.org/hdfs/">HDFS</a></li>
<li><a href="https://rclone.org/hidrive/">HiDrive</a></li>
<li><a href="https://rclone.org/http/">HTTP</a></li>
<li><a href="https://rclone.org/internetarchive/">Internet
Archive</a></li>
<li><a href="https://rclone.org/jottacloud/">Jottacloud</a></li>
<li><a href="https://rclone.org/koofr/">Koofr</a></li>
<li><a href="https://rclone.org/mailru/">Mail.ru Cloud</a></li>
<li><a href="https://rclone.org/mega/">Mega</a></li>
<li><a href="https://rclone.org/memory/">Memory</a></li>
<li><a href="https://rclone.org/azureblob/">Microsoft Azure Blob
Storage</a></li>
<li><a href="https://rclone.org/onedrive/">Microsoft OneDrive</a></li>
<li><a href="https://rclone.org/swift/">OpenStack Swift / Rackspace
Cloudfiles / Memset Memstore</a></li>
<li><a href="https://rclone.org/opendrive/">OpenDrive</a></li>
<li><a href="https://rclone.org/oracleobjectstorage/">Oracle Object
Storage</a></li>
<li><a href="https://rclone.org/pcloud/">Pcloud</a></li>
<li><a href="https://rclone.org/premiumizeme/">premiumize.me</a></li>
<li><a href="https://rclone.org/putio/">put.io</a></li>
<li><a href="https://rclone.org/qingstor/">QingStor</a></li>
<li><a href="https://rclone.org/seafile/">Seafile</a></li>
<li><a href="https://rclone.org/sftp/">SFTP</a></li>
<li><a href="https://rclone.org/sia/">Sia</a></li>
<li><a href="https://rclone.org/smb/">SMB</a></li>
<li><a href="https://rclone.org/storj/">Storj</a></li>
<li><a href="https://rclone.org/sugarsync/">SugarSync</a></li>
<li><a href="https://rclone.org/union/">Union</a></li>
<li><a href="https://rclone.org/uptobox/">Uptobox</a></li>
<li><a href="https://rclone.org/webdav/">WebDAV</a></li>
<li><a href="https://rclone.org/yandex/">Yandex Disk</a></li>
<li><a href="https://rclone.org/zoho/">Zoho WorkDrive</a></li>
<li><a href="https://rclone.org/local/">The local filesystem</a></li>
</ul>
<h2 id="basic-syntax">Basic syntax</h2>
<p>Rclone syncs a directory tree from one storage system to another.</p>
<p>Its syntax is like this</p>
<pre><code>Syntax: [options] subcommand &lt;parameters&gt; &lt;parameters...&gt;</code></pre>
<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>
<p>You can define as many storage paths as you like in the config
file.</p>
<p>Please use the <a href="#interactive"><code>-i</code> /
<code>--interactive</code></a> flag while learning rclone to avoid
accidental data loss.</p>
<h2 id="subcommands">Subcommands</h2>
<p>rclone uses a system of subcommands. For example</p>
<pre><code>rclone ls remote:path # lists a remote
rclone copy /local/path remote:path # copies /local/path to the remote
rclone sync -i /local/path remote:path # syncs /local/path to the remote</code></pre>
<h1 id="rclone-config">rclone config</h1>
<p>Enter an interactive configuration session.</p>
<h2 id="synopsis">Synopsis</h2>
<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>
<pre><code>rclone config [flags]</code></pre>
<h2 id="options">Options</h2>
<pre><code>  -h, --help   help for config</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
<li><a href="https://rclone.org/commands/rclone_config_create/">rclone
config create</a> - Create a new remote with name, type and
options.</li>
<li><a href="https://rclone.org/commands/rclone_config_delete/">rclone
config delete</a> - Delete an existing remote.</li>
<li><a
href="https://rclone.org/commands/rclone_config_disconnect/">rclone
config disconnect</a> - Disconnects user from remote</li>
<li><a href="https://rclone.org/commands/rclone_config_dump/">rclone
config dump</a> - Dump the config file as JSON.</li>
<li><a href="https://rclone.org/commands/rclone_config_file/">rclone
config file</a> - Show path of configuration file in use.</li>
<li><a href="https://rclone.org/commands/rclone_config_password/">rclone
config password</a> - Update password in an existing remote.</li>
<li><a href="https://rclone.org/commands/rclone_config_paths/">rclone
config paths</a> - Show paths used for configuration, cache, temp
etc.</li>
<li><a
href="https://rclone.org/commands/rclone_config_providers/">rclone
config providers</a> - List in JSON format all the providers and
options.</li>
<li><a
href="https://rclone.org/commands/rclone_config_reconnect/">rclone
config reconnect</a> - Re-authenticates user with remote.</li>
<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>
<li><a href="https://rclone.org/commands/rclone_config_touch/">rclone
config touch</a> - Ensure configuration file exists.</li>
<li><a href="https://rclone.org/commands/rclone_config_update/">rclone
config update</a> - Update options in an existing remote.</li>
<li><a href="https://rclone.org/commands/rclone_config_userinfo/">rclone
config userinfo</a> - Prints info about logged in user of remote.</li>
</ul>
<h1 id="rclone-copy">rclone copy</h1>
<p>Copy files from source to dest, skipping identical files.</p>
<h2 id="synopsis-1">Synopsis</h2>
<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>
<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>
<p>To copy single files, use the <a
href="https://rclone.org/commands/rclone_copyto/">copyto</a> command
instead.</p>
<p>If dest:path doesn’t exist, it is created and the source:path
contents go there.</p>
<p>For example</p>
<pre><code>rclone copy source:sourcepath dest:destpath</code></pre>
<p>Let’s say there are two files in sourcepath</p>
<pre><code>sourcepath/one.txt
sourcepath/two.txt</code></pre>
<p>This copies them to</p>
<pre><code>destpath/one.txt
destpath/two.txt</code></pre>
<p>Not to</p>
<pre><code>destpath/sourcepath/one.txt
destpath/sourcepath/two.txt</code></pre>
<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>
<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>
<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>
<pre><code>rclone copy --max-age 24h --no-traverse /path/to/src remote:</code></pre>
<p><strong>Note</strong>: Use the
<code>-P</code>/<code>--progress</code> flag to view real-time transfer
statistics.</p>
<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>
<pre><code>rclone copy source:path dest:path [flags]</code></pre>
<h2 id="options-1">Options</h2>
<pre><code>      --create-empty-src-dirs   Create empty source dirs on destination after copy
  -h, --help                    help for copy</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-1">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h1 id="rclone-sync">rclone sync</h1>
<p>Make source and dest identical, modifying destination only.</p>
<h2 id="synopsis-2">Synopsis</h2>
<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>
<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>
<pre><code>rclone sync -i SOURCE remote:DESTINATION</code></pre>
<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>
<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>
<p>If dest:path doesn’t exist, it is created and the source:path
contents go there.</p>
<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>
<p><strong>Note</strong>: Use the
<code>-P</code>/<code>--progress</code> flag to view real-time transfer
statistics</p>
<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>
<pre><code>rclone sync source:path dest:path [flags]</code></pre>
<h2 id="options-2">Options</h2>
<pre><code>      --create-empty-src-dirs   Create empty source dirs on destination after sync
  -h, --help                    help for sync</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-2">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h1 id="rclone-move">rclone move</h1>
<p>Move files from source to dest.</p>
<h2 id="synopsis-3">Synopsis</h2>
<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>
<p>To move single files, use the <a
href="https://rclone.org/commands/rclone_moveto/">moveto</a> command
instead.</p>
<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>
<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>
<p>If you want to delete empty source directories after move, use the
<code>--delete-empty-src-dirs</code> flag.</p>
<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>
<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>
<p><strong>Note</strong>: Use the
<code>-P</code>/<code>--progress</code> flag to view real-time transfer
statistics.</p>
<pre><code>rclone move source:path dest:path [flags]</code></pre>
<h2 id="options-3">Options</h2>
<pre><code>      --create-empty-src-dirs   Create empty source dirs on destination after move
      --delete-empty-src-dirs   Delete empty source dirs after move
  -h, --help                    help for move</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-3">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h1 id="rclone-delete">rclone delete</h1>
<p>Remove the files in path.</p>
<h2 id="synopsis-4">Synopsis</h2>
<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>
<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>
<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>
<p>For example, to delete all files bigger than 100 MiB, you may first
want to check what would be deleted (use either):</p>
<pre><code>rclone --min-size 100M lsl remote:path
rclone --dry-run --min-size 100M delete remote:path</code></pre>
<p>Then proceed with the actual delete:</p>
<pre><code>rclone --min-size 100M delete remote:path</code></pre>
<p>That reads “delete everything with a minimum size of 100 MiB”, hence
delete all files bigger than 100 MiB.</p>
<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>
<pre><code>rclone delete remote:path [flags]</code></pre>
<h2 id="options-4">Options</h2>
<pre><code>  -h, --help     help for delete
      --rmdirs   rmdirs removes empty directories but leaves root intact</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-4">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h1 id="rclone-purge">rclone purge</h1>
<p>Remove the path and all of its contents.</p>
<h2 id="synopsis-5">Synopsis</h2>
<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>
<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>
<pre><code>rclone purge remote:path [flags]</code></pre>
<h2 id="options-5">Options</h2>
<pre><code>  -h, --help   help for purge</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-5">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h1 id="rclone-mkdir">rclone mkdir</h1>
<p>Make the path if it doesn’t already exist.</p>
<pre><code>rclone mkdir remote:path [flags]</code></pre>
<h2 id="options-6">Options</h2>
<pre><code>  -h, --help   help for mkdir</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-6">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h1 id="rclone-rmdir">rclone rmdir</h1>
<p>Remove the empty directory at path.</p>
<h2 id="synopsis-6">Synopsis</h2>
<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>
<p>To delete a path and any objects in it, use <a
href="https://rclone.org/commands/rclone_purge/">purge</a> command.</p>
<pre><code>rclone rmdir remote:path [flags]</code></pre>
<h2 id="options-7">Options</h2>
<pre><code>  -h, --help   help for rmdir</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-7">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h1 id="rclone-check">rclone check</h1>
<p>Checks the files in the source and destination match.</p>
<h2 id="synopsis-7">Synopsis</h2>
<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>
<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 crypted files.</p>
<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>
<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>
<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>
<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>
<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>
<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>
<ul>
<li><code>= path</code> means path was found in source and destination
and was identical</li>
<li><code>- path</code> means path was missing on the source, so only in
the destination</li>
<li><code>+ path</code> means path was missing on the destination, so
only in the source</li>
<li><code>* path</code> means path was present in source and destination
but different.</li>
<li><code>! path</code> means there was an error reading or hashing the
source or dest.</li>
</ul>
<pre><code>rclone check source:path dest:path [flags]</code></pre>
<h2 id="options-8">Options</h2>
<pre><code>  -C, --checkfile string        Treat source:path as a SUM file with hashes of given type
      --combined string         Make a combined report of changes to this file
      --differ string           Report all non-matching files to this file
      --download                Check by downloading rather than with hash
      --error string            Report all files with errors (hashing or reading) to this file
  -h, --help                    help for check
      --match string            Report all matching files to this file
      --missing-on-dst string   Report all files missing from the destination to this file
      --missing-on-src string   Report all files missing from the source to this file
      --one-way                 Check one way only, source files must exist on remote</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-8">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h1 id="rclone-ls">rclone ls</h1>
<p>List the objects in the path with size and path.</p>
<h2 id="synopsis-8">Synopsis</h2>
<p>Lists the objects in the source path to standard output in a human
readable format with size and path. Recurses by default.</p>
<p>Eg</p>
<pre><code>$ rclone ls swift:bucket
    60295 bevajer5jef
    90613 canole
    94467 diwogej7
    37600 fubuwic</code></pre>
<p>Any of the filtering options can be applied to this command.</p>
<p>There are several related list commands</p>
<ul>
<li><code>ls</code> to list size and path of objects only</li>
<li><code>lsl</code> to list modification time, size and path of objects
only</li>
<li><code>lsd</code> to list directories only</li>
<li><code>lsf</code> to list objects and directories in easy to parse
format</li>
<li><code>lsjson</code> to list objects and directories in JSON
format</li>
</ul>
<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>
<p>Note that <code>ls</code> and <code>lsl</code> recurse by default -
use <code>--max-depth 1</code> to stop the recursion.</p>
<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>
<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>
<pre><code>rclone ls remote:path [flags]</code></pre>
<h2 id="options-9">Options</h2>
<pre><code>  -h, --help   help for ls</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-9">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h1 id="rclone-lsd">rclone lsd</h1>
<p>List all directories/containers/buckets in the path.</p>
<h2 id="synopsis-9">Synopsis</h2>
<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>
<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>
<pre><code>$ rclone lsd swift:
      494000 2018-04-26 08:43:20     10000 10000files
          65 2018-04-26 08:43:20         1 1File</code></pre>
<p>Or</p>
<pre><code>$ rclone lsd drive:test
          -1 2016-10-17 17:41:53        -1 1000files
          -1 2017-01-03 14:40:54        -1 2500files
          -1 2017-07-08 14:39:28        -1 4000files</code></pre>
<p>If you just want the directory names use
<code>rclone lsf --dirs-only</code>.</p>
<p>Any of the filtering options can be applied to this command.</p>
<p>There are several related list commands</p>
<ul>
<li><code>ls</code> to list size and path of objects only</li>
<li><code>lsl</code> to list modification time, size and path of objects
only</li>
<li><code>lsd</code> to list directories only</li>
<li><code>lsf</code> to list objects and directories in easy to parse
format</li>
<li><code>lsjson</code> to list objects and directories in JSON
format</li>
</ul>
<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>
<p>Note that <code>ls</code> and <code>lsl</code> recurse by default -
use <code>--max-depth 1</code> to stop the recursion.</p>
<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>
<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>
<pre><code>rclone lsd remote:path [flags]</code></pre>
<h2 id="options-10">Options</h2>
<pre><code>  -h, --help        help for lsd
  -R, --recursive   Recurse into the listing</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-10">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h1 id="rclone-lsl">rclone lsl</h1>
<p>List the objects in path with modification time, size and path.</p>
<h2 id="synopsis-10">Synopsis</h2>
<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>
<p>Eg</p>
<pre><code>$ rclone lsl swift:bucket
    60295 2016-06-25 18:55:41.062626927 bevajer5jef
    90613 2016-06-25 18:55:43.302607074 canole
    94467 2016-06-25 18:55:43.046609333 diwogej7
    37600 2016-06-25 18:55:40.814629136 fubuwic</code></pre>
<p>Any of the filtering options can be applied to this command.</p>
<p>There are several related list commands</p>
<ul>
<li><code>ls</code> to list size and path of objects only</li>
<li><code>lsl</code> to list modification time, size and path of objects
only</li>
<li><code>lsd</code> to list directories only</li>
<li><code>lsf</code> to list objects and directories in easy to parse
format</li>
<li><code>lsjson</code> to list objects and directories in JSON
format</li>
</ul>
<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>
<p>Note that <code>ls</code> and <code>lsl</code> recurse by default -
use <code>--max-depth 1</code> to stop the recursion.</p>
<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>
<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>
<pre><code>rclone lsl remote:path [flags]</code></pre>
<h2 id="options-11">Options</h2>
<pre><code>  -h, --help   help for lsl</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-11">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h1 id="rclone-md5sum">rclone md5sum</h1>
<p>Produces an md5sum file for all the objects in the path.</p>
<h2 id="synopsis-11">Synopsis</h2>
<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>
<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>
<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>
<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>
<pre><code>rclone md5sum remote:path [flags]</code></pre>
<h2 id="options-12">Options</h2>
<pre><code>      --base64               Output base64 encoded hashsum
  -C, --checkfile string     Validate hashes against a given SUM file instead of printing them
      --download             Download the file and hash it locally; if this flag is not specified, the hash is requested from the remote
  -h, --help                 help for md5sum
      --output-file string   Output hashsums to a file rather than the terminal</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-12">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h1 id="rclone-sha1sum">rclone sha1sum</h1>
<p>Produces an sha1sum file for all the objects in the path.</p>
<h2 id="synopsis-12">Synopsis</h2>
<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>
<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>
<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>
<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>
<p>This command can also hash data received on STDIN, if not passing a
remote:path.</p>
<pre><code>rclone sha1sum remote:path [flags]</code></pre>
<h2 id="options-13">Options</h2>
<pre><code>      --base64               Output base64 encoded hashsum
  -C, --checkfile string     Validate hashes against a given SUM file instead of printing them
      --download             Download the file and hash it locally; if this flag is not specified, the hash is requested from the remote
  -h, --help                 help for sha1sum
      --output-file string   Output hashsums to a file rather than the terminal</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-13">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h1 id="rclone-size">rclone size</h1>
<p>Prints the total size and number of objects in remote:path.</p>
<h2 id="synopsis-13">Synopsis</h2>
<p>Counts objects in the path and calculates the total size. Prints the
result to standard output.</p>
<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>
<p>Recurses by default, use <code>--max-depth 1</code> to stop the
recursion.</p>
<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
Drive</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>
<pre><code>rclone size remote:path [flags]</code></pre>
<h2 id="options-14">Options</h2>
<pre><code>  -h, --help   help for size
      --json   Format output as JSON</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-14">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h1 id="rclone-version">rclone version</h1>
<p>Show the version number.</p>
<h2 id="synopsis-14">Synopsis</h2>
<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>
<p>For example:</p>
<pre><code>$ rclone version
rclone v1.55.0
- os/version: ubuntu 18.04 (64 bit)
- os/kernel: 4.15.0-136-generic (x86_64)
- os/type: linux
- os/arch: amd64
- go/version: go1.16
- go/linking: static
- go/tags: none</code></pre>
<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>
<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>
<pre><code>$ rclone version --check
yours:  1.42.0.6
latest: 1.42          (released 2018-06-16)
beta:   1.42.0.5      (released 2018-06-17)</code></pre>
<p>Or</p>
<pre><code>$ rclone version --check
yours:  1.41
latest: 1.42          (released 2018-06-16)
  upgrade: https://downloads.rclone.org/v1.42
beta:   1.42.0.5      (released 2018-06-17)
  upgrade: https://beta.rclone.org/v1.42-005-g56e1e820</code></pre>
<pre><code>rclone version [flags]</code></pre>
<h2 id="options-15">Options</h2>
<pre><code>      --check   Check for new version
  -h, --help    help for version</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-15">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h1 id="rclone-cleanup">rclone cleanup</h1>
<p>Clean up the remote if possible.</p>
<h2 id="synopsis-15">Synopsis</h2>
<p>Clean up the remote if possible. Empty the trash or delete old file
versions. Not supported by all remotes.</p>
<pre><code>rclone cleanup remote:path [flags]</code></pre>
<h2 id="options-16">Options</h2>
<pre><code>  -h, --help   help for cleanup</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-16">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h1 id="rclone-dedupe">rclone dedupe</h1>
<p>Interactively find duplicate filenames and delete/rename them.</p>
<h2 id="synopsis-16">Synopsis</h2>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<p>Here is an example run.</p>
<p>Before - with duplicates</p>
<pre><code>$ rclone lsl drive:dupes
  6048320 2016-03-05 16:23:16.798000000 one.txt
  6048320 2016-03-05 16:23:11.775000000 one.txt
   564374 2016-03-05 16:23:06.731000000 one.txt
  6048320 2016-03-05 16:18:26.092000000 one.txt
  6048320 2016-03-05 16:22:46.185000000 two.txt
  1744073 2016-03-05 16:22:38.104000000 two.txt
   564374 2016-03-05 16:22:52.118000000 two.txt</code></pre>
<p>Now the <code>dedupe</code> session</p>
<pre><code>$ rclone dedupe drive:dupes
2016/03/05 16:24:37 Google drive root &#39;dupes&#39;: Looking for duplicates using interactive mode.
one.txt: Found 4 files with duplicate names
one.txt: Deleting 2/3 identical duplicates (MD5 &quot;1eedaa9fe86fd4b8632e2ac549403b36&quot;)
one.txt: 2 duplicates remain
  1:      6048320 bytes, 2016-03-05 16:23:16.798000000, MD5 1eedaa9fe86fd4b8632e2ac549403b36
  2:       564374 bytes, 2016-03-05 16:23:06.731000000, MD5 7594e7dc9fc28f727c42ee3e0749de81
s) Skip and do nothing
k) Keep just one (choose which in next step)
r) Rename all to be different (by changing file.jpg to file-1.jpg)
s/k/r&gt; k
Enter the number of the file to keep&gt; 1
one.txt: Deleted 1 extra copies
two.txt: Found 3 files with duplicate names
two.txt: 3 duplicates remain
  1:       564374 bytes, 2016-03-05 16:22:52.118000000, MD5 7594e7dc9fc28f727c42ee3e0749de81
  2:      6048320 bytes, 2016-03-05 16:22:46.185000000, MD5 1eedaa9fe86fd4b8632e2ac549403b36
  3:      1744073 bytes, 2016-03-05 16:22:38.104000000, MD5 851957f7fb6f0bc4ce76be966d336802
s) Skip and do nothing
k) Keep just one (choose which in next step)
r) Rename all to be different (by changing file.jpg to file-1.jpg)
s/k/r&gt; r
two-1.txt: renamed from: two.txt
two-2.txt: renamed from: two.txt
two-3.txt: renamed from: two.txt</code></pre>
<p>The result being</p>
<pre><code>$ rclone lsl drive:dupes
  6048320 2016-03-05 16:23:16.798000000 one.txt
   564374 2016-03-05 16:22:52.118000000 two-1.txt
  6048320 2016-03-05 16:22:46.185000000 two-2.txt
  1744073 2016-03-05 16:22:38.104000000 two-3.txt</code></pre>
<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>
<ul>
<li><code>--dedupe-mode interactive</code> - interactive as above.</li>
<li><code>--dedupe-mode skip</code> - removes identical files then skips
anything left.</li>
<li><code>--dedupe-mode first</code> - removes identical files then
keeps the first one.</li>
<li><code>--dedupe-mode newest</code> - removes identical files then
keeps the newest one.</li>
<li><code>--dedupe-mode oldest</code> - removes identical files then
keeps the oldest one.</li>
<li><code>--dedupe-mode largest</code> - removes identical files then
keeps the largest one.</li>
<li><code>--dedupe-mode smallest</code> - removes identical files then
keeps the smallest one.</li>
<li><code>--dedupe-mode rename</code> - removes identical files then
renames the rest to be different.</li>
<li><code>--dedupe-mode list</code> - lists duplicate dirs and files
only and changes nothing.</li>
</ul>
<p>For example, to rename all the identically named photos in your
Google Photos directory, do</p>
<pre><code>rclone dedupe --dedupe-mode rename &quot;drive:Google Photos&quot;</code></pre>
<p>Or</p>
<pre><code>rclone dedupe rename &quot;drive:Google Photos&quot;</code></pre>
<pre><code>rclone dedupe [mode] remote:path [flags]</code></pre>
<h2 id="options-17">Options</h2>
<pre><code>      --by-hash              Find identical hashes rather than names
      --dedupe-mode string   Dedupe mode interactive|skip|first|newest|oldest|largest|smallest|rename (default &quot;interactive&quot;)
  -h, --help                 help for dedupe</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-17">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h1 id="rclone-about">rclone about</h1>
<p>Get quota information from the remote.</p>
<h2 id="synopsis-17">Synopsis</h2>
<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>
<p>E.g. Typical output from <code>rclone about remote:</code> is:</p>
<pre><code>Total:   17 GiB
Used:    7.444 GiB
Free:    1.315 GiB
Trashed: 100.000 MiB
Other:   8.241 GiB</code></pre>
<p>Where the fields are:</p>
<ul>
<li>Total: Total size available.</li>
<li>Used: Total size used.</li>
<li>Free: Total space available to this user.</li>
<li>Trashed: Total space used by trash.</li>
<li>Other: Total amount in other storage (e.g. Gmail, Google
Photos).</li>
<li>Objects: Total number of objects in the storage.</li>
</ul>
<p>All sizes are in number of bytes.</p>
<p>Applying a <code>--full</code> flag to the command prints the bytes
in full, e.g.</p>
<pre><code>Total:   18253611008
Used:    7993453766
Free:    1411001220
Trashed: 104857602
Other:   8849156022</code></pre>
<p>A <code>--json</code> flag generates conveniently machine-readable
output, e.g.</p>
<pre><code>{
    &quot;total&quot;: 18253611008,
    &quot;used&quot;: 7993453766,
    &quot;trashed&quot;: 104857602,
    &quot;other&quot;: 8849156022,
    &quot;free&quot;: 1411001220
}</code></pre>
<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>
<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>
<pre><code>rclone about remote: [flags]</code></pre>
<h2 id="options-18">Options</h2>
<pre><code>      --full   Full numbers instead of human-readable
  -h, --help   help for about
      --json   Format output as JSON</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-18">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h1 id="rclone-authorize">rclone authorize</h1>
<p>Remote authorization.</p>
<h2 id="synopsis-18">Synopsis</h2>
<p>Remote authorization. Used to authorize a remote or headless rclone
from a machine with a browser - use as instructed by rclone config.</p>
<p>Use the –auth-no-open-browser to prevent rclone to open auth link in
default browser automatically.</p>
<pre><code>rclone authorize [flags]</code></pre>
<h2 id="options-19">Options</h2>
<pre><code>      --auth-no-open-browser   Do not automatically open auth link in default browser
  -h, --help                   help for authorize</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-19">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h1 id="rclone-backend">rclone backend</h1>
<p>Run a backend-specific command.</p>
<h2 id="synopsis-19">Synopsis</h2>
<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>
<p>You can discover what commands a backend implements by using</p>
<pre><code>rclone backend help remote:
rclone backend help &lt;backendname&gt;</code></pre>
<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>
<pre><code>rclone backend features remote:</code></pre>
<p>Pass options to the backend command with -o. This should be key=value
or key, e.g.:</p>
<pre><code>rclone backend stats remote:path stats -o format=json -o long</code></pre>
<p>Pass arguments to the backend by placing them on the end of the
line</p>
<pre><code>rclone backend cleanup remote:path file1 file2 file3</code></pre>
<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>
<pre><code>rclone backend &lt;command&gt; remote:path [opts] &lt;args&gt; [flags]</code></pre>
<h2 id="options-20">Options</h2>
<pre><code>  -h, --help                 help for backend
      --json                 Always output in JSON format
  -o, --option stringArray   Option in the form name=value or name</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-20">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h1 id="rclone-bisync">rclone bisync</h1>
<p>Perform bidirectional synchronization between two paths.</p>
<h2 id="synopsis-20">Synopsis</h2>
<p>Perform bidirectional synchronization between two paths.</p>
<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>
<p>See <a href="https://rclone.org/bisync/">full bisync description</a>
for details.</p>
<pre><code>rclone bisync remote1:path1 remote2:path2 [flags]</code></pre>
<h2 id="options-21">Options</h2>
<pre><code>      --check-access            Ensure expected RCLONE_TEST files are found on both Path1 and Path2 filesystems, else abort.
      --check-filename string   Filename for --check-access (default: RCLONE_TEST)
      --check-sync string       Controls comparison of final listings: true|false|only (default: true) (default &quot;true&quot;)
      --filters-file string     Read filtering patterns from a file
      --force                   Bypass --max-delete safety check and run the sync. Consider using with --verbose
  -h, --help                    help for bisync
      --localtime               Use local time in listings (default: UTC)
      --no-cleanup              Retain working files (useful for troubleshooting and testing).
      --remove-empty-dirs       Remove empty directories at the final cleanup step.
  -1, --resync                  Performs the resync run. Path1 files may overwrite Path2 versions. Consider using --verbose or --dry-run first.
      --workdir string          Use custom working dir - useful for testing. (default: $HOME/.cache/rclone/bisync)</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-21">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h1 id="rclone-cat">rclone cat</h1>
<p>Concatenates any files and sends them to stdout.</p>
<h2 id="synopsis-21">Synopsis</h2>
<p>rclone cat sends any files to standard output.</p>
<p>You can use it like this to output a single file</p>
<pre><code>rclone cat remote:path/to/file</code></pre>
<p>Or like this to output any file in dir or its subdirectories.</p>
<pre><code>rclone cat remote:path/to/dir</code></pre>
<p>Or like this to output any .txt files in dir or its
subdirectories.</p>
<pre><code>rclone --include &quot;*.txt&quot; cat remote:path/to/dir</code></pre>
<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>
<pre><code>rclone cat remote:path [flags]</code></pre>
<h2 id="options-22">Options</h2>
<pre><code>      --count int    Only print N characters (default -1)
      --discard      Discard the output instead of printing
      --head int     Only print the first N characters
  -h, --help         help for cat
      --offset int   Start printing at offset N (or from end if -ve)
      --tail int     Only print the last N characters</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-22">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h1 id="rclone-checksum">rclone checksum</h1>
<p>Checks the files in the source against a SUM file.</p>
<h2 id="synopsis-22">Synopsis</h2>
<p>Checks that hashsums of source 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>
<p>If you supply the <code>--download</code> flag, it will download the
data from remote and calculate the contents 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>
<p>Note that hash values in the SUM file are treated as case
insensitive.</p>
<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>
<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>
<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>
<ul>
<li><code>= path</code> means path was found in source and destination
and was identical</li>
<li><code>- path</code> means path was missing on the source, so only in
the destination</li>
<li><code>+ path</code> means path was missing on the destination, so
only in the source</li>
<li><code>* path</code> means path was present in source and destination
but different.</li>
<li><code>! path</code> means there was an error reading or hashing the
source or dest.</li>
</ul>
<pre><code>rclone checksum &lt;hash&gt; sumfile src:path [flags]</code></pre>
<h2 id="options-23">Options</h2>
<pre><code>      --combined string         Make a combined report of changes to this file
      --differ string           Report all non-matching files to this file
      --download                Check by hashing the contents
      --error string            Report all files with errors (hashing or reading) to this file
  -h, --help                    help for checksum
      --match string            Report all matching files to this file
      --missing-on-dst string   Report all files missing from the destination to this file
      --missing-on-src string   Report all files missing from the source to this file
      --one-way                 Check one way only, source files must exist on remote</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-23">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h1 id="rclone-completion">rclone completion</h1>
<p>Generate the autocompletion script for the specified shell</p>
<h2 id="synopsis-23">Synopsis</h2>
<p>Generate the autocompletion script for rclone for the specified
shell. See each sub-command’s help for details on how to use the
generated script.</p>
<h2 id="options-24">Options</h2>
<pre><code>  -h, --help   help for completion</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-24">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
<li><a href="https://rclone.org/commands/rclone_completion_bash/">rclone
completion bash</a> - Generate the autocompletion script for bash</li>
<li><a href="https://rclone.org/commands/rclone_completion_fish/">rclone
completion fish</a> - Generate the autocompletion script for fish</li>
<li><a
href="https://rclone.org/commands/rclone_completion_powershell/">rclone
completion powershell</a> - Generate the autocompletion script for
powershell</li>
<li><a href="https://rclone.org/commands/rclone_completion_zsh/">rclone
completion zsh</a> - Generate the autocompletion script for zsh</li>
</ul>
<h1 id="rclone-completion-bash">rclone completion bash</h1>
<p>Generate the autocompletion script for bash</p>
<h2 id="synopsis-24">Synopsis</h2>
<p>Generate the autocompletion script for the bash shell.</p>
<p>This script depends on the ‘bash-completion’ package. If it is not
installed already, you can install it via your OS’s package manager.</p>
<p>To load completions in your current shell session:</p>
<pre><code>source &lt;(rclone completion bash)</code></pre>
<p>To load completions for every new session, execute once:</p>
<h3 id="linux">Linux:</h3>
<pre><code>rclone completion bash &gt; /etc/bash_completion.d/rclone</code></pre>
<h3 id="macos">macOS:</h3>
<pre><code>rclone completion bash &gt; $(brew --prefix)/etc/bash_completion.d/rclone</code></pre>
<p>You will need to start a new shell for this setup to take effect.</p>
<pre><code>rclone completion bash</code></pre>
<h2 id="options-25">Options</h2>
<pre><code>  -h, --help              help for bash
      --no-descriptions   disable completion descriptions</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-25">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone_completion/">rclone
completion</a> - Generate the autocompletion script for the specified
shell</li>
</ul>
<h1 id="rclone-completion-fish">rclone completion fish</h1>
<p>Generate the autocompletion script for fish</p>
<h2 id="synopsis-25">Synopsis</h2>
<p>Generate the autocompletion script for the fish shell.</p>
<p>To load completions in your current shell session:</p>
<pre><code>rclone completion fish | source</code></pre>
<p>To load completions for every new session, execute once:</p>
<pre><code>rclone completion fish &gt; ~/.config/fish/completions/rclone.fish</code></pre>
<p>You will need to start a new shell for this setup to take effect.</p>
<pre><code>rclone completion fish [flags]</code></pre>
<h2 id="options-26">Options</h2>
<pre><code>  -h, --help              help for fish
      --no-descriptions   disable completion descriptions</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-26">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone_completion/">rclone
completion</a> - Generate the autocompletion script for the specified
shell</li>
</ul>
<h1 id="rclone-completion-powershell">rclone completion powershell</h1>
<p>Generate the autocompletion script for powershell</p>
<h2 id="synopsis-26">Synopsis</h2>
<p>Generate the autocompletion script for powershell.</p>
<p>To load completions in your current shell session:</p>
<pre><code>rclone completion powershell | Out-String | Invoke-Expression</code></pre>
<p>To load completions for every new session, add the output of the
above command to your powershell profile.</p>
<pre><code>rclone completion powershell [flags]</code></pre>
<h2 id="options-27">Options</h2>
<pre><code>  -h, --help              help for powershell
      --no-descriptions   disable completion descriptions</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-27">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone_completion/">rclone
completion</a> - Generate the autocompletion script for the specified
shell</li>
</ul>
<h1 id="rclone-completion-zsh">rclone completion zsh</h1>
<p>Generate the autocompletion script for zsh</p>
<h2 id="synopsis-27">Synopsis</h2>
<p>Generate the autocompletion script for the zsh shell.</p>
<p>If shell completion is not already enabled in your environment you
will need to enable it. You can execute the following once:</p>
<pre><code>echo &quot;autoload -U compinit; compinit&quot; &gt;&gt; ~/.zshrc</code></pre>
<p>To load completions in your current shell session:</p>
<pre><code>source &lt;(rclone completion zsh); compdef _rclone rclone</code></pre>
<p>To load completions for every new session, execute once:</p>
<h3 id="linux-1">Linux:</h3>
<pre><code>rclone completion zsh &gt; &quot;${fpath[1]}/_rclone&quot;</code></pre>
<h3 id="macos-1">macOS:</h3>
<pre><code>rclone completion zsh &gt; $(brew --prefix)/share/zsh/site-functions/_rclone</code></pre>
<p>You will need to start a new shell for this setup to take effect.</p>
<pre><code>rclone completion zsh [flags]</code></pre>
<h2 id="options-28">Options</h2>
<pre><code>  -h, --help              help for zsh
      --no-descriptions   disable completion descriptions</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-28">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone_completion/">rclone
completion</a> - Generate the autocompletion script for the specified
shell</li>
</ul>
<h1 id="rclone-config-create">rclone config create</h1>
<p>Create a new remote with name, type and options.</p>
<h2 id="synopsis-28">Synopsis</h2>
<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>
<p>For example, to make a swift remote of name myremote using auto
config you would do:</p>
<pre><code>rclone config create myremote swift env_auth true
rclone config create myremote swift env_auth=true</code></pre>
<p>So for example if you wanted to configure a Google Drive remote but
using remote authorization you would do this:</p>
<pre><code>rclone config create mydrive drive config_is_local=false</code></pre>
<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>
<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>
<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>
<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>
<p>This will look something like (some irrelevant detail removed):</p>
<pre><code>{
    &quot;State&quot;: &quot;*oauth-islocal,teamdrive,,&quot;,
    &quot;Option&quot;: {
        &quot;Name&quot;: &quot;config_is_local&quot;,
        &quot;Help&quot;: &quot;Use auto config?\n * Say Y if not sure\n * Say N if you are working on a remote or headless machine\n&quot;,
        &quot;Default&quot;: true,
        &quot;Examples&quot;: [
            {
                &quot;Value&quot;: &quot;true&quot;,
                &quot;Help&quot;: &quot;Yes&quot;
            },
            {
                &quot;Value&quot;: &quot;false&quot;,
                &quot;Help&quot;: &quot;No&quot;
            }
        ],
        &quot;Required&quot;: false,
        &quot;IsPassword&quot;: false,
        &quot;Type&quot;: &quot;bool&quot;,
        &quot;Exclusive&quot;: true,
    },
    &quot;Error&quot;: &quot;&quot;,
}</code></pre>
<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>
<p>The keys of <code>Option</code> are used as follows:</p>
<ul>
<li><code>Name</code> - name of variable - show to user</li>
<li><code>Help</code> - help text. Hard wrapped at 80 chars. Any URLs
should be clicky.</li>
<li><code>Default</code> - default value - return this if the user just
wants the default.</li>
<li><code>Examples</code> - the user should be able to choose one of
these</li>
<li><code>Required</code> - the value should be non-empty</li>
<li><code>IsPassword</code> - the value is a password and should be
edited as such</li>
<li><code>Type</code> - type of value, eg <code>bool</code>,
<code>string</code>, <code>int</code> and others</li>
<li><code>Exclusive</code> - if set no free-form entry allowed only the
<code>Examples</code></li>
<li>Irrelevant keys <code>Provider</code>, <code>ShortOpt</code>,
<code>Hide</code>, <code>NoPrefix</code>, <code>Advanced</code></li>
</ul>
<p>If <code>Error</code> is set then it should be shown to the user at
the same time as the question.</p>
<pre><code>rclone config update name --continue --state &quot;*oauth-islocal,teamdrive,,&quot; --result &quot;true&quot;</code></pre>
<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>
<p>At the end of the non interactive process, rclone will return a
result with <code>State</code> as empty string.</p>
<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>
<p>Note that <code>bin/config.py</code> in the rclone source implements
this protocol as a readable demonstration.</p>
<pre><code>rclone config create name type [key value]* [flags]</code></pre>
<h2 id="options-29">Options</h2>
<pre><code>      --all               Ask the full set of config questions
      --continue          Continue the configuration process with an answer
  -h, --help              help for create
      --no-obscure        Force any passwords not to be obscured
      --non-interactive   Don&#39;t interact with user and return questions
      --obscure           Force any passwords to be obscured
      --result string     Result - use with --continue
      --state string      State - use with --continue</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-29">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone_config/">rclone
config</a> - Enter an interactive configuration session.</li>
</ul>
<h1 id="rclone-config-delete">rclone config delete</h1>
<p>Delete an existing remote.</p>
<pre><code>rclone config delete name [flags]</code></pre>
<h2 id="options-30">Options</h2>
<pre><code>  -h, --help   help for delete</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-30">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone_config/">rclone
config</a> - Enter an interactive configuration session.</li>
</ul>
<h1 id="rclone-config-disconnect">rclone config disconnect</h1>
<p>Disconnects user from remote</p>
<h2 id="synopsis-29">Synopsis</h2>
<p>This disconnects the remote: passed in to the cloud storage
system.</p>
<p>This normally means revoking the oauth token.</p>
<p>To reconnect use “rclone config reconnect”.</p>
<pre><code>rclone config disconnect remote: [flags]</code></pre>
<h2 id="options-31">Options</h2>
<pre><code>  -h, --help   help for disconnect</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-31">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone_config/">rclone
config</a> - Enter an interactive configuration session.</li>
</ul>
<h1 id="rclone-config-dump">rclone config dump</h1>
<p>Dump the config file as JSON.</p>
<pre><code>rclone config dump [flags]</code></pre>
<h2 id="options-32">Options</h2>
<pre><code>  -h, --help   help for dump</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-32">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone_config/">rclone
config</a> - Enter an interactive configuration session.</li>
</ul>
<h1 id="rclone-config-edit">rclone config edit</h1>
<p>Enter an interactive configuration session.</p>
<h1 id="synopsis-30">Synopsis</h1>
<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>
<pre><code>rclone config edit [flags]</code></pre>
<h1 id="options-33">Options</h1>
<pre><code>  -h, --help   help for edit</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h1 id="see-also-33">SEE ALSO</h1>
<ul>
<li><a href="https://rclone.org/commands/rclone_config/">rclone
config</a> - Enter an interactive configuration session.</li>
</ul>
<h1 id="rclone-config-file">rclone config file</h1>
<p>Show path of configuration file in use.</p>
<pre><code>rclone config file [flags]</code></pre>
<h2 id="options-34">Options</h2>
<pre><code>  -h, --help   help for file</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-34">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone_config/">rclone
config</a> - Enter an interactive configuration session.</li>
</ul>
<h1 id="rclone-config-password">rclone config password</h1>
<p>Update password in an existing remote.</p>
<h2 id="synopsis-31">Synopsis</h2>
<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>
<p>For example, to set password of a remote of name myremote you would
do:</p>
<pre><code>rclone config password myremote fieldname mypassword
rclone config password myremote fieldname=mypassword</code></pre>
<p>This command is obsolete now that “config update” and “config create”
both support obscuring passwords directly.</p>
<pre><code>rclone config password name [key value]+ [flags]</code></pre>
<h2 id="options-35">Options</h2>
<pre><code>  -h, --help   help for password</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-35">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone_config/">rclone
config</a> - Enter an interactive configuration session.</li>
</ul>
<h1 id="rclone-config-paths">rclone config paths</h1>
<p>Show paths used for configuration, cache, temp etc.</p>
<pre><code>rclone config paths [flags]</code></pre>
<h2 id="options-36">Options</h2>
<pre><code>  -h, --help   help for paths</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-36">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone_config/">rclone
config</a> - Enter an interactive configuration session.</li>
</ul>
<h1 id="rclone-config-providers">rclone config providers</h1>
<p>List in JSON format all the providers and options.</p>
<pre><code>rclone config providers [flags]</code></pre>
<h2 id="options-37">Options</h2>
<pre><code>  -h, --help   help for providers</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-37">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone_config/">rclone
config</a> - Enter an interactive configuration session.</li>
</ul>
<h1 id="rclone-config-reconnect">rclone config reconnect</h1>
<p>Re-authenticates user with remote.</p>
<h2 id="synopsis-32">Synopsis</h2>
<p>This reconnects remote: passed in to the cloud storage system.</p>
<p>To disconnect the remote use “rclone config disconnect”.</p>
<p>This normally means going through the interactive oauth flow
again.</p>
<pre><code>rclone config reconnect remote: [flags]</code></pre>
<h2 id="options-38">Options</h2>
<pre><code>  -h, --help   help for reconnect</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-38">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone_config/">rclone
config</a> - Enter an interactive configuration session.</li>
</ul>
<h1 id="rclone-config-show">rclone config show</h1>
<p>Print (decrypted) config file, or the config for a single remote.</p>
<pre><code>rclone config show [&lt;remote&gt;] [flags]</code></pre>
<h2 id="options-39">Options</h2>
<pre><code>  -h, --help   help for show</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-39">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone_config/">rclone
config</a> - Enter an interactive configuration session.</li>
</ul>
<h1 id="rclone-config-touch">rclone config touch</h1>
<p>Ensure configuration file exists.</p>
<pre><code>rclone config touch [flags]</code></pre>
<h2 id="options-40">Options</h2>
<pre><code>  -h, --help   help for touch</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-40">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone_config/">rclone
config</a> - Enter an interactive configuration session.</li>
</ul>
<h1 id="rclone-config-update">rclone config update</h1>
<p>Update options in an existing remote.</p>
<h2 id="synopsis-33">Synopsis</h2>
<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>
<p>For example, to update the env_auth field of a remote of name
myremote you would do:</p>
<pre><code>rclone config update myremote env_auth true
rclone config update myremote env_auth=true</code></pre>
<p>If the remote uses OAuth the token will be updated, if you don’t
require this add an extra parameter thus:</p>
<pre><code>rclone config update myremote env_auth=true config_refresh_token=false</code></pre>
<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>
<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>
<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>
<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>
<p>This will look something like (some irrelevant detail removed):</p>
<pre><code>{
    &quot;State&quot;: &quot;*oauth-islocal,teamdrive,,&quot;,
    &quot;Option&quot;: {
        &quot;Name&quot;: &quot;config_is_local&quot;,
        &quot;Help&quot;: &quot;Use auto config?\n * Say Y if not sure\n * Say N if you are working on a remote or headless machine\n&quot;,
        &quot;Default&quot;: true,
        &quot;Examples&quot;: [
            {
                &quot;Value&quot;: &quot;true&quot;,
                &quot;Help&quot;: &quot;Yes&quot;
            },
            {
                &quot;Value&quot;: &quot;false&quot;,
                &quot;Help&quot;: &quot;No&quot;
            }
        ],
        &quot;Required&quot;: false,
        &quot;IsPassword&quot;: false,
        &quot;Type&quot;: &quot;bool&quot;,
        &quot;Exclusive&quot;: true,
    },
    &quot;Error&quot;: &quot;&quot;,
}</code></pre>
<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>
<p>The keys of <code>Option</code> are used as follows:</p>
<ul>
<li><code>Name</code> - name of variable - show to user</li>
<li><code>Help</code> - help text. Hard wrapped at 80 chars. Any URLs
should be clicky.</li>
<li><code>Default</code> - default value - return this if the user just
wants the default.</li>
<li><code>Examples</code> - the user should be able to choose one of
these</li>
<li><code>Required</code> - the value should be non-empty</li>
<li><code>IsPassword</code> - the value is a password and should be
edited as such</li>
<li><code>Type</code> - type of value, eg <code>bool</code>,
<code>string</code>, <code>int</code> and others</li>
<li><code>Exclusive</code> - if set no free-form entry allowed only the
<code>Examples</code></li>
<li>Irrelevant keys <code>Provider</code>, <code>ShortOpt</code>,
<code>Hide</code>, <code>NoPrefix</code>, <code>Advanced</code></li>
</ul>
<p>If <code>Error</code> is set then it should be shown to the user at
the same time as the question.</p>
<pre><code>rclone config update name --continue --state &quot;*oauth-islocal,teamdrive,,&quot; --result &quot;true&quot;</code></pre>
<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>
<p>At the end of the non interactive process, rclone will return a
result with <code>State</code> as empty string.</p>
<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>
<p>Note that <code>bin/config.py</code> in the rclone source implements
this protocol as a readable demonstration.</p>
<pre><code>rclone config update name [key value]+ [flags]</code></pre>
<h2 id="options-41">Options</h2>
<pre><code>      --all               Ask the full set of config questions
      --continue          Continue the configuration process with an answer
  -h, --help              help for update
      --no-obscure        Force any passwords not to be obscured
      --non-interactive   Don&#39;t interact with user and return questions
      --obscure           Force any passwords to be obscured
      --result string     Result - use with --continue
      --state string      State - use with --continue</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-41">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone_config/">rclone
config</a> - Enter an interactive configuration session.</li>
</ul>
<h1 id="rclone-config-userinfo">rclone config userinfo</h1>
<p>Prints info about logged in user of remote.</p>
<h2 id="synopsis-34">Synopsis</h2>
<p>This prints the details of the person logged in to the cloud storage
system.</p>
<pre><code>rclone config userinfo remote: [flags]</code></pre>
<h2 id="options-42">Options</h2>
<pre><code>  -h, --help   help for userinfo
      --json   Format output as JSON</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-42">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone_config/">rclone
config</a> - Enter an interactive configuration session.</li>
</ul>
<h1 id="rclone-copyto">rclone copyto</h1>
<p>Copy files from source to dest, skipping identical files.</p>
<h2 id="synopsis-35">Synopsis</h2>
<p>If source:path is a file or directory then it copies it to a file or
directory named dest:path.</p>
<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>
<p>So</p>
<pre><code>rclone copyto src dst</code></pre>
<p>where src and dst are rclone paths, either remote:path or
/path/to/local or C:.</p>
<p>This will:</p>
<pre><code>if src is file
    copy it to dst, overwriting an existing file if it exists
if src is directory
    copy it to dst, overwriting existing files if they exist
    see copy command for full details</code></pre>
<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>
<p><strong>Note</strong>: Use the
<code>-P</code>/<code>--progress</code> flag to view real-time transfer
statistics</p>
<pre><code>rclone copyto source:path dest:path [flags]</code></pre>
<h2 id="options-43">Options</h2>
<pre><code>  -h, --help   help for copyto</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-43">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h1 id="rclone-copyurl">rclone copyurl</h1>
<p>Copy url content to dest.</p>
<h2 id="synopsis-36">Synopsis</h2>
<p>Download a URL’s content and copy it to the destination without
saving it in temporary storage.</p>
<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. 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>
<p>Setting <code>--no-clobber</code> will prevent overwriting file on
the destination if there is one with the same name.</p>
<p>Setting <code>--stdout</code> or making the output file name
<code>-</code> will cause the output to be written to standard
output.</p>
<pre><code>rclone copyurl https://example.com dest:path [flags]</code></pre>
<h2 id="options-44">Options</h2>
<pre><code>  -a, --auto-filename     Get the file name from the URL and use it for destination file path
      --header-filename   Get the file name from the Content-Disposition header
  -h, --help              help for copyurl
      --no-clobber        Prevent overwriting file with same name
  -p, --print-filename    Print the resulting name from --auto-filename
      --stdout            Write the output to stdout rather than a file</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-44">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h1 id="rclone-cryptcheck">rclone cryptcheck</h1>
<p>Cryptcheck checks the integrity of a crypted remote.</p>
<h2 id="synopsis-37">Synopsis</h2>
<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 crypted remote.</p>
<p>For it to work the underlying remote of the cryptedremote must
support some kind of checksum.</p>
<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>
<p>Use it like this</p>
<pre><code>rclone cryptcheck /path/to/files encryptedremote:path</code></pre>
<p>You can use it like this also, but that will involve downloading all
the files in remote:path.</p>
<pre><code>rclone cryptcheck remote:path encryptedremote:path</code></pre>
<p>After it has run it will log the status of the encryptedremote:.</p>
<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>
<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>
<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>
<ul>
<li><code>= path</code> means path was found in source and destination
and was identical</li>
<li><code>- path</code> means path was missing on the source, so only in
the destination</li>
<li><code>+ path</code> means path was missing on the destination, so
only in the source</li>
<li><code>* path</code> means path was present in source and destination
but different.</li>
<li><code>! path</code> means there was an error reading or hashing the
source or dest.</li>
</ul>
<pre><code>rclone cryptcheck remote:path cryptedremote:path [flags]</code></pre>
<h2 id="options-45">Options</h2>
<pre><code>      --combined string         Make a combined report of changes to this file
      --differ string           Report all non-matching files to this file
      --error string            Report all files with errors (hashing or reading) to this file
  -h, --help                    help for cryptcheck
      --match string            Report all matching files to this file
      --missing-on-dst string   Report all files missing from the destination to this file
      --missing-on-src string   Report all files missing from the source to this file
      --one-way                 Check one way only, source files must exist on remote</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-45">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h1 id="rclone-cryptdecode">rclone cryptdecode</h1>
<p>Cryptdecode returns unencrypted file names.</p>
<h2 id="synopsis-38">Synopsis</h2>
<p>rclone cryptdecode returns unencrypted file names when provided with
a list of encrypted file names. List limit is 10 items.</p>
<p>If you supply the <code>--reverse</code> flag, it will return
encrypted file names.</p>
<p>use it like this</p>
<pre><code>rclone cryptdecode encryptedremote: encryptedfilename1 encryptedfilename2

rclone cryptdecode --reverse encryptedremote: filename1 filename2</code></pre>
<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>
<pre><code>rclone cryptdecode encryptedremote: encryptedfilename [flags]</code></pre>
<h2 id="options-46">Options</h2>
<pre><code>  -h, --help      help for cryptdecode
      --reverse   Reverse cryptdecode, encrypts filenames</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-46">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h1 id="rclone-deletefile">rclone deletefile</h1>
<p>Remove a single file from remote.</p>
<h2 id="synopsis-39">Synopsis</h2>
<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>
<pre><code>rclone deletefile remote:path [flags]</code></pre>
<h2 id="options-47">Options</h2>
<pre><code>  -h, --help   help for deletefile</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-47">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h1 id="rclone-genautocomplete">rclone genautocomplete</h1>
<p>Output completion script for a given shell.</p>
<h2 id="synopsis-40">Synopsis</h2>
<p>Generates a shell completion script for rclone. Run with
<code>--help</code> to list the supported shells.</p>
<h2 id="options-48">Options</h2>
<pre><code>  -h, --help   help for genautocomplete</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-48">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
<li><a
href="https://rclone.org/commands/rclone_genautocomplete_bash/">rclone
genautocomplete bash</a> - Output bash completion script for
rclone.</li>
<li><a
href="https://rclone.org/commands/rclone_genautocomplete_fish/">rclone
genautocomplete fish</a> - Output fish completion script for
rclone.</li>
<li><a
href="https://rclone.org/commands/rclone_genautocomplete_zsh/">rclone
genautocomplete zsh</a> - Output zsh completion script for rclone.</li>
</ul>
<h1 id="rclone-genautocomplete-bash">rclone genautocomplete bash</h1>
<p>Output bash completion script for rclone.</p>
<h2 id="synopsis-41">Synopsis</h2>
<p>Generates a bash shell autocompletion script for rclone.</p>
<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>
<pre><code>sudo rclone genautocomplete bash</code></pre>
<p>Logout and login again to use the autocompletion scripts, or source
them directly</p>
<pre><code>. /etc/bash_completion</code></pre>
<p>If you supply a command line argument the script will be written
there.</p>
<p>If output_file is “-”, then the output will be written to stdout.</p>
<pre><code>rclone genautocomplete bash [output_file] [flags]</code></pre>
<h2 id="options-49">Options</h2>
<pre><code>  -h, --help   help for bash</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-49">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone_genautocomplete/">rclone
genautocomplete</a> - Output completion script for a given shell.</li>
</ul>
<h1 id="rclone-genautocomplete-fish">rclone genautocomplete fish</h1>
<p>Output fish completion script for rclone.</p>
<h2 id="synopsis-42">Synopsis</h2>
<p>Generates a fish autocompletion script for rclone.</p>
<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>
<pre><code>sudo rclone genautocomplete fish</code></pre>
<p>Logout and login again to use the autocompletion scripts, or source
them directly</p>
<pre><code>. /etc/fish/completions/rclone.fish</code></pre>
<p>If you supply a command line argument the script will be written
there.</p>
<p>If output_file is “-”, then the output will be written to stdout.</p>
<pre><code>rclone genautocomplete fish [output_file] [flags]</code></pre>
<h2 id="options-50">Options</h2>
<pre><code>  -h, --help   help for fish</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-50">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone_genautocomplete/">rclone
genautocomplete</a> - Output completion script for a given shell.</li>
</ul>
<h1 id="rclone-genautocomplete-zsh">rclone genautocomplete zsh</h1>
<p>Output zsh completion script for rclone.</p>
<h2 id="synopsis-43">Synopsis</h2>
<p>Generates a zsh autocompletion script for rclone.</p>
<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>
<pre><code>sudo rclone genautocomplete zsh</code></pre>
<p>Logout and login again to use the autocompletion scripts, or source
them directly</p>
<pre><code>autoload -U compinit &amp;&amp; compinit</code></pre>
<p>If you supply a command line argument the script will be written
there.</p>
<p>If output_file is “-”, then the output will be written to stdout.</p>
<pre><code>rclone genautocomplete zsh [output_file] [flags]</code></pre>
<h2 id="options-51">Options</h2>
<pre><code>  -h, --help   help for zsh</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-51">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone_genautocomplete/">rclone
genautocomplete</a> - Output completion script for a given shell.</li>
</ul>
<h1 id="rclone-gendocs">rclone gendocs</h1>
<p>Output markdown docs for rclone to the directory supplied.</p>
<h2 id="synopsis-44">Synopsis</h2>
<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>
<pre><code>rclone gendocs output_directory [flags]</code></pre>
<h2 id="options-52">Options</h2>
<pre><code>  -h, --help   help for gendocs</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-52">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h1 id="rclone-hashsum">rclone hashsum</h1>
<p>Produces a hashsum file for all the objects in the path.</p>
<h2 id="synopsis-45">Synopsis</h2>
<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>
<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>
<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>
<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>
<p>Run without a hash to see the list of all supported hashes, e.g.</p>
<pre><code>$ rclone hashsum
Supported hashes are:
  * md5
  * sha1
  * whirlpool
  * crc32
  * sha256
  * dropbox
  * hidrive
  * mailru
  * quickxor</code></pre>
<p>Then</p>
<pre><code>$ rclone hashsum MD5 remote:path</code></pre>
<p>Note that hash names are case insensitive and values are output in
lower case.</p>
<pre><code>rclone hashsum &lt;hash&gt; remote:path [flags]</code></pre>
<h2 id="options-53">Options</h2>
<pre><code>      --base64               Output base64 encoded hashsum
  -C, --checkfile string     Validate hashes against a given SUM file instead of printing them
      --download             Download the file and hash it locally; if this flag is not specified, the hash is requested from the remote
  -h, --help                 help for hashsum
      --output-file string   Output hashsums to a file rather than the terminal</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-53">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h1 id="rclone-link">rclone link</h1>
<p>Generate public link to file/folder.</p>
<h2 id="synopsis-46">Synopsis</h2>
<p>rclone link will create, retrieve or remove a public link to the
given file or folder.</p>
<pre><code>rclone link remote:path/to/file
rclone link remote:path/to/folder/
rclone link --unlink remote:path/to/folder/
rclone link --expire 1d remote:path/to/file</code></pre>
<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>
<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>
<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>
<pre><code>rclone link remote:path [flags]</code></pre>
<h2 id="options-54">Options</h2>
<pre><code>      --expire Duration   The amount of time that the link will be valid (default off)
  -h, --help              help for link
      --unlink            Remove existing public link to file/folder</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-54">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h1 id="rclone-listremotes">rclone listremotes</h1>
<p>List all the remotes in the config file.</p>
<h2 id="synopsis-47">Synopsis</h2>
<p>rclone listremotes lists all the available remotes from the config
file.</p>
<p>When used with the <code>--long</code> flag it lists the types
too.</p>
<pre><code>rclone listremotes [flags]</code></pre>
<h2 id="options-55">Options</h2>
<pre><code>  -h, --help   help for listremotes
      --long   Show the type as well as names</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-55">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h1 id="rclone-lsf">rclone lsf</h1>
<p>List directories and objects in remote:path formatted for
parsing.</p>
<h2 id="synopsis-48">Synopsis</h2>
<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>
<p>Eg</p>
<pre><code>$ rclone lsf swift:bucket
bevajer5jef
canole
diwogej7
ferejej3gux/
fubuwic</code></pre>
<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>
<pre><code>p - path
s - size
t - modification time
h - hash
i - ID of object
o - Original ID of underlying object
m - MimeType of object if known
e - encrypted name
T - tier of storage if known, e.g. &quot;Hot&quot; or &quot;Cool&quot;
M - Metadata of object in JSON blob format, eg {&quot;key&quot;:&quot;value&quot;}</code></pre>
<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>
<p>Eg</p>
<pre><code>$ rclone lsf  --format &quot;tsp&quot; swift:bucket
2016-06-25 18:55:41;60295;bevajer5jef
2016-06-25 18:55:43;90613;canole
2016-06-25 18:55:43;94467;diwogej7
2018-04-26 08:50:45;0;ferejej3gux/
2016-06-25 18:55:40;37600;fubuwic</code></pre>
<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>
<p>For example, to emulate the md5sum command you can use</p>
<pre><code>rclone lsf -R --hash MD5 --format hp --separator &quot;  &quot; --files-only .</code></pre>
<p>Eg</p>
<pre><code>$ rclone lsf -R --hash MD5 --format hp --separator &quot;  &quot; --files-only swift:bucket
7908e352297f0f530b84a756f188baa3  bevajer5jef
cd65ac234e6fea5925974a51cdd865cc  canole
03b5341b4f234b9d984d03ad076bae91  diwogej7
8fd37c3810dd660778137ac3a66cc06d  fubuwic
99713e14a4c4ff553acaf1930fad985b  gixacuh7ku</code></pre>
<p>(Though “rclone md5sum .” is an easier way of typing this.)</p>
<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>
<p>Eg</p>
<pre><code>$ rclone lsf  --separator &quot;,&quot; --format &quot;tshp&quot; swift:bucket
2016-06-25 18:55:41,60295,7908e352297f0f530b84a756f188baa3,bevajer5jef
2016-06-25 18:55:43,90613,cd65ac234e6fea5925974a51cdd865cc,canole
2016-06-25 18:55:43,94467,03b5341b4f234b9d984d03ad076bae91,diwogej7
2018-04-26 08:52:53,0,,ferejej3gux/
2016-06-25 18:55:40,37600,8fd37c3810dd660778137ac3a66cc06d,fubuwic</code></pre>
<p>You can output in CSV standard format. This will escape things in ”
if they contain ,</p>
<p>Eg</p>
<pre><code>$ rclone lsf --csv --files-only --format ps remote:path
test.log,22355
test.sh,449
&quot;this file contains a comma, in the file name.txt&quot;,6</code></pre>
<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>
<p>For example, to find all the files modified within one day and copy
those only (without traversing the whole directory structure):</p>
<pre><code>rclone lsf --absolute --files-only --max-age 1d /path/to/local &gt; new_files
rclone copy --files-from-raw new_files /path/to/local remote:path</code></pre>
<p>Any of the filtering options can be applied to this command.</p>
<p>There are several related list commands</p>
<ul>
<li><code>ls</code> to list size and path of objects only</li>
<li><code>lsl</code> to list modification time, size and path of objects
only</li>
<li><code>lsd</code> to list directories only</li>
<li><code>lsf</code> to list objects and directories in easy to parse
format</li>
<li><code>lsjson</code> to list objects and directories in JSON
format</li>
</ul>
<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>
<p>Note that <code>ls</code> and <code>lsl</code> recurse by default -
use <code>--max-depth 1</code> to stop the recursion.</p>
<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>
<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>
<pre><code>rclone lsf remote:path [flags]</code></pre>
<h2 id="options-56">Options</h2>
<pre><code>      --absolute           Put a leading / in front of path names
      --csv                Output in CSV format
  -d, --dir-slash          Append a slash to directory names (default true)
      --dirs-only          Only list directories
      --files-only         Only list files
  -F, --format string      Output format - see  help for details (default &quot;p&quot;)
      --hash h             Use this hash when h is used in the format MD5|SHA-1|DropboxHash (default &quot;md5&quot;)
  -h, --help               help for lsf
  -R, --recursive          Recurse into the listing
  -s, --separator string   Separator for the items in the format (default &quot;;&quot;)</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-56">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h1 id="rclone-lsjson">rclone lsjson</h1>
<p>List directories and objects in the path in JSON format.</p>
<h2 id="synopsis-49">Synopsis</h2>
<p>List directories and objects in the path in JSON format.</p>
<p>The output is an array of Items, where each Item looks like this</p>
<pre><code>{
  &quot;Hashes&quot; : {
     &quot;SHA-1&quot; : &quot;f572d396fae9206628714fb2ce00f72e94f2258f&quot;,
     &quot;MD5&quot; : &quot;b1946ac92492d2347c6235b4d2611184&quot;,
     &quot;DropboxHash&quot; : &quot;ecb65bb98f9d905b70458986c39fcbad7715e5f2fcc3b1f07767d7c83e2438cc&quot;
  },
  &quot;ID&quot;: &quot;y2djkhiujf83u33&quot;,
  &quot;OrigID&quot;: &quot;UYOJVTUW00Q1RzTDA&quot;,
  &quot;IsBucket&quot; : false,
  &quot;IsDir&quot; : false,
  &quot;MimeType&quot; : &quot;application/octet-stream&quot;,
  &quot;ModTime&quot; : &quot;2017-05-31T16:15:57.034468261+01:00&quot;,
  &quot;Name&quot; : &quot;file.txt&quot;,
  &quot;Encrypted&quot; : &quot;v0qpsdq8anpci8n929v3uu9338&quot;,
  &quot;EncryptedPath&quot; : &quot;kja9098349023498/v0qpsdq8anpci8n929v3uu9338&quot;,
  &quot;Path&quot; : &quot;full/path/goes/here/file.txt&quot;,
  &quot;Size&quot; : 6,
  &quot;Tier&quot; : &quot;hot&quot;,
}</code></pre>
<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>
<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>
<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>
<p>If <code>--encrypted</code> is not specified the Encrypted won’t be
emitted.</p>
<p>If <code>--dirs-only</code> is not specified files in addition to
directories are returned</p>
<p>If <code>--files-only</code> is not specified directories in addition
to the files will be returned.</p>
<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>
<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>
<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>
<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>
<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>
<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>
<p>Any of the filtering options can be applied to this command.</p>
<p>There are several related list commands</p>
<ul>
<li><code>ls</code> to list size and path of objects only</li>
<li><code>lsl</code> to list modification time, size and path of objects
only</li>
<li><code>lsd</code> to list directories only</li>
<li><code>lsf</code> to list objects and directories in easy to parse
format</li>
<li><code>lsjson</code> to list objects and directories in JSON
format</li>
</ul>
<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>
<p>Note that <code>ls</code> and <code>lsl</code> recurse by default -
use <code>--max-depth 1</code> to stop the recursion.</p>
<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>
<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>
<pre><code>rclone lsjson remote:path [flags]</code></pre>
<h2 id="options-57">Options</h2>
<pre><code>      --dirs-only               Show only directories in the listing
      --encrypted               Show the encrypted names
      --files-only              Show only files in the listing
      --hash                    Include hashes in the output (may take longer)
      --hash-type stringArray   Show only this hash type (may be repeated)
  -h, --help                    help for lsjson
      --no-mimetype             Don&#39;t read the mime type (can speed things up)
      --no-modtime              Don&#39;t read the modification time (can speed things up)
      --original                Show the ID of the underlying Object
  -R, --recursive               Recurse into the listing
      --stat                    Just return the info for the pointed to file</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-57">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h1 id="rclone-mount">rclone mount</h1>
<p>Mount the remote as file system on a mountpoint.</p>
<h2 id="synopsis-50">Synopsis</h2>
<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>
<p>First set up your remote using <code>rclone config</code>. Check it
works with <code>rclone ls</code> etc.</p>
<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>
<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>
<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>
<pre><code>rclone mount remote:path/to/files /path/to/local/mount</code></pre>
<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>
<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>
<pre><code>rclone mount remote:path/to/files *
rclone mount remote:path/to/files X:
rclone mount remote:path/to/files C:\path\parent\mount
rclone mount remote:path/to/files \\cloud\remote</code></pre>
<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>
<p>When running in background mode the user will have to stop the mount
manually:</p>
<pre><code># Linux
fusermount -u /path/to/local/mount
# OS X
umount /path/to/local/mount</code></pre>
<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>
<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>
<h2 id="installing-on-windows">Installing on Windows</h2>
<p>To run rclone mount on Windows, you will need to download and install
<a href="http://www.secfs.net/winfsp/">WinFsp</a>.</p>
<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>
<h3 id="mounting-modes-on-windows">Mounting modes on windows</h3>
<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>
<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>
<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>
<pre><code>rclone mount remote:path/to/files *
rclone mount remote:path/to/files X:
rclone mount remote:path/to/files C:\path\parent\mount
rclone mount remote:path/to/files X:</code></pre>
<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>
<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>
<pre><code>rclone mount remote:path/to/files X: --network-mode</code></pre>
<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>
<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>
<pre><code>rclone mount remote:path/to/files X: --network-mode
rclone mount remote:path/to/files X: --volname \\server\share</code></pre>
<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>
<pre><code>rclone mount remote:path/to/files \\cloud\remote
rclone mount remote:path/to/files * --volname \\cloud\remote</code></pre>
<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>
<p><em>Note:</em> In previous versions of rclone this was the only
supported method.</p>
<p><a href="https://en.wikipedia.org/wiki/Drive_mapping">Read more about
drive mapping</a></p>
<p>See also <a href="#limitations">Limitations</a> section below.</p>
<h3 id="windows-filesystem-permissions">Windows filesystem
permissions</h3>
<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>
<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 <a
href="https://en.wikipedia.org/wiki/File-system_permissions#Numeric_notation">numeric
notation</a>.</p>
<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>).</p>
<p>Note that 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, 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” includes the “write extended attributes” permission.</p>
<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, such as “read attributes” and “read permissions”, in
Windows. 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. One case that may arise is that other programs
(incorrectly) interprets this as the file being accessible by everyone.
For example an SSH client may warn about “unprotected private key
file”.</p>
<p>WinFsp 2021 (version 1.9) introduces 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 can work around issues such as the mentioned “unprotected
private key file” by specifying
<code>-o FileSecurity="D:P(A;;FA;;;OW)"</code>, for file all access (FA)
to the owner (OW).</p>
<h3 id="windows-caveats">Windows caveats</h3>
<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>
<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>
<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>
<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>). 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. Read more in the <a href="https://rclone.org/install/">install
documentation</a>.</p>
<p>Note that mapping to a directory path, instead of a drive letter,
does not suffer from the same limitations.</p>
<h2 id="limitations">Limitations</h2>
<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.</p>
<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>
<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>
<p>Only supported on Linux, FreeBSD, OS X and Windows at the moment.</p>
<h2 id="rclone-mount-vs-rclone-synccopy">rclone mount vs rclone
sync/copy</h2>
<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>
<h2 id="attribute-caching">Attribute caching</h2>
<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>
<p>The default is <code>1s</code> which caches files just long enough to
avoid too many callbacks to rclone from the kernel.</p>
<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>
<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>
<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>
<p>If files don’t change on the remote outside of the control of rclone
then there is no chance of corruption.</p>
<p>This is the same as setting the attr_timeout option in
mount.fuse.</p>
<h2 id="filters">Filters</h2>
<p>Note that all the rclone filters can be used to select a subset of
the files to be visible in the mount.</p>
<h2 id="systemd">systemd</h2>
<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>
<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>
<h2 id="rclone-as-unix-mount-helper">Rclone as Unix mount helper</h2>
<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>
<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>
<p>Now you can run classic mounts like this:</p>
<pre><code>mount sftp1:subdir /mnt/data -t rclone -o vfs_cache_mode=writes,sftp_key_file=/path/to/pem</code></pre>
<p>or create systemd mount units:</p>
<pre><code># /etc/systemd/system/mnt-data.mount
[Unit]
After=network-online.target
[Mount]
Type=rclone
What=sftp1:subdir
Where=/mnt/data
Options=rw,allow_other,args2env,vfs-cache-mode=writes,config=/etc/rclone.conf,cache-dir=/var/rclone</code></pre>
<p>optionally accompanied by systemd automount unit</p>
<pre><code># /etc/systemd/system/mnt-data.automount
[Unit]
After=network-online.target
Before=remote-fs.target
[Automount]
Where=/mnt/data
TimeoutIdleSec=600
[Install]
WantedBy=multi-user.target</code></pre>
<p>or add in <code>/etc/fstab</code> a line like</p>
<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>
<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>
<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>
<p>Mount option syntax includes a few extra options treated
specially:</p>
<ul>
<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>
<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>
<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>
<li><code>vv...</code> will be transformed into appropriate
<code>--verbose=N</code></li>
<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.</li>
</ul>
<h2 id="vfs---virtual-file-system">VFS - Virtual File System</h2>
<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>
<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>
<p>The VFS layer also implements a directory cache - this caches info
about files and directories (but not the data) in memory.</p>
<h2 id="vfs-directory-cache">VFS Directory Cache</h2>
<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>
<pre><code>--dir-cache-time duration   Time to cache directory entries for (default 5m0s)
--poll-interval duration    Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable (default 1m0s)</code></pre>
<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>
<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>
<pre><code>kill -SIGHUP $(pidof rclone)</code></pre>
<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>
<pre><code>rclone rc vfs/forget</code></pre>
<p>Or individual files or directories:</p>
<pre><code>rclone rc vfs/forget file=path/to/file dir=path/to/dir</code></pre>
<h2 id="vfs-file-buffering">VFS File Buffering</h2>
<p>The <code>--buffer-size</code> flag determines the amount of memory,
that will be used to buffer data in advance.</p>
<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>
<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>
<p>The maximum memory used by rclone for buffering can be up to
<code>--buffer-size * open files</code>.</p>
<h2 id="vfs-file-caching">VFS File Caching</h2>
<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>
<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>
<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>
<pre><code>--cache-dir string                   Directory rclone will use for caching.
--vfs-cache-mode CacheMode           Cache mode off|minimal|writes|full (default off)
--vfs-cache-max-age duration         Max age of objects in the cache (default 1h0m0s)
--vfs-cache-max-size SizeSuffix      Max total size of objects in the cache (default off)
--vfs-cache-poll-interval duration   Interval to poll the cache for stale objects (default 1m0s)
--vfs-write-back duration            Time to writeback files after last use when using cache (default 5s)</code></pre>
<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>
<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>
<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>
<p>If using <code>--vfs-cache-max-size</code> note that the cache may
exceed this size 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.</p>
<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 &gt; 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>
<h3 id="vfs-cache-mode-off">–vfs-cache-mode off</h3>
<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>
<p>This will mean some operations are not possible</p>
<ul>
<li>Files can’t be opened for both read AND write</li>
<li>Files opened for write can’t be seeked</li>
<li>Existing files opened for write must have O_TRUNC set</li>
<li>Files open for read with O_TRUNC will be opened write only</li>
<li>Files open for write only will behave as if O_TRUNC was
supplied</li>
<li>Open modes O_APPEND, O_TRUNC are ignored</li>
<li>If an upload fails it can’t be retried</li>
</ul>
<h3 id="vfs-cache-mode-minimal">–vfs-cache-mode minimal</h3>
<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>
<p>These operations are not possible</p>
<ul>
<li>Files opened for write only can’t be seeked</li>
<li>Existing files opened for write must have O_TRUNC set</li>
<li>Files opened for write only will ignore O_APPEND, O_TRUNC</li>
<li>If an upload fails it can’t be retried</li>
</ul>
<h3 id="vfs-cache-mode-writes">–vfs-cache-mode writes</h3>
<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>
<p>This mode should support all normal file system operations.</p>
<p>If an upload fails it will be retried at exponentially increasing
intervals up to 1 minute.</p>
<h3 id="vfs-cache-mode-full">–vfs-cache-mode full</h3>
<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>
<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>
<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>
<p>This mode should support all normal file system operations and is
otherwise identical to <code>--vfs-cache-mode</code> writes.</p>
<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>
<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>
<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>
<h3 id="fingerprinting">Fingerprinting</h3>
<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>
<ul>
<li>size</li>
<li>modification time</li>
<li>hash</li>
</ul>
<p>where available on an object.</p>
<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>
<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>
<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>
<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>
<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>
<h2 id="vfs-chunked-reading">VFS Chunked Reading</h2>
<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>
<p>These flags control the chunking:</p>
<pre><code>--vfs-read-chunk-size SizeSuffix        Read the source objects in chunks (default 128M)
--vfs-read-chunk-size-limit SizeSuffix  Max chunk doubling size (default off)</code></pre>
<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>
<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>
<p>Setting <code>--vfs-read-chunk-size</code> to <code>0</code> or “off”
disables chunked reading.</p>
<h2 id="vfs-performance">VFS Performance</h2>
<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>
<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>
<pre><code>--no-checksum     Don&#39;t compare checksums on up/download.
--no-modtime      Don&#39;t read/write the modification time (can speed things up).
--no-seek         Don&#39;t allow seeking in files.
--read-only       Only allow read-only access.</code></pre>
<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>
<pre><code>--vfs-read-wait duration   Time to wait for in-sequence read before seeking (default 20ms)
--vfs-write-wait duration  Time to wait for in-sequence write before giving error (default 1s)</code></pre>
<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>
<pre><code>--transfers int  Number of file transfers to run in parallel (default 4)</code></pre>
<h2 id="vfs-case-sensitivity">VFS Case Sensitivity</h2>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<h2 id="vfs-disk-options">VFS Disk Options</h2>
<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>
<pre><code>--vfs-disk-space-total-size    Manually set the total disk space size (example: 256G, default: -1)</code></pre>
<h2 id="alternate-report-of-used-bytes">Alternate report of used
bytes</h2>
<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>
<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>
<pre><code>rclone mount remote:path /path/to/mountpoint [flags]</code></pre>
<h2 id="options-58">Options</h2>
<pre><code>      --allow-non-empty                        Allow mounting over a non-empty directory (not supported on Windows)
      --allow-other                            Allow access to other users (not supported on Windows)
      --allow-root                             Allow access to root user (not supported on Windows)
      --async-read                             Use asynchronous reads (not supported on Windows) (default true)
      --attr-timeout duration                  Time for which file/directory attributes are cached (default 1s)
      --daemon                                 Run mount in background and exit parent process (as background output is suppressed, use --log-file with --log-format=pid,... to monitor) (not supported on Windows)
      --daemon-timeout duration                Time limit for rclone to respond to kernel (not supported on Windows)
      --daemon-wait duration                   Time to wait for ready mount from daemon (maximum time on Linux, constant sleep time on OSX/BSD) (not supported on Windows) (default 1m0s)
      --debug-fuse                             Debug the FUSE internals - needs -v
      --default-permissions                    Makes kernel enforce access control based on the file mode (not supported on Windows)
      --devname string                         Set the device name - default is remote:path
      --dir-cache-time duration                Time to cache directory entries for (default 5m0s)
      --dir-perms FileMode                     Directory permissions (default 0777)
      --file-perms FileMode                    File permissions (default 0666)
      --fuse-flag stringArray                  Flags or arguments to be passed direct to libfuse/WinFsp (repeat if required)
      --gid uint32                             Override the gid field set by the filesystem (not supported on Windows) (default 1000)
  -h, --help                                   help for mount
      --max-read-ahead SizeSuffix              The number of bytes that can be prefetched for sequential reads (not supported on Windows) (default 128Ki)
      --network-mode                           Mount as remote network drive, instead of fixed disk drive (supported on Windows only)
      --no-checksum                            Don&#39;t compare checksums on up/download
      --no-modtime                             Don&#39;t read/write the modification time (can speed things up)
      --no-seek                                Don&#39;t allow seeking in files
      --noappledouble                          Ignore Apple Double (._) and .DS_Store files (supported on OSX only) (default true)
      --noapplexattr                           Ignore all &quot;com.apple.*&quot; extended attributes (supported on OSX only)
  -o, --option stringArray                     Option for libfuse/WinFsp (repeat if required)
      --poll-interval duration                 Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s)
      --read-only                              Only allow read-only access
      --uid uint32                             Override the uid field set by the filesystem (not supported on Windows) (default 1000)
      --umask int                              Override the permission bits set by the filesystem (not supported on Windows) (default 2)
      --vfs-cache-max-age duration             Max age of objects in the cache (default 1h0m0s)
      --vfs-cache-max-size SizeSuffix          Max total size of objects in the cache (default off)
      --vfs-cache-mode CacheMode               Cache mode off|minimal|writes|full (default off)
      --vfs-cache-poll-interval duration       Interval to poll the cache for stale objects (default 1m0s)
      --vfs-case-insensitive                   If a file name not found, find a case insensitive match
      --vfs-disk-space-total-size SizeSuffix   Specify the total space of disk (default off)
      --vfs-fast-fingerprint                   Use fast (less accurate) fingerprints for change detection
      --vfs-read-ahead SizeSuffix              Extra read ahead over --buffer-size when using cache-mode full
      --vfs-read-chunk-size SizeSuffix         Read the source objects in chunks (default 128Mi)
      --vfs-read-chunk-size-limit SizeSuffix   If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached (&#39;off&#39; is unlimited) (default off)
      --vfs-read-wait duration                 Time to wait for in-sequence read before seeking (default 20ms)
      --vfs-used-is-size rclone size           Use the rclone size algorithm for Used size
      --vfs-write-back duration                Time to writeback files after last use when using cache (default 5s)
      --vfs-write-wait duration                Time to wait for in-sequence write before giving error (default 1s)
      --volname string                         Set the volume name (supported on Windows and OSX only)
      --write-back-cache                       Makes kernel buffer writes before sending them to rclone (without this, writethrough caching is used) (not supported on Windows)</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-58">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h1 id="rclone-moveto">rclone moveto</h1>
<p>Move file or directory from source to dest.</p>
<h2 id="synopsis-51">Synopsis</h2>
<p>If source:path is a file or directory then it moves it to a file or
directory named dest:path.</p>
<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>
<p>So</p>
<pre><code>rclone moveto src dst</code></pre>
<p>where src and dst are rclone paths, either remote:path or
/path/to/local or C:.</p>
<p>This will:</p>
<pre><code>if src is file
    move it to dst, overwriting an existing file if it exists
if src is directory
    move it to dst, overwriting existing files if they exist
    see move command for full details</code></pre>
<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>
<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>
<p><strong>Note</strong>: Use the
<code>-P</code>/<code>--progress</code> flag to view real-time transfer
statistics.</p>
<pre><code>rclone moveto source:path dest:path [flags]</code></pre>
<h2 id="options-59">Options</h2>
<pre><code>  -h, --help   help for moveto</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-59">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h1 id="rclone-ncdu">rclone ncdu</h1>
<p>Explore a remote with a text based user interface.</p>
<h2 id="synopsis-52">Synopsis</h2>
<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>
<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>
<p>You can interact with the user interface using key presses, press ‘?’
to toggle the help on and off. The supported keys are:</p>
<pre><code> ↑,↓ or k,j to Move
 →,l to enter
 ←,h to return
 c toggle counts
 g toggle graph
 a toggle average size in directory
 u toggle human-readable format
 n,s,C,A sort by name,size,count,average size
 d delete file/directory
 v select file/directory
 V enter visual select mode
 D delete selected files/directories
 y copy current path to clipboard
 Y display current path
 ^L refresh screen (fix screen corruption)
 ? to toggle help on and off
 q/ESC/^c to quit</code></pre>
<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>
<pre><code>e means this is an empty directory, i.e. contains no files (but
  may contain empty subdirectories)
~ means this is a directory where some of the files (possibly in
  subdirectories) have unknown size, and therefore the directory
  size may be underestimated (and average size inaccurate, as it
  is average of the files with known sizes).
. means an error occurred while reading a subdirectory, and
  therefore the directory size may be underestimated (and average
  size inaccurate)
! means an error occurred while reading this directory</code></pre>
<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>
<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>
<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>
<pre><code>rclone ncdu remote:path [flags]</code></pre>
<h2 id="options-60">Options</h2>
<pre><code>  -h, --help   help for ncdu</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-60">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h1 id="rclone-obscure">rclone obscure</h1>
<p>Obscure password for use in the rclone config file.</p>
<h2 id="synopsis-53">Synopsis</h2>
<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>
<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>
<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>
<pre><code>echo &quot;secretpassword&quot; | rclone obscure -</code></pre>
<p>If there is no data on STDIN to read, rclone obscure will default to
obfuscating the hyphen itself.</p>
<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>
<pre><code>rclone obscure password [flags]</code></pre>
<h2 id="options-61">Options</h2>
<pre><code>  -h, --help   help for obscure</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-61">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h1 id="rclone-rc">rclone rc</h1>
<p>Run a command against a running rclone.</p>
<h2 id="synopsis-54">Synopsis</h2>
<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>
<p>A username and password can be passed in with <code>--user</code> and
<code>--pass</code>.</p>
<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>
<p>Arguments should be passed in as parameter=value.</p>
<p>The result will be returned as a JSON object by default.</p>
<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>
<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>
<pre><code>-o key=value -o key2</code></pre>
<p>Will place this in the “opt” value</p>
<pre><code>{&quot;key&quot;:&quot;value&quot;, &quot;key2&quot;,&quot;&quot;)</code></pre>
<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>
<pre><code>-a value -a value2</code></pre>
<p>Will place this in the “arg” value</p>
<pre><code>[&quot;value&quot;, &quot;value2&quot;]</code></pre>
<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>
<pre><code>rclone rc --loopback operations/about fs=/</code></pre>
<p>Use <code>rclone rc</code> to see a list of all possible
commands.</p>
<pre><code>rclone rc commands parameter [flags]</code></pre>
<h2 id="options-62">Options</h2>
<pre><code>  -a, --arg stringArray   Argument placed in the &quot;arg&quot; array
  -h, --help              help for rc
      --json string       Input JSON - use instead of key=value args
      --loopback          If set connect to this rclone instance not via HTTP
      --no-output         If set, don&#39;t output the JSON result
  -o, --opt stringArray   Option in the form name=value or name placed in the &quot;opt&quot; array
      --pass string       Password to use to connect to rclone remote control
      --url string        URL to connect to rclone remote control (default &quot;http://localhost:5572/&quot;)
      --user string       Username to use to rclone remote control</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-62">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h1 id="rclone-rcat">rclone rcat</h1>
<p>Copies standard input to file on remote.</p>
<h2 id="synopsis-55">Synopsis</h2>
<p>rclone rcat reads from standard input (stdin) and copies it to a
single remote file.</p>
<pre><code>echo &quot;hello world&quot; | rclone rcat remote:path/to/file
ffmpeg - | rclone rcat remote:path/to/file</code></pre>
<p>If the remote file already exists, it will be overwritten.</p>
<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>
<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>
<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>
<p>Note that the upload can also not be retried because the data is not
kept around until the upload succeeds. If you need to transfer a lot of
data, you’re better off caching locally and then
<code>rclone move</code> it to the destination.</p>
<pre><code>rclone rcat remote:path [flags]</code></pre>
<h2 id="options-63">Options</h2>
<pre><code>  -h, --help       help for rcat
      --size int   File size hint to preallocate (default -1)</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-63">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h1 id="rclone-rcd">rclone rcd</h1>
<p>Run rclone listening to remote control commands only.</p>
<h2 id="synopsis-56">Synopsis</h2>
<p>This runs rclone so that it only listens to remote control
commands.</p>
<p>This is useful if you are controlling rclone via the rc API.</p>
<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>
<p>See the <a href="https://rclone.org/rc/">rc documentation</a> for
more info on the rc flags.</p>
<pre><code>rclone rcd &lt;path to files to serve&gt;* [flags]</code></pre>
<h2 id="options-64">Options</h2>
<pre><code>  -h, --help   help for rcd</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-64">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h1 id="rclone-rmdirs">rclone rmdirs</h1>
<p>Remove empty directories under the path.</p>
<h2 id="synopsis-57">Synopsis</h2>
<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>
<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>
<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>
<p>To delete a path and any objects in it, use <a
href="https://rclone.org/commands/rclone_purge/">purge</a> command.</p>
<pre><code>rclone rmdirs remote:path [flags]</code></pre>
<h2 id="options-65">Options</h2>
<pre><code>  -h, --help         help for rmdirs
      --leave-root   Do not remove root directory if empty</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-65">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h1 id="rclone-selfupdate">rclone selfupdate</h1>
<p>Update the rclone binary.</p>
<h2 id="synopsis-58">Synopsis</h2>
<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.</p>
<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>
<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>
<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>
<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>
<p>The <code>rclone mount</code> command
(https://rclone.org/commands/rclone_mount/) 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>
<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>
<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>
<pre><code>rclone selfupdate [flags]</code></pre>
<h2 id="options-66">Options</h2>
<pre><code>      --beta             Install beta release
      --check            Check for latest release, do not download
  -h, --help             help for selfupdate
      --output string    Save the downloaded binary at a given path (default: replace running binary)
      --package string   Package format: zip|deb|rpm (default: zip)
      --stable           Install stable release (this is the default)
      --version string   Install the given rclone version (default: latest)</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-66">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h1 id="rclone-serve">rclone serve</h1>
<p>Serve a remote over a protocol.</p>
<h2 id="synopsis-59">Synopsis</h2>
<p>Serve a remote over a given protocol. Requires the use of a
subcommand to specify the protocol, e.g.</p>
<pre><code>rclone serve http remote:</code></pre>
<p>Each subcommand has its own options which you can see in their
help.</p>
<pre><code>rclone serve &lt;protocol&gt; [opts] &lt;remote&gt; [flags]</code></pre>
<h2 id="options-67">Options</h2>
<pre><code>  -h, --help   help for serve</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-67">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
<li><a href="https://rclone.org/commands/rclone_serve_dlna/">rclone
serve dlna</a> - Serve remote:path over DLNA</li>
<li><a href="https://rclone.org/commands/rclone_serve_docker/">rclone
serve docker</a> - Serve any remote on docker’s volume plugin API.</li>
<li><a href="https://rclone.org/commands/rclone_serve_ftp/">rclone serve
ftp</a> - Serve remote:path over FTP.</li>
<li><a href="https://rclone.org/commands/rclone_serve_http/">rclone
serve http</a> - Serve the remote over HTTP.</li>
<li><a href="https://rclone.org/commands/rclone_serve_restic/">rclone
serve restic</a> - Serve the remote for restic’s REST API.</li>
<li><a href="https://rclone.org/commands/rclone_serve_sftp/">rclone
serve sftp</a> - Serve the remote over SFTP.</li>
<li><a href="https://rclone.org/commands/rclone_serve_webdav/">rclone
serve webdav</a> - Serve remote:path over WebDAV.</li>
</ul>
<h1 id="rclone-serve-dlna">rclone serve dlna</h1>
<p>Serve remote:path over DLNA</p>
<h2 id="synopsis-60">Synopsis</h2>
<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>
<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>
<h2 id="server-options">Server options</h2>
<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>
<p>Use <code>--name</code> to choose the friendly server name, which is
by default “rclone (hostname)”.</p>
<p>Use <code>--log-trace</code> in conjunction with <code>-vv</code> to
enable additional debug logging of all UPNP traffic.</p>
<h2 id="vfs---virtual-file-system-1">VFS - Virtual File System</h2>
<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>
<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>
<p>The VFS layer also implements a directory cache - this caches info
about files and directories (but not the data) in memory.</p>
<h2 id="vfs-directory-cache-1">VFS Directory Cache</h2>
<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>
<pre><code>--dir-cache-time duration   Time to cache directory entries for (default 5m0s)
--poll-interval duration    Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable (default 1m0s)</code></pre>
<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>
<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>
<pre><code>kill -SIGHUP $(pidof rclone)</code></pre>
<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>
<pre><code>rclone rc vfs/forget</code></pre>
<p>Or individual files or directories:</p>
<pre><code>rclone rc vfs/forget file=path/to/file dir=path/to/dir</code></pre>
<h2 id="vfs-file-buffering-1">VFS File Buffering</h2>
<p>The <code>--buffer-size</code> flag determines the amount of memory,
that will be used to buffer data in advance.</p>
<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>
<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>
<p>The maximum memory used by rclone for buffering can be up to
<code>--buffer-size * open files</code>.</p>
<h2 id="vfs-file-caching-1">VFS File Caching</h2>
<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>
<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>
<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>
<pre><code>--cache-dir string                   Directory rclone will use for caching.
--vfs-cache-mode CacheMode           Cache mode off|minimal|writes|full (default off)
--vfs-cache-max-age duration         Max age of objects in the cache (default 1h0m0s)
--vfs-cache-max-size SizeSuffix      Max total size of objects in the cache (default off)
--vfs-cache-poll-interval duration   Interval to poll the cache for stale objects (default 1m0s)
--vfs-write-back duration            Time to writeback files after last use when using cache (default 5s)</code></pre>
<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>
<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>
<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>
<p>If using <code>--vfs-cache-max-size</code> note that the cache may
exceed this size 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.</p>
<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 &gt; 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>
<h3 id="vfs-cache-mode-off-1">–vfs-cache-mode off</h3>
<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>
<p>This will mean some operations are not possible</p>
<ul>
<li>Files can’t be opened for both read AND write</li>
<li>Files opened for write can’t be seeked</li>
<li>Existing files opened for write must have O_TRUNC set</li>
<li>Files open for read with O_TRUNC will be opened write only</li>
<li>Files open for write only will behave as if O_TRUNC was
supplied</li>
<li>Open modes O_APPEND, O_TRUNC are ignored</li>
<li>If an upload fails it can’t be retried</li>
</ul>
<h3 id="vfs-cache-mode-minimal-1">–vfs-cache-mode minimal</h3>
<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>
<p>These operations are not possible</p>
<ul>
<li>Files opened for write only can’t be seeked</li>
<li>Existing files opened for write must have O_TRUNC set</li>
<li>Files opened for write only will ignore O_APPEND, O_TRUNC</li>
<li>If an upload fails it can’t be retried</li>
</ul>
<h3 id="vfs-cache-mode-writes-1">–vfs-cache-mode writes</h3>
<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>
<p>This mode should support all normal file system operations.</p>
<p>If an upload fails it will be retried at exponentially increasing
intervals up to 1 minute.</p>
<h3 id="vfs-cache-mode-full-1">–vfs-cache-mode full</h3>
<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>
<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>
<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>
<p>This mode should support all normal file system operations and is
otherwise identical to <code>--vfs-cache-mode</code> writes.</p>
<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>
<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>
<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>
<h3 id="fingerprinting-1">Fingerprinting</h3>
<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>
<ul>
<li>size</li>
<li>modification time</li>
<li>hash</li>
</ul>
<p>where available on an object.</p>
<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>
<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>
<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>
<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>
<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>
<h2 id="vfs-chunked-reading-1">VFS Chunked Reading</h2>
<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>
<p>These flags control the chunking:</p>
<pre><code>--vfs-read-chunk-size SizeSuffix        Read the source objects in chunks (default 128M)
--vfs-read-chunk-size-limit SizeSuffix  Max chunk doubling size (default off)</code></pre>
<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>
<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>
<p>Setting <code>--vfs-read-chunk-size</code> to <code>0</code> or “off”
disables chunked reading.</p>
<h2 id="vfs-performance-1">VFS Performance</h2>
<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>
<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>
<pre><code>--no-checksum     Don&#39;t compare checksums on up/download.
--no-modtime      Don&#39;t read/write the modification time (can speed things up).
--no-seek         Don&#39;t allow seeking in files.
--read-only       Only allow read-only access.</code></pre>
<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>
<pre><code>--vfs-read-wait duration   Time to wait for in-sequence read before seeking (default 20ms)
--vfs-write-wait duration  Time to wait for in-sequence write before giving error (default 1s)</code></pre>
<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>
<pre><code>--transfers int  Number of file transfers to run in parallel (default 4)</code></pre>
<h2 id="vfs-case-sensitivity-1">VFS Case Sensitivity</h2>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<h2 id="vfs-disk-options-1">VFS Disk Options</h2>
<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>
<pre><code>--vfs-disk-space-total-size    Manually set the total disk space size (example: 256G, default: -1)</code></pre>
<h2 id="alternate-report-of-used-bytes-1">Alternate report of used
bytes</h2>
<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>
<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>
<pre><code>rclone serve dlna remote:path [flags]</code></pre>
<h2 id="options-68">Options</h2>
<pre><code>      --addr string                            The ip:port or :port to bind the DLNA http server to (default &quot;:7879&quot;)
      --announce-interval duration             The interval between SSDP announcements (default 12m0s)
      --dir-cache-time duration                Time to cache directory entries for (default 5m0s)
      --dir-perms FileMode                     Directory permissions (default 0777)
      --file-perms FileMode                    File permissions (default 0666)
      --gid uint32                             Override the gid field set by the filesystem (not supported on Windows) (default 1000)
  -h, --help                                   help for dlna
      --interface stringArray                  The interface to use for SSDP (repeat as necessary)
      --log-trace                              Enable trace logging of SOAP traffic
      --name string                            Name of DLNA server
      --no-checksum                            Don&#39;t compare checksums on up/download
      --no-modtime                             Don&#39;t read/write the modification time (can speed things up)
      --no-seek                                Don&#39;t allow seeking in files
      --poll-interval duration                 Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s)
      --read-only                              Only allow read-only access
      --uid uint32                             Override the uid field set by the filesystem (not supported on Windows) (default 1000)
      --umask int                              Override the permission bits set by the filesystem (not supported on Windows) (default 2)
      --vfs-cache-max-age duration             Max age of objects in the cache (default 1h0m0s)
      --vfs-cache-max-size SizeSuffix          Max total size of objects in the cache (default off)
      --vfs-cache-mode CacheMode               Cache mode off|minimal|writes|full (default off)
      --vfs-cache-poll-interval duration       Interval to poll the cache for stale objects (default 1m0s)
      --vfs-case-insensitive                   If a file name not found, find a case insensitive match
      --vfs-disk-space-total-size SizeSuffix   Specify the total space of disk (default off)
      --vfs-fast-fingerprint                   Use fast (less accurate) fingerprints for change detection
      --vfs-read-ahead SizeSuffix              Extra read ahead over --buffer-size when using cache-mode full
      --vfs-read-chunk-size SizeSuffix         Read the source objects in chunks (default 128Mi)
      --vfs-read-chunk-size-limit SizeSuffix   If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached (&#39;off&#39; is unlimited) (default off)
      --vfs-read-wait duration                 Time to wait for in-sequence read before seeking (default 20ms)
      --vfs-used-is-size rclone size           Use the rclone size algorithm for Used size
      --vfs-write-back duration                Time to writeback files after last use when using cache (default 5s)
      --vfs-write-wait duration                Time to wait for in-sequence write before giving error (default 1s)</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-68">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone_serve/">rclone serve</a>
- Serve a remote over a protocol.</li>
</ul>
<h1 id="rclone-serve-docker">rclone serve docker</h1>
<p>Serve any remote on docker’s volume plugin API.</p>
<h2 id="synopsis-61">Synopsis</h2>
<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>
<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>
<pre><code>sudo rclone serve docker --base-dir /tmp/rclone-volumes --socket-addr localhost:8787 -vv</code></pre>
<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>
<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>
<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>
<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.</p>
<h2 id="vfs---virtual-file-system-2">VFS - Virtual File System</h2>
<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>
<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>
<p>The VFS layer also implements a directory cache - this caches info
about files and directories (but not the data) in memory.</p>
<h2 id="vfs-directory-cache-2">VFS Directory Cache</h2>
<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>
<pre><code>--dir-cache-time duration   Time to cache directory entries for (default 5m0s)
--poll-interval duration    Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable (default 1m0s)</code></pre>
<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>
<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>
<pre><code>kill -SIGHUP $(pidof rclone)</code></pre>
<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>
<pre><code>rclone rc vfs/forget</code></pre>
<p>Or individual files or directories:</p>
<pre><code>rclone rc vfs/forget file=path/to/file dir=path/to/dir</code></pre>
<h2 id="vfs-file-buffering-2">VFS File Buffering</h2>
<p>The <code>--buffer-size</code> flag determines the amount of memory,
that will be used to buffer data in advance.</p>
<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>
<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>
<p>The maximum memory used by rclone for buffering can be up to
<code>--buffer-size * open files</code>.</p>
<h2 id="vfs-file-caching-2">VFS File Caching</h2>
<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>
<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>
<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>
<pre><code>--cache-dir string                   Directory rclone will use for caching.
--vfs-cache-mode CacheMode           Cache mode off|minimal|writes|full (default off)
--vfs-cache-max-age duration         Max age of objects in the cache (default 1h0m0s)
--vfs-cache-max-size SizeSuffix      Max total size of objects in the cache (default off)
--vfs-cache-poll-interval duration   Interval to poll the cache for stale objects (default 1m0s)
--vfs-write-back duration            Time to writeback files after last use when using cache (default 5s)</code></pre>
<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>
<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>
<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>
<p>If using <code>--vfs-cache-max-size</code> note that the cache may
exceed this size 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.</p>
<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 &gt; 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>
<h3 id="vfs-cache-mode-off-2">–vfs-cache-mode off</h3>
<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>
<p>This will mean some operations are not possible</p>
<ul>
<li>Files can’t be opened for both read AND write</li>
<li>Files opened for write can’t be seeked</li>
<li>Existing files opened for write must have O_TRUNC set</li>
<li>Files open for read with O_TRUNC will be opened write only</li>
<li>Files open for write only will behave as if O_TRUNC was
supplied</li>
<li>Open modes O_APPEND, O_TRUNC are ignored</li>
<li>If an upload fails it can’t be retried</li>
</ul>
<h3 id="vfs-cache-mode-minimal-2">–vfs-cache-mode minimal</h3>
<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>
<p>These operations are not possible</p>
<ul>
<li>Files opened for write only can’t be seeked</li>
<li>Existing files opened for write must have O_TRUNC set</li>
<li>Files opened for write only will ignore O_APPEND, O_TRUNC</li>
<li>If an upload fails it can’t be retried</li>
</ul>
<h3 id="vfs-cache-mode-writes-2">–vfs-cache-mode writes</h3>
<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>
<p>This mode should support all normal file system operations.</p>
<p>If an upload fails it will be retried at exponentially increasing
intervals up to 1 minute.</p>
<h3 id="vfs-cache-mode-full-2">–vfs-cache-mode full</h3>
<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>
<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>
<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>
<p>This mode should support all normal file system operations and is
otherwise identical to <code>--vfs-cache-mode</code> writes.</p>
<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>
<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>
<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>
<h3 id="fingerprinting-2">Fingerprinting</h3>
<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>
<ul>
<li>size</li>
<li>modification time</li>
<li>hash</li>
</ul>
<p>where available on an object.</p>
<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>
<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>
<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>
<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>
<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>
<h2 id="vfs-chunked-reading-2">VFS Chunked Reading</h2>
<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>
<p>These flags control the chunking:</p>
<pre><code>--vfs-read-chunk-size SizeSuffix        Read the source objects in chunks (default 128M)
--vfs-read-chunk-size-limit SizeSuffix  Max chunk doubling size (default off)</code></pre>
<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>
<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>
<p>Setting <code>--vfs-read-chunk-size</code> to <code>0</code> or “off”
disables chunked reading.</p>
<h2 id="vfs-performance-2">VFS Performance</h2>
<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>
<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>
<pre><code>--no-checksum     Don&#39;t compare checksums on up/download.
--no-modtime      Don&#39;t read/write the modification time (can speed things up).
--no-seek         Don&#39;t allow seeking in files.
--read-only       Only allow read-only access.</code></pre>
<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>
<pre><code>--vfs-read-wait duration   Time to wait for in-sequence read before seeking (default 20ms)
--vfs-write-wait duration  Time to wait for in-sequence write before giving error (default 1s)</code></pre>
<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>
<pre><code>--transfers int  Number of file transfers to run in parallel (default 4)</code></pre>
<h2 id="vfs-case-sensitivity-2">VFS Case Sensitivity</h2>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<h2 id="vfs-disk-options-2">VFS Disk Options</h2>
<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>
<pre><code>--vfs-disk-space-total-size    Manually set the total disk space size (example: 256G, default: -1)</code></pre>
<h2 id="alternate-report-of-used-bytes-2">Alternate report of used
bytes</h2>
<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>
<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>
<pre><code>rclone serve docker [flags]</code></pre>
<h2 id="options-69">Options</h2>
<pre><code>      --allow-non-empty                        Allow mounting over a non-empty directory (not supported on Windows)
      --allow-other                            Allow access to other users (not supported on Windows)
      --allow-root                             Allow access to root user (not supported on Windows)
      --async-read                             Use asynchronous reads (not supported on Windows) (default true)
      --attr-timeout duration                  Time for which file/directory attributes are cached (default 1s)
      --base-dir string                        Base directory for volumes (default &quot;/var/lib/docker-volumes/rclone&quot;)
      --daemon                                 Run mount in background and exit parent process (as background output is suppressed, use --log-file with --log-format=pid,... to monitor) (not supported on Windows)
      --daemon-timeout duration                Time limit for rclone to respond to kernel (not supported on Windows)
      --daemon-wait duration                   Time to wait for ready mount from daemon (maximum time on Linux, constant sleep time on OSX/BSD) (not supported on Windows) (default 1m0s)
      --debug-fuse                             Debug the FUSE internals - needs -v
      --default-permissions                    Makes kernel enforce access control based on the file mode (not supported on Windows)
      --devname string                         Set the device name - default is remote:path
      --dir-cache-time duration                Time to cache directory entries for (default 5m0s)
      --dir-perms FileMode                     Directory permissions (default 0777)
      --file-perms FileMode                    File permissions (default 0666)
      --forget-state                           Skip restoring previous state
      --fuse-flag stringArray                  Flags or arguments to be passed direct to libfuse/WinFsp (repeat if required)
      --gid uint32                             Override the gid field set by the filesystem (not supported on Windows) (default 1000)
  -h, --help                                   help for docker
      --max-read-ahead SizeSuffix              The number of bytes that can be prefetched for sequential reads (not supported on Windows) (default 128Ki)
      --network-mode                           Mount as remote network drive, instead of fixed disk drive (supported on Windows only)
      --no-checksum                            Don&#39;t compare checksums on up/download
      --no-modtime                             Don&#39;t read/write the modification time (can speed things up)
      --no-seek                                Don&#39;t allow seeking in files
      --no-spec                                Do not write spec file
      --noappledouble                          Ignore Apple Double (._) and .DS_Store files (supported on OSX only) (default true)
      --noapplexattr                           Ignore all &quot;com.apple.*&quot; extended attributes (supported on OSX only)
  -o, --option stringArray                     Option for libfuse/WinFsp (repeat if required)
      --poll-interval duration                 Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s)
      --read-only                              Only allow read-only access
      --socket-addr string                     Address &lt;host:port&gt; or absolute path (default: /run/docker/plugins/rclone.sock)
      --socket-gid int                         GID for unix socket (default: current process GID) (default 1000)
      --uid uint32                             Override the uid field set by the filesystem (not supported on Windows) (default 1000)
      --umask int                              Override the permission bits set by the filesystem (not supported on Windows) (default 2)
      --vfs-cache-max-age duration             Max age of objects in the cache (default 1h0m0s)
      --vfs-cache-max-size SizeSuffix          Max total size of objects in the cache (default off)
      --vfs-cache-mode CacheMode               Cache mode off|minimal|writes|full (default off)
      --vfs-cache-poll-interval duration       Interval to poll the cache for stale objects (default 1m0s)
      --vfs-case-insensitive                   If a file name not found, find a case insensitive match
      --vfs-disk-space-total-size SizeSuffix   Specify the total space of disk (default off)
      --vfs-fast-fingerprint                   Use fast (less accurate) fingerprints for change detection
      --vfs-read-ahead SizeSuffix              Extra read ahead over --buffer-size when using cache-mode full
      --vfs-read-chunk-size SizeSuffix         Read the source objects in chunks (default 128Mi)
      --vfs-read-chunk-size-limit SizeSuffix   If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached (&#39;off&#39; is unlimited) (default off)
      --vfs-read-wait duration                 Time to wait for in-sequence read before seeking (default 20ms)
      --vfs-used-is-size rclone size           Use the rclone size algorithm for Used size
      --vfs-write-back duration                Time to writeback files after last use when using cache (default 5s)
      --vfs-write-wait duration                Time to wait for in-sequence write before giving error (default 1s)
      --volname string                         Set the volume name (supported on Windows and OSX only)
      --write-back-cache                       Makes kernel buffer writes before sending them to rclone (without this, writethrough caching is used) (not supported on Windows)</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-69">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone_serve/">rclone serve</a>
- Serve a remote over a protocol.</li>
</ul>
<h1 id="rclone-serve-ftp">rclone serve ftp</h1>
<p>Serve remote:path over FTP.</p>
<h2 id="synopsis-62">Synopsis</h2>
<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>
<h2 id="server-options-1">Server options</h2>
<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>
<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>
<h3 id="authentication">Authentication</h3>
<p>By default this will serve files without needing a login.</p>
<p>You can set a single username and password with the –user and –pass
flags.</p>
<h2 id="vfs---virtual-file-system-3">VFS - Virtual File System</h2>
<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>
<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>
<p>The VFS layer also implements a directory cache - this caches info
about files and directories (but not the data) in memory.</p>
<h2 id="vfs-directory-cache-3">VFS Directory Cache</h2>
<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>
<pre><code>--dir-cache-time duration   Time to cache directory entries for (default 5m0s)
--poll-interval duration    Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable (default 1m0s)</code></pre>
<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>
<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>
<pre><code>kill -SIGHUP $(pidof rclone)</code></pre>
<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>
<pre><code>rclone rc vfs/forget</code></pre>
<p>Or individual files or directories:</p>
<pre><code>rclone rc vfs/forget file=path/to/file dir=path/to/dir</code></pre>
<h2 id="vfs-file-buffering-3">VFS File Buffering</h2>
<p>The <code>--buffer-size</code> flag determines the amount of memory,
that will be used to buffer data in advance.</p>
<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>
<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>
<p>The maximum memory used by rclone for buffering can be up to
<code>--buffer-size * open files</code>.</p>
<h2 id="vfs-file-caching-3">VFS File Caching</h2>
<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>
<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>
<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>
<pre><code>--cache-dir string                   Directory rclone will use for caching.
--vfs-cache-mode CacheMode           Cache mode off|minimal|writes|full (default off)
--vfs-cache-max-age duration         Max age of objects in the cache (default 1h0m0s)
--vfs-cache-max-size SizeSuffix      Max total size of objects in the cache (default off)
--vfs-cache-poll-interval duration   Interval to poll the cache for stale objects (default 1m0s)
--vfs-write-back duration            Time to writeback files after last use when using cache (default 5s)</code></pre>
<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>
<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>
<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>
<p>If using <code>--vfs-cache-max-size</code> note that the cache may
exceed this size 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.</p>
<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 &gt; 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>
<h3 id="vfs-cache-mode-off-3">–vfs-cache-mode off</h3>
<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>
<p>This will mean some operations are not possible</p>
<ul>
<li>Files can’t be opened for both read AND write</li>
<li>Files opened for write can’t be seeked</li>
<li>Existing files opened for write must have O_TRUNC set</li>
<li>Files open for read with O_TRUNC will be opened write only</li>
<li>Files open for write only will behave as if O_TRUNC was
supplied</li>
<li>Open modes O_APPEND, O_TRUNC are ignored</li>
<li>If an upload fails it can’t be retried</li>
</ul>
<h3 id="vfs-cache-mode-minimal-3">–vfs-cache-mode minimal</h3>
<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>
<p>These operations are not possible</p>
<ul>
<li>Files opened for write only can’t be seeked</li>
<li>Existing files opened for write must have O_TRUNC set</li>
<li>Files opened for write only will ignore O_APPEND, O_TRUNC</li>
<li>If an upload fails it can’t be retried</li>
</ul>
<h3 id="vfs-cache-mode-writes-3">–vfs-cache-mode writes</h3>
<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>
<p>This mode should support all normal file system operations.</p>
<p>If an upload fails it will be retried at exponentially increasing
intervals up to 1 minute.</p>
<h3 id="vfs-cache-mode-full-3">–vfs-cache-mode full</h3>
<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>
<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>
<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>
<p>This mode should support all normal file system operations and is
otherwise identical to <code>--vfs-cache-mode</code> writes.</p>
<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>
<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>
<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>
<h3 id="fingerprinting-3">Fingerprinting</h3>
<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>
<ul>
<li>size</li>
<li>modification time</li>
<li>hash</li>
</ul>
<p>where available on an object.</p>
<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>
<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>
<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>
<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>
<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>
<h2 id="vfs-chunked-reading-3">VFS Chunked Reading</h2>
<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>
<p>These flags control the chunking:</p>
<pre><code>--vfs-read-chunk-size SizeSuffix        Read the source objects in chunks (default 128M)
--vfs-read-chunk-size-limit SizeSuffix  Max chunk doubling size (default off)</code></pre>
<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>
<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>
<p>Setting <code>--vfs-read-chunk-size</code> to <code>0</code> or “off”
disables chunked reading.</p>
<h2 id="vfs-performance-3">VFS Performance</h2>
<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>
<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>
<pre><code>--no-checksum     Don&#39;t compare checksums on up/download.
--no-modtime      Don&#39;t read/write the modification time (can speed things up).
--no-seek         Don&#39;t allow seeking in files.
--read-only       Only allow read-only access.</code></pre>
<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>
<pre><code>--vfs-read-wait duration   Time to wait for in-sequence read before seeking (default 20ms)
--vfs-write-wait duration  Time to wait for in-sequence write before giving error (default 1s)</code></pre>
<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>
<pre><code>--transfers int  Number of file transfers to run in parallel (default 4)</code></pre>
<h2 id="vfs-case-sensitivity-3">VFS Case Sensitivity</h2>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<h2 id="vfs-disk-options-3">VFS Disk Options</h2>
<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>
<pre><code>--vfs-disk-space-total-size    Manually set the total disk space size (example: 256G, default: -1)</code></pre>
<h2 id="alternate-report-of-used-bytes-3">Alternate report of used
bytes</h2>
<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>
<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>
<h2 id="auth-proxy">Auth Proxy</h2>
<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>
<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>
<p>There is an example program <a
href="https://github.com/rclone/rclone/blob/master/test_proxy.py">bin/test_proxy.py</a>
in the rclone source code.</p>
<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>
<p>This config generated must have this extra parameter -
<code>_root</code> - root to use for the backend</p>
<p>And it may have this parameter - <code>_obscure</code> - comma
separated strings for parameters to obscure</p>
<p>If password authentication was used by the client, input to the proxy
process (on STDIN) would look similar to this:</p>
<pre><code>{
    &quot;user&quot;: &quot;me&quot;,
    &quot;pass&quot;: &quot;mypassword&quot;
}</code></pre>
<p>If public-key authentication was used by the client, input to the
proxy process (on STDIN) would look similar to this:</p>
<pre><code>{
    &quot;user&quot;: &quot;me&quot;,
    &quot;public_key&quot;: &quot;AAAAB3NzaC1yc2EAAAADAQABAAABAQDuwESFdAe14hVS6omeyX7edc...JQdf&quot;
}</code></pre>
<p>And as an example return this on STDOUT</p>
<pre><code>{
    &quot;type&quot;: &quot;sftp&quot;,
    &quot;_root&quot;: &quot;&quot;,
    &quot;_obscure&quot;: &quot;pass&quot;,
    &quot;user&quot;: &quot;me&quot;,
    &quot;pass&quot;: &quot;mypassword&quot;,
    &quot;host&quot;: &quot;sftp.example.com&quot;
}</code></pre>
<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>
<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>
<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>
<p>This can be used to build general purpose proxies to any kind of
backend that rclone supports.</p>
<pre><code>rclone serve ftp remote:path [flags]</code></pre>
<h2 id="options-70">Options</h2>
<pre><code>      --addr string                            IPaddress:Port or :Port to bind server to (default &quot;localhost:2121&quot;)
      --auth-proxy string                      A program to use to create the backend from the auth
      --cert string                            TLS PEM key (concatenation of certificate and CA certificate)
      --dir-cache-time duration                Time to cache directory entries for (default 5m0s)
      --dir-perms FileMode                     Directory permissions (default 0777)
      --file-perms FileMode                    File permissions (default 0666)
      --gid uint32                             Override the gid field set by the filesystem (not supported on Windows) (default 1000)
  -h, --help                                   help for ftp
      --key string                             TLS PEM Private key
      --no-checksum                            Don&#39;t compare checksums on up/download
      --no-modtime                             Don&#39;t read/write the modification time (can speed things up)
      --no-seek                                Don&#39;t allow seeking in files
      --pass string                            Password for authentication (empty value allow every password)
      --passive-port string                    Passive port range to use (default &quot;30000-32000&quot;)
      --poll-interval duration                 Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s)
      --public-ip string                       Public IP address to advertise for passive connections
      --read-only                              Only allow read-only access
      --uid uint32                             Override the uid field set by the filesystem (not supported on Windows) (default 1000)
      --umask int                              Override the permission bits set by the filesystem (not supported on Windows) (default 2)
      --user string                            User name for authentication (default &quot;anonymous&quot;)
      --vfs-cache-max-age duration             Max age of objects in the cache (default 1h0m0s)
      --vfs-cache-max-size SizeSuffix          Max total size of objects in the cache (default off)
      --vfs-cache-mode CacheMode               Cache mode off|minimal|writes|full (default off)
      --vfs-cache-poll-interval duration       Interval to poll the cache for stale objects (default 1m0s)
      --vfs-case-insensitive                   If a file name not found, find a case insensitive match
      --vfs-disk-space-total-size SizeSuffix   Specify the total space of disk (default off)
      --vfs-fast-fingerprint                   Use fast (less accurate) fingerprints for change detection
      --vfs-read-ahead SizeSuffix              Extra read ahead over --buffer-size when using cache-mode full
      --vfs-read-chunk-size SizeSuffix         Read the source objects in chunks (default 128Mi)
      --vfs-read-chunk-size-limit SizeSuffix   If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached (&#39;off&#39; is unlimited) (default off)
      --vfs-read-wait duration                 Time to wait for in-sequence read before seeking (default 20ms)
      --vfs-used-is-size rclone size           Use the rclone size algorithm for Used size
      --vfs-write-back duration                Time to writeback files after last use when using cache (default 5s)
      --vfs-write-wait duration                Time to wait for in-sequence write before giving error (default 1s)</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-70">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone_serve/">rclone serve</a>
- Serve a remote over a protocol.</li>
</ul>
<h1 id="rclone-serve-http">rclone serve http</h1>
<p>Serve the remote over HTTP.</p>
<h2 id="synopsis-63">Synopsis</h2>
<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>
<p>You can use the filter flags (e.g. <code>--include</code>,
<code>--exclude</code>) to control what is served.</p>
<p>The server will log errors. Use <code>-v</code> to see access
logs.</p>
<p><code>--bwlimit</code> will be respected for file transfers. Use
<code>--stats</code> to control the stats printing.</p>
<h2 id="server-options-2">Server options</h2>
<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>
<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>
<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>
<p><code>--max-header-bytes</code> controls the maximum number of bytes
the server will accept in the HTTP header.</p>
<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>
<h3 id="ssltls">SSL/TLS</h3>
<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>
<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>
<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>
<h3 id="template">Template</h3>
<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>
<table>
<colgroup>
<col style="width: 50%" />
<col style="width: 50%" />
</colgroup>
<thead>
<tr class="header">
<th style="text-align: left;">Parameter</th>
<th style="text-align: left;">Description</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td style="text-align: left;">.Name</td>
<td style="text-align: left;">The full path of a file/directory.</td>
</tr>
<tr class="even">
<td style="text-align: left;">.Title</td>
<td style="text-align: left;">Directory listing of .Name</td>
</tr>
<tr class="odd">
<td style="text-align: left;">.Sort</td>
<td style="text-align: left;">The current sort used. This is changeable
via ?sort= parameter</td>
</tr>
<tr class="even">
<td style="text-align: left;"></td>
<td style="text-align: left;">Sort Options: namedirfirst,name,size,time
(default namedirfirst)</td>
</tr>
<tr class="odd">
<td style="text-align: left;">.Order</td>
<td style="text-align: left;">The current ordering used. This is
changeable via ?order= parameter</td>
</tr>
<tr class="even">
<td style="text-align: left;"></td>
<td style="text-align: left;">Order Options: asc,desc (default asc)</td>
</tr>
<tr class="odd">
<td style="text-align: left;">.Query</td>
<td style="text-align: left;">Currently unused.</td>
</tr>
<tr class="even">
<td style="text-align: left;">.Breadcrumb</td>
<td style="text-align: left;">Allows for creating a relative
navigation</td>
</tr>
<tr class="odd">
<td style="text-align: left;">– .Link</td>
<td style="text-align: left;">The relative to the root link of the
Text.</td>
</tr>
<tr class="even">
<td style="text-align: left;">– .Text</td>
<td style="text-align: left;">The Name of the directory.</td>
</tr>
<tr class="odd">
<td style="text-align: left;">.Entries</td>
<td style="text-align: left;">Information about a specific
file/directory.</td>
</tr>
<tr class="even">
<td style="text-align: left;">– .URL</td>
<td style="text-align: left;">The ‘url’ of an entry.</td>
</tr>
<tr class="odd">
<td style="text-align: left;">– .Leaf</td>
<td style="text-align: left;">Currently same as ‘URL’ but intended to be
‘just’ the name.</td>
</tr>
<tr class="even">
<td style="text-align: left;">– .IsDir</td>
<td style="text-align: left;">Boolean for if an entry is a directory or
not.</td>
</tr>
<tr class="odd">
<td style="text-align: left;">– .Size</td>
<td style="text-align: left;">Size in Bytes of the entry.</td>
</tr>
<tr class="even">
<td style="text-align: left;">– .ModTime</td>
<td style="text-align: left;">The UTC timestamp of an entry.</td>
</tr>
</tbody>
</table>
<h3 id="authentication-1">Authentication</h3>
<p>By default this will serve files without needing a login.</p>
<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>
<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>
<p>To create an htpasswd file:</p>
<pre><code>touch htpasswd
htpasswd -B htpasswd user
htpasswd -B htpasswd anotherUser</code></pre>
<p>The password file can be updated while rclone is running.</p>
<p>Use <code>--realm</code> to set the authentication realm.</p>
<p>Use <code>--salt</code> to change the password hashing salt from the
default.</p>
<h2 id="vfs---virtual-file-system-4">VFS - Virtual File System</h2>
<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>
<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>
<p>The VFS layer also implements a directory cache - this caches info
about files and directories (but not the data) in memory.</p>
<h2 id="vfs-directory-cache-4">VFS Directory Cache</h2>
<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>
<pre><code>--dir-cache-time duration   Time to cache directory entries for (default 5m0s)
--poll-interval duration    Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable (default 1m0s)</code></pre>
<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>
<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>
<pre><code>kill -SIGHUP $(pidof rclone)</code></pre>
<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>
<pre><code>rclone rc vfs/forget</code></pre>
<p>Or individual files or directories:</p>
<pre><code>rclone rc vfs/forget file=path/to/file dir=path/to/dir</code></pre>
<h2 id="vfs-file-buffering-4">VFS File Buffering</h2>
<p>The <code>--buffer-size</code> flag determines the amount of memory,
that will be used to buffer data in advance.</p>
<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>
<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>
<p>The maximum memory used by rclone for buffering can be up to
<code>--buffer-size * open files</code>.</p>
<h2 id="vfs-file-caching-4">VFS File Caching</h2>
<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>
<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>
<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>
<pre><code>--cache-dir string                   Directory rclone will use for caching.
--vfs-cache-mode CacheMode           Cache mode off|minimal|writes|full (default off)
--vfs-cache-max-age duration         Max age of objects in the cache (default 1h0m0s)
--vfs-cache-max-size SizeSuffix      Max total size of objects in the cache (default off)
--vfs-cache-poll-interval duration   Interval to poll the cache for stale objects (default 1m0s)
--vfs-write-back duration            Time to writeback files after last use when using cache (default 5s)</code></pre>
<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>
<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>
<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>
<p>If using <code>--vfs-cache-max-size</code> note that the cache may
exceed this size 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.</p>
<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 &gt; 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>
<h3 id="vfs-cache-mode-off-4">–vfs-cache-mode off</h3>
<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>
<p>This will mean some operations are not possible</p>
<ul>
<li>Files can’t be opened for both read AND write</li>
<li>Files opened for write can’t be seeked</li>
<li>Existing files opened for write must have O_TRUNC set</li>
<li>Files open for read with O_TRUNC will be opened write only</li>
<li>Files open for write only will behave as if O_TRUNC was
supplied</li>
<li>Open modes O_APPEND, O_TRUNC are ignored</li>
<li>If an upload fails it can’t be retried</li>
</ul>
<h3 id="vfs-cache-mode-minimal-4">–vfs-cache-mode minimal</h3>
<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>
<p>These operations are not possible</p>
<ul>
<li>Files opened for write only can’t be seeked</li>
<li>Existing files opened for write must have O_TRUNC set</li>
<li>Files opened for write only will ignore O_APPEND, O_TRUNC</li>
<li>If an upload fails it can’t be retried</li>
</ul>
<h3 id="vfs-cache-mode-writes-4">–vfs-cache-mode writes</h3>
<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>
<p>This mode should support all normal file system operations.</p>
<p>If an upload fails it will be retried at exponentially increasing
intervals up to 1 minute.</p>
<h3 id="vfs-cache-mode-full-4">–vfs-cache-mode full</h3>
<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>
<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>
<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>
<p>This mode should support all normal file system operations and is
otherwise identical to <code>--vfs-cache-mode</code> writes.</p>
<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>
<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>
<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>
<h3 id="fingerprinting-4">Fingerprinting</h3>
<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>
<ul>
<li>size</li>
<li>modification time</li>
<li>hash</li>
</ul>
<p>where available on an object.</p>
<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>
<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>
<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>
<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>
<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>
<h2 id="vfs-chunked-reading-4">VFS Chunked Reading</h2>
<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>
<p>These flags control the chunking:</p>
<pre><code>--vfs-read-chunk-size SizeSuffix        Read the source objects in chunks (default 128M)
--vfs-read-chunk-size-limit SizeSuffix  Max chunk doubling size (default off)</code></pre>
<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>
<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>
<p>Setting <code>--vfs-read-chunk-size</code> to <code>0</code> or “off”
disables chunked reading.</p>
<h2 id="vfs-performance-4">VFS Performance</h2>
<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>
<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>
<pre><code>--no-checksum     Don&#39;t compare checksums on up/download.
--no-modtime      Don&#39;t read/write the modification time (can speed things up).
--no-seek         Don&#39;t allow seeking in files.
--read-only       Only allow read-only access.</code></pre>
<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>
<pre><code>--vfs-read-wait duration   Time to wait for in-sequence read before seeking (default 20ms)
--vfs-write-wait duration  Time to wait for in-sequence write before giving error (default 1s)</code></pre>
<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>
<pre><code>--transfers int  Number of file transfers to run in parallel (default 4)</code></pre>
<h2 id="vfs-case-sensitivity-4">VFS Case Sensitivity</h2>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<h2 id="vfs-disk-options-4">VFS Disk Options</h2>
<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>
<pre><code>--vfs-disk-space-total-size    Manually set the total disk space size (example: 256G, default: -1)</code></pre>
<h2 id="alternate-report-of-used-bytes-4">Alternate report of used
bytes</h2>
<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>
<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>
<pre><code>rclone serve http remote:path [flags]</code></pre>
<h2 id="options-71">Options</h2>
<pre><code>      --addr string                            IPaddress:Port or :Port to bind server to (default &quot;127.0.0.1:8080&quot;)
      --baseurl string                         Prefix for URLs - leave blank for root
      --cert string                            SSL PEM key (concatenation of certificate and CA certificate)
      --client-ca string                       Client certificate authority to verify clients with
      --dir-cache-time duration                Time to cache directory entries for (default 5m0s)
      --dir-perms FileMode                     Directory permissions (default 0777)
      --file-perms FileMode                    File permissions (default 0666)
      --gid uint32                             Override the gid field set by the filesystem (not supported on Windows) (default 1000)
  -h, --help                                   help for http
      --htpasswd string                        A htpasswd file - if not provided no authentication is done
      --key string                             SSL PEM Private key
      --max-header-bytes int                   Maximum size of request header (default 4096)
      --min-tls-version string                 Minimum TLS version that is acceptable (default &quot;tls1.0&quot;)
      --no-checksum                            Don&#39;t compare checksums on up/download
      --no-modtime                             Don&#39;t read/write the modification time (can speed things up)
      --no-seek                                Don&#39;t allow seeking in files
      --pass string                            Password for authentication
      --poll-interval duration                 Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s)
      --read-only                              Only allow read-only access
      --realm string                           Realm for authentication
      --salt string                            Password hashing salt (default &quot;dlPL2MqE&quot;)
      --server-read-timeout duration           Timeout for server reading data (default 1h0m0s)
      --server-write-timeout duration          Timeout for server writing data (default 1h0m0s)
      --template string                        User-specified template
      --uid uint32                             Override the uid field set by the filesystem (not supported on Windows) (default 1000)
      --umask int                              Override the permission bits set by the filesystem (not supported on Windows) (default 2)
      --user string                            User name for authentication
      --vfs-cache-max-age duration             Max age of objects in the cache (default 1h0m0s)
      --vfs-cache-max-size SizeSuffix          Max total size of objects in the cache (default off)
      --vfs-cache-mode CacheMode               Cache mode off|minimal|writes|full (default off)
      --vfs-cache-poll-interval duration       Interval to poll the cache for stale objects (default 1m0s)
      --vfs-case-insensitive                   If a file name not found, find a case insensitive match
      --vfs-disk-space-total-size SizeSuffix   Specify the total space of disk (default off)
      --vfs-fast-fingerprint                   Use fast (less accurate) fingerprints for change detection
      --vfs-read-ahead SizeSuffix              Extra read ahead over --buffer-size when using cache-mode full
      --vfs-read-chunk-size SizeSuffix         Read the source objects in chunks (default 128Mi)
      --vfs-read-chunk-size-limit SizeSuffix   If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached (&#39;off&#39; is unlimited) (default off)
      --vfs-read-wait duration                 Time to wait for in-sequence read before seeking (default 20ms)
      --vfs-used-is-size rclone size           Use the rclone size algorithm for Used size
      --vfs-write-back duration                Time to writeback files after last use when using cache (default 5s)
      --vfs-write-wait duration                Time to wait for in-sequence write before giving error (default 1s)</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-71">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone_serve/">rclone serve</a>
- Serve a remote over a protocol.</li>
</ul>
<h1 id="rclone-serve-restic">rclone serve restic</h1>
<p>Serve the remote for restic’s REST API.</p>
<h2 id="synopsis-64">Synopsis</h2>
<p>Run a basic web server to serve a remove 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>
<p><a href="https://restic.net/">Restic</a> is a command-line program
for doing backups.</p>
<p>The server will log errors. Use -v to see access logs.</p>
<p><code>--bwlimit</code> will be respected for file transfers. Use
<code>--stats</code> to control the stats printing.</p>
<h2 id="setting-up-rclone-for-use-by-restic">Setting up rclone for use
by restic</h2>
<p>First <a href="https://rclone.org/docs/#configure">set up a remote
for your chosen cloud provider</a>.</p>
<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>
<p>Now start the rclone restic server</p>
<pre><code>rclone serve restic -v remote:backup</code></pre>
<p>Where you can replace “backup” in the above by whatever path in the
remote you wish to use.</p>
<p>By default this will serve on “localhost:8080” you can change this
with use of the <code>--addr</code> flag.</p>
<p>You might wish to start this server on boot.</p>
<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>
<h2 id="setting-up-restic-to-use-rclone">Setting up restic to use
rclone</h2>
<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>
<p>Note that you will need restic 0.8.2 or later to interoperate with
rclone.</p>
<p>For the example above you will want to use “http://localhost:8080/”
as the URL for the REST server.</p>
<p>For example:</p>
<pre><code>$ export RESTIC_REPOSITORY=rest:http://localhost:8080/
$ export RESTIC_PASSWORD=yourpassword
$ restic init
created restic backend 8b1a4b56ae at rest:http://localhost:8080/

Please note that knowledge of your password is required to access
the repository. Losing your password means that your data is
irrecoverably lost.
$ restic backup /path/to/files/to/backup
scan [/path/to/files/to/backup]
scanned 189 directories, 312 files in 0:00
[0:00] 100.00%  38.128 MiB / 38.128 MiB  501 / 501 items  0 errors  ETA 0:00
duration: 0:00
snapshot 45c8fdd8 saved</code></pre>
<h3 id="multiple-repositories">Multiple repositories</h3>
<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>
<pre><code>$ export RESTIC_REPOSITORY=rest:http://localhost:8080/user1repo/
# backup user1 stuff
$ export RESTIC_REPOSITORY=rest:http://localhost:8080/user2repo/
# backup user2 stuff</code></pre>
<h3 id="private-repositories">Private repositories</h3>
<p>The<code>--private-repos</code> flag can be used to limit users to
repositories starting with a path of
<code>/&lt;username&gt;/</code>.</p>
<h2 id="server-options-3">Server options</h2>
<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. By default it only
listens on localhost. You can use port :0 to let the OS choose an
available port.</p>
<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>
<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>
<p><code>--max-header-bytes</code> controls the maximum number of bytes
the server will accept in the HTTP header.</p>
<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>
<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>
<table>
<colgroup>
<col style="width: 50%" />
<col style="width: 50%" />
</colgroup>
<thead>
<tr class="header">
<th style="text-align: left;">Parameter</th>
<th style="text-align: left;">Description</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td style="text-align: left;">.Name</td>
<td style="text-align: left;">The full path of a file/directory.</td>
</tr>
<tr class="even">
<td style="text-align: left;">.Title</td>
<td style="text-align: left;">Directory listing of .Name</td>
</tr>
<tr class="odd">
<td style="text-align: left;">.Sort</td>
<td style="text-align: left;">The current sort used. This is changeable
via ?sort= parameter</td>
</tr>
<tr class="even">
<td style="text-align: left;"></td>
<td style="text-align: left;">Sort Options: namedirfirst,name,size,time
(default namedirfirst)</td>
</tr>
<tr class="odd">
<td style="text-align: left;">.Order</td>
<td style="text-align: left;">The current ordering used. This is
changeable via ?order= parameter</td>
</tr>
<tr class="even">
<td style="text-align: left;"></td>
<td style="text-align: left;">Order Options: asc,desc (default asc)</td>
</tr>
<tr class="odd">
<td style="text-align: left;">.Query</td>
<td style="text-align: left;">Currently unused.</td>
</tr>
<tr class="even">
<td style="text-align: left;">.Breadcrumb</td>
<td style="text-align: left;">Allows for creating a relative
navigation</td>
</tr>
<tr class="odd">
<td style="text-align: left;">– .Link</td>
<td style="text-align: left;">The relative to the root link of the
Text.</td>
</tr>
<tr class="even">
<td style="text-align: left;">– .Text</td>
<td style="text-align: left;">The Name of the directory.</td>
</tr>
<tr class="odd">
<td style="text-align: left;">.Entries</td>
<td style="text-align: left;">Information about a specific
file/directory.</td>
</tr>
<tr class="even">
<td style="text-align: left;">– .URL</td>
<td style="text-align: left;">The ‘url’ of an entry.</td>
</tr>
<tr class="odd">
<td style="text-align: left;">– .Leaf</td>
<td style="text-align: left;">Currently same as ‘URL’ but intended to be
‘just’ the name.</td>
</tr>
<tr class="even">
<td style="text-align: left;">– .IsDir</td>
<td style="text-align: left;">Boolean for if an entry is a directory or
not.</td>
</tr>
<tr class="odd">
<td style="text-align: left;">– .Size</td>
<td style="text-align: left;">Size in Bytes of the entry.</td>
</tr>
<tr class="even">
<td style="text-align: left;">– .ModTime</td>
<td style="text-align: left;">The UTC timestamp of an entry.</td>
</tr>
</tbody>
</table>
<h3 id="authentication-2">Authentication</h3>
<p>By default this will serve files without needing a login.</p>
<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>
<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>
<p>To create an htpasswd file:</p>
<pre><code>touch htpasswd
htpasswd -B htpasswd user
htpasswd -B htpasswd anotherUser</code></pre>
<p>The password file can be updated while rclone is running.</p>
<p>Use <code>--realm</code> to set the authentication realm.</p>
<h3 id="ssltls-1">SSL/TLS</h3>
<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>
<p><code>--cert</code> should be 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>
<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>
<pre><code>rclone serve restic remote:path [flags]</code></pre>
<h2 id="options-72">Options</h2>
<pre><code>      --addr string                     IPaddress:Port or :Port to bind server to (default &quot;localhost:8080&quot;)
      --append-only                     Disallow deletion of repository data
      --baseurl string                  Prefix for URLs - leave blank for root
      --cache-objects                   Cache listed objects (default true)
      --cert string                     SSL PEM key (concatenation of certificate and CA certificate)
      --client-ca string                Client certificate authority to verify clients with
  -h, --help                            help for restic
      --htpasswd string                 htpasswd file - if not provided no authentication is done
      --key string                      SSL PEM Private key
      --max-header-bytes int            Maximum size of request header (default 4096)
      --min-tls-version string          Minimum TLS version that is acceptable (default &quot;tls1.0&quot;)
      --pass string                     Password for authentication
      --private-repos                   Users can only access their private repo
      --realm string                    Realm for authentication (default &quot;rclone&quot;)
      --server-read-timeout duration    Timeout for server reading data (default 1h0m0s)
      --server-write-timeout duration   Timeout for server writing data (default 1h0m0s)
      --stdio                           Run an HTTP2 server on stdin/stdout
      --template string                 User-specified template
      --user string                     User name for authentication</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-72">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone_serve/">rclone serve</a>
- Serve a remote over a protocol.</li>
</ul>
<h1 id="rclone-serve-sftp">rclone serve sftp</h1>
<p>Serve the remote over SFTP.</p>
<h2 id="synopsis-65">Synopsis</h2>
<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>
<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>
<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>
<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>
<p>The server will log errors. Use <code>-v</code> to see access
logs.</p>
<p><code>--bwlimit</code> will be respected for file transfers. Use
<code>--stats</code> to control the stats printing.</p>
<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>
<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>
<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>
<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>
<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>
<pre><code>restrict,command=&quot;rclone serve sftp --stdio ./photos&quot; ssh-rsa ...</code></pre>
<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>
<p>The “restrict” in authorized_keys prevents SHA1SUMs and MD5SUMs from
beeing 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>
<h2 id="vfs---virtual-file-system-5">VFS - Virtual File System</h2>
<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>
<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>
<p>The VFS layer also implements a directory cache - this caches info
about files and directories (but not the data) in memory.</p>
<h2 id="vfs-directory-cache-5">VFS Directory Cache</h2>
<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>
<pre><code>--dir-cache-time duration   Time to cache directory entries for (default 5m0s)
--poll-interval duration    Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable (default 1m0s)</code></pre>
<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>
<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>
<pre><code>kill -SIGHUP $(pidof rclone)</code></pre>
<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>
<pre><code>rclone rc vfs/forget</code></pre>
<p>Or individual files or directories:</p>
<pre><code>rclone rc vfs/forget file=path/to/file dir=path/to/dir</code></pre>
<h2 id="vfs-file-buffering-5">VFS File Buffering</h2>
<p>The <code>--buffer-size</code> flag determines the amount of memory,
that will be used to buffer data in advance.</p>
<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>
<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>
<p>The maximum memory used by rclone for buffering can be up to
<code>--buffer-size * open files</code>.</p>
<h2 id="vfs-file-caching-5">VFS File Caching</h2>
<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>
<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>
<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>
<pre><code>--cache-dir string                   Directory rclone will use for caching.
--vfs-cache-mode CacheMode           Cache mode off|minimal|writes|full (default off)
--vfs-cache-max-age duration         Max age of objects in the cache (default 1h0m0s)
--vfs-cache-max-size SizeSuffix      Max total size of objects in the cache (default off)
--vfs-cache-poll-interval duration   Interval to poll the cache for stale objects (default 1m0s)
--vfs-write-back duration            Time to writeback files after last use when using cache (default 5s)</code></pre>
<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>
<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>
<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>
<p>If using <code>--vfs-cache-max-size</code> note that the cache may
exceed this size 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.</p>
<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 &gt; 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>
<h3 id="vfs-cache-mode-off-5">–vfs-cache-mode off</h3>
<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>
<p>This will mean some operations are not possible</p>
<ul>
<li>Files can’t be opened for both read AND write</li>
<li>Files opened for write can’t be seeked</li>
<li>Existing files opened for write must have O_TRUNC set</li>
<li>Files open for read with O_TRUNC will be opened write only</li>
<li>Files open for write only will behave as if O_TRUNC was
supplied</li>
<li>Open modes O_APPEND, O_TRUNC are ignored</li>
<li>If an upload fails it can’t be retried</li>
</ul>
<h3 id="vfs-cache-mode-minimal-5">–vfs-cache-mode minimal</h3>
<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>
<p>These operations are not possible</p>
<ul>
<li>Files opened for write only can’t be seeked</li>
<li>Existing files opened for write must have O_TRUNC set</li>
<li>Files opened for write only will ignore O_APPEND, O_TRUNC</li>
<li>If an upload fails it can’t be retried</li>
</ul>
<h3 id="vfs-cache-mode-writes-5">–vfs-cache-mode writes</h3>
<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>
<p>This mode should support all normal file system operations.</p>
<p>If an upload fails it will be retried at exponentially increasing
intervals up to 1 minute.</p>
<h3 id="vfs-cache-mode-full-5">–vfs-cache-mode full</h3>
<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>
<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>
<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>
<p>This mode should support all normal file system operations and is
otherwise identical to <code>--vfs-cache-mode</code> writes.</p>
<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>
<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>
<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>
<h3 id="fingerprinting-5">Fingerprinting</h3>
<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>
<ul>
<li>size</li>
<li>modification time</li>
<li>hash</li>
</ul>
<p>where available on an object.</p>
<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>
<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>
<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>
<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>
<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>
<h2 id="vfs-chunked-reading-5">VFS Chunked Reading</h2>
<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>
<p>These flags control the chunking:</p>
<pre><code>--vfs-read-chunk-size SizeSuffix        Read the source objects in chunks (default 128M)
--vfs-read-chunk-size-limit SizeSuffix  Max chunk doubling size (default off)</code></pre>
<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>
<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>
<p>Setting <code>--vfs-read-chunk-size</code> to <code>0</code> or “off”
disables chunked reading.</p>
<h2 id="vfs-performance-5">VFS Performance</h2>
<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>
<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>
<pre><code>--no-checksum     Don&#39;t compare checksums on up/download.
--no-modtime      Don&#39;t read/write the modification time (can speed things up).
--no-seek         Don&#39;t allow seeking in files.
--read-only       Only allow read-only access.</code></pre>
<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>
<pre><code>--vfs-read-wait duration   Time to wait for in-sequence read before seeking (default 20ms)
--vfs-write-wait duration  Time to wait for in-sequence write before giving error (default 1s)</code></pre>
<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>
<pre><code>--transfers int  Number of file transfers to run in parallel (default 4)</code></pre>
<h2 id="vfs-case-sensitivity-5">VFS Case Sensitivity</h2>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<h2 id="vfs-disk-options-5">VFS Disk Options</h2>
<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>
<pre><code>--vfs-disk-space-total-size    Manually set the total disk space size (example: 256G, default: -1)</code></pre>
<h2 id="alternate-report-of-used-bytes-5">Alternate report of used
bytes</h2>
<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>
<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>
<h2 id="auth-proxy-1">Auth Proxy</h2>
<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>
<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>
<p>There is an example program <a
href="https://github.com/rclone/rclone/blob/master/test_proxy.py">bin/test_proxy.py</a>
in the rclone source code.</p>
<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>
<p>This config generated must have this extra parameter -
<code>_root</code> - root to use for the backend</p>
<p>And it may have this parameter - <code>_obscure</code> - comma
separated strings for parameters to obscure</p>
<p>If password authentication was used by the client, input to the proxy
process (on STDIN) would look similar to this:</p>
<pre><code>{
    &quot;user&quot;: &quot;me&quot;,
    &quot;pass&quot;: &quot;mypassword&quot;
}</code></pre>
<p>If public-key authentication was used by the client, input to the
proxy process (on STDIN) would look similar to this:</p>
<pre><code>{
    &quot;user&quot;: &quot;me&quot;,
    &quot;public_key&quot;: &quot;AAAAB3NzaC1yc2EAAAADAQABAAABAQDuwESFdAe14hVS6omeyX7edc...JQdf&quot;
}</code></pre>
<p>And as an example return this on STDOUT</p>
<pre><code>{
    &quot;type&quot;: &quot;sftp&quot;,
    &quot;_root&quot;: &quot;&quot;,
    &quot;_obscure&quot;: &quot;pass&quot;,
    &quot;user&quot;: &quot;me&quot;,
    &quot;pass&quot;: &quot;mypassword&quot;,
    &quot;host&quot;: &quot;sftp.example.com&quot;
}</code></pre>
<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>
<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>
<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>
<p>This can be used to build general purpose proxies to any kind of
backend that rclone supports.</p>
<pre><code>rclone serve sftp remote:path [flags]</code></pre>
<h2 id="options-73">Options</h2>
<pre><code>      --addr string                            IPaddress:Port or :Port to bind server to (default &quot;localhost:2022&quot;)
      --auth-proxy string                      A program to use to create the backend from the auth
      --authorized-keys string                 Authorized keys file (default &quot;~/.ssh/authorized_keys&quot;)
      --dir-cache-time duration                Time to cache directory entries for (default 5m0s)
      --dir-perms FileMode                     Directory permissions (default 0777)
      --file-perms FileMode                    File permissions (default 0666)
      --gid uint32                             Override the gid field set by the filesystem (not supported on Windows) (default 1000)
  -h, --help                                   help for sftp
      --key stringArray                        SSH private host key file (Can be multi-valued, leave blank to auto generate)
      --no-auth                                Allow connections with no authentication if set
      --no-checksum                            Don&#39;t compare checksums on up/download
      --no-modtime                             Don&#39;t read/write the modification time (can speed things up)
      --no-seek                                Don&#39;t allow seeking in files
      --pass string                            Password for authentication
      --poll-interval duration                 Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s)
      --read-only                              Only allow read-only access
      --stdio                                  Run an sftp server on stdin/stdout
      --uid uint32                             Override the uid field set by the filesystem (not supported on Windows) (default 1000)
      --umask int                              Override the permission bits set by the filesystem (not supported on Windows) (default 2)
      --user string                            User name for authentication
      --vfs-cache-max-age duration             Max age of objects in the cache (default 1h0m0s)
      --vfs-cache-max-size SizeSuffix          Max total size of objects in the cache (default off)
      --vfs-cache-mode CacheMode               Cache mode off|minimal|writes|full (default off)
      --vfs-cache-poll-interval duration       Interval to poll the cache for stale objects (default 1m0s)
      --vfs-case-insensitive                   If a file name not found, find a case insensitive match
      --vfs-disk-space-total-size SizeSuffix   Specify the total space of disk (default off)
      --vfs-fast-fingerprint                   Use fast (less accurate) fingerprints for change detection
      --vfs-read-ahead SizeSuffix              Extra read ahead over --buffer-size when using cache-mode full
      --vfs-read-chunk-size SizeSuffix         Read the source objects in chunks (default 128Mi)
      --vfs-read-chunk-size-limit SizeSuffix   If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached (&#39;off&#39; is unlimited) (default off)
      --vfs-read-wait duration                 Time to wait for in-sequence read before seeking (default 20ms)
      --vfs-used-is-size rclone size           Use the rclone size algorithm for Used size
      --vfs-write-back duration                Time to writeback files after last use when using cache (default 5s)
      --vfs-write-wait duration                Time to wait for in-sequence write before giving error (default 1s)</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-73">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone_serve/">rclone serve</a>
- Serve a remote over a protocol.</li>
</ul>
<h1 id="rclone-serve-webdav">rclone serve webdav</h1>
<p>Serve remote:path over WebDAV.</p>
<h2 id="synopsis-66">Synopsis</h2>
<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>
<h2 id="webdav-options">WebDAV options</h2>
<h3 id="etag-hash">–etag-hash</h3>
<p>This controls the ETag header. Without this flag the ETag will be
based on the ModTime and Size of the object.</p>
<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>
<h2 id="server-options-4">Server options</h2>
<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. By default it only
listens on localhost. You can use port :0 to let the OS choose an
available port.</p>
<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>
<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>
<p><code>--max-header-bytes</code> controls the maximum number of bytes
the server will accept in the HTTP header.</p>
<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>
<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>
<table>
<colgroup>
<col style="width: 50%" />
<col style="width: 50%" />
</colgroup>
<thead>
<tr class="header">
<th style="text-align: left;">Parameter</th>
<th style="text-align: left;">Description</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td style="text-align: left;">.Name</td>
<td style="text-align: left;">The full path of a file/directory.</td>
</tr>
<tr class="even">
<td style="text-align: left;">.Title</td>
<td style="text-align: left;">Directory listing of .Name</td>
</tr>
<tr class="odd">
<td style="text-align: left;">.Sort</td>
<td style="text-align: left;">The current sort used. This is changeable
via ?sort= parameter</td>
</tr>
<tr class="even">
<td style="text-align: left;"></td>
<td style="text-align: left;">Sort Options: namedirfirst,name,size,time
(default namedirfirst)</td>
</tr>
<tr class="odd">
<td style="text-align: left;">.Order</td>
<td style="text-align: left;">The current ordering used. This is
changeable via ?order= parameter</td>
</tr>
<tr class="even">
<td style="text-align: left;"></td>
<td style="text-align: left;">Order Options: asc,desc (default asc)</td>
</tr>
<tr class="odd">
<td style="text-align: left;">.Query</td>
<td style="text-align: left;">Currently unused.</td>
</tr>
<tr class="even">
<td style="text-align: left;">.Breadcrumb</td>
<td style="text-align: left;">Allows for creating a relative
navigation</td>
</tr>
<tr class="odd">
<td style="text-align: left;">– .Link</td>
<td style="text-align: left;">The relative to the root link of the
Text.</td>
</tr>
<tr class="even">
<td style="text-align: left;">– .Text</td>
<td style="text-align: left;">The Name of the directory.</td>
</tr>
<tr class="odd">
<td style="text-align: left;">.Entries</td>
<td style="text-align: left;">Information about a specific
file/directory.</td>
</tr>
<tr class="even">
<td style="text-align: left;">– .URL</td>
<td style="text-align: left;">The ‘url’ of an entry.</td>
</tr>
<tr class="odd">
<td style="text-align: left;">– .Leaf</td>
<td style="text-align: left;">Currently same as ‘URL’ but intended to be
‘just’ the name.</td>
</tr>
<tr class="even">
<td style="text-align: left;">– .IsDir</td>
<td style="text-align: left;">Boolean for if an entry is a directory or
not.</td>
</tr>
<tr class="odd">
<td style="text-align: left;">– .Size</td>
<td style="text-align: left;">Size in Bytes of the entry.</td>
</tr>
<tr class="even">
<td style="text-align: left;">– .ModTime</td>
<td style="text-align: left;">The UTC timestamp of an entry.</td>
</tr>
</tbody>
</table>
<h3 id="authentication-3">Authentication</h3>
<p>By default this will serve files without needing a login.</p>
<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>
<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>
<p>To create an htpasswd file:</p>
<pre><code>touch htpasswd
htpasswd -B htpasswd user
htpasswd -B htpasswd anotherUser</code></pre>
<p>The password file can be updated while rclone is running.</p>
<p>Use <code>--realm</code> to set the authentication realm.</p>
<h3 id="ssltls-2">SSL/TLS</h3>
<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>
<p><code>--cert</code> should be 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>
<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>
<h2 id="vfs---virtual-file-system-6">VFS - Virtual File System</h2>
<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>
<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>
<p>The VFS layer also implements a directory cache - this caches info
about files and directories (but not the data) in memory.</p>
<h2 id="vfs-directory-cache-6">VFS Directory Cache</h2>
<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>
<pre><code>--dir-cache-time duration   Time to cache directory entries for (default 5m0s)
--poll-interval duration    Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable (default 1m0s)</code></pre>
<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>
<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>
<pre><code>kill -SIGHUP $(pidof rclone)</code></pre>
<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>
<pre><code>rclone rc vfs/forget</code></pre>
<p>Or individual files or directories:</p>
<pre><code>rclone rc vfs/forget file=path/to/file dir=path/to/dir</code></pre>
<h2 id="vfs-file-buffering-6">VFS File Buffering</h2>
<p>The <code>--buffer-size</code> flag determines the amount of memory,
that will be used to buffer data in advance.</p>
<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>
<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>
<p>The maximum memory used by rclone for buffering can be up to
<code>--buffer-size * open files</code>.</p>
<h2 id="vfs-file-caching-6">VFS File Caching</h2>
<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>
<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>
<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>
<pre><code>--cache-dir string                   Directory rclone will use for caching.
--vfs-cache-mode CacheMode           Cache mode off|minimal|writes|full (default off)
--vfs-cache-max-age duration         Max age of objects in the cache (default 1h0m0s)
--vfs-cache-max-size SizeSuffix      Max total size of objects in the cache (default off)
--vfs-cache-poll-interval duration   Interval to poll the cache for stale objects (default 1m0s)
--vfs-write-back duration            Time to writeback files after last use when using cache (default 5s)</code></pre>
<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>
<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>
<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>
<p>If using <code>--vfs-cache-max-size</code> note that the cache may
exceed this size 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.</p>
<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 &gt; 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>
<h3 id="vfs-cache-mode-off-6">–vfs-cache-mode off</h3>
<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>
<p>This will mean some operations are not possible</p>
<ul>
<li>Files can’t be opened for both read AND write</li>
<li>Files opened for write can’t be seeked</li>
<li>Existing files opened for write must have O_TRUNC set</li>
<li>Files open for read with O_TRUNC will be opened write only</li>
<li>Files open for write only will behave as if O_TRUNC was
supplied</li>
<li>Open modes O_APPEND, O_TRUNC are ignored</li>
<li>If an upload fails it can’t be retried</li>
</ul>
<h3 id="vfs-cache-mode-minimal-6">–vfs-cache-mode minimal</h3>
<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>
<p>These operations are not possible</p>
<ul>
<li>Files opened for write only can’t be seeked</li>
<li>Existing files opened for write must have O_TRUNC set</li>
<li>Files opened for write only will ignore O_APPEND, O_TRUNC</li>
<li>If an upload fails it can’t be retried</li>
</ul>
<h3 id="vfs-cache-mode-writes-6">–vfs-cache-mode writes</h3>
<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>
<p>This mode should support all normal file system operations.</p>
<p>If an upload fails it will be retried at exponentially increasing
intervals up to 1 minute.</p>
<h3 id="vfs-cache-mode-full-6">–vfs-cache-mode full</h3>
<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>
<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>
<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>
<p>This mode should support all normal file system operations and is
otherwise identical to <code>--vfs-cache-mode</code> writes.</p>
<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>
<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>
<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>
<h3 id="fingerprinting-6">Fingerprinting</h3>
<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>
<ul>
<li>size</li>
<li>modification time</li>
<li>hash</li>
</ul>
<p>where available on an object.</p>
<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>
<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>
<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>
<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>
<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>
<h2 id="vfs-chunked-reading-6">VFS Chunked Reading</h2>
<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>
<p>These flags control the chunking:</p>
<pre><code>--vfs-read-chunk-size SizeSuffix        Read the source objects in chunks (default 128M)
--vfs-read-chunk-size-limit SizeSuffix  Max chunk doubling size (default off)</code></pre>
<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>
<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>
<p>Setting <code>--vfs-read-chunk-size</code> to <code>0</code> or “off”
disables chunked reading.</p>
<h2 id="vfs-performance-6">VFS Performance</h2>
<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>
<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>
<pre><code>--no-checksum     Don&#39;t compare checksums on up/download.
--no-modtime      Don&#39;t read/write the modification time (can speed things up).
--no-seek         Don&#39;t allow seeking in files.
--read-only       Only allow read-only access.</code></pre>
<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>
<pre><code>--vfs-read-wait duration   Time to wait for in-sequence read before seeking (default 20ms)
--vfs-write-wait duration  Time to wait for in-sequence write before giving error (default 1s)</code></pre>
<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>
<pre><code>--transfers int  Number of file transfers to run in parallel (default 4)</code></pre>
<h2 id="vfs-case-sensitivity-6">VFS Case Sensitivity</h2>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<h2 id="vfs-disk-options-6">VFS Disk Options</h2>
<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>
<pre><code>--vfs-disk-space-total-size    Manually set the total disk space size (example: 256G, default: -1)</code></pre>
<h2 id="alternate-report-of-used-bytes-6">Alternate report of used
bytes</h2>
<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>
<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>
<h2 id="auth-proxy-2">Auth Proxy</h2>
<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>
<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>
<p>There is an example program <a
href="https://github.com/rclone/rclone/blob/master/test_proxy.py">bin/test_proxy.py</a>
in the rclone source code.</p>
<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>
<p>This config generated must have this extra parameter -
<code>_root</code> - root to use for the backend</p>
<p>And it may have this parameter - <code>_obscure</code> - comma
separated strings for parameters to obscure</p>
<p>If password authentication was used by the client, input to the proxy
process (on STDIN) would look similar to this:</p>
<pre><code>{
    &quot;user&quot;: &quot;me&quot;,
    &quot;pass&quot;: &quot;mypassword&quot;
}</code></pre>
<p>If public-key authentication was used by the client, input to the
proxy process (on STDIN) would look similar to this:</p>
<pre><code>{
    &quot;user&quot;: &quot;me&quot;,
    &quot;public_key&quot;: &quot;AAAAB3NzaC1yc2EAAAADAQABAAABAQDuwESFdAe14hVS6omeyX7edc...JQdf&quot;
}</code></pre>
<p>And as an example return this on STDOUT</p>
<pre><code>{
    &quot;type&quot;: &quot;sftp&quot;,
    &quot;_root&quot;: &quot;&quot;,
    &quot;_obscure&quot;: &quot;pass&quot;,
    &quot;user&quot;: &quot;me&quot;,
    &quot;pass&quot;: &quot;mypassword&quot;,
    &quot;host&quot;: &quot;sftp.example.com&quot;
}</code></pre>
<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>
<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>
<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>
<p>This can be used to build general purpose proxies to any kind of
backend that rclone supports.</p>
<pre><code>rclone serve webdav remote:path [flags]</code></pre>
<h2 id="options-74">Options</h2>
<pre><code>      --addr string                            IPaddress:Port or :Port to bind server to (default &quot;localhost:8080&quot;)
      --auth-proxy string                      A program to use to create the backend from the auth
      --baseurl string                         Prefix for URLs - leave blank for root
      --cert string                            SSL PEM key (concatenation of certificate and CA certificate)
      --client-ca string                       Client certificate authority to verify clients with
      --dir-cache-time duration                Time to cache directory entries for (default 5m0s)
      --dir-perms FileMode                     Directory permissions (default 0777)
      --disable-dir-list                       Disable HTML directory list on GET request for a directory
      --etag-hash string                       Which hash to use for the ETag, or auto or blank for off
      --file-perms FileMode                    File permissions (default 0666)
      --gid uint32                             Override the gid field set by the filesystem (not supported on Windows) (default 1000)
  -h, --help                                   help for webdav
      --htpasswd string                        htpasswd file - if not provided no authentication is done
      --key string                             SSL PEM Private key
      --max-header-bytes int                   Maximum size of request header (default 4096)
      --min-tls-version string                 Minimum TLS version that is acceptable (default &quot;tls1.0&quot;)
      --no-checksum                            Don&#39;t compare checksums on up/download
      --no-modtime                             Don&#39;t read/write the modification time (can speed things up)
      --no-seek                                Don&#39;t allow seeking in files
      --pass string                            Password for authentication
      --poll-interval duration                 Time to wait between polling for changes, must be smaller than dir-cache-time and only on supported remotes (set 0 to disable) (default 1m0s)
      --read-only                              Only allow read-only access
      --realm string                           Realm for authentication (default &quot;rclone&quot;)
      --server-read-timeout duration           Timeout for server reading data (default 1h0m0s)
      --server-write-timeout duration          Timeout for server writing data (default 1h0m0s)
      --template string                        User-specified template
      --uid uint32                             Override the uid field set by the filesystem (not supported on Windows) (default 1000)
      --umask int                              Override the permission bits set by the filesystem (not supported on Windows) (default 2)
      --user string                            User name for authentication
      --vfs-cache-max-age duration             Max age of objects in the cache (default 1h0m0s)
      --vfs-cache-max-size SizeSuffix          Max total size of objects in the cache (default off)
      --vfs-cache-mode CacheMode               Cache mode off|minimal|writes|full (default off)
      --vfs-cache-poll-interval duration       Interval to poll the cache for stale objects (default 1m0s)
      --vfs-case-insensitive                   If a file name not found, find a case insensitive match
      --vfs-disk-space-total-size SizeSuffix   Specify the total space of disk (default off)
      --vfs-fast-fingerprint                   Use fast (less accurate) fingerprints for change detection
      --vfs-read-ahead SizeSuffix              Extra read ahead over --buffer-size when using cache-mode full
      --vfs-read-chunk-size SizeSuffix         Read the source objects in chunks (default 128Mi)
      --vfs-read-chunk-size-limit SizeSuffix   If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached (&#39;off&#39; is unlimited) (default off)
      --vfs-read-wait duration                 Time to wait for in-sequence read before seeking (default 20ms)
      --vfs-used-is-size rclone size           Use the rclone size algorithm for Used size
      --vfs-write-back duration                Time to writeback files after last use when using cache (default 5s)
      --vfs-write-wait duration                Time to wait for in-sequence write before giving error (default 1s)</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-74">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone_serve/">rclone serve</a>
- Serve a remote over a protocol.</li>
</ul>
<h1 id="rclone-settier">rclone settier</h1>
<p>Changes storage class/tier of objects in remote.</p>
<h2 id="synopsis-67">Synopsis</h2>
<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>
<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>
<p>You can use it to tier single object</p>
<pre><code>rclone settier Cool remote:path/file</code></pre>
<p>Or use rclone filters to set tier on only specific files</p>
<pre><code>rclone --include &quot;*.txt&quot; settier Hot remote:path/dir</code></pre>
<p>Or just provide remote directory and all files in directory will be
tiered</p>
<pre><code>rclone settier tier remote:path/dir</code></pre>
<pre><code>rclone settier tier remote:path [flags]</code></pre>
<h2 id="options-75">Options</h2>
<pre><code>  -h, --help   help for settier</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-75">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h1 id="rclone-test">rclone test</h1>
<p>Run a test command</p>
<h2 id="synopsis-68">Synopsis</h2>
<p>Rclone test is used to run test commands.</p>
<p>Select which test comand you want with the subcommand, eg</p>
<pre><code>rclone test memory remote:</code></pre>
<p>Each subcommand has its own options which you can see in their
help.</p>
<p><strong>NB</strong> Be careful running these commands, they may do
strange things so reading their documentation first is recommended.</p>
<h2 id="options-76">Options</h2>
<pre><code>  -h, --help   help for test</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-76">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
<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>
<li><a href="https://rclone.org/commands/rclone_test_histogram/">rclone
test histogram</a> - Makes a histogram of file name characters.</li>
<li><a href="https://rclone.org/commands/rclone_test_info/">rclone test
info</a> - Discovers file name or other limitations for paths.</li>
<li><a href="https://rclone.org/commands/rclone_test_makefile/">rclone
test makefile</a> - Make files with random contents of the size
given</li>
<li><a href="https://rclone.org/commands/rclone_test_makefiles/">rclone
test makefiles</a> - Make a random file hierarchy in a directory</li>
<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>
</ul>
<h1 id="rclone-test-changenotify">rclone test changenotify</h1>
<p>Log any change notify requests for the remote passed in.</p>
<pre><code>rclone test changenotify remote: [flags]</code></pre>
<h2 id="options-77">Options</h2>
<pre><code>  -h, --help                     help for changenotify
      --poll-interval duration   Time to wait between polling for changes (default 10s)</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-77">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone_test/">rclone test</a> -
Run a test command</li>
</ul>
<h1 id="rclone-test-histogram">rclone test histogram</h1>
<p>Makes a histogram of file name characters.</p>
<h2 id="synopsis-69">Synopsis</h2>
<p>This command outputs JSON which shows the histogram of characters
used in filenames in the remote:path specified.</p>
<p>The data doesn’t contain any identifying information but is useful
for the rclone developers when developing filename compression.</p>
<pre><code>rclone test histogram [remote:path] [flags]</code></pre>
<h2 id="options-78">Options</h2>
<pre><code>  -h, --help   help for histogram</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-78">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone_test/">rclone test</a> -
Run a test command</li>
</ul>
<h1 id="rclone-test-info">rclone test info</h1>
<p>Discovers file name or other limitations for paths.</p>
<h2 id="synopsis-70">Synopsis</h2>
<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>
<p><strong>NB</strong> this can create undeletable files and other
hazards - use with care</p>
<pre><code>rclone test info [remote:path]+ [flags]</code></pre>
<h2 id="options-79">Options</h2>
<pre><code>      --all                    Run all tests
      --check-control          Check control characters
      --check-length           Check max filename length
      --check-normalization    Check UTF-8 Normalization
      --check-streaming        Check uploads with indeterminate file size
  -h, --help                   help for info
      --upload-wait duration   Wait after writing a file
      --write-json string      Write results to file</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-79">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone_test/">rclone test</a> -
Run a test command</li>
</ul>
<h1 id="rclone-test-makefile">rclone test makefile</h1>
<p>Make files with random contents of the size given</p>
<pre><code>rclone test makefile &lt;size&gt; [&lt;file&gt;]+ [flags]</code></pre>
<h2 id="options-80">Options</h2>
<pre><code>      --ascii      Fill files with random ASCII printable bytes only
      --chargen    Fill files with a ASCII chargen pattern
  -h, --help       help for makefile
      --pattern    Fill files with a periodic pattern
      --seed int   Seed for the random number generator (0 for random) (default 1)
      --sparse     Make the files sparse (appear to be filled with ASCII 0x00)
      --zero       Fill files with ASCII 0x00</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-80">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone_test/">rclone test</a> -
Run a test command</li>
</ul>
<h1 id="rclone-test-makefiles">rclone test makefiles</h1>
<p>Make a random file hierarchy in a directory</p>
<pre><code>rclone test makefiles &lt;dir&gt; [flags]</code></pre>
<h2 id="options-81">Options</h2>
<pre><code>      --ascii                      Fill files with random ASCII printable bytes only
      --chargen                    Fill files with a ASCII chargen pattern
      --files int                  Number of files to create (default 1000)
      --files-per-directory int    Average number of files per directory (default 10)
  -h, --help                       help for makefiles
      --max-file-size SizeSuffix   Maximum size of files to create (default 100)
      --max-name-length int        Maximum size of file names (default 12)
      --min-file-size SizeSuffix   Minimum size of file to create
      --min-name-length int        Minimum size of file names (default 4)
      --pattern                    Fill files with a periodic pattern
      --seed int                   Seed for the random number generator (0 for random) (default 1)
      --sparse                     Make the files sparse (appear to be filled with ASCII 0x00)
      --zero                       Fill files with ASCII 0x00</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-81">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone_test/">rclone test</a> -
Run a test command</li>
</ul>
<h1 id="rclone-test-memory">rclone test memory</h1>
<p>Load all the objects at remote:path into memory and report memory
stats.</p>
<pre><code>rclone test memory remote:path [flags]</code></pre>
<h2 id="options-82">Options</h2>
<pre><code>  -h, --help   help for memory</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-82">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone_test/">rclone test</a> -
Run a test command</li>
</ul>
<h1 id="rclone-touch">rclone touch</h1>
<p>Create new file or change file modification time.</p>
<h2 id="synopsis-71">Synopsis</h2>
<p>Set the modification time on file(s) as specified by remote:path to
have the current time.</p>
<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>
<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> flag.</p>
<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>
<ul>
<li>‘YYMMDD’ - e.g. 17.10.30</li>
<li>‘YYYY-MM-DDTHH:MM:SS’ - e.g. 2006-01-02T15:04:05</li>
<li>‘YYYY-MM-DDTHH:MM:SS.SSS’ - e.g. 2006-01-02T15:04:05.123456789</li>
</ul>
<p>Note that value of <code>--timestamp</code> is in UTC. If you want
local time then add the <code>--localtime</code> flag.</p>
<pre><code>rclone touch remote:path [flags]</code></pre>
<h2 id="options-83">Options</h2>
<pre><code>  -h, --help               help for touch
      --localtime          Use localtime for timestamp, not UTC
  -C, --no-create          Do not create the file if it does not exist (implied with --recursive)
  -R, --recursive          Recursively touch all files
  -t, --timestamp string   Use specified time instead of the current time of day</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-83">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h1 id="rclone-tree">rclone tree</h1>
<p>List the contents of the remote in a tree like fashion.</p>
<h2 id="synopsis-72">Synopsis</h2>
<p>rclone tree lists the contents of a remote in a similar way to the
unix tree command.</p>
<p>For example</p>
<pre><code>$ rclone tree remote:path
/
├── file1
├── file2
├── file3
└── subdir
    ├── file4
    └── file5

1 directories, 5 files</code></pre>
<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>
<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>
<p>For a more interactive navigation of the remote see the <a
href="https://rclone.org/commands/rclone_ncdu/">ncdu</a> command.</p>
<pre><code>rclone tree remote:path [flags]</code></pre>
<h2 id="options-84">Options</h2>
<pre><code>  -a, --all             All files are listed (list . files too)
  -C, --color           Turn colorization on always
  -d, --dirs-only       List directories only
      --dirsfirst       List directories before files (-U disables)
      --full-path       Print the full path prefix for each file
  -h, --help            help for tree
      --level int       Descend only level directories deep
  -D, --modtime         Print the date of last modification.
      --noindent        Don&#39;t print indentation lines
      --noreport        Turn off file/directory count at end of tree listing
  -o, --output string   Output to file instead of stdout
  -p, --protections     Print the protections for each file.
  -Q, --quote           Quote filenames with double quotes.
  -s, --size            Print the size in bytes of each file.
      --sort string     Select sort: name,version,size,mtime,ctime
      --sort-ctime      Sort files by last status change time
  -t, --sort-modtime    Sort files by last modification time
  -r, --sort-reverse    Reverse the order of the sort
  -U, --unsorted        Leave files unsorted
      --version         Sort files alphanumerically by version</code></pre>
<p>See the <a href="https://rclone.org/flags/">global flags page</a> for
global options not listed here.</p>
<h2 id="see-also-84">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
for rclone commands, flags and backends.</li>
</ul>
<h2 id="copying-single-files">Copying single files</h2>
<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>
<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>
<pre><code>rclone copy remote:test.jpg /tmp/download</code></pre>
<p>The file <code>test.jpg</code> will be placed inside
<code>/tmp/download</code>.</p>
<p>This is equivalent to specifying</p>
<pre><code>rclone copy --files-from /tmp/files remote: /tmp/download</code></pre>
<p>Where <code>/tmp/files</code> contains the single line</p>
<pre><code>test.jpg</code></pre>
<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>
<h2 id="syntax-of-remote-paths">Syntax of remote paths</h2>
<p>The syntax of the paths passed to the rclone command are as
follows.</p>
<h3 id="pathtodir">/path/to/dir</h3>
<p>This refers to the local file system.</p>
<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>
<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>
<h3 id="remotepathtodir">remote:path/to/dir</h3>
<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>
<h3 id="remotepathtodir-1">remote:/path/to/dir</h3>
<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>
<h3 id="backendpathtodir">:backend:path/to/dir</h3>
<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>
<p>Here are some examples:</p>
<pre><code>rclone lsd --http-url https://pub.rclone.org :http:</code></pre>
<p>To list all the directories in the root of
<code>https://pub.rclone.org/</code>.</p>
<pre><code>rclone lsf --http-url https://example.com :http:path/to/dir</code></pre>
<p>To list files and directories in
<code>https://example.com/path/to/dir/</code></p>
<pre><code>rclone copy --http-url https://example.com :http:path/to/dir /tmp/dir</code></pre>
<p>To copy files and directories in
<code>https://example.com/path/to/dir</code> to
<code>/tmp/dir</code>.</p>
<pre><code>rclone copy --sftp-host example.com :sftp:path/to/dir /tmp/dir</code></pre>
<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>
<h3 id="connection-strings">Connection strings</h3>
<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>
<pre><code>rclone lsd &quot;:http,url=&#39;https://pub.rclone.org&#39;:&quot;
rclone lsf &quot;:http,url=&#39;https://example.com&#39;:path/to/dir&quot;
rclone copy &quot;:http,url=&#39;https://example.com&#39;:path/to/dir&quot; /tmp/dir
rclone copy :sftp,host=example.com:path/to/dir /tmp/dir</code></pre>
<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>
<pre><code>rclone lsf &quot;gdrive,shared_with_me:path/to/dir&quot;</code></pre>
<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>
<pre><code>rclone copy --drive-shared-with-me gdrive:shared-file.txt gdrive:</code></pre>
<p>However using the connection string syntax, this does work.</p>
<pre><code>rclone copy &quot;gdrive,shared_with_me:shared-file.txt&quot; gdrive:</code></pre>
<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>
<pre><code>rclone copy &quot;gdriveCrypt,shared_with_me:shared-file.txt&quot; gdriveCrypt:</code></pre>
<p>The connection strings have the following syntax</p>
<pre><code>remote,parameter=value,parameter2=value2:path/to/dir
:backend,parameter=value,parameter2=value2:path/to/dir</code></pre>
<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>
<pre><code>remote,parameter=&quot;colon:value&quot;,parameter2=&quot;comma,value&quot;:path/to/dir
:backend,parameter=&#39;colon:value&#39;,parameter2=&#39;comma,value&#39;:path/to/dir</code></pre>
<p>If a quoted value needs to include that quote, then it should be
doubled, so</p>
<pre><code>remote,parameter=&quot;with&quot;&quot;quote&quot;,parameter2=&#39;with&#39;&#39;quote&#39;:path/to/dir</code></pre>
<p>This will make <code>parameter</code> be <code>with"quote</code> and
<code>parameter2</code> be <code>with'quote</code>.</p>
<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>
<pre><code>rclone lsd :s3,env_auth:</code></pre>
<p>Which is equivalent to</p>
<pre><code>rclone lsd :s3,env_auth=true:</code></pre>
<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>
<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>
<pre><code>rclone copy &quot;:http,url=&#39;https://example.com&#39;:path/to/dir&quot; /tmp/dir</code></pre>
<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>
<pre><code>rclone copy &#39;:http,url=&quot;https://example.com&quot;:path/to/dir&#39; /tmp/dir</code></pre>
<h4 id="connection-strings-config-and-logging">Connection strings,
config and logging</h4>
<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>
<pre><code>rclone -vv lsf --s3-chunk-size 20M s3:</code></pre>
<p>Has the log message</p>
<pre><code>DEBUG : s3: detected overridden config - adding &quot;{Srj1p}&quot; suffix to name</code></pre>
<p>This is so rclone can tell the modified remote apart from the
unmodified remote when caching the backends.</p>
<p>This should only be noticeable in the logs.</p>
<p>This means that on the fly backends such as</p>
<pre><code>rclone -vv lsf :s3,env_auth:</code></pre>
<p>Will get their own names</p>
<pre><code>DEBUG : :s3: detected overridden config - adding &quot;{YTu53}&quot; suffix to name</code></pre>
<h3 id="valid-remote-names">Valid remote names</h3>
<p>Remote names are case sensitive, and must adhere to the following
rules: - May only contain <code>0</code>-<code>9</code>,
<code>A</code>-<code>Z</code>, <code>a</code>-<code>z</code>,
<code>_</code>, <code>-</code>, <code>.</code> and space. - May not
start with <code>-</code> or space.</p>
<h2 id="quoting-and-the-shell">Quoting and the shell</h2>
<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>
<p>Here are some gotchas which may help users unfamiliar with the shell
rules</p>
<h3 id="linux-osx">Linux / OSX</h3>
<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>
<pre><code>rclone copy &#39;Important files?&#39; remote:backup</code></pre>
<p>If you want to send a <code>'</code> you will need to use
<code>"</code>, e.g.</p>
<pre><code>rclone copy &quot;O&#39;Reilly Reviews&quot; remote:backup</code></pre>
<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>
<h3 id="windows">Windows</h3>
<p>If your names have spaces in you need to put them in <code>"</code>,
e.g.</p>
<pre><code>rclone copy &quot;E:\folder name\folder name\folder name&quot; remote:backup</code></pre>
<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>
<pre><code>rclone copy E:\ remote:backup</code></pre>
<h2 id="copying-files-or-directories-with-in-the-names">Copying files or
directories with <code>:</code> in the names</h2>
<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>
<p>So to sync a directory called <code>sync:me</code> to a remote called
<code>remote:</code> use</p>
<pre><code>rclone sync -i ./sync:me remote:path</code></pre>
<p>or</p>
<pre><code>rclone sync -i /full/path/to/sync:me remote:path</code></pre>
<h2 id="server-side-copy">Server Side Copy</h2>
<p>Most remotes (but not all - see <a
href="https://rclone.org/overview/#optional-features">the overview</a>)
support server-side copy.</p>
<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>
<p>Eg</p>
<pre><code>rclone copy s3:oldbucket s3:newbucket</code></pre>
<p>Will copy the contents of <code>oldbucket</code> to
<code>newbucket</code> without downloading and re-uploading.</p>
<p>Remotes which don’t support server-side copy <strong>will</strong>
download and re-upload in this case.</p>
<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>
<p>Server side copies will only be attempted if the remote names are the
same.</p>
<p>This can be used when scripting to make aged backups efficiently,
e.g.</p>
<pre><code>rclone sync -i remote:current-backup remote:previous-backup
rclone sync -i /path/to/files remote:current-backup</code></pre>
<h2 id="metadata">Metadata support</h2>
<p>Metadata is data about a file which isn’t the contents of the file.
Normally rclone only preserves the modification time and the content
(MIME) type where possible.</p>
<p>Rclone supports preserving all the available metadata on files (not
directories) when using the <code>--metadata</code> or <code>-M</code>
flag.</p>
<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>
<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>
<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>
<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>
<h3 id="types-of-metadata">Types of metadata</h3>
<p>Metadata is divided into two type. System metadata and User
metadata.</p>
<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>
<p>Arbitrary metadata is called user metadata and this can be set
however is desired.</p>
<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>
<h3 id="metadata-framework">Metadata framework</h3>
<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>
<p>This metadata is stored as a dictionary with string keys and string
values.</p>
<p>There are some limits on the names of the keys (these may be
clarified further in the future).</p>
<ul>
<li>must be lower case</li>
<li>may be <code>a-z</code> <code>0-9</code> containing <code>.</code>
<code>-</code> or <code>_</code></li>
<li>length is backend dependent</li>
</ul>
<p>Each backend can provide system metadata that it understands. Some
backends can also store arbitrary user metadata.</p>
<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>
<p>Some backends have limits on the size of the metadata and rclone will
give errors on upload if they are exceeded.</p>
<h3 id="metadata-preservation">Metadata preservation</h3>
<p>The goal of the implementation is to</p>
<ol type="1">
<li>Preserve metadata if at all possible</li>
<li>Interpret metadata if at all possible</li>
</ol>
<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>
<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>
<h3 id="standard-system-metadata">Standard system metadata</h3>
<p>Here is a table of standard system metadata which, if appropriate, a
backend may implement.</p>
<table>
<colgroup>
<col style="width: 48%" />
<col style="width: 30%" />
<col style="width: 20%" />
</colgroup>
<thead>
<tr class="header">
<th>key</th>
<th>description</th>
<th>example</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>mode</td>
<td>File type and mode: octal, unix style</td>
<td>0100664</td>
</tr>
<tr class="even">
<td>uid</td>
<td>User ID of owner: decimal number</td>
<td>500</td>
</tr>
<tr class="odd">
<td>gid</td>
<td>Group ID of owner: decimal number</td>
<td>500</td>
</tr>
<tr class="even">
<td>rdev</td>
<td>Device ID (if special file) =&gt; hexadecimal</td>
<td>0</td>
</tr>
<tr class="odd">
<td>atime</td>
<td>Time of last access: RFC 3339</td>
<td>2006-01-02T15:04:05.999999999Z07:00</td>
</tr>
<tr class="even">
<td>mtime</td>
<td>Time of last modification: RFC 3339</td>
<td>2006-01-02T15:04:05.999999999Z07:00</td>
</tr>
<tr class="odd">
<td>btime</td>
<td>Time of file creation (birth): RFC 3339</td>
<td>2006-01-02T15:04:05.999999999Z07:00</td>
</tr>
<tr class="even">
<td>cache-control</td>
<td>Cache-Control header</td>
<td>no-cache</td>
</tr>
<tr class="odd">
<td>content-disposition</td>
<td>Content-Disposition header</td>
<td>inline</td>
</tr>
<tr class="even">
<td>content-encoding</td>
<td>Content-Encoding header</td>
<td>gzip</td>
</tr>
<tr class="odd">
<td>content-language</td>
<td>Content-Language header</td>
<td>en-US</td>
</tr>
<tr class="even">
<td>content-type</td>
<td>Content-Type header</td>
<td>text/plain</td>
</tr>
</tbody>
</table>
<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>
<p>Hashes are not included in system metadata as there is a well defined
way of reading those already.</p>
<h2 id="options-85">Options</h2>
<p>Rclone has a number of options to control its behaviour.</p>
<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>
<h3 id="time-option">Time or duration options</h3>
<p>TIME or DURATION options can be specified as a duration string or a
time string.</p>
<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>
<ul>
<li><code>ms</code> - Milliseconds</li>
<li><code>s</code> - Seconds</li>
<li><code>m</code> - Minutes</li>
<li><code>h</code> - Hours</li>
<li><code>d</code> - Days</li>
<li><code>w</code> - Weeks</li>
<li><code>M</code> - Months</li>
<li><code>y</code> - Years</li>
</ul>
<p>These can also be specified as an absolute time in the following
formats:</p>
<ul>
<li>RFC3339 - e.g. <code>2006-01-02T15:04:05Z</code> or
<code>2006-01-02T15:04:05+07:00</code></li>
<li>ISO8601 Date and time, local timezone -
<code>2006-01-02T15:04:05</code></li>
<li>ISO8601 Date and time, local timezone -
<code>2006-01-02 15:04:05</code></li>
<li>ISO8601 Date - <code>2006-01-02</code> (YYYY-MM-DD)</li>
</ul>
<h3 id="size-option">Size options</h3>
<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>
<h3 id="backup-dirdir">–backup-dir=DIR</h3>
<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>
<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>
<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>
<p>For example</p>
<pre><code>rclone sync -i /path/to/local remote:current --backup-dir remote:old</code></pre>
<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>
<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>
<p>See <code>--compare-dest</code> and <code>--copy-dest</code>.</p>
<h3 id="bind-string">–bind string</h3>
<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>
<h3 id="bwlimitbandwidth_spec">–bwlimit=BANDWIDTH_SPEC</h3>
<p>This option controls the bandwidth limit. For example</p>
<pre><code>--bwlimit 10M</code></pre>
<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>
<p>The upload and download bandwidth can be specified separately, as
<code>--bwlimit UP:DOWN</code>, so</p>
<pre><code>--bwlimit 10M:100k</code></pre>
<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>
<pre><code>--bwlimit 10M:off</code></pre>
<p>this would limit the upload bandwidth to 10 MiB/s but the download
bandwidth would be unlimited.</p>
<p>When specified as above the bandwidth limits last for the duration of
run of the rclone binary.</p>
<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>
<ul>
<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>
<li><code>WEEKDAY</code> can be written as the whole word or only using
the first 3 characters. It is optional.</li>
<li><code>HH:MM</code> is an hour from 00:00 to 23:59.</li>
</ul>
<p>An example of a typical timetable to avoid link saturation during
daytime working hours could be:</p>
<p><code>--bwlimit "08:00,512k 12:00,10M 13:00,512k 18:00,30M 23:00,off"</code></p>
<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>
<p>An example of timetable with <code>WEEKDAY</code> could be:</p>
<p><code>--bwlimit "Mon-00:00,512 Fri-23:59,10M Sat-10:00,1M Sun-20:00,off"</code></p>
<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>
<p>Timeslots without <code>WEEKDAY</code> are extended to the whole
week. So this example:</p>
<p><code>--bwlimit "Mon-00:00,512 12:00,1M Sun-20:00,off"</code></p>
<p>Is equivalent to this:</p>
<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>
<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>
<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>
<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>
<pre><code>kill -SIGUSR2 $(pidof rclone)</code></pre>
<p>If you configure rclone with a <a href="/rc">remote control</a> then
you can use change the bwlimit dynamically:</p>
<pre><code>rclone rc core/bwlimit rate=1M</code></pre>
<h3 id="bwlimit-filebandwidth_spec">–bwlimit-file=BANDWIDTH_SPEC</h3>
<p>This option controls per file bandwidth limit. For the options see
the <code>--bwlimit</code> flag.</p>
<p>For example use this to allow no transfers to be faster than 1
MiB/s</p>
<pre><code>--bwlimit-file 1M</code></pre>
<p>This can be used in conjunction with <code>--bwlimit</code>.</p>
<p>Note that if a schedule is provided the file will use the schedule in
effect at the start of the transfer.</p>
<h3 id="buffer-sizesize">–buffer-size=SIZE</h3>
<p>Use this sized buffer to speed up file transfers. Each
<code>--transfer</code> will use this much memory for buffering.</p>
<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>
<p>Set to <code>0</code> to disable the buffering for the minimum memory
usage.</p>
<p>Note that the memory allocation of the buffers is influenced by the
<a href="#use-mmap">–use-mmap</a> flag.</p>
<h3 id="cache-dirdir">–cache-dir=DIR</h3>
<p>Specify the directory rclone will use for caching, to override the
default.</p>
<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>
<p>You can use the <a
href="https://rclone.org/commands/rclone_config_paths/">config paths</a>
command to see the current value.</p>
<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>
<h3 id="check-first">–check-first</h3>
<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>
<p>This flag can be useful on IO limited systems where transfers
interfere with checking.</p>
<p>It can also be useful to ensure perfect ordering when using
<code>--order-by</code>.</p>
<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>
<h3 id="checkersn">–checkers=N</h3>
<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>
<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>
<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>
<h3 id="c-checksum">-c, –checksum</h3>
<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>
<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>
<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>
<p>Eg <code>rclone --checksum sync s3:/bucket swift:/bucket</code> would
run much quicker than without the <code>--checksum</code> flag.</p>
<p>When using this flag, rclone won’t update mtimes of remote files if
they are incorrect as it would normally.</p>
<h3 id="compare-destdir">–compare-dest=DIR</h3>
<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>
<p>You must use the same remote as the destination of the sync. The
compare directory must not overlap the destination directory.</p>
<p>See <code>--copy-dest</code> and <code>--backup-dir</code>.</p>
<h3 id="configconfig_file">–config=CONFIG_FILE</h3>
<p>Specify the location of the rclone configuration file, to override
the default. E.g. <code>rclone config --config="rclone.conf"</code>.</p>
<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>
<ul>
<li><code>%APPDATA%/rclone/rclone.conf</code> on Windows</li>
<li><code>~/.config/rclone/rclone.conf</code> on other</li>
</ul>
<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>
<ol type="1">
<li><code>rclone.conf</code> (in program directory, where rclone
executable is)</li>
<li><code>%APPDATA%/rclone/rclone.conf</code> (only on Windows)</li>
<li><code>$XDG_CONFIG_HOME/rclone/rclone.conf</code> (on all systems,
including Windows)</li>
<li><code>~/.config/rclone/rclone.conf</code> (see below for explanation
of ~ symbol)</li>
<li><code>~/.rclone.conf</code></li>
</ol>
<p>If no existing configuration file is found, then a new one will be
created in the following location:</p>
<ul>
<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>
<li>On Unix: Location 3 if <code>XDG_CONFIG_HOME</code> is defined, else
location 4.</li>
<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>
</ul>
<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>
<ul>
<li>On Windows: <code>%HOME%</code> if defined, else
<code>%USERPROFILE%</code>, or else
<code>%HOMEDRIVE%\%HOMEPATH%</code>.</li>
<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 &amp;&amp; pwd</code>.</li>
</ul>
<p>If you run <code>rclone config file</code> you will see where the
default location is for you.</p>
<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>
<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>
<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>
<p>Example:</p>
<pre><code>[megaremote]
type = mega
user = you@example.com
pass = PDPcQVVjVtzFY-GTdDFozqBhTdsPg3qH</code></pre>
<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>
<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>
<p>When token-based authentication are used, the configuration file must
be writable, because rclone needs to update the tokens inside it.</p>
<h3 id="contimeouttime">–contimeout=TIME</h3>
<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>
<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>
<h3 id="copy-destdir">–copy-dest=DIR</h3>
<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>
<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>
<p>See <code>--compare-dest</code> and <code>--backup-dir</code>.</p>
<h3 id="dedupe-mode-mode">–dedupe-mode MODE</h3>
<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 />
See the dedupe command for more information as to what these options
mean.</p>
<h3 id="disable-featurefeature">–disable FEATURE,FEATURE,…</h3>
<p>This disables a comma separated list of optional features. For
example to disable server-side move and server-side copy use:</p>
<pre><code>--disable move,copy</code></pre>
<p>The features can be put in any case.</p>
<p>To see a list of which features can be disabled use:</p>
<pre><code>--disable help</code></pre>
<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>
<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>
<h3 id="disable-http2">–disable-http2</h3>
<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>
<h3 id="dscp-value">–dscp VALUE</h3>
<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>
<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>
<p>For example, if you configured QoS on router to handle LE properly.
Running:</p>
<pre><code>rclone copy --dscp LE from:/from to:/to</code></pre>
<p>would make the priority lower than usual internet flows.</p>
<p>This option has no effect on Windows (see <a
href="https://github.com/golang/go/issues/42728">golang/go#42728</a>).</p>
<h3 id="n-dry-run">-n, –dry-run</h3>
<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>
<h3 id="expect-continue-timeouttime">–expect-continue-timeout=TIME</h3>
<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>
<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>
<p>The default is <code>1s</code>. Set to <code>0</code> to disable.</p>
<h3 id="error-on-no-transfer">–error-on-no-transfer</h3>
<p>By default, rclone will exit with return code 0 if there were no
errors.</p>
<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>
<p>NB: Enabling this option turns a usually non-fatal error into a
potentially fatal one - please check and adjust your scripts
accordingly!</p>
<h3
id="fs-cache-expire-durationtime">–fs-cache-expire-duration=TIME</h3>
<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>
<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>
<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>
<h3
id="fs-cache-expire-intervaltime">–fs-cache-expire-interval=TIME</h3>
<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>
<h3 id="header">–header</h3>
<p>Add an HTTP header for all transactions. The flag can be repeated to
add multiple headers.</p>
<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>
<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>
<pre><code>rclone ls remote:test --header &quot;X-Rclone: Foo&quot; --header &quot;X-LetMeIn: Yes&quot;</code></pre>
<h3 id="header-download">–header-download</h3>
<p>Add an HTTP header for all download transactions. The flag can be
repeated to add multiple headers.</p>
<pre><code>rclone sync -i s3:test/src ~/dst --header-download &quot;X-Amz-Meta-Test: Foo&quot; --header-download &quot;X-Amz-Meta-Test2: Bar&quot;</code></pre>
<p>See the GitHub issue <a
href="https://github.com/rclone/rclone/issues/59">here</a> for currently
supported backends.</p>
<h3 id="header-upload">–header-upload</h3>
<p>Add an HTTP header for all upload transactions. The flag can be
repeated to add multiple headers.</p>
<pre><code>rclone sync -i ~/src s3:test/dst --header-upload &quot;Content-Disposition: attachment; filename=&#39;cool.html&#39;&quot; --header-upload &quot;X-Amz-Meta-Test: FooBar&quot;</code></pre>
<p>See the GitHub issue <a
href="https://github.com/rclone/rclone/issues/59">here</a> for currently
supported backends.</p>
<h3 id="human-readable">–human-readable</h3>
<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>
<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>
<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>
<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>
<p>Command <a href="https://rclone.org/commands/rclone_size/">size</a>
outputs both human-readable and raw numbers in the same output.</p>
<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>
<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>
<h3 id="ignore-case-sync">–ignore-case-sync</h3>
<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>
<h3 id="ignore-checksum">–ignore-checksum</h3>
<p>Normally rclone will check that the checksums of transferred files
match, and give an error “corrupted on transfer” if they don’t.</p>
<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>
<h3 id="ignore-existing">–ignore-existing</h3>
<p>Using this option will make rclone unconditionally skip all files
that exist on the destination, no matter the content of these files.</p>
<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>
<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>
<h3 id="ignore-size">–ignore-size</h3>
<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>
<p>It will also cause rclone to skip verifying the sizes are the same
after transfer.</p>
<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>
<h3 id="i-ignore-times">-I, –ignore-times</h3>
<p>Using this option will cause rclone to unconditionally upload all
files regardless of the state of files on the destination.</p>
<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>
<h3 id="immutable">–immutable</h3>
<p>Treat source and destination files as immutable and disallow
modification.</p>
<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>
<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>
<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>
<h3 id="interactive">-i / –interactive</h3>
<p>This flag can be used to tell rclone that you wish a manual
confirmation before destructive operations.</p>
<p>It is <strong>recommended</strong> that you use this flag while
learning rclone especially with <code>rclone sync</code>.</p>
<p>For example</p>
<pre><code>$ rclone delete -i /tmp/dir
rclone: delete &quot;important-file.txt&quot;?
y) Yes, this is OK (default)
n) No, skip this
s) Skip all delete operations with no more questions
!) Do all delete operations with no more questions
q) Exit rclone now.
y/n/s/!/q&gt; n</code></pre>
<p>The options mean</p>
<ul>
<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>
<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>
<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>
<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>
<li><code>q</code>: <strong>Quit</strong> rclone now, just in case!</li>
</ul>
<h3 id="leave-root">–leave-root</h3>
<p>During rmdirs it will not remove root directory, even if it’s
empty.</p>
<h3 id="log-filefile">–log-file=FILE</h3>
<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>
<p>If FILE exists then rclone will append to it.</p>
<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>
<h3 id="log-format-list">–log-format LIST</h3>
<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>
<h3 id="log-level-level">–log-level LEVEL</h3>
<p>This sets the log level for rclone. The default log level is
<code>NOTICE</code>.</p>
<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>
<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>
<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>
<p><code>ERROR</code> is equivalent to <code>-q</code>. It only outputs
error messages.</p>
<h3 id="use-json-log">–use-json-log</h3>
<p>This switches the log format to JSON for rclone. The fields of json
log are level, msg, source, time.</p>
<h3 id="low-level-retries-number">–low-level-retries NUMBER</h3>
<p>This controls the number of low level retries rclone does.</p>
<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>
<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>
<p>Disable low level retries with
<code>--low-level-retries 1</code>.</p>
<h3 id="max-backlogn">–max-backlog=N</h3>
<p>This is the maximum allowable backlog of files in a sync/copy/move
queued for being checked or transferred.</p>
<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>
<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>
<p>Setting this small will make rclone more synchronous to the listings
of the remote which may be desirable.</p>
<p>Setting this to a negative number will make the backlog as large as
possible.</p>
<h3 id="max-deleten">–max-delete=N</h3>
<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>
<h3 id="max-depthn">–max-depth=N</h3>
<p>This modifies the recursion depth for all the commands except
purge.</p>
<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>
<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>
<p>You can use this command to disable recursion (with
<code>--max-depth 1</code>).</p>
<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>
<h3 id="max-durationtime">–max-duration=TIME</h3>
<p>Rclone will stop scheduling new transfers when it has run for the
duration specified.</p>
<p>Defaults to off.</p>
<p>When the limit is reached any existing transfers will complete.</p>
<p>Rclone won’t exit with an error if the transfer limit is reached.</p>
<h3 id="max-transfersize">–max-transfer=SIZE</h3>
<p>Rclone will stop transferring when it has reached the size specified.
Defaults to off.</p>
<p>When the limit is reached all transfers will stop immediately.</p>
<p>Rclone will exit with exit code 8 if the transfer limit is
reached.</p>
<h2 id="metadata--m">–metadata / -M</h2>
<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%20section">#metadata</a> for more
info.</p>
<h3 id="metadata-set-keyvalue">–metadata-set key=value</h3>
<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%20section">#metadata</a> for more info.</p>
<h3
id="cutoff-modehardsoftcautious">–cutoff-mode=hard|soft|cautious</h3>
<p>This modifies the behavior of <code>--max-transfer</code> Defaults to
<code>--cutoff-mode=hard</code>.</p>
<p>Specifying <code>--cutoff-mode=hard</code> will stop transferring
immediately when Rclone reaches the limit.</p>
<p>Specifying <code>--cutoff-mode=soft</code> will stop starting new
transfers when Rclone reaches the limit.</p>
<p>Specifying <code>--cutoff-mode=cautious</code> will try to prevent
Rclone from reaching the limit.</p>
<h3 id="modify-windowtime">–modify-window=TIME</h3>
<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>
<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>
<p>This command line flag allows you to override that computed
default.</p>
<h3 id="multi-thread-cutoffsize">–multi-thread-cutoff=SIZE</h3>
<p>When downloading files to the local backend above this size, rclone
will use multiple threads to download the file (default 250M).</p>
<p>Rclone preallocates the file (using
<code>fallocate(FALLOC_FL_KEEP_SIZE)</code> on unix or
<code>NTSetInformationFile</code> on Windows both of which takes no
time) then each thread writes directly into the file at the correct
place. This means that rclone won’t create fragmented or sparse files
and there won’t be any assembly time at the end of the transfer.</p>
<p>The number of threads used to download is controlled by
<code>--multi-thread-streams</code>.</p>
<p>Use <code>-vv</code> if you wish to see info about the threads.</p>
<p>This will work with the
<code>sync</code>/<code>copy</code>/<code>move</code> commands and
friends <code>copyto</code>/<code>moveto</code>. Multi thread downloads
will be used with <code>rclone mount</code> and
<code>rclone serve</code> if <code>--vfs-cache-mode</code> is set to
<code>writes</code> or above.</p>
<p><strong>NB</strong> that this <strong>only</strong> works for a local
destination but will work with any source.</p>
<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>
<p><strong>NB</strong> on Windows using multi-thread downloads will
cause the resulting files to be <a
href="https://en.wikipedia.org/wiki/Sparse_file">sparse</a>. Use
<code>--local-no-sparse</code> to disable sparse files (which may cause
long delays at the start of downloads) or disable multi-thread downloads
with <code>--multi-thread-streams 0</code></p>
<h3 id="multi-thread-streamsn">–multi-thread-streams=N</h3>
<p>When using multi thread downloads (see above
<code>--multi-thread-cutoff</code>) this sets the maximum number of
streams to use. Set to <code>0</code> to disable multi thread downloads
(Default 4).</p>
<p>Exactly how many streams rclone uses for the download depends on the
size of the file. To calculate the number of download streams Rclone
divides the size of the file by the <code>--multi-thread-cutoff</code>
and rounds up, up to the maximum set with
<code>--multi-thread-streams</code>.</p>
<p>So if <code>--multi-thread-cutoff 250M</code> and
<code>--multi-thread-streams 4</code> are in effect (the defaults):</p>
<ul>
<li>0..250 MiB files will be downloaded with 1 stream</li>
<li>250..500 MiB files will be downloaded with 2 streams</li>
<li>500..750 MiB files will be downloaded with 3 streams</li>
<li>750+ MiB files will be downloaded with 4 streams</li>
</ul>
<h3 id="no-check-dest">–no-check-dest</h3>
<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>
<p>This means that:</p>
<ul>
<li>the destination is not listed minimising the API calls</li>
<li>files are always transferred</li>
<li>this can cause duplicates on remotes which allow it (e.g. Google
Drive)</li>
<li><code>--retries 1</code> is recommended otherwise you’ll transfer
everything again on a retry</li>
</ul>
<p>This flag is useful to minimise the transactions if you know that
none of the files are on the destination.</p>
<p>This is a specialized flag which should be ignored by most users!</p>
<h3 id="no-gzip-encoding">–no-gzip-encoding</h3>
<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>
<p>There is no need to set this in normal operation, and doing so will
decrease the network transfer efficiency of rclone.</p>
<h3 id="no-traverse">–no-traverse</h3>
<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>
<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>
<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>
<p>See <a href="https://rclone.org/commands/rclone_copy/">rclone
copy</a> for an example of how to use it.</p>
<h3 id="no-unicode-normalization">–no-unicode-normalization</h3>
<p>Don’t normalize unicode characters in filenames during the sync
routine.</p>
<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>
<p>Using this flag will disable that functionality, treating each
unicode character as unique. For example, by default é and é will be
normalized into the same character. With
<code>--no-unicode-normalization</code> they will be treated as unique
characters.</p>
<h3 id="no-update-modtime">–no-update-modtime</h3>
<p>When using this flag, rclone won’t update modification times of
remote files if they are incorrect as it would normally.</p>
<p>This can be used if the remote is being synced with another tool also
(e.g. the Google Drive client).</p>
<h3 id="order-by-string">–order-by string</h3>
<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>
<p>The order by string is constructed like this. The first part
describes what aspect is being measured:</p>
<ul>
<li><code>size</code> - order by the size of the files</li>
<li><code>name</code> - order by the full path of the files</li>
<li><code>modtime</code> - order by the modification date of the
files</li>
</ul>
<p>This can have a modifier appended with a comma:</p>
<ul>
<li><code>ascending</code> or <code>asc</code> - order so that the
smallest (or oldest) is processed first</li>
<li><code>descending</code> or <code>desc</code> - order so that the
largest (or newest) is processed first</li>
<li><code>mixed</code> - order so that the smallest is processed first
for some threads and the largest for others</li>
</ul>
<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>
<p>If no modifier is supplied then the order is
<code>ascending</code>.</p>
<p>For example</p>
<ul>
<li><code>--order-by size,desc</code> - send the largest files
first</li>
<li><code>--order-by modtime,ascending</code> - send the oldest files
first</li>
<li><code>--order-by name</code> - send the files with alphabetically by
path first</li>
</ul>
<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>
<h4 id="limitations-1">Limitations</h4>
<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>
<ul>
<li>there are no files in the backlog or the source has not been fully
scanned yet</li>
<li>there are more than <a href="#max-backlog-n">–max-backlog</a> files
in the backlog</li>
</ul>
<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>
<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>
<h3 id="password-command-spaceseplist">–password-command
SpaceSepList</h3>
<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>
<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>
<p>Eg</p>
<pre><code>--password-command echo hello
--password-command echo &quot;hello with space&quot;
--password-command echo &quot;hello with &quot;&quot;quotes&quot;&quot; and space&quot;</code></pre>
<p>See the <a href="#configuration-encryption">Configuration
Encryption</a> for more info.</p>
<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>
<h3 id="p-progress">-P, –progress</h3>
<p>This flag makes rclone update the stats in a static block in the
terminal providing a realtime overview of the transfer.</p>
<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>
<p>Normally this is updated every 500mS but this period can be
overridden with the <code>--stats</code> flag.</p>
<p>This can be used with the <code>--stats-one-line</code> flag for a
simpler display.</p>
<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>
<h3 id="progress-terminal-title">–progress-terminal-title</h3>
<p>This flag, when used with <code>-P/--progress</code>, will print the
string <code>ETA: %s</code> to the terminal title.</p>
<h3 id="q-quiet">-q, –quiet</h3>
<p>This flag will limit rclone’s output to error messages only.</p>
<h3 id="refresh-times">–refresh-times</h3>
<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>
<p>This is useful if you uploaded files with the incorrect timestamps
and you now wish to correct them.</p>
<p>This flag is <strong>only</strong> useful for destinations which
don’t support hashes (e.g. <code>crypt</code>).</p>
<p>This can be used any of the sync commands <code>sync</code>,
<code>copy</code> or <code>move</code>.</p>
<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>
<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>
<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>
<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>
<h3 id="retries-int">–retries int</h3>
<p>Retry the entire sync if it fails this many times it fails (default
3).</p>
<p>Some remotes can be unreliable and a few retries help pick up the
files which didn’t get transferred because of errors.</p>
<p>Disable retries with <code>--retries 1</code>.</p>
<h3 id="retries-sleeptime">–retries-sleep=TIME</h3>
<p>This sets the interval between each retry specified by
<code>--retries</code></p>
<p>The default is <code>0</code>. Use <code>0</code> to disable.</p>
<h3 id="server-side-across-configs">–server-side-across-configs</h3>
<p>Allow server-side operations (e.g. copy or move) to work across
different configurations.</p>
<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>
<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>
<h3 id="size-only">–size-only</h3>
<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>
<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>
<h3 id="statstime">–stats=TIME</h3>
<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>
<p>This sets the interval.</p>
<p>The default is <code>1m</code>. Use <code>0</code> to disable.</p>
<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>
<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>
<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>
<h3 id="stats-file-name-length-integer">–stats-file-name-length
integer</h3>
<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>
<h3 id="stats-log-level-string">–stats-log-level string</h3>
<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>
<h3 id="stats-one-line">–stats-one-line</h3>
<p>When this is specified, rclone condenses the stats into a single line
showing the most important stats only.</p>
<h3 id="stats-one-line-date">–stats-one-line-date</h3>
<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>
<h3 id="stats-one-line-date-format">–stats-one-line-date-format</h3>
<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>
<h3 id="stats-unitbitsbytes">–stats-unit=bits|bytes</h3>
<p>By default, data transfer rates will be printed in bytes per
second.</p>
<p>This option allows the data rate to be printed in bits per
second.</p>
<p>Data transfer volume will still be reported in bytes.</p>
<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>
<p>The default is <code>bytes</code>.</p>
<h3 id="suffixsuffix">–suffix=SUFFIX</h3>
<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>
<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>
<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>
<p>For example</p>
<pre><code>rclone copy -i /path/to/local/file remote:current --suffix .bak</code></pre>
<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>
<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>
<pre><code>rclone sync -i /path/to/local/file remote:current --suffix .bak --exclude &quot;*.bak&quot;</code></pre>
<h3 id="suffix-keep-extension">–suffix-keep-extension</h3>
<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>
<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>
<h3 id="syslog">–syslog</h3>
<p>On capable OSes (not Windows or Plan9) send all log output to
syslog.</p>
<p>This can be useful for running rclone in a script or
<code>rclone mount</code>.</p>
<h3 id="syslog-facility-string">–syslog-facility string</h3>
<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>
<h3 id="temp-dirdir">–temp-dir=DIR</h3>
<p>Specify the directory rclone will use for temporary files, to
override the default. Make sure the directory exists and have accessible
permissions.</p>
<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>
<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>
<p>You can use the <a
href="https://rclone.org/commands/rclone_config_paths/">config paths</a>
command to see the current value.</p>
<h3 id="tpslimit-float">–tpslimit float</h3>
<p>Limit transactions per second to this number. Default is 0 which is
used to mean unlimited transactions per second.</p>
<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>
<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>
<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>
<p>This can be very useful for <code>rclone mount</code> to control the
behaviour of applications using it.</p>
<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>
<p>See also <code>--tpslimit-burst</code>.</p>
<h3 id="tpslimit-burst-int">–tpslimit-burst int</h3>
<p>Max burst of transactions for <code>--tpslimit</code> (default
<code>1</code>).</p>
<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>
<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>
<p>This may be used to increase performance of <code>--tpslimit</code>
without changing the long term average number of transactions per
second.</p>
<h3 id="track-renames">–track-renames</h3>
<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>
<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>
<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>
<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>
<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>
<p>Encrypted destinations are not currently supported by
<code>--track-renames</code> if <code>--track-renames-strategy</code>
includes <code>hash</code>.</p>
<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>
<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>
<h3
id="track-renames-strategy-hashmodtimeleafsize">–track-renames-strategy
(hash,modtime,leaf,size)</h3>
<p>This option changes the file matching criteria for
<code>--track-renames</code>.</p>
<p>The matching is controlled by a comma separated selection of these
tokens:</p>
<ul>
<li><code>modtime</code> - the modification time of the file - not
supported on all backends</li>
<li><code>hash</code> - the hash of the file contents - not supported on
all backends</li>
<li><code>leaf</code> - the name of the file not including its directory
name</li>
<li><code>size</code> - the size of the file (this is always
enabled)</li>
</ul>
<p>The default option is <code>hash</code>.</p>
<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>
<p>Using <code>--track-renames-strategy modtime</code> or
<code>leaf</code> can enable <code>--track-renames</code> support for
encrypted destinations.</p>
<p>Note that the <code>hash</code> strategy is not supported with
encrypted destinations.</p>
<h3 id="delete-beforeduringafter">–delete-(before,during,after)</h3>
<p>This option allows you to specify when files on your destination are
deleted when you sync folders.</p>
<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>
<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>
<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>
<h3 id="fast-list">–fast-list</h3>
<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 normally lists a directory and processes
it before using more directory lists to process any subdirectories. This
can be parallelised and works very quickly using the least amount of
memory.</p>
<p>However, some remotes have a way of listing all files beneath a
directory in one (or a small number) of transactions. These tend to be
the bucket-based remotes (e.g. S3, B2, GCS, Swift).</p>
<p>If you use the <code>--fast-list</code> flag then rclone will use
this method for listing directories. This will have the following
consequences for the listing:</p>
<ul>
<li>It <strong>will</strong> use fewer transactions (important if you
pay for them)</li>
<li>It <strong>will</strong> use more memory. Rclone has to load the
whole listing into memory.</li>
<li>It <em>may</em> be faster because it uses fewer transactions</li>
<li>It <em>may</em> be slower because it can’t be parallelized</li>
</ul>
<p>rclone should always give identical results with and without
<code>--fast-list</code>.</p>
<p>If you pay for transactions and can fit your entire sync listing into
memory then <code>--fast-list</code> is recommended. If you have a very
big sync to do then don’t use <code>--fast-list</code> otherwise you
will run out of memory.</p>
<p>If you use <code>--fast-list</code> on a remote which doesn’t support
it, then rclone will just ignore it.</p>
<h3 id="timeouttime">–timeout=TIME</h3>
<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>
<p>The default is <code>5m</code>. Set to <code>0</code> to disable.</p>
<h3 id="transfersn">–transfers=N</h3>
<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>
<p>The default is to run 4 file transfers in parallel.</p>
<p>Look at –multi-thread-streams if you would like to control single
file transfers.</p>
<h3 id="u-update">-u, –update</h3>
<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>
<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>
<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>
<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>
<p>In all other cases the file will not be updated.</p>
<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>
<h3 id="use-mmap">–use-mmap</h3>
<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>
<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>
<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>
<h3 id="use-server-modtime">–use-server-modtime</h3>
<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>
<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>
<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>
<h3 id="v--vv-verbose">-v, -vv, –verbose</h3>
<p>With <code>-v</code> rclone will tell you about each file that is
transferred and a small number of significant events.</p>
<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>
<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>
<h3 id="v-version">-V, –version</h3>
<p>Prints the version number</p>
<h2 id="ssltls-options">SSL/TLS options</h2>
<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>
<h3 id="ca-cert-string">–ca-cert string</h3>
<p>This loads the PEM encoded certificate authority certificate and uses
it to verify the certificates of the servers rclone connects to.</p>
<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>
<h3 id="client-cert-string">–client-cert string</h3>
<p>This loads the PEM encoded client side certificate.</p>
<p>This is used for <a
href="https://en.wikipedia.org/wiki/Mutual_authentication">mutual TLS
authentication</a>.</p>
<p>The <code>--client-key</code> flag is required too when using
this.</p>
<h3 id="client-key-string">–client-key string</h3>
<p>This loads the PEM encoded client side private key used for mutual
TLS authentication. Used in conjunction with
<code>--client-cert</code>.</p>
<h3
id="no-check-certificatetruefalse">–no-check-certificate=true/false</h3>
<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>
<p>This option defaults to <code>false</code>.</p>
<p><strong>This should be used only for testing.</strong></p>
<h2 id="configuration-encryption">Configuration Encryption</h2>
<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>
<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>
<p>To add a password to your rclone configuration, execute
<code>rclone config</code>.</p>
<pre><code>&gt;rclone config
Current remotes:

e) Edit existing remote
n) New remote
d) Delete remote
s) Set configuration password
q) Quit config
e/n/d/s/q&gt;</code></pre>
<p>Go into <code>s</code>, Set configuration password:</p>
<pre><code>e/n/d/s/q&gt; s
Your configuration is not encrypted.
If you add a password, you will protect your login information to cloud services.
a) Add Password
q) Quit to main menu
a/q&gt; a
Enter NEW configuration password:
password:
Confirm NEW password:
password:
Password set
Your configuration is encrypted.
c) Change Password
u) Unencrypt configuration
q) Quit to main menu
c/u/q&gt;</code></pre>
<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>
<p>There is no way to recover the configuration if you lose your
password.</p>
<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>
<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>
<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>
<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>
<pre><code>#!/bin/echo Source this file don&#39;t run it

read -s RCLONE_CONFIG_PASS
export RCLONE_CONFIG_PASS</code></pre>
<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>
<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>
<p>One useful example of this is using the <code>passwordstore</code>
application to retrieve the password:</p>
<pre><code>export RCLONE_PASSWORD_COMMAND=&quot;pass rclone/config&quot;</code></pre>
<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>
<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>
<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>
<h2 id="developer-options">Developer options</h2>
<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>
<h3 id="cpuprofilefile">–cpuprofile=FILE</h3>
<p>Write CPU profile to file. This can be analysed with
<code>go tool pprof</code>.</p>
<h4 id="dump-flagflagflag">–dump flag,flag,flag</h4>
<p>The <code>--dump</code> flag takes a comma separated list of flags to
dump info about.</p>
<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>
<p>The available flags are:</p>
<h4 id="dump-headers">–dump headers</h4>
<p>Dump HTTP headers with <code>Authorization:</code> lines removed. May
still contain sensitive info. Can be very verbose. Useful for debugging
only.</p>
<p>Use <code>--dump auth</code> if you do want the
<code>Authorization:</code> headers.</p>
<h4 id="dump-bodies">–dump bodies</h4>
<p>Dump HTTP headers and bodies - may contain sensitive info. Can be
very verbose. Useful for debugging only.</p>
<p>Note that the bodies are buffered in memory so don’t use this for
enormous files.</p>
<h4 id="dump-requests">–dump requests</h4>
<p>Like <code>--dump bodies</code> but dumps the request bodies and the
response headers. Useful for debugging download problems.</p>
<h4 id="dump-responses">–dump responses</h4>
<p>Like <code>--dump bodies</code> but dumps the response bodies and the
request headers. Useful for debugging upload problems.</p>
<h4 id="dump-auth">–dump auth</h4>
<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>
<h4 id="dump-filters">–dump filters</h4>
<p>Dump the filters to the output. Useful to see exactly what include
and exclude options are filtering on.</p>
<h4 id="dump-goroutines">–dump goroutines</h4>
<p>This dumps a list of the running go-routines at the end of the
command to standard output.</p>
<h4 id="dump-openfiles">–dump openfiles</h4>
<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>
<h3 id="memprofilefile">–memprofile=FILE</h3>
<p>Write memory profile to file. This can be analysed with
<code>go tool pprof</code>.</p>
<h2 id="filtering">Filtering</h2>
<p>For the filtering options</p>
<ul>
<li><code>--delete-excluded</code></li>
<li><code>--filter</code></li>
<li><code>--filter-from</code></li>
<li><code>--exclude</code></li>
<li><code>--exclude-from</code></li>
<li><code>--exclude-if-present</code></li>
<li><code>--include</code></li>
<li><code>--include-from</code></li>
<li><code>--files-from</code></li>
<li><code>--files-from-raw</code></li>
<li><code>--min-size</code></li>
<li><code>--max-size</code></li>
<li><code>--min-age</code></li>
<li><code>--max-age</code></li>
<li><code>--dump filters</code></li>
</ul>
<p>See the <a href="https://rclone.org/filtering/">filtering
section</a>.</p>
<h2 id="remote-control">Remote control</h2>
<p>For the remote control options and for instructions on how to remote
control rclone</p>
<ul>
<li><code>--rc</code></li>
<li>and anything starting with <code>--rc-</code></li>
</ul>
<p>See <a href="https://rclone.org/rc/">the remote control
section</a>.</p>
<h2 id="logging">Logging</h2>
<p>rclone has 4 levels of logging, <code>ERROR</code>,
<code>NOTICE</code>, <code>INFO</code> and <code>DEBUG</code>.</p>
<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>
<p>By default, rclone will produce <code>Error</code> and
<code>Notice</code> level messages.</p>
<p>If you use the <code>-q</code> flag, rclone will only produce
<code>Error</code> messages.</p>
<p>If you use the <code>-v</code> flag, rclone will produce
<code>Error</code>, <code>Notice</code> and <code>Info</code>
messages.</p>
<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>
<p>You can also control the log levels with the <code>--log-level</code>
flag.</p>
<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>
<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>
<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>
<h2 id="exit-code">Exit Code</h2>
<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>
<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>
<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>
<h3 id="list-of-exit-codes">List of exit codes</h3>
<ul>
<li><code>0</code> - success</li>
<li><code>1</code> - Syntax or usage error</li>
<li><code>2</code> - Error not otherwise categorised</li>
<li><code>3</code> - Directory not found</li>
<li><code>4</code> - File not found</li>
<li><code>5</code> - Temporary error (one that more retries might fix)
(Retry errors)</li>
<li><code>6</code> - Less serious errors (like 461 errors from dropbox)
(NoRetry errors)</li>
<li><code>7</code> - Fatal error (one that more retries won’t fix, like
account suspended) (Fatal errors)</li>
<li><code>8</code> - Transfer exceeded - limit set by –max-transfer
reached</li>
<li><code>9</code> - Operation successful, but no files transferred</li>
</ul>
<h2 id="environment-variables">Environment Variables</h2>
<p>Rclone can be configured entirely using environment variables. These
can be used to set defaults for options or config file entries.</p>
<h3 id="options-86">Options</h3>
<p>Every option in rclone can have its default set by environment
variable.</p>
<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>
<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>
<p>Or to always use the trash in drive <code>--drive-use-trash</code>,
set <code>RCLONE_DRIVE_USE_TRASH=true</code>.</p>
<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>
<p>The same parser is used for the options and the environment variables
so they take exactly the same form.</p>
<p>The options set by environment variables can be seen with the
<code>-vv</code> flag, e.g. <code>rclone version -vv</code>.</p>
<h3 id="config-file">Config file</h3>
<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>
<p>To find the name of the environment variable, you need to set, take
<code>RCLONE_CONFIG_</code> + name of remote + <code>_</code> + name of
config file option and make it all uppercase.</p>
<p>For example, to configure an S3 remote named <code>mys3:</code>
without a config file (using unix ways of setting environment
variables):</p>
<pre><code>$ export RCLONE_CONFIG_MYS3_TYPE=s3
$ export RCLONE_CONFIG_MYS3_ACCESS_KEY_ID=XXX
$ export RCLONE_CONFIG_MYS3_SECRET_ACCESS_KEY=XXX
$ rclone lsd mys3:
          -1 2016-09-21 12:54:21        -1 my-bucket
$ rclone listremotes | grep mys3
mys3:</code></pre>
<p>Note that if you want to create a remote using environment variables
you must create the <code>..._TYPE</code> variable as above.</p>
<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>
<pre><code>$ rclone lsd mys3:
          -1 2016-09-21 12:54:21        -1 my-bucket
$ rclone lsd MYS3:
          -1 2016-09-21 12:54:21        -1 my-bucket</code></pre>
<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>
<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>
<pre><code>rclone lsd :s3,access_key_id=XXX,secret_access_key=XXX:</code></pre>
<h3 id="precedence">Precedence</h3>
<p>The various different methods of backend configuration are read in
this order and the first one with a value is used.</p>
<ul>
<li>Parameters in connection strings,
e.g. <code>myRemote,skip_links:</code></li>
<li>Flag values as supplied on the command line,
e.g. <code>--skip-links</code></li>
<li>Remote specific environment vars,
e.g. <code>RCLONE_CONFIG_MYREMOTE_SKIP_LINKS</code> (see above).</li>
<li>Backend-specific environment vars,
e.g. <code>RCLONE_LOCAL_SKIP_LINKS</code>.</li>
<li>Backend generic environment vars,
e.g. <code>RCLONE_SKIP_LINKS</code>.</li>
<li>Config file, e.g. <code>skip_links = true</code>.</li>
<li>Default values, e.g. <code>false</code> - these can’t be
changed.</li>
</ul>
<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>
<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>
<p>For non backend configuration the order is as follows:</p>
<ul>
<li>Flag values as supplied on the command line,
e.g. <code>--stats 5s</code>.</li>
<li>Environment vars, e.g. <code>RCLONE_STATS=5s</code>.</li>
<li>Default values, e.g. <code>1m</code> - these can’t be changed.</li>
</ul>
<h3 id="other-environment-variables">Other environment variables</h3>
<ul>
<li><code>RCLONE_CONFIG_PASS</code> set to contain your config file
password (see <a href="#configuration-encryption">Configuration
Encryption</a> section)</li>
<li><code>HTTP_PROXY</code>, <code>HTTPS_PROXY</code> and
<code>NO_PROXY</code> (or the lowercase versions thereof).
<ul>
<li><code>HTTPS_PROXY</code> takes precedence over
<code>HTTP_PROXY</code> for https requests.</li>
<li>The environment values may be either a complete URL or a
“host[:port]” for, in which case the “http” scheme is assumed.</li>
</ul></li>
<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>
<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>
</ul>
<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>
<h1 id="configuring-rclone-on-a-remote-headless-machine">Configuring
rclone on a remote / headless machine</h1>
<p>Some of the configurations (those involving oauth2) require an
Internet connected web browser.</p>
<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>
<h2 id="configuring-using-rclone-authorize">Configuring using rclone
authorize</h2>
<p>On the headless box run <code>rclone</code> config but answer
<code>N</code> to the <code>Use auto config?</code> question.</p>
<pre><code>...
Remote config
Use auto config?
 * Say Y if not sure
 * Say N if you are working on a remote or headless machine
y) Yes (default)
n) No
y/n&gt; n
For this to work, you will need rclone available on a machine that has
a web browser available.

For more help and alternate methods see: https://rclone.org/remote_setup/

Execute the following on the machine with the web browser (same rclone
version recommended):

rclone authorize &quot;amazon cloud drive&quot;

Then paste the result below:
result&gt;</code></pre>
<p>Then on your main desktop machine</p>
<pre><code>rclone authorize &quot;amazon cloud drive&quot;
If your browser doesn&#39;t open automatically go to the following link: http://127.0.0.1:53682/auth
Log in and authorize rclone for access
Waiting for code...
Got code
Paste the following into your remote machine ---&gt;
SECRET_TOKEN
&lt;---End paste</code></pre>
<p>Then back to the headless box, paste in the code</p>
<pre><code>result&gt; SECRET_TOKEN
--------------------
[acd12]
client_id = 
client_secret = 
token = SECRET_TOKEN
--------------------
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d&gt;</code></pre>
<h2 id="configuring-by-copying-the-config-file">Configuring by copying
the config file</h2>
<p>Rclone stores all of its config in a single configuration file. This
can easily be copied to configure a remote rclone.</p>
<p>So first configure rclone on your desktop machine with</p>
<pre><code>rclone config</code></pre>
<p>to set up the config file.</p>
<p>Find the config file by running <code>rclone config file</code>, for
example</p>
<pre><code>$ rclone config file
Configuration file is stored at:
/home/user/.rclone.conf</code></pre>
<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>
<h2 id="configuring-using-ssh-tunnel">Configuring using SSH Tunnel</h2>
<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>
<pre><code>ssh -L localhost:53682:localhost:53682 username@remote_server</code></pre>
<p>Then on the headless box run <code>rclone</code> config and answer
<code>Y</code> to the <code>Use auto config?</code> question.</p>
<pre><code>...
Remote config
Use auto config?
 * Say Y if not sure
 * Say N if you are working on a remote or headless machine
y) Yes (default)
n) No
y/n&gt; y</code></pre>
<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>
<h1 id="filtering-includes-and-excludes">Filtering, includes and
excludes</h1>
<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>
<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>
<p>Rclone <code>purge</code> does not obey filters.</p>
<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>
<p>Rclone filter patterns can only be used in filter command line
options, not in the specification of a remote.</p>
<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>
<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 may not
be what you expect. Instead use a <code>--filter...</code> flag.</p>
<h2 id="patterns-for-matching-pathfile-names">Patterns for matching
path/file names</h2>
<h3 id="pattern-syntax">Pattern syntax</h3>
<p>Here is a formal definition of the pattern syntax, <a
href="#examples">examples</a> are below.</p>
<p>Rclone matching rules follow a glob style:</p>
<pre><code>*         matches any sequence of non-separator (/) characters
**        matches any sequence of characters including / separators
?         matches any single non-separator (/) character
[ [ ! ] { character-range } ]
          character class (must be non-empty)
{ pattern-list }
          pattern alternatives
{{ regexp }}
          regular expression to match
c         matches character c (c != *, **, ?, \, [, {, })
\c        matches reserved character c (c = *, **, ?, \, [, {, }) or character class</code></pre>
<p>character-range:</p>
<pre><code>c         matches character c (c != \, -, ])
\c        matches reserved character c (c = \, -, ])
lo - hi   matches character c for lo &lt;= c &lt;= hi</code></pre>
<p>pattern-list:</p>
<pre><code>pattern { , pattern }
          comma-separated (without spaces) patterns</code></pre>
<p>character classes (see <a
href="https://golang.org/pkg/regexp/syntax/">Go regular expression
reference</a>) include:</p>
<pre><code>Named character classes (e.g. [\d], [^\d], [\D], [^\D])
Perl character classes (e.g. \s, \S, \w, \W)
ASCII character classes (e.g. [[:alnum:]], [[:alpha:]], [[:punct:]], [[:xdigit:]])</code></pre>
<p>regexp for advanced users to insert a regular expression - see <a
href="#regexp">below</a> for more info:</p>
<pre><code>Any re2 regular expression not containing `}}`</code></pre>
<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>
<pre><code>file.jpg   - matches &quot;file.jpg&quot;
           - matches &quot;directory/file.jpg&quot;
           - doesn&#39;t match &quot;afile.jpg&quot;
           - doesn&#39;t match &quot;directory/afile.jpg&quot;
/file.jpg  - matches &quot;file.jpg&quot; in the root directory of the remote
           - doesn&#39;t match &quot;afile.jpg&quot;
           - doesn&#39;t match &quot;directory/file.jpg&quot;</code></pre>
<p>The top level of the remote may not be the top level of the
drive.</p>
<p>E.g. for a Microsoft Windows local directory structure</p>
<pre><code>F:
├── bkp
├── data
│   ├── excl
│   │   ├── 123.jpg
│   │   └── 456.jpg
│   ├── incl
│   │   └── document.pdf</code></pre>
<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>
<p><code>rclone copy F:\data\ F:\bkp\ --exclude=/excl/**</code></p>
<p><strong>Important</strong> Use <code>/</code> in path/file name
patterns and not <code>\</code> even if running on Microsoft
Windows.</p>
<p>Simple patterns are case sensitive unless the
<code>--ignore-case</code> flag is used.</p>
<p>Without <code>--ignore-case</code> (default)</p>
<pre><code>potato - matches &quot;potato&quot;
       - doesn&#39;t match &quot;POTATO&quot;</code></pre>
<p>With <code>--ignore-case</code></p>
<pre><code>potato - matches &quot;potato&quot;
       - matches &quot;POTATO&quot;</code></pre>
<h2 id="regexp">Using regular expressions in filter patterns</h2>
<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>
<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>
<p>Here is how the <code>{{regexp}}</code> is transformed into an full
regular expression to match the entire path:</p>
<pre><code>{{regexp}}  becomes (^|/)(regexp)$
/{{regexp}} becomes ^(regexp)$</code></pre>
<p>Regexp syntax can be mixed with glob syntax, for example</p>
<pre><code>*.{{jpe?g}} to match file.jpg, file.jpeg but not file.png</code></pre>
<p>You can also use regexp flags - to set case insensitive, for
example</p>
<pre><code>*.{{(?i)jpg}} to match file.jpg, file.JPG but not file.png</code></pre>
<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>
<pre><code>{{start[^/]*end\.jpg}}</code></pre>
<p>Not</p>
<pre><code>{{start.*end\.jpg}}</code></pre>
<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>
<p>Note that you can use <code>-vv --dump filters</code> to show the
filter patterns in regexp format - rclone implements the glob patters by
transforming them into regular expressions.</p>
<h2 id="examples">Filter pattern examples</h2>
<table>
<colgroup>
<col style="width: 27%" />
<col style="width: 20%" />
<col style="width: 17%" />
<col style="width: 35%" />
</colgroup>
<thead>
<tr class="header">
<th>Description</th>
<th>Pattern</th>
<th>Matches</th>
<th>Does not match</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>Wildcard</td>
<td><code>*.jpg</code></td>
<td><code>/file.jpg</code></td>
<td><code>/file.png</code></td>
</tr>
<tr class="even">
<td></td>
<td></td>
<td><code>/dir/file.jpg</code></td>
<td><code>/dir/file.png</code></td>
</tr>
<tr class="odd">
<td>Rooted</td>
<td><code>/*.jpg</code></td>
<td><code>/file.jpg</code></td>
<td><code>/file.png</code></td>
</tr>
<tr class="even">
<td></td>
<td></td>
<td><code>/file2.jpg</code></td>
<td><code>/dir/file.jpg</code></td>
</tr>
<tr class="odd">
<td>Alternates</td>
<td><code>*.{jpg,png}</code></td>
<td><code>/file.jpg</code></td>
<td><code>/file.gif</code></td>
</tr>
<tr class="even">
<td></td>
<td></td>
<td><code>/dir/file.png</code></td>
<td><code>/dir/file.gif</code></td>
</tr>
<tr class="odd">
<td>Path Wildcard</td>
<td><code>dir/**</code></td>
<td><code>/dir/anyfile</code></td>
<td><code>file.png</code></td>
</tr>
<tr class="even">
<td></td>
<td></td>
<td><code>/subdir/dir/subsubdir/anyfile</code></td>
<td><code>/subdir/file.png</code></td>
</tr>
<tr class="odd">
<td>Any Char</td>
<td><code>*.t?t</code></td>
<td><code>/file.txt</code></td>
<td><code>/file.qxt</code></td>
</tr>
<tr class="even">
<td></td>
<td></td>
<td><code>/dir/file.tzt</code></td>
<td><code>/dir/file.png</code></td>
</tr>
<tr class="odd">
<td>Range</td>
<td><code>*.[a-z]</code></td>
<td><code>/file.a</code></td>
<td><code>/file.0</code></td>
</tr>
<tr class="even">
<td></td>
<td></td>
<td><code>/dir/file.b</code></td>
<td><code>/dir/file.1</code></td>
</tr>
<tr class="odd">
<td>Escape</td>
<td><code>*.\?\?\?</code></td>
<td><code>/file.???</code></td>
<td><code>/file.abc</code></td>
</tr>
<tr class="even">
<td></td>
<td></td>
<td><code>/dir/file.???</code></td>
<td><code>/dir/file.def</code></td>
</tr>
<tr class="odd">
<td>Class</td>
<td><code>*.\d\d\d</code></td>
<td><code>/file.012</code></td>
<td><code>/file.abc</code></td>
</tr>
<tr class="even">
<td></td>
<td></td>
<td><code>/dir/file.345</code></td>
<td><code>/dir/file.def</code></td>
</tr>
<tr class="odd">
<td>Regexp</td>
<td><code>*.{{jpe?g}}</code></td>
<td><code>/file.jpeg</code></td>
<td><code>/file.png</code></td>
</tr>
<tr class="even">
<td></td>
<td></td>
<td><code>/dir/file.jpg</code></td>
<td><code>/dir/file.jpeeg</code></td>
</tr>
<tr class="odd">
<td>Rooted Regexp</td>
<td><code>/{{.*\.jpe?g}}</code></td>
<td><code>/file.jpeg</code></td>
<td><code>/file.png</code></td>
</tr>
<tr class="even">
<td></td>
<td></td>
<td><code>/file.jpg</code></td>
<td><code>/dir/file.jpg</code></td>
</tr>
</tbody>
</table>
<h2 id="how-filter-rules-are-applied-to-files">How filter rules are
applied to files</h2>
<p>Rclone path/file name filters are made up of one or more of the
following flags:</p>
<ul>
<li><code>--include</code></li>
<li><code>--include-from</code></li>
<li><code>--exclude</code></li>
<li><code>--exclude-from</code></li>
<li><code>--filter</code></li>
<li><code>--filter-from</code></li>
</ul>
<p>There can be more than one instance of individual flags.</p>
<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>
<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>
<p>Multiple instances of the same flag are processed from left to right
according to their position in the command line.</p>
<p>To mix up the order of processing includes and excludes use
<code>--filter...</code> flags.</p>
<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>
<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>
<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>
<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>
<p>Any path/file included at that stage is processed by the rclone
command.</p>
<p><code>--files-from</code> and <code>--files-from-raw</code> flags
over-ride and cannot be combined with other filter options.</p>
<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>
<h3 id="directory_filter">How filter rules are applied to
directories</h3>
<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>
<p>Directory filter rules are defined with a closing <code>/</code>
separator.</p>
<p>E.g. <code>/directory/subdirectory/</code> is an rclone directory
filter rule.</p>
<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>
<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>
<p>Directory recursion optimisation occurs if either:</p>
<ul>
<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>
<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>
<li><p>Whenever the <code>--disable ListR</code> flag is applied to an
rclone command.</p></li>
</ul>
<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>
<p>E.g. for an include rule</p>
<pre><code>/a/*.jpg</code></pre>
<p>Rclone implies the directory include rule</p>
<pre><code>/a/</code></pre>
<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>
<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>
<p>E.g. <code>rclone ls remote: --filter-from filter-list.txt</code>
with a file <code>filter-list.txt</code>:</p>
<pre><code>- /dir1/
- /dir2/
+ *.pdf
- **</code></pre>
<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>
<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>
<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>
<p>E.g. for an include rule</p>
<pre><code>{dir1/**,dir2/**}</code></pre>
<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>
<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>
<h3 id="exclude---exclude-files-matching-pattern"><code>--exclude</code>
- Exclude files matching pattern</h3>
<p>Excludes path/file names from an rclone command based on a single
exclude rule.</p>
<p>This flag can be repeated. See above for the order filter flags are
processed in.</p>
<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>
<p><code>--exclude</code> has no effect when combined with
<code>--files-from</code> or <code>--files-from-raw</code> flags.</p>
<p>E.g. <code>rclone ls remote: --exclude *.bak</code> excludes all .bak
files from listing.</p>
<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>
<p>E.g. on Microsoft Windows
<code>rclone ls remote: --exclude "*\[{JP,KR,HK}\]*"</code> lists the
files in <code>remote:</code> with <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>
<h3
id="exclude-from---read-exclude-patterns-from-file"><code>--exclude-from</code>
- Read exclude patterns from file</h3>
<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>
<p>For an example <code>exclude-file.txt</code>:</p>
<pre><code># a sample exclude rule file
*.bak
file2.jpg</code></pre>
<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>
<p>This flag can be repeated. See above for the order filter flags are
processed in.</p>
<p>The <code>--exclude-from</code> flag is useful where multiple exclude
filter rules are applied to an rclone command.</p>
<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>
<p><code>--exclude-from</code> has no effect when combined with
<code>--files-from</code> or <code>--files-from-raw</code> flags.</p>
<p><code>--exclude-from</code> followed by <code>-</code> reads filter
rules from standard input.</p>
<h3 id="include---include-files-matching-pattern"><code>--include</code>
- Include files matching pattern</h3>
<p>Adds a single include rule based on path/file names to an rclone
command.</p>
<p>This flag can be repeated. See above for the order filter flags are
processed in.</p>
<p><code>--include</code> has no effect when combined with
<code>--files-from</code> or <code>--files-from-raw</code> flags.</p>
<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>
<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>
<p>E.g. multiple rclone copy commands can be combined with
<code>--include</code> and a pattern-list.</p>
<pre><code>rclone copy /vol1/A remote:A
rclone copy /vol1/B remote:B</code></pre>
<p>is equivalent to:</p>
<pre><code>rclone copy /vol1 remote: --include &quot;{A,B}/**&quot;</code></pre>
<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>
<h3
id="include-from---read-include-patterns-from-file"><code>--include-from</code>
- Read include patterns from file</h3>
<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>
<p>For an example <code>include-file.txt</code>:</p>
<pre><code># a sample include rule file
*.jpg
file2.avi</code></pre>
<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>
<p>This flag can be repeated. See above for the order filter flags are
processed in.</p>
<p>The <code>--include-from</code> flag is useful where multiple include
filter rules are applied to an rclone command.</p>
<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>
<p><code>--exclude-from</code> has no effect when combined with
<code>--files-from</code> or <code>--files-from-raw</code> flags.</p>
<p><code>--exclude-from</code> followed by <code>-</code> reads filter
rules from standard input.</p>
<h3 id="filter---add-a-file-filtering-rule"><code>--filter</code> - Add
a file-filtering rule</h3>
<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>
<p>This flag can be repeated. See above for the order filter flags are
processed in.</p>
<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>
<p><code>--filter</code> has no effect when combined with
<code>--files-from</code> or <code>--files-from-raw</code> flags.</p>
<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>
<p>E.g. <code>rclone ls remote: --filter "- *.bak"</code> excludes all
<code>.bak</code> files from a list of <code>remote:</code>.</p>
<h3
id="filter-from---read-filtering-patterns-from-a-file"><code>--filter-from</code>
- Read filtering patterns from a file</h3>
<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>
<p>This flag can be repeated. See above for the order filter flags are
processed in.</p>
<p>Arrange the order of filter rules with the most restrictive first and
work down.</p>
<p>E.g. for <code>filter-file.txt</code>:</p>
<pre><code># a sample filter rule file
- secret*.jpg
+ *.jpg
+ *.png
+ file2.avi
- /dir/Trash/**
+ /dir/**
# exclude everything else
- *</code></pre>
<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>
<p>E.g. for an alternative <code>filter-file.txt</code>:</p>
<pre><code>- secret*.jpg
+ *.jpg
+ *.png
+ file2.avi
- *</code></pre>
<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 .jpg<code>or</code>.png` are excluded.</p>
<p>E.g. for an alternative <code>filter-file.txt</code>:</p>
<pre><code>+ *.jpg
+ *.gif
!
+ 42.doc
- *</code></pre>
<p>Only file 42.doc is listed. Prior rules are cleared by the
<code>!</code>.</p>
<h3
id="files-from---read-list-of-source-file-names"><code>--files-from</code>
- Read list of source-file names</h3>
<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>
<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>
<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>
<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>
<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>
<p>Rclone commands do not error if any names in the
<code>--files-from</code> file are missing from the source remote.</p>
<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>
<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>
<p>E.g. for a file <code>files-from.txt</code>:</p>
<pre><code># comment
file1.jpg
subdir/file2.jpg</code></pre>
<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>
<pre><code>/home/me/pics/file1.jpg        → remote:pics/file1.jpg
/home/me/pics/subdir/file2.jpg → remote:pics/subdir/file2.jpg</code></pre>
<p>E.g. to copy the following files referenced by their absolute
paths:</p>
<pre><code>/home/user1/42
/home/user1/dir/ford
/home/user2/prefect</code></pre>
<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>
<pre><code>user1/42
user1/dir/ford
user2/prefect</code></pre>
<p>Then copy these to a remote:</p>
<pre><code>rclone copy --files-from files-from.txt /home remote:backup</code></pre>
<p>The three files are transferred as follows:</p>
<pre><code>/home/user1/42       → remote:backup/user1/important
/home/user1/dir/ford → remote:backup/user1/dir/file
/home/user2/prefect  → remote:backup/user2/stuff</code></pre>
<p>Alternatively if <code>/</code> is chosen as root
<code>files-from.txt</code> will be:</p>
<pre><code>/home/user1/42
/home/user1/dir/ford
/home/user2/prefect</code></pre>
<p>The copy command will be:</p>
<pre><code>rclone copy --files-from files-from.txt / remote:backup</code></pre>
<p>Then there will be an extra <code>home</code> directory on the
remote:</p>
<pre><code>/home/user1/42       → remote:backup/home/user1/42
/home/user1/dir/ford → remote:backup/home/user1/dir/ford
/home/user2/prefect  → remote:backup/home/user2/prefect</code></pre>
<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>
<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>
<h3
id="ignore-case---make-searches-case-insensitive"><code>--ignore-case</code>
- make searches case insensitive</h3>
<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>
<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>
<h2 id="quoting-shell-metacharacters">Quoting shell metacharacters</h2>
<p>Rclone commands with filter patterns containing shell metacharacters
may not as work as expected in your shell and may require quoting.</p>
<p>E.g. linux, OSX (<code>*</code> metacharacter)</p>
<ul>
<li><code>--include \*.jpg</code></li>
<li><code>--include '*.jpg'</code></li>
<li><code>--include='*.jpg'</code></li>
</ul>
<p>Microsoft Windows expansion is done by the command, not shell, so
<code>--include *.jpg</code> does not require quoting.</p>
<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>
<h2 id="other-filters">Other filters</h2>
<h3
id="min-size---dont-transfer-any-file-smaller-than-this"><code>--min-size</code>
- Don’t transfer any file smaller than this</h3>
<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>
<p>E.g. <code>rclone ls remote: --min-size 50k</code> lists files on
<code>remote:</code> of 50 KiB size or larger.</p>
<p>See <a href="https://rclone.org/docs/#size-option">the size option
docs</a> for more info.</p>
<h3
id="max-size---dont-transfer-any-file-larger-than-this"><code>--max-size</code>
- Don’t transfer any file larger than this</h3>
<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>
<p>E.g. <code>rclone ls remote: --max-size 1G</code> lists files on
<code>remote:</code> of 1 GiB size or smaller.</p>
<p>See <a href="https://rclone.org/docs/#size-option">the size option
docs</a> for more info.</p>
<h3
id="max-age---dont-transfer-any-file-older-than-this"><code>--max-age</code>
- Don’t transfer any file older than this</h3>
<p>Controls the maximum age of files within the scope of an rclone
command.</p>
<p><code>--max-age</code> applies only to files and not to
directories.</p>
<p>E.g. <code>rclone ls remote: --max-age 2d</code> lists files on
<code>remote:</code> of 2 days old or less.</p>
<p>See <a href="https://rclone.org/docs/#time-option">the time option
docs</a> for valid formats.</p>
<h3
id="min-age---dont-transfer-any-file-younger-than-this"><code>--min-age</code>
- Don’t transfer any file younger than this</h3>
<p>Controls the minimum age of files within the scope of an rclone
command. (see <code>--max-age</code> for valid formats)</p>
<p><code>--min-age</code> applies only to files and not to
directories.</p>
<p>E.g. <code>rclone ls remote: --min-age 2d</code> lists files on
<code>remote:</code> of 2 days old or more.</p>
<p>See <a href="https://rclone.org/docs/#time-option">the time option
docs</a> for valid formats.</p>
<h2 id="other-flags">Other flags</h2>
<h3
id="delete-excluded---delete-files-on-dest-excluded-from-sync"><code>--delete-excluded</code>
- Delete files on dest excluded from sync</h3>
<p><strong>Important</strong> this flag is dangerous to your data - use
with <code>--dry-run</code> and <code>-v</code> first.</p>
<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>
<p>E.g. the scope of <code>rclone sync -i A: B:</code> can be
restricted:</p>
<pre><code>rclone --min-size 50k --delete-excluded sync A: B:</code></pre>
<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>
<h3
id="dump-filters---dump-the-filters-to-the-output"><code>--dump filters</code>
- dump the filters to the output</h3>
<p>Dumps the defined filters to standard output in regular expression
format.</p>
<p>Useful for debugging.</p>
<h2 id="exclude-directory-based-on-a-file">Exclude directory based on a
file</h2>
<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>
<p>This flag has a priority over other filter flags.</p>
<p>E.g. for the following directory structure:</p>
<pre><code>dir1/file1
dir1/dir2/file2
dir1/dir2/dir3/file3
dir1/dir2/dir3/.ignore</code></pre>
<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>
<h2 id="common-pitfalls">Common pitfalls</h2>
<p>The most frequent filter support issues on the <a
href="https://forum.rclone.org/">rclone forum</a> are:</p>
<ul>
<li>Not using paths relative to the root of the remote</li>
<li>Not using <code>/</code> to match from the root of a remote</li>
<li>Not using <code>**</code> to match the contents of a directory</li>
</ul>
<h1 id="gui-experimental">GUI (Experimental)</h1>
<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>
<p>Run this command in a terminal and rclone will download and then
display the GUI in a web browser.</p>
<pre><code>rclone rcd --rc-web-gui</code></pre>
<p>This will produce logs like this and rclone needs to continue to run
to serve the GUI:</p>
<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
2019/08/25 11:40:14 NOTICE: Downloading webgui binary. Please wait. [Size: 3813937, Path :  /home/USER/.cache/rclone/webgui/v0.0.6.zip]
2019/08/25 11:40:16 NOTICE: Unzipping
2019/08/25 11:40:16 NOTICE: Serving remote control on http://127.0.0.1:5572/</code></pre>
<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>
<p>If you wish to check for updates then you can add
<code>--rc-web-gui-update</code> to the command line.</p>
<p>If you find your GUI broken, you may force it to update by add
<code>--rc-web-gui-force-update</code>.</p>
<p>By default, rclone will open your browser. Add
<code>--rc-web-gui-no-open-browser</code> to disable this feature.</p>
<h2 id="using-the-gui">Using the GUI</h2>
<p>Once the GUI opens, you will be looking at the dashboard which has an
overall overview.</p>
<p>On the left hand side you will see a series of view buttons you can
click on:</p>
<ul>
<li>Dashboard - main overview</li>
<li>Configs - examine and create new configurations</li>
<li>Explorer - view, download and upload files to the cloud storage
systems</li>
<li>Backend - view or alter the backend config</li>
<li>Log out</li>
</ul>
<p>(More docs and walkthrough video to come!)</p>
<h2 id="how-it-works">How it works</h2>
<p>When you run the <code>rclone rcd --rc-web-gui</code> this is what
happens</p>
<ul>
<li>Rclone starts but only runs the remote control API (“rc”).</li>
<li>The API is bound to localhost with an auto-generated username and
password.</li>
<li>If the API bundle is missing then rclone will download it.</li>
<li>rclone will start serving the files from the API bundle over the
same port as the API</li>
<li>rclone will open the browser with a <code>login_token</code> so it
can log straight in.</li>
</ul>
<h2 id="advanced-use">Advanced use</h2>
<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>
<p>The flag <code>--rc-web-gui</code> is shorthand for</p>
<ul>
<li>Download the web GUI if necessary</li>
<li>Check we are using some authentication</li>
<li><code>--rc-user gui</code></li>
<li><code>--rc-pass &lt;random password&gt;</code></li>
<li><code>--rc-serve</code></li>
</ul>
<p>These flags can be overridden as desired.</p>
<p>See also the <a href="https://rclone.org/commands/rclone_rcd/">rclone
rcd documentation</a>.</p>
<h3 id="example-running-a-public-gui">Example: Running a public GUI</h3>
<p>For example the GUI could be served on a public port over SSL using
an htpasswd file using the following flags:</p>
<ul>
<li><code>--rc-web-gui</code></li>
<li><code>--rc-addr :443</code></li>
<li><code>--rc-htpasswd /path/to/htpasswd</code></li>
<li><code>--rc-cert /path/to/ssl.crt</code></li>
<li><code>--rc-key /path/to/ssl.key</code></li>
</ul>
<h3 id="example-running-a-gui-behind-a-proxy">Example: Running a GUI
behind a proxy</h3>
<p>If you want to run the GUI behind a proxy at <code>/rclone</code> you
could use these flags:</p>
<ul>
<li><code>--rc-web-gui</code></li>
<li><code>--rc-baseurl rclone</code></li>
<li><code>--rc-htpasswd /path/to/htpasswd</code></li>
</ul>
<p>Or instead of htpasswd if you just want a single user and
password:</p>
<ul>
<li><code>--rc-user me</code></li>
<li><code>--rc-pass mypassword</code></li>
</ul>
<h2 id="project">Project</h2>
<p>The GUI is being developed in the: <a
href="https://github.com/rclone/rclone-webui-react">rclone/rclone-webui-react
repository</a>.</p>
<p>Bug reports and contributions are very welcome :-)</p>
<p>If you have questions then please ask them on the <a
href="https://forum.rclone.org/">rclone forum</a>.</p>
<h1 id="remote-controlling-rclone-with-its-api">Remote controlling
rclone with its API</h1>
<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>
<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>
<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>
<h2 id="supported-parameters">Supported parameters</h2>
<h3 id="rc">–rc</h3>
<p>Flag to start the http server listen on remote requests</p>
<h3 id="rc-addrip">–rc-addr=IP</h3>
<p>IPaddress:Port or :Port to bind server to. (default
“localhost:5572”)</p>
<h3 id="rc-certkey">–rc-cert=KEY</h3>
<p>SSL PEM key (concatenation of certificate and CA certificate)</p>
<h3 id="rc-client-capath">–rc-client-ca=PATH</h3>
<p>Client certificate authority to verify clients with</p>
<h3 id="rc-htpasswdpath">–rc-htpasswd=PATH</h3>
<p>htpasswd file - if not provided no authentication is done</p>
<h3 id="rc-keypath">–rc-key=PATH</h3>
<p>SSL PEM Private key</p>
<h3 id="rc-max-header-bytesvalue">–rc-max-header-bytes=VALUE</h3>
<p>Maximum size of request header (default 4096)</p>
<h3 id="rc-min-tls-versionvalue">–rc-min-tls-version=VALUE</h3>
<p>The minimum TLS version that is acceptable. Valid values are
“tls1.0”, “tls1.1”, “tls1.2” and “tls1.3” (default “tls1.0”).</p>
<h3 id="rc-uservalue">–rc-user=VALUE</h3>
<p>User name for authentication.</p>
<h3 id="rc-passvalue">–rc-pass=VALUE</h3>
<p>Password for authentication.</p>
<h3 id="rc-realmvalue">–rc-realm=VALUE</h3>
<p>Realm for authentication (default “rclone”)</p>
<h3
id="rc-server-read-timeoutduration">–rc-server-read-timeout=DURATION</h3>
<p>Timeout for server reading data (default 1h0m0s)</p>
<h3
id="rc-server-write-timeoutduration">–rc-server-write-timeout=DURATION</h3>
<p>Timeout for server writing data (default 1h0m0s)</p>
<h3 id="rc-serve">–rc-serve</h3>
<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>
<p>Default Off.</p>
<h3 id="rc-files-pathtodirectory">–rc-files /path/to/directory</h3>
<p>Path to local files to serve on the HTTP server.</p>
<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>
<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>
<p>Default Off.</p>
<h3 id="rc-enable-metrics">–rc-enable-metrics</h3>
<p>Enable OpenMetrics/Prometheus compatible endpoint at
<code>/metrics</code>.</p>
<p>Default Off.</p>
<h3 id="rc-web-gui">–rc-web-gui</h3>
<p>Set this flag to serve the default web gui on the same port as
rclone.</p>
<p>Default Off.</p>
<h3 id="rc-allow-origin">–rc-allow-origin</h3>
<p>Set the allowed Access-Control-Allow-Origin for rc requests.</p>
<p>Can be used with –rc-web-gui if the rclone is running on different IP
than the web-gui.</p>
<p>Default is IP address on which rc is running.</p>
<h3 id="rc-web-fetch-url">–rc-web-fetch-url</h3>
<p>Set the URL to fetch the rclone-web-gui files from.</p>
<p>Default
https://api.github.com/repos/rclone/rclone-webui-react/releases/latest.</p>
<h3 id="rc-web-gui-update">–rc-web-gui-update</h3>
<p>Set this flag to check and update rclone-webui-react from the
rc-web-fetch-url.</p>
<p>Default Off.</p>
<h3 id="rc-web-gui-force-update">–rc-web-gui-force-update</h3>
<p>Set this flag to force update rclone-webui-react from the
rc-web-fetch-url.</p>
<p>Default Off.</p>
<h3 id="rc-web-gui-no-open-browser">–rc-web-gui-no-open-browser</h3>
<p>Set this flag to disable opening browser automatically when using
web-gui.</p>
<p>Default Off.</p>
<h3
id="rc-job-expire-durationduration">–rc-job-expire-duration=DURATION</h3>
<p>Expire finished async jobs older than DURATION (default 60s).</p>
<h3
id="rc-job-expire-intervalduration">–rc-job-expire-interval=DURATION</h3>
<p>Interval duration to check for expired async jobs (default 10s).</p>
<h3 id="rc-no-auth">–rc-no-auth</h3>
<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>
<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>
<p>Default Off.</p>
<h3 id="rc-baseurl">–rc-baseurl</h3>
<p>Prefix for URLs.</p>
<p>Default is root</p>
<h3 id="rc-template">–rc-template</h3>
<p>User-specified template.</p>
<h2 id="api-rc">Accessing the remote control via the rclone rc
command</h2>
<p>Rclone itself implements the remote control protocol in its
<code>rclone rc</code> command.</p>
<p>You can use it like this</p>
<pre><code>$ rclone rc rc/noop param1=one param2=two
{
    &quot;param1&quot;: &quot;one&quot;,
    &quot;param2&quot;: &quot;two&quot;
}</code></pre>
<p>Run <code>rclone rc</code> on its own to see the help for the
installed remote control commands.</p>
<h2 id="json-input">JSON input</h2>
<p><code>rclone rc</code> also supports a <code>--json</code> flag which
can be used to send more complicated input parameters.</p>
<pre><code>$ rclone rc --json &#39;{ &quot;p1&quot;: [1,&quot;2&quot;,null,4], &quot;p2&quot;: { &quot;a&quot;:1, &quot;b&quot;:2 } }&#39; rc/noop
{
    &quot;p1&quot;: [
        1,
        &quot;2&quot;,
        null,
        4
    ],
    &quot;p2&quot;: {
        &quot;a&quot;: 1,
        &quot;b&quot;: 2
    }
}</code></pre>
<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>
<pre><code>rclone rc operations/list fs=/tmp remote=test opt=&#39;{&quot;showHash&quot;: true}&#39;</code></pre>
<p>Rather than</p>
<pre><code>rclone rc operations/list --json &#39;{&quot;fs&quot;: &quot;/tmp&quot;, &quot;remote&quot;: &quot;test&quot;, &quot;opt&quot;: {&quot;showHash&quot;: true}}&#39;</code></pre>
<h2 id="special-parameters">Special parameters</h2>
<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>
<h3 id="running-asynchronous-jobs-with-_async-true">Running asynchronous
jobs with _async = true</h3>
<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>
<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>
<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>
<p>Starting a job with the <code>_async</code> flag:</p>
<pre><code>$ rclone rc --json &#39;{ &quot;p1&quot;: [1,&quot;2&quot;,null,4], &quot;p2&quot;: { &quot;a&quot;:1, &quot;b&quot;:2 }, &quot;_async&quot;: true }&#39; rc/noop
{
    &quot;jobid&quot;: 2
}</code></pre>
<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>
<pre><code>$ rclone rc --json &#39;{ &quot;jobid&quot;:2 }&#39; job/status
{
    &quot;duration&quot;: 0.000124163,
    &quot;endTime&quot;: &quot;2018-10-27T11:38:07.911245881+01:00&quot;,
    &quot;error&quot;: &quot;&quot;,
    &quot;finished&quot;: true,
    &quot;id&quot;: 2,
    &quot;output&quot;: {
        &quot;_async&quot;: true,
        &quot;p1&quot;: [
            1,
            &quot;2&quot;,
            null,
            4
        ],
        &quot;p2&quot;: {
            &quot;a&quot;: 1,
            &quot;b&quot;: 2
        }
    },
    &quot;startTime&quot;: &quot;2018-10-27T11:38:07.911121728+01:00&quot;,
    &quot;success&quot;: true
}</code></pre>
<p><code>job/list</code> can be used to show the running or recently
completed jobs</p>
<pre><code>$ rclone rc job/list
{
    &quot;jobids&quot;: [
        2
    ]
}</code></pre>
<h3 id="setting-config-flags-with-_config">Setting config flags with
_config</h3>
<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>
<p>This should be in the same format as the <code>config</code> key
returned by <a href="#options-get">options/get</a>.</p>
<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>
<pre><code>&quot;_config&quot;:{&quot;CheckSum&quot;: true}</code></pre>
<p>If using <code>rclone rc</code> this could be passed as</p>
<pre><code>rclone rc operations/sync ... _config=&#39;{&quot;CheckSum&quot;: true}&#39;</code></pre>
<p>Any config parameters you don’t set will inherit the global defaults
which were set with command line flags or environment variables.</p>
<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>
<pre><code>&quot;_config&quot;:{&quot;BufferSize&quot;: &quot;42M&quot;}
&quot;_config&quot;:{&quot;BufferSize&quot;: 44040192}</code></pre>
<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>
<h3 id="setting-filter-flags-with-_filter">Setting filter flags with
_filter</h3>
<p>If you wish to set filters for the duration of an rc call only then
pass in the <code>_filter</code> parameter.</p>
<p>This should be in the same format as the <code>filter</code> key
returned by <a href="#options-get">options/get</a>.</p>
<p>For example, if you wished to run a sync with these flags</p>
<pre><code>--max-size 1M --max-age 42s --include &quot;a&quot; --include &quot;b&quot;</code></pre>
<p>you would pass this parameter in your JSON blob.</p>
<pre><code>&quot;_filter&quot;:{&quot;MaxSize&quot;:&quot;1M&quot;, &quot;IncludeRule&quot;:[&quot;a&quot;,&quot;b&quot;], &quot;MaxAge&quot;:&quot;42s&quot;}</code></pre>
<p>If using <code>rclone rc</code> this could be passed as</p>
<pre><code>rclone rc ... _filter=&#39;{&quot;MaxSize&quot;:&quot;1M&quot;, &quot;IncludeRule&quot;:[&quot;a&quot;,&quot;b&quot;], &quot;MaxAge&quot;:&quot;42s&quot;}&#39;</code></pre>
<p>Any filter parameters you don’t set will inherit the global defaults
which were set with command line flags or environment variables.</p>
<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>
<pre><code>&quot;_filter&quot;:{&quot;MinSize&quot;: &quot;42M&quot;}
&quot;_filter&quot;:{&quot;MinSize&quot;: 44040192}</code></pre>
<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>
<h3 id="assigning-operations-to-groups-with-_group-value">Assigning
operations to groups with _group = value</h3>
<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>
<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>
<p>Stats for specific group can be accessed by passing
<code>group</code> to <code>core/stats</code>:</p>
<pre><code>$ rclone rc --json &#39;{ &quot;group&quot;: &quot;job/1&quot; }&#39; core/stats
{
    &quot;speed&quot;: 12345
    ...
}</code></pre>
<h2 id="data-types">Data types</h2>
<p>When the API returns types, these will mostly be straight forward
integer, string or boolean types.</p>
<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>
<ul>
<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>
<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>
<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>
<li><code>BandwidthSpec</code> - this will be set and returned as a
string, eg “1M”.</li>
</ul>
<h2 id="specifying-remotes-to-work-on">Specifying remotes to work
on</h2>
<p>Remotes are specified with the <code>fs=</code>, <code>srcFs=</code>,
<code>dstFs=</code> parameters depending on the command being used.</p>
<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>
<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>
<ul>
<li><code>type</code> - set to <code>type</code> to specify a remote
called <code>:type:</code></li>
<li><code>_name</code> - set to <code>name</code> to specify a remote
called <code>name:</code></li>
<li><code>_root</code> - sets the root of the remote - may be empty</li>
</ul>
<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>
<p>For example this JSON is equivalent to <code>remote:/tmp</code></p>
<pre><code>{
    &quot;_name&quot;: &quot;remote&quot;,
    &quot;_path&quot;: &quot;/tmp&quot;
}</code></pre>
<p>And this is equivalent to
<code>:sftp,host='example.com':/tmp</code></p>
<pre><code>{
    &quot;type&quot;: &quot;sftp&quot;,
    &quot;host&quot;: &quot;example.com&quot;,
    &quot;_path&quot;: &quot;/tmp&quot;
}</code></pre>
<p>And this is equivalent to <code>/tmp/dir</code></p>
<pre><code>{
    type = &quot;local&quot;,
    _ path = &quot;/tmp/dir&quot;
}</code></pre>
<h2 id="supported-commands">Supported commands</h2>
<h3 id="backend-command">backend/command: Runs a backend command.</h3>
<p>This takes the following parameters:</p>
<ul>
<li>command - a string with the command name</li>
<li>fs - a remote name string e.g. “drive:”</li>
<li>arg - a list of arguments for the backend command</li>
<li>opt - a map of string to string of options</li>
</ul>
<p>Returns:</p>
<ul>
<li>result - result from the backend command</li>
</ul>
<p>Example:</p>
<pre><code>rclone rc backend/command command=noop fs=. -o echo=yes -o blue -a path1 -a path2</code></pre>
<p>Returns</p>
<pre><code>{
    &quot;result&quot;: {
        &quot;arg&quot;: [
            &quot;path1&quot;,
            &quot;path2&quot;
        ],
        &quot;name&quot;: &quot;noop&quot;,
        &quot;opt&quot;: {
            &quot;blue&quot;: &quot;&quot;,
            &quot;echo&quot;: &quot;yes&quot;
        }
    }
}</code></pre>
<p>Note that this is the direct equivalent of using this “backend”
command:</p>
<pre><code>rclone backend noop . -o echo=yes -o blue path1 path2</code></pre>
<p>Note that arguments must be preceded by the “-a” flag</p>
<p>See the <a
href="https://rclone.org/commands/rclone_backend/">backend</a> command
for more information.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="cache-expire">cache/expire: Purge a remote from cache</h3>
<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>
<p>Eg</p>
<pre><code>rclone rc cache/expire remote=path/to/sub/folder/
rclone rc cache/expire remote=/ withData=true</code></pre>
<h3 id="cache-fetch">cache/fetch: Fetch file chunks</h3>
<p>Ensure the specified file chunks are cached on disk.</p>
<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>
<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>
<p>Some valid examples are: “:5,-5:” -&gt; the first and last five
chunks “0,-2” -&gt; the first and the second last chunk “0:10” -&gt; the
first ten chunks</p>
<p>Any parameter with a key that starts with “file” can be used to
specify files to fetch, e.g.</p>
<pre><code>rclone rc cache/fetch chunks=0 file=hello file2=home/goodbye</code></pre>
<p>File names will automatically be encrypted when the a crypt remote is
used on top of the cache.</p>
<h3 id="cache-stats">cache/stats: Get cache stats</h3>
<p>Show statistics for the cache remote.</p>
<h3 id="config-create">config/create: create the config for a
remote.</h3>
<p>This takes the following parameters:</p>
<ul>
<li>name - name of remote</li>
<li>parameters - a map of { “key”: “value” } pairs</li>
<li>type - type of the new remote</li>
<li>opt - a dictionary of options to control the configuration
<ul>
<li>obscure - declare passwords are plain and need obscuring</li>
<li>noObscure - declare passwords are already obscured and don’t need
obscuring</li>
<li>nonInteractive - don’t interact with a user, return questions</li>
<li>continue - continue the config process with an answer</li>
<li>all - ask all the config questions not just the post config
ones</li>
<li>state - state to restart with - used with continue</li>
<li>result - result to restart with - used with continue</li>
</ul></li>
</ul>
<p>See the <a
href="https://rclone.org/commands/rclone_config_create/">config
create</a> command for more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="config-delete">config/delete: Delete a remote in the config
file.</h3>
<p>Parameters:</p>
<ul>
<li>name - name of remote to delete</li>
</ul>
<p>See the <a
href="https://rclone.org/commands/rclone_config_delete/">config
delete</a> command for more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="config-dump">config/dump: Dumps the config file.</h3>
<p>Returns a JSON object: - key: value</p>
<p>Where keys are remote names and values are the config parameters.</p>
<p>See the <a
href="https://rclone.org/commands/rclone_config_dump/">config dump</a>
command for more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="config-get">config/get: Get a remote in the config file.</h3>
<p>Parameters:</p>
<ul>
<li>name - name of remote to get</li>
</ul>
<p>See the <a
href="https://rclone.org/commands/rclone_config_dump/">config dump</a>
command for more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="config-listremotes">config/listremotes: Lists the remotes in the
config file.</h3>
<p>Returns - remotes - array of remote names</p>
<p>See the <a
href="https://rclone.org/commands/rclone_listremotes/">listremotes</a>
command for more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="config-password">config/password: password the config for a
remote.</h3>
<p>This takes the following parameters:</p>
<ul>
<li>name - name of remote</li>
<li>parameters - a map of { “key”: “value” } pairs</li>
</ul>
<p>See the <a
href="https://rclone.org/commands/rclone_config_password/">config
password</a> command for more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="config-providers">config/providers: Shows how providers are
configured in the config file.</h3>
<p>Returns a JSON object: - providers - array of objects</p>
<p>See the <a
href="https://rclone.org/commands/rclone_config_providers/">config
providers</a> command for more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="config-update">config/update: update the config for a
remote.</h3>
<p>This takes the following parameters:</p>
<ul>
<li>name - name of remote</li>
<li>parameters - a map of { “key”: “value” } pairs</li>
<li>opt - a dictionary of options to control the configuration
<ul>
<li>obscure - declare passwords are plain and need obscuring</li>
<li>noObscure - declare passwords are already obscured and don’t need
obscuring</li>
<li>nonInteractive - don’t interact with a user, return questions</li>
<li>continue - continue the config process with an answer</li>
<li>all - ask all the config questions not just the post config
ones</li>
<li>state - state to restart with - used with continue</li>
<li>result - result to restart with - used with continue</li>
</ul></li>
</ul>
<p>See the <a
href="https://rclone.org/commands/rclone_config_update/">config
update</a> command for more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="core-bwlimit">core/bwlimit: Set the bandwidth limit.</h3>
<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>
<p>Eg</p>
<pre><code>rclone rc core/bwlimit rate=off
{
    &quot;bytesPerSecond&quot;: -1,
    &quot;bytesPerSecondTx&quot;: -1,
    &quot;bytesPerSecondRx&quot;: -1,
    &quot;rate&quot;: &quot;off&quot;
}
rclone rc core/bwlimit rate=1M
{
    &quot;bytesPerSecond&quot;: 1048576,
    &quot;bytesPerSecondTx&quot;: 1048576,
    &quot;bytesPerSecondRx&quot;: 1048576,
    &quot;rate&quot;: &quot;1M&quot;
}
rclone rc core/bwlimit rate=1M:100k
{
    &quot;bytesPerSecond&quot;: 1048576,
    &quot;bytesPerSecondTx&quot;: 1048576,
    &quot;bytesPerSecondRx&quot;: 131072,
    &quot;rate&quot;: &quot;1M&quot;
}</code></pre>
<p>If the rate parameter is not supplied then the bandwidth is
queried</p>
<pre><code>rclone rc core/bwlimit
{
    &quot;bytesPerSecond&quot;: 1048576,
    &quot;bytesPerSecondTx&quot;: 1048576,
    &quot;bytesPerSecondRx&quot;: 1048576,
    &quot;rate&quot;: &quot;1M&quot;
}</code></pre>
<p>The format of the parameter is exactly the same as passed to –bwlimit
except only one bandwidth may be specified.</p>
<p>In either case “rate” is returned as a human-readable string, and
“bytesPerSecond” is returned as a number.</p>
<h3 id="core-command">core/command: Run a rclone terminal command over
rc.</h3>
<p>This takes the following parameters:</p>
<ul>
<li>command - a string with the command name.</li>
<li>arg - a list of arguments for the backend command.</li>
<li>opt - a map of string to string of options.</li>
<li>returnType - one of (“COMBINED_OUTPUT”, “STREAM”,
“STREAM_ONLY_STDOUT”, “STREAM_ONLY_STDERR”).
<ul>
<li>Defaults to “COMBINED_OUTPUT” if not set.</li>
<li>The STREAM returnTypes will write the output to the body of the HTTP
message.</li>
<li>The COMBINED_OUTPUT will write the output to the “result”
parameter.</li>
</ul></li>
</ul>
<p>Returns:</p>
<ul>
<li>result - result from the backend command.
<ul>
<li>Only set when using returnType “COMBINED_OUTPUT”.</li>
</ul></li>
<li>error - set if rclone exits with an error code.</li>
<li>returnType - one of (“COMBINED_OUTPUT”, “STREAM”,
“STREAM_ONLY_STDOUT”, “STREAM_ONLY_STDERR”).</li>
</ul>
<p>Example:</p>
<pre><code>rclone rc core/command command=ls -a mydrive:/ -o max-depth=1
rclone rc core/command -a ls -a mydrive:/ -o max-depth=1</code></pre>
<p>Returns:</p>
<pre><code>{
    &quot;error&quot;: false,
    &quot;result&quot;: &quot;&lt;Raw command line output&gt;&quot;
}

OR 
{
    &quot;error&quot;: true,
    &quot;result&quot;: &quot;&lt;Raw command line output&gt;&quot;
}
</code></pre>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="core-gc">core/gc: Runs a garbage collection.</h3>
<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>
<h3 id="core-group-list">core/group-list: Returns list of stats.</h3>
<p>This returns list of stats groups currently in memory.</p>
<p>Returns the following values:</p>
<pre><code>{
    &quot;groups&quot;:  an array of group names:
        [
            &quot;group1&quot;,
            &quot;group2&quot;,
            ...
        ]
}</code></pre>
<h3 id="core-memstats">core/memstats: Returns the memory statistics</h3>
<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>
<p>The most interesting values for most people are:</p>
<ul>
<li>HeapAlloc - this is the amount of memory rclone is actually
using</li>
<li>HeapSys - this is the amount of memory rclone has obtained from the
OS</li>
<li>Sys - this is the total amount of memory requested from the OS
<ul>
<li>It is virtual memory so may include unused memory</li>
</ul></li>
</ul>
<h3 id="core-obscure">core/obscure: Obscures a string passed in.</h3>
<p>Pass a clear string and rclone will obscure it for the config file: -
clear - string</p>
<p>Returns: - obscured - string</p>
<h3 id="core-pid">core/pid: Return PID of current process</h3>
<p>This returns PID of current process. Useful for stopping rclone
process.</p>
<h3 id="core-quit">core/quit: Terminates the app.</h3>
<p>(Optional) Pass an exit code to be used for terminating the app: -
exitCode - int</p>
<h3 id="core-stats">core/stats: Returns stats about current
transfers.</h3>
<p>This returns all available stats:</p>
<pre><code>rclone rc core/stats</code></pre>
<p>If group is not provided then summed up stats for all groups will be
returned.</p>
<p>Parameters</p>
<ul>
<li>group - name of the stats group (string)</li>
</ul>
<p>Returns the following values:</p>
<pre><code>{
    &quot;bytes&quot;: total transferred bytes since the start of the group,
    &quot;checks&quot;: number of files checked,
    &quot;deletes&quot; : number of files deleted,
    &quot;elapsedTime&quot;: time in floating point seconds since rclone was started,
    &quot;errors&quot;: number of errors,
    &quot;eta&quot;: estimated time in seconds until the group completes,
    &quot;fatalError&quot;: boolean whether there has been at least one fatal error,
    &quot;lastError&quot;: last error string,
    &quot;renames&quot; : number of files renamed,
    &quot;retryError&quot;: boolean showing whether there has been at least one non-NoRetryError,
    &quot;speed&quot;: average speed in bytes per second since start of the group,
    &quot;totalBytes&quot;: total number of bytes in the group,
    &quot;totalChecks&quot;: total number of checks in the group,
    &quot;totalTransfers&quot;: total number of transfers in the group,
    &quot;transferTime&quot; : total time spent on running jobs,
    &quot;transfers&quot;: number of transferred files,
    &quot;transferring&quot;: an array of currently active file transfers:
        [
            {
                &quot;bytes&quot;: total transferred bytes for this file,
                &quot;eta&quot;: estimated time in seconds until file transfer completion
                &quot;name&quot;: name of the file,
                &quot;percentage&quot;: progress of the file transfer in percent,
                &quot;speed&quot;: average speed over the whole transfer in bytes per second,
                &quot;speedAvg&quot;: current speed in bytes per second as an exponentially weighted moving average,
                &quot;size&quot;: size of the file in bytes
            }
        ],
    &quot;checking&quot;: an array of names of currently active file checks
        []
}</code></pre>
<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>
<h3 id="core-stats-delete">core/stats-delete: Delete stats group.</h3>
<p>This deletes entire stats group.</p>
<p>Parameters</p>
<ul>
<li>group - name of the stats group (string)</li>
</ul>
<h3 id="core-stats-reset">core/stats-reset: Reset stats.</h3>
<p>This clears counters, errors and finished transfers for all stats or
specific stats group if group is provided.</p>
<p>Parameters</p>
<ul>
<li>group - name of the stats group (string)</li>
</ul>
<h3 id="core-transferred">core/transferred: Returns stats about
completed transfers.</h3>
<p>This returns stats about completed transfers:</p>
<pre><code>rclone rc core/transferred</code></pre>
<p>If group is not provided then completed transfers for all groups will
be returned.</p>
<p>Note only the last 100 completed transfers are returned.</p>
<p>Parameters</p>
<ul>
<li>group - name of the stats group (string)</li>
</ul>
<p>Returns the following values:</p>
<pre><code>{
    &quot;transferred&quot;:  an array of completed transfers (including failed ones):
        [
            {
                &quot;name&quot;: name of the file,
                &quot;size&quot;: size of the file in bytes,
                &quot;bytes&quot;: total transferred bytes for this file,
                &quot;checked&quot;: if the transfer is only checked (skipped, deleted),
                &quot;timestamp&quot;: integer representing millisecond unix epoch,
                &quot;error&quot;: string description of the error (empty if successful),
                &quot;jobid&quot;: id of the job that this transfer belongs to
            }
        ]
}</code></pre>
<h3 id="core-version">core/version: Shows the current version of rclone
and the go runtime.</h3>
<p>This shows the current version of go and the go runtime:</p>
<ul>
<li>version - rclone version, e.g. “v1.53.0”</li>
<li>decomposed - version number as [major, minor, patch]</li>
<li>isGit - boolean - true if this was compiled from the git
version</li>
<li>isBeta - boolean - true if this is a beta version</li>
<li>os - OS in use as according to Go</li>
<li>arch - cpu architecture in use according to Go</li>
<li>goVersion - version of Go runtime in use</li>
<li>linking - type of rclone executable (static or dynamic)</li>
<li>goTags - space separated build tags or “none”</li>
</ul>
<h3 id="debug-set-block-profile-rate">debug/set-block-profile-rate: Set
runtime.SetBlockProfileRate for blocking profiling.</h3>
<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>
<p>To include every blocking event in the profile, pass rate = 1. To
turn off profiling entirely, pass rate &lt;= 0.</p>
<p>After calling this you can use this to see the blocking profile:</p>
<pre><code>go tool pprof http://localhost:5572/debug/pprof/block</code></pre>
<p>Parameters:</p>
<ul>
<li>rate - int</li>
</ul>
<h3
id="debug-set-mutex-profile-fraction">debug/set-mutex-profile-fraction:
Set runtime.SetMutexProfileFraction for mutex profiling.</h3>
<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>
<p>To turn off profiling entirely, pass rate 0. To just read the current
rate, pass rate &lt; 0. (For n&gt;1 the details of sampling may
change.)</p>
<p>Once this is set you can look use this to profile the mutex
contention:</p>
<pre><code>go tool pprof http://localhost:5572/debug/pprof/mutex</code></pre>
<p>Parameters:</p>
<ul>
<li>rate - int</li>
</ul>
<p>Results:</p>
<ul>
<li>previousRate - int</li>
</ul>
<h3 id="fscache-clear">fscache/clear: Clear the Fs cache.</h3>
<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>
<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>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="fscache-entries">fscache/entries: Returns the number of entries
in the fs cache.</h3>
<p>This returns the number of entries in the fs cache.</p>
<p>Returns - entries - number of items in the cache</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="job-list">job/list: Lists the IDs of the running jobs</h3>
<p>Parameters: None.</p>
<p>Results:</p>
<ul>
<li>jobids - array of integer job ids.</li>
</ul>
<h3 id="job-status">job/status: Reads the status of the job ID</h3>
<p>Parameters:</p>
<ul>
<li>jobid - id of the job (integer).</li>
</ul>
<p>Results:</p>
<ul>
<li>finished - boolean</li>
<li>duration - time in seconds that the job ran for</li>
<li>endTime - time the job finished
(e.g. “2018-10-26T18:50:20.528746884+01:00”)</li>
<li>error - error from the job or empty string for no error</li>
<li>finished - boolean whether the job has finished or not</li>
<li>id - as passed in above</li>
<li>startTime - time the job started
(e.g. “2018-10-26T18:50:20.528336039+01:00”)</li>
<li>success - boolean - true for success false otherwise</li>
<li>output - output of the job as would have been returned if called
synchronously</li>
<li>progress - output of the progress related to the underlying job</li>
</ul>
<h3 id="job-stop">job/stop: Stop the running job</h3>
<p>Parameters:</p>
<ul>
<li>jobid - id of the job (integer).</li>
</ul>
<h3 id="job-stopgroup">job/stopgroup: Stop all running jobs in a
group</h3>
<p>Parameters:</p>
<ul>
<li>group - name of the group (string).</li>
</ul>
<h3 id="mount-listmounts">mount/listmounts: Show current mount
points</h3>
<p>This shows currently mounted points, which can be used for performing
an unmount.</p>
<p>This takes no parameters and returns</p>
<ul>
<li>mountPoints: list of current mount points</li>
</ul>
<p>Eg</p>
<pre><code>rclone rc mount/listmounts</code></pre>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="mount-mount">mount/mount: Create a new mount point</h3>
<p>rclone allows Linux, FreeBSD, macOS and Windows to mount any of
Rclone’s cloud storage systems as a file system with FUSE.</p>
<p>If no mountType is provided, the priority is given as follows: 1.
mount 2.cmount 3.mount2</p>
<p>This takes the following parameters:</p>
<ul>
<li>fs - a remote path to be mounted (required)</li>
<li>mountPoint: valid path on the local machine (required)</li>
<li>mountType: one of the values (mount, cmount, mount2) specifies the
mount implementation to use</li>
<li>mountOpt: a JSON object with Mount options in.</li>
<li>vfsOpt: a JSON object with VFS options in.</li>
</ul>
<p>Example:</p>
<pre><code>rclone rc mount/mount fs=mydrive: mountPoint=/home/&lt;user&gt;/mountPoint
rclone rc mount/mount fs=mydrive: mountPoint=/home/&lt;user&gt;/mountPoint mountType=mount
rclone rc mount/mount fs=TestDrive: mountPoint=/mnt/tmp vfsOpt=&#39;{&quot;CacheMode&quot;: 2}&#39; mountOpt=&#39;{&quot;AllowOther&quot;: true}&#39;</code></pre>
<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>
<pre><code>rclone rc options/get</code></pre>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="mount-types">mount/types: Show all possible mount types</h3>
<p>This shows all possible mount types and returns them as a list.</p>
<p>This takes no parameters and returns</p>
<ul>
<li>mountTypes: list of mount types</li>
</ul>
<p>The mount types are strings like “mount”, “mount2”, “cmount” and can
be passed to mount/mount as the mountType parameter.</p>
<p>Eg</p>
<pre><code>rclone rc mount/types</code></pre>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="mount-unmount">mount/unmount: Unmount selected active mount</h3>
<p>rclone allows Linux, FreeBSD, macOS and Windows to mount any of
Rclone’s cloud storage systems as a file system with FUSE.</p>
<p>This takes the following parameters:</p>
<ul>
<li>mountPoint: valid path on the local machine where the mount was
created (required)</li>
</ul>
<p>Example:</p>
<pre><code>rclone rc mount/unmount mountPoint=/home/&lt;user&gt;/mountPoint</code></pre>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="mount-unmountall">mount/unmountall: Unmount all active
mounts</h3>
<p>rclone allows Linux, FreeBSD, macOS and Windows to mount any of
Rclone’s cloud storage systems as a file system with FUSE.</p>
<p>This takes no parameters and returns error if unmount does not
succeed.</p>
<p>Eg</p>
<pre><code>rclone rc mount/unmountall</code></pre>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="operations-about">operations/about: Return the space used on the
remote</h3>
<p>This takes the following parameters:</p>
<ul>
<li>fs - a remote name string e.g. “drive:”</li>
</ul>
<p>The result is as returned from rclone about –json</p>
<p>See the <a href="https://rclone.org/commands/rclone_about/">about</a>
command for more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="operations-cleanup">operations/cleanup: Remove trashed files in
the remote or path</h3>
<p>This takes the following parameters:</p>
<ul>
<li>fs - a remote name string e.g. “drive:”</li>
</ul>
<p>See the <a
href="https://rclone.org/commands/rclone_cleanup/">cleanup</a> command
for more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="operations-copyfile">operations/copyfile: Copy a file from
source remote to destination remote</h3>
<p>This takes the following parameters:</p>
<ul>
<li>srcFs - a remote name string e.g. “drive:” for the source</li>
<li>srcRemote - a path within that remote e.g. “file.txt” for the
source</li>
<li>dstFs - a remote name string e.g. “drive2:” for the destination</li>
<li>dstRemote - a path within that remote e.g. “file2.txt” for the
destination</li>
</ul>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="operations-copyurl">operations/copyurl: Copy the URL to the
object</h3>
<p>This takes the following parameters:</p>
<ul>
<li>fs - a remote name string e.g. “drive:”</li>
<li>remote - a path within that remote e.g. “dir”</li>
<li>url - string, URL to read from</li>
<li>autoFilename - boolean, set to true to retrieve destination file
name from url</li>
</ul>
<p>See the <a
href="https://rclone.org/commands/rclone_copyurl/">copyurl</a> command
for more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="operations-delete">operations/delete: Remove files in the
path</h3>
<p>This takes the following parameters:</p>
<ul>
<li>fs - a remote name string e.g. “drive:”</li>
</ul>
<p>See the <a
href="https://rclone.org/commands/rclone_delete/">delete</a> command for
more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="operations-deletefile">operations/deletefile: Remove the single
file pointed to</h3>
<p>This takes the following parameters:</p>
<ul>
<li>fs - a remote name string e.g. “drive:”</li>
<li>remote - a path within that remote e.g. “dir”</li>
</ul>
<p>See the <a
href="https://rclone.org/commands/rclone_deletefile/">deletefile</a>
command for more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="operations-fsinfo">operations/fsinfo: Return information about
the remote</h3>
<p>This takes the following parameters:</p>
<ul>
<li>fs - a remote name string e.g. “drive:”</li>
</ul>
<p>This returns info about the remote passed in;</p>
<pre><code>{
        // optional features and whether they are available or not
        &quot;Features&quot;: {
                &quot;About&quot;: true,
                &quot;BucketBased&quot;: false,
                &quot;BucketBasedRootOK&quot;: false,
                &quot;CanHaveEmptyDirectories&quot;: true,
                &quot;CaseInsensitive&quot;: false,
                &quot;ChangeNotify&quot;: false,
                &quot;CleanUp&quot;: false,
                &quot;Command&quot;: true,
                &quot;Copy&quot;: false,
                &quot;DirCacheFlush&quot;: false,
                &quot;DirMove&quot;: true,
                &quot;Disconnect&quot;: false,
                &quot;DuplicateFiles&quot;: false,
                &quot;GetTier&quot;: false,
                &quot;IsLocal&quot;: true,
                &quot;ListR&quot;: false,
                &quot;MergeDirs&quot;: false,
                &quot;MetadataInfo&quot;: true,
                &quot;Move&quot;: true,
                &quot;OpenWriterAt&quot;: true,
                &quot;PublicLink&quot;: false,
                &quot;Purge&quot;: true,
                &quot;PutStream&quot;: true,
                &quot;PutUnchecked&quot;: false,
                &quot;ReadMetadata&quot;: true,
                &quot;ReadMimeType&quot;: false,
                &quot;ServerSideAcrossConfigs&quot;: false,
                &quot;SetTier&quot;: false,
                &quot;SetWrapper&quot;: false,
                &quot;Shutdown&quot;: false,
                &quot;SlowHash&quot;: true,
                &quot;SlowModTime&quot;: false,
                &quot;UnWrap&quot;: false,
                &quot;UserInfo&quot;: false,
                &quot;UserMetadata&quot;: true,
                &quot;WrapFs&quot;: false,
                &quot;WriteMetadata&quot;: true,
                &quot;WriteMimeType&quot;: false
        },
        // Names of hashes available
        &quot;Hashes&quot;: [
                &quot;md5&quot;,
                &quot;sha1&quot;,
                &quot;whirlpool&quot;,
                &quot;crc32&quot;,
                &quot;sha256&quot;,
                &quot;dropbox&quot;,
                &quot;mailru&quot;,
                &quot;quickxor&quot;
        ],
        &quot;Name&quot;: &quot;local&quot;,        // Name as created
        &quot;Precision&quot;: 1,         // Precision of timestamps in ns
        &quot;Root&quot;: &quot;/&quot;,            // Path as created
        &quot;String&quot;: &quot;Local file system at /&quot;, // how the remote will appear in logs
        // Information about the system metadata for this backend
        &quot;MetadataInfo&quot;: {
                &quot;System&quot;: {
                        &quot;atime&quot;: {
                                &quot;Help&quot;: &quot;Time of last access&quot;,
                                &quot;Type&quot;: &quot;RFC 3339&quot;,
                                &quot;Example&quot;: &quot;2006-01-02T15:04:05.999999999Z07:00&quot;
                        },
                        &quot;btime&quot;: {
                                &quot;Help&quot;: &quot;Time of file birth (creation)&quot;,
                                &quot;Type&quot;: &quot;RFC 3339&quot;,
                                &quot;Example&quot;: &quot;2006-01-02T15:04:05.999999999Z07:00&quot;
                        },
                        &quot;gid&quot;: {
                                &quot;Help&quot;: &quot;Group ID of owner&quot;,
                                &quot;Type&quot;: &quot;decimal number&quot;,
                                &quot;Example&quot;: &quot;500&quot;
                        },
                        &quot;mode&quot;: {
                                &quot;Help&quot;: &quot;File type and mode&quot;,
                                &quot;Type&quot;: &quot;octal, unix style&quot;,
                                &quot;Example&quot;: &quot;0100664&quot;
                        },
                        &quot;mtime&quot;: {
                                &quot;Help&quot;: &quot;Time of last modification&quot;,
                                &quot;Type&quot;: &quot;RFC 3339&quot;,
                                &quot;Example&quot;: &quot;2006-01-02T15:04:05.999999999Z07:00&quot;
                        },
                        &quot;rdev&quot;: {
                                &quot;Help&quot;: &quot;Device ID (if special file)&quot;,
                                &quot;Type&quot;: &quot;hexadecimal&quot;,
                                &quot;Example&quot;: &quot;1abc&quot;
                        },
                        &quot;uid&quot;: {
                                &quot;Help&quot;: &quot;User ID of owner&quot;,
                                &quot;Type&quot;: &quot;decimal number&quot;,
                                &quot;Example&quot;: &quot;500&quot;
                        }
                },
                &quot;Help&quot;: &quot;Textual help string\n&quot;
        }
}</code></pre>
<p>This command does not have a command line equivalent so use this
instead:</p>
<pre><code>rclone rc --loopback operations/fsinfo fs=remote:</code></pre>
<h3 id="operations-list">operations/list: List the given remote and path
in JSON format</h3>
<p>This takes the following parameters:</p>
<ul>
<li>fs - a remote name string e.g. “drive:”</li>
<li>remote - a path within that remote e.g. “dir”</li>
<li>opt - a dictionary of options to control the listing (optional)
<ul>
<li>recurse - If set recurse directories</li>
<li>noModTime - If set return modification time</li>
<li>showEncrypted - If set show decrypted names</li>
<li>showOrigIDs - If set show the IDs for each item if known</li>
<li>showHash - If set return a dictionary of hashes</li>
<li>noMimeType - If set don’t show mime types</li>
<li>dirsOnly - If set only show directories</li>
<li>filesOnly - If set only show files</li>
<li>metadata - If set return metadata of objects also</li>
<li>hashTypes - array of strings of hash types to show if showHash
set</li>
</ul></li>
</ul>
<p>Returns:</p>
<ul>
<li>list
<ul>
<li>This is an array of objects as described in the lsjson command</li>
</ul></li>
</ul>
<p>See the <a
href="https://rclone.org/commands/rclone_lsjson/">lsjson</a> command for
more information on the above and examples.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="operations-mkdir">operations/mkdir: Make a destination directory
or container</h3>
<p>This takes the following parameters:</p>
<ul>
<li>fs - a remote name string e.g. “drive:”</li>
<li>remote - a path within that remote e.g. “dir”</li>
</ul>
<p>See the <a href="https://rclone.org/commands/rclone_mkdir/">mkdir</a>
command for more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="operations-movefile">operations/movefile: Move a file from
source remote to destination remote</h3>
<p>This takes the following parameters:</p>
<ul>
<li>srcFs - a remote name string e.g. “drive:” for the source</li>
<li>srcRemote - a path within that remote e.g. “file.txt” for the
source</li>
<li>dstFs - a remote name string e.g. “drive2:” for the destination</li>
<li>dstRemote - a path within that remote e.g. “file2.txt” for the
destination</li>
</ul>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="operations-publiclink">operations/publiclink: Create or retrieve
a public link to the given file or folder.</h3>
<p>This takes the following parameters:</p>
<ul>
<li>fs - a remote name string e.g. “drive:”</li>
<li>remote - a path within that remote e.g. “dir”</li>
<li>unlink - boolean - if set removes the link rather than adding it
(optional)</li>
<li>expire - string - the expiry time of the link e.g. “1d”
(optional)</li>
</ul>
<p>Returns:</p>
<ul>
<li>url - URL of the resource</li>
</ul>
<p>See the <a href="https://rclone.org/commands/rclone_link/">link</a>
command for more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="operations-purge">operations/purge: Remove a directory or
container and all of its contents</h3>
<p>This takes the following parameters:</p>
<ul>
<li>fs - a remote name string e.g. “drive:”</li>
<li>remote - a path within that remote e.g. “dir”</li>
</ul>
<p>See the <a href="https://rclone.org/commands/rclone_purge/">purge</a>
command for more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="operations-rmdir">operations/rmdir: Remove an empty directory or
container</h3>
<p>This takes the following parameters:</p>
<ul>
<li>fs - a remote name string e.g. “drive:”</li>
<li>remote - a path within that remote e.g. “dir”</li>
</ul>
<p>See the <a href="https://rclone.org/commands/rclone_rmdir/">rmdir</a>
command for more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="operations-rmdirs">operations/rmdirs: Remove all the empty
directories in the path</h3>
<p>This takes the following parameters:</p>
<ul>
<li>fs - a remote name string e.g. “drive:”</li>
<li>remote - a path within that remote e.g. “dir”</li>
<li>leaveRoot - boolean, set to true not to delete the root</li>
</ul>
<p>See the <a
href="https://rclone.org/commands/rclone_rmdirs/">rmdirs</a> command for
more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="operations-size">operations/size: Count the number of bytes and
files in remote</h3>
<p>This takes the following parameters:</p>
<ul>
<li>fs - a remote name string e.g. “drive:path/to/dir”</li>
</ul>
<p>Returns:</p>
<ul>
<li>count - number of files</li>
<li>bytes - number of bytes in those files</li>
</ul>
<p>See the <a href="https://rclone.org/commands/rclone_size/">size</a>
command for more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="operations-stat">operations/stat: Give information about the
supplied file or directory</h3>
<p>This takes the following parameters</p>
<ul>
<li>fs - a remote name string eg “drive:”</li>
<li>remote - a path within that remote eg “dir”</li>
<li>opt - a dictionary of options to control the listing (optional)
<ul>
<li>see operations/list for the options</li>
</ul></li>
</ul>
<p>The result is</p>
<ul>
<li>item - an object as described in the lsjson command. Will be null if
not found.</li>
</ul>
<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>
<p>See the <a
href="https://rclone.org/commands/rclone_lsjson/">lsjson</a> command for
more information on the above and examples.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="operations-uploadfile">operations/uploadfile: Upload file using
multiform/form-data</h3>
<p>This takes the following parameters:</p>
<ul>
<li>fs - a remote name string e.g. “drive:”</li>
<li>remote - a path within that remote e.g. “dir”</li>
<li>each part in body represents a file to be uploaded</li>
</ul>
<p>See the <a
href="https://rclone.org/commands/rclone_uploadfile/">uploadfile</a>
command for more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="options-blocks">options/blocks: List all the option blocks</h3>
<p>Returns: - options - a list of the options block names</p>
<h3 id="options-get">options/get: Get all the global options</h3>
<p>Returns an object where keys are option block names and values are an
object with the current option values in.</p>
<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>
<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>
<h3 id="options-local">options/local: Get the currently active config
for this call</h3>
<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>
<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>
<p>This call is mostly useful for seeing if _config and _filter passing
is working.</p>
<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>
<h3 id="options-set">options/set: Set an option</h3>
<p>Parameters:</p>
<ul>
<li>option block name containing an object with
<ul>
<li>key: value</li>
</ul></li>
</ul>
<p>Repeated as often as required.</p>
<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>
<p>For example:</p>
<p>This sets DEBUG level logs (-vv) (these can be set by number or
string)</p>
<pre><code>rclone rc options/set --json &#39;{&quot;main&quot;: {&quot;LogLevel&quot;: &quot;DEBUG&quot;}}&#39;
rclone rc options/set --json &#39;{&quot;main&quot;: {&quot;LogLevel&quot;: 8}}&#39;</code></pre>
<p>And this sets INFO level logs (-v)</p>
<pre><code>rclone rc options/set --json &#39;{&quot;main&quot;: {&quot;LogLevel&quot;: &quot;INFO&quot;}}&#39;</code></pre>
<p>And this sets NOTICE level logs (normal without -v)</p>
<pre><code>rclone rc options/set --json &#39;{&quot;main&quot;: {&quot;LogLevel&quot;: &quot;NOTICE&quot;}}&#39;</code></pre>
<h3 id="pluginsctl-addPlugin">pluginsctl/addPlugin: Add a plugin using
url</h3>
<p>Used for adding a plugin to the webgui.</p>
<p>This takes the following parameters:</p>
<ul>
<li>url - http url of the github repo where the plugin is hosted
(http://github.com/rclone/rclone-webui-react).</li>
</ul>
<p>Example:</p>
<p>rclone rc pluginsctl/addPlugin</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="pluginsctl-getPluginsForType">pluginsctl/getPluginsForType: Get
plugins with type criteria</h3>
<p>This shows all possible plugins by a mime type.</p>
<p>This takes the following parameters:</p>
<ul>
<li>type - supported mime type by a loaded plugin e.g. (video/mp4,
audio/mp3).</li>
<li>pluginType - filter plugins based on their type e.g. (DASHBOARD,
FILE_HANDLER, TERMINAL).</li>
</ul>
<p>Returns:</p>
<ul>
<li>loadedPlugins - list of current production plugins.</li>
<li>testPlugins - list of temporarily loaded development plugins,
usually running on a different server.</li>
</ul>
<p>Example:</p>
<p>rclone rc pluginsctl/getPluginsForType type=video/mp4</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="pluginsctl-listPlugins">pluginsctl/listPlugins: Get the list of
currently loaded plugins</h3>
<p>This allows you to get the currently enabled plugins and their
details.</p>
<p>This takes no parameters and returns:</p>
<ul>
<li>loadedPlugins - list of current production plugins.</li>
<li>testPlugins - list of temporarily loaded development plugins,
usually running on a different server.</li>
</ul>
<p>E.g.</p>
<p>rclone rc pluginsctl/listPlugins</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="pluginsctl-listTestPlugins">pluginsctl/listTestPlugins: Show
currently loaded test plugins</h3>
<p>Allows listing of test plugins with the rclone.test set to true in
package.json of the plugin.</p>
<p>This takes no parameters and returns:</p>
<ul>
<li>loadedTestPlugins - list of currently available test plugins.</li>
</ul>
<p>E.g.</p>
<pre><code>rclone rc pluginsctl/listTestPlugins</code></pre>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="pluginsctl-removePlugin">pluginsctl/removePlugin: Remove a
loaded plugin</h3>
<p>This allows you to remove a plugin using it’s name.</p>
<p>This takes parameters:</p>
<ul>
<li>name - name of the plugin in the format
<code>author</code>/<code>plugin_name</code>.</li>
</ul>
<p>E.g.</p>
<p>rclone rc pluginsctl/removePlugin name=rclone/video-plugin</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="pluginsctl-removeTestPlugin">pluginsctl/removeTestPlugin: Remove
a test plugin</h3>
<p>This allows you to remove a plugin using it’s name.</p>
<p>This takes the following parameters:</p>
<ul>
<li>name - name of the plugin in the format
<code>author</code>/<code>plugin_name</code>.</li>
</ul>
<p>Example:</p>
<pre><code>rclone rc pluginsctl/removeTestPlugin name=rclone/rclone-webui-react</code></pre>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="rc-error">rc/error: This returns an error</h3>
<p>This returns an error with the input as part of its error string.
Useful for testing error handling.</p>
<h3 id="rc-list">rc/list: List all the registered remote control
commands</h3>
<p>This lists all the registered remote control commands as a JSON map
in the commands response.</p>
<h3 id="rc-noop">rc/noop: Echo the input to the output parameters</h3>
<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>
<h3 id="rc-noopauth">rc/noopauth: Echo the input to the output
parameters requiring auth</h3>
<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>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="sync-bisync">sync/bisync: Perform bidirectional synchronization
between two paths.</h3>
<p>This takes the following parameters</p>
<ul>
<li>path1 - a remote directory string e.g. <code>drive:path1</code></li>
<li>path2 - a remote directory string e.g. <code>drive:path2</code></li>
<li>dryRun - dry-run mode</li>
<li>resync - performs the resync run</li>
<li>checkAccess - abort if RCLONE_TEST files are not found on both
filesystems</li>
<li>checkFilename - file name for checkAccess (default:
RCLONE_TEST)</li>
<li>maxDelete - abort sync if percentage of deleted files is above this
threshold (default: 50)</li>
<li>force - maxDelete safety check and run the sync</li>
<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>
<li>removeEmptyDirs - remove empty directories at the final cleanup
step</li>
<li>filtersFile - read filtering patterns from a file</li>
<li>workdir - server directory for history files (default:
/home/ncw/.cache/rclone/bisync)</li>
<li>noCleanup - retain working files</li>
</ul>
<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>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="sync-copy">sync/copy: copy a directory from source remote to
destination remote</h3>
<p>This takes the following parameters:</p>
<ul>
<li>srcFs - a remote name string e.g. “drive:src” for the source</li>
<li>dstFs - a remote name string e.g. “drive:dst” for the
destination</li>
<li>createEmptySrcDirs - create empty src directories on destination if
set</li>
</ul>
<p>See the <a href="https://rclone.org/commands/rclone_copy/">copy</a>
command for more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="sync-move">sync/move: move a directory from source remote to
destination remote</h3>
<p>This takes the following parameters:</p>
<ul>
<li>srcFs - a remote name string e.g. “drive:src” for the source</li>
<li>dstFs - a remote name string e.g. “drive:dst” for the
destination</li>
<li>createEmptySrcDirs - create empty src directories on destination if
set</li>
<li>deleteEmptySrcDirs - delete empty src directories if set</li>
</ul>
<p>See the <a href="https://rclone.org/commands/rclone_move/">move</a>
command for more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="sync-sync">sync/sync: sync a directory from source remote to
destination remote</h3>
<p>This takes the following parameters:</p>
<ul>
<li>srcFs - a remote name string e.g. “drive:src” for the source</li>
<li>dstFs - a remote name string e.g. “drive:dst” for the
destination</li>
<li>createEmptySrcDirs - create empty src directories on destination if
set</li>
</ul>
<p>See the <a href="https://rclone.org/commands/rclone_sync/">sync</a>
command for more information on the above.</p>
<p><strong>Authentication is required for this call.</strong></p>
<h3 id="vfs-forget">vfs/forget: Forget files or directories in the
directory cache.</h3>
<p>This forgets the paths in the directory cache causing them to be
re-read from the remote when needed.</p>
<p>If no paths are passed in then it will forget all the paths in the
directory cache.</p>
<pre><code>rclone rc vfs/forget</code></pre>
<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>
<pre><code>rclone rc vfs/forget file=hello file2=goodbye dir=home/junk</code></pre>
<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>
<h3 id="vfs-list">vfs/list: List active VFSes.</h3>
<p>This lists the active VFSes.</p>
<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>
<h3 id="vfs-poll-interval">vfs/poll-interval: Get the status or update
the value of the poll-interval option.</h3>
<p>Without any parameter given this returns the current status of the
poll-interval setting.</p>
<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>
<pre><code>rclone rc vfs/poll-interval interval=5m</code></pre>
<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>
<p>The new poll-interval value will only be active when the timeout is
not reached.</p>
<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>
<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>
<h3 id="vfs-refresh">vfs/refresh: Refresh the directory cache.</h3>
<p>This reads the directories for the specified paths and freshens the
directory cache.</p>
<p>If no paths are passed in then it will refresh the root
directory.</p>
<pre><code>rclone rc vfs/refresh</code></pre>
<p>Otherwise pass directories in as dir=path. Any parameter key starting
with dir will refresh that directory, e.g.</p>
<pre><code>rclone rc vfs/refresh dir=home/junk dir2=data/misc</code></pre>
<p>If the parameter recursive=true is given the whole directory tree
will get refreshed. This refresh will use –fast-list if enabled.</p>
<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>
<h3 id="vfs-stats">vfs/stats: Stats for a VFS.</h3>
<p>This returns stats for the selected VFS.</p>
<pre><code>{
    // Status of the disk cache - only present if --vfs-cache-mode &gt; off
    &quot;diskCache&quot;: {
        &quot;bytesUsed&quot;: 0,
        &quot;erroredFiles&quot;: 0,
        &quot;files&quot;: 0,
        &quot;hashType&quot;: 1,
        &quot;outOfSpace&quot;: false,
        &quot;path&quot;: &quot;/home/user/.cache/rclone/vfs/local/mnt/a&quot;,
        &quot;pathMeta&quot;: &quot;/home/user/.cache/rclone/vfsMeta/local/mnt/a&quot;,
        &quot;uploadsInProgress&quot;: 0,
        &quot;uploadsQueued&quot;: 0
    },
    &quot;fs&quot;: &quot;/mnt/a&quot;,
    &quot;inUse&quot;: 1,
    // Status of the in memory metadata cache
    &quot;metadataCache&quot;: {
        &quot;dirs&quot;: 1,
        &quot;files&quot;: 0
    },
    // Options as returned by options/get
    &quot;opt&quot;: {
        &quot;CacheMaxAge&quot;: 3600000000000,
        // ...
        &quot;WriteWait&quot;: 1000000000
    }
}</code></pre>
<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>
<h2 id="api-http">Accessing the remote control via HTTP</h2>
<p>Rclone implements a simple HTTP based protocol.</p>
<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>
<p>All calls must made using POST.</p>
<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>
<p>The response will be a JSON blob in the body of the response. This is
formatted to be reasonably human-readable.</p>
<h3 id="error-returns">Error returns</h3>
<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>
<pre><code>{
    &quot;error&quot;: &quot;Expecting string value for key \&quot;remote\&quot; (was float64)&quot;,
    &quot;input&quot;: {
        &quot;fs&quot;: &quot;/tmp&quot;,
        &quot;remote&quot;: 3
    },
    &quot;status&quot;: 400
    &quot;path&quot;: &quot;operations/rmdir&quot;,
}</code></pre>
<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>
<h3 id="cors">CORS</h3>
<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>
<h3 id="using-post-with-url-parameters-only">Using POST with URL
parameters only</h3>
<pre><code>curl -X POST &#39;http://localhost:5572/rc/noop?potato=1&amp;sausage=2&#39;</code></pre>
<p>Response</p>
<pre><code>{
    &quot;potato&quot;: &quot;1&quot;,
    &quot;sausage&quot;: &quot;2&quot;
}</code></pre>
<p>Here is what an error response looks like:</p>
<pre><code>curl -X POST &#39;http://localhost:5572/rc/error?potato=1&amp;sausage=2&#39;</code></pre>
<pre><code>{
    &quot;error&quot;: &quot;arbitrary error on input map[potato:1 sausage:2]&quot;,
    &quot;input&quot;: {
        &quot;potato&quot;: &quot;1&quot;,
        &quot;sausage&quot;: &quot;2&quot;
    }
}</code></pre>
<p>Note that curl doesn’t return errors to the shell unless you use the
<code>-f</code> option</p>
<pre><code>$ curl -f -X POST &#39;http://localhost:5572/rc/error?potato=1&amp;sausage=2&#39;
curl: (22) The requested URL returned error: 400 Bad Request
$ echo $?
22</code></pre>
<h3 id="using-post-with-a-form">Using POST with a form</h3>
<pre><code>curl --data &quot;potato=1&quot; --data &quot;sausage=2&quot; http://localhost:5572/rc/noop</code></pre>
<p>Response</p>
<pre><code>{
    &quot;potato&quot;: &quot;1&quot;,
    &quot;sausage&quot;: &quot;2&quot;
}</code></pre>
<p>Note that you can combine these with URL parameters too with the POST
parameters taking precedence.</p>
<pre><code>curl --data &quot;potato=1&quot; --data &quot;sausage=2&quot; &quot;http://localhost:5572/rc/noop?rutabaga=3&amp;sausage=4&quot;</code></pre>
<p>Response</p>
<pre><code>{
    &quot;potato&quot;: &quot;1&quot;,
    &quot;rutabaga&quot;: &quot;3&quot;,
    &quot;sausage&quot;: &quot;4&quot;
}
</code></pre>
<h3 id="using-post-with-a-json-blob">Using POST with a JSON blob</h3>
<pre><code>curl -H &quot;Content-Type: application/json&quot; -X POST -d &#39;{&quot;potato&quot;:2,&quot;sausage&quot;:1}&#39; http://localhost:5572/rc/noop</code></pre>
<p>response</p>
<pre><code>{
    &quot;password&quot;: &quot;xyz&quot;,
    &quot;username&quot;: &quot;xyz&quot;
}</code></pre>
<p>This can be combined with URL parameters too if required. The JSON
blob takes precedence.</p>
<pre><code>curl -H &quot;Content-Type: application/json&quot; -X POST -d &#39;{&quot;potato&quot;:2,&quot;sausage&quot;:1}&#39; &#39;http://localhost:5572/rc/noop?rutabaga=3&amp;potato=4&#39;</code></pre>
<pre><code>{
    &quot;potato&quot;: 2,
    &quot;rutabaga&quot;: &quot;3&quot;,
    &quot;sausage&quot;: 1
}</code></pre>
<h2 id="debugging-rclone-with-pprof">Debugging rclone with pprof</h2>
<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>
<p>To use these, first <a href="https://golang.org/doc/install">install
go</a>.</p>
<h3 id="debugging-memory-use">Debugging memory use</h3>
<p>To profile rclone’s memory use you can run:</p>
<pre><code>go tool pprof -web http://localhost:5572/debug/pprof/heap</code></pre>
<p>This should open a page in your browser showing what is using what
memory.</p>
<p>You can also use the <code>-text</code> flag to produce a textual
summary</p>
<pre><code>$ go tool pprof -text http://localhost:5572/debug/pprof/heap
Showing nodes accounting for 1537.03kB, 100% of 1537.03kB total
      flat  flat%   sum%        cum   cum%
 1024.03kB 66.62% 66.62%  1024.03kB 66.62%  github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.addDecoderNode
     513kB 33.38%   100%      513kB 33.38%  net/http.newBufioWriterSize
         0     0%   100%  1024.03kB 66.62%  github.com/rclone/rclone/cmd/all.init
         0     0%   100%  1024.03kB 66.62%  github.com/rclone/rclone/cmd/serve.init
         0     0%   100%  1024.03kB 66.62%  github.com/rclone/rclone/cmd/serve/restic.init
         0     0%   100%  1024.03kB 66.62%  github.com/rclone/rclone/vendor/golang.org/x/net/http2.init
         0     0%   100%  1024.03kB 66.62%  github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.init
         0     0%   100%  1024.03kB 66.62%  github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.init.0
         0     0%   100%  1024.03kB 66.62%  main.init
         0     0%   100%      513kB 33.38%  net/http.(*conn).readRequest
         0     0%   100%      513kB 33.38%  net/http.(*conn).serve
         0     0%   100%  1024.03kB 66.62%  runtime.main</code></pre>
<h3 id="debugging-go-routine-leaks">Debugging go routine leaks</h3>
<p>Memory leaks are most often caused by go routine leaks keeping memory
alive which should have been garbage collected.</p>
<p>See all active go routines using</p>
<pre><code>curl http://localhost:5572/debug/pprof/goroutine?debug=1</code></pre>
<p>Or go to http://localhost:5572/debug/pprof/goroutine?debug=1 in your
browser.</p>
<h3 id="other-profiles-to-look-at">Other profiles to look at</h3>
<p>You can see a summary of profiles available at
http://localhost:5572/debug/pprof/</p>
<p>Here is how to use some of them:</p>
<ul>
<li>Memory:
<code>go tool pprof http://localhost:5572/debug/pprof/heap</code></li>
<li>Go routines:
<code>curl http://localhost:5572/debug/pprof/goroutine?debug=1</code></li>
<li>30-second CPU profile:
<code>go tool pprof http://localhost:5572/debug/pprof/profile</code></li>
<li>5-second execution trace:
<code>wget http://localhost:5572/debug/pprof/trace?seconds=5</code></li>
<li>Goroutine blocking profile
<ul>
<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>
<li><code>go tool pprof http://localhost:5572/debug/pprof/block</code></li>
</ul></li>
<li>Contended mutexes:
<ul>
<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>
<li><code>go tool pprof http://localhost:5572/debug/pprof/mutex</code></li>
</ul></li>
</ul>
<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>
<p>The profiling hook is <a
href="https://stackoverflow.com/q/26545159/164234">zero overhead unless
it is used</a>.</p>
<h1 id="overview-of-cloud-storage-systems">Overview of cloud storage
systems</h1>
<p>Each cloud storage system is slightly different. Rclone attempts to
provide a unified interface to them, but some underlying differences
show through.</p>
<h2 id="features-1">Features</h2>
<p>Here is an overview of the major features of each cloud storage
system.</p>
<table style="width:100%;">
<colgroup>
<col style="width: 25%" />
<col style="width: 16%" />
<col style="width: 8%" />
<col style="width: 16%" />
<col style="width: 15%" />
<col style="width: 9%" />
<col style="width: 9%" />
</colgroup>
<thead>
<tr class="header">
<th>Name</th>
<th style="text-align: center;">Hash</th>
<th style="text-align: center;">ModTime</th>
<th style="text-align: center;">Case Insensitive</th>
<th style="text-align: center;">Duplicate Files</th>
<th style="text-align: center;">MIME Type</th>
<th style="text-align: center;">Metadata</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>1Fichier</td>
<td style="text-align: center;">Whirlpool</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">R</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="even">
<td>Akamai Netstorage</td>
<td style="text-align: center;">MD5, SHA256</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">R</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="odd">
<td>Amazon Drive</td>
<td style="text-align: center;">MD5</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">R</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="even">
<td>Amazon S3 (or S3 compatible)</td>
<td style="text-align: center;">MD5</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">RWU</td>
</tr>
<tr class="odd">
<td>Backblaze B2</td>
<td style="text-align: center;">SHA1</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="even">
<td>Box</td>
<td style="text-align: center;">SHA1</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="odd">
<td>Citrix ShareFile</td>
<td style="text-align: center;">MD5</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="even">
<td>Dropbox</td>
<td style="text-align: center;">DBHASH ¹</td>
<td style="text-align: center;">R</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="odd">
<td>Enterprise File Fabric</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="even">
<td>FTP</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">R/W ¹⁰</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="odd">
<td>Google Cloud Storage</td>
<td style="text-align: center;">MD5</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="even">
<td>Google Drive</td>
<td style="text-align: center;">MD5</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="odd">
<td>Google Photos</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">R</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="even">
<td>HDFS</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="odd">
<td>HiDrive</td>
<td style="text-align: center;">HiDrive ¹²</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="even">
<td>HTTP</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">R</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">R</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="odd">
<td>Internet Archive</td>
<td style="text-align: center;">MD5, SHA1, CRC32</td>
<td style="text-align: center;">R/W ¹¹</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">RWU</td>
</tr>
<tr class="even">
<td>Jottacloud</td>
<td style="text-align: center;">MD5</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">R</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="odd">
<td>Koofr</td>
<td style="text-align: center;">MD5</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="even">
<td>Mail.ru Cloud</td>
<td style="text-align: center;">Mailru ⁶</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="odd">
<td>Mega</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="even">
<td>Memory</td>
<td style="text-align: center;">MD5</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="odd">
<td>Microsoft Azure Blob Storage</td>
<td style="text-align: center;">MD5</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="even">
<td>Microsoft OneDrive</td>
<td style="text-align: center;">SHA1 ⁵</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">R</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="odd">
<td>OpenDrive</td>
<td style="text-align: center;">MD5</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Partial ⁸</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="even">
<td>OpenStack Swift</td>
<td style="text-align: center;">MD5</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="odd">
<td>Oracle Object Storage</td>
<td style="text-align: center;">MD5</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="even">
<td>pCloud</td>
<td style="text-align: center;">MD5, SHA1 ⁷</td>
<td style="text-align: center;">R</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">W</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="odd">
<td>premiumize.me</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">R</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="even">
<td>put.io</td>
<td style="text-align: center;">CRC-32</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">R</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="odd">
<td>QingStor</td>
<td style="text-align: center;">MD5</td>
<td style="text-align: center;">- ⁹</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="even">
<td>Seafile</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="odd">
<td>SFTP</td>
<td style="text-align: center;">MD5, SHA1 ²</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">Depends</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="even">
<td>Sia</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="odd">
<td>SMB</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="even">
<td>SugarSync</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="odd">
<td>Storj</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">R</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="even">
<td>Uptobox</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="odd">
<td>WebDAV</td>
<td style="text-align: center;">MD5, SHA1 ³</td>
<td style="text-align: center;">R ⁴</td>
<td style="text-align: center;">Depends</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="even">
<td>Yandex Disk</td>
<td style="text-align: center;">MD5</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">R</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="odd">
<td>Zoho WorkDrive</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">-</td>
</tr>
<tr class="even">
<td>The local filesystem</td>
<td style="text-align: center;">All</td>
<td style="text-align: center;">R/W</td>
<td style="text-align: center;">Depends</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">-</td>
<td style="text-align: center;">RWU</td>
</tr>
</tbody>
</table>
<h3 id="notes">Notes</h3>
<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>
<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>
<p>³ WebDAV supports hashes when used with Owncloud and Nextcloud
only.</p>
<p>⁴ WebDAV supports modtimes when used with Owncloud and Nextcloud
only.</p>
<p>⁵ Microsoft OneDrive Personal supports SHA1 hashes, whereas OneDrive
for business and SharePoint server support Microsoft’s own <a
href="https://docs.microsoft.com/en-us/onedrive/developer/code-snippets/quickxorhash">QuickXorHash</a>.</p>
<p>⁶ Mail.ru uses its own modified SHA1 hash</p>
<p>⁷ pCloud only supports SHA1 (not MD5) in its EU region</p>
<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>
<p>⁹ QingStor does not support SetModTime for objects bigger than 5
GiB.</p>
<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/#modified-time">this</a> for more
details.</p>
<p>¹¹ Internet Archive requires option <code>wait_archive</code> to be
set to a non-zero value for full modtime support.</p>
<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>
<h3 id="hash">Hash</h3>
<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>
<p>To use the verify checksums when transferring between cloud storage
systems they must support a common hash type.</p>
<h3 id="modtime">ModTime</h3>
<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
represent 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>
<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>
<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>
<p>Storage systems with <code>R/W</code> (for read/write) in the ModTime
column, means they do also support modtime-only operations.</p>
<h3 id="case-insensitive">Case Insensitive</h3>
<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>
<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>
<p>The local filesystem and SFTP may or may not be case sensitive
depending on OS.</p>
<ul>
<li>Windows - usually case insensitive, though case is preserved</li>
<li>OSX - usually case insensitive, though it is possible to format case
sensitive</li>
<li>Linux - usually case sensitive, but there are case insensitive file
systems (e.g. FAT formatted USB keys)</li>
</ul>
<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>
<h3 id="duplicate-files">Duplicate files</h3>
<p>If a cloud storage system allows duplicate files then it can have two
objects with the same name.</p>
<p>This confuses rclone greatly when syncing - use the
<code>rclone dedupe</code> command to rename or remove duplicates.</p>
<h3 id="restricted-filenames">Restricted filenames</h3>
<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>
<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>
<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>
<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>
<h4 id="restricted-filenames-caveats">Caveats</h4>
<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>
<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>
<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>
<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>
<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>
<p>(Windows was used as an example of a file system with many restricted
characters, and Google drive a storage system with few.)</p>
<h4 id="restricted-characters">Default restricted characters</h4>
<p>The table below shows the characters that are replaced by
default.</p>
<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>
<p>Each cloud storage backend can use a different set of characters,
which will be specified in the documentation for each backend.</p>
<table>
<thead>
<tr class="header">
<th>Character</th>
<th style="text-align: center;">Value</th>
<th style="text-align: center;">Replacement</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>NUL</td>
<td style="text-align: center;">0x00</td>
<td style="text-align: center;">␀</td>
</tr>
<tr class="even">
<td>SOH</td>
<td style="text-align: center;">0x01</td>
<td style="text-align: center;">␁</td>
</tr>
<tr class="odd">
<td>STX</td>
<td style="text-align: center;">0x02</td>
<td style="text-align: center;">␂</td>
</tr>
<tr class="even">
<td>ETX</td>
<td style="text-align: center;">0x03</td>
<td style="text-align: center;">␃</td>
</tr>
<tr class="odd">
<td>EOT</td>
<td style="text-align: center;">0x04</td>
<td style="text-align: center;">␄</td>
</tr>
<tr class="even">
<td>ENQ</td>
<td style="text-align: center;">0x05</td>
<td style="text-align: center;">␅</td>
</tr>
<tr class="odd">
<td>ACK</td>
<td style="text-align: center;">0x06</td>
<td style="text-align: center;">␆</td>
</tr>
<tr class="even">
<td>BEL</td>
<td style="text-align: center;">0x07</td>
<td style="text-align: center;">␇</td>
</tr>
<tr class="odd">
<td>BS</td>
<td style="text-align: center;">0x08</td>
<td style="text-align: center;">␈</td>
</tr>
<tr class="even">
<td>HT</td>
<td style="text-align: center;">0x09</td>
<td style="text-align: center;">␉</td>
</tr>
<tr class="odd">
<td>LF</td>
<td style="text-align: center;">0x0A</td>
<td style="text-align: center;">␊</td>
</tr>
<tr class="even">
<td>VT</td>
<td style="text-align: center;">0x0B</td>
<td style="text-align: center;">␋</td>
</tr>
<tr class="odd">
<td>FF</td>
<td style="text-align: center;">0x0C</td>
<td style="text-align: center;">␌</td>
</tr>
<tr class="even">
<td>CR</td>
<td style="text-align: center;">0x0D</td>
<td style="text-align: center;">␍</td>
</tr>
<tr class="odd">
<td>SO</td>
<td style="text-align: center;">0x0E</td>
<td style="text-align: center;">␎</td>
</tr>
<tr class="even">
<td>SI</td>
<td style="text-align: center;">0x0F</td>
<td style="text-align: center;">␏</td>
</tr>
<tr class="odd">
<td>DLE</td>
<td style="text-align: center;">0x10</td>
<td style="text-align: center;">␐</td>
</tr>
<tr class="even">
<td>DC1</td>
<td style="text-align: center;">0x11</td>
<td style="text-align: center;">␑</td>
</tr>
<tr class="odd">
<td>DC2</td>
<td style="text-align: center;">0x12</td>
<td style="text-align: center;">␒</td>
</tr>
<tr class="even">
<td>DC3</td>
<td style="text-align: center;">0x13</td>
<td style="text-align: center;">␓</td>
</tr>
<tr class="odd">
<td>DC4</td>
<td style="text-align: center;">0x14</td>
<td style="text-align: center;">␔</td>
</tr>
<tr class="even">
<td>NAK</td>
<td style="text-align: center;">0x15</td>
<td style="text-align: center;">␕</td>
</tr>
<tr class="odd">
<td>SYN</td>
<td style="text-align: center;">0x16</td>
<td style="text-align: center;">␖</td>
</tr>
<tr class="even">
<td>ETB</td>
<td style="text-align: center;">0x17</td>
<td style="text-align: center;">␗</td>
</tr>
<tr class="odd">
<td>CAN</td>
<td style="text-align: center;">0x18</td>
<td style="text-align: center;">␘</td>
</tr>
<tr class="even">
<td>EM</td>
<td style="text-align: center;">0x19</td>
<td style="text-align: center;">␙</td>
</tr>
<tr class="odd">
<td>SUB</td>
<td style="text-align: center;">0x1A</td>
<td style="text-align: center;">␚</td>
</tr>
<tr class="even">
<td>ESC</td>
<td style="text-align: center;">0x1B</td>
<td style="text-align: center;">␛</td>
</tr>
<tr class="odd">
<td>FS</td>
<td style="text-align: center;">0x1C</td>
<td style="text-align: center;">␜</td>
</tr>
<tr class="even">
<td>GS</td>
<td style="text-align: center;">0x1D</td>
<td style="text-align: center;">␝</td>
</tr>
<tr class="odd">
<td>RS</td>
<td style="text-align: center;">0x1E</td>
<td style="text-align: center;">␞</td>
</tr>
<tr class="even">
<td>US</td>
<td style="text-align: center;">0x1F</td>
<td style="text-align: center;">␟</td>
</tr>
<tr class="odd">
<td>/</td>
<td style="text-align: center;">0x2F</td>
<td style="text-align: center;">／</td>
</tr>
<tr class="even">
<td>DEL</td>
<td style="text-align: center;">0x7F</td>
<td style="text-align: center;">␡</td>
</tr>
</tbody>
</table>
<p>The default encoding will also encode these file names as they are
problematic with many cloud storage systems.</p>
<table>
<thead>
<tr class="header">
<th>File name</th>
<th style="text-align: center;">Replacement</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>.</td>
<td style="text-align: center;">．</td>
</tr>
<tr class="even">
<td>..</td>
<td style="text-align: center;">．．</td>
</tr>
</tbody>
</table>
<h4 id="invalid-utf8">Invalid UTF-8 bytes</h4>
<p>Some backends only support a sequence of well formed UTF-8 bytes as
file or directory names.</p>
<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>
<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>
<h4 id="encoding">Encoding option</h4>
<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>
<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>
<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>
<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>
<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>
<table>
<colgroup>
<col style="width: 31%" />
<col style="width: 34%" />
<col style="width: 34%" />
</colgroup>
<thead>
<tr class="header">
<th>Encoding</th>
<th>Characters</th>
<th>Encoded as</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>Asterisk</td>
<td><code>*</code></td>
<td><code>＊</code></td>
</tr>
<tr class="even">
<td>BackQuote</td>
<td><code>`</code></td>
<td><code>｀</code></td>
</tr>
<tr class="odd">
<td>BackSlash</td>
<td><code>\</code></td>
<td><code>＼</code></td>
</tr>
<tr class="even">
<td>Colon</td>
<td><code>:</code></td>
<td><code>：</code></td>
</tr>
<tr class="odd">
<td>CrLf</td>
<td>CR 0x0D, LF 0x0A</td>
<td><code>␍</code>, <code>␊</code></td>
</tr>
<tr class="even">
<td>Ctl</td>
<td>All control characters 0x00-0x1F</td>
<td><code>␀␁␂␃␄␅␆␇␈␉␊␋␌␍␎␏␐␑␒␓␔␕␖␗␘␙␚␛␜␝␞␟</code></td>
</tr>
<tr class="odd">
<td>Del</td>
<td>DEL 0x7F</td>
<td><code>␡</code></td>
</tr>
<tr class="even">
<td>Dollar</td>
<td><code>$</code></td>
<td><code>＄</code></td>
</tr>
<tr class="odd">
<td>Dot</td>
<td><code>.</code> or <code>..</code> as entire string</td>
<td><code>．</code>, <code>．．</code></td>
</tr>
<tr class="even">
<td>DoubleQuote</td>
<td><code>"</code></td>
<td><code>＂</code></td>
</tr>
<tr class="odd">
<td>Hash</td>
<td><code>#</code></td>
<td><code>＃</code></td>
</tr>
<tr class="even">
<td>InvalidUtf8</td>
<td>An invalid UTF-8 character (e.g. latin1)</td>
<td><code>�</code></td>
</tr>
<tr class="odd">
<td>LeftCrLfHtVt</td>
<td>CR 0x0D, LF 0x0A, HT 0x09, VT 0x0B on the left of a string</td>
<td><code>␍</code>, <code>␊</code>, <code>␉</code>, <code>␋</code></td>
</tr>
<tr class="even">
<td>LeftPeriod</td>
<td><code>.</code> on the left of a string</td>
<td><code>.</code></td>
</tr>
<tr class="odd">
<td>LeftSpace</td>
<td>SPACE on the left of a string</td>
<td><code>␠</code></td>
</tr>
<tr class="even">
<td>LeftTilde</td>
<td><code>~</code> on the left of a string</td>
<td><code>～</code></td>
</tr>
<tr class="odd">
<td>LtGt</td>
<td><code>&lt;</code>, <code>&gt;</code></td>
<td><code>＜</code>, <code>＞</code></td>
</tr>
<tr class="even">
<td>None</td>
<td>No characters are encoded</td>
<td></td>
</tr>
<tr class="odd">
<td>Percent</td>
<td><code>%</code></td>
<td><code>％</code></td>
</tr>
<tr class="even">
<td>Pipe</td>
<td>|</td>
<td><code>｜</code></td>
</tr>
<tr class="odd">
<td>Question</td>
<td><code>?</code></td>
<td><code>？</code></td>
</tr>
<tr class="even">
<td>RightCrLfHtVt</td>
<td>CR 0x0D, LF 0x0A, HT 0x09, VT 0x0B on the right of a string</td>
<td><code>␍</code>, <code>␊</code>, <code>␉</code>, <code>␋</code></td>
</tr>
<tr class="odd">
<td>RightPeriod</td>
<td><code>.</code> on the right of a string</td>
<td><code>.</code></td>
</tr>
<tr class="even">
<td>RightSpace</td>
<td>SPACE on the right of a string</td>
<td><code>␠</code></td>
</tr>
<tr class="odd">
<td>Semicolon</td>
<td><code>;</code></td>
<td><code>；</code></td>
</tr>
<tr class="even">
<td>SingleQuote</td>
<td><code>'</code></td>
<td><code>＇</code></td>
</tr>
<tr class="odd">
<td>Slash</td>
<td><code>/</code></td>
<td><code>／</code></td>
</tr>
<tr class="even">
<td>SquareBracket</td>
<td><code>[</code>, <code>]</code></td>
<td><code>［</code>, <code>］</code></td>
</tr>
</tbody>
</table>
<h5 id="encoding-example-ftp">Encoding example: FTP</h5>
<p>To take a specific example, the FTP backend’s default encoding is</p>
<pre><code>--ftp-encoding &quot;Slash,Del,Ctl,RightSpace,Dot&quot;</code></pre>
<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>
<pre><code>Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot</code></pre>
<p>to the existing ones, giving:</p>
<pre><code>Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot,Del,RightSpace</code></pre>
<p>This can be specified using the <code>--ftp-encoding</code> flag or
using an <code>encoding</code> parameter in the config file.</p>
<h5 id="encoding-example-windows">Encoding example: Windows</h5>
<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>
<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>
<pre><code>--local-encoding &quot;Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot&quot;</code></pre>
<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>
<pre><code>--local-encoding &quot;Slash,LtGt,DoubleQuote,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot&quot;</code></pre>
<p>Alternatively, you can disable the conversion of any characters with
<code>--local-encoding None</code>.</p>
<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>
<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>
<h3 id="mime-type">MIME Type</h3>
<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>
<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>
<p>The MIME type can be important if you are serving files directly to
HTTP from the storage system.</p>
<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>
<h3 id="metadata-1">Metadata</h3>
<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>
<p>The levels of metadata support are</p>
<table>
<colgroup>
<col style="width: 27%" />
<col style="width: 72%" />
</colgroup>
<thead>
<tr class="header">
<th>Key</th>
<th>Explanation</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td><code>R</code></td>
<td>Read only System Metadata</td>
</tr>
<tr class="even">
<td><code>RW</code></td>
<td>Read and write System Metadata</td>
</tr>
<tr class="odd">
<td><code>RWU</code></td>
<td>Read and write System Metadata and read and write User Metadata</td>
</tr>
</tbody>
</table>
<p>See <a href="https://rclone.org/docs/#metadata">the metadata docs</a>
for more info.</p>
<h2 id="optional-features">Optional Features</h2>
<p>All rclone remotes support a base command set. Other features depend
upon backend-specific capabilities.</p>
<table>
<colgroup>
<col style="width: 23%" />
<col style="width: 5%" />
<col style="width: 5%" />
<col style="width: 5%" />
<col style="width: 7%" />
<col style="width: 7%" />
<col style="width: 5%" />
<col style="width: 11%" />
<col style="width: 11%" />
<col style="width: 5%" />
<col style="width: 8%" />
</colgroup>
<thead>
<tr class="header">
<th>Name</th>
<th style="text-align: center;">Purge</th>
<th style="text-align: center;">Copy</th>
<th style="text-align: center;">Move</th>
<th style="text-align: center;">DirMove</th>
<th style="text-align: center;">CleanUp</th>
<th style="text-align: center;">ListR</th>
<th style="text-align: center;">StreamUpload</th>
<th style="text-align: center;">LinkSharing</th>
<th style="text-align: center;">About</th>
<th style="text-align: center;">EmptyDir</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>1Fichier</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="even">
<td>Akamai Netstorage</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="odd">
<td>Amazon Drive</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="even">
<td>Amazon S3 (or S3 compatible)</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
</tr>
<tr class="odd">
<td>Backblaze B2</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
</tr>
<tr class="even">
<td>Box</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes ‡‡</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="odd">
<td>Citrix ShareFile</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="even">
<td>Dropbox</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="odd">
<td>Enterprise File Fabric</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="even">
<td>FTP</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="odd">
<td>Google Cloud Storage</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
</tr>
<tr class="even">
<td>Google Drive</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="odd">
<td>Google Photos</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
</tr>
<tr class="even">
<td>HDFS</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="odd">
<td>HiDrive</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="even">
<td>HTTP</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="odd">
<td>Internet Archive</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
</tr>
<tr class="even">
<td>Jottacloud</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="odd">
<td>Koofr</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="even">
<td>Mail.ru Cloud</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="odd">
<td>Mega</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="even">
<td>Memory</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
</tr>
<tr class="odd">
<td>Microsoft Azure Blob Storage</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
</tr>
<tr class="even">
<td>Microsoft OneDrive</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="odd">
<td>OpenDrive</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="even">
<td>OpenStack Swift</td>
<td style="text-align: center;">Yes †</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
</tr>
<tr class="odd">
<td>Oracle Object Storage</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
</tr>
<tr class="even">
<td>pCloud</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="odd">
<td>premiumize.me</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="even">
<td>put.io</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="odd">
<td>QingStor</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
</tr>
<tr class="even">
<td>Seafile</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="odd">
<td>SFTP</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="even">
<td>Sia</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="odd">
<td>SMB</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="even">
<td>SugarSync</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="odd">
<td>Storj</td>
<td style="text-align: center;">Yes †</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
</tr>
<tr class="even">
<td>Uptobox</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
</tr>
<tr class="odd">
<td>WebDAV</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes ‡</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="even">
<td>Yandex Disk</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="odd">
<td>Zoho WorkDrive</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
</tr>
<tr class="even">
<td>The local filesystem</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">No</td>
<td style="text-align: center;">Yes</td>
<td style="text-align: center;">Yes</td>
</tr>
</tbody>
</table>
<h3 id="purge">Purge</h3>
<p>This deletes a directory quicker than just deleting all the files in
the directory.</p>
<p>† Note Swift and Storj implement this in order to delete directory
markers but they don’t actually have a quicker way of deleting files
other than deleting them individually.</p>
<p>‡ StreamUpload is not supported with Nextcloud</p>
<h3 id="copy">Copy</h3>
<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>
<p>If the server doesn’t support <code>Copy</code> directly then for
copy operations the file is downloaded then re-uploaded.</p>
<h3 id="move">Move</h3>
<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>
<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>
<h3 id="dirmove">DirMove</h3>
<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>
<h3 id="cleanup">CleanUp</h3>
<p>This is used for emptying the trash for a remote by
<code>rclone cleanup</code>.</p>
<p>If the server can’t do <code>CleanUp</code> then
<code>rclone cleanup</code> will return an error.</p>
<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>
<h3 id="listr">ListR</h3>
<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>
<h3 id="streamupload">StreamUpload</h3>
<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>
<h3 id="linksharing">LinkSharing</h3>
<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>
<h3 id="about-1">About</h3>
<p>Rclone <code>about</code> prints quota information for a remote.
Typical output includes bytes used, free, quota and in trash.</p>
<p>If a remote lacks about capability
<code>rclone about remote:</code>returns an error.</p>
<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>
<p>See <a href="https://rclone.org/commands/rclone_about/">rclone about
command</a></p>
<h3 id="emptydir">EmptyDir</h3>
<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>
<h1 id="global-flags">Global Flags</h1>
<p>This describes the global flags available to every rclone command
split into two groups, non backend and backend flags.</p>
<h2 id="non-backend-flags">Non Backend Flags</h2>
<p>These flags are available for every command.</p>
<pre><code>      --ask-password                         Allow prompt for password for encrypted configuration (default true)
      --auto-confirm                         If enabled, do not request console confirmation
      --backup-dir string                    Make backups into hierarchy based in DIR
      --bind string                          Local address to bind to for outgoing connections, IPv4, IPv6 or name
      --buffer-size SizeSuffix               In memory buffer size when reading files for each --transfer (default 16Mi)
      --bwlimit BwTimetable                  Bandwidth limit in KiB/s, or use suffix B|K|M|G|T|P or a full timetable
      --bwlimit-file BwTimetable             Bandwidth limit per file in KiB/s, or use suffix B|K|M|G|T|P or a full timetable
      --ca-cert string                       CA certificate used to verify servers
      --cache-dir string                     Directory rclone will use for caching (default &quot;$HOME/.cache/rclone&quot;)
      --check-first                          Do all the checks before starting transfers
      --checkers int                         Number of checkers to run in parallel (default 8)
  -c, --checksum                             Skip based on checksum (if available) &amp; size, not mod-time &amp; size
      --client-cert string                   Client SSL certificate (PEM) for mutual TLS auth
      --client-key string                    Client SSL private key (PEM) for mutual TLS auth
      --compare-dest stringArray             Include additional comma separated server-side paths during comparison
      --config string                        Config file (default &quot;$HOME/.config/rclone/rclone.conf&quot;)
      --contimeout duration                  Connect timeout (default 1m0s)
      --copy-dest stringArray                Implies --compare-dest but also copies files from paths into destination
      --cpuprofile string                    Write cpu profile to file
      --cutoff-mode string                   Mode to stop transfers when reaching the max transfer limit HARD|SOFT|CAUTIOUS (default &quot;HARD&quot;)
      --delete-after                         When synchronizing, delete files on destination after transferring (default)
      --delete-before                        When synchronizing, delete files on destination before transferring
      --delete-during                        When synchronizing, delete files during transfer
      --delete-excluded                      Delete files on dest excluded from sync
      --disable string                       Disable a comma separated list of features (use --disable help to see a list)
      --disable-http-keep-alives             Disable HTTP keep-alives and use each connection once.
      --disable-http2                        Disable HTTP/2 in the global transport
  -n, --dry-run                              Do a trial run with no permanent changes
      --dscp string                          Set DSCP value to connections, value or name, e.g. CS1, LE, DF, AF21
      --dump DumpFlags                       List of items to dump from: headers,bodies,requests,responses,auth,filters,goroutines,openfiles
      --dump-bodies                          Dump HTTP headers and bodies - may contain sensitive info
      --dump-headers                         Dump HTTP headers - may contain sensitive info
      --error-on-no-transfer                 Sets exit code 9 if no files are transferred, useful in scripts
      --exclude stringArray                  Exclude files matching pattern
      --exclude-from stringArray             Read exclude patterns from file (use - to read from stdin)
      --exclude-if-present stringArray       Exclude directories if filename is present
      --expect-continue-timeout duration     Timeout when using expect / 100-continue in HTTP (default 1s)
      --fast-list                            Use recursive list if available; uses more memory but fewer transactions
      --files-from stringArray               Read list of source-file names from file (use - to read from stdin)
      --files-from-raw stringArray           Read list of source-file names from file without any processing of lines (use - to read from stdin)
  -f, --filter stringArray                   Add a file-filtering rule
      --filter-from stringArray              Read filtering patterns from a file (use - to read from stdin)
      --fs-cache-expire-duration duration    Cache remotes for this long (0 to disable caching) (default 5m0s)
      --fs-cache-expire-interval duration    Interval to check for expired remotes (default 1m0s)
      --header stringArray                   Set HTTP header for all transactions
      --header-download stringArray          Set HTTP header for download transactions
      --header-upload stringArray            Set HTTP header for upload transactions
      --human-readable                       Print numbers in a human-readable format, sizes with suffix Ki|Mi|Gi|Ti|Pi
      --ignore-case                          Ignore case in filters (case insensitive)
      --ignore-case-sync                     Ignore case when synchronizing
      --ignore-checksum                      Skip post copy check of checksums
      --ignore-errors                        Delete even if there are I/O errors
      --ignore-existing                      Skip all files that exist on destination
      --ignore-size                          Ignore size when skipping use mod-time or checksum
  -I, --ignore-times                         Don&#39;t skip files that match size and time - transfer all files
      --immutable                            Do not modify files, fail if existing files have been modified
      --include stringArray                  Include files matching pattern
      --include-from stringArray             Read include patterns from file (use - to read from stdin)
  -i, --interactive                          Enable interactive mode
      --kv-lock-time duration                Maximum time to keep key-value database locked by process (default 1s)
      --log-file string                      Log everything to this file
      --log-format string                    Comma separated list of log format options (default &quot;date,time&quot;)
      --log-level string                     Log level DEBUG|INFO|NOTICE|ERROR (default &quot;NOTICE&quot;)
      --log-systemd                          Activate systemd integration for the logger
      --low-level-retries int                Number of low level retries to do (default 10)
      --max-age Duration                     Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --max-backlog int                      Maximum number of objects in sync or check backlog (default 10000)
      --max-delete int                       When synchronizing, limit the number of deletes (default -1)
      --max-depth int                        If set limits the recursion depth to this (default -1)
      --max-duration duration                Maximum duration rclone will transfer data for
      --max-size SizeSuffix                  Only transfer files smaller than this in KiB or suffix B|K|M|G|T|P (default off)
      --max-stats-groups int                 Maximum number of stats groups to keep in memory, on max oldest is discarded (default 1000)
      --max-transfer SizeSuffix              Maximum size of data to transfer (default off)
      --memprofile string                    Write memory profile to file
  -M, --metadata                             If set, preserve metadata when copying objects
      --metadata-set stringArray             Add metadata key=value when uploading
      --min-age Duration                     Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
      --min-size SizeSuffix                  Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)
      --modify-window duration               Max time diff to be considered the same (default 1ns)
      --multi-thread-cutoff SizeSuffix       Use multi-thread downloads for files above this size (default 250Mi)
      --multi-thread-streams int             Max number of streams to use for multi-thread downloads (default 4)
      --no-check-certificate                 Do not verify the server SSL certificate (insecure)
      --no-check-dest                        Don&#39;t check the destination, copy regardless
      --no-console                           Hide console window (supported on Windows only)
      --no-gzip-encoding                     Don&#39;t set Accept-Encoding: gzip
      --no-traverse                          Don&#39;t traverse destination file system on copy
      --no-unicode-normalization             Don&#39;t normalize unicode characters in filenames
      --no-update-modtime                    Don&#39;t update destination mod-time if files identical
      --order-by string                      Instructions on how to order the transfers, e.g. &#39;size,descending&#39;
      --password-command SpaceSepList        Command for supplying password for encrypted configuration
  -P, --progress                             Show progress during transfer
      --progress-terminal-title              Show progress on the terminal title (requires -P/--progress)
  -q, --quiet                                Print as little stuff as possible
      --rc                                   Enable the remote control server
      --rc-addr string                       IPaddress:Port or :Port to bind server to (default &quot;localhost:5572&quot;)
      --rc-allow-origin string               Set the allowed origin for CORS
      --rc-baseurl string                    Prefix for URLs - leave blank for root
      --rc-cert string                       SSL PEM key (concatenation of certificate and CA certificate)
      --rc-client-ca string                  Client certificate authority to verify clients with
      --rc-enable-metrics                    Enable prometheus metrics on /metrics
      --rc-files string                      Path to local files to serve on the HTTP server
      --rc-htpasswd string                   htpasswd file - if not provided no authentication is done
      --rc-job-expire-duration duration      Expire finished async jobs older than this value (default 1m0s)
      --rc-job-expire-interval duration      Interval to check for expired async jobs (default 10s)
      --rc-key string                        SSL PEM Private key
      --rc-max-header-bytes int              Maximum size of request header (default 4096)
      --rc-min-tls-version string            Minimum TLS version that is acceptable (default &quot;tls1.0&quot;)
      --rc-no-auth                           Don&#39;t require auth for certain methods
      --rc-pass string                       Password for authentication
      --rc-realm string                      Realm for authentication (default &quot;rclone&quot;)
      --rc-serve                             Enable the serving of remote objects
      --rc-server-read-timeout duration      Timeout for server reading data (default 1h0m0s)
      --rc-server-write-timeout duration     Timeout for server writing data (default 1h0m0s)
      --rc-template string                   User-specified template
      --rc-user string                       User name for authentication
      --rc-web-fetch-url string              URL to fetch the releases for webgui (default &quot;https://api.github.com/repos/rclone/rclone-webui-react/releases/latest&quot;)
      --rc-web-gui                           Launch WebGUI on localhost
      --rc-web-gui-force-update              Force update to latest version of web gui
      --rc-web-gui-no-open-browser           Don&#39;t open the browser automatically
      --rc-web-gui-update                    Check and update to latest version of web gui
      --refresh-times                        Refresh the modtime of remote files
      --retries int                          Retry operations this many times if they fail (default 3)
      --retries-sleep duration               Interval between retrying operations if they fail, e.g. 500ms, 60s, 5m (0 to disable)
      --server-side-across-configs           Allow server-side operations (e.g. copy) to work across different configs
      --size-only                            Skip based on size only, not mod-time or checksum
      --stats duration                       Interval between printing stats, e.g. 500ms, 60s, 5m (0 to disable) (default 1m0s)
      --stats-file-name-length int           Max file name length in stats (0 for no limit) (default 45)
      --stats-log-level string               Log level to show --stats output DEBUG|INFO|NOTICE|ERROR (default &quot;INFO&quot;)
      --stats-one-line                       Make the stats fit on one line
      --stats-one-line-date                  Enable --stats-one-line and add current date/time prefix
      --stats-one-line-date-format string    Enable --stats-one-line-date and use custom formatted date: Enclose date string in double quotes (&quot;), see https://golang.org/pkg/time/#Time.Format
      --stats-unit string                    Show data rate in stats as either &#39;bits&#39; or &#39;bytes&#39; per second (default &quot;bytes&quot;)
      --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)
      --suffix string                        Suffix to add to changed files
      --suffix-keep-extension                Preserve the extension when using --suffix
      --syslog                               Use Syslog for logging
      --syslog-facility string               Facility for syslog, e.g. KERN,USER,... (default &quot;DAEMON&quot;)
      --temp-dir string                      Directory rclone will use for temporary files (default &quot;/tmp&quot;)
      --timeout duration                     IO idle timeout (default 5m0s)
      --tpslimit float                       Limit HTTP transactions per second to this
      --tpslimit-burst int                   Max burst of transactions for --tpslimit (default 1)
      --track-renames                        When synchronizing, track file renames and do a server-side move if possible
      --track-renames-strategy string        Strategies to use when synchronizing using track-renames hash|modtime|leaf (default &quot;hash&quot;)
      --transfers int                        Number of file transfers to run in parallel (default 4)
  -u, --update                               Skip files that are newer on the destination
      --use-cookies                          Enable session cookiejar
      --use-json-log                         Use json log format
      --use-mmap                             Use mmap allocator (see docs)
      --use-server-modtime                   Use server modified time instead of object metadata
      --user-agent string                    Set the user-agent to a specified string (default &quot;rclone/v1.60.1&quot;)
  -v, --verbose count                        Print lots more stuff (repeat for more)</code></pre>
<h2 id="backend-flags">Backend Flags</h2>
<p>These flags are available for every command. They control the
backends and may be set in the config file.</p>
<pre><code>      --acd-auth-url string                          Auth server URL
      --acd-client-id string                         OAuth Client Id
      --acd-client-secret string                     OAuth Client Secret
      --acd-encoding MultiEncoder                    The encoding for the backend (default Slash,InvalidUtf8,Dot)
      --acd-templink-threshold SizeSuffix            Files &gt;= this size will be downloaded via their tempLink (default 9Gi)
      --acd-token string                             OAuth Access Token as a JSON blob
      --acd-token-url string                         Token server url
      --acd-upload-wait-per-gb Duration              Additional time per GiB to wait after a failed complete upload to see if it appears (default 3m0s)
      --alias-remote string                          Remote or path to alias
      --azureblob-access-tier string                 Access tier of blob: hot, cool or archive
      --azureblob-account string                     Storage Account Name
      --azureblob-archive-tier-delete                Delete archive tier blobs before overwriting
      --azureblob-chunk-size SizeSuffix              Upload chunk size (default 4Mi)
      --azureblob-disable-checksum                   Don&#39;t store MD5 checksum with object metadata
      --azureblob-encoding MultiEncoder              The encoding for the backend (default Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8)
      --azureblob-endpoint string                    Endpoint for the service
      --azureblob-key string                         Storage Account Key
      --azureblob-list-chunk int                     Size of blob list (default 5000)
      --azureblob-memory-pool-flush-time Duration    How often internal memory buffer pools will be flushed (default 1m0s)
      --azureblob-memory-pool-use-mmap               Whether to use mmap buffers in internal memory pool
      --azureblob-msi-client-id string               Object ID of the user-assigned MSI to use, if any
      --azureblob-msi-mi-res-id string               Azure resource ID of the user-assigned MSI to use, if any
      --azureblob-msi-object-id string               Object ID of the user-assigned MSI to use, if any
      --azureblob-no-head-object                     If set, do not do HEAD before GET when getting objects
      --azureblob-public-access string               Public access level of a container: blob or container
      --azureblob-sas-url string                     SAS URL for container level access only
      --azureblob-service-principal-file string      Path to file containing credentials for use with a service principal
      --azureblob-upload-concurrency int             Concurrency for multipart uploads (default 16)
      --azureblob-upload-cutoff string               Cutoff for switching to chunked upload (&lt;= 256 MiB) (deprecated)
      --azureblob-use-emulator                       Uses local storage emulator if provided as &#39;true&#39;
      --azureblob-use-msi                            Use a managed service identity to authenticate (only works in Azure)
      --b2-account string                            Account ID or Application Key ID
      --b2-chunk-size SizeSuffix                     Upload chunk size (default 96Mi)
      --b2-copy-cutoff SizeSuffix                    Cutoff for switching to multipart copy (default 4Gi)
      --b2-disable-checksum                          Disable checksums for large (&gt; upload cutoff) files
      --b2-download-auth-duration Duration           Time before the authorization token will expire in s or suffix ms|s|m|h|d (default 1w)
      --b2-download-url string                       Custom endpoint for downloads
      --b2-encoding MultiEncoder                     The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
      --b2-endpoint string                           Endpoint for the service
      --b2-hard-delete                               Permanently delete files on remote removal, otherwise hide files
      --b2-key string                                Application Key
      --b2-memory-pool-flush-time Duration           How often internal memory buffer pools will be flushed (default 1m0s)
      --b2-memory-pool-use-mmap                      Whether to use mmap buffers in internal memory pool
      --b2-test-mode string                          A flag string for X-Bz-Test-Mode header for debugging
      --b2-upload-cutoff SizeSuffix                  Cutoff for switching to chunked upload (default 200Mi)
      --b2-version-at Time                           Show file versions as they were at the specified time (default off)
      --b2-versions                                  Include old versions in directory listings
      --box-access-token string                      Box App Primary Access Token
      --box-auth-url string                          Auth server URL
      --box-box-config-file string                   Box App config.json location
      --box-box-sub-type string                       (default &quot;user&quot;)
      --box-client-id string                         OAuth Client Id
      --box-client-secret string                     OAuth Client Secret
      --box-commit-retries int                       Max number of times to try committing a multipart file (default 100)
      --box-encoding MultiEncoder                    The encoding for the backend (default Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot)
      --box-list-chunk int                           Size of listing chunk 1-1000 (default 1000)
      --box-owned-by string                          Only show items owned by the login (email address) passed in
      --box-root-folder-id string                    Fill in for rclone to use a non root folder as its starting point
      --box-token string                             OAuth Access Token as a JSON blob
      --box-token-url string                         Token server url
      --box-upload-cutoff SizeSuffix                 Cutoff for switching to multipart upload (&gt;= 50 MiB) (default 50Mi)
      --cache-chunk-clean-interval Duration          How often should the cache perform cleanups of the chunk storage (default 1m0s)
      --cache-chunk-no-memory                        Disable the in-memory cache for storing chunks during streaming
      --cache-chunk-path string                      Directory to cache chunk files (default &quot;$HOME/.cache/rclone/cache-backend&quot;)
      --cache-chunk-size SizeSuffix                  The size of a chunk (partial file data) (default 5Mi)
      --cache-chunk-total-size SizeSuffix            The total size that the chunks can take up on the local disk (default 10Gi)
      --cache-db-path string                         Directory to store file structure metadata DB (default &quot;$HOME/.cache/rclone/cache-backend&quot;)
      --cache-db-purge                               Clear all the cached data for this remote on start
      --cache-db-wait-time Duration                  How long to wait for the DB to be available - 0 is unlimited (default 1s)
      --cache-info-age Duration                      How long to cache file structure information (directory listings, file size, times, etc.) (default 6h0m0s)
      --cache-plex-insecure string                   Skip all certificate verification when connecting to the Plex server
      --cache-plex-password string                   The password of the Plex user (obscured)
      --cache-plex-url string                        The URL of the Plex server
      --cache-plex-username string                   The username of the Plex user
      --cache-read-retries int                       How many times to retry a read from a cache storage (default 10)
      --cache-remote string                          Remote to cache
      --cache-rps int                                Limits the number of requests per second to the source FS (-1 to disable) (default -1)
      --cache-tmp-upload-path string                 Directory to keep temporary files until they are uploaded
      --cache-tmp-wait-time Duration                 How long should files be stored in local cache before being uploaded (default 15s)
      --cache-workers int                            How many workers should run in parallel to download chunks (default 4)
      --cache-writes                                 Cache file data on writes through the FS
      --chunker-chunk-size SizeSuffix                Files larger than chunk size will be split in chunks (default 2Gi)
      --chunker-fail-hard                            Choose how chunker should handle files with missing or invalid chunks
      --chunker-hash-type string                     Choose how chunker handles hash sums (default &quot;md5&quot;)
      --chunker-remote string                        Remote to chunk/unchunk
      --combine-upstreams SpaceSepList               Upstreams for combining
      --compress-level int                           GZIP compression level (-2 to 9) (default -1)
      --compress-mode string                         Compression mode (default &quot;gzip&quot;)
      --compress-ram-cache-limit SizeSuffix          Some remotes don&#39;t allow the upload of files with unknown size (default 20Mi)
      --compress-remote string                       Remote to compress
  -L, --copy-links                                   Follow symlinks and copy the pointed to item
      --crypt-directory-name-encryption              Option to either encrypt directory names or leave them intact (default true)
      --crypt-filename-encoding string               How to encode the encrypted filename to text string (default &quot;base32&quot;)
      --crypt-filename-encryption string             How to encrypt the filenames (default &quot;standard&quot;)
      --crypt-no-data-encryption                     Option to either encrypt file data or leave it unencrypted
      --crypt-password string                        Password or pass phrase for encryption (obscured)
      --crypt-password2 string                       Password or pass phrase for salt (obscured)
      --crypt-remote string                          Remote to encrypt/decrypt
      --crypt-server-side-across-configs             Allow server-side operations (e.g. copy) to work across different crypt configs
      --crypt-show-mapping                           For all files listed show how the names encrypt
      --drive-acknowledge-abuse                      Set to allow files which return cannotDownloadAbusiveFile to be downloaded
      --drive-allow-import-name-change               Allow the filetype to change when uploading Google docs
      --drive-auth-owner-only                        Only consider files owned by the authenticated user
      --drive-auth-url string                        Auth server URL
      --drive-chunk-size SizeSuffix                  Upload chunk size (default 8Mi)
      --drive-client-id string                       Google Application Client Id
      --drive-client-secret string                   OAuth Client Secret
      --drive-copy-shortcut-content                  Server side copy contents of shortcuts instead of the shortcut
      --drive-disable-http2                          Disable drive using http2 (default true)
      --drive-encoding MultiEncoder                  The encoding for the backend (default InvalidUtf8)
      --drive-export-formats string                  Comma separated list of preferred formats for downloading Google docs (default &quot;docx,xlsx,pptx,svg&quot;)
      --drive-formats string                         Deprecated: See export_formats
      --drive-impersonate string                     Impersonate this user when using a service account
      --drive-import-formats string                  Comma separated list of preferred formats for uploading Google docs
      --drive-keep-revision-forever                  Keep new head revision of each file forever
      --drive-list-chunk int                         Size of listing chunk 100-1000, 0 to disable (default 1000)
      --drive-pacer-burst int                        Number of API calls to allow without sleeping (default 100)
      --drive-pacer-min-sleep Duration               Minimum time to sleep between API calls (default 100ms)
      --drive-resource-key string                    Resource key for accessing a link-shared file
      --drive-root-folder-id string                  ID of the root folder
      --drive-scope string                           Scope that rclone should use when requesting access from drive
      --drive-server-side-across-configs             Allow server-side operations (e.g. copy) to work across different drive configs
      --drive-service-account-credentials string     Service Account Credentials JSON blob
      --drive-service-account-file string            Service Account Credentials JSON file path
      --drive-shared-with-me                         Only show files that are shared with me
      --drive-size-as-quota                          Show sizes as storage quota usage, not actual size
      --drive-skip-checksum-gphotos                  Skip MD5 checksum on Google photos and videos only
      --drive-skip-dangling-shortcuts                If set skip dangling shortcut files
      --drive-skip-gdocs                             Skip google documents in all listings
      --drive-skip-shortcuts                         If set skip shortcut files
      --drive-starred-only                           Only show files that are starred
      --drive-stop-on-download-limit                 Make download limit errors be fatal
      --drive-stop-on-upload-limit                   Make upload limit errors be fatal
      --drive-team-drive string                      ID of the Shared Drive (Team Drive)
      --drive-token string                           OAuth Access Token as a JSON blob
      --drive-token-url string                       Token server url
      --drive-trashed-only                           Only show files that are in the trash
      --drive-upload-cutoff SizeSuffix               Cutoff for switching to chunked upload (default 8Mi)
      --drive-use-created-date                       Use file created date instead of modified date
      --drive-use-shared-date                        Use date file was shared instead of modified date
      --drive-use-trash                              Send files to the trash instead of deleting permanently (default true)
      --drive-v2-download-min-size SizeSuffix        If Object&#39;s are greater, use drive v2 API to download (default off)
      --dropbox-auth-url string                      Auth server URL
      --dropbox-batch-commit-timeout Duration        Max time to wait for a batch to finish committing (default 10m0s)
      --dropbox-batch-mode string                    Upload file batching sync|async|off (default &quot;sync&quot;)
      --dropbox-batch-size int                       Max number of files in upload batch
      --dropbox-batch-timeout Duration               Max time to allow an idle upload batch before uploading (default 0s)
      --dropbox-chunk-size SizeSuffix                Upload chunk size (&lt; 150Mi) (default 48Mi)
      --dropbox-client-id string                     OAuth Client Id
      --dropbox-client-secret string                 OAuth Client Secret
      --dropbox-encoding MultiEncoder                The encoding for the backend (default Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot)
      --dropbox-impersonate string                   Impersonate this user when using a business account
      --dropbox-shared-files                         Instructs rclone to work on individual shared files
      --dropbox-shared-folders                       Instructs rclone to work on shared folders
      --dropbox-token string                         OAuth Access Token as a JSON blob
      --dropbox-token-url string                     Token server url
      --fichier-api-key string                       Your API Key, get it from https://1fichier.com/console/params.pl
      --fichier-encoding MultiEncoder                The encoding for the backend (default Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot)
      --fichier-file-password string                 If you want to download a shared file that is password protected, add this parameter (obscured)
      --fichier-folder-password string               If you want to list the files in a shared folder that is password protected, add this parameter (obscured)
      --fichier-shared-folder string                 If you want to download a shared folder, add this parameter
      --filefabric-encoding MultiEncoder             The encoding for the backend (default Slash,Del,Ctl,InvalidUtf8,Dot)
      --filefabric-permanent-token string            Permanent Authentication Token
      --filefabric-root-folder-id string             ID of the root folder
      --filefabric-token string                      Session Token
      --filefabric-token-expiry string               Token expiry time
      --filefabric-url string                        URL of the Enterprise File Fabric to connect to
      --filefabric-version string                    Version read from the file fabric
      --ftp-ask-password                             Allow asking for FTP password when needed
      --ftp-close-timeout Duration                   Maximum time to wait for a response to close (default 1m0s)
      --ftp-concurrency int                          Maximum number of FTP simultaneous connections, 0 for unlimited
      --ftp-disable-epsv                             Disable using EPSV even if server advertises support
      --ftp-disable-mlsd                             Disable using MLSD even if server advertises support
      --ftp-disable-tls13                            Disable TLS 1.3 (workaround for FTP servers with buggy TLS)
      --ftp-disable-utf8                             Disable using UTF-8 even if server advertises support
      --ftp-encoding MultiEncoder                    The encoding for the backend (default Slash,Del,Ctl,RightSpace,Dot)
      --ftp-explicit-tls                             Use Explicit FTPS (FTP over TLS)
      --ftp-force-list-hidden                        Use LIST -a to force listing of hidden files and folders. This will disable the use of MLSD
      --ftp-host string                              FTP host to connect to
      --ftp-idle-timeout Duration                    Max time before closing idle connections (default 1m0s)
      --ftp-no-check-certificate                     Do not verify the TLS certificate of the server
      --ftp-pass string                              FTP password (obscured)
      --ftp-port int                                 FTP port number (default 21)
      --ftp-shut-timeout Duration                    Maximum time to wait for data connection closing status (default 1m0s)
      --ftp-tls                                      Use Implicit FTPS (FTP over TLS)
      --ftp-tls-cache-size int                       Size of TLS session cache for all control and data connections (default 32)
      --ftp-user string                              FTP username (default &quot;$USER&quot;)
      --ftp-writing-mdtm                             Use MDTM to set modification time (VsFtpd quirk)
      --gcs-anonymous                                Access public buckets and objects without credentials
      --gcs-auth-url string                          Auth server URL
      --gcs-bucket-acl string                        Access Control List for new buckets
      --gcs-bucket-policy-only                       Access checks should use bucket-level IAM policies
      --gcs-client-id string                         OAuth Client Id
      --gcs-client-secret string                     OAuth Client Secret
      --gcs-decompress                               If set this will decompress gzip encoded objects
      --gcs-encoding MultiEncoder                    The encoding for the backend (default Slash,CrLf,InvalidUtf8,Dot)
      --gcs-endpoint string                          Endpoint for the service
      --gcs-location string                          Location for the newly created buckets
      --gcs-no-check-bucket                          If set, don&#39;t attempt to check the bucket exists or create it
      --gcs-object-acl string                        Access Control List for new objects
      --gcs-project-number string                    Project number
      --gcs-service-account-file string              Service Account Credentials JSON file path
      --gcs-storage-class string                     The storage class to use when storing objects in Google Cloud Storage
      --gcs-token string                             OAuth Access Token as a JSON blob
      --gcs-token-url string                         Token server url
      --gphotos-auth-url string                      Auth server URL
      --gphotos-client-id string                     OAuth Client Id
      --gphotos-client-secret string                 OAuth Client Secret
      --gphotos-encoding MultiEncoder                The encoding for the backend (default Slash,CrLf,InvalidUtf8,Dot)
      --gphotos-include-archived                     Also view and download archived media
      --gphotos-read-only                            Set to make the Google Photos backend read only
      --gphotos-read-size                            Set to read the size of media items
      --gphotos-start-year int                       Year limits the photos to be downloaded to those which are uploaded after the given year (default 2000)
      --gphotos-token string                         OAuth Access Token as a JSON blob
      --gphotos-token-url string                     Token server url
      --hasher-auto-size SizeSuffix                  Auto-update checksum for files smaller than this size (disabled by default)
      --hasher-hashes CommaSepList                   Comma separated list of supported checksum types (default md5,sha1)
      --hasher-max-age Duration                      Maximum time to keep checksums in cache (0 = no cache, off = cache forever) (default off)
      --hasher-remote string                         Remote to cache checksums for (e.g. myRemote:path)
      --hdfs-data-transfer-protection string         Kerberos data transfer protection: authentication|integrity|privacy
      --hdfs-encoding MultiEncoder                   The encoding for the backend (default Slash,Colon,Del,Ctl,InvalidUtf8,Dot)
      --hdfs-namenode string                         Hadoop name node and port
      --hdfs-service-principal-name string           Kerberos service principal name for the namenode
      --hdfs-username string                         Hadoop user name
      --hidrive-auth-url string                      Auth server URL
      --hidrive-chunk-size SizeSuffix                Chunksize for chunked uploads (default 48Mi)
      --hidrive-client-id string                     OAuth Client Id
      --hidrive-client-secret string                 OAuth Client Secret
      --hidrive-disable-fetching-member-count        Do not fetch number of objects in directories unless it is absolutely necessary
      --hidrive-encoding MultiEncoder                The encoding for the backend (default Slash,Dot)
      --hidrive-endpoint string                      Endpoint for the service (default &quot;https://api.hidrive.strato.com/2.1&quot;)
      --hidrive-root-prefix string                   The root/parent folder for all paths (default &quot;/&quot;)
      --hidrive-scope-access string                  Access permissions that rclone should use when requesting access from HiDrive (default &quot;rw&quot;)
      --hidrive-scope-role string                    User-level that rclone should use when requesting access from HiDrive (default &quot;user&quot;)
      --hidrive-token string                         OAuth Access Token as a JSON blob
      --hidrive-token-url string                     Token server url
      --hidrive-upload-concurrency int               Concurrency for chunked uploads (default 4)
      --hidrive-upload-cutoff SizeSuffix             Cutoff/Threshold for chunked uploads (default 96Mi)
      --http-headers CommaSepList                    Set HTTP headers for all transactions
      --http-no-head                                 Don&#39;t use HEAD requests
      --http-no-slash                                Set this if the site doesn&#39;t end directories with /
      --http-url string                              URL of HTTP host to connect to
      --internetarchive-access-key-id string         IAS3 Access Key
      --internetarchive-disable-checksum             Don&#39;t ask the server to test against MD5 checksum calculated by rclone (default true)
      --internetarchive-encoding MultiEncoder        The encoding for the backend (default Slash,LtGt,CrLf,Del,Ctl,InvalidUtf8,Dot)
      --internetarchive-endpoint string              IAS3 Endpoint (default &quot;https://s3.us.archive.org&quot;)
      --internetarchive-front-endpoint string        Host of InternetArchive Frontend (default &quot;https://archive.org&quot;)
      --internetarchive-secret-access-key string     IAS3 Secret Key (password)
      --internetarchive-wait-archive Duration        Timeout for waiting the server&#39;s processing tasks (specifically archive and book_op) to finish (default 0s)
      --jottacloud-encoding MultiEncoder             The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot)
      --jottacloud-hard-delete                       Delete files permanently rather than putting them into the trash
      --jottacloud-md5-memory-limit SizeSuffix       Files bigger than this will be cached on disk to calculate the MD5 if required (default 10Mi)
      --jottacloud-no-versions                       Avoid server side versioning by deleting files and recreating files instead of overwriting them
      --jottacloud-trashed-only                      Only show files that are in the trash
      --jottacloud-upload-resume-limit SizeSuffix    Files bigger than this can be resumed if the upload fail&#39;s (default 10Mi)
      --koofr-encoding MultiEncoder                  The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
      --koofr-endpoint string                        The Koofr API endpoint to use
      --koofr-mountid string                         Mount ID of the mount to use
      --koofr-password string                        Your password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password) (obscured)
      --koofr-provider string                        Choose your storage provider
      --koofr-setmtime                               Does the backend support setting modification time (default true)
      --koofr-user string                            Your user name
  -l, --links                                        Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension
      --local-case-insensitive                       Force the filesystem to report itself as case insensitive
      --local-case-sensitive                         Force the filesystem to report itself as case sensitive
      --local-encoding MultiEncoder                  The encoding for the backend (default Slash,Dot)
      --local-no-check-updated                       Don&#39;t check to see if the files change during upload
      --local-no-preallocate                         Disable preallocation of disk space for transferred files
      --local-no-set-modtime                         Disable setting modtime
      --local-no-sparse                              Disable sparse files for multi-thread downloads
      --local-nounc                                  Disable UNC (long path names) conversion on Windows
      --local-unicode-normalization                  Apply unicode NFC normalization to paths and filenames
      --local-zero-size-links                        Assume the Stat size of links is zero (and read them instead) (deprecated)
      --mailru-check-hash                            What should copy do if file checksum is mismatched or invalid (default true)
      --mailru-encoding MultiEncoder                 The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot)
      --mailru-pass string                           Password (obscured)
      --mailru-speedup-enable                        Skip full upload if there is another file with same data hash (default true)
      --mailru-speedup-file-patterns string          Comma separated list of file name patterns eligible for speedup (put by hash) (default &quot;*.mkv,*.avi,*.mp4,*.mp3,*.zip,*.gz,*.rar,*.pdf&quot;)
      --mailru-speedup-max-disk SizeSuffix           This option allows you to disable speedup (put by hash) for large files (default 3Gi)
      --mailru-speedup-max-memory SizeSuffix         Files larger than the size given below will always be hashed on disk (default 32Mi)
      --mailru-user string                           User name (usually email)
      --mega-debug                                   Output more debug from Mega
      --mega-encoding MultiEncoder                   The encoding for the backend (default Slash,InvalidUtf8,Dot)
      --mega-hard-delete                             Delete files permanently rather than putting them into the trash
      --mega-pass string                             Password (obscured)
      --mega-user string                             User name
      --netstorage-account string                    Set the NetStorage account name
      --netstorage-host string                       Domain+path of NetStorage host to connect to
      --netstorage-protocol string                   Select between HTTP or HTTPS protocol (default &quot;https&quot;)
      --netstorage-secret string                     Set the NetStorage account secret/G2O key for authentication (obscured)
  -x, --one-file-system                              Don&#39;t cross filesystem boundaries (unix/macOS only)
      --onedrive-access-scopes SpaceSepList          Set scopes to be requested by rclone (default Files.Read Files.ReadWrite Files.Read.All Files.ReadWrite.All Sites.Read.All offline_access)
      --onedrive-auth-url string                     Auth server URL
      --onedrive-chunk-size SizeSuffix               Chunk size to upload files with - must be multiple of 320k (327,680 bytes) (default 10Mi)
      --onedrive-client-id string                    OAuth Client Id
      --onedrive-client-secret string                OAuth Client Secret
      --onedrive-drive-id string                     The ID of the drive to use
      --onedrive-drive-type string                   The type of the drive (personal | business | documentLibrary)
      --onedrive-encoding MultiEncoder               The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot)
      --onedrive-expose-onenote-files                Set to make OneNote files show up in directory listings
      --onedrive-link-password string                Set the password for links created by the link command
      --onedrive-link-scope string                   Set the scope of the links created by the link command (default &quot;anonymous&quot;)
      --onedrive-link-type string                    Set the type of the links created by the link command (default &quot;view&quot;)
      --onedrive-list-chunk int                      Size of listing chunk (default 1000)
      --onedrive-no-versions                         Remove all versions on modifying operations
      --onedrive-region string                       Choose national cloud region for OneDrive (default &quot;global&quot;)
      --onedrive-root-folder-id string               ID of the root folder
      --onedrive-server-side-across-configs          Allow server-side operations (e.g. copy) to work across different onedrive configs
      --onedrive-token string                        OAuth Access Token as a JSON blob
      --onedrive-token-url string                    Token server url
      --oos-chunk-size SizeSuffix                    Chunk size to use for uploading (default 5Mi)
      --oos-compartment string                       Object storage compartment OCID
      --oos-config-file string                       Path to OCI config file (default &quot;~/.oci/config&quot;)
      --oos-config-profile string                    Profile name inside the oci config file (default &quot;Default&quot;)
      --oos-copy-cutoff SizeSuffix                   Cutoff for switching to multipart copy (default 4.656Gi)
      --oos-copy-timeout Duration                    Timeout for copy (default 1m0s)
      --oos-disable-checksum                         Don&#39;t store MD5 checksum with object metadata
      --oos-encoding MultiEncoder                    The encoding for the backend (default Slash,InvalidUtf8,Dot)
      --oos-endpoint string                          Endpoint for Object storage API
      --oos-leave-parts-on-error                     If true avoid calling abort upload on a failure, leaving all successfully uploaded parts on S3 for manual recovery
      --oos-namespace string                         Object storage namespace
      --oos-no-check-bucket                          If set, don&#39;t attempt to check the bucket exists or create it
      --oos-provider string                          Choose your Auth Provider (default &quot;env_auth&quot;)
      --oos-region string                            Object storage Region
      --oos-upload-concurrency int                   Concurrency for multipart uploads (default 10)
      --oos-upload-cutoff SizeSuffix                 Cutoff for switching to chunked upload (default 200Mi)
      --opendrive-chunk-size SizeSuffix              Files will be uploaded in chunks this size (default 10Mi)
      --opendrive-encoding MultiEncoder              The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,LeftSpace,LeftCrLfHtVt,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot)
      --opendrive-password string                    Password (obscured)
      --opendrive-username string                    Username
      --pcloud-auth-url string                       Auth server URL
      --pcloud-client-id string                      OAuth Client Id
      --pcloud-client-secret string                  OAuth Client Secret
      --pcloud-encoding MultiEncoder                 The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
      --pcloud-hostname string                       Hostname to connect to (default &quot;api.pcloud.com&quot;)
      --pcloud-password string                       Your pcloud password (obscured)
      --pcloud-root-folder-id string                 Fill in for rclone to use a non root folder as its starting point (default &quot;d0&quot;)
      --pcloud-token string                          OAuth Access Token as a JSON blob
      --pcloud-token-url string                      Token server url
      --pcloud-username string                       Your pcloud username
      --premiumizeme-encoding MultiEncoder           The encoding for the backend (default Slash,DoubleQuote,BackSlash,Del,Ctl,InvalidUtf8,Dot)
      --putio-encoding MultiEncoder                  The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
      --qingstor-access-key-id string                QingStor Access Key ID
      --qingstor-chunk-size SizeSuffix               Chunk size to use for uploading (default 4Mi)
      --qingstor-connection-retries int              Number of connection retries (default 3)
      --qingstor-encoding MultiEncoder               The encoding for the backend (default Slash,Ctl,InvalidUtf8)
      --qingstor-endpoint string                     Enter an endpoint URL to connection QingStor API
      --qingstor-env-auth                            Get QingStor credentials from runtime
      --qingstor-secret-access-key string            QingStor Secret Access Key (password)
      --qingstor-upload-concurrency int              Concurrency for multipart uploads (default 1)
      --qingstor-upload-cutoff SizeSuffix            Cutoff for switching to chunked upload (default 200Mi)
      --qingstor-zone string                         Zone to connect to
      --s3-access-key-id string                      AWS Access Key ID
      --s3-acl string                                Canned ACL used when creating buckets and storing or copying objects
      --s3-bucket-acl string                         Canned ACL used when creating buckets
      --s3-chunk-size SizeSuffix                     Chunk size to use for uploading (default 5Mi)
      --s3-copy-cutoff SizeSuffix                    Cutoff for switching to multipart copy (default 4.656Gi)
      --s3-decompress                                If set this will decompress gzip encoded objects
      --s3-disable-checksum                          Don&#39;t store MD5 checksum with object metadata
      --s3-disable-http2                             Disable usage of http2 for S3 backends
      --s3-download-url string                       Custom endpoint for downloads
      --s3-encoding MultiEncoder                     The encoding for the backend (default Slash,InvalidUtf8,Dot)
      --s3-endpoint string                           Endpoint for S3 API
      --s3-env-auth                                  Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars)
      --s3-force-path-style                          If true use path style access if false use virtual hosted style (default true)
      --s3-leave-parts-on-error                      If true avoid calling abort upload on a failure, leaving all successfully uploaded parts on S3 for manual recovery
      --s3-list-chunk int                            Size of listing chunk (response list for each ListObject S3 request) (default 1000)
      --s3-list-url-encode Tristate                  Whether to url encode listings: true/false/unset (default unset)
      --s3-list-version int                          Version of ListObjects to use: 1,2 or 0 for auto
      --s3-location-constraint string                Location constraint - must be set to match the Region
      --s3-max-upload-parts int                      Maximum number of parts in a multipart upload (default 10000)
      --s3-memory-pool-flush-time Duration           How often internal memory buffer pools will be flushed (default 1m0s)
      --s3-memory-pool-use-mmap                      Whether to use mmap buffers in internal memory pool
      --s3-might-gzip Tristate                       Set this if the backend might gzip objects (default unset)
      --s3-no-check-bucket                           If set, don&#39;t attempt to check the bucket exists or create it
      --s3-no-head                                   If set, don&#39;t HEAD uploaded objects to check integrity
      --s3-no-head-object                            If set, do not do HEAD before GET when getting objects
      --s3-no-system-metadata                        Suppress setting and reading of system metadata
      --s3-profile string                            Profile to use in the shared credentials file
      --s3-provider string                           Choose your S3 provider
      --s3-region string                             Region to connect to
      --s3-requester-pays                            Enables requester pays option when interacting with S3 bucket
      --s3-secret-access-key string                  AWS Secret Access Key (password)
      --s3-server-side-encryption string             The server-side encryption algorithm used when storing this object in S3
      --s3-session-token string                      An AWS session token
      --s3-shared-credentials-file string            Path to the shared credentials file
      --s3-sse-customer-algorithm string             If using SSE-C, the server-side encryption algorithm used when storing this object in S3
      --s3-sse-customer-key string                   To use SSE-C you may provide the secret encryption key used to encrypt/decrypt your data
      --s3-sse-customer-key-base64 string            If using SSE-C you must provide the secret encryption key encoded in base64 format to encrypt/decrypt your data
      --s3-sse-customer-key-md5 string               If using SSE-C you may provide the secret encryption key MD5 checksum (optional)
      --s3-sse-kms-key-id string                     If using KMS ID you must provide the ARN of Key
      --s3-storage-class string                      The storage class to use when storing new objects in S3
      --s3-upload-concurrency int                    Concurrency for multipart uploads (default 4)
      --s3-upload-cutoff SizeSuffix                  Cutoff for switching to chunked upload (default 200Mi)
      --s3-use-accelerate-endpoint                   If true use the AWS S3 accelerated endpoint
      --s3-use-multipart-etag Tristate               Whether to use ETag in multipart uploads for verification (default unset)
      --s3-use-presigned-request                     Whether to use a presigned request or PutObject for single part uploads
      --s3-v2-auth                                   If true use v2 authentication
      --s3-version-at Time                           Show file versions as they were at the specified time (default off)
      --s3-versions                                  Include old versions in directory listings
      --seafile-2fa                                  Two-factor authentication (&#39;true&#39; if the account has 2FA enabled)
      --seafile-create-library                       Should rclone create a library if it doesn&#39;t exist
      --seafile-encoding MultiEncoder                The encoding for the backend (default Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8)
      --seafile-library string                       Name of the library
      --seafile-library-key string                   Library password (for encrypted libraries only) (obscured)
      --seafile-pass string                          Password (obscured)
      --seafile-url string                           URL of seafile host to connect to
      --seafile-user string                          User name (usually email address)
      --sftp-ask-password                            Allow asking for SFTP password when needed
      --sftp-chunk-size SizeSuffix                   Upload and download chunk size (default 32Ki)
      --sftp-concurrency int                         The maximum number of outstanding requests for one file (default 64)
      --sftp-disable-concurrent-reads                If set don&#39;t use concurrent reads
      --sftp-disable-concurrent-writes               If set don&#39;t use concurrent writes
      --sftp-disable-hashcheck                       Disable the execution of SSH commands to determine if remote file hashing is available
      --sftp-host string                             SSH host to connect to
      --sftp-idle-timeout Duration                   Max time before closing idle connections (default 1m0s)
      --sftp-key-file string                         Path to PEM-encoded private key file
      --sftp-key-file-pass string                    The passphrase to decrypt the PEM-encoded private key file (obscured)
      --sftp-key-pem string                          Raw PEM-encoded private key
      --sftp-key-use-agent                           When set forces the usage of the ssh-agent
      --sftp-known-hosts-file string                 Optional path to known_hosts file
      --sftp-md5sum-command string                   The command used to read md5 hashes
      --sftp-pass string                             SSH password, leave blank to use ssh-agent (obscured)
      --sftp-path-override string                    Override path used by SSH shell commands
      --sftp-port int                                SSH port number (default 22)
      --sftp-pubkey-file string                      Optional path to public key file
      --sftp-server-command string                   Specifies the path or command to run a sftp server on the remote host
      --sftp-set-env SpaceSepList                    Environment variables to pass to sftp and commands
      --sftp-set-modtime                             Set the modified time on the remote if set (default true)
      --sftp-sha1sum-command string                  The command used to read sha1 hashes
      --sftp-shell-type string                       The type of SSH shell on remote server, if any
      --sftp-skip-links                              Set to skip any symlinks and any other non regular files
      --sftp-subsystem string                        Specifies the SSH2 subsystem on the remote host (default &quot;sftp&quot;)
      --sftp-use-fstat                               If set use fstat instead of stat
      --sftp-use-insecure-cipher                     Enable the use of insecure ciphers and key exchange methods
      --sftp-user string                             SSH username (default &quot;$USER&quot;)
      --sharefile-chunk-size SizeSuffix              Upload chunk size (default 64Mi)
      --sharefile-encoding MultiEncoder              The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot)
      --sharefile-endpoint string                    Endpoint for API calls
      --sharefile-root-folder-id string              ID of the root folder
      --sharefile-upload-cutoff SizeSuffix           Cutoff for switching to multipart upload (default 128Mi)
      --sia-api-password string                      Sia Daemon API Password (obscured)
      --sia-api-url string                           Sia daemon API URL, like http://sia.daemon.host:9980 (default &quot;http://127.0.0.1:9980&quot;)
      --sia-encoding MultiEncoder                    The encoding for the backend (default Slash,Question,Hash,Percent,Del,Ctl,InvalidUtf8,Dot)
      --sia-user-agent string                        Siad User Agent (default &quot;Sia-Agent&quot;)
      --skip-links                                   Don&#39;t warn about skipped symlinks
      --smb-case-insensitive                         Whether the server is configured to be case-insensitive (default true)
      --smb-domain string                            Domain name for NTLM authentication (default &quot;WORKGROUP&quot;)
      --smb-encoding MultiEncoder                    The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot)
      --smb-hide-special-share                       Hide special shares (e.g. print$) which users aren&#39;t supposed to access (default true)
      --smb-host string                              SMB server hostname to connect to
      --smb-idle-timeout Duration                    Max time before closing idle connections (default 1m0s)
      --smb-pass string                              SMB password (obscured)
      --smb-port int                                 SMB port number (default 445)
      --smb-user string                              SMB username (default &quot;$USER&quot;)
      --storj-access-grant string                    Access grant
      --storj-api-key string                         API key
      --storj-passphrase string                      Encryption passphrase
      --storj-provider string                        Choose an authentication method (default &quot;existing&quot;)
      --storj-satellite-address string               Satellite address (default &quot;us-central-1.storj.io&quot;)
      --sugarsync-access-key-id string               Sugarsync Access Key ID
      --sugarsync-app-id string                      Sugarsync App ID
      --sugarsync-authorization string               Sugarsync authorization
      --sugarsync-authorization-expiry string        Sugarsync authorization expiry
      --sugarsync-deleted-id string                  Sugarsync deleted folder id
      --sugarsync-encoding MultiEncoder              The encoding for the backend (default Slash,Ctl,InvalidUtf8,Dot)
      --sugarsync-hard-delete                        Permanently delete files if true
      --sugarsync-private-access-key string          Sugarsync Private Access Key
      --sugarsync-refresh-token string               Sugarsync refresh token
      --sugarsync-root-id string                     Sugarsync root id
      --sugarsync-user string                        Sugarsync user
      --swift-application-credential-id string       Application Credential ID (OS_APPLICATION_CREDENTIAL_ID)
      --swift-application-credential-name string     Application Credential Name (OS_APPLICATION_CREDENTIAL_NAME)
      --swift-application-credential-secret string   Application Credential Secret (OS_APPLICATION_CREDENTIAL_SECRET)
      --swift-auth string                            Authentication URL for server (OS_AUTH_URL)
      --swift-auth-token string                      Auth Token from alternate authentication - optional (OS_AUTH_TOKEN)
      --swift-auth-version int                       AuthVersion - optional - set to (1,2,3) if your auth URL has no version (ST_AUTH_VERSION)
      --swift-chunk-size SizeSuffix                  Above this size files will be chunked into a _segments container (default 5Gi)
      --swift-domain string                          User domain - optional (v3 auth) (OS_USER_DOMAIN_NAME)
      --swift-encoding MultiEncoder                  The encoding for the backend (default Slash,InvalidUtf8)
      --swift-endpoint-type string                   Endpoint type to choose from the service catalogue (OS_ENDPOINT_TYPE) (default &quot;public&quot;)
      --swift-env-auth                               Get swift credentials from environment variables in standard OpenStack form
      --swift-key string                             API key or password (OS_PASSWORD)
      --swift-leave-parts-on-error                   If true avoid calling abort upload on a failure
      --swift-no-chunk                               Don&#39;t chunk files during streaming upload
      --swift-no-large-objects                       Disable support for static and dynamic large objects
      --swift-region string                          Region name - optional (OS_REGION_NAME)
      --swift-storage-policy string                  The storage policy to use when creating a new container
      --swift-storage-url string                     Storage URL - optional (OS_STORAGE_URL)
      --swift-tenant string                          Tenant name - optional for v1 auth, this or tenant_id required otherwise (OS_TENANT_NAME or OS_PROJECT_NAME)
      --swift-tenant-domain string                   Tenant domain - optional (v3 auth) (OS_PROJECT_DOMAIN_NAME)
      --swift-tenant-id string                       Tenant ID - optional for v1 auth, this or tenant required otherwise (OS_TENANT_ID)
      --swift-user string                            User name to log in (OS_USERNAME)
      --swift-user-id string                         User ID to log in - optional - most swift systems use user and leave this blank (v3 auth) (OS_USER_ID)
      --union-action-policy string                   Policy to choose upstream on ACTION category (default &quot;epall&quot;)
      --union-cache-time int                         Cache time of usage and free space (in seconds) (default 120)
      --union-create-policy string                   Policy to choose upstream on CREATE category (default &quot;epmfs&quot;)
      --union-min-free-space SizeSuffix              Minimum viable free space for lfs/eplfs policies (default 1Gi)
      --union-search-policy string                   Policy to choose upstream on SEARCH category (default &quot;ff&quot;)
      --union-upstreams string                       List of space separated upstreams
      --uptobox-access-token string                  Your access token
      --uptobox-encoding MultiEncoder                The encoding for the backend (default Slash,LtGt,DoubleQuote,BackQuote,Del,Ctl,LeftSpace,InvalidUtf8,Dot)
      --webdav-bearer-token string                   Bearer token instead of user/pass (e.g. a Macaroon)
      --webdav-bearer-token-command string           Command to run to get a bearer token
      --webdav-encoding string                       The encoding for the backend
      --webdav-headers CommaSepList                  Set HTTP headers for all transactions
      --webdav-pass string                           Password (obscured)
      --webdav-url string                            URL of http host to connect to
      --webdav-user string                           User name
      --webdav-vendor string                         Name of the WebDAV site/service/software you are using
      --yandex-auth-url string                       Auth server URL
      --yandex-client-id string                      OAuth Client Id
      --yandex-client-secret string                  OAuth Client Secret
      --yandex-encoding MultiEncoder                 The encoding for the backend (default Slash,Del,Ctl,InvalidUtf8,Dot)
      --yandex-hard-delete                           Delete files permanently rather than putting them into the trash
      --yandex-token string                          OAuth Access Token as a JSON blob
      --yandex-token-url string                      Token server url
      --zoho-auth-url string                         Auth server URL
      --zoho-client-id string                        OAuth Client Id
      --zoho-client-secret string                    OAuth Client Secret
      --zoho-encoding MultiEncoder                   The encoding for the backend (default Del,Ctl,InvalidUtf8)
      --zoho-region string                           Zoho region to connect to
      --zoho-token string                            OAuth Access Token as a JSON blob
      --zoho-token-url string                        Token server url</code></pre>
<h1 id="docker-volume-plugin">Docker Volume Plugin</h1>
<h2 id="introduction">Introduction</h2>
<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>
<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>
<h2 id="getting-started">Getting started</h2>
<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>
<p>Start from <a
href="https://docs.docker.com/engine/install/">installing Docker</a> on
the host.</p>
<p>The <em>FUSE</em> driver is a prerequisite for rclone mounting and
should be installed on host:</p>
<pre><code>sudo apt-get -y install fuse</code></pre>
<p>Create two directories required by rclone docker plugin:</p>
<pre><code>sudo mkdir -p /var/lib/docker-plugins/rclone/config
sudo mkdir -p /var/lib/docker-plugins/rclone/cache</code></pre>
<p>Install the managed rclone docker plugin for your architecture (here
<code>amd64</code>):</p>
<pre><code>docker plugin install rclone/docker-volume-rclone:amd64 args=&quot;-v&quot; --alias rclone --grant-all-permissions
docker plugin list</code></pre>
<p>Create your <a href="https://rclone.org/sftp/#standard-options">SFTP
volume</a>:</p>
<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>
<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>
<p>Time to create a test container and mount the volume into it:</p>
<pre><code>docker run --rm -it -v firstvolume:/mnt --workdir /mnt ubuntu:latest bash</code></pre>
<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>
<pre><code>docker volume list
docker volume remove firstvolume</code></pre>
<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>
<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>
<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>
<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>
<pre><code>[gdrive]
type = drive
scope = drive
drive_id = 1234567...
root_folder_id = 0Abcd...
token = {&quot;access_token&quot;:...}</code></pre>
<p>Now create the file named <code>example.yml</code> with a swarm stack
description like this:</p>
<pre><code>version: &#39;3&#39;
services:
  heimdall:
    image: linuxserver/heimdall:latest
    ports: [8080:80]
    volumes: [configdata:/config]
volumes:
  configdata:
    driver: rclone
    driver_opts:
      remote: &#39;gdrive:heimdall&#39;
      allow_other: &#39;true&#39;
      vfs_cache_mode: full
      poll_interval: 0</code></pre>
<p>and run the stack:</p>
<pre><code>docker stack deploy example -c ./example.yml</code></pre>
<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>
<pre><code>docker service ls
docker service ps example_heimdall
docker volume ls</code></pre>
<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>
<h2 id="creating-volumes-via-cli">Creating Volumes via CLI</h2>
<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>
<pre><code>docker volume create vol1 -d rclone -o remote=storj: -o vfs-cache-mode=full
docker volume create vol2 -d rclone -o remote=:storj,access_grant=xxx:heimdall
docker volume create vol3 -d rclone -o type=storj -o path=heimdall -o storj-access-grant=xxx -o poll-interval=0</code></pre>
<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>
<p>Volumes can be inspected as follows:</p>
<pre><code>docker volume list
docker volume inspect vol1</code></pre>
<h2 id="volume-configuration">Volume Configuration</h2>
<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>
<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>
<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>
<pre><code>-o type=backend -o path=dir/subdir</code></pre>
<p>is equivalent to the combined syntax</p>
<pre><code>-o remote=:backend:dir/subdir</code></pre>
<p>but is arguably easier to parameterize in scripts. The
<code>path</code> part is optional.</p>
<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>
<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>
<h2 id="special-volume-options">Special Volume Options</h2>
<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>
<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>
<h2 id="connection-strings-1">Connection Strings</h2>
<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>
<pre><code>-o remote=:sftp:/home -o sftp-host=localhost</code></pre>
<p>with equivalent connection string:</p>
<pre><code>-o remote=:sftp,host=localhost:/home</code></pre>
<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>
<h2 id="using-with-swarm-or-compose">Using with Swarm or Compose</h2>
<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>
<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>
<pre><code>volumes:
  volume_name_1:
    driver: rclone
    driver_opts:
      remote: &#39;gdrive:&#39;
      allow_other: &#39;true&#39;
      vfs_cache_mode: full
      token: &#39;{&quot;type&quot;: &quot;borrower&quot;, &quot;expires&quot;: &quot;2021-12-31&quot;}&#39;
      poll_interval: 0</code></pre>
<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>
<h2 id="installing-as-managed-plugin">Installing as Managed Plugin</h2>
<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>
<p>Rclone volume plugin requires <strong>Docker Engine &gt;=
19.03.15</strong></p>
<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>
<p>You can <a
href="https://docs.docker.com/engine/reference/commandline/plugin_install/">install
managed plugin</a> with default settings as follows:</p>
<pre><code>docker plugin install rclone/docker-volume-rclone:amd64 --grant-all-permissions --alias rclone</code></pre>
<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>
<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>
<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>
<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>
<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>
<p>You can tweak a few plugin settings after installation when it’s
disabled (not in use), for instance:</p>
<pre><code>docker plugin disable rclone
docker plugin set rclone RCLONE_VERBOSE=2 config=/etc/rclone args=&quot;--vfs-cache-mode=writes --allow-other&quot;
docker plugin enable rclone
docker plugin inspect rclone</code></pre>
<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>
<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>
<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>
<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>
<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>
<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>
<p><code>HTTP_PROXY</code>, <code>HTTPS_PROXY</code>,
<code>NO_PROXY</code> customize the plugin proxy settings.</p>
<p>You can set custom plugin options right when you install it, <em>in
one go</em>:</p>
<pre><code>docker plugin remove rclone
docker plugin install rclone/docker-volume-rclone:amd64 \
       --alias rclone --grant-all-permissions \
       args=&quot;-v --allow-other&quot; config=/etc/rclone
docker plugin inspect rclone</code></pre>
<h2 id="healthchecks">Healthchecks</h2>
<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>
<pre><code>services:
  my_service:
    image: my_image
    healthcheck:
      test: ls /path/to/rclone/mount || exit 1
      interval: 1m
      timeout: 15s
      retries: 3
      start_period: 15s</code></pre>
<h2 id="running-plugin-under-systemd">Running Plugin under Systemd</h2>
<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>
<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>
<p>Install <em>FUSE</em>:</p>
<pre><code>sudo apt-get -y install fuse</code></pre>
<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>
<p>Put them to the <code>/etc/systemd/system/</code> directory:</p>
<pre><code>cp docker-volume-plugin.service /etc/systemd/system/
cp docker-volume-plugin.socket  /etc/systemd/system/</code></pre>
<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>
<pre><code>mkdir -p /var/lib/docker-volumes/rclone
mkdir -p /var/lib/docker-plugins/rclone/config
mkdir -p /var/lib/docker-plugins/rclone/cache</code></pre>
<p>Run the docker plugin service in the socket activated mode:</p>
<pre><code>systemctl daemon-reload
systemctl start docker-volume-rclone.service
systemctl enable docker-volume-rclone.socket
systemctl start docker-volume-rclone.socket
systemctl restart docker</code></pre>
<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>
<p>The two methods are equivalent from the user perspective, but I
personally prefer socket activation.</p>
<h2 id="troubleshooting">Troubleshooting</h2>
<p>You can <a
href="https://docs.docker.com/engine/extend/#debugging-plugins">see
managed plugin settings</a> with</p>
<pre><code>docker plugin list
docker plugin inspect rclone</code></pre>
<p>Note that docker (including latest 20.10.7) will not show actual
values of <code>args</code>, just the defaults.</p>
<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>
<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>
<pre><code>PLUGID=$(docker plugin list --no-trunc | awk &#39;/rclone/{print$1}&#39;)
sudo runc --root /run/docker/runtime-runc/plugins.moby exec $PLUGID rclone version</code></pre>
<p>You can even use <code>runc</code> to run shell inside the plugin
container:</p>
<pre><code>sudo runc --root /run/docker/runtime-runc/plugins.moby exec --tty $PLUGID bash</code></pre>
<p>Also you can use curl to check the plugin socket connectivity:</p>
<pre><code>docker plugin list --no-trunc
PLUGID=123abc...
sudo curl -H Content-Type:application/json -XPOST -d {} --unix-socket /run/docker/plugins/$PLUGID/rclone.sock http://localhost/Plugin.Activate</code></pre>
<p>though this is rarely needed.</p>
<h2 id="caveats">Caveats</h2>
<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>
<pre><code>docker volume remove my_vol
docker volume create my_vol -d rclone -o opt1=new_val1 ...</code></pre>
<p>and verify that settings did update:</p>
<pre><code>docker volume list
docker volume inspect my_vol</code></pre>
<p>If docker refuses to remove the volume, you should find containers or
swarm services that use it and stop them first.</p>
<h2 id="getting-started">Getting started</h2>
<ul>
<li><a href="https://rclone.org/install/">Install rclone</a> and setup
your remotes.</li>
<li>Bisync will create its working directory at
<code>~/.cache/rclone/bisync</code> on Linux or
<code>C:\Users\MyLogin\AppData\Local\rclone\bisync</code> on Windows.
Make sure that this location is writable.</li>
<li>Run bisync with the <code>--resync</code> flag, specifying the paths
to the local and remote sync directory roots.</li>
<li>For successive sync runs, leave off the <code>--resync</code>
flag.</li>
<li>Consider using a <a href="#filtering">filters file</a> for excluding
unnecessary files and directories from the sync.</li>
<li>Consider setting up the <a
href="#check-access-option">–check-access</a> feature for safety.</li>
<li>On Linux, 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>
</ul>
<p>Here is a typical run log (with timestamps removed for clarity):</p>
<pre><code>rclone bisync /testdir/path1/ /testdir/path2/ --verbose
INFO  : Synching Path1 &quot;/testdir/path1/&quot; with Path2 &quot;/testdir/path2/&quot;
INFO  : Path1 checking for diffs
INFO  : - Path1    File is new                         - file11.txt
INFO  : - Path1    File is newer                       - file2.txt
INFO  : - Path1    File is newer                       - file5.txt
INFO  : - Path1    File is newer                       - file7.txt
INFO  : - Path1    File was deleted                    - file4.txt
INFO  : - Path1    File was deleted                    - file6.txt
INFO  : - Path1    File was deleted                    - file8.txt
INFO  : Path1:    7 changes:    1 new,    3 newer,    0 older,    3 deleted
INFO  : Path2 checking for diffs
INFO  : - Path2    File is new                         - file10.txt
INFO  : - Path2    File is newer                       - file1.txt
INFO  : - Path2    File is newer                       - file5.txt
INFO  : - Path2    File is newer                       - file6.txt
INFO  : - Path2    File was deleted                    - file3.txt
INFO  : - Path2    File was deleted                    - file7.txt
INFO  : - Path2    File was deleted                    - file8.txt
INFO  : Path2:    7 changes:    1 new,    3 newer,    0 older,    3 deleted
INFO  : Applying changes
INFO  : - Path1    Queue copy to Path2                 - /testdir/path2/file11.txt
INFO  : - Path1    Queue copy to Path2                 - /testdir/path2/file2.txt
INFO  : - Path2    Queue delete                        - /testdir/path2/file4.txt
NOTICE: - WARNING  New or changed in both paths        - file5.txt
NOTICE: - Path1    Renaming Path1 copy                 - /testdir/path1/file5.txt..path1
NOTICE: - Path1    Queue copy to Path2                 - /testdir/path2/file5.txt..path1
NOTICE: - Path2    Renaming Path2 copy                 - /testdir/path2/file5.txt..path2
NOTICE: - Path2    Queue copy to Path1                 - /testdir/path1/file5.txt..path2
INFO  : - Path2    Queue copy to Path1                 - /testdir/path1/file6.txt
INFO  : - Path1    Queue copy to Path2                 - /testdir/path2/file7.txt
INFO  : - Path2    Queue copy to Path1                 - /testdir/path1/file1.txt
INFO  : - Path2    Queue copy to Path1                 - /testdir/path1/file10.txt
INFO  : - Path1    Queue delete                        - /testdir/path1/file3.txt
INFO  : - Path2    Do queued copies to                 - Path1
INFO  : - Path1    Do queued copies to                 - Path2
INFO  : -          Do queued deletes on                - Path1
INFO  : -          Do queued deletes on                - Path2
INFO  : Updating listings
INFO  : Validating listings for Path1 &quot;/testdir/path1/&quot; vs Path2 &quot;/testdir/path2/&quot;
INFO  : Bisync successful</code></pre>
<h2 id="command-line-syntax">Command line syntax</h2>
<pre><code>$ rclone bisync --help
Usage:
  rclone bisync remote1:path1 remote2:path2 [flags]

Positional arguments:
  Path1, Path2  Local path, or remote storage with &#39;:&#39; plus optional path.
                Type &#39;rclone listremotes&#39; for list of configured remotes.

Optional Flags:
      --check-access            Ensure expected `RCLONE_TEST` files are found on
                                both Path1 and Path2 filesystems, else abort.
      --check-filename FILENAME Filename for `--check-access` (default: `RCLONE_TEST`)
      --check-sync CHOICE       Controls comparison of final listings:
                                `true | false | only` (default: true)
                                If set to `only`, bisync will only compare listings
                                from the last run but skip actual sync.
      --filters-file PATH       Read filtering patterns from a file
      --max-delete PERCENT      Safety check on maximum percentage of deleted files allowed.
                                If exceeded, the bisync run will abort. (default: 50%)
      --force                   Bypass `--max-delete` safety check and run the sync.
                                Consider using with `--verbose`
      --remove-empty-dirs       Remove empty directories at the final cleanup step.
  -1, --resync                  Performs the resync run.
                                Warning: Path1 files may overwrite Path2 versions.
                                Consider using `--verbose` or `--dry-run` first.
      --localtime               Use local time in listings (default: UTC)
      --no-cleanup              Retain working files (useful for troubleshooting and testing).
      --workdir PATH            Use custom working directory (useful for testing).
                                (default: `~/.cache/rclone/bisync`)
  -n, --dry-run                 Go through the motions - No files are copied/deleted.
  -v, --verbose                 Increases logging verbosity.
                                May be specified more than once for more details.
  -h, --help                    help for bisync</code></pre>
<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>
<h3 id="paths">Paths</h3>
<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>
<p>Path1 and Path2 are treated equally, in that neither has priority for
file changes, and access efficiency does not change whether a remote is
on Path1 or Path2.</p>
<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>
<p>Any empty directories after the sync on both the Path1 and Path2
filesystems are not deleted by default. If the
<code>--remove-empty-dirs</code> flag is specified, then both paths will
have any empty directories purged as the last step in the process.</p>
<h2 id="command-line-flags">Command-line flags</h2>
<h4 id="resync">–resync</h4>
<p>This will effectively make both Path1 and Path2 filesystems contain a
matching superset of all files. Path2 files that do not exist in Path1
will be copied to Path1, and the process will then sync the Path1 tree
to Path2.</p>
<p>The base directories on the 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>
<p>When using <code>--resync</code> a newer version of a file on the
Path2 filesystem will be overwritten by the Path1 filesystem version.
Carefully evaluate deltas using <a
href="https://rclone.org/flags/#non-backend-flags">–dry-run</a>.</p>
<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>
<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>
<h4 id="check-access">–check-access</h4>
<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. Time stamps
and file contents are not important, just the names and locations. Place
one or more <code>RCLONE_TEST</code> files in the Path1 or Path2
filesystem and then do either a run without <code>--check-access</code>
or a <code>--resync</code> to set matching files on both filesystems. 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. Also see the
<code>--check-filename</code> flag.</p>
<h4 id="max-delete">–max-delete</h4>
<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>
<p>Also see the <a href="#all-files-changed">all files changed</a>
check.</p>
<h4 id="filters-file">–filters-file</h4>
<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>
<p>If you make changes to your filters file then bisync requires a run
with <code>--resync</code>. This is a safety feature, which avoids
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>
<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 runs 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
<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>
<h4 id="check-sync">–check-sync</h4>
<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>
<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>
<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>
<h2 id="operation">Operation</h2>
<h3 id="runtime-flow-details">Runtime flow details</h3>
<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>
<ul>
<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>
<li>Propagate changes on <code>path1</code> to <code>path2</code>, and
vice-versa.</li>
</ul>
<h3 id="safety-measures">Safety measures</h3>
<ul>
<li>Lock file prevents multiple simultaneous runs when taking a while.
This can be particularly useful if bisync is run by cron scheduler.</li>
<li>Handle change conflicts non-destructively by creating
<code>..path1</code> and <code>..path2</code> file versions.</li>
<li>File system access health check using <code>RCLONE_TEST</code> files
(see the <code>--check-access</code> flag).</li>
<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>
<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>
</ul>
<h3 id="normal-sync-checks">Normal sync checks</h3>
<table>
<colgroup>
<col style="width: 12%" />
<col style="width: 40%" />
<col style="width: 22%" />
<col style="width: 25%" />
</colgroup>
<thead>
<tr class="header">
<th>Type</th>
<th>Description</th>
<th>Result</th>
<th>Implementation</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>Path2 new</td>
<td>File is new on Path2, does not exist on Path1</td>
<td>Path2 version survives</td>
<td><code>rclone copy</code> Path2 to Path1</td>
</tr>
<tr class="even">
<td>Path2 newer</td>
<td>File is newer on Path2, unchanged on Path1</td>
<td>Path2 version survives</td>
<td><code>rclone copy</code> Path2 to Path1</td>
</tr>
<tr class="odd">
<td>Path2 deleted</td>
<td>File is deleted on Path2, unchanged on Path1</td>
<td>File is deleted</td>
<td><code>rclone delete</code> Path1</td>
</tr>
<tr class="even">
<td>Path1 new</td>
<td>File is new on Path1, does not exist on Path2</td>
<td>Path1 version survives</td>
<td><code>rclone copy</code> Path1 to Path2</td>
</tr>
<tr class="odd">
<td>Path1 newer</td>
<td>File is newer on Path1, unchanged on Path2</td>
<td>Path1 version survives</td>
<td><code>rclone copy</code> Path1 to Path2</td>
</tr>
<tr class="even">
<td>Path1 older</td>
<td>File is older on Path1, unchanged on Path2</td>
<td><em>Path1 version survives</em></td>
<td><code>rclone copy</code> Path1 to Path2</td>
</tr>
<tr class="odd">
<td>Path2 older</td>
<td>File is older on Path2, unchanged on Path1</td>
<td><em>Path2 version survives</em></td>
<td><code>rclone copy</code> Path2 to Path1</td>
</tr>
<tr class="even">
<td>Path1 deleted</td>
<td>File no longer exists on Path1</td>
<td>File is deleted</td>
<td><code>rclone delete</code> Path2</td>
</tr>
</tbody>
</table>
<h3 id="unusual-sync-checks">Unusual sync checks</h3>
<table>
<colgroup>
<col style="width: 24%" />
<col style="width: 30%" />
<col style="width: 27%" />
<col style="width: 17%" />
</colgroup>
<thead>
<tr class="header">
<th>Type</th>
<th>Description</th>
<th>Result</th>
<th>Implementation</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>Path1 new AND Path2 new</td>
<td>File is new on Path1 AND new on Path2</td>
<td>Files renamed to _Path1 and _Path2</td>
<td><code>rclone copy</code> _Path2 file to Path1,
<code>rclone copy</code> _Path1 file to Path2</td>
</tr>
<tr class="even">
<td>Path2 newer AND Path1 changed</td>
<td>File is newer on Path2 AND also changed (newer/older/size) on
Path1</td>
<td>Files renamed to _Path1 and _Path2</td>
<td><code>rclone copy</code> _Path2 file to Path1,
<code>rclone copy</code> _Path1 file to Path2</td>
</tr>
<tr class="odd">
<td>Path2 newer AND Path1 deleted</td>
<td>File is newer on Path2 AND also deleted on Path1</td>
<td>Path2 version survives</td>
<td><code>rclone copy</code> Path2 to Path1</td>
</tr>
<tr class="even">
<td>Path2 deleted AND Path1 changed</td>
<td>File is deleted on Path2 AND changed (newer/older/size) on
Path1</td>
<td>Path1 version survives</td>
<td><code>rclone copy</code> Path1 to Path2</td>
</tr>
<tr class="odd">
<td>Path1 deleted AND Path2 changed</td>
<td>File is deleted on Path1 AND changed (newer/older/size) on
Path2</td>
<td>Path2 version survives</td>
<td><code>rclone copy</code> Path2 to Path1</td>
</tr>
</tbody>
</table>
<h3 id="all-files-changed">All files changed check</h3>
<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>
<h3 id="modification-time">Modification time</h3>
<p>Bisync relies on file timestamps to identify changed files and will
<em>refuse</em> to operate if backend lacks the modification time
support.</p>
<p>If you or your application should change the content of a file
without changing the modification time then bisync will <em>not</em>
notice the change, and thus will not copy it to the other side.</p>
<p>Note that on some cloud storage systems it is not possible to have
file timestamps that match <em>precisely</em> between the local and
other filesystems.</p>
<p>Bisync’s approach to this problem is by tracking the changes on each
side <em>separately</em> over time with a local database of files in
that side then applying the resulting changes on the other side.</p>
<h3 id="error-handling">Error handling</h3>
<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>
<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>
<p>Most of these events come up due to a 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>
<p>Some errors are considered temporary and re-running the bisync is not
blocked. The <em>critical return</em> blocks further bisync runs.</p>
<h3 id="lock-file">Lock file</h3>
<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.</p>
<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>
<h3 id="return-codes">Return codes</h3>
<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>
<h2 id="limitations-2">Limitations</h2>
<h3 id="supported-backends">Supported backends</h3>
<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</p>
<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>
<p>First release of <code>rclone bisync</code> requires that underlying
backend supported the modification time feature and will refuse to run
otherwise. This limitation will be lifted in a future
<code>rclone bisync</code> release.</p>
<h3 id="concurrent-modifications">Concurrent modifications</h3>
<p>When using <strong>Local, FTP or SFTP</strong> remotes 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. This will be solved in a future release, there
is no workaround at the moment.</p>
<p>Files that <strong>change during</strong> a bisync run may result in
data loss. This has been seen in a highly dynamic environment, where the
filesystem is getting hammered by running processes during the sync. The
solution is to sync at quiet times or <a href="#filtering">filter
out</a> unnecessary directories and files.</p>
<h3 id="empty-directories">Empty directories</h3>
<p>New 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. The following sequence is a workaround but will not
propagate the delete of an empty directory to the other side:</p>
<pre><code>rclone bisync PATH1 PATH2
rclone copy PATH1 PATH2 --filter &quot;+ */&quot; --filter &quot;- **&quot; --create-empty-src-dirs
rclone copy PATH2 PATH2 --filter &quot;+ */&quot; --filter &quot;- **&quot; --create-empty-src-dirs</code></pre>
<h3 id="renamed-directories">Renamed directories</h3>
<p>Renaming a folder on the Path1 side results is 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. Similarly, renaming a
directory on both sides to the same name will result in creating
<code>..path1</code> and <code>..path2</code> files on both sides.
Currently the most effective and efficient method of renaming a
directory is to rename it on both sides, then do a
<code>--resync</code>.</p>
<h3 id="case-sensitivity">Case sensitivity</h3>
<p>Synching with <strong>case-insensitive</strong> filesystems, such as
Windows or <code>Box</code>, can result in file name conflicts. This
will be fixed in a future release. The near term workaround is to make
sure that files on both sides don’t have spelling case differences
(<code>Smile.jpg</code> vs. <code>smile.jpg</code>).</p>
<h2 id="windows">Windows support</h2>
<p>Bisync has been tested on Windows 8.1, Windows 10 Pro 64-bit and on
Windows GitHub runners.</p>
<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>
<p>Absolute paths (with or without a drive letter), and relative paths
(with or without a drive letter) are supported.</p>
<p>Working directory is created at
<code>C:\Users\MyLogin\AppData\Local\rclone\bisync</code>.</p>
<p>Note that bisync output may show a mix of forward <code>/</code> and
back <code>\</code> slashes.</p>
<p>Be careful of case independent directory and file naming on Windows
vs. case dependent Linux</p>
<h2 id="filtering">Filtering</h2>
<p>See <a href="https://rclone.org/filtering/">filtering
documentation</a> for how filter rules are written and interpreted.</p>
<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>
<h3 id="how-to-filter-directories">How to filter directories</h3>
<p>Filtering portions of the directory tree is a critical feature for
synching.</p>
<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>
<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>
<h3 id="filters-file-writing-guidelines">Filters file writing
guidelines</h3>
<ol type="1">
<li>Begin with excluding directory trees:
<ul>
<li>e.g. <code>- /AppData/</code></li>
<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>
<li>Exclude such directories that are unneeded, are big, dynamically
thrashed, or where there may be access permission issues.</li>
<li>Excluding such dirs first will make rclone operations (much)
faster.</li>
<li>Specific files may also be excluded, as with the Dropbox exclusions
example below.</li>
</ul></li>
<li>Decide if its easier (or cleaner) to:
<ul>
<li>Include select directories and therefore <em>exclude everything
else</em> – or –</li>
<li>Exclude select directories and therefore <em>include everything
else</em></li>
</ul></li>
<li>Include select directories:
<ul>
<li>Add lines like: <code>+ /Documents/PersonalFiles/**</code> to select
which directories to include in the sync.</li>
<li><code>**</code> on the end specifies to include the full depth of
the specified tree.</li>
<li>With Include-style filters, files at the Path1/Path2 root are not
included. They may be included with <code>+ /*</code>.</li>
<li>Place RCLONE_TEST files within these included directory trees. They
will only be looked for in these directory trees.</li>
<li>Finish by excluding everything else by adding <code>- **</code> at
the end of the filters file.</li>
<li>Disregard step 4.</li>
</ul></li>
<li>Exclude select directories:
<ul>
<li>Add more lines like in step 1. For example:
<code>-/Desktop/tempfiles/</code>, or <code>- /testdir/</code>. Again, a
<code>**</code> on the end is not necessary.</li>
<li>Do <em>not</em> add a <code>- **</code> in the file. Without this
line, everything will be included that has not be explicitly
excluded.</li>
<li>Disregard step 3.</li>
</ul></li>
</ol>
<p>A few rules for the syntax of a filter file expanding on <a
href="https://rclone.org/filtering/">filtering documentation</a>:</p>
<ul>
<li>Lines may start with spaces and tabs - rclone strips leading
whitespace.</li>
<li>If the first non-whitespace character is a <code>#</code> then the
line is a comment and will be ignored.</li>
<li>Blank lines are ignored.</li>
<li>The first non-whitespace character on a filter line must be a
<code>+</code> or <code>-</code>.</li>
<li>Exactly 1 space is allowed between the <code>+/-</code> and the path
term.</li>
<li>Only forward slashes (<code>/</code>) are used in path terms, even
on Windows.</li>
<li>The rest of the line is taken as the path term. Trailing whitespace
is taken literally, and probably is an error.</li>
</ul>
<h3 id="include-filters">Example include-style filters for Windows user
directories</h3>
<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>
<ul>
<li><code>- /AppData/</code> excludes an entire tree of Windows stored
stuff that need not be synched. In my case, AppData has &gt;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>
<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>
<li>There are just a few directories with <em>my</em> data that I do
want synched, in the form of <code>+ /&lt;path&gt;</code>. By selecting
only the directory trees I want to avoid the dozen plus directories that
various apps make at <code>C:\Users\MyLogin\Documents</code>.</li>
<li>Include files in the root of the sync point,
<code>C:\Users\MyLogin</code>, by adding the <code>+ /*</code>
line.</li>
<li>This is an Include-style filters file, therefore it ends with
<code>- **</code> which excludes everything not explicitly
included.</li>
</ul>
<pre><code>- /AppData/
- NTUSER*
- ntuser*
+ /Documents/Family/**
+ /Documents/Sketchup/**
+ /Documents/Microcapture_Photo/**
+ /Documents/Microcapture_Video/**
+ /Desktop/**
+ /Pictures/**
+ /*
- **</code></pre>
<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>
<h2 id="exclude-filters">Example exclude-style filters files for use
with Dropbox</h2>
<ul>
<li>Dropbox disallows synching the listed temporary and
configuration/data files. The <code>- &lt;filename&gt;</code> 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>
<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 <code>- /testdir/</code> filter blocks this tree from being
synched. You don’t need this exclusion if you are not doing bisync
development testing.</li>
<li>Everything else beneath the Path1/Path2 root will be synched.</li>
<li>RCLONE_TEST files may be placed anywhere within the tree, including
the root.</li>
</ul>
<h3 id="example-filters-file">Example filters file for Dropbox</h3>
<pre><code># Filter file for use with bisync
# See https://rclone.org/filtering/ for filtering rules
# NOTICE: If you make changes to this file you MUST do a --resync run.
#         Run with --dry-run to see what changes will be made.

# Dropbox wont sync some files so filter them away here.
# See https://help.dropbox.com/installs-integrations/sync-uploads/files-not-syncing
- .dropbox.attr
- ~*.tmp
- ~$*
- .~*
- desktop.ini
- .dropbox

# Used for bisync testing, so excluded from normal runs
- /testdir/

# Other example filters
#- /TiBU/
#- /Photos/</code></pre>
<h3 id="how-check-access-handles-filters">How –check-access handles
filters</h3>
<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>
<h2 id="troubleshooting">Troubleshooting</h2>
<h3 id="reading-bisync-logs">Reading bisync logs</h3>
<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>
<pre><code>2021/05/16 00:24:38 INFO  : Synching Path1 &quot;/path/to/local/tree/&quot; with Path2 &quot;dropbox:/&quot;
2021/05/16 00:24:38 INFO  : Path1 checking for diffs
2021/05/16 00:24:38 INFO  : - Path1    File is new                         - file.txt
2021/05/16 00:24:38 INFO  : Path1:    1 changes:    1 new,    0 newer,    0 older,    0 deleted
2021/05/16 00:24:38 INFO  : Path2 checking for diffs
2021/05/16 00:24:38 INFO  : Applying changes
2021/05/16 00:24:38 INFO  : - Path1    Queue copy to Path2                 - dropbox:/file.txt
2021/05/16 00:24:38 INFO  : - Path1    Do queued copies to                 - Path2
2021/05/16 00:24:38 INFO  : Updating listings
2021/05/16 00:24:38 INFO  : Validating listings for Path1 &quot;/path/to/local/tree/&quot; vs Path2 &quot;dropbox:/&quot;
2021/05/16 00:24:38 INFO  : Bisync successful

2021/05/16 00:36:52 INFO  : Synching Path1 &quot;/path/to/local/tree/&quot; with Path2 &quot;dropbox:/&quot;
2021/05/16 00:36:52 INFO  : Path1 checking for diffs
2021/05/16 00:36:52 INFO  : Path2 checking for diffs
2021/05/16 00:36:52 INFO  : No changes found
2021/05/16 00:36:52 INFO  : Updating listings
2021/05/16 00:36:52 INFO  : Validating listings for Path1 &quot;/path/to/local/tree/&quot; vs Path2 &quot;dropbox:/&quot;
2021/05/16 00:36:52 INFO  : Bisync successful</code></pre>
<h3 id="dry-run-oddity">Dry run oddity</h3>
<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 the Path2, blocked again by –dry-run:
<code>... Not deleting as --dry-run</code>.</p>
<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>
<h3 id="retries">Retries</h3>
<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>
<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>
<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>
<pre><code>1: 2021/05/14 00:44:12 INFO  : Synching Path1 &quot;/path/to/local/tree&quot; with Path2 &quot;dropbox:&quot;
2: 2021/05/14 00:44:12 INFO  : Path1 checking for diffs
3: 2021/05/14 00:44:12 INFO  : Path2 checking for diffs
4: 2021/05/14 00:44:12 INFO  : Path2:  113 changes:   22 new,    0 newer,    0 older,   91 deleted
5: 2021/05/14 00:44:12 ERROR : /path/to/local/tree/objects/af: error listing: unexpected end of JSON input
6: 2021/05/14 00:44:12 NOTICE: WARNING  listing try 1 failed.                 - dropbox:
7: 2021/05/14 00:44:12 INFO  : Bisync successful</code></pre>
<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>
<pre><code>2021/05/12 00:49:40 INFO  : Google drive root &#39;&#39;: Waiting for checks to finish
2021/05/12 00:49:40 INFO  : Google drive root &#39;&#39;: Waiting for transfers to finish
2021/05/12 00:49:40 INFO  : Google drive root &#39;&#39;: not deleting files as there were IO errors
2021/05/12 00:49:40 ERROR : Attempt 3/3 failed with 3 errors and: not deleting files as there were IO errors
2021/05/12 00:49:40 ERROR : Failed to sync: not deleting files as there were IO errors
2021/05/12 00:49:40 NOTICE: WARNING  rclone sync try 3 failed.           - /path/to/local/tree/
2021/05/12 00:49:40 ERROR : Bisync aborted. Must run --resync to recover.</code></pre>
<h3 id="denied-downloads-of-infected-or-abusive-files">Denied downloads
of “infected” or “abusive” files</h3>
<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>
<h3 id="google-doc-files">Google Doc files</h3>
<p>Google docs exist as virtual files on Google Drive and cannot be
transferred to other filesystems natively. While it is possible to
export a Google doc to a normal file (with <code>.xlsx</code> extension,
for example), it is not possible to import a normal file back into a
Google document.</p>
<p>Bisync’s handling of Google Doc files is to flag them in the run log
output for user’s attention and ignore them for any file transfers,
deletes, or syncs. They will show up with a length of <code>-1</code> in
the listings. This bisync run is otherwise successful:</p>
<pre><code>2021/05/11 08:23:15 INFO  : Synching Path1 &quot;/path/to/local/tree/base/&quot; with Path2 &quot;GDrive:&quot;
2021/05/11 08:23:15 INFO  : ...path2.lst-new: Ignoring incorrect line: &quot;- -1 - - 2018-07-29T08:49:30.136000000+0000 GoogleDoc.docx&quot;
2021/05/11 08:23:15 INFO  : Bisync successful</code></pre>
<h2 id="usage-examples">Usage examples</h2>
<h3 id="cron">Cron</h3>
<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>
<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>
<pre><code># Minute (0-59)
#      Hour (0-23)
#           Day of Month (1-31)
#                Month (1-12 or Jan-Dec)
#                     Day of Week (0-6 or Sun-Sat)
#                         Command
  */5  *    *    *    *   /path/to/rclone bisync /local/files MyCloud: --check-access --filters-file /path/to/bysync-filters.txt --log-file /path/to//bisync.log</code></pre>
<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>
<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>&gt;&gt;</code>) and stderr (via
<code>2&gt;&amp;1</code>) to a log file.</p>
<pre><code>0 * * * * /path/to/rclone bisync /path/to/local/dropbox Dropbox: --check-access --filters-file /home/user/filters.txt &gt;&gt; /path/to/logs/dropbox-run.log 2&gt;&amp;1</code></pre>
<h3 id="sharing-an-encrypted-folder-tree-between-hosts">Sharing an
encrypted folder tree between hosts</h3>
<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>
<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>
<h3 id="linux-server-setup">Linux server setup</h3>
<ul>
<li><code>/path/to/DBoxroot</code> is the root of my local sync tree.
There are numerous subdirectories.</li>
<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>
<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>
<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>
<li><code>bisync /path/to/DBoxroot Dropbox:</code> runs periodically via
cron, keeping my full local sync tree in sync with Dropbox.</li>
</ul>
<h3 id="windows-notebook-setup">Windows notebook setup</h3>
<ul>
<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>
<li>A separate directory tree at
<code>C:\Users\MyLogin\Documents\DropLocal</code> hosts the tree of
unencrypted files/folders.</li>
<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>
<li>The Dropbox client then syncs the changes with Dropbox.</li>
</ul>
<h3 id="rclone-conf-snippet">rclone.conf snippet</h3>
<pre><code>[Dropbox]
type = dropbox
...

[Dropcrypt]
type = crypt
remote = /path/to/DBoxroot/crypt          # on the Linux server
remote = C:\Users\MyLogin\Dropbox\crypt   # on the Windows notebook
filename_encryption = standard
directory_name_encryption = true
password = ...
...</code></pre>
<h2 id="testing">Testing</h2>
<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>
<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>
<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>
<h3 id="test-command-syntax">Test command syntax</h3>
<pre><code>usage: go test ./cmd/bisync [options...]

Options:
  -case NAME        Name(s) of the test case(s) to run. Multiple names should
                    be separated by commas. You can remove the `test_` prefix
                    and replace `_` by `-` in test name for convenience.
                    If not `all`, the name(s) should map to a directory under
                    `./cmd/bisync/testdata`.
                    Use `all` to run all tests (default: all)
  -remote PATH1     `local` or name of cloud service with `:` (default: local)
  -remote2 PATH2    `local` or name of cloud service with `:` (default: local)
  -no-compare       Disable comparing test results with the golden directory
                    (default: compare)
  -no-cleanup       Disable cleanup of Path1 and Path2 testdirs.
                    Useful for troubleshooting. (default: cleanup)
  -golden           Store results in the golden directory (default: false)
                    This flag can be used with multiple tests.
  -debug            Print debug messages
  -stop-at NUM      Stop test after given step number. (default: run to the end)
                    Implies `-no-compare` and `-no-cleanup`, if the test really
                    ends prematurely. Only meaningful for a single test case.
  -refresh-times    Force refreshing the target modtime, useful for Dropbox
                    (default: false)
  -verbose          Run tests verbosely</code></pre>
<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>
<h3 id="running-tests">Running tests</h3>
<ul>
<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>
<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>
<li>The test engine will mangle rclone output to ensure comparability
with golden listings and logs.</li>
<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>
<li><code>go test . -remote local -remote2 local -case all</code> runs
all tests.</li>
<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>
<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 &gt; runlog.txt 2&gt;&amp;1</code></li>
</ul>
<h3 id="test-execution-flow">Test execution flow</h3>
<ol type="1">
<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>
<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>
<li>Finally, the contents of the test working directory are compared to
the contents of the testcase’s golden directory.</li>
</ol>
<h3 id="notes-about-testing">Notes about testing</h3>
<ul>
<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>
<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>
<li>The local test sync tree is created at a temporary directory named
like <code>bisync.XXX</code> under system temporary directory.</li>
<li>The remote test sync tree is located at a temporary directory under
<code>&lt;remote:&gt;/bisync.XXX/</code>.</li>
<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>
<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>
<li>You will likely want to add <code>- /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</code>, so
the test cases may reside on the synched tree even if there are check
file mismatches in the test tree.</li>
<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 a way Dropbox handles modification
times. You should use the <code>-refresh-times</code> test flag to make
up for this.</li>
<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>
</ul>
<h3 id="updating-golden-results">Updating golden results</h3>
<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>
<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>
<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>
<h3 id="structure-of-test-scenarios">Structure of test scenarios</h3>
<ul>
<li><code>&lt;testname&gt;/initial/</code> contains a tree of files that
will be set as the initial condition on both Path1 and Path2
testdirs.</li>
<li><code>&lt;testname&gt;/modfiles/</code> contains files that will be
used to modify the Path1 and/or Path2 filesystems.</li>
<li><code>&lt;testname&gt;/golden/</code> contains the expected content
of the test working directory (<code>workdir</code>) at the completion
of the testcase.</li>
<li><code>&lt;testname&gt;/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>
</ul>
<h3 id="supported-test-commands">Supported test commands</h3>
<ul>
<li><code>test &lt;some message&gt;</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>
<li><code>copy-listings &lt;prefix&gt;</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>
<li><code>move-listings &lt;prefix&gt;</code> Similar to
<code>copy-listings</code> but removes the source</li>
<li><code>purge-children &lt;dir&gt;</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>
<li><code>delete-file &lt;file&gt;</code> Delete a single file.</li>
<li><code>delete-glob &lt;dir&gt; &lt;pattern&gt;</code> Delete a group
of files located one level deep in the given directory with names
maching a given glob pattern.</li>
<li><code>touch-glob YYYY-MM-DD &lt;dir&gt; &lt;pattern&gt;</code>
Change modification time on a group of files.</li>
<li><code>touch-copy YYYY-MM-DD &lt;source-file&gt; &lt;dest-dir&gt;</code>
Change file modification time then copy it to destination.</li>
<li><code>copy-file &lt;source-file&gt; &lt;dest-dir&gt;</code> Copy a
single file to given directory.</li>
<li><code>copy-as &lt;source-file&gt; &lt;dest-file&gt;</code> Similar
to above but destination must include both directory and the new file
name at destination.</li>
<li><code>copy-dir &lt;src&gt; &lt;dst&gt;</code> and
<code>sync-dir &lt;src&gt; &lt;dst&gt;</code> Copy/sync a directory.
Equivalent of <code>rclone copy</code> and
<code>rclone sync</code>.</li>
<li><code>list-dirs &lt;dir&gt;</code> Equivalent to
<code>rclone lsf -R --dirs-only &lt;dir&gt;</code></li>
<li><code>bisync [options]</code> Runs bisync against
<code>-remote</code> and <code>-remote2</code>.</li>
</ul>
<h3 id="supported-substitution-terms">Supported substitution terms</h3>
<ul>
<li><code>{testdir/}</code> - the root dir of the testcase</li>
<li><code>{datadir/}</code> - the <code>modfiles</code> dir under the
testcase root</li>
<li><code>{workdir/}</code> - the temporary test working directory</li>
<li><code>{path1/}</code> - the root of the Path1 test directory
tree</li>
<li><code>{path2/}</code> - the root of the Path2 test directory
tree</li>
<li><code>{session}</code> - base name of the test listings</li>
<li><code>{/}</code> - OS-specific path separator</li>
<li><code>{spc}</code>, <code>{tab}</code>, <code>{eol}</code> -
whitespace</li>
<li><code>{chr:HH}</code> - raw byte with given hexadecimal code</li>
</ul>
<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>
<h2 id="benchmarks">Benchmarks</h2>
<p><em>This section is work in progress.</em></p>
<p>Here are a few data points for scale, execution times, and memory
usage.</p>
<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>
<table>
<colgroup>
<col style="width: 33%" />
<col style="width: 50%" />
<col style="width: 16%" />
</colgroup>
<thead>
<tr class="header">
<th>Change</th>
<th>Operations and times</th>
<th>Overall run time</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>500 files synched (nothing to move)</td>
<td>1x listings for Path1 &amp; Path2</td>
<td>1.5 sec</td>
</tr>
<tr class="even">
<td>500 files synched with –check-access</td>
<td>1x listings for Path1 &amp; Path2</td>
<td>1.5 sec</td>
</tr>
<tr class="odd">
<td>50 new files on remote</td>
<td>Queued 50 copies down: 27 sec</td>
<td>29 sec</td>
</tr>
<tr class="even">
<td>Moved local dir</td>
<td>Queued 50 copies up: 410 sec, 50 deletes up: 9 sec</td>
<td>421 sec</td>
</tr>
<tr class="odd">
<td>Moved remote dir</td>
<td>Queued 50 copies down: 31 sec, 50 deletes down: &lt;1 sec</td>
<td>33 sec</td>
</tr>
<tr class="even">
<td>Delete local dir</td>
<td>Queued 50 deletes up: 9 sec</td>
<td>13 sec</td>
</tr>
</tbody>
</table>
<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>
<ul>
<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>
<li>Getting a fresh listing of the local file system (producing the 140
MB output file) took about XXX sec.</li>
<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>
<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>
</ul>
<h2 id="references">References</h2>
<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 <a
href="https://github.com/cjnaz"><span class="citation"
data-cites="cjnaz">@cjnaz</span></a>’s full support and
encouragement.</p>
<p><code>rclone bisync</code> is similar in nature to a range of other
projects:</p>
<ul>
<li><a href="https://github.com/bcpierce00/unison">unison</a></li>
<li><a href="https://github.com/syncthing/syncthing">syncthing</a></li>
<li><a
href="https://github.com/cjnaz/rclonesync-V2">cjnaz/rclonesync</a></li>
<li><a
href="https://github.com/ConorWilliams/rsinc">ConorWilliams/rsinc</a></li>
<li><a
href="https://github.com/Jwink3101/syncrclone">jwink3101/syncrclone</a></li>
<li><a
href="https://github.com/DavideRossi/upback">DavideRossi/upback</a></li>
</ul>
<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 the <a
href="https://neil.fraser.name/writing/sync/">Neil Fraser’s
article</a>.</p>
<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>
<h1 id="fichier">1Fichier</h1>
<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>
<p>Paths are specified as <code>remote:path</code></p>
<p>Paths may be as deep as required,
e.g. <code>remote:directory/subdirectory</code>.</p>
<h2 id="configuration">Configuration</h2>
<p>The initial setup for 1Fichier involves getting the API key from the
website which you need to do in your browser.</p>
<p>Here is an example of how to make a remote called
<code>remote</code>. First run:</p>
<pre><code> rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<pre><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; remote
Type of storage to configure.
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
[snip]
XX / 1Fichier
   \ &quot;fichier&quot;
[snip]
Storage&gt; fichier
** See help for fichier backend at: https://rclone.org/fichier/ **

Your API Key, get it from https://1fichier.com/console/params.pl
Enter a string value. Press Enter for the default (&quot;&quot;).
api_key&gt; example_key

Edit advanced config? (y/n)
y) Yes
n) No
y/n&gt; 
Remote config
--------------------
[remote]
type = fichier
api_key = example_key
--------------------
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<p>Once configured you can then use <code>rclone</code> like this,</p>
<p>List directories in top level of your 1Fichier account</p>
<pre><code>rclone lsd remote:</code></pre>
<p>List all the files in your 1Fichier account</p>
<pre><code>rclone ls remote:</code></pre>
<p>To copy a local directory to a 1Fichier directory called backup</p>
<pre><code>rclone copy /home/source remote:backup</code></pre>
<h3 id="modified-time-and-hashes">Modified time and hashes</h3>
<p>1Fichier does not support modification times. It supports the
Whirlpool hash algorithm.</p>
<h3 id="duplicated-files">Duplicated files</h3>
<p>1Fichier can have two files with exactly the same name and path
(unlike a normal file system).</p>
<p>Duplicated files cause problems with the syncing and you will see
messages in the log about duplicates.</p>
<h3 id="restricted-filename-characters">Restricted filename
characters</h3>
<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>
<table>
<thead>
<tr class="header">
<th>Character</th>
<th style="text-align: center;">Value</th>
<th style="text-align: center;">Replacement</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>\</td>
<td style="text-align: center;">0x5C</td>
<td style="text-align: center;">＼</td>
</tr>
<tr class="even">
<td>&lt;</td>
<td style="text-align: center;">0x3C</td>
<td style="text-align: center;">＜</td>
</tr>
<tr class="odd">
<td>&gt;</td>
<td style="text-align: center;">0x3E</td>
<td style="text-align: center;">＞</td>
</tr>
<tr class="even">
<td>”</td>
<td style="text-align: center;">0x22</td>
<td style="text-align: center;">＂</td>
</tr>
<tr class="odd">
<td>$</td>
<td style="text-align: center;">0x24</td>
<td style="text-align: center;">＄</td>
</tr>
<tr class="even">
<td>`</td>
<td style="text-align: center;">0x60</td>
<td style="text-align: center;">｀</td>
</tr>
<tr class="odd">
<td>’</td>
<td style="text-align: center;">0x27</td>
<td style="text-align: center;">＇</td>
</tr>
</tbody>
</table>
<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>
<table>
<thead>
<tr class="header">
<th>Character</th>
<th style="text-align: center;">Value</th>
<th style="text-align: center;">Replacement</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>SP</td>
<td style="text-align: center;">0x20</td>
<td style="text-align: center;">␠</td>
</tr>
</tbody>
</table>
<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>
<h3 id="standard-options">Standard options</h3>
<p>Here are the Standard options specific to fichier (1Fichier).</p>
<h4 id="fichier-api-key">–fichier-api-key</h4>
<p>Your API Key, get it from https://1fichier.com/console/params.pl.</p>
<p>Properties:</p>
<ul>
<li>Config: api_key</li>
<li>Env Var: RCLONE_FICHIER_API_KEY</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h3 id="advanced-options">Advanced options</h3>
<p>Here are the Advanced options specific to fichier (1Fichier).</p>
<h4 id="fichier-shared-folder">–fichier-shared-folder</h4>
<p>If you want to download a shared folder, add this parameter.</p>
<p>Properties:</p>
<ul>
<li>Config: shared_folder</li>
<li>Env Var: RCLONE_FICHIER_SHARED_FOLDER</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="fichier-file-password">–fichier-file-password</h4>
<p>If you want to download a shared file that is password protected, add
this parameter.</p>
<p><strong>NB</strong> Input to this must be obscured - see <a
href="https://rclone.org/commands/rclone_obscure/">rclone
obscure</a>.</p>
<p>Properties:</p>
<ul>
<li>Config: file_password</li>
<li>Env Var: RCLONE_FICHIER_FILE_PASSWORD</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="fichier-folder-password">–fichier-folder-password</h4>
<p>If you want to list the files in a shared folder that is password
protected, add this parameter.</p>
<p><strong>NB</strong> Input to this must be obscured - see <a
href="https://rclone.org/commands/rclone_obscure/">rclone
obscure</a>.</p>
<p>Properties:</p>
<ul>
<li>Config: folder_password</li>
<li>Env Var: RCLONE_FICHIER_FOLDER_PASSWORD</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="fichier-encoding">–fichier-encoding</h4>
<p>The encoding for the backend.</p>
<p>See the <a href="https://rclone.org/overview/#encoding">encoding
section in the overview</a> for more info.</p>
<p>Properties:</p>
<ul>
<li>Config: encoding</li>
<li>Env Var: RCLONE_FICHIER_ENCODING</li>
<li>Type: MultiEncoder</li>
<li>Default:
Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot</li>
</ul>
<h2 id="limitations-3">Limitations</h2>
<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>
<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>
<h1 id="alias">Alias</h1>
<p>The <code>alias</code> remote provides a new name for another
remote.</p>
<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>
<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>
<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>
<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>
<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>
<h2 id="configuration-1">Configuration</h2>
<p>Here is an example of how to make an alias called <code>remote</code>
for local folder. First run:</p>
<pre><code> rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<pre><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; remote
Type of storage to configure.
Choose a number from below, or type in your own value
[snip]
XX / Alias for an existing remote
   \ &quot;alias&quot;
[snip]
Storage&gt; alias
Remote or path to alias.
Can be &quot;myremote:path/to/dir&quot;, &quot;myremote:bucket&quot;, &quot;myremote:&quot; or &quot;/local/path&quot;.
remote&gt; /mnt/storage/backup
Remote config
--------------------
[remote]
remote = /mnt/storage/backup
--------------------
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d&gt; y
Current remotes:

Name                 Type
====                 ====
remote               alias

e) Edit existing remote
n) New remote
d) Delete remote
r) Rename remote
c) Copy remote
s) Set configuration password
q) Quit config
e/n/d/r/c/s/q&gt; q</code></pre>
<p>Once configured you can then use <code>rclone</code> like this,</p>
<p>List directories in top level in <code>/mnt/storage/backup</code></p>
<pre><code>rclone lsd remote:</code></pre>
<p>List all the files in <code>/mnt/storage/backup</code></p>
<pre><code>rclone ls remote:</code></pre>
<p>Copy another local directory to the alias directory called source</p>
<pre><code>rclone copy /home/source remote:source</code></pre>
<h3 id="standard-options-1">Standard options</h3>
<p>Here are the Standard options specific to alias (Alias for an
existing remote).</p>
<h4 id="alias-remote">–alias-remote</h4>
<p>Remote or path to alias.</p>
<p>Can be “myremote:path/to/dir”, “myremote:bucket”, “myremote:” or
“/local/path”.</p>
<p>Properties:</p>
<ul>
<li>Config: remote</li>
<li>Env Var: RCLONE_ALIAS_REMOTE</li>
<li>Type: string</li>
<li>Required: true</li>
</ul>
<h1 id="amazon-drive">Amazon Drive</h1>
<p>Amazon Drive, formerly known as Amazon Cloud Drive, is a cloud
storage service run by Amazon for consumers.</p>
<h2 id="status">Status</h2>
<p><strong>Important:</strong> rclone supports Amazon Drive only if you
have your own set of API keys. Unfortunately the <a
href="https://developer.amazon.com/amazon-drive">Amazon Drive developer
program</a> is now closed to new entries so if you don’t already have
your own set of keys you will not be able to use rclone with Amazon
Drive.</p>
<p>For the history on why rclone no longer has a set of Amazon Drive API
keys see <a
href="https://forum.rclone.org/t/rclone-has-been-banned-from-amazon-drive/2314">the
forum</a>.</p>
<p>If you happen to know anyone who works at Amazon then please ask them
to re-instate rclone into the Amazon Drive developer program -
thanks!</p>
<h2 id="configuration-2">Configuration</h2>
<p>The initial setup for Amazon Drive involves getting a token from
Amazon which you need to do in your browser. <code>rclone config</code>
walks you through it.</p>
<p>The configuration process for Amazon Drive may involve using an <a
href="https://github.com/ncw/oauthproxy">oauth proxy</a>. This is used
to keep the Amazon credentials out of the source code. The proxy runs in
Google’s very secure App Engine environment and doesn’t store any
credentials which pass through it.</p>
<p>Since rclone doesn’t currently have its own Amazon Drive credentials
so you will either need to have your own <code>client_id</code> and
<code>client_secret</code> with Amazon Drive, or use a third-party oauth
proxy in which case you will need to enter <code>client_id</code>,
<code>client_secret</code>, <code>auth_url</code> and
<code>token_url</code>.</p>
<p>Note also if you are not using Amazon’s <code>auth_url</code> and
<code>token_url</code>, (ie you filled in something for those) then if
setting up on a remote machine you can only use the <a
href="https://rclone.org/remote_setup/#configuring-by-copying-the-config-file">copying
the config method of configuration</a> - <code>rclone authorize</code>
will not work.</p>
<p>Here is an example of how to make a remote called
<code>remote</code>. First run:</p>
<pre><code> rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<pre><code>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&gt; n
name&gt; remote
Type of storage to configure.
Choose a number from below, or type in your own value
[snip]
XX / Amazon Drive
   \ &quot;amazon cloud drive&quot;
[snip]
Storage&gt; amazon cloud drive
Amazon Application Client Id - required.
client_id&gt; your client ID goes here
Amazon Application Client Secret - required.
client_secret&gt; your client secret goes here
Auth server URL - leave blank to use Amazon&#39;s.
auth_url&gt; Optional auth URL
Token server url - leave blank to use Amazon&#39;s.
token_url&gt; Optional token URL
Remote config
Make sure your Redirect URL is set to &quot;http://127.0.0.1:53682/&quot; in your custom config.
Use auto config?
 * Say Y if not sure
 * Say N if you are working on a remote or headless machine
y) Yes
n) No
y/n&gt; y
If your browser doesn&#39;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 = your client ID goes here
client_secret = your client secret goes here
auth_url = Optional auth URL
token_url = Optional token URL
token = {&quot;access_token&quot;:&quot;xxxxxxxxxxxxxxxxxxxxxxx&quot;,&quot;token_type&quot;:&quot;bearer&quot;,&quot;refresh_token&quot;:&quot;xxxxxxxxxxxxxxxxxx&quot;,&quot;expiry&quot;:&quot;2015-09-06T16:07:39.658438471+01:00&quot;}
--------------------
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<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>
<p>Note that rclone runs a webserver on your local machine to collect
the token as returned from Amazon. This only runs from the moment it
opens your browser to the moment you get back the verification code.
This is on <code>http://127.0.0.1:53682/</code> and this it may require
you to unblock it temporarily if you are running a host firewall.</p>
<p>Once configured you can then use <code>rclone</code> like this,</p>
<p>List directories in top level of your Amazon Drive</p>
<pre><code>rclone lsd remote:</code></pre>
<p>List all the files in your Amazon Drive</p>
<pre><code>rclone ls remote:</code></pre>
<p>To copy a local directory to an Amazon Drive directory called
backup</p>
<pre><code>rclone copy /home/source remote:backup</code></pre>
<h3 id="modified-time-and-md5sums">Modified time and MD5SUMs</h3>
<p>Amazon Drive doesn’t allow modification times to be changed via the
API so these won’t be accurate or used for syncing.</p>
<p>It does store MD5SUMs so for a more accurate sync, you can use the
<code>--checksum</code> flag.</p>
<h3 id="restricted-filename-characters-1">Restricted filename
characters</h3>
<table>
<thead>
<tr class="header">
<th>Character</th>
<th style="text-align: center;">Value</th>
<th style="text-align: center;">Replacement</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>NUL</td>
<td style="text-align: center;">0x00</td>
<td style="text-align: center;">␀</td>
</tr>
<tr class="even">
<td>/</td>
<td style="text-align: center;">0x2F</td>
<td style="text-align: center;">／</td>
</tr>
</tbody>
</table>
<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>
<h3 id="deleting-files">Deleting files</h3>
<p>Any files you delete with rclone will end up in the trash. Amazon
don’t provide an API to permanently delete files, nor to empty the
trash, so you will have to do that with one of Amazon’s apps or via the
Amazon Drive website. As of November 17, 2016, files are automatically
deleted by Amazon from the trash after 30 days.</p>
<h3 id="using-with-non-.com-amazon-accounts">Using with non
<code>.com</code> Amazon accounts</h3>
<p>Let’s say you usually use <code>amazon.co.uk</code>. When you
authenticate with rclone it will take you to an <code>amazon.com</code>
page to log in. Your <code>amazon.co.uk</code> email and password should
work here just fine.</p>
<h3 id="standard-options-2">Standard options</h3>
<p>Here are the Standard options specific to amazon cloud drive (Amazon
Drive).</p>
<h4 id="acd-client-id">–acd-client-id</h4>
<p>OAuth Client Id.</p>
<p>Leave blank normally.</p>
<p>Properties:</p>
<ul>
<li>Config: client_id</li>
<li>Env Var: RCLONE_ACD_CLIENT_ID</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="acd-client-secret">–acd-client-secret</h4>
<p>OAuth Client Secret.</p>
<p>Leave blank normally.</p>
<p>Properties:</p>
<ul>
<li>Config: client_secret</li>
<li>Env Var: RCLONE_ACD_CLIENT_SECRET</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h3 id="advanced-options-1">Advanced options</h3>
<p>Here are the Advanced options specific to amazon cloud drive (Amazon
Drive).</p>
<h4 id="acd-token">–acd-token</h4>
<p>OAuth Access Token as a JSON blob.</p>
<p>Properties:</p>
<ul>
<li>Config: token</li>
<li>Env Var: RCLONE_ACD_TOKEN</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="acd-auth-url">–acd-auth-url</h4>
<p>Auth server URL.</p>
<p>Leave blank to use the provider defaults.</p>
<p>Properties:</p>
<ul>
<li>Config: auth_url</li>
<li>Env Var: RCLONE_ACD_AUTH_URL</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="acd-token-url">–acd-token-url</h4>
<p>Token server url.</p>
<p>Leave blank to use the provider defaults.</p>
<p>Properties:</p>
<ul>
<li>Config: token_url</li>
<li>Env Var: RCLONE_ACD_TOKEN_URL</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="acd-checkpoint">–acd-checkpoint</h4>
<p>Checkpoint for internal polling (debug).</p>
<p>Properties:</p>
<ul>
<li>Config: checkpoint</li>
<li>Env Var: RCLONE_ACD_CHECKPOINT</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="acd-upload-wait-per-gb">–acd-upload-wait-per-gb</h4>
<p>Additional time per GiB to wait after a failed complete upload to see
if it appears.</p>
<p>Sometimes Amazon Drive gives an error when a file has been fully
uploaded but the file appears anyway after a little while. This happens
sometimes for files over 1 GiB in size and nearly every time for files
bigger than 10 GiB. This parameter controls the time rclone waits for
the file to appear.</p>
<p>The default value for this parameter is 3 minutes per GiB, so by
default it will wait 3 minutes for every GiB uploaded to see if the file
appears.</p>
<p>You can disable this feature by setting it to 0. This may cause
conflict errors as rclone retries the failed upload but the file will
most likely appear correctly eventually.</p>
<p>These values were determined empirically by observing lots of uploads
of big files for a range of file sizes.</p>
<p>Upload with the “-v” flag to see more info about what rclone is doing
in this situation.</p>
<p>Properties:</p>
<ul>
<li>Config: upload_wait_per_gb</li>
<li>Env Var: RCLONE_ACD_UPLOAD_WAIT_PER_GB</li>
<li>Type: Duration</li>
<li>Default: 3m0s</li>
</ul>
<h4 id="acd-templink-threshold">–acd-templink-threshold</h4>
<p>Files &gt;= this size will be downloaded via their tempLink.</p>
<p>Files this size or more will be downloaded via their “tempLink”. This
is to work around a problem with Amazon Drive which blocks downloads of
files bigger than about 10 GiB. The default for this is 9 GiB which
shouldn’t need to be changed.</p>
<p>To download files above this threshold, rclone requests a “tempLink”
which downloads the file through a temporary URL directly from the
underlying S3 storage.</p>
<p>Properties:</p>
<ul>
<li>Config: templink_threshold</li>
<li>Env Var: RCLONE_ACD_TEMPLINK_THRESHOLD</li>
<li>Type: SizeSuffix</li>
<li>Default: 9Gi</li>
</ul>
<h4 id="acd-encoding">–acd-encoding</h4>
<p>The encoding for the backend.</p>
<p>See the <a href="https://rclone.org/overview/#encoding">encoding
section in the overview</a> for more info.</p>
<p>Properties:</p>
<ul>
<li>Config: encoding</li>
<li>Env Var: RCLONE_ACD_ENCODING</li>
<li>Type: MultiEncoder</li>
<li>Default: Slash,InvalidUtf8,Dot</li>
</ul>
<h2 id="limitations-4">Limitations</h2>
<p>Note that Amazon Drive is case insensitive so you can’t have a file
called “Hello.doc” and one called “hello.doc”.</p>
<p>Amazon Drive has rate limiting so you may notice errors in the sync
(429 errors). rclone will automatically retry the sync up to 3 times by
default (see <code>--retries</code> flag) which should hopefully work
around this problem.</p>
<p>Amazon Drive has an internal limit of file sizes that can be uploaded
to the service. This limit is not officially published, but all files
larger than this will fail.</p>
<p>At the time of writing (Jan 2016) is in the area of 50 GiB per file.
This means that larger files are likely to fail.</p>
<p>Unfortunately there is no way for rclone to see that this failure is
because of file size, so it will retry the operation, as any other
failure. To avoid this problem, use <code>--max-size 50000M</code>
option to limit the maximum size of uploaded files. Note that
<code>--max-size</code> does not split files into segments, it only
ignores files over this size.</p>
<p><code>rclone about</code> is not supported by the Amazon Drive
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>
<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>
<h1 id="amazon-s3-storage-providers">Amazon S3 Storage Providers</h1>
<p>The S3 backend can be used with a number of different providers:</p>
<ul>
<li>AWS S3</li>
<li>Alibaba Cloud (Aliyun) Object Storage System (OSS)</li>
<li>Ceph</li>
<li>China Mobile Ecloud Elastic Object Storage (EOS)</li>
<li>Cloudflare R2</li>
<li>Arvan Cloud Object Storage (AOS)</li>
<li>DigitalOcean Spaces</li>
<li>Dreamhost</li>
<li>Huawei OBS</li>
<li>IBM COS S3</li>
<li>IDrive e2</li>
<li>IONOS Cloud</li>
<li>Minio</li>
<li>Qiniu Cloud Object Storage (Kodo)</li>
<li>RackCorp Object Storage</li>
<li>Scaleway</li>
<li>Seagate Lyve Cloud</li>
<li>SeaweedFS</li>
<li>StackPath</li>
<li>Storj</li>
<li>Tencent Cloud Object Storage (COS)</li>
<li>Wasabi</li>
</ul>
<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>
<p>Once you have made a remote (see the provider specific section above)
you can use it like this:</p>
<p>See all buckets</p>
<pre><code>rclone lsd remote:</code></pre>
<p>Make a new bucket</p>
<pre><code>rclone mkdir remote:bucket</code></pre>
<p>List the contents of a bucket</p>
<pre><code>rclone ls remote:bucket</code></pre>
<p>Sync <code>/home/local/directory</code> to the remote bucket,
deleting any excess files in the bucket.</p>
<pre><code>rclone sync -i /home/local/directory remote:bucket</code></pre>
<h2 id="configuration-3">Configuration</h2>
<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>
<p>First run</p>
<pre><code>rclone config</code></pre>
<p>This will guide you through an interactive setup process.</p>
<pre><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; remote
Type of storage to configure.
Choose a number from below, or type in your own value
[snip]
XX / Amazon S3 Compliant Storage Providers including AWS, Ceph, ChinaMobile, ArvanCloud, Dreamhost, IBM COS, Minio, and Tencent COS
   \ &quot;s3&quot;
[snip]
Storage&gt; s3
Choose your S3 provider.
Choose a number from below, or type in your own value
 1 / Amazon Web Services (AWS) S3
   \ &quot;AWS&quot;
 2 / Ceph Object Storage
   \ &quot;Ceph&quot;
 3 / Digital Ocean Spaces
   \ &quot;DigitalOcean&quot;
 4 / Dreamhost DreamObjects
   \ &quot;Dreamhost&quot;
 5 / IBM COS S3
   \ &quot;IBMCOS&quot;
 6 / Minio Object Storage
   \ &quot;Minio&quot;
 7 / Wasabi Object Storage
   \ &quot;Wasabi&quot;
 8 / Any other S3 compatible provider
   \ &quot;Other&quot;
provider&gt; 1
Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank.
Choose a number from below, or type in your own value
 1 / Enter AWS credentials in the next step
   \ &quot;false&quot;
 2 / Get AWS credentials from the environment (env vars or IAM)
   \ &quot;true&quot;
env_auth&gt; 1
AWS Access Key ID - leave blank for anonymous access or runtime credentials.
access_key_id&gt; XXX
AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials.
secret_access_key&gt; YYY
Region to connect to.
Choose a number from below, or type in your own value
   / The default endpoint - a good choice if you are unsure.
 1 | US Region, Northern Virginia, or Pacific Northwest.
   | Leave location constraint empty.
   \ &quot;us-east-1&quot;
   / US East (Ohio) Region
 2 | Needs location constraint us-east-2.
   \ &quot;us-east-2&quot;
   / US West (Oregon) Region
 3 | Needs location constraint us-west-2.
   \ &quot;us-west-2&quot;
   / US West (Northern California) Region
 4 | Needs location constraint us-west-1.
   \ &quot;us-west-1&quot;
   / Canada (Central) Region
 5 | Needs location constraint ca-central-1.
   \ &quot;ca-central-1&quot;
   / EU (Ireland) Region
 6 | Needs location constraint EU or eu-west-1.
   \ &quot;eu-west-1&quot;
   / EU (London) Region
 7 | Needs location constraint eu-west-2.
   \ &quot;eu-west-2&quot;
   / EU (Frankfurt) Region
 8 | Needs location constraint eu-central-1.
   \ &quot;eu-central-1&quot;
   / Asia Pacific (Singapore) Region
 9 | Needs location constraint ap-southeast-1.
   \ &quot;ap-southeast-1&quot;
   / Asia Pacific (Sydney) Region
10 | Needs location constraint ap-southeast-2.
   \ &quot;ap-southeast-2&quot;
   / Asia Pacific (Tokyo) Region
11 | Needs location constraint ap-northeast-1.
   \ &quot;ap-northeast-1&quot;
   / Asia Pacific (Seoul)
12 | Needs location constraint ap-northeast-2.
   \ &quot;ap-northeast-2&quot;
   / Asia Pacific (Mumbai)
13 | Needs location constraint ap-south-1.
   \ &quot;ap-south-1&quot;
   / Asia Pacific (Hong Kong) Region
14 | Needs location constraint ap-east-1.
   \ &quot;ap-east-1&quot;
   / South America (Sao Paulo) Region
15 | Needs location constraint sa-east-1.
   \ &quot;sa-east-1&quot;
region&gt; 1
Endpoint for S3 API.
Leave blank if using AWS to use the default endpoint for the region.
endpoint&gt;
Location constraint - must be set to match the Region. Used when creating buckets only.
Choose a number from below, or type in your own value
 1 / Empty for US Region, Northern Virginia, or Pacific Northwest.
   \ &quot;&quot;
 2 / US East (Ohio) Region.
   \ &quot;us-east-2&quot;
 3 / US West (Oregon) Region.
   \ &quot;us-west-2&quot;
 4 / US West (Northern California) Region.
   \ &quot;us-west-1&quot;
 5 / Canada (Central) Region.
   \ &quot;ca-central-1&quot;
 6 / EU (Ireland) Region.
   \ &quot;eu-west-1&quot;
 7 / EU (London) Region.
   \ &quot;eu-west-2&quot;
 8 / EU Region.
   \ &quot;EU&quot;
 9 / Asia Pacific (Singapore) Region.
   \ &quot;ap-southeast-1&quot;
10 / Asia Pacific (Sydney) Region.
   \ &quot;ap-southeast-2&quot;
11 / Asia Pacific (Tokyo) Region.
   \ &quot;ap-northeast-1&quot;
12 / Asia Pacific (Seoul)
   \ &quot;ap-northeast-2&quot;
13 / Asia Pacific (Mumbai)
   \ &quot;ap-south-1&quot;
14 / Asia Pacific (Hong Kong)
   \ &quot;ap-east-1&quot;
15 / South America (Sao Paulo) Region.
   \ &quot;sa-east-1&quot;
location_constraint&gt; 1
Canned ACL used when creating buckets and/or storing objects in S3.
For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl
Choose a number from below, or type in your own value
 1 / Owner gets FULL_CONTROL. No one else has access rights (default).
   \ &quot;private&quot;
 2 / Owner gets FULL_CONTROL. The AllUsers group gets READ access.
   \ &quot;public-read&quot;
   / Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access.
 3 | Granting this on a bucket is generally not recommended.
   \ &quot;public-read-write&quot;
 4 / Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access.
   \ &quot;authenticated-read&quot;
   / Object owner gets FULL_CONTROL. Bucket owner gets READ access.
 5 | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.
   \ &quot;bucket-owner-read&quot;
   / Both the object owner and the bucket owner get FULL_CONTROL over the object.
 6 | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.
   \ &quot;bucket-owner-full-control&quot;
acl&gt; 1
The server-side encryption algorithm used when storing this object in S3.
Choose a number from below, or type in your own value
 1 / None
   \ &quot;&quot;
 2 / AES256
   \ &quot;AES256&quot;
server_side_encryption&gt; 1
The storage class to use when storing objects in S3.
Choose a number from below, or type in your own value
 1 / Default
   \ &quot;&quot;
 2 / Standard storage class
   \ &quot;STANDARD&quot;
 3 / Reduced redundancy storage class
   \ &quot;REDUCED_REDUNDANCY&quot;
 4 / Standard Infrequent Access storage class
   \ &quot;STANDARD_IA&quot;
 5 / One Zone Infrequent Access storage class
   \ &quot;ONEZONE_IA&quot;
 6 / Glacier storage class
   \ &quot;GLACIER&quot;
 7 / Glacier Deep Archive storage class
   \ &quot;DEEP_ARCHIVE&quot;
 8 / Intelligent-Tiering storage class
   \ &quot;INTELLIGENT_TIERING&quot;
 9 / Glacier Instant Retrieval storage class
   \ &quot;GLACIER_IR&quot;
storage_class&gt; 1
Remote config
--------------------
[remote]
type = s3
provider = AWS
env_auth = false
access_key_id = XXX
secret_access_key = YYY
region = us-east-1
endpoint =
location_constraint =
acl = private
server_side_encryption =
storage_class =
--------------------
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d&gt;</code></pre>
<h3 id="modified-time">Modified time</h3>
<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>
<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>
<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>
<h3 id="reducing-costs">Reducing costs</h3>
<h4 id="avoiding-head-requests-to-read-the-modification-time">Avoiding
HEAD requests to read the modification time</h4>
<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>
<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>
<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>
<ul>
<li><code>--size-only</code>
<ul>
<li>Only checks the size of files.</li>
<li>Uses no extra transactions.</li>
<li>If the file doesn’t change size then rclone won’t detect it has
changed.</li>
<li><code>rclone sync --size-only /path/to/source s3:bucket</code></li>
</ul></li>
<li><code>--checksum</code>
<ul>
<li>Checks the size and MD5 checksum of files.</li>
<li>Uses no extra transactions.</li>
<li>The most accurate detection of changes possible.</li>
<li>Will cause the source to read an MD5 checksum which, if it is a
local disk, will cause lots of disk activity.</li>
<li>If the source and destination are both S3 this is the
<strong>recommended</strong> flag to use for maximum efficiency.</li>
<li><code>rclone sync --checksum /path/to/source s3:bucket</code></li>
</ul></li>
<li><code>--update --use-server-modtime</code>
<ul>
<li>Uses no extra transactions.</li>
<li>Modification time becomes the time the object was uploaded.</li>
<li>For many operations this is sufficient to determine if it needs
uploading.</li>
<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>
<li>Files created with timestamps in the past will be missed by the
sync.</li>
<li><code>rclone sync --update --use-server-modtime /path/to/source s3:bucket</code></li>
</ul></li>
</ul>
<p>These flags can and should be used in combination with
<code>--fast-list</code> - see below.</p>
<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>
<h4 id="avoiding-get-requests-to-read-directory-listings">Avoiding GET
requests to read directory listings</h4>
<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>
<pre><code>rclone sync --fast-list --checksum /path/to/source s3:bucket</code></pre>
<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>
<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>
<pre><code>rclone copy --max-age 24h --no-traverse /path/to/source s3:bucket</code></pre>
<p>You’d then do a full <code>rclone sync</code> less often.</p>
<p>Note that <code>--fast-list</code> isn’t required in the top-up
sync.</p>
<h4 id="avoiding-head-requests-after-put">Avoiding HEAD requests after
PUT</h4>
<p>By default, rclone will HEAD every object it uploads. It does this to
check the object got uploaded correctly.</p>
<p>You can disable this with the <a href="#s3-no-head">–s3-no-head</a>
option - see there for more details.</p>
<p>Setting this flag increases the chance for undetected upload
failures.</p>
<h3 id="hashes">Hashes</h3>
<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>
<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>).</p>
<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>
<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>
<h3 id="versions">Versions</h3>
<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>
<p>Old versions of files, where available, are visible using the <a
href="#s3-versions"><code>--s3-versions</code></a> flag.</p>
<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>
<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>
<p>When you <code>purge</code> a bucket, the current and the old
versions will be deleted then the bucket will be deleted.</p>
<p>However <code>delete</code> will cause the current versions of the
files to become hidden old versions.</p>
<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>
<p>Show current version and all the versions with
<code>--s3-versions</code> flag.</p>
<pre><code>$ rclone -q ls s3:cleanup-test
        9 one.txt

$ rclone -q --s3-versions ls s3:cleanup-test
        9 one.txt
        8 one-v2016-07-04-141032-000.txt
       16 one-v2016-07-04-141003-000.txt
       15 one-v2016-07-02-155621-000.txt</code></pre>
<p>Retrieve an old version</p>
<pre><code>$ rclone -q --s3-versions copy s3:cleanup-test/one-v2016-07-04-141003-000.txt /tmp

$ ls -l /tmp/one-v2016-07-04-141003-000.txt
-rw-rw-r-- 1 ncw ncw 16 Jul  2 17:46 /tmp/one-v2016-07-04-141003-000.txt</code></pre>
<p>Clean up all the old versions and show that they’ve gone.</p>
<pre><code>$ rclone -q backend cleanup-hidden s3:cleanup-test

$ rclone -q ls s3:cleanup-test
        9 one.txt

$ rclone -q --s3-versions ls s3:cleanup-test
        9 one.txt</code></pre>
<h3 id="cleanup-1">Cleanup</h3>
<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>-i</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>
<h3 id="restricted-filename-characters-2">Restricted filename
characters</h3>
<p>S3 allows any valid UTF-8 string as a key.</p>
<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>
<p>The following characters are replaced since these are problematic
when dealing with the REST API:</p>
<table>
<thead>
<tr class="header">
<th>Character</th>
<th style="text-align: center;">Value</th>
<th style="text-align: center;">Replacement</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>NUL</td>
<td style="text-align: center;">0x00</td>
<td style="text-align: center;">␀</td>
</tr>
<tr class="even">
<td>/</td>
<td style="text-align: center;">0x2F</td>
<td style="text-align: center;">／</td>
</tr>
</tbody>
</table>
<p>The encoding will also encode these file names as they don’t seem to
work with the SDK properly:</p>
<table>
<thead>
<tr class="header">
<th>File name</th>
<th style="text-align: center;">Replacement</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>.</td>
<td style="text-align: center;">．</td>
</tr>
<tr class="even">
<td>..</td>
<td style="text-align: center;">．．</td>
</tr>
</tbody>
</table>
<h3 id="multipart-uploads">Multipart uploads</h3>
<p>rclone supports multipart uploads with S3 which means that it can
upload files bigger than 5 GiB.</p>
<p>Note that files uploaded <em>both</em> with multipart upload
<em>and</em> through crypt remotes do not have MD5 sums.</p>
<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>
<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>
<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>
<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>
<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>
<h3 id="buckets-and-regions">Buckets and Regions</h3>
<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>
<h3 id="authentication-4">Authentication</h3>
<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>
<p>The different authentication methods are tried in this order:</p>
<ul>
<li>Directly in the rclone configuration file
(<code>env_auth = false</code> in the config file):
<ul>
<li><code>access_key_id</code> and <code>secret_access_key</code> are
required.</li>
<li><code>session_token</code> can be optionally set when using AWS
STS.</li>
</ul></li>
<li>Runtime configuration (<code>env_auth = true</code> in the config
file):
<ul>
<li>Export the following environment variables before running
<code>rclone</code>:
<ul>
<li>Access Key ID: <code>AWS_ACCESS_KEY_ID</code> or
<code>AWS_ACCESS_KEY</code></li>
<li>Secret Access Key: <code>AWS_SECRET_ACCESS_KEY</code> or
<code>AWS_SECRET_KEY</code></li>
<li>Session Token: <code>AWS_SESSION_TOKEN</code> (optional)</li>
</ul></li>
<li>Or, use a <a
href="https://docs.aws.amazon.com/cli/latest/userguide/cli-multiple-profiles.html">named
profile</a>:
<ul>
<li>Profile files are standard files used by AWS CLI tools</li>
<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:
<ul>
<li><code>AWS_SHARED_CREDENTIALS_FILE</code> to control which file.</li>
<li><code>AWS_PROFILE</code> to control which profile to use.</li>
</ul></li>
</ul></li>
<li>Or, run <code>rclone</code> in an ECS task with an IAM role (AWS
only).</li>
<li>Or, run <code>rclone</code> on an EC2 instance with an IAM role (AWS
only).</li>
<li>Or, run <code>rclone</code> in an EKS pod with an IAM role that is
associated with a service account (AWS only).</li>
</ul></li>
</ul>
<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>
<h3 id="s3-permissions">S3 Permissions</h3>
<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>
<ul>
<li><code>ListBucket</code></li>
<li><code>DeleteObject</code></li>
<li><code>GetObject</code></li>
<li><code>PutObject</code></li>
<li><code>PutObjectACL</code></li>
</ul>
<p>When using the <code>lsd</code> subcommand, the
<code>ListAllMyBuckets</code> permission is required.</p>
<p>Example policy:</p>
<pre><code>{
    &quot;Version&quot;: &quot;2012-10-17&quot;,
    &quot;Statement&quot;: [
        {
            &quot;Effect&quot;: &quot;Allow&quot;,
            &quot;Principal&quot;: {
                &quot;AWS&quot;: &quot;arn:aws:iam::USER_SID:user/USER_NAME&quot;
            },
            &quot;Action&quot;: [
                &quot;s3:ListBucket&quot;,
                &quot;s3:DeleteObject&quot;,
                &quot;s3:GetObject&quot;,
                &quot;s3:PutObject&quot;,
                &quot;s3:PutObjectAcl&quot;
            ],
            &quot;Resource&quot;: [
              &quot;arn:aws:s3:::BUCKET_NAME/*&quot;,
              &quot;arn:aws:s3:::BUCKET_NAME&quot;
            ]
        },
        {
            &quot;Effect&quot;: &quot;Allow&quot;,
            &quot;Action&quot;: &quot;s3:ListAllMyBuckets&quot;,
            &quot;Resource&quot;: &quot;arn:aws:s3:::*&quot;
        }
    ]
}</code></pre>
<p>Notes on above:</p>
<ol type="1">
<li>This is a policy that can be used when creating bucket. It assumes
that <code>USER_NAME</code> has been created.</li>
<li>The Resource entry must include both resource ARNs, as one implies
the bucket and the other implies the bucket’s objects.</li>
</ol>
<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>
<h3 id="key-management-system-kms">Key Management System (KMS)</h3>
<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>
<h3 id="glacier-and-glacier-deep-archive">Glacier and Glacier Deep
Archive</h3>
<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>
<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>
<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>
<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>
<h3 id="object-lock-enabled-s3-bucket">Object-lock enabled S3
bucket</h3>
<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>
<blockquote>
<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>
</blockquote>
<p>As mentioned in the <a href="#hashes">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>
<h3 id="standard-options-3">Standard options</h3>
<p>Here are the Standard options specific to s3 (Amazon S3 Compliant
Storage Providers including AWS, Alibaba, Ceph, China Mobile,
Cloudflare, ArvanCloud, Digital Ocean, Dreamhost, Huawei OBS, IBM COS,
IDrive e2, IONOS Cloud, Lyve Cloud, Minio, Netease, RackCorp, Scaleway,
SeaweedFS, StackPath, Storj, Tencent COS, Qiniu and Wasabi).</p>
<h4 id="s3-provider">–s3-provider</h4>
<p>Choose your S3 provider.</p>
<p>Properties:</p>
<ul>
<li>Config: provider</li>
<li>Env Var: RCLONE_S3_PROVIDER</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“AWS”
<ul>
<li>Amazon Web Services (AWS) S3</li>
</ul></li>
<li>“Alibaba”
<ul>
<li>Alibaba Cloud Object Storage System (OSS) formerly Aliyun</li>
</ul></li>
<li>“Ceph”
<ul>
<li>Ceph Object Storage</li>
</ul></li>
<li>“ChinaMobile”
<ul>
<li>China Mobile Ecloud Elastic Object Storage (EOS)</li>
</ul></li>
<li>“Cloudflare”
<ul>
<li>Cloudflare R2 Storage</li>
</ul></li>
<li>“ArvanCloud”
<ul>
<li>Arvan Cloud Object Storage (AOS)</li>
</ul></li>
<li>“DigitalOcean”
<ul>
<li>Digital Ocean Spaces</li>
</ul></li>
<li>“Dreamhost”
<ul>
<li>Dreamhost DreamObjects</li>
</ul></li>
<li>“HuaweiOBS”
<ul>
<li>Huawei Object Storage Service</li>
</ul></li>
<li>“IBMCOS”
<ul>
<li>IBM COS S3</li>
</ul></li>
<li>“IDrive”
<ul>
<li>IDrive e2</li>
</ul></li>
<li>“IONOS”
<ul>
<li>IONOS Cloud</li>
</ul></li>
<li>“LyveCloud”
<ul>
<li>Seagate Lyve Cloud</li>
</ul></li>
<li>“Minio”
<ul>
<li>Minio Object Storage</li>
</ul></li>
<li>“Netease”
<ul>
<li>Netease Object Storage (NOS)</li>
</ul></li>
<li>“RackCorp”
<ul>
<li>RackCorp Object Storage</li>
</ul></li>
<li>“Scaleway”
<ul>
<li>Scaleway Object Storage</li>
</ul></li>
<li>“SeaweedFS”
<ul>
<li>SeaweedFS S3</li>
</ul></li>
<li>“StackPath”
<ul>
<li>StackPath Object Storage</li>
</ul></li>
<li>“Storj”
<ul>
<li>Storj (S3 Compatible Gateway)</li>
</ul></li>
<li>“TencentCOS”
<ul>
<li>Tencent Cloud Object Storage (COS)</li>
</ul></li>
<li>“Wasabi”
<ul>
<li>Wasabi Object Storage</li>
</ul></li>
<li>“Qiniu”
<ul>
<li>Qiniu Object Storage (Kodo)</li>
</ul></li>
<li>“Other”
<ul>
<li>Any other S3 compatible provider</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-env-auth">–s3-env-auth</h4>
<p>Get AWS credentials from runtime (environment variables or EC2/ECS
meta data if no env vars).</p>
<p>Only applies if access_key_id and secret_access_key is blank.</p>
<p>Properties:</p>
<ul>
<li>Config: env_auth</li>
<li>Env Var: RCLONE_S3_ENV_AUTH</li>
<li>Type: bool</li>
<li>Default: false</li>
<li>Examples:
<ul>
<li>“false”
<ul>
<li>Enter AWS credentials in the next step.</li>
</ul></li>
<li>“true”
<ul>
<li>Get AWS credentials from the environment (env vars or IAM).</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-access-key-id">–s3-access-key-id</h4>
<p>AWS Access Key ID.</p>
<p>Leave blank for anonymous access or runtime credentials.</p>
<p>Properties:</p>
<ul>
<li>Config: access_key_id</li>
<li>Env Var: RCLONE_S3_ACCESS_KEY_ID</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="s3-secret-access-key">–s3-secret-access-key</h4>
<p>AWS Secret Access Key (password).</p>
<p>Leave blank for anonymous access or runtime credentials.</p>
<p>Properties:</p>
<ul>
<li>Config: secret_access_key</li>
<li>Env Var: RCLONE_S3_SECRET_ACCESS_KEY</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="s3-region">–s3-region</h4>
<p>Region to connect to.</p>
<p>Properties:</p>
<ul>
<li>Config: region</li>
<li>Env Var: RCLONE_S3_REGION</li>
<li>Provider: AWS</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“us-east-1”
<ul>
<li>The default endpoint - a good choice if you are unsure.</li>
<li>US Region, Northern Virginia, or Pacific Northwest.</li>
<li>Leave location constraint empty.</li>
</ul></li>
<li>“us-east-2”
<ul>
<li>US East (Ohio) Region.</li>
<li>Needs location constraint us-east-2.</li>
</ul></li>
<li>“us-west-1”
<ul>
<li>US West (Northern California) Region.</li>
<li>Needs location constraint us-west-1.</li>
</ul></li>
<li>“us-west-2”
<ul>
<li>US West (Oregon) Region.</li>
<li>Needs location constraint us-west-2.</li>
</ul></li>
<li>“ca-central-1”
<ul>
<li>Canada (Central) Region.</li>
<li>Needs location constraint ca-central-1.</li>
</ul></li>
<li>“eu-west-1”
<ul>
<li>EU (Ireland) Region.</li>
<li>Needs location constraint EU or eu-west-1.</li>
</ul></li>
<li>“eu-west-2”
<ul>
<li>EU (London) Region.</li>
<li>Needs location constraint eu-west-2.</li>
</ul></li>
<li>“eu-west-3”
<ul>
<li>EU (Paris) Region.</li>
<li>Needs location constraint eu-west-3.</li>
</ul></li>
<li>“eu-north-1”
<ul>
<li>EU (Stockholm) Region.</li>
<li>Needs location constraint eu-north-1.</li>
</ul></li>
<li>“eu-south-1”
<ul>
<li>EU (Milan) Region.</li>
<li>Needs location constraint eu-south-1.</li>
</ul></li>
<li>“eu-central-1”
<ul>
<li>EU (Frankfurt) Region.</li>
<li>Needs location constraint eu-central-1.</li>
</ul></li>
<li>“ap-southeast-1”
<ul>
<li>Asia Pacific (Singapore) Region.</li>
<li>Needs location constraint ap-southeast-1.</li>
</ul></li>
<li>“ap-southeast-2”
<ul>
<li>Asia Pacific (Sydney) Region.</li>
<li>Needs location constraint ap-southeast-2.</li>
</ul></li>
<li>“ap-northeast-1”
<ul>
<li>Asia Pacific (Tokyo) Region.</li>
<li>Needs location constraint ap-northeast-1.</li>
</ul></li>
<li>“ap-northeast-2”
<ul>
<li>Asia Pacific (Seoul).</li>
<li>Needs location constraint ap-northeast-2.</li>
</ul></li>
<li>“ap-northeast-3”
<ul>
<li>Asia Pacific (Osaka-Local).</li>
<li>Needs location constraint ap-northeast-3.</li>
</ul></li>
<li>“ap-south-1”
<ul>
<li>Asia Pacific (Mumbai).</li>
<li>Needs location constraint ap-south-1.</li>
</ul></li>
<li>“ap-east-1”
<ul>
<li>Asia Pacific (Hong Kong) Region.</li>
<li>Needs location constraint ap-east-1.</li>
</ul></li>
<li>“sa-east-1”
<ul>
<li>South America (Sao Paulo) Region.</li>
<li>Needs location constraint sa-east-1.</li>
</ul></li>
<li>“me-south-1”
<ul>
<li>Middle East (Bahrain) Region.</li>
<li>Needs location constraint me-south-1.</li>
</ul></li>
<li>“af-south-1”
<ul>
<li>Africa (Cape Town) Region.</li>
<li>Needs location constraint af-south-1.</li>
</ul></li>
<li>“cn-north-1”
<ul>
<li>China (Beijing) Region.</li>
<li>Needs location constraint cn-north-1.</li>
</ul></li>
<li>“cn-northwest-1”
<ul>
<li>China (Ningxia) Region.</li>
<li>Needs location constraint cn-northwest-1.</li>
</ul></li>
<li>“us-gov-east-1”
<ul>
<li>AWS GovCloud (US-East) Region.</li>
<li>Needs location constraint us-gov-east-1.</li>
</ul></li>
<li>“us-gov-west-1”
<ul>
<li>AWS GovCloud (US) Region.</li>
<li>Needs location constraint us-gov-west-1.</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-region-1">–s3-region</h4>
<p>region - the location where your bucket will be created and your data
stored.</p>
<p>Properties:</p>
<ul>
<li>Config: region</li>
<li>Env Var: RCLONE_S3_REGION</li>
<li>Provider: RackCorp</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“global”
<ul>
<li>Global CDN (All locations) Region</li>
</ul></li>
<li>“au”
<ul>
<li>Australia (All states)</li>
</ul></li>
<li>“au-nsw”
<ul>
<li>NSW (Australia) Region</li>
</ul></li>
<li>“au-qld”
<ul>
<li>QLD (Australia) Region</li>
</ul></li>
<li>“au-vic”
<ul>
<li>VIC (Australia) Region</li>
</ul></li>
<li>“au-wa”
<ul>
<li>Perth (Australia) Region</li>
</ul></li>
<li>“ph”
<ul>
<li>Manila (Philippines) Region</li>
</ul></li>
<li>“th”
<ul>
<li>Bangkok (Thailand) Region</li>
</ul></li>
<li>“hk”
<ul>
<li>HK (Hong Kong) Region</li>
</ul></li>
<li>“mn”
<ul>
<li>Ulaanbaatar (Mongolia) Region</li>
</ul></li>
<li>“kg”
<ul>
<li>Bishkek (Kyrgyzstan) Region</li>
</ul></li>
<li>“id”
<ul>
<li>Jakarta (Indonesia) Region</li>
</ul></li>
<li>“jp”
<ul>
<li>Tokyo (Japan) Region</li>
</ul></li>
<li>“sg”
<ul>
<li>SG (Singapore) Region</li>
</ul></li>
<li>“de”
<ul>
<li>Frankfurt (Germany) Region</li>
</ul></li>
<li>“us”
<ul>
<li>USA (AnyCast) Region</li>
</ul></li>
<li>“us-east-1”
<ul>
<li>New York (USA) Region</li>
</ul></li>
<li>“us-west-1”
<ul>
<li>Freemont (USA) Region</li>
</ul></li>
<li>“nz”
<ul>
<li>Auckland (New Zealand) Region</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-region-2">–s3-region</h4>
<p>Region to connect to.</p>
<p>Properties:</p>
<ul>
<li>Config: region</li>
<li>Env Var: RCLONE_S3_REGION</li>
<li>Provider: Scaleway</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“nl-ams”
<ul>
<li>Amsterdam, The Netherlands</li>
</ul></li>
<li>“fr-par”
<ul>
<li>Paris, France</li>
</ul></li>
<li>“pl-waw”
<ul>
<li>Warsaw, Poland</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-region-3">–s3-region</h4>
<p>Region to connect to. - the location where your bucket will be
created and your data stored. Need bo be same with your endpoint.</p>
<p>Properties:</p>
<ul>
<li>Config: region</li>
<li>Env Var: RCLONE_S3_REGION</li>
<li>Provider: HuaweiOBS</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“af-south-1”
<ul>
<li>AF-Johannesburg</li>
</ul></li>
<li>“ap-southeast-2”
<ul>
<li>AP-Bangkok</li>
</ul></li>
<li>“ap-southeast-3”
<ul>
<li>AP-Singapore</li>
</ul></li>
<li>“cn-east-3”
<ul>
<li>CN East-Shanghai1</li>
</ul></li>
<li>“cn-east-2”
<ul>
<li>CN East-Shanghai2</li>
</ul></li>
<li>“cn-north-1”
<ul>
<li>CN North-Beijing1</li>
</ul></li>
<li>“cn-north-4”
<ul>
<li>CN North-Beijing4</li>
</ul></li>
<li>“cn-south-1”
<ul>
<li>CN South-Guangzhou</li>
</ul></li>
<li>“ap-southeast-1”
<ul>
<li>CN-Hong Kong</li>
</ul></li>
<li>“sa-argentina-1”
<ul>
<li>LA-Buenos Aires1</li>
</ul></li>
<li>“sa-peru-1”
<ul>
<li>LA-Lima1</li>
</ul></li>
<li>“na-mexico-1”
<ul>
<li>LA-Mexico City1</li>
</ul></li>
<li>“sa-chile-1”
<ul>
<li>LA-Santiago2</li>
</ul></li>
<li>“sa-brazil-1”
<ul>
<li>LA-Sao Paulo1</li>
</ul></li>
<li>“ru-northwest-2”
<ul>
<li>RU-Moscow2</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-region-4">–s3-region</h4>
<p>Region to connect to.</p>
<p>Properties:</p>
<ul>
<li>Config: region</li>
<li>Env Var: RCLONE_S3_REGION</li>
<li>Provider: Cloudflare</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“auto”
<ul>
<li>R2 buckets are automatically distributed across Cloudflare’s data
centers for low latency.</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-region-5">–s3-region</h4>
<p>Region to connect to.</p>
<p>Properties:</p>
<ul>
<li>Config: region</li>
<li>Env Var: RCLONE_S3_REGION</li>
<li>Provider: Qiniu</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“cn-east-1”
<ul>
<li>The default endpoint - a good choice if you are unsure.</li>
<li>East China Region 1.</li>
<li>Needs location constraint cn-east-1.</li>
</ul></li>
<li>“cn-east-2”
<ul>
<li>East China Region 2.</li>
<li>Needs location constraint cn-east-2.</li>
</ul></li>
<li>“cn-north-1”
<ul>
<li>North China Region 1.</li>
<li>Needs location constraint cn-north-1.</li>
</ul></li>
<li>“cn-south-1”
<ul>
<li>South China Region 1.</li>
<li>Needs location constraint cn-south-1.</li>
</ul></li>
<li>“us-north-1”
<ul>
<li>North America Region.</li>
<li>Needs location constraint us-north-1.</li>
</ul></li>
<li>“ap-southeast-1”
<ul>
<li>Southeast Asia Region 1.</li>
<li>Needs location constraint ap-southeast-1.</li>
</ul></li>
<li>“ap-northeast-1”
<ul>
<li>Northeast Asia Region 1.</li>
<li>Needs location constraint ap-northeast-1.</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-region-6">–s3-region</h4>
<p>Region where your bucket will be created and your data stored.</p>
<p>Properties:</p>
<ul>
<li>Config: region</li>
<li>Env Var: RCLONE_S3_REGION</li>
<li>Provider: IONOS</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“de”
<ul>
<li>Frankfurt, Germany</li>
</ul></li>
<li>“eu-central-2”
<ul>
<li>Berlin, Germany</li>
</ul></li>
<li>“eu-south-2”
<ul>
<li>Logrono, Spain</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-region-7">–s3-region</h4>
<p>Region to connect to.</p>
<p>Leave blank if you are using an S3 clone and you don’t have a
region.</p>
<p>Properties:</p>
<ul>
<li>Config: region</li>
<li>Env Var: RCLONE_S3_REGION</li>
<li>Provider:
!AWS,Alibaba,ChinaMobile,Cloudflare,IONOS,ArvanCloud,Qiniu,RackCorp,Scaleway,Storj,TencentCOS,HuaweiOBS,IDrive</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“”
<ul>
<li>Use this if unsure.</li>
<li>Will use v4 signatures and an empty region.</li>
</ul></li>
<li>“other-v2-signature”
<ul>
<li>Use this only if v4 signatures don’t work.</li>
<li>E.g. pre Jewel/v10 CEPH.</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-endpoint">–s3-endpoint</h4>
<p>Endpoint for S3 API.</p>
<p>Leave blank if using AWS to use the default endpoint for the
region.</p>
<p>Properties:</p>
<ul>
<li>Config: endpoint</li>
<li>Env Var: RCLONE_S3_ENDPOINT</li>
<li>Provider: AWS</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="s3-endpoint-1">–s3-endpoint</h4>
<p>Endpoint for China Mobile Ecloud Elastic Object Storage (EOS)
API.</p>
<p>Properties:</p>
<ul>
<li>Config: endpoint</li>
<li>Env Var: RCLONE_S3_ENDPOINT</li>
<li>Provider: ChinaMobile</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“eos-wuxi-1.cmecloud.cn”
<ul>
<li>The default endpoint - a good choice if you are unsure.</li>
<li>East China (Suzhou)</li>
</ul></li>
<li>“eos-jinan-1.cmecloud.cn”
<ul>
<li>East China (Jinan)</li>
</ul></li>
<li>“eos-ningbo-1.cmecloud.cn”
<ul>
<li>East China (Hangzhou)</li>
</ul></li>
<li>“eos-shanghai-1.cmecloud.cn”
<ul>
<li>East China (Shanghai-1)</li>
</ul></li>
<li>“eos-zhengzhou-1.cmecloud.cn”
<ul>
<li>Central China (Zhengzhou)</li>
</ul></li>
<li>“eos-hunan-1.cmecloud.cn”
<ul>
<li>Central China (Changsha-1)</li>
</ul></li>
<li>“eos-zhuzhou-1.cmecloud.cn”
<ul>
<li>Central China (Changsha-2)</li>
</ul></li>
<li>“eos-guangzhou-1.cmecloud.cn”
<ul>
<li>South China (Guangzhou-2)</li>
</ul></li>
<li>“eos-dongguan-1.cmecloud.cn”
<ul>
<li>South China (Guangzhou-3)</li>
</ul></li>
<li>“eos-beijing-1.cmecloud.cn”
<ul>
<li>North China (Beijing-1)</li>
</ul></li>
<li>“eos-beijing-2.cmecloud.cn”
<ul>
<li>North China (Beijing-2)</li>
</ul></li>
<li>“eos-beijing-4.cmecloud.cn”
<ul>
<li>North China (Beijing-3)</li>
</ul></li>
<li>“eos-huhehaote-1.cmecloud.cn”
<ul>
<li>North China (Huhehaote)</li>
</ul></li>
<li>“eos-chengdu-1.cmecloud.cn”
<ul>
<li>Southwest China (Chengdu)</li>
</ul></li>
<li>“eos-chongqing-1.cmecloud.cn”
<ul>
<li>Southwest China (Chongqing)</li>
</ul></li>
<li>“eos-guiyang-1.cmecloud.cn”
<ul>
<li>Southwest China (Guiyang)</li>
</ul></li>
<li>“eos-xian-1.cmecloud.cn”
<ul>
<li>Nouthwest China (Xian)</li>
</ul></li>
<li>“eos-yunnan.cmecloud.cn”
<ul>
<li>Yunnan China (Kunming)</li>
</ul></li>
<li>“eos-yunnan-2.cmecloud.cn”
<ul>
<li>Yunnan China (Kunming-2)</li>
</ul></li>
<li>“eos-tianjin-1.cmecloud.cn”
<ul>
<li>Tianjin China (Tianjin)</li>
</ul></li>
<li>“eos-jilin-1.cmecloud.cn”
<ul>
<li>Jilin China (Changchun)</li>
</ul></li>
<li>“eos-hubei-1.cmecloud.cn”
<ul>
<li>Hubei China (Xiangyan)</li>
</ul></li>
<li>“eos-jiangxi-1.cmecloud.cn”
<ul>
<li>Jiangxi China (Nanchang)</li>
</ul></li>
<li>“eos-gansu-1.cmecloud.cn”
<ul>
<li>Gansu China (Lanzhou)</li>
</ul></li>
<li>“eos-shanxi-1.cmecloud.cn”
<ul>
<li>Shanxi China (Taiyuan)</li>
</ul></li>
<li>“eos-liaoning-1.cmecloud.cn”
<ul>
<li>Liaoning China (Shenyang)</li>
</ul></li>
<li>“eos-hebei-1.cmecloud.cn”
<ul>
<li>Hebei China (Shijiazhuang)</li>
</ul></li>
<li>“eos-fujian-1.cmecloud.cn”
<ul>
<li>Fujian China (Xiamen)</li>
</ul></li>
<li>“eos-guangxi-1.cmecloud.cn”
<ul>
<li>Guangxi China (Nanning)</li>
</ul></li>
<li>“eos-anhui-1.cmecloud.cn”
<ul>
<li>Anhui China (Huainan)</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-endpoint-2">–s3-endpoint</h4>
<p>Endpoint for Arvan Cloud Object Storage (AOS) API.</p>
<p>Properties:</p>
<ul>
<li>Config: endpoint</li>
<li>Env Var: RCLONE_S3_ENDPOINT</li>
<li>Provider: ArvanCloud</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“s3.ir-thr-at1.arvanstorage.com”
<ul>
<li>The default endpoint - a good choice if you are unsure.</li>
<li>Tehran Iran (Asiatech)</li>
</ul></li>
<li>“s3.ir-tbz-sh1.arvanstorage.com”
<ul>
<li>Tabriz Iran (Shahriar)</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-endpoint-3">–s3-endpoint</h4>
<p>Endpoint for IBM COS S3 API.</p>
<p>Specify if using an IBM COS On Premise.</p>
<p>Properties:</p>
<ul>
<li>Config: endpoint</li>
<li>Env Var: RCLONE_S3_ENDPOINT</li>
<li>Provider: IBMCOS</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“s3.us.cloud-object-storage.appdomain.cloud”
<ul>
<li>US Cross Region Endpoint</li>
</ul></li>
<li>“s3.dal.us.cloud-object-storage.appdomain.cloud”
<ul>
<li>US Cross Region Dallas Endpoint</li>
</ul></li>
<li>“s3.wdc.us.cloud-object-storage.appdomain.cloud”
<ul>
<li>US Cross Region Washington DC Endpoint</li>
</ul></li>
<li>“s3.sjc.us.cloud-object-storage.appdomain.cloud”
<ul>
<li>US Cross Region San Jose Endpoint</li>
</ul></li>
<li>“s3.private.us.cloud-object-storage.appdomain.cloud”
<ul>
<li>US Cross Region Private Endpoint</li>
</ul></li>
<li>“s3.private.dal.us.cloud-object-storage.appdomain.cloud”
<ul>
<li>US Cross Region Dallas Private Endpoint</li>
</ul></li>
<li>“s3.private.wdc.us.cloud-object-storage.appdomain.cloud”
<ul>
<li>US Cross Region Washington DC Private Endpoint</li>
</ul></li>
<li>“s3.private.sjc.us.cloud-object-storage.appdomain.cloud”
<ul>
<li>US Cross Region San Jose Private Endpoint</li>
</ul></li>
<li>“s3.us-east.cloud-object-storage.appdomain.cloud”
<ul>
<li>US Region East Endpoint</li>
</ul></li>
<li>“s3.private.us-east.cloud-object-storage.appdomain.cloud”
<ul>
<li>US Region East Private Endpoint</li>
</ul></li>
<li>“s3.us-south.cloud-object-storage.appdomain.cloud”
<ul>
<li>US Region South Endpoint</li>
</ul></li>
<li>“s3.private.us-south.cloud-object-storage.appdomain.cloud”
<ul>
<li>US Region South Private Endpoint</li>
</ul></li>
<li>“s3.eu.cloud-object-storage.appdomain.cloud”
<ul>
<li>EU Cross Region Endpoint</li>
</ul></li>
<li>“s3.fra.eu.cloud-object-storage.appdomain.cloud”
<ul>
<li>EU Cross Region Frankfurt Endpoint</li>
</ul></li>
<li>“s3.mil.eu.cloud-object-storage.appdomain.cloud”
<ul>
<li>EU Cross Region Milan Endpoint</li>
</ul></li>
<li>“s3.ams.eu.cloud-object-storage.appdomain.cloud”
<ul>
<li>EU Cross Region Amsterdam Endpoint</li>
</ul></li>
<li>“s3.private.eu.cloud-object-storage.appdomain.cloud”
<ul>
<li>EU Cross Region Private Endpoint</li>
</ul></li>
<li>“s3.private.fra.eu.cloud-object-storage.appdomain.cloud”
<ul>
<li>EU Cross Region Frankfurt Private Endpoint</li>
</ul></li>
<li>“s3.private.mil.eu.cloud-object-storage.appdomain.cloud”
<ul>
<li>EU Cross Region Milan Private Endpoint</li>
</ul></li>
<li>“s3.private.ams.eu.cloud-object-storage.appdomain.cloud”
<ul>
<li>EU Cross Region Amsterdam Private Endpoint</li>
</ul></li>
<li>“s3.eu-gb.cloud-object-storage.appdomain.cloud”
<ul>
<li>Great Britain Endpoint</li>
</ul></li>
<li>“s3.private.eu-gb.cloud-object-storage.appdomain.cloud”
<ul>
<li>Great Britain Private Endpoint</li>
</ul></li>
<li>“s3.eu-de.cloud-object-storage.appdomain.cloud”
<ul>
<li>EU Region DE Endpoint</li>
</ul></li>
<li>“s3.private.eu-de.cloud-object-storage.appdomain.cloud”
<ul>
<li>EU Region DE Private Endpoint</li>
</ul></li>
<li>“s3.ap.cloud-object-storage.appdomain.cloud”
<ul>
<li>APAC Cross Regional Endpoint</li>
</ul></li>
<li>“s3.tok.ap.cloud-object-storage.appdomain.cloud”
<ul>
<li>APAC Cross Regional Tokyo Endpoint</li>
</ul></li>
<li>“s3.hkg.ap.cloud-object-storage.appdomain.cloud”
<ul>
<li>APAC Cross Regional HongKong Endpoint</li>
</ul></li>
<li>“s3.seo.ap.cloud-object-storage.appdomain.cloud”
<ul>
<li>APAC Cross Regional Seoul Endpoint</li>
</ul></li>
<li>“s3.private.ap.cloud-object-storage.appdomain.cloud”
<ul>
<li>APAC Cross Regional Private Endpoint</li>
</ul></li>
<li>“s3.private.tok.ap.cloud-object-storage.appdomain.cloud”
<ul>
<li>APAC Cross Regional Tokyo Private Endpoint</li>
</ul></li>
<li>“s3.private.hkg.ap.cloud-object-storage.appdomain.cloud”
<ul>
<li>APAC Cross Regional HongKong Private Endpoint</li>
</ul></li>
<li>“s3.private.seo.ap.cloud-object-storage.appdomain.cloud”
<ul>
<li>APAC Cross Regional Seoul Private Endpoint</li>
</ul></li>
<li>“s3.jp-tok.cloud-object-storage.appdomain.cloud”
<ul>
<li>APAC Region Japan Endpoint</li>
</ul></li>
<li>“s3.private.jp-tok.cloud-object-storage.appdomain.cloud”
<ul>
<li>APAC Region Japan Private Endpoint</li>
</ul></li>
<li>“s3.au-syd.cloud-object-storage.appdomain.cloud”
<ul>
<li>APAC Region Australia Endpoint</li>
</ul></li>
<li>“s3.private.au-syd.cloud-object-storage.appdomain.cloud”
<ul>
<li>APAC Region Australia Private Endpoint</li>
</ul></li>
<li>“s3.ams03.cloud-object-storage.appdomain.cloud”
<ul>
<li>Amsterdam Single Site Endpoint</li>
</ul></li>
<li>“s3.private.ams03.cloud-object-storage.appdomain.cloud”
<ul>
<li>Amsterdam Single Site Private Endpoint</li>
</ul></li>
<li>“s3.che01.cloud-object-storage.appdomain.cloud”
<ul>
<li>Chennai Single Site Endpoint</li>
</ul></li>
<li>“s3.private.che01.cloud-object-storage.appdomain.cloud”
<ul>
<li>Chennai Single Site Private Endpoint</li>
</ul></li>
<li>“s3.mel01.cloud-object-storage.appdomain.cloud”
<ul>
<li>Melbourne Single Site Endpoint</li>
</ul></li>
<li>“s3.private.mel01.cloud-object-storage.appdomain.cloud”
<ul>
<li>Melbourne Single Site Private Endpoint</li>
</ul></li>
<li>“s3.osl01.cloud-object-storage.appdomain.cloud”
<ul>
<li>Oslo Single Site Endpoint</li>
</ul></li>
<li>“s3.private.osl01.cloud-object-storage.appdomain.cloud”
<ul>
<li>Oslo Single Site Private Endpoint</li>
</ul></li>
<li>“s3.tor01.cloud-object-storage.appdomain.cloud”
<ul>
<li>Toronto Single Site Endpoint</li>
</ul></li>
<li>“s3.private.tor01.cloud-object-storage.appdomain.cloud”
<ul>
<li>Toronto Single Site Private Endpoint</li>
</ul></li>
<li>“s3.seo01.cloud-object-storage.appdomain.cloud”
<ul>
<li>Seoul Single Site Endpoint</li>
</ul></li>
<li>“s3.private.seo01.cloud-object-storage.appdomain.cloud”
<ul>
<li>Seoul Single Site Private Endpoint</li>
</ul></li>
<li>“s3.mon01.cloud-object-storage.appdomain.cloud”
<ul>
<li>Montreal Single Site Endpoint</li>
</ul></li>
<li>“s3.private.mon01.cloud-object-storage.appdomain.cloud”
<ul>
<li>Montreal Single Site Private Endpoint</li>
</ul></li>
<li>“s3.mex01.cloud-object-storage.appdomain.cloud”
<ul>
<li>Mexico Single Site Endpoint</li>
</ul></li>
<li>“s3.private.mex01.cloud-object-storage.appdomain.cloud”
<ul>
<li>Mexico Single Site Private Endpoint</li>
</ul></li>
<li>“s3.sjc04.cloud-object-storage.appdomain.cloud”
<ul>
<li>San Jose Single Site Endpoint</li>
</ul></li>
<li>“s3.private.sjc04.cloud-object-storage.appdomain.cloud”
<ul>
<li>San Jose Single Site Private Endpoint</li>
</ul></li>
<li>“s3.mil01.cloud-object-storage.appdomain.cloud”
<ul>
<li>Milan Single Site Endpoint</li>
</ul></li>
<li>“s3.private.mil01.cloud-object-storage.appdomain.cloud”
<ul>
<li>Milan Single Site Private Endpoint</li>
</ul></li>
<li>“s3.hkg02.cloud-object-storage.appdomain.cloud”
<ul>
<li>Hong Kong Single Site Endpoint</li>
</ul></li>
<li>“s3.private.hkg02.cloud-object-storage.appdomain.cloud”
<ul>
<li>Hong Kong Single Site Private Endpoint</li>
</ul></li>
<li>“s3.par01.cloud-object-storage.appdomain.cloud”
<ul>
<li>Paris Single Site Endpoint</li>
</ul></li>
<li>“s3.private.par01.cloud-object-storage.appdomain.cloud”
<ul>
<li>Paris Single Site Private Endpoint</li>
</ul></li>
<li>“s3.sng01.cloud-object-storage.appdomain.cloud”
<ul>
<li>Singapore Single Site Endpoint</li>
</ul></li>
<li>“s3.private.sng01.cloud-object-storage.appdomain.cloud”
<ul>
<li>Singapore Single Site Private Endpoint</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-endpoint-4">–s3-endpoint</h4>
<p>Endpoint for IONOS S3 Object Storage.</p>
<p>Specify the endpoint from the same region.</p>
<p>Properties:</p>
<ul>
<li>Config: endpoint</li>
<li>Env Var: RCLONE_S3_ENDPOINT</li>
<li>Provider: IONOS</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“s3-eu-central-1.ionoscloud.com”
<ul>
<li>Frankfurt, Germany</li>
</ul></li>
<li>“s3-eu-central-2.ionoscloud.com”
<ul>
<li>Berlin, Germany</li>
</ul></li>
<li>“s3-eu-south-2.ionoscloud.com”
<ul>
<li>Logrono, Spain</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-endpoint-5">–s3-endpoint</h4>
<p>Endpoint for OSS API.</p>
<p>Properties:</p>
<ul>
<li>Config: endpoint</li>
<li>Env Var: RCLONE_S3_ENDPOINT</li>
<li>Provider: Alibaba</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“oss-accelerate.aliyuncs.com”
<ul>
<li>Global Accelerate</li>
</ul></li>
<li>“oss-accelerate-overseas.aliyuncs.com”
<ul>
<li>Global Accelerate (outside mainland China)</li>
</ul></li>
<li>“oss-cn-hangzhou.aliyuncs.com”
<ul>
<li>East China 1 (Hangzhou)</li>
</ul></li>
<li>“oss-cn-shanghai.aliyuncs.com”
<ul>
<li>East China 2 (Shanghai)</li>
</ul></li>
<li>“oss-cn-qingdao.aliyuncs.com”
<ul>
<li>North China 1 (Qingdao)</li>
</ul></li>
<li>“oss-cn-beijing.aliyuncs.com”
<ul>
<li>North China 2 (Beijing)</li>
</ul></li>
<li>“oss-cn-zhangjiakou.aliyuncs.com”
<ul>
<li>North China 3 (Zhangjiakou)</li>
</ul></li>
<li>“oss-cn-huhehaote.aliyuncs.com”
<ul>
<li>North China 5 (Hohhot)</li>
</ul></li>
<li>“oss-cn-wulanchabu.aliyuncs.com”
<ul>
<li>North China 6 (Ulanqab)</li>
</ul></li>
<li>“oss-cn-shenzhen.aliyuncs.com”
<ul>
<li>South China 1 (Shenzhen)</li>
</ul></li>
<li>“oss-cn-heyuan.aliyuncs.com”
<ul>
<li>South China 2 (Heyuan)</li>
</ul></li>
<li>“oss-cn-guangzhou.aliyuncs.com”
<ul>
<li>South China 3 (Guangzhou)</li>
</ul></li>
<li>“oss-cn-chengdu.aliyuncs.com”
<ul>
<li>West China 1 (Chengdu)</li>
</ul></li>
<li>“oss-cn-hongkong.aliyuncs.com”
<ul>
<li>Hong Kong (Hong Kong)</li>
</ul></li>
<li>“oss-us-west-1.aliyuncs.com”
<ul>
<li>US West 1 (Silicon Valley)</li>
</ul></li>
<li>“oss-us-east-1.aliyuncs.com”
<ul>
<li>US East 1 (Virginia)</li>
</ul></li>
<li>“oss-ap-southeast-1.aliyuncs.com”
<ul>
<li>Southeast Asia Southeast 1 (Singapore)</li>
</ul></li>
<li>“oss-ap-southeast-2.aliyuncs.com”
<ul>
<li>Asia Pacific Southeast 2 (Sydney)</li>
</ul></li>
<li>“oss-ap-southeast-3.aliyuncs.com”
<ul>
<li>Southeast Asia Southeast 3 (Kuala Lumpur)</li>
</ul></li>
<li>“oss-ap-southeast-5.aliyuncs.com”
<ul>
<li>Asia Pacific Southeast 5 (Jakarta)</li>
</ul></li>
<li>“oss-ap-northeast-1.aliyuncs.com”
<ul>
<li>Asia Pacific Northeast 1 (Japan)</li>
</ul></li>
<li>“oss-ap-south-1.aliyuncs.com”
<ul>
<li>Asia Pacific South 1 (Mumbai)</li>
</ul></li>
<li>“oss-eu-central-1.aliyuncs.com”
<ul>
<li>Central Europe 1 (Frankfurt)</li>
</ul></li>
<li>“oss-eu-west-1.aliyuncs.com”
<ul>
<li>West Europe (London)</li>
</ul></li>
<li>“oss-me-east-1.aliyuncs.com”
<ul>
<li>Middle East 1 (Dubai)</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-endpoint-6">–s3-endpoint</h4>
<p>Endpoint for OBS API.</p>
<p>Properties:</p>
<ul>
<li>Config: endpoint</li>
<li>Env Var: RCLONE_S3_ENDPOINT</li>
<li>Provider: HuaweiOBS</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“obs.af-south-1.myhuaweicloud.com”
<ul>
<li>AF-Johannesburg</li>
</ul></li>
<li>“obs.ap-southeast-2.myhuaweicloud.com”
<ul>
<li>AP-Bangkok</li>
</ul></li>
<li>“obs.ap-southeast-3.myhuaweicloud.com”
<ul>
<li>AP-Singapore</li>
</ul></li>
<li>“obs.cn-east-3.myhuaweicloud.com”
<ul>
<li>CN East-Shanghai1</li>
</ul></li>
<li>“obs.cn-east-2.myhuaweicloud.com”
<ul>
<li>CN East-Shanghai2</li>
</ul></li>
<li>“obs.cn-north-1.myhuaweicloud.com”
<ul>
<li>CN North-Beijing1</li>
</ul></li>
<li>“obs.cn-north-4.myhuaweicloud.com”
<ul>
<li>CN North-Beijing4</li>
</ul></li>
<li>“obs.cn-south-1.myhuaweicloud.com”
<ul>
<li>CN South-Guangzhou</li>
</ul></li>
<li>“obs.ap-southeast-1.myhuaweicloud.com”
<ul>
<li>CN-Hong Kong</li>
</ul></li>
<li>“obs.sa-argentina-1.myhuaweicloud.com”
<ul>
<li>LA-Buenos Aires1</li>
</ul></li>
<li>“obs.sa-peru-1.myhuaweicloud.com”
<ul>
<li>LA-Lima1</li>
</ul></li>
<li>“obs.na-mexico-1.myhuaweicloud.com”
<ul>
<li>LA-Mexico City1</li>
</ul></li>
<li>“obs.sa-chile-1.myhuaweicloud.com”
<ul>
<li>LA-Santiago2</li>
</ul></li>
<li>“obs.sa-brazil-1.myhuaweicloud.com”
<ul>
<li>LA-Sao Paulo1</li>
</ul></li>
<li>“obs.ru-northwest-2.myhuaweicloud.com”
<ul>
<li>RU-Moscow2</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-endpoint-7">–s3-endpoint</h4>
<p>Endpoint for Scaleway Object Storage.</p>
<p>Properties:</p>
<ul>
<li>Config: endpoint</li>
<li>Env Var: RCLONE_S3_ENDPOINT</li>
<li>Provider: Scaleway</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“s3.nl-ams.scw.cloud”
<ul>
<li>Amsterdam Endpoint</li>
</ul></li>
<li>“s3.fr-par.scw.cloud”
<ul>
<li>Paris Endpoint</li>
</ul></li>
<li>“s3.pl-waw.scw.cloud”
<ul>
<li>Warsaw Endpoint</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-endpoint-8">–s3-endpoint</h4>
<p>Endpoint for StackPath Object Storage.</p>
<p>Properties:</p>
<ul>
<li>Config: endpoint</li>
<li>Env Var: RCLONE_S3_ENDPOINT</li>
<li>Provider: StackPath</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“s3.us-east-2.stackpathstorage.com”
<ul>
<li>US East Endpoint</li>
</ul></li>
<li>“s3.us-west-1.stackpathstorage.com”
<ul>
<li>US West Endpoint</li>
</ul></li>
<li>“s3.eu-central-1.stackpathstorage.com”
<ul>
<li>EU Endpoint</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-endpoint-9">–s3-endpoint</h4>
<p>Endpoint of the Shared Gateway.</p>
<p>Properties:</p>
<ul>
<li>Config: endpoint</li>
<li>Env Var: RCLONE_S3_ENDPOINT</li>
<li>Provider: Storj</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“gateway.eu1.storjshare.io”
<ul>
<li>EU1 Shared Gateway</li>
</ul></li>
<li>“gateway.us1.storjshare.io”
<ul>
<li>US1 Shared Gateway</li>
</ul></li>
<li>“gateway.ap1.storjshare.io”
<ul>
<li>Asia-Pacific Shared Gateway</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-endpoint-10">–s3-endpoint</h4>
<p>Endpoint for Tencent COS API.</p>
<p>Properties:</p>
<ul>
<li>Config: endpoint</li>
<li>Env Var: RCLONE_S3_ENDPOINT</li>
<li>Provider: TencentCOS</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“cos.ap-beijing.myqcloud.com”
<ul>
<li>Beijing Region</li>
</ul></li>
<li>“cos.ap-nanjing.myqcloud.com”
<ul>
<li>Nanjing Region</li>
</ul></li>
<li>“cos.ap-shanghai.myqcloud.com”
<ul>
<li>Shanghai Region</li>
</ul></li>
<li>“cos.ap-guangzhou.myqcloud.com”
<ul>
<li>Guangzhou Region</li>
</ul></li>
<li>“cos.ap-nanjing.myqcloud.com”
<ul>
<li>Nanjing Region</li>
</ul></li>
<li>“cos.ap-chengdu.myqcloud.com”
<ul>
<li>Chengdu Region</li>
</ul></li>
<li>“cos.ap-chongqing.myqcloud.com”
<ul>
<li>Chongqing Region</li>
</ul></li>
<li>“cos.ap-hongkong.myqcloud.com”
<ul>
<li>Hong Kong (China) Region</li>
</ul></li>
<li>“cos.ap-singapore.myqcloud.com”
<ul>
<li>Singapore Region</li>
</ul></li>
<li>“cos.ap-mumbai.myqcloud.com”
<ul>
<li>Mumbai Region</li>
</ul></li>
<li>“cos.ap-seoul.myqcloud.com”
<ul>
<li>Seoul Region</li>
</ul></li>
<li>“cos.ap-bangkok.myqcloud.com”
<ul>
<li>Bangkok Region</li>
</ul></li>
<li>“cos.ap-tokyo.myqcloud.com”
<ul>
<li>Tokyo Region</li>
</ul></li>
<li>“cos.na-siliconvalley.myqcloud.com”
<ul>
<li>Silicon Valley Region</li>
</ul></li>
<li>“cos.na-ashburn.myqcloud.com”
<ul>
<li>Virginia Region</li>
</ul></li>
<li>“cos.na-toronto.myqcloud.com”
<ul>
<li>Toronto Region</li>
</ul></li>
<li>“cos.eu-frankfurt.myqcloud.com”
<ul>
<li>Frankfurt Region</li>
</ul></li>
<li>“cos.eu-moscow.myqcloud.com”
<ul>
<li>Moscow Region</li>
</ul></li>
<li>“cos.accelerate.myqcloud.com”
<ul>
<li>Use Tencent COS Accelerate Endpoint</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-endpoint-11">–s3-endpoint</h4>
<p>Endpoint for RackCorp Object Storage.</p>
<p>Properties:</p>
<ul>
<li>Config: endpoint</li>
<li>Env Var: RCLONE_S3_ENDPOINT</li>
<li>Provider: RackCorp</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“s3.rackcorp.com”
<ul>
<li>Global (AnyCast) Endpoint</li>
</ul></li>
<li>“au.s3.rackcorp.com”
<ul>
<li>Australia (Anycast) Endpoint</li>
</ul></li>
<li>“au-nsw.s3.rackcorp.com”
<ul>
<li>Sydney (Australia) Endpoint</li>
</ul></li>
<li>“au-qld.s3.rackcorp.com”
<ul>
<li>Brisbane (Australia) Endpoint</li>
</ul></li>
<li>“au-vic.s3.rackcorp.com”
<ul>
<li>Melbourne (Australia) Endpoint</li>
</ul></li>
<li>“au-wa.s3.rackcorp.com”
<ul>
<li>Perth (Australia) Endpoint</li>
</ul></li>
<li>“ph.s3.rackcorp.com”
<ul>
<li>Manila (Philippines) Endpoint</li>
</ul></li>
<li>“th.s3.rackcorp.com”
<ul>
<li>Bangkok (Thailand) Endpoint</li>
</ul></li>
<li>“hk.s3.rackcorp.com”
<ul>
<li>HK (Hong Kong) Endpoint</li>
</ul></li>
<li>“mn.s3.rackcorp.com”
<ul>
<li>Ulaanbaatar (Mongolia) Endpoint</li>
</ul></li>
<li>“kg.s3.rackcorp.com”
<ul>
<li>Bishkek (Kyrgyzstan) Endpoint</li>
</ul></li>
<li>“id.s3.rackcorp.com”
<ul>
<li>Jakarta (Indonesia) Endpoint</li>
</ul></li>
<li>“jp.s3.rackcorp.com”
<ul>
<li>Tokyo (Japan) Endpoint</li>
</ul></li>
<li>“sg.s3.rackcorp.com”
<ul>
<li>SG (Singapore) Endpoint</li>
</ul></li>
<li>“de.s3.rackcorp.com”
<ul>
<li>Frankfurt (Germany) Endpoint</li>
</ul></li>
<li>“us.s3.rackcorp.com”
<ul>
<li>USA (AnyCast) Endpoint</li>
</ul></li>
<li>“us-east-1.s3.rackcorp.com”
<ul>
<li>New York (USA) Endpoint</li>
</ul></li>
<li>“us-west-1.s3.rackcorp.com”
<ul>
<li>Freemont (USA) Endpoint</li>
</ul></li>
<li>“nz.s3.rackcorp.com”
<ul>
<li>Auckland (New Zealand) Endpoint</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-endpoint-12">–s3-endpoint</h4>
<p>Endpoint for Qiniu Object Storage.</p>
<p>Properties:</p>
<ul>
<li>Config: endpoint</li>
<li>Env Var: RCLONE_S3_ENDPOINT</li>
<li>Provider: Qiniu</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“s3-cn-east-1.qiniucs.com”
<ul>
<li>East China Endpoint 1</li>
</ul></li>
<li>“s3-cn-east-2.qiniucs.com”
<ul>
<li>East China Endpoint 2</li>
</ul></li>
<li>“s3-cn-north-1.qiniucs.com”
<ul>
<li>North China Endpoint 1</li>
</ul></li>
<li>“s3-cn-south-1.qiniucs.com”
<ul>
<li>South China Endpoint 1</li>
</ul></li>
<li>“s3-us-north-1.qiniucs.com”
<ul>
<li>North America Endpoint 1</li>
</ul></li>
<li>“s3-ap-southeast-1.qiniucs.com”
<ul>
<li>Southeast Asia Endpoint 1</li>
</ul></li>
<li>“s3-ap-northeast-1.qiniucs.com”
<ul>
<li>Northeast Asia Endpoint 1</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-endpoint-13">–s3-endpoint</h4>
<p>Endpoint for S3 API.</p>
<p>Required when using an S3 clone.</p>
<p>Properties:</p>
<ul>
<li>Config: endpoint</li>
<li>Env Var: RCLONE_S3_ENDPOINT</li>
<li>Provider:
!AWS,IBMCOS,IDrive,IONOS,TencentCOS,HuaweiOBS,Alibaba,ChinaMobile,ArvanCloud,Scaleway,StackPath,Storj,RackCorp,Qiniu</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“objects-us-east-1.dream.io”
<ul>
<li>Dream Objects endpoint</li>
</ul></li>
<li>“nyc3.digitaloceanspaces.com”
<ul>
<li>Digital Ocean Spaces New York 3</li>
</ul></li>
<li>“ams3.digitaloceanspaces.com”
<ul>
<li>Digital Ocean Spaces Amsterdam 3</li>
</ul></li>
<li>“sgp1.digitaloceanspaces.com”
<ul>
<li>Digital Ocean Spaces Singapore 1</li>
</ul></li>
<li>“localhost:8333”
<ul>
<li>SeaweedFS S3 localhost</li>
</ul></li>
<li>“s3.us-east-1.lyvecloud.seagate.com”
<ul>
<li>Seagate Lyve Cloud US East 1 (Virginia)</li>
</ul></li>
<li>“s3.us-west-1.lyvecloud.seagate.com”
<ul>
<li>Seagate Lyve Cloud US West 1 (California)</li>
</ul></li>
<li>“s3.ap-southeast-1.lyvecloud.seagate.com”
<ul>
<li>Seagate Lyve Cloud AP Southeast 1 (Singapore)</li>
</ul></li>
<li>“s3.wasabisys.com”
<ul>
<li>Wasabi US East 1 (N. Virginia)</li>
</ul></li>
<li>“s3.us-east-2.wasabisys.com”
<ul>
<li>Wasabi US East 2 (N. Virginia)</li>
</ul></li>
<li>“s3.us-central-1.wasabisys.com”
<ul>
<li>Wasabi US Central 1 (Texas)</li>
</ul></li>
<li>“s3.us-west-1.wasabisys.com”
<ul>
<li>Wasabi US West 1 (Oregon)</li>
</ul></li>
<li>“s3.ca-central-1.wasabisys.com”
<ul>
<li>Wasabi CA Central 1 (Toronto)</li>
</ul></li>
<li>“s3.eu-central-1.wasabisys.com”
<ul>
<li>Wasabi EU Central 1 (Amsterdam)</li>
</ul></li>
<li>“s3.eu-central-2.wasabisys.com”
<ul>
<li>Wasabi EU Central 2 (Frankfurt)</li>
</ul></li>
<li>“s3.eu-west-1.wasabisys.com”
<ul>
<li>Wasabi EU West 1 (London)</li>
</ul></li>
<li>“s3.eu-west-2.wasabisys.com”
<ul>
<li>Wasabi EU West 2 (Paris)</li>
</ul></li>
<li>“s3.ap-northeast-1.wasabisys.com”
<ul>
<li>Wasabi AP Northeast 1 (Tokyo) endpoint</li>
</ul></li>
<li>“s3.ap-northeast-2.wasabisys.com”
<ul>
<li>Wasabi AP Northeast 2 (Osaka) endpoint</li>
</ul></li>
<li>“s3.ap-southeast-1.wasabisys.com”
<ul>
<li>Wasabi AP Southeast 1 (Singapore)</li>
</ul></li>
<li>“s3.ap-southeast-2.wasabisys.com”
<ul>
<li>Wasabi AP Southeast 2 (Sydney)</li>
</ul></li>
<li>“s3.ir-thr-at1.arvanstorage.com”
<ul>
<li>ArvanCloud Tehran Iran (Asiatech) endpoint</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-location-constraint">–s3-location-constraint</h4>
<p>Location constraint - must be set to match the Region.</p>
<p>Used when creating buckets only.</p>
<p>Properties:</p>
<ul>
<li>Config: location_constraint</li>
<li>Env Var: RCLONE_S3_LOCATION_CONSTRAINT</li>
<li>Provider: AWS</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“”
<ul>
<li>Empty for US Region, Northern Virginia, or Pacific Northwest</li>
</ul></li>
<li>“us-east-2”
<ul>
<li>US East (Ohio) Region</li>
</ul></li>
<li>“us-west-1”
<ul>
<li>US West (Northern California) Region</li>
</ul></li>
<li>“us-west-2”
<ul>
<li>US West (Oregon) Region</li>
</ul></li>
<li>“ca-central-1”
<ul>
<li>Canada (Central) Region</li>
</ul></li>
<li>“eu-west-1”
<ul>
<li>EU (Ireland) Region</li>
</ul></li>
<li>“eu-west-2”
<ul>
<li>EU (London) Region</li>
</ul></li>
<li>“eu-west-3”
<ul>
<li>EU (Paris) Region</li>
</ul></li>
<li>“eu-north-1”
<ul>
<li>EU (Stockholm) Region</li>
</ul></li>
<li>“eu-south-1”
<ul>
<li>EU (Milan) Region</li>
</ul></li>
<li>“EU”
<ul>
<li>EU Region</li>
</ul></li>
<li>“ap-southeast-1”
<ul>
<li>Asia Pacific (Singapore) Region</li>
</ul></li>
<li>“ap-southeast-2”
<ul>
<li>Asia Pacific (Sydney) Region</li>
</ul></li>
<li>“ap-northeast-1”
<ul>
<li>Asia Pacific (Tokyo) Region</li>
</ul></li>
<li>“ap-northeast-2”
<ul>
<li>Asia Pacific (Seoul) Region</li>
</ul></li>
<li>“ap-northeast-3”
<ul>
<li>Asia Pacific (Osaka-Local) Region</li>
</ul></li>
<li>“ap-south-1”
<ul>
<li>Asia Pacific (Mumbai) Region</li>
</ul></li>
<li>“ap-east-1”
<ul>
<li>Asia Pacific (Hong Kong) Region</li>
</ul></li>
<li>“sa-east-1”
<ul>
<li>South America (Sao Paulo) Region</li>
</ul></li>
<li>“me-south-1”
<ul>
<li>Middle East (Bahrain) Region</li>
</ul></li>
<li>“af-south-1”
<ul>
<li>Africa (Cape Town) Region</li>
</ul></li>
<li>“cn-north-1”
<ul>
<li>China (Beijing) Region</li>
</ul></li>
<li>“cn-northwest-1”
<ul>
<li>China (Ningxia) Region</li>
</ul></li>
<li>“us-gov-east-1”
<ul>
<li>AWS GovCloud (US-East) Region</li>
</ul></li>
<li>“us-gov-west-1”
<ul>
<li>AWS GovCloud (US) Region</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-location-constraint-1">–s3-location-constraint</h4>
<p>Location constraint - must match endpoint.</p>
<p>Used when creating buckets only.</p>
<p>Properties:</p>
<ul>
<li>Config: location_constraint</li>
<li>Env Var: RCLONE_S3_LOCATION_CONSTRAINT</li>
<li>Provider: ChinaMobile</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“wuxi1”
<ul>
<li>East China (Suzhou)</li>
</ul></li>
<li>“jinan1”
<ul>
<li>East China (Jinan)</li>
</ul></li>
<li>“ningbo1”
<ul>
<li>East China (Hangzhou)</li>
</ul></li>
<li>“shanghai1”
<ul>
<li>East China (Shanghai-1)</li>
</ul></li>
<li>“zhengzhou1”
<ul>
<li>Central China (Zhengzhou)</li>
</ul></li>
<li>“hunan1”
<ul>
<li>Central China (Changsha-1)</li>
</ul></li>
<li>“zhuzhou1”
<ul>
<li>Central China (Changsha-2)</li>
</ul></li>
<li>“guangzhou1”
<ul>
<li>South China (Guangzhou-2)</li>
</ul></li>
<li>“dongguan1”
<ul>
<li>South China (Guangzhou-3)</li>
</ul></li>
<li>“beijing1”
<ul>
<li>North China (Beijing-1)</li>
</ul></li>
<li>“beijing2”
<ul>
<li>North China (Beijing-2)</li>
</ul></li>
<li>“beijing4”
<ul>
<li>North China (Beijing-3)</li>
</ul></li>
<li>“huhehaote1”
<ul>
<li>North China (Huhehaote)</li>
</ul></li>
<li>“chengdu1”
<ul>
<li>Southwest China (Chengdu)</li>
</ul></li>
<li>“chongqing1”
<ul>
<li>Southwest China (Chongqing)</li>
</ul></li>
<li>“guiyang1”
<ul>
<li>Southwest China (Guiyang)</li>
</ul></li>
<li>“xian1”
<ul>
<li>Nouthwest China (Xian)</li>
</ul></li>
<li>“yunnan”
<ul>
<li>Yunnan China (Kunming)</li>
</ul></li>
<li>“yunnan2”
<ul>
<li>Yunnan China (Kunming-2)</li>
</ul></li>
<li>“tianjin1”
<ul>
<li>Tianjin China (Tianjin)</li>
</ul></li>
<li>“jilin1”
<ul>
<li>Jilin China (Changchun)</li>
</ul></li>
<li>“hubei1”
<ul>
<li>Hubei China (Xiangyan)</li>
</ul></li>
<li>“jiangxi1”
<ul>
<li>Jiangxi China (Nanchang)</li>
</ul></li>
<li>“gansu1”
<ul>
<li>Gansu China (Lanzhou)</li>
</ul></li>
<li>“shanxi1”
<ul>
<li>Shanxi China (Taiyuan)</li>
</ul></li>
<li>“liaoning1”
<ul>
<li>Liaoning China (Shenyang)</li>
</ul></li>
<li>“hebei1”
<ul>
<li>Hebei China (Shijiazhuang)</li>
</ul></li>
<li>“fujian1”
<ul>
<li>Fujian China (Xiamen)</li>
</ul></li>
<li>“guangxi1”
<ul>
<li>Guangxi China (Nanning)</li>
</ul></li>
<li>“anhui1”
<ul>
<li>Anhui China (Huainan)</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-location-constraint-2">–s3-location-constraint</h4>
<p>Location constraint - must match endpoint.</p>
<p>Used when creating buckets only.</p>
<p>Properties:</p>
<ul>
<li>Config: location_constraint</li>
<li>Env Var: RCLONE_S3_LOCATION_CONSTRAINT</li>
<li>Provider: ArvanCloud</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“ir-thr-at1”
<ul>
<li>Tehran Iran (Asiatech)</li>
</ul></li>
<li>“ir-tbz-sh1”
<ul>
<li>Tabriz Iran (Shahriar)</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-location-constraint-3">–s3-location-constraint</h4>
<p>Location constraint - must match endpoint when using IBM Cloud
Public.</p>
<p>For on-prem COS, do not make a selection from this list, hit
enter.</p>
<p>Properties:</p>
<ul>
<li>Config: location_constraint</li>
<li>Env Var: RCLONE_S3_LOCATION_CONSTRAINT</li>
<li>Provider: IBMCOS</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“us-standard”
<ul>
<li>US Cross Region Standard</li>
</ul></li>
<li>“us-vault”
<ul>
<li>US Cross Region Vault</li>
</ul></li>
<li>“us-cold”
<ul>
<li>US Cross Region Cold</li>
</ul></li>
<li>“us-flex”
<ul>
<li>US Cross Region Flex</li>
</ul></li>
<li>“us-east-standard”
<ul>
<li>US East Region Standard</li>
</ul></li>
<li>“us-east-vault”
<ul>
<li>US East Region Vault</li>
</ul></li>
<li>“us-east-cold”
<ul>
<li>US East Region Cold</li>
</ul></li>
<li>“us-east-flex”
<ul>
<li>US East Region Flex</li>
</ul></li>
<li>“us-south-standard”
<ul>
<li>US South Region Standard</li>
</ul></li>
<li>“us-south-vault”
<ul>
<li>US South Region Vault</li>
</ul></li>
<li>“us-south-cold”
<ul>
<li>US South Region Cold</li>
</ul></li>
<li>“us-south-flex”
<ul>
<li>US South Region Flex</li>
</ul></li>
<li>“eu-standard”
<ul>
<li>EU Cross Region Standard</li>
</ul></li>
<li>“eu-vault”
<ul>
<li>EU Cross Region Vault</li>
</ul></li>
<li>“eu-cold”
<ul>
<li>EU Cross Region Cold</li>
</ul></li>
<li>“eu-flex”
<ul>
<li>EU Cross Region Flex</li>
</ul></li>
<li>“eu-gb-standard”
<ul>
<li>Great Britain Standard</li>
</ul></li>
<li>“eu-gb-vault”
<ul>
<li>Great Britain Vault</li>
</ul></li>
<li>“eu-gb-cold”
<ul>
<li>Great Britain Cold</li>
</ul></li>
<li>“eu-gb-flex”
<ul>
<li>Great Britain Flex</li>
</ul></li>
<li>“ap-standard”
<ul>
<li>APAC Standard</li>
</ul></li>
<li>“ap-vault”
<ul>
<li>APAC Vault</li>
</ul></li>
<li>“ap-cold”
<ul>
<li>APAC Cold</li>
</ul></li>
<li>“ap-flex”
<ul>
<li>APAC Flex</li>
</ul></li>
<li>“mel01-standard”
<ul>
<li>Melbourne Standard</li>
</ul></li>
<li>“mel01-vault”
<ul>
<li>Melbourne Vault</li>
</ul></li>
<li>“mel01-cold”
<ul>
<li>Melbourne Cold</li>
</ul></li>
<li>“mel01-flex”
<ul>
<li>Melbourne Flex</li>
</ul></li>
<li>“tor01-standard”
<ul>
<li>Toronto Standard</li>
</ul></li>
<li>“tor01-vault”
<ul>
<li>Toronto Vault</li>
</ul></li>
<li>“tor01-cold”
<ul>
<li>Toronto Cold</li>
</ul></li>
<li>“tor01-flex”
<ul>
<li>Toronto Flex</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-location-constraint-4">–s3-location-constraint</h4>
<p>Location constraint - the location where your bucket will be located
and your data stored.</p>
<p>Properties:</p>
<ul>
<li>Config: location_constraint</li>
<li>Env Var: RCLONE_S3_LOCATION_CONSTRAINT</li>
<li>Provider: RackCorp</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“global”
<ul>
<li>Global CDN Region</li>
</ul></li>
<li>“au”
<ul>
<li>Australia (All locations)</li>
</ul></li>
<li>“au-nsw”
<ul>
<li>NSW (Australia) Region</li>
</ul></li>
<li>“au-qld”
<ul>
<li>QLD (Australia) Region</li>
</ul></li>
<li>“au-vic”
<ul>
<li>VIC (Australia) Region</li>
</ul></li>
<li>“au-wa”
<ul>
<li>Perth (Australia) Region</li>
</ul></li>
<li>“ph”
<ul>
<li>Manila (Philippines) Region</li>
</ul></li>
<li>“th”
<ul>
<li>Bangkok (Thailand) Region</li>
</ul></li>
<li>“hk”
<ul>
<li>HK (Hong Kong) Region</li>
</ul></li>
<li>“mn”
<ul>
<li>Ulaanbaatar (Mongolia) Region</li>
</ul></li>
<li>“kg”
<ul>
<li>Bishkek (Kyrgyzstan) Region</li>
</ul></li>
<li>“id”
<ul>
<li>Jakarta (Indonesia) Region</li>
</ul></li>
<li>“jp”
<ul>
<li>Tokyo (Japan) Region</li>
</ul></li>
<li>“sg”
<ul>
<li>SG (Singapore) Region</li>
</ul></li>
<li>“de”
<ul>
<li>Frankfurt (Germany) Region</li>
</ul></li>
<li>“us”
<ul>
<li>USA (AnyCast) Region</li>
</ul></li>
<li>“us-east-1”
<ul>
<li>New York (USA) Region</li>
</ul></li>
<li>“us-west-1”
<ul>
<li>Freemont (USA) Region</li>
</ul></li>
<li>“nz”
<ul>
<li>Auckland (New Zealand) Region</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-location-constraint-5">–s3-location-constraint</h4>
<p>Location constraint - must be set to match the Region.</p>
<p>Used when creating buckets only.</p>
<p>Properties:</p>
<ul>
<li>Config: location_constraint</li>
<li>Env Var: RCLONE_S3_LOCATION_CONSTRAINT</li>
<li>Provider: Qiniu</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“cn-east-1”
<ul>
<li>East China Region 1</li>
</ul></li>
<li>“cn-east-2”
<ul>
<li>East China Region 2</li>
</ul></li>
<li>“cn-north-1”
<ul>
<li>North China Region 1</li>
</ul></li>
<li>“cn-south-1”
<ul>
<li>South China Region 1</li>
</ul></li>
<li>“us-north-1”
<ul>
<li>North America Region 1</li>
</ul></li>
<li>“ap-southeast-1”
<ul>
<li>Southeast Asia Region 1</li>
</ul></li>
<li>“ap-northeast-1”
<ul>
<li>Northeast Asia Region 1</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-location-constraint-6">–s3-location-constraint</h4>
<p>Location constraint - must be set to match the Region.</p>
<p>Leave blank if not sure. Used when creating buckets only.</p>
<p>Properties:</p>
<ul>
<li>Config: location_constraint</li>
<li>Env Var: RCLONE_S3_LOCATION_CONSTRAINT</li>
<li>Provider:
!AWS,Alibaba,HuaweiOBS,ChinaMobile,Cloudflare,IBMCOS,IDrive,IONOS,ArvanCloud,Qiniu,RackCorp,Scaleway,StackPath,Storj,TencentCOS</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="s3-acl">–s3-acl</h4>
<p>Canned ACL used when creating buckets and storing or copying
objects.</p>
<p>This ACL is used for creating objects and if bucket_acl isn’t set,
for creating buckets too.</p>
<p>For more info visit
https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl</p>
<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>
<p>Properties:</p>
<ul>
<li>Config: acl</li>
<li>Env Var: RCLONE_S3_ACL</li>
<li>Provider: !Storj,Cloudflare</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“default”
<ul>
<li>Owner gets Full_CONTROL.</li>
<li>No one else has access rights (default).</li>
</ul></li>
<li>“private”
<ul>
<li>Owner gets FULL_CONTROL.</li>
<li>No one else has access rights (default).</li>
</ul></li>
<li>“public-read”
<ul>
<li>Owner gets FULL_CONTROL.</li>
<li>The AllUsers group gets READ access.</li>
</ul></li>
<li>“public-read-write”
<ul>
<li>Owner gets FULL_CONTROL.</li>
<li>The AllUsers group gets READ and WRITE access.</li>
<li>Granting this on a bucket is generally not recommended.</li>
</ul></li>
<li>“authenticated-read”
<ul>
<li>Owner gets FULL_CONTROL.</li>
<li>The AuthenticatedUsers group gets READ access.</li>
</ul></li>
<li>“bucket-owner-read”
<ul>
<li>Object owner gets FULL_CONTROL.</li>
<li>Bucket owner gets READ access.</li>
<li>If you specify this canned ACL when creating a bucket, Amazon S3
ignores it.</li>
</ul></li>
<li>“bucket-owner-full-control”
<ul>
<li>Both the object owner and the bucket owner get FULL_CONTROL over the
object.</li>
<li>If you specify this canned ACL when creating a bucket, Amazon S3
ignores it.</li>
</ul></li>
<li>“private”
<ul>
<li>Owner gets FULL_CONTROL.</li>
<li>No one else has access rights (default).</li>
<li>This acl is available on IBM Cloud (Infra), IBM Cloud (Storage),
On-Premise COS.</li>
</ul></li>
<li>“public-read”
<ul>
<li>Owner gets FULL_CONTROL.</li>
<li>The AllUsers group gets READ access.</li>
<li>This acl is available on IBM Cloud (Infra), IBM Cloud (Storage),
On-Premise IBM COS.</li>
</ul></li>
<li>“public-read-write”
<ul>
<li>Owner gets FULL_CONTROL.</li>
<li>The AllUsers group gets READ and WRITE access.</li>
<li>This acl is available on IBM Cloud (Infra), On-Premise IBM COS.</li>
</ul></li>
<li>“authenticated-read”
<ul>
<li>Owner gets FULL_CONTROL.</li>
<li>The AuthenticatedUsers group gets READ access.</li>
<li>Not supported on Buckets.</li>
<li>This acl is available on IBM Cloud (Infra) and On-Premise IBM
COS.</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-server-side-encryption">–s3-server-side-encryption</h4>
<p>The server-side encryption algorithm used when storing this object in
S3.</p>
<p>Properties:</p>
<ul>
<li>Config: server_side_encryption</li>
<li>Env Var: RCLONE_S3_SERVER_SIDE_ENCRYPTION</li>
<li>Provider: AWS,Ceph,ChinaMobile,Minio</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“”
<ul>
<li>None</li>
</ul></li>
<li>“AES256”
<ul>
<li>AES256</li>
</ul></li>
<li>“aws:kms”
<ul>
<li>aws:kms</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-sse-kms-key-id">–s3-sse-kms-key-id</h4>
<p>If using KMS ID you must provide the ARN of Key.</p>
<p>Properties:</p>
<ul>
<li>Config: sse_kms_key_id</li>
<li>Env Var: RCLONE_S3_SSE_KMS_KEY_ID</li>
<li>Provider: AWS,Ceph,Minio</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“”
<ul>
<li>None</li>
</ul></li>
<li>“arn:aws:kms:us-east-1:*”
<ul>
<li>arn:aws:kms:*</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-storage-class">–s3-storage-class</h4>
<p>The storage class to use when storing new objects in S3.</p>
<p>Properties:</p>
<ul>
<li>Config: storage_class</li>
<li>Env Var: RCLONE_S3_STORAGE_CLASS</li>
<li>Provider: AWS</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“”
<ul>
<li>Default</li>
</ul></li>
<li>“STANDARD”
<ul>
<li>Standard storage class</li>
</ul></li>
<li>“REDUCED_REDUNDANCY”
<ul>
<li>Reduced redundancy storage class</li>
</ul></li>
<li>“STANDARD_IA”
<ul>
<li>Standard Infrequent Access storage class</li>
</ul></li>
<li>“ONEZONE_IA”
<ul>
<li>One Zone Infrequent Access storage class</li>
</ul></li>
<li>“GLACIER”
<ul>
<li>Glacier storage class</li>
</ul></li>
<li>“DEEP_ARCHIVE”
<ul>
<li>Glacier Deep Archive storage class</li>
</ul></li>
<li>“INTELLIGENT_TIERING”
<ul>
<li>Intelligent-Tiering storage class</li>
</ul></li>
<li>“GLACIER_IR”
<ul>
<li>Glacier Instant Retrieval storage class</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-storage-class-1">–s3-storage-class</h4>
<p>The storage class to use when storing new objects in OSS.</p>
<p>Properties:</p>
<ul>
<li>Config: storage_class</li>
<li>Env Var: RCLONE_S3_STORAGE_CLASS</li>
<li>Provider: Alibaba</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“”
<ul>
<li>Default</li>
</ul></li>
<li>“STANDARD”
<ul>
<li>Standard storage class</li>
</ul></li>
<li>“GLACIER”
<ul>
<li>Archive storage mode</li>
</ul></li>
<li>“STANDARD_IA”
<ul>
<li>Infrequent access storage mode</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-storage-class-2">–s3-storage-class</h4>
<p>The storage class to use when storing new objects in ChinaMobile.</p>
<p>Properties:</p>
<ul>
<li>Config: storage_class</li>
<li>Env Var: RCLONE_S3_STORAGE_CLASS</li>
<li>Provider: ChinaMobile</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“”
<ul>
<li>Default</li>
</ul></li>
<li>“STANDARD”
<ul>
<li>Standard storage class</li>
</ul></li>
<li>“GLACIER”
<ul>
<li>Archive storage mode</li>
</ul></li>
<li>“STANDARD_IA”
<ul>
<li>Infrequent access storage mode</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-storage-class-3">–s3-storage-class</h4>
<p>The storage class to use when storing new objects in ArvanCloud.</p>
<p>Properties:</p>
<ul>
<li>Config: storage_class</li>
<li>Env Var: RCLONE_S3_STORAGE_CLASS</li>
<li>Provider: ArvanCloud</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“STANDARD”
<ul>
<li>Standard storage class</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-storage-class-4">–s3-storage-class</h4>
<p>The storage class to use when storing new objects in Tencent COS.</p>
<p>Properties:</p>
<ul>
<li>Config: storage_class</li>
<li>Env Var: RCLONE_S3_STORAGE_CLASS</li>
<li>Provider: TencentCOS</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“”
<ul>
<li>Default</li>
</ul></li>
<li>“STANDARD”
<ul>
<li>Standard storage class</li>
</ul></li>
<li>“ARCHIVE”
<ul>
<li>Archive storage mode</li>
</ul></li>
<li>“STANDARD_IA”
<ul>
<li>Infrequent access storage mode</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-storage-class-5">–s3-storage-class</h4>
<p>The storage class to use when storing new objects in S3.</p>
<p>Properties:</p>
<ul>
<li>Config: storage_class</li>
<li>Env Var: RCLONE_S3_STORAGE_CLASS</li>
<li>Provider: Scaleway</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“”
<ul>
<li>Default.</li>
</ul></li>
<li>“STANDARD”
<ul>
<li>The Standard class for any upload.</li>
<li>Suitable for on-demand content like streaming or CDN.</li>
</ul></li>
<li>“GLACIER”
<ul>
<li>Archived storage.</li>
<li>Prices are lower, but it needs to be restored first to be
accessed.</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-storage-class-6">–s3-storage-class</h4>
<p>The storage class to use when storing new objects in Qiniu.</p>
<p>Properties:</p>
<ul>
<li>Config: storage_class</li>
<li>Env Var: RCLONE_S3_STORAGE_CLASS</li>
<li>Provider: Qiniu</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“STANDARD”
<ul>
<li>Standard storage class</li>
</ul></li>
<li>“LINE”
<ul>
<li>Infrequent access storage mode</li>
</ul></li>
<li>“GLACIER”
<ul>
<li>Archive storage mode</li>
</ul></li>
<li>“DEEP_ARCHIVE”
<ul>
<li>Deep archive storage mode</li>
</ul></li>
</ul></li>
</ul>
<h3 id="advanced-options-2">Advanced options</h3>
<p>Here are the Advanced options specific to s3 (Amazon S3 Compliant
Storage Providers including AWS, Alibaba, Ceph, China Mobile,
Cloudflare, ArvanCloud, Digital Ocean, Dreamhost, Huawei OBS, IBM COS,
IDrive e2, IONOS Cloud, Lyve Cloud, Minio, Netease, RackCorp, Scaleway,
SeaweedFS, StackPath, Storj, Tencent COS, Qiniu and Wasabi).</p>
<h4 id="s3-bucket-acl">–s3-bucket-acl</h4>
<p>Canned ACL used when creating buckets.</p>
<p>For more info visit
https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl</p>
<p>Note that this ACL is applied when only when creating buckets. If it
isn’t set then “acl” is used instead.</p>
<p>Properties:</p>
<ul>
<li>Config: bucket_acl</li>
<li>Env Var: RCLONE_S3_BUCKET_ACL</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“private”
<ul>
<li>Owner gets FULL_CONTROL.</li>
<li>No one else has access rights (default).</li>
</ul></li>
<li>“public-read”
<ul>
<li>Owner gets FULL_CONTROL.</li>
<li>The AllUsers group gets READ access.</li>
</ul></li>
<li>“public-read-write”
<ul>
<li>Owner gets FULL_CONTROL.</li>
<li>The AllUsers group gets READ and WRITE access.</li>
<li>Granting this on a bucket is generally not recommended.</li>
</ul></li>
<li>“authenticated-read”
<ul>
<li>Owner gets FULL_CONTROL.</li>
<li>The AuthenticatedUsers group gets READ access.</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-requester-pays">–s3-requester-pays</h4>
<p>Enables requester pays option when interacting with S3 bucket.</p>
<p>Properties:</p>
<ul>
<li>Config: requester_pays</li>
<li>Env Var: RCLONE_S3_REQUESTER_PAYS</li>
<li>Provider: AWS</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="s3-sse-customer-algorithm">–s3-sse-customer-algorithm</h4>
<p>If using SSE-C, the server-side encryption algorithm used when
storing this object in S3.</p>
<p>Properties:</p>
<ul>
<li>Config: sse_customer_algorithm</li>
<li>Env Var: RCLONE_S3_SSE_CUSTOMER_ALGORITHM</li>
<li>Provider: AWS,Ceph,ChinaMobile,Minio</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“”
<ul>
<li>None</li>
</ul></li>
<li>“AES256”
<ul>
<li>AES256</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-sse-customer-key">–s3-sse-customer-key</h4>
<p>To use SSE-C you may provide the secret encryption key used to
encrypt/decrypt your data.</p>
<p>Alternatively you can provide –sse-customer-key-base64.</p>
<p>Properties:</p>
<ul>
<li>Config: sse_customer_key</li>
<li>Env Var: RCLONE_S3_SSE_CUSTOMER_KEY</li>
<li>Provider: AWS,Ceph,ChinaMobile,Minio</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“”
<ul>
<li>None</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-sse-customer-key-base64">–s3-sse-customer-key-base64</h4>
<p>If using SSE-C you must provide the secret encryption key encoded in
base64 format to encrypt/decrypt your data.</p>
<p>Alternatively you can provide –sse-customer-key.</p>
<p>Properties:</p>
<ul>
<li>Config: sse_customer_key_base64</li>
<li>Env Var: RCLONE_S3_SSE_CUSTOMER_KEY_BASE64</li>
<li>Provider: AWS,Ceph,ChinaMobile,Minio</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“”
<ul>
<li>None</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-sse-customer-key-md5">–s3-sse-customer-key-md5</h4>
<p>If using SSE-C you may provide the secret encryption key MD5 checksum
(optional).</p>
<p>If you leave it blank, this is calculated automatically from the
sse_customer_key provided.</p>
<p>Properties:</p>
<ul>
<li>Config: sse_customer_key_md5</li>
<li>Env Var: RCLONE_S3_SSE_CUSTOMER_KEY_MD5</li>
<li>Provider: AWS,Ceph,ChinaMobile,Minio</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“”
<ul>
<li>None</li>
</ul></li>
</ul></li>
</ul>
<h4 id="s3-upload-cutoff">–s3-upload-cutoff</h4>
<p>Cutoff for switching to chunked upload.</p>
<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>
<p>Properties:</p>
<ul>
<li>Config: upload_cutoff</li>
<li>Env Var: RCLONE_S3_UPLOAD_CUTOFF</li>
<li>Type: SizeSuffix</li>
<li>Default: 200Mi</li>
</ul>
<h4 id="s3-chunk-size">–s3-chunk-size</h4>
<p>Chunk size to use for uploading.</p>
<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>
<p>Note that “–s3-upload-concurrency” chunks of this size are buffered
in memory per transfer.</p>
<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>
<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>
<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>
<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>
<p>Properties:</p>
<ul>
<li>Config: chunk_size</li>
<li>Env Var: RCLONE_S3_CHUNK_SIZE</li>
<li>Type: SizeSuffix</li>
<li>Default: 5Mi</li>
</ul>
<h4 id="s3-max-upload-parts">–s3-max-upload-parts</h4>
<p>Maximum number of parts in a multipart upload.</p>
<p>This option defines the maximum number of multipart chunks to use
when doing a multipart upload.</p>
<p>This can be useful if a service does not support the AWS S3
specification of 10,000 chunks.</p>
<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>
<p>Properties:</p>
<ul>
<li>Config: max_upload_parts</li>
<li>Env Var: RCLONE_S3_MAX_UPLOAD_PARTS</li>
<li>Type: int</li>
<li>Default: 10000</li>
</ul>
<h4 id="s3-copy-cutoff">–s3-copy-cutoff</h4>
<p>Cutoff for switching to multipart copy.</p>
<p>Any files larger than this that need to be server-side copied will be
copied in chunks of this size.</p>
<p>The minimum is 0 and the maximum is 5 GiB.</p>
<p>Properties:</p>
<ul>
<li>Config: copy_cutoff</li>
<li>Env Var: RCLONE_S3_COPY_CUTOFF</li>
<li>Type: SizeSuffix</li>
<li>Default: 4.656Gi</li>
</ul>
<h4 id="s3-disable-checksum">–s3-disable-checksum</h4>
<p>Don’t store MD5 checksum with object metadata.</p>
<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>
<p>Properties:</p>
<ul>
<li>Config: disable_checksum</li>
<li>Env Var: RCLONE_S3_DISABLE_CHECKSUM</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="s3-shared-credentials-file">–s3-shared-credentials-file</h4>
<p>Path to the shared credentials file.</p>
<p>If env_auth = true then rclone can use a shared credentials file.</p>
<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>
<pre><code>Linux/OSX: &quot;$HOME/.aws/credentials&quot;
Windows:   &quot;%USERPROFILE%\.aws\credentials&quot;</code></pre>
<p>Properties:</p>
<ul>
<li>Config: shared_credentials_file</li>
<li>Env Var: RCLONE_S3_SHARED_CREDENTIALS_FILE</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="s3-profile">–s3-profile</h4>
<p>Profile to use in the shared credentials file.</p>
<p>If env_auth = true then rclone can use a shared credentials file.
This variable controls which profile is used in that file.</p>
<p>If empty it will default to the environment variable “AWS_PROFILE” or
“default” if that environment variable is also not set.</p>
<p>Properties:</p>
<ul>
<li>Config: profile</li>
<li>Env Var: RCLONE_S3_PROFILE</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="s3-session-token">–s3-session-token</h4>
<p>An AWS session token.</p>
<p>Properties:</p>
<ul>
<li>Config: session_token</li>
<li>Env Var: RCLONE_S3_SESSION_TOKEN</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="s3-upload-concurrency">–s3-upload-concurrency</h4>
<p>Concurrency for multipart uploads.</p>
<p>This is the number of chunks of the same file that are uploaded
concurrently.</p>
<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>
<p>Properties:</p>
<ul>
<li>Config: upload_concurrency</li>
<li>Env Var: RCLONE_S3_UPLOAD_CONCURRENCY</li>
<li>Type: int</li>
<li>Default: 4</li>
</ul>
<h4 id="s3-force-path-style">–s3-force-path-style</h4>
<p>If true use path style access if false use virtual hosted style.</p>
<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>
<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>
<p>Properties:</p>
<ul>
<li>Config: force_path_style</li>
<li>Env Var: RCLONE_S3_FORCE_PATH_STYLE</li>
<li>Type: bool</li>
<li>Default: true</li>
</ul>
<h4 id="s3-v2-auth">–s3-v2-auth</h4>
<p>If true use v2 authentication.</p>
<p>If this is false (the default) then rclone will use v4
authentication. If it is set then rclone will use v2 authentication.</p>
<p>Use this only if v4 signatures don’t work, e.g. pre Jewel/v10
CEPH.</p>
<p>Properties:</p>
<ul>
<li>Config: v2_auth</li>
<li>Env Var: RCLONE_S3_V2_AUTH</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="s3-use-accelerate-endpoint">–s3-use-accelerate-endpoint</h4>
<p>If true use the AWS S3 accelerated endpoint.</p>
<p>See: <a
href="https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration-examples.html">AWS
S3 Transfer acceleration</a></p>
<p>Properties:</p>
<ul>
<li>Config: use_accelerate_endpoint</li>
<li>Env Var: RCLONE_S3_USE_ACCELERATE_ENDPOINT</li>
<li>Provider: AWS</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="s3-leave-parts-on-error">–s3-leave-parts-on-error</h4>
<p>If true avoid calling abort upload on a failure, leaving all
successfully uploaded parts on S3 for manual recovery.</p>
<p>It should be set to true for resuming uploads across different
sessions.</p>
<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>
<p>Properties:</p>
<ul>
<li>Config: leave_parts_on_error</li>
<li>Env Var: RCLONE_S3_LEAVE_PARTS_ON_ERROR</li>
<li>Provider: AWS</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="s3-list-chunk">–s3-list-chunk</h4>
<p>Size of listing chunk (response list for each ListObject S3
request).</p>
<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>
<p>Properties:</p>
<ul>
<li>Config: list_chunk</li>
<li>Env Var: RCLONE_S3_LIST_CHUNK</li>
<li>Type: int</li>
<li>Default: 1000</li>
</ul>
<h4 id="s3-list-version">–s3-list-version</h4>
<p>Version of ListObjects to use: 1,2 or 0 for auto.</p>
<p>When S3 originally launched it only provided the ListObjects call to
enumerate objects in a bucket.</p>
<p>However in May 2016 the ListObjectsV2 call was introduced. This is
much higher performance and should be used if at all possible.</p>
<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>
<p>Properties:</p>
<ul>
<li>Config: list_version</li>
<li>Env Var: RCLONE_S3_LIST_VERSION</li>
<li>Type: int</li>
<li>Default: 0</li>
</ul>
<h4 id="s3-list-url-encode">–s3-list-url-encode</h4>
<p>Whether to url encode listings: true/false/unset</p>
<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>
<p>Properties:</p>
<ul>
<li>Config: list_url_encode</li>
<li>Env Var: RCLONE_S3_LIST_URL_ENCODE</li>
<li>Type: Tristate</li>
<li>Default: unset</li>
</ul>
<h4 id="s3-no-check-bucket">–s3-no-check-bucket</h4>
<p>If set, don’t attempt to check the bucket exists or create it.</p>
<p>This can be useful when trying to minimise the number of transactions
rclone does if you know the bucket exists already.</p>
<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>
<p>Properties:</p>
<ul>
<li>Config: no_check_bucket</li>
<li>Env Var: RCLONE_S3_NO_CHECK_BUCKET</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="s3-no-head">–s3-no-head</h4>
<p>If set, don’t HEAD uploaded objects to check integrity.</p>
<p>This can be useful when trying to minimise the number of transactions
rclone does.</p>
<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>
<p>In particular it will assume:</p>
<ul>
<li>the metadata, including modtime, storage class and content type was
as uploaded</li>
<li>the size was as uploaded</li>
</ul>
<p>It reads the following items from the response for a single part
PUT:</p>
<ul>
<li>the MD5SUM</li>
<li>The uploaded date</li>
</ul>
<p>For multipart uploads these items aren’t read.</p>
<p>If an source object of unknown length is uploaded then rclone
<strong>will</strong> do a HEAD request.</p>
<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>
<p>Properties:</p>
<ul>
<li>Config: no_head</li>
<li>Env Var: RCLONE_S3_NO_HEAD</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="s3-no-head-object">–s3-no-head-object</h4>
<p>If set, do not do HEAD before GET when getting objects.</p>
<p>Properties:</p>
<ul>
<li>Config: no_head_object</li>
<li>Env Var: RCLONE_S3_NO_HEAD_OBJECT</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="s3-encoding">–s3-encoding</h4>
<p>The encoding for the backend.</p>
<p>See the <a href="https://rclone.org/overview/#encoding">encoding
section in the overview</a> for more info.</p>
<p>Properties:</p>
<ul>
<li>Config: encoding</li>
<li>Env Var: RCLONE_S3_ENCODING</li>
<li>Type: MultiEncoder</li>
<li>Default: Slash,InvalidUtf8,Dot</li>
</ul>
<h4 id="s3-memory-pool-flush-time">–s3-memory-pool-flush-time</h4>
<p>How often internal memory buffer pools will be flushed.</p>
<p>Uploads which requires additional buffers (f.e multipart) will use
memory pool for allocations. This option controls how often unused
buffers will be removed from the pool.</p>
<p>Properties:</p>
<ul>
<li>Config: memory_pool_flush_time</li>
<li>Env Var: RCLONE_S3_MEMORY_POOL_FLUSH_TIME</li>
<li>Type: Duration</li>
<li>Default: 1m0s</li>
</ul>
<h4 id="s3-memory-pool-use-mmap">–s3-memory-pool-use-mmap</h4>
<p>Whether to use mmap buffers in internal memory pool.</p>
<p>Properties:</p>
<ul>
<li>Config: memory_pool_use_mmap</li>
<li>Env Var: RCLONE_S3_MEMORY_POOL_USE_MMAP</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="s3-disable-http2">–s3-disable-http2</h4>
<p>Disable usage of http2 for S3 backends.</p>
<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>
<p>See: https://github.com/rclone/rclone/issues/4673,
https://github.com/rclone/rclone/issues/3631</p>
<p>Properties:</p>
<ul>
<li>Config: disable_http2</li>
<li>Env Var: RCLONE_S3_DISABLE_HTTP2</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="s3-download-url">–s3-download-url</h4>
<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>
<p>Properties:</p>
<ul>
<li>Config: download_url</li>
<li>Env Var: RCLONE_S3_DOWNLOAD_URL</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="s3-use-multipart-etag">–s3-use-multipart-etag</h4>
<p>Whether to use ETag in multipart uploads for verification</p>
<p>This should be true, false or left unset to use the default for the
provider.</p>
<p>Properties:</p>
<ul>
<li>Config: use_multipart_etag</li>
<li>Env Var: RCLONE_S3_USE_MULTIPART_ETAG</li>
<li>Type: Tristate</li>
<li>Default: unset</li>
</ul>
<h4 id="s3-use-presigned-request">–s3-use-presigned-request</h4>
<p>Whether to use a presigned request or PutObject for single part
uploads</p>
<p>If this is false rclone will use PutObject from the AWS SDK to upload
an object.</p>
<p>Versions of rclone &lt; 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>
<p>Properties:</p>
<ul>
<li>Config: use_presigned_request</li>
<li>Env Var: RCLONE_S3_USE_PRESIGNED_REQUEST</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="s3-versions">–s3-versions</h4>
<p>Include old versions in directory listings.</p>
<p>Properties:</p>
<ul>
<li>Config: versions</li>
<li>Env Var: RCLONE_S3_VERSIONS</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="s3-version-at">–s3-version-at</h4>
<p>Show file versions as they were at the specified time.</p>
<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>
<p>Note that when using this no file write operations are permitted, so
you can’t upload files or delete them.</p>
<p>See <a href="https://rclone.org/docs/#time-option">the time option
docs</a> for valid formats.</p>
<p>Properties:</p>
<ul>
<li>Config: version_at</li>
<li>Env Var: RCLONE_S3_VERSION_AT</li>
<li>Type: Time</li>
<li>Default: off</li>
</ul>
<h4 id="s3-decompress">–s3-decompress</h4>
<p>If set this will decompress gzip encoded objects.</p>
<p>It is possible to upload objects to S3 with “Content-Encoding: gzip”
set. Normally rclone will download these files as compressed
objects.</p>
<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>
<p>Properties:</p>
<ul>
<li>Config: decompress</li>
<li>Env Var: RCLONE_S3_DECOMPRESS</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="s3-might-gzip">–s3-might-gzip</h4>
<p>Set this if the backend might gzip objects.</p>
<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>
<p>However some providers may gzip objects even if they weren’t uploaded
with <code>Content-Encoding: gzip</code> (eg Cloudflare).</p>
<p>A symptom of this would be receiving errors like</p>
<pre><code>ERROR corrupted on transfer: sizes differ NNN vs MMM</code></pre>
<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>
<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>
<p>Properties:</p>
<ul>
<li>Config: might_gzip</li>
<li>Env Var: RCLONE_S3_MIGHT_GZIP</li>
<li>Type: Tristate</li>
<li>Default: unset</li>
</ul>
<h4 id="s3-no-system-metadata">–s3-no-system-metadata</h4>
<p>Suppress setting and reading of system metadata</p>
<p>Properties:</p>
<ul>
<li>Config: no_system_metadata</li>
<li>Env Var: RCLONE_S3_NO_SYSTEM_METADATA</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h3 id="metadata-2">Metadata</h3>
<p>User metadata is stored as x-amz-meta- keys. S3 metadata keys are
case insensitive and are always returned in lower case.</p>
<p>Here are the possible system metadata items for the s3 backend.</p>
<table>
<colgroup>
<col style="width: 15%" />
<col style="width: 15%" />
<col style="width: 15%" />
<col style="width: 23%" />
<col style="width: 28%" />
</colgroup>
<thead>
<tr class="header">
<th>Name</th>
<th>Help</th>
<th>Type</th>
<th>Example</th>
<th>Read Only</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>btime</td>
<td>Time of file birth (creation) read from Last-Modified header</td>
<td>RFC 3339</td>
<td>2006-01-02T15:04:05.999999999Z07:00</td>
<td><strong>Y</strong></td>
</tr>
<tr class="even">
<td>cache-control</td>
<td>Cache-Control header</td>
<td>string</td>
<td>no-cache</td>
<td>N</td>
</tr>
<tr class="odd">
<td>content-disposition</td>
<td>Content-Disposition header</td>
<td>string</td>
<td>inline</td>
<td>N</td>
</tr>
<tr class="even">
<td>content-encoding</td>
<td>Content-Encoding header</td>
<td>string</td>
<td>gzip</td>
<td>N</td>
</tr>
<tr class="odd">
<td>content-language</td>
<td>Content-Language header</td>
<td>string</td>
<td>en-US</td>
<td>N</td>
</tr>
<tr class="even">
<td>content-type</td>
<td>Content-Type header</td>
<td>string</td>
<td>text/plain</td>
<td>N</td>
</tr>
<tr class="odd">
<td>mtime</td>
<td>Time of last modification, read from rclone metadata</td>
<td>RFC 3339</td>
<td>2006-01-02T15:04:05.999999999Z07:00</td>
<td>N</td>
</tr>
<tr class="even">
<td>tier</td>
<td>Tier of the object</td>
<td>string</td>
<td>GLACIER</td>
<td><strong>Y</strong></td>
</tr>
</tbody>
</table>
<p>See the <a href="https://rclone.org/docs/#metadata">metadata</a> docs
for more info.</p>
<h2 id="backend-commands">Backend commands</h2>
<p>Here are the commands specific to the s3 backend.</p>
<p>Run them with</p>
<pre><code>rclone backend COMMAND remote:</code></pre>
<p>The help below will explain what arguments each command takes.</p>
<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>
<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>
<h3 id="restore">restore</h3>
<p>Restore objects from GLACIER to normal storage</p>
<pre><code>rclone backend restore remote: [options] [&lt;arguments&gt;+]</code></pre>
<p>This command can be used to restore one or more objects from GLACIER
to normal storage.</p>
<p>Usage Examples:</p>
<pre><code>rclone backend restore s3:bucket/path/to/object [-o priority=PRIORITY] [-o lifetime=DAYS]
rclone backend restore s3:bucket/path/to/directory [-o priority=PRIORITY] [-o lifetime=DAYS]
rclone backend restore s3:bucket [-o priority=PRIORITY] [-o lifetime=DAYS]</code></pre>
<p>This flag also obeys the filters. Test first with -i/–interactive or
–dry-run flags</p>
<pre><code>rclone -i backend restore --include &quot;*.txt&quot; s3:bucket/path -o priority=Standard</code></pre>
<p>All the objects shown will be marked for restore, then</p>
<pre><code>rclone backend restore --include &quot;*.txt&quot; s3:bucket/path -o priority=Standard</code></pre>
<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>
<pre><code>[
    {
        &quot;Status&quot;: &quot;OK&quot;,
        &quot;Path&quot;: &quot;test.txt&quot;
    },
    {
        &quot;Status&quot;: &quot;OK&quot;,
        &quot;Path&quot;: &quot;test/file4.txt&quot;
    }
]</code></pre>
<p>Options:</p>
<ul>
<li>“description”: The optional description for the job.</li>
<li>“lifetime”: Lifetime of the active copy in days</li>
<li>“priority”: Priority of restore: Standard|Expedited|Bulk</li>
</ul>
<h3 id="list-multipart-uploads">list-multipart-uploads</h3>
<p>List the unfinished multipart uploads</p>
<pre><code>rclone backend list-multipart-uploads remote: [options] [&lt;arguments&gt;+]</code></pre>
<p>This command lists the unfinished multipart uploads in JSON
format.</p>
<pre><code>rclone backend list-multipart s3:bucket/path/to/object</code></pre>
<p>It returns a dictionary of buckets with values as lists of unfinished
multipart uploads.</p>
<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>
<pre><code>{
  &quot;rclone&quot;: [
    {
      &quot;Initiated&quot;: &quot;2020-06-26T14:20:36Z&quot;,
      &quot;Initiator&quot;: {
        &quot;DisplayName&quot;: &quot;XXX&quot;,
        &quot;ID&quot;: &quot;arn:aws:iam::XXX:user/XXX&quot;
      },
      &quot;Key&quot;: &quot;KEY&quot;,
      &quot;Owner&quot;: {
        &quot;DisplayName&quot;: null,
        &quot;ID&quot;: &quot;XXX&quot;
      },
      &quot;StorageClass&quot;: &quot;STANDARD&quot;,
      &quot;UploadId&quot;: &quot;XXX&quot;
    }
  ],
  &quot;rclone-1000files&quot;: [],
  &quot;rclone-dst&quot;: []
}</code></pre>
<h3 id="cleanup-2">cleanup</h3>
<p>Remove unfinished multipart uploads.</p>
<pre><code>rclone backend cleanup remote: [options] [&lt;arguments&gt;+]</code></pre>
<p>This command removes unfinished multipart uploads of age greater than
max-age which defaults to 24 hours.</p>
<p>Note that you can use -i/–dry-run with this command to see what it
would do.</p>
<pre><code>rclone backend cleanup s3:bucket/path/to/object
rclone backend cleanup -o max-age=7w s3:bucket/path/to/object</code></pre>
<p>Durations are parsed as per the rest of rclone, 2h, 7d, 7w etc.</p>
<p>Options:</p>
<ul>
<li>“max-age”: Max age of upload to delete</li>
</ul>
<h3 id="cleanup-hidden">cleanup-hidden</h3>
<p>Remove old versions of files.</p>
<pre><code>rclone backend cleanup-hidden remote: [options] [&lt;arguments&gt;+]</code></pre>
<p>This command removes any old hidden versions of files on a versions
enabled bucket.</p>
<p>Note that you can use -i/–dry-run with this command to see what it
would do.</p>
<pre><code>rclone backend cleanup-hidden s3:bucket/path/to/dir</code></pre>
<h3 id="versioning">versioning</h3>
<p>Set/get versioning support for a bucket.</p>
<pre><code>rclone backend versioning remote: [options] [&lt;arguments&gt;+]</code></pre>
<p>This command sets versioning support if a parameter is passed and
then returns the current versioning status for the bucket supplied.</p>
<pre><code>rclone backend versioning s3:bucket # read status only
rclone backend versioning s3:bucket Enabled
rclone backend versioning s3:bucket Suspended</code></pre>
<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>
<h3 id="anonymous-access-to-public-buckets">Anonymous access to public
buckets</h3>
<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>
<pre><code>[anons3]
type = s3
provider = AWS
env_auth = false
access_key_id =
secret_access_key =
region = us-east-1
endpoint =
location_constraint =
acl = private
server_side_encryption =
storage_class =</code></pre>
<p>Then use it as normal with the name of the public bucket, e.g.</p>
<pre><code>rclone lsd anons3:1000genomes</code></pre>
<p>You will be able to list and copy data but not upload it.</p>
<h2 id="providers-1">Providers</h2>
<h3 id="aws-s3">AWS S3</h3>
<p>This is the provider used as main example and described in the <a
href="#configuration">configuration</a> section above.</p>
<h3 id="aws-snowball-edge">AWS Snowball Edge</h3>
<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>
<p>To use rclone with AWS Snowball Edge devices, configure as standard
for an ‘S3 Compatible Service’.</p>
<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>
<p>With rclone v1.59 or later setting <code>upload_cutoff</code> should
not be necessary.</p>
<p>eg.</p>
<pre><code>[snowball]
type = s3
provider = Other
access_key_id = YOUR_ACCESS_KEY
secret_access_key = YOUR_SECRET_KEY
endpoint = http://[IP of Snowball]:8080
upload_cutoff = 0</code></pre>
<h3 id="ceph">Ceph</h3>
<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>
<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>
<pre><code>[ceph]
type = s3
provider = Ceph
env_auth = false
access_key_id = XXX
secret_access_key = YYY
region =
endpoint = https://ceph.endpoint.example.com
location_constraint =
acl =
server_side_encryption =
storage_class =</code></pre>
<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>
<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>
<p>Eg the dump from Ceph looks something like this (irrelevant keys
removed).</p>
<pre><code>{
    &quot;user_id&quot;: &quot;xxx&quot;,
    &quot;display_name&quot;: &quot;xxxx&quot;,
    &quot;keys&quot;: [
        {
            &quot;user&quot;: &quot;xxx&quot;,
            &quot;access_key&quot;: &quot;xxxxxx&quot;,
            &quot;secret_key&quot;: &quot;xxxxxx\/xxxx&quot;
        }
    ],
}</code></pre>
<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>
<h3 id="cloudflare-r2">Cloudflare R2</h3>
<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>
<p>Here is an example of making a Cloudflare R2 configuration. First
run:</p>
<pre><code>rclone config</code></pre>
<p>This will guide you through an interactive setup process.</p>
<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>
<pre><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; r2
Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
...
XX / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, China Mobile, Cloudflare, ArvanCloud, Digital Ocean, Dreamhost, Huawei OBS, IBM COS, Lyve Cloud, Minio, Netease, RackCorp, Scaleway, SeaweedFS, StackPath, Storj, Tencent COS and Wasabi
   \ (s3)
...
Storage&gt; s3
Option provider.
Choose your S3 provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
...
XX / Cloudflare R2 Storage
   \ (Cloudflare)
...
provider&gt; Cloudflare
Option env_auth.
Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).
Only applies if access_key_id and secret_access_key is blank.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth&gt; 1
Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id&gt; ACCESS_KEY
Option secret_access_key.
AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key&gt; SECRET_ACCESS_KEY
Option region.
Region to connect to.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / R2 buckets are automatically distributed across Cloudflare&#39;s data centers for low latency.
   \ (auto)
region&gt; 1
Option endpoint.
Endpoint for S3 API.
Required when using an S3 clone.
Enter a value. Press Enter to leave empty.
endpoint&gt; https://ACCOUNT_ID.r2.cloudflarestorage.com
Edit advanced config?
y) Yes
n) No (default)
y/n&gt; n
--------------------
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<p>This will leave your config looking something like:</p>
<pre><code>[r2]
type = s3
provider = Cloudflare
access_key_id = ACCESS_KEY
secret_access_key = SECRET_ACCESS_KEY
region = auto
endpoint = https://ACCOUNT_ID.r2.cloudflarestorage.com
acl = private</code></pre>
<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>
<h3 id="dreamhost">Dreamhost</h3>
<p>Dreamhost <a
href="https://www.dreamhost.com/cloud/storage/">DreamObjects</a> is an
object storage system based on CEPH.</p>
<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>
<pre><code>[dreamobjects]
type = s3
provider = DreamHost
env_auth = false
access_key_id = your_access_key
secret_access_key = your_secret_key
region =
endpoint = objects-us-west-1.dream.io
location_constraint =
acl = private
server_side_encryption =
storage_class =</code></pre>
<h3 id="digitalocean-spaces">DigitalOcean Spaces</h3>
<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>
<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
&amp; 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>
<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>
<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>
<pre><code>Storage&gt; s3
env_auth&gt; 1
access_key_id&gt; YOUR_ACCESS_KEY
secret_access_key&gt; YOUR_SECRET_KEY
region&gt;
endpoint&gt; nyc3.digitaloceanspaces.com
location_constraint&gt;
acl&gt;
storage_class&gt;</code></pre>
<p>The resulting configuration file should look like:</p>
<pre><code>[spaces]
type = s3
provider = DigitalOcean
env_auth = false
access_key_id = YOUR_ACCESS_KEY
secret_access_key = YOUR_SECRET_KEY
region =
endpoint = nyc3.digitaloceanspaces.com
location_constraint =
acl =
server_side_encryption =
storage_class =</code></pre>
<p>Once configured, you can create a new Space and begin copying files.
For example:</p>
<pre><code>rclone mkdir spaces:my-new-space
rclone copy /path/to/files spaces:my-new-space</code></pre>
<h3 id="huawei-obs">Huawei OBS</h3>
<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>
<p>OBS provides an S3 interface, you can copy and modify the following
configuration and add it to your rclone configuration file.</p>
<pre><code>[obs]
type = s3
provider = HuaweiOBS
access_key_id = your-access-key-id
secret_access_key = your-secret-access-key
region = af-south-1
endpoint = obs.af-south-1.myhuaweicloud.com
acl = private</code></pre>
<p>Or you can also configure via the interactive command line:</p>
<pre><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; obs
Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
[snip]
 5 / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, China Mobile, Cloudflare, ArvanCloud, Digital Ocean, Dreamhost, Huawei OBS, IBM COS, Lyve Cloud, Minio, Netease, RackCorp, Scaleway, SeaweedFS, StackPath, Storj, Tencent COS and Wasabi
   \ (s3)
[snip]
Storage&gt; 5
Option provider.
Choose your S3 provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
[snip]
 9 / Huawei Object Storage Service
   \ (HuaweiOBS)
[snip]
provider&gt; 9
Option env_auth.
Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).
Only applies if access_key_id and secret_access_key is blank.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth&gt; 1
Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id&gt; your-access-key-id
Option secret_access_key.
AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key&gt; your-secret-access-key
Option region.
Region to connect to.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / AF-Johannesburg
   \ (af-south-1)
 2 / AP-Bangkok
   \ (ap-southeast-2)
[snip]
region&gt; 1
Option endpoint.
Endpoint for OBS API.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / AF-Johannesburg
   \ (obs.af-south-1.myhuaweicloud.com)
 2 / AP-Bangkok
   \ (obs.ap-southeast-2.myhuaweicloud.com)
[snip]
endpoint&gt; 1
Option acl.
Canned ACL used when creating buckets and storing or copying objects.
This ACL is used for creating objects and if bucket_acl isn&#39;t set, for creating buckets too.
For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl
Note that this ACL is applied when server-side copying objects as S3
doesn&#39;t copy the ACL from the source but rather writes a fresh one.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
   / Owner gets FULL_CONTROL.
 1 | No one else has access rights (default).
   \ (private)
[snip]
acl&gt; 1
Edit advanced config?
y) Yes
n) No (default)
y/n&gt;
--------------------
[obs]
type = s3
provider = HuaweiOBS
access_key_id = your-access-key-id
secret_access_key = your-secret-access-key
region = af-south-1
endpoint = obs.af-south-1.myhuaweicloud.com
acl = private
--------------------
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d&gt; y
Current remotes:

Name                 Type
====                 ====
obs                  s3

e) Edit existing remote
n) New remote
d) Delete remote
r) Rename remote
c) Copy remote
s) Set configuration password
q) Quit config
e/n/d/r/c/s/q&gt; q</code></pre>
<h3 id="ibm-cos-s3">IBM COS (S3)</h3>
<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>
<p>To configure access to IBM COS S3, follow the steps below:</p>
<ol type="1">
<li>Run rclone config and select n for a new remote.</li>
</ol>
<pre><code>    2018/02/14 14:13:11 NOTICE: Config file &quot;C:\\Users\\a\\.config\\rclone\\rclone.conf&quot; not found - using defaults
    No remotes found, make a new one?
    n) New remote
    s) Set configuration password
    q) Quit config
    n/s/q&gt; n</code></pre>
<ol start="2" type="1">
<li>Enter the name for the configuration</li>
</ol>
<pre><code>    name&gt; &lt;YOUR NAME&gt;</code></pre>
<ol start="3" type="1">
<li>Select “s3” storage.</li>
</ol>
<pre><code>Choose a number from below, or type in your own value
    1 / Alias for an existing remote
    \ &quot;alias&quot;
    2 / Amazon Drive
    \ &quot;amazon cloud drive&quot;
    3 / Amazon S3 Complaint Storage Providers (Dreamhost, Ceph, ChinaMobile, ArvanCloud, Minio, IBM COS)
    \ &quot;s3&quot;
    4 / Backblaze B2
    \ &quot;b2&quot;
[snip]
    23 / HTTP
    \ &quot;http&quot;
Storage&gt; 3</code></pre>
<ol start="4" type="1">
<li>Select IBM COS as the S3 Storage Provider.</li>
</ol>
<pre><code>Choose the S3 provider.
Choose a number from below, or type in your own value
     1 / Choose this option to configure Storage to AWS S3
       \ &quot;AWS&quot;
     2 / Choose this option to configure Storage to Ceph Systems
     \ &quot;Ceph&quot;
     3 /  Choose this option to configure Storage to Dreamhost
     \ &quot;Dreamhost&quot;
   4 / Choose this option to the configure Storage to IBM COS S3
     \ &quot;IBMCOS&quot;
     5 / Choose this option to the configure Storage to Minio
     \ &quot;Minio&quot;
     Provider&gt;4</code></pre>
<ol start="5" type="1">
<li>Enter the Access Key and Secret.</li>
</ol>
<pre><code>    AWS Access Key ID - leave blank for anonymous access or runtime credentials.
    access_key_id&gt; &lt;&gt;
    AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials.
    secret_access_key&gt; &lt;&gt;</code></pre>
<ol start="6" type="1">
<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>
</ol>
<pre><code>    Endpoint for IBM COS S3 API.
    Specify if using an IBM COS On Premise.
    Choose a number from below, or type in your own value
     1 / US Cross Region Endpoint
       \ &quot;s3-api.us-geo.objectstorage.softlayer.net&quot;
     2 / US Cross Region Dallas Endpoint
       \ &quot;s3-api.dal.us-geo.objectstorage.softlayer.net&quot;
     3 / US Cross Region Washington DC Endpoint
       \ &quot;s3-api.wdc-us-geo.objectstorage.softlayer.net&quot;
     4 / US Cross Region San Jose Endpoint
       \ &quot;s3-api.sjc-us-geo.objectstorage.softlayer.net&quot;
     5 / US Cross Region Private Endpoint
       \ &quot;s3-api.us-geo.objectstorage.service.networklayer.com&quot;
     6 / US Cross Region Dallas Private Endpoint
       \ &quot;s3-api.dal-us-geo.objectstorage.service.networklayer.com&quot;
     7 / US Cross Region Washington DC Private Endpoint
       \ &quot;s3-api.wdc-us-geo.objectstorage.service.networklayer.com&quot;
     8 / US Cross Region San Jose Private Endpoint
       \ &quot;s3-api.sjc-us-geo.objectstorage.service.networklayer.com&quot;
     9 / US Region East Endpoint
       \ &quot;s3.us-east.objectstorage.softlayer.net&quot;
    10 / US Region East Private Endpoint
       \ &quot;s3.us-east.objectstorage.service.networklayer.com&quot;
    11 / US Region South Endpoint
[snip]
    34 / Toronto Single Site Private Endpoint
       \ &quot;s3.tor01.objectstorage.service.networklayer.com&quot;
    endpoint&gt;1</code></pre>
<ol start="7" type="1">
<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>
</ol>
<pre><code>     1 / US Cross Region Standard
       \ &quot;us-standard&quot;
     2 / US Cross Region Vault
       \ &quot;us-vault&quot;
     3 / US Cross Region Cold
       \ &quot;us-cold&quot;
     4 / US Cross Region Flex
       \ &quot;us-flex&quot;
     5 / US East Region Standard
       \ &quot;us-east-standard&quot;
     6 / US East Region Vault
       \ &quot;us-east-vault&quot;
     7 / US East Region Cold
       \ &quot;us-east-cold&quot;
     8 / US East Region Flex
       \ &quot;us-east-flex&quot;
     9 / US South Region Standard
       \ &quot;us-south-standard&quot;
    10 / US South Region Vault
       \ &quot;us-south-vault&quot;
[snip]
    32 / Toronto Flex
       \ &quot;tor01-flex&quot;
location_constraint&gt;1</code></pre>
<ol start="9" type="1">
<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>
</ol>
<pre><code>Canned ACL used when creating buckets and/or storing objects in S3.
For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl
Choose a number from below, or type in your own value
      1 / Owner gets FULL_CONTROL. No one else has access rights (default). This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On-Premise COS
      \ &quot;private&quot;
      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
      \ &quot;public-read&quot;
      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
      \ &quot;public-read-write&quot;
      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
      \ &quot;authenticated-read&quot;
acl&gt; 1</code></pre>
<ol start="12" type="1">
<li>Review the displayed configuration and accept to save the “remote”
then quit. The config file should look like this</li>
</ol>
<pre><code>    [xxx]
    type = s3
    Provider = IBMCOS
    access_key_id = xxx
    secret_access_key = yyy
    endpoint = s3-api.us-geo.objectstorage.softlayer.net
    location_constraint = us-standard
    acl = private</code></pre>
<ol start="13" type="1">
<li>Execute rclone commands</li>
</ol>
<pre><code>    1)  Create a bucket.
        rclone mkdir IBM-COS-XREGION:newbucket
    2)  List available buckets.
        rclone lsd IBM-COS-XREGION:
        -1 2017-11-08 21:16:22        -1 test
        -1 2018-02-14 20:16:39        -1 newbucket
    3)  List contents of a bucket.
        rclone ls IBM-COS-XREGION:newbucket
        18685952 test.exe
    4)  Copy a file from local to remote.
        rclone copy /Users/file.txt IBM-COS-XREGION:newbucket
    5)  Copy a file from remote to local.
        rclone copy IBM-COS-XREGION:newbucket/file.txt .
    6)  Delete a file on remote.
        rclone delete IBM-COS-XREGION:newbucket/file.txt</code></pre>
<h3 id="idrive-e2">IDrive e2</h3>
<p>Here is an example of making an <a
href="https://www.idrive.com/e2/">IDrive e2</a> configuration. First
run:</p>
<pre><code>rclone config</code></pre>
<p>This will guide you through an interactive setup process.</p>
<pre><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n

Enter name for new remote.
name&gt; e2

Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
[snip]
XX / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, China Mobile, Cloudflare, ArvanCloud, Digital Ocean, Dreamhost, Huawei OBS, IBM COS, IDrive e2, Lyve Cloud, Minio, Netease, RackCorp, Scaleway, SeaweedFS, StackPath, Storj, Tencent COS and Wasabi
   \ (s3)
[snip]
Storage&gt; s3

Option provider.
Choose your S3 provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
[snip]
XX / IDrive e2
   \ (IDrive)
[snip]
provider&gt; IDrive

Option env_auth.
Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).
Only applies if access_key_id and secret_access_key is blank.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth&gt;

Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id&gt; YOUR_ACCESS_KEY

Option secret_access_key.
AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key&gt; YOUR_SECRET_KEY

Option acl.
Canned ACL used when creating buckets and storing or copying objects.
This ACL is used for creating objects and if bucket_acl isn&#39;t set, for creating buckets too.
For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl
Note that this ACL is applied when server-side copying objects as S3
doesn&#39;t copy the ACL from the source but rather writes a fresh one.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
   / Owner gets FULL_CONTROL.
 1 | No one else has access rights (default).
   \ (private)
   / Owner gets FULL_CONTROL.
 2 | The AllUsers group gets READ access.
   \ (public-read)
   / Owner gets FULL_CONTROL.
 3 | The AllUsers group gets READ and WRITE access.
   | Granting this on a bucket is generally not recommended.
   \ (public-read-write)
   / Owner gets FULL_CONTROL.
 4 | The AuthenticatedUsers group gets READ access.
   \ (authenticated-read)
   / Object owner gets FULL_CONTROL.
 5 | Bucket owner gets READ access.
   | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.
   \ (bucket-owner-read)
   / Both the object owner and the bucket owner get FULL_CONTROL over the object.
 6 | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.
   \ (bucket-owner-full-control)
acl&gt;

Edit advanced config?
y) Yes
n) No (default)
y/n&gt;

Configuration complete.
Options:
- type: s3
- provider: IDrive
- access_key_id: YOUR_ACCESS_KEY
- secret_access_key: YOUR_SECRET_KEY
- endpoint: q9d9.la12.idrivee2-5.com
Keep this &quot;e2&quot; remote?
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<h3 id="ionos">IONOS Cloud</h3>
<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> &gt; <strong>Object Storage Key
Manager</strong>.</p>
<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>
<pre><code>Enter name for new remote.
name&gt; ionos-fra</code></pre>
<p>Type <code>s3</code> to choose the connection type:</p>
<pre><code>Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
[snip]
XX / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, China Mobile, Cloudflare, ArvanCloud, Digital Ocean, Dreamhost, Huawei OBS, IBM COS, IDrive e2, IONOS Cloud, Lyve Cloud, Minio, Netease, RackCorp, Scaleway, SeaweedFS, StackPath, Storj, Tencent COS and Wasabi
   \ (s3)
[snip]
Storage&gt; s3</code></pre>
<p>Type <code>IONOS</code>:</p>
<pre><code>Option provider.
Choose your S3 provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
[snip]
XX / IONOS Cloud
   \ (IONOS)
[snip]
provider&gt; IONOS</code></pre>
<p>Press Enter to choose the default option
<code>Enter AWS credentials in the next step</code>:</p>
<pre><code>Option env_auth.
Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).
Only applies if access_key_id and secret_access_key is blank.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth&gt;</code></pre>
<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>
<pre><code>Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id&gt; YOUR_ACCESS_KEY

Option secret_access_key.
AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key&gt; YOUR_SECRET_KEY</code></pre>
<p>Choose the region where your bucket is located:</p>
<pre><code>Option region.
Region where your bucket will be created and your data stored.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / Frankfurt, Germany
   \ (de)
 2 / Berlin, Germany
   \ (eu-central-2)
 3 / Logrono, Spain
   \ (eu-south-2)
region&gt; 2</code></pre>
<p>Choose the endpoint from the same region:</p>
<pre><code>Option endpoint.
Endpoint for IONOS S3 Object Storage.
Specify the endpoint from the same region.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / Frankfurt, Germany
   \ (s3-eu-central-1.ionoscloud.com)
 2 / Berlin, Germany
   \ (s3-eu-central-2.ionoscloud.com)
 3 / Logrono, Spain
   \ (s3-eu-south-2.ionoscloud.com)
endpoint&gt; 1</code></pre>
<p>Press Enter to choose the default option or choose the desired ACL
setting:</p>
<pre><code>Option acl.
Canned ACL used when creating buckets and storing or copying objects.
This ACL is used for creating objects and if bucket_acl isn&#39;t set, for creating buckets too.
For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl
Note that this ACL is applied when server-side copying objects as S3
doesn&#39;t copy the ACL from the source but rather writes a fresh one.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
   / Owner gets FULL_CONTROL.
 1 | No one else has access rights (default).
   \ (private)
   / Owner gets FULL_CONTROL.
[snip]
acl&gt;</code></pre>
<p>Press Enter to skip the advanced config:</p>
<pre><code>Edit advanced config?
y) Yes
n) No (default)
y/n&gt;</code></pre>
<p>Press Enter to save the configuration, and then <code>q</code> to
quit the configuration process:</p>
<pre><code>Configuration complete.
Options:
- type: s3
- provider: IONOS
- access_key_id: YOUR_ACCESS_KEY
- secret_access_key: YOUR_SECRET_KEY
- endpoint: s3-eu-central-1.ionoscloud.com
Keep this &quot;ionos-fra&quot; remote?
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<p>Done! Now you can try some commands (for macOS, use
<code>./rclone</code> instead of <code>rclone</code>).</p>
<ol type="1">
<li>Create a bucket (the name must be unique within the whole IONOS
S3)</li>
</ol>
<pre><code>rclone mkdir ionos-fra:my-bucket</code></pre>
<ol start="2" type="1">
<li>List available buckets</li>
</ol>
<pre><code>rclone lsd ionos-fra:</code></pre>
<ol start="4" type="1">
<li>Copy a file from local to remote</li>
</ol>
<pre><code>rclone copy /Users/file.txt ionos-fra:my-bucket</code></pre>
<ol start="3" type="1">
<li>List contents of a bucket</li>
</ol>
<pre><code>rclone ls ionos-fra:my-bucket</code></pre>
<ol start="5" type="1">
<li>Copy a file from remote to local</li>
</ol>
<pre><code>rclone copy ionos-fra:my-bucket/file.txt</code></pre>
<h3 id="minio">Minio</h3>
<p><a href="https://minio.io/">Minio</a> is an object storage server
built for cloud application developers and devops.</p>
<p>It is very easy to install and provides an S3 compatible server which
can be used by rclone.</p>
<p>To use it, install Minio following the instructions <a
href="https://docs.minio.io/docs/minio-quickstart-guide">here</a>.</p>
<p>When it configures itself Minio will print something like this</p>
<pre><code>Endpoint:  http://192.168.1.106:9000  http://172.23.0.1:9000
AccessKey: USWUXHGYZQYFYFFIT3RE
SecretKey: MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03
Region:    us-east-1
SQS ARNs:  arn:minio:sqs:us-east-1:1:redis arn:minio:sqs:us-east-1:2:redis

Browser Access:
   http://192.168.1.106:9000  http://172.23.0.1:9000

Command-line Access: https://docs.minio.io/docs/minio-client-quickstart-guide
   $ mc config host add myminio http://192.168.1.106:9000 USWUXHGYZQYFYFFIT3RE MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03

Object API (Amazon S3 compatible):
   Go:         https://docs.minio.io/docs/golang-client-quickstart-guide
   Java:       https://docs.minio.io/docs/java-client-quickstart-guide
   Python:     https://docs.minio.io/docs/python-client-quickstart-guide
   JavaScript: https://docs.minio.io/docs/javascript-client-quickstart-guide
   .NET:       https://docs.minio.io/docs/dotnet-client-quickstart-guide

Drive Capacity: 26 GiB Free, 165 GiB Total</code></pre>
<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>
<pre><code>env_auth&gt; 1
access_key_id&gt; USWUXHGYZQYFYFFIT3RE
secret_access_key&gt; MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03
region&gt; us-east-1
endpoint&gt; http://192.168.1.106:9000
location_constraint&gt;
server_side_encryption&gt;</code></pre>
<p>Which makes the config file look like this</p>
<pre><code>[minio]
type = s3
provider = Minio
env_auth = false
access_key_id = USWUXHGYZQYFYFFIT3RE
secret_access_key = MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03
region = us-east-1
endpoint = http://192.168.1.106:9000
location_constraint =
server_side_encryption =</code></pre>
<p>So once set up, for example, to copy files into a bucket</p>
<pre><code>rclone copy /path/to/files minio:bucket</code></pre>
<h3 id="qiniu">Qiniu Cloud Object Storage (Kodo)</h3>
<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>
<p>To configure access to Qiniu Kodo, follow the steps below:</p>
<ol type="1">
<li>Run <code>rclone config</code> and select <code>n</code> for a new
remote.</li>
</ol>
<pre><code>rclone config
No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n</code></pre>
<ol start="2" type="1">
<li>Give the name of the configuration. For example, name it
‘qiniu’.</li>
</ol>
<pre><code>name&gt; qiniu</code></pre>
<ol start="3" type="1">
<li>Select <code>s3</code> storage.</li>
</ol>
<pre><code>Choose a number from below, or type in your own value
 1 / 1Fichier
   \ (fichier)
 2 / Akamai NetStorage
   \ (netstorage)
 3 / Alias for an existing remote
   \ (alias)
 4 / Amazon Drive
   \ (amazon cloud drive)
 5 / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, China Mobile, Cloudflare, ArvanCloud, Digital Ocean, Dreamhost, Huawei OBS, IBM COS, IDrive e2, Lyve Cloud, Minio, Netease, RackCorp, Scaleway, SeaweedFS, StackPath, Storj, Tencent COS, Qiniu and Wasabi
   \ (s3)
[snip]
Storage&gt; s3</code></pre>
<ol start="4" type="1">
<li>Select <code>Qiniu</code> provider.</li>
</ol>
<pre><code>Choose a number from below, or type in your own value
1 / Amazon Web Services (AWS) S3
   \ &quot;AWS&quot;
[snip]
22 / Qiniu Object Storage (Kodo)
   \ (Qiniu)
[snip]
provider&gt; Qiniu</code></pre>
<ol start="5" type="1">
<li>Enter your SecretId and SecretKey of Qiniu Kodo.</li>
</ol>
<pre><code>Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).
Only applies if access_key_id and secret_access_key is blank.
Enter a boolean value (true or false). Press Enter for the default (&quot;false&quot;).
Choose a number from below, or type in your own value
 1 / Enter AWS credentials in the next step
   \ &quot;false&quot;
 2 / Get AWS credentials from the environment (env vars or IAM)
   \ &quot;true&quot;
env_auth&gt; 1
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a string value. Press Enter for the default (&quot;&quot;).
access_key_id&gt; AKIDxxxxxxxxxx
AWS Secret Access Key (password)
Leave blank for anonymous access or runtime credentials.
Enter a string value. Press Enter for the default (&quot;&quot;).
secret_access_key&gt; xxxxxxxxxxx</code></pre>
<ol start="6" type="1">
<li>Select endpoint for Qiniu Kodo. This is the standard endpoint for
different region.</li>
</ol>
<pre><code>   / The default endpoint - a good choice if you are unsure.
 1 | East China Region 1.
   | Needs location constraint cn-east-1.
   \ (cn-east-1)
   / East China Region 2.
 2 | Needs location constraint cn-east-2.
   \ (cn-east-2)
   / North China Region 1.
 3 | Needs location constraint cn-north-1.
   \ (cn-north-1)
   / South China Region 1.
 4 | Needs location constraint cn-south-1.
   \ (cn-south-1)
   / North America Region.
 5 | Needs location constraint us-north-1.
   \ (us-north-1)
   / Southeast Asia Region 1.
 6 | Needs location constraint ap-southeast-1.
   \ (ap-southeast-1)
   / Northeast Asia Region 1.
 7 | Needs location constraint ap-northeast-1.
   \ (ap-northeast-1)
[snip]
endpoint&gt; 1

Option endpoint.
Endpoint for Qiniu Object Storage.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / East China Endpoint 1
   \ (s3-cn-east-1.qiniucs.com)
 2 / East China Endpoint 2
   \ (s3-cn-east-2.qiniucs.com)
 3 / North China Endpoint 1
   \ (s3-cn-north-1.qiniucs.com)
 4 / South China Endpoint 1
   \ (s3-cn-south-1.qiniucs.com)
 5 / North America Endpoint 1
   \ (s3-us-north-1.qiniucs.com)
 6 / Southeast Asia Endpoint 1
   \ (s3-ap-southeast-1.qiniucs.com)
 7 / Northeast Asia Endpoint 1
   \ (s3-ap-northeast-1.qiniucs.com)
endpoint&gt; 1

Option location_constraint.
Location constraint - must be set to match the Region.
Used when creating buckets only.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / East China Region 1
   \ (cn-east-1)
 2 / East China Region 2
   \ (cn-east-2)
 3 / North China Region 1
   \ (cn-north-1)
 4 / South China Region 1
   \ (cn-south-1)
 5 / North America Region 1
   \ (us-north-1)
 6 / Southeast Asia Region 1
   \ (ap-southeast-1)
 7 / Northeast Asia Region 1
   \ (ap-northeast-1)
location_constraint&gt; 1</code></pre>
<ol start="7" type="1">
<li>Choose acl and storage class.</li>
</ol>
<pre><code>Note that this ACL is applied when server-side copying objects as S3
doesn&#39;t copy the ACL from the source but rather writes a fresh one.
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
   / Owner gets FULL_CONTROL.
 1 | No one else has access rights (default).
   \ (private)
   / Owner gets FULL_CONTROL.
 2 | The AllUsers group gets READ access.
   \ (public-read)
[snip]
acl&gt; 2
The storage class to use when storing new objects in Tencent COS.
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
 1 / Standard storage class
   \ (STANDARD)
 2 / Infrequent access storage mode
   \ (LINE)
 3 / Archive storage mode
   \ (GLACIER)
 4 / Deep archive storage mode
   \ (DEEP_ARCHIVE)
[snip]
storage_class&gt; 1
Edit advanced config? (y/n)
y) Yes
n) No (default)
y/n&gt; n
Remote config
--------------------
[qiniu]
- type: s3
- provider: Qiniu
- access_key_id: xxx
- secret_access_key: xxx
- region: cn-east-1
- endpoint: s3-cn-east-1.qiniucs.com
- location_constraint: cn-east-1
- acl: public-read
- storage_class: STANDARD
--------------------
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d&gt; y
Current remotes:

Name                 Type
====                 ====
qiniu                s3</code></pre>
<h3 id="RackCorp">RackCorp</h3>
<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>
<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>
<p>Your config should end up looking a bit like this:</p>
<pre><code>[RCS3-demo-config]
type = s3
provider = RackCorp
env_auth = true
access_key_id = YOURACCESSKEY
secret_access_key = YOURSECRETACCESSKEY
region = au-nsw
endpoint = s3.rackcorp.com
location_constraint = au-nsw</code></pre>
<h3 id="scaleway">Scaleway</h3>
<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>
<p>Scaleway provides an S3 interface which can be configured for use
with rclone like this:</p>
<pre><code>[scaleway]
type = s3
provider = Scaleway
env_auth = false
endpoint = s3.nl-ams.scw.cloud
access_key_id = SCWXXXXXXXXXXXXXX
secret_access_key = 1111111-2222-3333-44444-55555555555555
region = nl-ams
location_constraint =
acl = private
server_side_encryption =
storage_class =</code></pre>
<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>
<h3 id="lyve">Seagate Lyve Cloud</h3>
<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>
<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>
<pre><code>$ rclone config
No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; remote</code></pre>
<p>Choose <code>s3</code> backend</p>
<pre><code>Type of storage to configure.
Choose a number from below, or type in your own value.
[snip]
XX / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, ChinaMobile, ArvanCloud, Digital Ocean, Dreamhost, Huawei OBS, IBM COS, Lyve Cloud, Minio, RackCorp, SeaweedFS, and Tencent COS
   \ (s3)
[snip]
Storage&gt; s3</code></pre>
<p>Choose <code>LyveCloud</code> as S3 provider</p>
<pre><code>Choose your S3 provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
[snip]
XX / Seagate Lyve Cloud
   \ (LyveCloud)
[snip]
provider&gt; LyveCloud</code></pre>
<p>Take the default (just press enter) to enter access key and secret in
the config file.</p>
<pre><code>Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).
Only applies if access_key_id and secret_access_key is blank.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth&gt;</code></pre>
<pre><code>AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id&gt; XXX</code></pre>
<pre><code>AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key&gt; YYY</code></pre>
<p>Leave region blank</p>
<pre><code>Region to connect to.
Leave blank if you are using an S3 clone and you don&#39;t have a region.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
   / Use this if unsure.
 1 | Will use v4 signatures and an empty region.
   \ ()
   / Use this only if v4 signatures don&#39;t work.
 2 | E.g. pre Jewel/v10 CEPH.
   \ (other-v2-signature)
region&gt;</code></pre>
<p>Choose an endpoint from the list</p>
<pre><code>Endpoint for S3 API.
Required when using an S3 clone.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / Seagate Lyve Cloud US East 1 (Virginia)
   \ (s3.us-east-1.lyvecloud.seagate.com)
 2 / Seagate Lyve Cloud US West 1 (California)
   \ (s3.us-west-1.lyvecloud.seagate.com)
 3 / Seagate Lyve Cloud AP Southeast 1 (Singapore)
   \ (s3.ap-southeast-1.lyvecloud.seagate.com)
endpoint&gt; 1</code></pre>
<p>Leave location constraint blank</p>
<pre><code>Location constraint - must be set to match the Region.
Leave blank if not sure. Used when creating buckets only.
Enter a value. Press Enter to leave empty.
location_constraint&gt;</code></pre>
<p>Choose default ACL (<code>private</code>).</p>
<pre><code>Canned ACL used when creating buckets and storing or copying objects.
This ACL is used for creating objects and if bucket_acl isn&#39;t set, for creating buckets too.
For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl
Note that this ACL is applied when server-side copying objects as S3
doesn&#39;t copy the ACL from the source but rather writes a fresh one.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
   / Owner gets FULL_CONTROL.
 1 | No one else has access rights (default).
   \ (private)
[snip]
acl&gt;</code></pre>
<p>And the config file should end up looking like this:</p>
<pre><code>[remote]
type = s3
provider = LyveCloud
access_key_id = XXX
secret_access_key = YYY
endpoint = s3.us-east-1.lyvecloud.seagate.com</code></pre>
<h3 id="seaweedfs">SeaweedFS</h3>
<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>
<p>Assuming the SeaweedFS are configured with <code>weed shell</code> as
such:</p>
<pre><code>&gt; s3.bucket.create -name foo
&gt; s3.configure -access_key=any -secret_key=any -buckets=foo -user=me -actions=Read,Write,List,Tagging,Admin -apply
{
  &quot;identities&quot;: [
    {
      &quot;name&quot;: &quot;me&quot;,
      &quot;credentials&quot;: [
        {
          &quot;accessKey&quot;: &quot;any&quot;,
          &quot;secretKey&quot;: &quot;any&quot;
        }
      ],
      &quot;actions&quot;: [
        &quot;Read:foo&quot;,
        &quot;Write:foo&quot;,
        &quot;List:foo&quot;,
        &quot;Tagging:foo&quot;,
        &quot;Admin:foo&quot;
      ]
    }
  ]
}</code></pre>
<p>To use rclone with SeaweedFS, above configuration should end up with
something like this in your config:</p>
<pre><code>[seaweedfs_s3]
type = s3
provider = SeaweedFS
access_key_id = any
secret_access_key = any
endpoint = localhost:8333</code></pre>
<p>So once set up, for example to copy files into a bucket</p>
<pre><code>rclone copy /path/to/files seaweedfs_s3:foo</code></pre>
<h3 id="wasabi">Wasabi</h3>
<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>
<p>Wasabi provides an S3 interface which can be configured for use with
rclone like this.</p>
<pre><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
n/s&gt; n
name&gt; wasabi
Type of storage to configure.
Choose a number from below, or type in your own value
[snip]
XX / Amazon S3 (also Dreamhost, Ceph, ChinaMobile, ArvanCloud, Minio)
   \ &quot;s3&quot;
[snip]
Storage&gt; s3
Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank.
Choose a number from below, or type in your own value
 1 / Enter AWS credentials in the next step
   \ &quot;false&quot;
 2 / Get AWS credentials from the environment (env vars or IAM)
   \ &quot;true&quot;
env_auth&gt; 1
AWS Access Key ID - leave blank for anonymous access or runtime credentials.
access_key_id&gt; YOURACCESSKEY
AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials.
secret_access_key&gt; YOURSECRETACCESSKEY
Region to connect to.
Choose a number from below, or type in your own value
   / The default endpoint - a good choice if you are unsure.
 1 | US Region, Northern Virginia, or Pacific Northwest.
   | Leave location constraint empty.
   \ &quot;us-east-1&quot;
[snip]
region&gt; us-east-1
Endpoint for S3 API.
Leave blank if using AWS to use the default endpoint for the region.
Specify if using an S3 clone such as Ceph.
endpoint&gt; s3.wasabisys.com
Location constraint - must be set to match the Region. Used when creating buckets only.
Choose a number from below, or type in your own value
 1 / Empty for US Region, Northern Virginia, or Pacific Northwest.
   \ &quot;&quot;
[snip]
location_constraint&gt;
Canned ACL used when creating buckets and/or storing objects in S3.
For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl
Choose a number from below, or type in your own value
 1 / Owner gets FULL_CONTROL. No one else has access rights (default).
   \ &quot;private&quot;
[snip]
acl&gt;
The server-side encryption algorithm used when storing this object in S3.
Choose a number from below, or type in your own value
 1 / None
   \ &quot;&quot;
 2 / AES256
   \ &quot;AES256&quot;
server_side_encryption&gt;
The storage class to use when storing objects in S3.
Choose a number from below, or type in your own value
 1 / Default
   \ &quot;&quot;
 2 / Standard storage class
   \ &quot;STANDARD&quot;
 3 / Reduced redundancy storage class
   \ &quot;REDUCED_REDUNDANCY&quot;
 4 / Standard Infrequent Access storage class
   \ &quot;STANDARD_IA&quot;
storage_class&gt;
Remote config
--------------------
[wasabi]
env_auth = false
access_key_id = YOURACCESSKEY
secret_access_key = YOURSECRETACCESSKEY
region = us-east-1
endpoint = s3.wasabisys.com
location_constraint =
acl =
server_side_encryption =
storage_class =
--------------------
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<p>This will leave the config file looking like this.</p>
<pre><code>[wasabi]
type = s3
provider = Wasabi
env_auth = false
access_key_id = YOURACCESSKEY
secret_access_key = YOURSECRETACCESSKEY
region =
endpoint = s3.wasabisys.com
location_constraint =
acl =
server_side_encryption =
storage_class =</code></pre>
<h3 id="alibaba-oss">Alibaba OSS</h3>
<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>
<pre><code>rclone config</code></pre>
<p>This will guide you through an interactive setup process.</p>
<pre><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; oss
Type of storage to configure.
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
[snip]
 4 / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, ChinaMobile, ArvanCloud, Digital Ocean, Dreamhost, Huawei OBS, IBM COS, Minio, and Tencent COS
   \ &quot;s3&quot;
[snip]
Storage&gt; s3
Choose your S3 provider.
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
 1 / Amazon Web Services (AWS) S3
   \ &quot;AWS&quot;
 2 / Alibaba Cloud Object Storage System (OSS) formerly Aliyun
   \ &quot;Alibaba&quot;
 3 / Ceph Object Storage
   \ &quot;Ceph&quot;
[snip]
provider&gt; Alibaba
Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).
Only applies if access_key_id and secret_access_key is blank.
Enter a boolean value (true or false). Press Enter for the default (&quot;false&quot;).
Choose a number from below, or type in your own value
 1 / Enter AWS credentials in the next step
   \ &quot;false&quot;
 2 / Get AWS credentials from the environment (env vars or IAM)
   \ &quot;true&quot;
env_auth&gt; 1
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a string value. Press Enter for the default (&quot;&quot;).
access_key_id&gt; accesskeyid
AWS Secret Access Key (password)
Leave blank for anonymous access or runtime credentials.
Enter a string value. Press Enter for the default (&quot;&quot;).
secret_access_key&gt; secretaccesskey
Endpoint for OSS API.
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
 1 / East China 1 (Hangzhou)
   \ &quot;oss-cn-hangzhou.aliyuncs.com&quot;
 2 / East China 2 (Shanghai)
   \ &quot;oss-cn-shanghai.aliyuncs.com&quot;
 3 / North China 1 (Qingdao)
   \ &quot;oss-cn-qingdao.aliyuncs.com&quot;
[snip]
endpoint&gt; 1
Canned ACL used when creating buckets and storing or copying objects.

Note that this ACL is applied when server-side copying objects as S3
doesn&#39;t copy the ACL from the source but rather writes a fresh one.
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
 1 / Owner gets FULL_CONTROL. No one else has access rights (default).
   \ &quot;private&quot;
 2 / Owner gets FULL_CONTROL. The AllUsers group gets READ access.
   \ &quot;public-read&quot;
   / Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access.
[snip]
acl&gt; 1
The storage class to use when storing new objects in OSS.
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
 1 / Default
   \ &quot;&quot;
 2 / Standard storage class
   \ &quot;STANDARD&quot;
 3 / Archive storage mode.
   \ &quot;GLACIER&quot;
 4 / Infrequent access storage mode.
   \ &quot;STANDARD_IA&quot;
storage_class&gt; 1
Edit advanced config? (y/n)
y) Yes
n) No
y/n&gt; n
Remote config
--------------------
[oss]
type = s3
provider = Alibaba
env_auth = false
access_key_id = accesskeyid
secret_access_key = secretaccesskey
endpoint = oss-cn-hangzhou.aliyuncs.com
acl = private
storage_class = Standard
--------------------
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<h3 id="china-mobile-ecloud-eos">China Mobile Ecloud Elastic Object
Storage (EOS)</h3>
<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>
<pre><code>rclone config</code></pre>
<p>This will guide you through an interactive setup process.</p>
<pre><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; ChinaMobile
Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
 ...
 5 / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, ChinaMobile, Digital Ocean, Dreamhost, Huawei OBS, IBM COS, Lyve Cloud, Minio, RackCorp, SeaweedFS, and Tencent COS
   \ (s3)
 ...
Storage&gt; s3
Option provider.
Choose your S3 provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 ...
 4 / China Mobile Ecloud Elastic Object Storage (EOS)
   \ (ChinaMobile)
 ...
provider&gt; ChinaMobile
Option env_auth.
Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).
Only applies if access_key_id and secret_access_key is blank.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth&gt;
Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id&gt; accesskeyid
Option secret_access_key.
AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key&gt; secretaccesskey
Option endpoint.
Endpoint for China Mobile Ecloud Elastic Object Storage (EOS) API.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
   / The default endpoint - a good choice if you are unsure.
 1 | East China (Suzhou)
   \ (eos-wuxi-1.cmecloud.cn)
 2 / East China (Jinan)
   \ (eos-jinan-1.cmecloud.cn)
 3 / East China (Hangzhou)
   \ (eos-ningbo-1.cmecloud.cn)
 4 / East China (Shanghai-1)
   \ (eos-shanghai-1.cmecloud.cn)
 5 / Central China (Zhengzhou)
   \ (eos-zhengzhou-1.cmecloud.cn)
 6 / Central China (Changsha-1)
   \ (eos-hunan-1.cmecloud.cn)
 7 / Central China (Changsha-2)
   \ (eos-zhuzhou-1.cmecloud.cn)
 8 / South China (Guangzhou-2)
   \ (eos-guangzhou-1.cmecloud.cn)
 9 / South China (Guangzhou-3)
   \ (eos-dongguan-1.cmecloud.cn)
10 / North China (Beijing-1)
   \ (eos-beijing-1.cmecloud.cn)
11 / North China (Beijing-2)
   \ (eos-beijing-2.cmecloud.cn)
12 / North China (Beijing-3)
   \ (eos-beijing-4.cmecloud.cn)
13 / North China (Huhehaote)
   \ (eos-huhehaote-1.cmecloud.cn)
14 / Southwest China (Chengdu)
   \ (eos-chengdu-1.cmecloud.cn)
15 / Southwest China (Chongqing)
   \ (eos-chongqing-1.cmecloud.cn)
16 / Southwest China (Guiyang)
   \ (eos-guiyang-1.cmecloud.cn)
17 / Nouthwest China (Xian)
   \ (eos-xian-1.cmecloud.cn)
18 / Yunnan China (Kunming)
   \ (eos-yunnan.cmecloud.cn)
19 / Yunnan China (Kunming-2)
   \ (eos-yunnan-2.cmecloud.cn)
20 / Tianjin China (Tianjin)
   \ (eos-tianjin-1.cmecloud.cn)
21 / Jilin China (Changchun)
   \ (eos-jilin-1.cmecloud.cn)
22 / Hubei China (Xiangyan)
   \ (eos-hubei-1.cmecloud.cn)
23 / Jiangxi China (Nanchang)
   \ (eos-jiangxi-1.cmecloud.cn)
24 / Gansu China (Lanzhou)
   \ (eos-gansu-1.cmecloud.cn)
25 / Shanxi China (Taiyuan)
   \ (eos-shanxi-1.cmecloud.cn)
26 / Liaoning China (Shenyang)
   \ (eos-liaoning-1.cmecloud.cn)
27 / Hebei China (Shijiazhuang)
   \ (eos-hebei-1.cmecloud.cn)
28 / Fujian China (Xiamen)
   \ (eos-fujian-1.cmecloud.cn)
29 / Guangxi China (Nanning)
   \ (eos-guangxi-1.cmecloud.cn)
30 / Anhui China (Huainan)
   \ (eos-anhui-1.cmecloud.cn)
endpoint&gt; 1
Option location_constraint.
Location constraint - must match endpoint.
Used when creating buckets only.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / East China (Suzhou)
   \ (wuxi1)
 2 / East China (Jinan)
   \ (jinan1)
 3 / East China (Hangzhou)
   \ (ningbo1)
 4 / East China (Shanghai-1)
   \ (shanghai1)
 5 / Central China (Zhengzhou)
   \ (zhengzhou1)
 6 / Central China (Changsha-1)
   \ (hunan1)
 7 / Central China (Changsha-2)
   \ (zhuzhou1)
 8 / South China (Guangzhou-2)
   \ (guangzhou1)
 9 / South China (Guangzhou-3)
   \ (dongguan1)
10 / North China (Beijing-1)
   \ (beijing1)
11 / North China (Beijing-2)
   \ (beijing2)
12 / North China (Beijing-3)
   \ (beijing4)
13 / North China (Huhehaote)
   \ (huhehaote1)
14 / Southwest China (Chengdu)
   \ (chengdu1)
15 / Southwest China (Chongqing)
   \ (chongqing1)
16 / Southwest China (Guiyang)
   \ (guiyang1)
17 / Nouthwest China (Xian)
   \ (xian1)
18 / Yunnan China (Kunming)
   \ (yunnan)
19 / Yunnan China (Kunming-2)
   \ (yunnan2)
20 / Tianjin China (Tianjin)
   \ (tianjin1)
21 / Jilin China (Changchun)
   \ (jilin1)
22 / Hubei China (Xiangyan)
   \ (hubei1)
23 / Jiangxi China (Nanchang)
   \ (jiangxi1)
24 / Gansu China (Lanzhou)
   \ (gansu1)
25 / Shanxi China (Taiyuan)
   \ (shanxi1)
26 / Liaoning China (Shenyang)
   \ (liaoning1)
27 / Hebei China (Shijiazhuang)
   \ (hebei1)
28 / Fujian China (Xiamen)
   \ (fujian1)
29 / Guangxi China (Nanning)
   \ (guangxi1)
30 / Anhui China (Huainan)
   \ (anhui1)
location_constraint&gt; 1
Option acl.
Canned ACL used when creating buckets and storing or copying objects.
This ACL is used for creating objects and if bucket_acl isn&#39;t set, for creating buckets too.
For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl
Note that this ACL is applied when server-side copying objects as S3
doesn&#39;t copy the ACL from the source but rather writes a fresh one.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
   / Owner gets FULL_CONTROL.
 1 | No one else has access rights (default).
   \ (private)
   / Owner gets FULL_CONTROL.
 2 | The AllUsers group gets READ access.
   \ (public-read)
   / Owner gets FULL_CONTROL.
 3 | The AllUsers group gets READ and WRITE access.
   | Granting this on a bucket is generally not recommended.
   \ (public-read-write)
   / Owner gets FULL_CONTROL.
 4 | The AuthenticatedUsers group gets READ access.
   \ (authenticated-read)
   / Object owner gets FULL_CONTROL.
acl&gt; private
Option server_side_encryption.
The server-side encryption algorithm used when storing this object in S3.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / None
   \ ()
 2 / AES256
   \ (AES256)
server_side_encryption&gt;
Option storage_class.
The storage class to use when storing new objects in ChinaMobile.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / Default
   \ ()
 2 / Standard storage class
   \ (STANDARD)
 3 / Archive storage mode
   \ (GLACIER)
 4 / Infrequent access storage mode
   \ (STANDARD_IA)
storage_class&gt;
Edit advanced config?
y) Yes
n) No (default)
y/n&gt; n
--------------------
[ChinaMobile]
type = s3
provider = ChinaMobile
access_key_id = accesskeyid
secret_access_key = secretaccesskey
endpoint = eos-wuxi-1.cmecloud.cn
location_constraint = wuxi1
acl = private
--------------------
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<h3 id="arvan-cloud">ArvanCloud</h3>
<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>
<p>ArvanCloud provides an S3 interface which can be configured for use
with rclone like this.</p>
<pre><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
n/s&gt; n
name&gt; ArvanCloud
Type of storage to configure.
Choose a number from below, or type in your own value
[snip]
XX / Amazon S3 (also Dreamhost, Ceph, ChinaMobile, ArvanCloud, Minio)
   \ &quot;s3&quot;
[snip]
Storage&gt; s3
Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank.
Choose a number from below, or type in your own value
 1 / Enter AWS credentials in the next step
   \ &quot;false&quot;
 2 / Get AWS credentials from the environment (env vars or IAM)
   \ &quot;true&quot;
env_auth&gt; 1
AWS Access Key ID - leave blank for anonymous access or runtime credentials.
access_key_id&gt; YOURACCESSKEY
AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials.
secret_access_key&gt; YOURSECRETACCESSKEY
Region to connect to.
Choose a number from below, or type in your own value
   / The default endpoint - a good choice if you are unsure.
 1 | US Region, Northern Virginia, or Pacific Northwest.
   | Leave location constraint empty.
   \ &quot;us-east-1&quot;
[snip]
region&gt; 
Endpoint for S3 API.
Leave blank if using ArvanCloud to use the default endpoint for the region.
Specify if using an S3 clone such as Ceph.
endpoint&gt; s3.arvanstorage.com
Location constraint - must be set to match the Region. Used when creating buckets only.
Choose a number from below, or type in your own value
 1 / Empty for Iran-Tehran Region.
   \ &quot;&quot;
[snip]
location_constraint&gt;
Canned ACL used when creating buckets and/or storing objects in S3.
For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl
Choose a number from below, or type in your own value
 1 / Owner gets FULL_CONTROL. No one else has access rights (default).
   \ &quot;private&quot;
[snip]
acl&gt;
The server-side encryption algorithm used when storing this object in S3.
Choose a number from below, or type in your own value
 1 / None
   \ &quot;&quot;
 2 / AES256
   \ &quot;AES256&quot;
server_side_encryption&gt;
The storage class to use when storing objects in S3.
Choose a number from below, or type in your own value
 1 / Default
   \ &quot;&quot;
 2 / Standard storage class
   \ &quot;STANDARD&quot;
storage_class&gt;
Remote config
--------------------
[ArvanCloud]
env_auth = false
access_key_id = YOURACCESSKEY
secret_access_key = YOURSECRETACCESSKEY
region = ir-thr-at1
endpoint = s3.arvanstorage.com
location_constraint =
acl =
server_side_encryption =
storage_class =
--------------------
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<p>This will leave the config file looking like this.</p>
<pre><code>[ArvanCloud]
type = s3
provider = ArvanCloud
env_auth = false
access_key_id = YOURACCESSKEY
secret_access_key = YOURSECRETACCESSKEY
region =
endpoint = s3.arvanstorage.com
location_constraint =
acl =
server_side_encryption =
storage_class =</code></pre>
<h3 id="tencent-cos">Tencent COS</h3>
<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>
<p>To configure access to Tencent COS, follow the steps below:</p>
<ol type="1">
<li>Run <code>rclone config</code> and select <code>n</code> for a new
remote.</li>
</ol>
<pre><code>rclone config
No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n</code></pre>
<ol start="2" type="1">
<li>Give the name of the configuration. For example, name it ‘cos’.</li>
</ol>
<pre><code>name&gt; cos</code></pre>
<ol start="3" type="1">
<li>Select <code>s3</code> storage.</li>
</ol>
<pre><code>Choose a number from below, or type in your own value
1 / 1Fichier
   \ &quot;fichier&quot;
 2 / Alias for an existing remote
   \ &quot;alias&quot;
 3 / Amazon Drive
   \ &quot;amazon cloud drive&quot;
 4 / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, ChinaMobile, ArvanCloud, Digital Ocean, Dreamhost, Huawei OBS, IBM COS, Minio, and Tencent COS
   \ &quot;s3&quot;
[snip]
Storage&gt; s3</code></pre>
<ol start="4" type="1">
<li>Select <code>TencentCOS</code> provider.</li>
</ol>
<pre><code>Choose a number from below, or type in your own value
1 / Amazon Web Services (AWS) S3
   \ &quot;AWS&quot;
[snip]
11 / Tencent Cloud Object Storage (COS)
   \ &quot;TencentCOS&quot;
[snip]
provider&gt; TencentCOS</code></pre>
<ol start="5" type="1">
<li>Enter your SecretId and SecretKey of Tencent Cloud.</li>
</ol>
<pre><code>Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).
Only applies if access_key_id and secret_access_key is blank.
Enter a boolean value (true or false). Press Enter for the default (&quot;false&quot;).
Choose a number from below, or type in your own value
 1 / Enter AWS credentials in the next step
   \ &quot;false&quot;
 2 / Get AWS credentials from the environment (env vars or IAM)
   \ &quot;true&quot;
env_auth&gt; 1
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a string value. Press Enter for the default (&quot;&quot;).
access_key_id&gt; AKIDxxxxxxxxxx
AWS Secret Access Key (password)
Leave blank for anonymous access or runtime credentials.
Enter a string value. Press Enter for the default (&quot;&quot;).
secret_access_key&gt; xxxxxxxxxxx</code></pre>
<ol start="6" type="1">
<li>Select endpoint for Tencent COS. This is the standard endpoint for
different region.</li>
</ol>
<pre><code> 1 / Beijing Region.
   \ &quot;cos.ap-beijing.myqcloud.com&quot;
 2 / Nanjing Region.
   \ &quot;cos.ap-nanjing.myqcloud.com&quot;
 3 / Shanghai Region.
   \ &quot;cos.ap-shanghai.myqcloud.com&quot;
 4 / Guangzhou Region.
   \ &quot;cos.ap-guangzhou.myqcloud.com&quot;
[snip]
endpoint&gt; 4</code></pre>
<ol start="7" type="1">
<li>Choose acl and storage class.</li>
</ol>
<pre><code>Note that this ACL is applied when server-side copying objects as S3
doesn&#39;t copy the ACL from the source but rather writes a fresh one.
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
 1 / Owner gets Full_CONTROL. No one else has access rights (default).
   \ &quot;default&quot;
[snip]
acl&gt; 1
The storage class to use when storing new objects in Tencent COS.
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
 1 / Default
   \ &quot;&quot;
[snip]
storage_class&gt; 1
Edit advanced config? (y/n)
y) Yes
n) No (default)
y/n&gt; n
Remote config
--------------------
[cos]
type = s3
provider = TencentCOS
env_auth = false
access_key_id = xxx
secret_access_key = xxx
endpoint = cos.ap-guangzhou.myqcloud.com
acl = default
--------------------
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d&gt; y
Current remotes:

Name                 Type
====                 ====
cos                  s3</code></pre>
<h3 id="netease-nos">Netease NOS</h3>
<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>
<h3 id="storj">Storj</h3>
<p>Storj is a decentralized cloud storage which can be used through its
native protocol or an S3 compatible gateway.</p>
<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>
<pre><code>Type of storage to configure.
Storage&gt; s3
Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).
Only applies if access_key_id and secret_access_key is blank.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth&gt; 1
Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id&gt; XXXX (as shown when creating the access grant)
Option secret_access_key.
AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key&gt; XXXX (as shown when creating the access grant)
Option endpoint.
Endpoint of the Shared Gateway.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / EU1 Shared Gateway
   \ (gateway.eu1.storjshare.io)
 2 / US1 Shared Gateway
   \ (gateway.us1.storjshare.io)
 3 / Asia-Pacific Shared Gateway
   \ (gateway.ap1.storjshare.io)
endpoint&gt; 1 (as shown when creating the access grant)
Edit advanced config?
y) Yes
n) No (default)
y/n&gt; n</code></pre>
<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>
<h4 id="backend-quirks">Backend quirks</h4>
<ul>
<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>
<li>Server side copy is disabled as it isn’t currently supported in the
gateway.</li>
<li>GetTier and SetTier are not supported.</li>
</ul>
<h4 id="backend-bugs">Backend bugs</h4>
<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>
<p>This has the following consequences:</p>
<ul>
<li>Using <code>rclone rcat</code> will fail as the medatada doesn’t
match after upload</li>
<li>Uploading files with <code>rclone mount</code> will fail for the
same reason
<ul>
<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>
</ul></li>
<li>Files uploaded via a multipart upload won’t have their modtimes
<ul>
<li>This will mean that <code>rclone sync</code> will likely keep trying
to upload files bigger than <code>--s3-upload-cutoff</code></li>
<li>This can be worked around with <code>--checksum</code> or
<code>--size-only</code> or setting <code>--s3-upload-cutoff</code>
large</li>
<li>The maximum value for <code>--s3-upload-cutoff</code> is 5GiB
though</li>
</ul></li>
</ul>
<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>
<h4 id="comparison-with-the-native-protocol">Comparison with the native
protocol</h4>
<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>
<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>
<p>For more detailed comparison please check the documentation of the <a
href="/storj">storj</a> backend.</p>
<h2 id="limitations-5">Limitations</h2>
<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>
<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>
<h1 id="backblaze-b2">Backblaze B2</h1>
<p>B2 is <a href="https://www.backblaze.com/b2/">Backblaze’s cloud
storage system</a>.</p>
<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>
<h2 id="configuration-4">Configuration</h2>
<p>Here is an example of making a b2 configuration. First run</p>
<pre><code>rclone config</code></pre>
<p>This will guide you through an interactive setup process. To
authenticate you will either need your Account ID (a short hex number)
and Master Application Key (a long hex number) OR an Application Key,
which is the recommended method. See below for further details on
generating and using an Application Key.</p>
<pre><code>No remotes found, make a new one?
n) New remote
q) Quit config
n/q&gt; n
name&gt; remote
Type of storage to configure.
Choose a number from below, or type in your own value
[snip]
XX / Backblaze B2
   \ &quot;b2&quot;
[snip]
Storage&gt; b2
Account ID or Application Key ID
account&gt; 123456789abc
Application Key
key&gt; 0123456789abcdef0123456789abcdef0123456789
Endpoint for the service - leave blank normally.
endpoint&gt;
Remote config
--------------------
[remote]
account = 123456789abc
key = 0123456789abcdef0123456789abcdef0123456789
endpoint =
--------------------
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<p>This remote is called <code>remote</code> and can now be used like
this</p>
<p>See all buckets</p>
<pre><code>rclone lsd remote:</code></pre>
<p>Create a new bucket</p>
<pre><code>rclone mkdir remote:bucket</code></pre>
<p>List the contents of a bucket</p>
<pre><code>rclone ls remote:bucket</code></pre>
<p>Sync <code>/home/local/directory</code> to the remote bucket,
deleting any excess files in the bucket.</p>
<pre><code>rclone sync -i /home/local/directory remote:bucket</code></pre>
<h3 id="application-keys">Application Keys</h3>
<p>B2 supports multiple <a
href="https://www.backblaze.com/b2/docs/application_keys.html">Application
Keys for different access permission to B2 Buckets</a>.</p>
<p>You can use these with rclone too; you will need to use rclone
version 1.43 or later.</p>
<p>Follow Backblaze’s docs to create an Application Key with the
required permission and add the <code>applicationKeyId</code> as the
<code>account</code> and the <code>Application Key</code> itself as the
<code>key</code>.</p>
<p>Note that you must put the <em>applicationKeyId</em> as the
<code>account</code> – you can’t use the master Account ID. If you try
then B2 will return 401 errors.</p>
<h3 id="fast-list-1">–fast-list</h3>
<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>
<h3 id="modified-time-1">Modified time</h3>
<p>The modified time is stored as metadata on the object as
<code>X-Bz-Info-src_last_modified_millis</code> as milliseconds since
1970-01-01 in the Backblaze standard. Other tools should be able to use
this as a modified time.</p>
<p>Modified times are used in syncing and are fully supported. Note that
if a modification time needs to be updated on an object then it will
create a new version of the object.</p>
<h3 id="restricted-filename-characters-3">Restricted filename
characters</h3>
<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>
<table>
<thead>
<tr class="header">
<th>Character</th>
<th style="text-align: center;">Value</th>
<th style="text-align: center;">Replacement</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>\</td>
<td style="text-align: center;">0x5C</td>
<td style="text-align: center;">＼</td>
</tr>
</tbody>
</table>
<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>
<p>Note that in 2020-05 Backblaze started allowing  characters in file
names. Rclone hasn’t changed its encoding as this could cause syncs to
re-transfer files. If you want rclone not to replace  then see the
<code>--b2-encoding</code> flag below and remove the
<code>BackSlash</code> from the string. This can be set in the
config.</p>
<h3 id="sha1-checksums">SHA1 checksums</h3>
<p>The SHA1 checksums of the files are checked on upload and download
and will be used in the syncing process.</p>
<p>Large files (bigger than the limit in
<code>--b2-upload-cutoff</code>) which are uploaded in chunks will store
their SHA1 on the object as <code>X-Bz-Info-large_file_sha1</code> as
recommended by Backblaze.</p>
<p>For a large file to be uploaded with an SHA1 checksum, the source
needs to support SHA1 checksums. The local disk supports SHA1 checksums
so large file transfers from local disk will have an SHA1. See <a
href="https://rclone.org/overview/#features">the overview</a> for
exactly which remotes support SHA1.</p>
<p>Sources which don’t support SHA1, in particular <code>crypt</code>
will upload large files without SHA1 checksums. This may be fixed in the
future (see <a
href="https://github.com/rclone/rclone/issues/1767">#1767</a>).</p>
<p>Files sizes below <code>--b2-upload-cutoff</code> will always have an
SHA1 regardless of the source.</p>
<h3 id="transfers">Transfers</h3>
<p>Backblaze recommends that you do lots of transfers simultaneously for
maximum speed. In tests from my SSD equipped laptop the optimum setting
is about <code>--transfers 32</code> though higher numbers may be used
for a slight speed improvement. The optimum number for you may vary
depending on your hardware, how big the files are, how much you want to
load your computer, etc. The default of <code>--transfers 4</code> is
definitely too low for Backblaze B2 though.</p>
<p>Note that uploading big files (bigger than 200 MiB by default) will
use a 96 MiB RAM buffer by default. There can be at most
<code>--transfers</code> of these in use at any moment, so this sets the
upper limit on the memory used.</p>
<h3 id="versions-1">Versions</h3>
<p>When rclone uploads a new version of a file it creates a <a
href="https://www.backblaze.com/b2/docs/file_versions.html">new version
of it</a>. Likewise when you delete a file, the old version will be
marked hidden and still be available. Conversely, you may opt in to a
“hard delete” of files with the <code>--b2-hard-delete</code> flag which
would permanently remove the file instead of hiding it.</p>
<p>Old versions of files, where available, are visible using the
<code>--b2-versions</code> flag.</p>
<p>It is also possible to view a bucket as it was at a certain point in
time, using the <code>--b2-version-at</code> 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>
<p>If you wish to remove all the old versions then you can use the
<code>rclone cleanup remote:bucket</code> command which will delete all
the old versions of files, leaving the current ones intact. You can also
supply a path and only old versions under that path will be deleted,
e.g. <code>rclone cleanup remote:bucket/path/to/stuff</code>.</p>
<p>Note that <code>cleanup</code> will remove partially uploaded files
from the bucket if they are more than a day old.</p>
<p>When you <code>purge</code> a bucket, the current and the old
versions will be deleted then the bucket will be deleted.</p>
<p>However <code>delete</code> will cause the current versions of the
files to become hidden old versions.</p>
<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>
<p>Show current version and all the versions with
<code>--b2-versions</code> flag.</p>
<pre><code>$ rclone -q ls b2:cleanup-test
        9 one.txt

$ rclone -q --b2-versions ls b2:cleanup-test
        9 one.txt
        8 one-v2016-07-04-141032-000.txt
       16 one-v2016-07-04-141003-000.txt
       15 one-v2016-07-02-155621-000.txt</code></pre>
<p>Retrieve an old version</p>
<pre><code>$ rclone -q --b2-versions copy b2:cleanup-test/one-v2016-07-04-141003-000.txt /tmp

$ rclone -q ls b2:cleanup-test
        9 one.txt

$ rclone -q --b2-versions ls b2:cleanup-test
        9 one.txt</code></pre>
<h3 id="data-usage">Data usage</h3>
<p>It is useful to know how many requests are sent to the server in
different scenarios.</p>
<p>All copy commands send the following 4 requests:</p>
<pre><code>/b2api/v1/b2_authorize_account
/b2api/v1/b2_create_bucket
/b2api/v1/b2_list_buckets
/b2api/v1/b2_list_file_names</code></pre>
<p>The <code>b2_list_file_names</code> request will be sent once for
every 1k files in the remote path, providing the checksum and
modification time of the listed files. As of version 1.33 issue <a
href="https://github.com/rclone/rclone/issues/818">#818</a> causes extra
requests to be sent when using B2 with Crypt. When a copy operation does
not require any files to be uploaded, no more requests will be sent.</p>
<p>Uploading files that do not require chunking, will send 2 requests
per file upload:</p>
<pre><code>/b2api/v1/b2_get_upload_url
/b2api/v1/b2_upload_file/</code></pre>
<p>Uploading files requiring chunking, will send 2 requests (one each to
start and finish the upload) and another 2 requests for each chunk:</p>
<pre><code>/b2api/v1/b2_start_large_file
/b2api/v1/b2_get_upload_part_url
/b2api/v1/b2_upload_part/
/b2api/v1/b2_finish_large_file</code></pre>
<h4 id="versions-2">Versions</h4>
<p>Versions can be viewed with the <code>--b2-versions</code> flag. When
it is set rclone will show and act on older versions of files. For
example</p>
<p>Listing without <code>--b2-versions</code></p>
<pre><code>$ rclone -q ls b2:cleanup-test
        9 one.txt</code></pre>
<p>And with</p>
<pre><code>$ 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</code></pre>
<p>Showing that the current version is unchanged but older versions can
be seen. These have the UTC date that they were uploaded to the server
to the nearest millisecond appended to them.</p>
<p>Note that when using <code>--b2-versions</code> no file write
operations are permitted, so you can’t upload files or delete them.</p>
<h3 id="b2-and-rclone-link">B2 and rclone link</h3>
<p>Rclone supports generating file share links for private B2 buckets.
They can either be for a file for example:</p>
<pre><code>./rclone link B2:bucket/path/to/file.txt
https://f002.backblazeb2.com/file/bucket/path/to/file.txt?Authorization=xxxxxxxx
</code></pre>
<p>or if run on a directory you will get:</p>
<pre><code>./rclone link B2:bucket/path
https://f002.backblazeb2.com/file/bucket/path?Authorization=xxxxxxxx</code></pre>
<p>you can then use the authorization token (the part of the url from
the <code>?Authorization=</code> on) on any file path under that
directory. For example:</p>
<pre><code>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
</code></pre>
<h3 id="standard-options-4">Standard options</h3>
<p>Here are the Standard options specific to b2 (Backblaze B2).</p>
<h4 id="b2-account">–b2-account</h4>
<p>Account ID or Application Key ID.</p>
<p>Properties:</p>
<ul>
<li>Config: account</li>
<li>Env Var: RCLONE_B2_ACCOUNT</li>
<li>Type: string</li>
<li>Required: true</li>
</ul>
<h4 id="b2-key">–b2-key</h4>
<p>Application Key.</p>
<p>Properties:</p>
<ul>
<li>Config: key</li>
<li>Env Var: RCLONE_B2_KEY</li>
<li>Type: string</li>
<li>Required: true</li>
</ul>
<h4 id="b2-hard-delete">–b2-hard-delete</h4>
<p>Permanently delete files on remote removal, otherwise hide files.</p>
<p>Properties:</p>
<ul>
<li>Config: hard_delete</li>
<li>Env Var: RCLONE_B2_HARD_DELETE</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h3 id="advanced-options-3">Advanced options</h3>
<p>Here are the Advanced options specific to b2 (Backblaze B2).</p>
<h4 id="b2-endpoint">–b2-endpoint</h4>
<p>Endpoint for the service.</p>
<p>Leave blank normally.</p>
<p>Properties:</p>
<ul>
<li>Config: endpoint</li>
<li>Env Var: RCLONE_B2_ENDPOINT</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="b2-test-mode">–b2-test-mode</h4>
<p>A flag string for X-Bz-Test-Mode header for debugging.</p>
<p>This is for debugging purposes only. Setting it to one of the strings
below will cause b2 to return specific errors:</p>
<ul>
<li>“fail_some_uploads”</li>
<li>“expire_some_account_authorization_tokens”</li>
<li>“force_cap_exceeded”</li>
</ul>
<p>These will be set in the “X-Bz-Test-Mode” header which is documented
in the <a
href="https://www.backblaze.com/b2/docs/integration_checklist.html">b2
integrations checklist</a>.</p>
<p>Properties:</p>
<ul>
<li>Config: test_mode</li>
<li>Env Var: RCLONE_B2_TEST_MODE</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="b2-versions">–b2-versions</h4>
<p>Include old versions in directory listings.</p>
<p>Note that when using this no file write operations are permitted, so
you can’t upload files or delete them.</p>
<p>Properties:</p>
<ul>
<li>Config: versions</li>
<li>Env Var: RCLONE_B2_VERSIONS</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="b2-version-at">–b2-version-at</h4>
<p>Show file versions as they were at the specified time.</p>
<p>Note that when using this no file write operations are permitted, so
you can’t upload files or delete them.</p>
<p>Properties:</p>
<ul>
<li>Config: version_at</li>
<li>Env Var: RCLONE_B2_VERSION_AT</li>
<li>Type: Time</li>
<li>Default: off</li>
</ul>
<h4 id="b2-upload-cutoff">–b2-upload-cutoff</h4>
<p>Cutoff for switching to chunked upload.</p>
<p>Files above this size will be uploaded in chunks of
“–b2-chunk-size”.</p>
<p>This value should be set no larger than 4.657 GiB (== 5 GB).</p>
<p>Properties:</p>
<ul>
<li>Config: upload_cutoff</li>
<li>Env Var: RCLONE_B2_UPLOAD_CUTOFF</li>
<li>Type: SizeSuffix</li>
<li>Default: 200Mi</li>
</ul>
<h4 id="b2-copy-cutoff">–b2-copy-cutoff</h4>
<p>Cutoff for switching to multipart copy.</p>
<p>Any files larger than this that need to be server-side copied will be
copied in chunks of this size.</p>
<p>The minimum is 0 and the maximum is 4.6 GiB.</p>
<p>Properties:</p>
<ul>
<li>Config: copy_cutoff</li>
<li>Env Var: RCLONE_B2_COPY_CUTOFF</li>
<li>Type: SizeSuffix</li>
<li>Default: 4Gi</li>
</ul>
<h4 id="b2-chunk-size">–b2-chunk-size</h4>
<p>Upload chunk size.</p>
<p>When uploading large files, chunk the file into this size.</p>
<p>Must fit in memory. These chunks are buffered in memory and there
might a maximum of “–transfers” chunks in progress at once.</p>
<p>5,000,000 Bytes is the minimum size.</p>
<p>Properties:</p>
<ul>
<li>Config: chunk_size</li>
<li>Env Var: RCLONE_B2_CHUNK_SIZE</li>
<li>Type: SizeSuffix</li>
<li>Default: 96Mi</li>
</ul>
<h4 id="b2-disable-checksum">–b2-disable-checksum</h4>
<p>Disable checksums for large (&gt; upload cutoff) files.</p>
<p>Normally rclone will calculate the SHA1 checksum of the input before
uploading it so it can add it to metadata on the object. This is great
for data integrity checking but can cause long delays for large files to
start uploading.</p>
<p>Properties:</p>
<ul>
<li>Config: disable_checksum</li>
<li>Env Var: RCLONE_B2_DISABLE_CHECKSUM</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="b2-download-url">–b2-download-url</h4>
<p>Custom endpoint for downloads.</p>
<p>This is usually set to a Cloudflare CDN URL as Backblaze offers free
egress for data downloaded through the Cloudflare network. Rclone works
with private buckets by sending an “Authorization” header. If the custom
endpoint rewrites the requests for authentication, e.g., in Cloudflare
Workers, this header needs to be handled properly. Leave blank if you
want to use the endpoint provided by Backblaze.</p>
<p>The URL provided here SHOULD have the protocol and SHOULD NOT have a
trailing slash or specify the /file/bucket subpath as rclone will
request files with “{download_url}/file/{bucket_name}/{path}”.</p>
<p>Example: &gt; https://mysubdomain.mydomain.tld (No trailing “/”,
“file” or “bucket”)</p>
<p>Properties:</p>
<ul>
<li>Config: download_url</li>
<li>Env Var: RCLONE_B2_DOWNLOAD_URL</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="b2-download-auth-duration">–b2-download-auth-duration</h4>
<p>Time before the authorization token will expire in s or suffix
ms|s|m|h|d.</p>
<p>The duration before the download authorization token will expire. The
minimum value is 1 second. The maximum value is one week.</p>
<p>Properties:</p>
<ul>
<li>Config: download_auth_duration</li>
<li>Env Var: RCLONE_B2_DOWNLOAD_AUTH_DURATION</li>
<li>Type: Duration</li>
<li>Default: 1w</li>
</ul>
<h4 id="b2-memory-pool-flush-time">–b2-memory-pool-flush-time</h4>
<p>How often internal memory buffer pools will be flushed. Uploads which
requires additional buffers (f.e multipart) will use memory pool for
allocations. This option controls how often unused buffers will be
removed from the pool.</p>
<p>Properties:</p>
<ul>
<li>Config: memory_pool_flush_time</li>
<li>Env Var: RCLONE_B2_MEMORY_POOL_FLUSH_TIME</li>
<li>Type: Duration</li>
<li>Default: 1m0s</li>
</ul>
<h4 id="b2-memory-pool-use-mmap">–b2-memory-pool-use-mmap</h4>
<p>Whether to use mmap buffers in internal memory pool.</p>
<p>Properties:</p>
<ul>
<li>Config: memory_pool_use_mmap</li>
<li>Env Var: RCLONE_B2_MEMORY_POOL_USE_MMAP</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="b2-encoding">–b2-encoding</h4>
<p>The encoding for the backend.</p>
<p>See the <a href="https://rclone.org/overview/#encoding">encoding
section in the overview</a> for more info.</p>
<p>Properties:</p>
<ul>
<li>Config: encoding</li>
<li>Env Var: RCLONE_B2_ENCODING</li>
<li>Type: MultiEncoder</li>
<li>Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot</li>
</ul>
<h2 id="limitations-6">Limitations</h2>
<p><code>rclone about</code> is not supported by the B2 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>
<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>
<h1 id="box">Box</h1>
<p>Paths are specified as <code>remote:path</code></p>
<p>Paths may be as deep as required,
e.g. <code>remote:directory/subdirectory</code>.</p>
<p>The initial setup for Box involves getting a token from Box which you
can do either in your browser, or with a config.json downloaded from Box
to use JWT authentication. <code>rclone config</code> walks you through
it.</p>
<h2 id="configuration-5">Configuration</h2>
<p>Here is an example of how to make a remote called
<code>remote</code>. First run:</p>
<pre><code> rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<pre><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; remote
Type of storage to configure.
Choose a number from below, or type in your own value
[snip]
XX / Box
   \ &quot;box&quot;
[snip]
Storage&gt; box
Box App Client Id - leave blank normally.
client_id&gt; 
Box App Client Secret - leave blank normally.
client_secret&gt;
Box App config.json location
Leave blank normally.
Enter a string value. Press Enter for the default (&quot;&quot;).
box_config_file&gt;
Box App Primary Access Token
Leave blank normally.
Enter a string value. Press Enter for the default (&quot;&quot;).
access_token&gt;

Enter a string value. Press Enter for the default (&quot;user&quot;).
Choose a number from below, or type in your own value
 1 / Rclone should act on behalf of a user
   \ &quot;user&quot;
 2 / Rclone should act on behalf of a service account
   \ &quot;enterprise&quot;
box_sub_type&gt;
Remote config
Use auto config?
 * Say Y if not sure
 * Say N if you are working on a remote or headless machine
y) Yes
n) No
y/n&gt; y
If your browser doesn&#39;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 = {&quot;access_token&quot;:&quot;XXX&quot;,&quot;token_type&quot;:&quot;bearer&quot;,&quot;refresh_token&quot;:&quot;XXX&quot;,&quot;expiry&quot;:&quot;XXX&quot;}
--------------------
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<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>
<p>Note that rclone runs a webserver on your local machine to collect
the token as returned from Box. This only runs from the moment it opens
your browser to the moment you get back the verification code. This is
on <code>http://127.0.0.1:53682/</code> and this it may require you to
unblock it temporarily if you are running a host firewall.</p>
<p>Once configured you can then use <code>rclone</code> like this,</p>
<p>List directories in top level of your Box</p>
<pre><code>rclone lsd remote:</code></pre>
<p>List all the files in your Box</p>
<pre><code>rclone ls remote:</code></pre>
<p>To copy a local directory to an Box directory called backup</p>
<pre><code>rclone copy /home/source remote:backup</code></pre>
<h3 id="using-rclone-with-an-enterprise-account-with-sso">Using rclone
with an Enterprise account with SSO</h3>
<p>If you have an “Enterprise” account type with Box with single sign on
(SSO), you need to create a password to use Box with rclone. This can be
done at your Enterprise Box account by going to Settings, “Account” Tab,
and then set the password in the “Authentication” field.</p>
<p>Once you have done this, you can setup your Enterprise Box account
using the same procedure detailed above in the, using the password you
have just set.</p>
<h3 id="invalid-refresh-token">Invalid refresh token</h3>
<p>According to the <a
href="https://developer.box.com/v2.0/docs/oauth-20#section-6-using-the-access-and-refresh-tokens">box
docs</a>:</p>
<blockquote>
<p>Each refresh_token is valid for one use in 60 days.</p>
</blockquote>
<p>This means that if you</p>
<ul>
<li>Don’t use the box remote for 60 days</li>
<li>Copy the config file with a box refresh token in and use it in two
places</li>
<li>Get an error on a token refresh</li>
</ul>
<p>then rclone will return an error which includes the text
<code>Invalid refresh token</code>.</p>
<p>To fix this you will need to use oauth2 again to update the refresh
token. You can use the methods in <a
href="https://rclone.org/remote_setup/">the remote setup docs</a>,
bearing in mind that if you use the copy the config file method, you
should not use that remote on the computer you did the authentication
on.</p>
<p>Here is how to do it.</p>
<pre><code>$ rclone config
Current remotes:

Name                 Type
====                 ====
remote               box

e) Edit existing remote
n) New remote
d) Delete remote
r) Rename remote
c) Copy remote
s) Set configuration password
q) Quit config
e/n/d/r/c/s/q&gt; e
Choose a number from below, or type in an existing value
 1 &gt; remote
remote&gt; remote
--------------------
[remote]
type = box
token = {&quot;access_token&quot;:&quot;XXX&quot;,&quot;token_type&quot;:&quot;bearer&quot;,&quot;refresh_token&quot;:&quot;XXX&quot;,&quot;expiry&quot;:&quot;2017-07-08T23:40:08.059167677+01:00&quot;}
--------------------
Edit remote
Value &quot;client_id&quot; = &quot;&quot;
Edit? (y/n)&gt;
y) Yes
n) No
y/n&gt; n
Value &quot;client_secret&quot; = &quot;&quot;
Edit? (y/n)&gt;
y) Yes
n) No
y/n&gt; n
Remote config
Already have a token - refresh?
y) Yes
n) No
y/n&gt; y
Use auto config?
 * Say Y if not sure
 * Say N if you are working on a remote or headless machine
y) Yes
n) No
y/n&gt; y
If your browser doesn&#39;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 = {&quot;access_token&quot;:&quot;YYY&quot;,&quot;token_type&quot;:&quot;bearer&quot;,&quot;refresh_token&quot;:&quot;YYY&quot;,&quot;expiry&quot;:&quot;2017-07-23T12:22:29.259137901+01:00&quot;}
--------------------
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<h3 id="modified-time-and-hashes-1">Modified time and hashes</h3>
<p>Box allows modification times to be set on objects accurate to 1
second. These will be used to detect whether objects need syncing or
not.</p>
<p>Box supports SHA1 type hashes, so you can use the
<code>--checksum</code> flag.</p>
<h3 id="restricted-filename-characters-4">Restricted filename
characters</h3>
<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>
<table>
<thead>
<tr class="header">
<th>Character</th>
<th style="text-align: center;">Value</th>
<th style="text-align: center;">Replacement</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>\</td>
<td style="text-align: center;">0x5C</td>
<td style="text-align: center;">＼</td>
</tr>
</tbody>
</table>
<p>File names can also not end with the following characters. These only
get replaced if they are the last character in the name:</p>
<table>
<thead>
<tr class="header">
<th>Character</th>
<th style="text-align: center;">Value</th>
<th style="text-align: center;">Replacement</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>SP</td>
<td style="text-align: center;">0x20</td>
<td style="text-align: center;">␠</td>
</tr>
</tbody>
</table>
<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>
<h3 id="transfers-1">Transfers</h3>
<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 the multipart uploads). Chunks are buffered in memory
and are normally 8 MiB so increasing <code>--transfers</code> will
increase memory use.</p>
<h3 id="deleting-files-1">Deleting files</h3>
<p>Depending on the enterprise settings for your user, the item will
either be actually deleted from Box or moved to the trash.</p>
<p>Emptying the trash is supported via the rclone however cleanup
command however this deletes every trashed file and folder individually
so it may take a very long time. Emptying the trash via the WebUI does
not have this limitation so it is advised to empty the trash via the
WebUI.</p>
<h3 id="root-folder-id">Root folder ID</h3>
<p>You can set the <code>root_folder_id</code> for rclone. This is the
directory (identified by its <code>Folder ID</code>) that rclone
considers to be the root of your Box drive.</p>
<p>Normally you will leave this blank and rclone will determine the
correct root to use itself.</p>
<p>However you can set this to restrict rclone to a specific folder
hierarchy.</p>
<p>In order to do this you will have to find the <code>Folder ID</code>
of the directory you wish rclone to display. This will be the last
segment of the URL when you open the relevant folder in the Box web
interface.</p>
<p>So if the folder you want rclone to use has a URL which looks like
<code>https://app.box.com/folder/11xxxxxxxxx8</code> in the browser,
then you use <code>11xxxxxxxxx8</code> as the
<code>root_folder_id</code> in the config.</p>
<h3 id="standard-options-5">Standard options</h3>
<p>Here are the Standard options specific to box (Box).</p>
<h4 id="box-client-id">–box-client-id</h4>
<p>OAuth Client Id.</p>
<p>Leave blank normally.</p>
<p>Properties:</p>
<ul>
<li>Config: client_id</li>
<li>Env Var: RCLONE_BOX_CLIENT_ID</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="box-client-secret">–box-client-secret</h4>
<p>OAuth Client Secret.</p>
<p>Leave blank normally.</p>
<p>Properties:</p>
<ul>
<li>Config: client_secret</li>
<li>Env Var: RCLONE_BOX_CLIENT_SECRET</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="box-box-config-file">–box-box-config-file</h4>
<p>Box App config.json location</p>
<p>Leave blank normally.</p>
<p>Leading <code>~</code> will be expanded in the file name as will
environment variables such as <code>${RCLONE_CONFIG_DIR}</code>.</p>
<p>Properties:</p>
<ul>
<li>Config: box_config_file</li>
<li>Env Var: RCLONE_BOX_BOX_CONFIG_FILE</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="box-access-token">–box-access-token</h4>
<p>Box App Primary Access Token</p>
<p>Leave blank normally.</p>
<p>Properties:</p>
<ul>
<li>Config: access_token</li>
<li>Env Var: RCLONE_BOX_ACCESS_TOKEN</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="box-box-sub-type">–box-box-sub-type</h4>
<p>Properties:</p>
<ul>
<li>Config: box_sub_type</li>
<li>Env Var: RCLONE_BOX_BOX_SUB_TYPE</li>
<li>Type: string</li>
<li>Default: “user”</li>
<li>Examples:
<ul>
<li>“user”
<ul>
<li>Rclone should act on behalf of a user.</li>
</ul></li>
<li>“enterprise”
<ul>
<li>Rclone should act on behalf of a service account.</li>
</ul></li>
</ul></li>
</ul>
<h3 id="advanced-options-4">Advanced options</h3>
<p>Here are the Advanced options specific to box (Box).</p>
<h4 id="box-token">–box-token</h4>
<p>OAuth Access Token as a JSON blob.</p>
<p>Properties:</p>
<ul>
<li>Config: token</li>
<li>Env Var: RCLONE_BOX_TOKEN</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="box-auth-url">–box-auth-url</h4>
<p>Auth server URL.</p>
<p>Leave blank to use the provider defaults.</p>
<p>Properties:</p>
<ul>
<li>Config: auth_url</li>
<li>Env Var: RCLONE_BOX_AUTH_URL</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="box-token-url">–box-token-url</h4>
<p>Token server url.</p>
<p>Leave blank to use the provider defaults.</p>
<p>Properties:</p>
<ul>
<li>Config: token_url</li>
<li>Env Var: RCLONE_BOX_TOKEN_URL</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="box-root-folder-id">–box-root-folder-id</h4>
<p>Fill in for rclone to use a non root folder as its starting
point.</p>
<p>Properties:</p>
<ul>
<li>Config: root_folder_id</li>
<li>Env Var: RCLONE_BOX_ROOT_FOLDER_ID</li>
<li>Type: string</li>
<li>Default: “0”</li>
</ul>
<h4 id="box-upload-cutoff">–box-upload-cutoff</h4>
<p>Cutoff for switching to multipart upload (&gt;= 50 MiB).</p>
<p>Properties:</p>
<ul>
<li>Config: upload_cutoff</li>
<li>Env Var: RCLONE_BOX_UPLOAD_CUTOFF</li>
<li>Type: SizeSuffix</li>
<li>Default: 50Mi</li>
</ul>
<h4 id="box-commit-retries">–box-commit-retries</h4>
<p>Max number of times to try committing a multipart file.</p>
<p>Properties:</p>
<ul>
<li>Config: commit_retries</li>
<li>Env Var: RCLONE_BOX_COMMIT_RETRIES</li>
<li>Type: int</li>
<li>Default: 100</li>
</ul>
<h4 id="box-list-chunk">–box-list-chunk</h4>
<p>Size of listing chunk 1-1000.</p>
<p>Properties:</p>
<ul>
<li>Config: list_chunk</li>
<li>Env Var: RCLONE_BOX_LIST_CHUNK</li>
<li>Type: int</li>
<li>Default: 1000</li>
</ul>
<h4 id="box-owned-by">–box-owned-by</h4>
<p>Only show items owned by the login (email address) passed in.</p>
<p>Properties:</p>
<ul>
<li>Config: owned_by</li>
<li>Env Var: RCLONE_BOX_OWNED_BY</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="box-encoding">–box-encoding</h4>
<p>The encoding for the backend.</p>
<p>See the <a href="https://rclone.org/overview/#encoding">encoding
section in the overview</a> for more info.</p>
<p>Properties:</p>
<ul>
<li>Config: encoding</li>
<li>Env Var: RCLONE_BOX_ENCODING</li>
<li>Type: MultiEncoder</li>
<li>Default: Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot</li>
</ul>
<h2 id="limitations-7">Limitations</h2>
<p>Note that Box is case insensitive so you can’t have a file called
“Hello.doc” and one called “hello.doc”.</p>
<p>Box file names can’t have the <code>\</code> character in. rclone
maps this to and from an identical looking unicode equivalent
<code>＼</code> (U+FF3C Fullwidth Reverse Solidus).</p>
<p>Box only supports filenames up to 255 characters in length.</p>
<p><code>rclone about</code> is not supported by the Box 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>
<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>
<h1 id="cache-deprecated">Cache (DEPRECATED)</h1>
<p>The <code>cache</code> remote wraps another existing remote and
stores file structure and its data for long running tasks like
<code>rclone mount</code>.</p>
<h2 id="status-1">Status</h2>
<p>The cache backend code is working but it currently doesn’t have a
maintainer so there are <a
href="https://github.com/rclone/rclone/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3A%22Remote%3A+Cache%22">outstanding
bugs</a> which aren’t getting fixed.</p>
<p>The cache backend is due to be phased out in favour of the VFS
caching layer eventually which is more tightly integrated into
rclone.</p>
<p>Until this happens we recommend only using the cache backend if you
find you can’t work without it. There are many docs online describing
the use of the cache backend to minimize API hits and by-and-large these
are out of date and the cache backend isn’t needed in those scenarios
any more.</p>
<h2 id="configuration-6">Configuration</h2>
<p>To get started you just need to have an existing remote which can be
configured with <code>cache</code>.</p>
<p>Here is an example of how to make a remote called
<code>test-cache</code>. First run:</p>
<pre><code> rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<pre><code>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&gt; n
name&gt; test-cache
Type of storage to configure.
Choose a number from below, or type in your own value
[snip]
XX / Cache a remote
   \ &quot;cache&quot;
[snip]
Storage&gt; cache
Remote to cache.
Normally should contain a &#39;:&#39; and a path, e.g. &quot;myremote:path/to/dir&quot;,
&quot;myremote:bucket&quot; or maybe &quot;myremote:&quot; (not recommended).
remote&gt; local:/test
Optional: The URL of the Plex server
plex_url&gt; http://127.0.0.1:32400
Optional: The username of the Plex user
plex_username&gt; 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&gt; 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
   \ &quot;1M&quot;
 2 / 5 MiB
   \ &quot;5M&quot;
 3 / 10 MiB
   \ &quot;10M&quot;
chunk_size&gt; 2
How much time should object info (file size, file hashes, etc.) be stored in cache. Use a very high value if you don&#39;t plan on changing the source FS from outside the cache.
Accepted units are: &quot;s&quot;, &quot;m&quot;, &quot;h&quot;.
Default: 5m
Choose a number from below, or type in your own value
 1 / 1 hour
   \ &quot;1h&quot;
 2 / 24 hours
   \ &quot;24h&quot;
 3 / 24 hours
   \ &quot;48h&quot;
info_age&gt; 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
   \ &quot;500M&quot;
 2 / 1 GiB
   \ &quot;1G&quot;
 3 / 10 GiB
   \ &quot;10G&quot;
chunk_total_size&gt; 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</code></pre>
<p>You can then use it like this,</p>
<p>List directories in top level of your drive</p>
<pre><code>rclone lsd test-cache:</code></pre>
<p>List all the files in your drive</p>
<pre><code>rclone ls test-cache:</code></pre>
<p>To start a cached mount</p>
<pre><code>rclone mount --allow-other test-cache: /var/tmp/test-cache</code></pre>
<h3 id="write-features">Write Features</h3>
<h3 id="offline-uploading">Offline uploading</h3>
<p>In an effort to make writing through cache more reliable, the backend
now supports this feature which can be activated by specifying a
<code>cache-tmp-upload-path</code>.</p>
<p>A files goes through these states when using this feature:</p>
<ol type="1">
<li>An upload is started (usually by copying a file on the cache
remote)</li>
<li>When the copy to the temporary location is complete the file is part
of the cached remote and looks and behaves like any other file (reading
included)</li>
<li>After <code>cache-tmp-wait-time</code> passes and the file is next
in line, <code>rclone move</code> is used to move the file to the cloud
provider</li>
<li>Reading the file still works during the upload but most
modifications on it will be prohibited</li>
<li>Once the move is complete the file is unlocked for modifications as
it becomes as any other regular file</li>
<li>If the file is being read through <code>cache</code> when it’s
actually deleted from the temporary path then <code>cache</code> will
simply swap the source to the cloud provider without interrupting the
reading (small blip can happen though)</li>
</ol>
<p>Files are uploaded in sequence and only one file is uploaded at a
time. Uploads will be stored in a queue and be processed based on the
order they were added. The queue and the temporary storage is persistent
across restarts but can be cleared on startup with the
<code>--cache-db-purge</code> flag.</p>
<h3 id="write-support">Write Support</h3>
<p>Writes are supported through <code>cache</code>. One caveat is that a
mounted cache remote does not add any retry or fallback mechanism to the
upload operation. This will depend on the implementation of the wrapped
remote. Consider using <code>Offline uploading</code> for reliable
writes.</p>
<p>One special case is covered with <code>cache-writes</code> which will
cache the file data at the same time as the upload when it is enabled
making it available from the cache store immediately once the upload is
finished.</p>
<h3 id="read-features">Read Features</h3>
<h4 id="multiple-connections">Multiple connections</h4>
<p>To counter the high latency between a local PC where rclone is
running and cloud providers, the cache remote can split multiple
requests to the cloud provider for smaller file chunks and combines them
together locally where they can be available almost immediately before
the reader usually needs them.</p>
<p>This is similar to buffering when media files are played online.
Rclone will stay around the current marker but always try its best to
stay ahead and prepare the data before.</p>
<h4 id="plex-integration">Plex Integration</h4>
<p>There is a direct integration with Plex which allows cache to detect
during reading if the file is in playback or not. This helps cache to
adapt how it queries the cloud provider depending on what is needed
for.</p>
<p>Scans will have a minimum amount of workers (1) while in a confirmed
playback cache will deploy the configured number of workers.</p>
<p>This integration opens the doorway to additional performance
improvements which will be explored in the near future.</p>
<p><strong>Note:</strong> If Plex options are not configured,
<code>cache</code> will function with its configured options without
adapting any of its settings.</p>
<p>How to enable? Run <code>rclone config</code> and add all the Plex
options (endpoint, username and password) in your remote and it will be
automatically enabled.</p>
<p>Affected settings: - <code>cache-workers</code>: <em>Configured
value</em> during confirmed playback or <em>1</em> all the other
times</p>
<h5 id="certificate-validation">Certificate Validation</h5>
<p>When the Plex server is configured to only accept secure connections,
it is possible to use <code>.plex.direct</code> URLs to ensure
certificate validation succeeds. These URLs are used by Plex internally
to connect to the Plex server securely.</p>
<p>The format for these URLs is the following:</p>
<p><code>https://ip-with-dots-replaced.server-hash.plex.direct:32400/</code></p>
<p>The <code>ip-with-dots-replaced</code> part can be any IPv4 address,
where the dots have been replaced with dashes,
e.g. <code>127.0.0.1</code> becomes <code>127-0-0-1</code>.</p>
<p>To get the <code>server-hash</code> part, the easiest way is to
visit</p>
<p>https://plex.tv/api/resources?includeHttps=1&amp;X-Plex-Token=your-plex-token</p>
<p>This page will list all the available Plex servers for your account
with at least one <code>.plex.direct</code> link for each. Copy one URL
and replace the IP address with the desired address. This can be used as
the <code>plex_url</code> value.</p>
<h3 id="known-issues">Known issues</h3>
<h4 id="mount-and-dir-cache-time">Mount and –dir-cache-time</h4>
<p>–dir-cache-time controls the first layer of directory caching which
works at the mount layer. Being an independent caching mechanism from
the <code>cache</code> backend, it will manage its own entries based on
the configured time.</p>
<p>To avoid getting in a scenario where dir cache has obsolete data and
cache would have the correct one, try to set
<code>--dir-cache-time</code> to a lower time than
<code>--cache-info-age</code>. Default values are already configured in
this way.</p>
<h4 id="windows-support---experimental">Windows support -
Experimental</h4>
<p>There are a couple of issues with Windows <code>mount</code>
functionality that still require some investigations. It should be
considered as experimental thus far as fixes come in for this OS.</p>
<p>Most of the issues seem to be related to the difference between
filesystems on Linux flavors and Windows as cache is heavily dependent
on them.</p>
<p>Any reports or feedback on how cache behaves on this OS is greatly
appreciated.</p>
<ul>
<li>https://github.com/rclone/rclone/issues/1935</li>
<li>https://github.com/rclone/rclone/issues/1907</li>
<li>https://github.com/rclone/rclone/issues/1834</li>
</ul>
<h4 id="risk-of-throttling">Risk of throttling</h4>
<p>Future iterations of the cache backend will make use of the pooling
functionality of the cloud provider to synchronize and at the same time
make writing through it more tolerant to failures.</p>
<p>There are a couple of enhancements in track to add these but in the
meantime there is a valid concern that the expiring cache listings can
lead to cloud provider throttles or bans due to repeated queries on it
for very large mounts.</p>
<p>Some recommendations: - don’t use a very small interval for entry
information (<code>--cache-info-age</code>) - while writes aren’t yet
optimised, you can still write through <code>cache</code> which gives
you the advantage of adding the file in the cache at the same time if
configured to do so.</p>
<p>Future enhancements:</p>
<ul>
<li>https://github.com/rclone/rclone/issues/1937</li>
<li>https://github.com/rclone/rclone/issues/1936</li>
</ul>
<h4 id="cache-and-crypt">cache and crypt</h4>
<p>One common scenario is to keep your data encrypted in the cloud
provider using the <code>crypt</code> remote. <code>crypt</code> uses a
similar technique to wrap around an existing remote and handles this
translation in a seamless way.</p>
<p>There is an issue with wrapping the remotes in this order:
<strong>cloud remote</strong> -&gt; <strong>crypt</strong> -&gt;
<strong>cache</strong></p>
<p>During testing, I experienced a lot of bans with the remotes in this
order. I suspect it might be related to how crypt opens files on the
cloud provider which makes it think we’re downloading the full file
instead of small chunks. Organizing the remotes in this order yields
better results: <strong>cloud remote</strong> -&gt;
<strong>cache</strong> -&gt; <strong>crypt</strong></p>
<h4 id="absolute-remote-paths">absolute remote paths</h4>
<p><code>cache</code> can not differentiate between relative and
absolute paths for the wrapped remote. Any path given in the
<code>remote</code> config setting and on the command line will be
passed to the wrapped remote as is, but for storing the chunks on disk
the path will be made relative by removing any leading <code>/</code>
character.</p>
<p>This behavior is irrelevant for most backend types, but there are
backends where a leading <code>/</code> changes the effective directory,
e.g. in the <code>sftp</code> backend paths starting with a
<code>/</code> are relative to the root of the SSH server and paths
without are relative to the user home directory. As a result
<code>sftp:bin</code> and <code>sftp:/bin</code> will share the same
cache folder, even if they represent a different directory on the SSH
server.</p>
<h3 id="cache-and-remote-control-rc">Cache and Remote Control (–rc)</h3>
<p>Cache supports the new <code>--rc</code> mode in rclone and can be
remote controlled through the following end points: By default, the
listener is disabled if you do not add the flag.</p>
<h3 id="rc-cacheexpire">rc cache/expire</h3>
<p>Purge a remote from the cache backend. Supports either a directory or
a file. It supports both encrypted and unencrypted file names if cache
is wrapped by crypt.</p>
<p>Params: - <strong>remote</strong> = path to remote
<strong>(required)</strong> - <strong>withData</strong> = true/false to
delete cached data (chunks) as well <em>(optional, false by
default)</em></p>
<h3 id="standard-options-6">Standard options</h3>
<p>Here are the Standard options specific to cache (Cache a remote).</p>
<h4 id="cache-remote">–cache-remote</h4>
<p>Remote to cache.</p>
<p>Normally should contain a ‘:’ and a path,
e.g. “myremote:path/to/dir”, “myremote:bucket” or maybe “myremote:” (not
recommended).</p>
<p>Properties:</p>
<ul>
<li>Config: remote</li>
<li>Env Var: RCLONE_CACHE_REMOTE</li>
<li>Type: string</li>
<li>Required: true</li>
</ul>
<h4 id="cache-plex-url">–cache-plex-url</h4>
<p>The URL of the Plex server.</p>
<p>Properties:</p>
<ul>
<li>Config: plex_url</li>
<li>Env Var: RCLONE_CACHE_PLEX_URL</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="cache-plex-username">–cache-plex-username</h4>
<p>The username of the Plex user.</p>
<p>Properties:</p>
<ul>
<li>Config: plex_username</li>
<li>Env Var: RCLONE_CACHE_PLEX_USERNAME</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="cache-plex-password">–cache-plex-password</h4>
<p>The password of the Plex user.</p>
<p><strong>NB</strong> Input to this must be obscured - see <a
href="https://rclone.org/commands/rclone_obscure/">rclone
obscure</a>.</p>
<p>Properties:</p>
<ul>
<li>Config: plex_password</li>
<li>Env Var: RCLONE_CACHE_PLEX_PASSWORD</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="cache-chunk-size">–cache-chunk-size</h4>
<p>The size of a chunk (partial file data).</p>
<p>Use lower numbers for slower connections. If the chunk size is
changed, any downloaded chunks will be invalid and cache-chunk-path will
need to be cleared or unexpected EOF errors will occur.</p>
<p>Properties:</p>
<ul>
<li>Config: chunk_size</li>
<li>Env Var: RCLONE_CACHE_CHUNK_SIZE</li>
<li>Type: SizeSuffix</li>
<li>Default: 5Mi</li>
<li>Examples:
<ul>
<li>“1M”
<ul>
<li>1 MiB</li>
</ul></li>
<li>“5M”
<ul>
<li>5 MiB</li>
</ul></li>
<li>“10M”
<ul>
<li>10 MiB</li>
</ul></li>
</ul></li>
</ul>
<h4 id="cache-info-age">–cache-info-age</h4>
<p>How long to cache file structure information (directory listings,
file size, times, etc.). If all write operations are done through the
cache then you can safely make this value very large as the cache store
will also be updated in real time.</p>
<p>Properties:</p>
<ul>
<li>Config: info_age</li>
<li>Env Var: RCLONE_CACHE_INFO_AGE</li>
<li>Type: Duration</li>
<li>Default: 6h0m0s</li>
<li>Examples:
<ul>
<li>“1h”
<ul>
<li>1 hour</li>
</ul></li>
<li>“24h”
<ul>
<li>24 hours</li>
</ul></li>
<li>“48h”
<ul>
<li>48 hours</li>
</ul></li>
</ul></li>
</ul>
<h4 id="cache-chunk-total-size">–cache-chunk-total-size</h4>
<p>The total size that the chunks can take up on the local disk.</p>
<p>If the cache exceeds this value then it will start to delete the
oldest chunks until it goes under this value.</p>
<p>Properties:</p>
<ul>
<li>Config: chunk_total_size</li>
<li>Env Var: RCLONE_CACHE_CHUNK_TOTAL_SIZE</li>
<li>Type: SizeSuffix</li>
<li>Default: 10Gi</li>
<li>Examples:
<ul>
<li>“500M”
<ul>
<li>500 MiB</li>
</ul></li>
<li>“1G”
<ul>
<li>1 GiB</li>
</ul></li>
<li>“10G”
<ul>
<li>10 GiB</li>
</ul></li>
</ul></li>
</ul>
<h3 id="advanced-options-5">Advanced options</h3>
<p>Here are the Advanced options specific to cache (Cache a remote).</p>
<h4 id="cache-plex-token">–cache-plex-token</h4>
<p>The plex token for authentication - auto set normally.</p>
<p>Properties:</p>
<ul>
<li>Config: plex_token</li>
<li>Env Var: RCLONE_CACHE_PLEX_TOKEN</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="cache-plex-insecure">–cache-plex-insecure</h4>
<p>Skip all certificate verification when connecting to the Plex
server.</p>
<p>Properties:</p>
<ul>
<li>Config: plex_insecure</li>
<li>Env Var: RCLONE_CACHE_PLEX_INSECURE</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="cache-db-path">–cache-db-path</h4>
<p>Directory to store file structure metadata DB.</p>
<p>The remote name is used as the DB file name.</p>
<p>Properties:</p>
<ul>
<li>Config: db_path</li>
<li>Env Var: RCLONE_CACHE_DB_PATH</li>
<li>Type: string</li>
<li>Default: “$HOME/.cache/rclone/cache-backend”</li>
</ul>
<h4 id="cache-chunk-path">–cache-chunk-path</h4>
<p>Directory to cache chunk files.</p>
<p>Path to where partial file data (chunks) are stored locally. The
remote name is appended to the final path.</p>
<p>This config follows the “–cache-db-path”. If you specify a custom
location for “–cache-db-path” and don’t specify one for
“–cache-chunk-path” then “–cache-chunk-path” will use the same path as
“–cache-db-path”.</p>
<p>Properties:</p>
<ul>
<li>Config: chunk_path</li>
<li>Env Var: RCLONE_CACHE_CHUNK_PATH</li>
<li>Type: string</li>
<li>Default: “$HOME/.cache/rclone/cache-backend”</li>
</ul>
<h4 id="cache-db-purge">–cache-db-purge</h4>
<p>Clear all the cached data for this remote on start.</p>
<p>Properties:</p>
<ul>
<li>Config: db_purge</li>
<li>Env Var: RCLONE_CACHE_DB_PURGE</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="cache-chunk-clean-interval">–cache-chunk-clean-interval</h4>
<p>How often should the cache perform cleanups of the chunk storage.</p>
<p>The default value should be ok for most people. If you find that the
cache goes over “cache-chunk-total-size” too often then try to lower
this value to force it to perform cleanups more often.</p>
<p>Properties:</p>
<ul>
<li>Config: chunk_clean_interval</li>
<li>Env Var: RCLONE_CACHE_CHUNK_CLEAN_INTERVAL</li>
<li>Type: Duration</li>
<li>Default: 1m0s</li>
</ul>
<h4 id="cache-read-retries">–cache-read-retries</h4>
<p>How many times to retry a read from a cache storage.</p>
<p>Since reading from a cache stream is independent from downloading
file data, readers can get to a point where there’s no more data in the
cache. Most of the times this can indicate a connectivity issue if cache
isn’t able to provide file data anymore.</p>
<p>For really slow connections, increase this to a point where the
stream is able to provide data but your experience will be very
stuttering.</p>
<p>Properties:</p>
<ul>
<li>Config: read_retries</li>
<li>Env Var: RCLONE_CACHE_READ_RETRIES</li>
<li>Type: int</li>
<li>Default: 10</li>
</ul>
<h4 id="cache-workers">–cache-workers</h4>
<p>How many workers should run in parallel to download chunks.</p>
<p>Higher values will mean more parallel processing (better CPU needed)
and more concurrent requests on the cloud provider. This impacts several
aspects like the cloud provider API limits, more stress on the hardware
that rclone runs on but it also means that streams will be more fluid
and data will be available much more faster to readers.</p>
<p><strong>Note</strong>: If the optional Plex integration is enabled
then this setting will adapt to the type of reading performed and the
value specified here will be used as a maximum number of workers to
use.</p>
<p>Properties:</p>
<ul>
<li>Config: workers</li>
<li>Env Var: RCLONE_CACHE_WORKERS</li>
<li>Type: int</li>
<li>Default: 4</li>
</ul>
<h4 id="cache-chunk-no-memory">–cache-chunk-no-memory</h4>
<p>Disable the in-memory cache for storing chunks during streaming.</p>
<p>By default, cache will keep file data during streaming in RAM as well
to provide it to readers as fast as possible.</p>
<p>This transient data is evicted as soon as it is read and the number
of chunks stored doesn’t exceed the number of workers. However,
depending on other settings like “cache-chunk-size” and “cache-workers”
this footprint can increase if there are parallel streams too (multiple
files being read at the same time).</p>
<p>If the hardware permits it, use this feature to provide an overall
better performance during streaming but it can also be disabled if RAM
is not available on the local machine.</p>
<p>Properties:</p>
<ul>
<li>Config: chunk_no_memory</li>
<li>Env Var: RCLONE_CACHE_CHUNK_NO_MEMORY</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="cache-rps">–cache-rps</h4>
<p>Limits the number of requests per second to the source FS (-1 to
disable).</p>
<p>This setting places a hard limit on the number of requests per second
that cache will be doing to the cloud provider remote and try to respect
that value by setting waits between reads.</p>
<p>If you find that you’re getting banned or limited on the cloud
provider through cache and know that a smaller number of requests per
second will allow you to work with it then you can use this setting for
that.</p>
<p>A good balance of all the other settings should make this setting
useless but it is available to set for more special cases.</p>
<p><strong>NOTE</strong>: This will limit the number of requests during
streams but other API calls to the cloud provider like directory
listings will still pass.</p>
<p>Properties:</p>
<ul>
<li>Config: rps</li>
<li>Env Var: RCLONE_CACHE_RPS</li>
<li>Type: int</li>
<li>Default: -1</li>
</ul>
<h4 id="cache-writes">–cache-writes</h4>
<p>Cache file data on writes through the FS.</p>
<p>If you need to read files immediately after you upload them through
cache you can enable this flag to have their data stored in the cache
store at the same time during upload.</p>
<p>Properties:</p>
<ul>
<li>Config: writes</li>
<li>Env Var: RCLONE_CACHE_WRITES</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="cache-tmp-upload-path">–cache-tmp-upload-path</h4>
<p>Directory to keep temporary files until they are uploaded.</p>
<p>This is the path where cache will use as a temporary storage for new
files that need to be uploaded to the cloud provider.</p>
<p>Specifying a value will enable this feature. Without it, it is
completely disabled and files will be uploaded directly to the cloud
provider</p>
<p>Properties:</p>
<ul>
<li>Config: tmp_upload_path</li>
<li>Env Var: RCLONE_CACHE_TMP_UPLOAD_PATH</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="cache-tmp-wait-time">–cache-tmp-wait-time</h4>
<p>How long should files be stored in local cache before being
uploaded.</p>
<p>This is the duration that a file must wait in the temporary location
<em>cache-tmp-upload-path</em> before it is selected for upload.</p>
<p>Note that only one file is uploaded at a time and it can take longer
to start the upload if a queue formed for this purpose.</p>
<p>Properties:</p>
<ul>
<li>Config: tmp_wait_time</li>
<li>Env Var: RCLONE_CACHE_TMP_WAIT_TIME</li>
<li>Type: Duration</li>
<li>Default: 15s</li>
</ul>
<h4 id="cache-db-wait-time">–cache-db-wait-time</h4>
<p>How long to wait for the DB to be available - 0 is unlimited.</p>
<p>Only one process can have the DB open at any one time, so rclone
waits for this duration for the DB to become available before it gives
an error.</p>
<p>If you set it to 0 then it will wait forever.</p>
<p>Properties:</p>
<ul>
<li>Config: db_wait_time</li>
<li>Env Var: RCLONE_CACHE_DB_WAIT_TIME</li>
<li>Type: Duration</li>
<li>Default: 1s</li>
</ul>
<h2 id="backend-commands-1">Backend commands</h2>
<p>Here are the commands specific to the cache backend.</p>
<p>Run them with</p>
<pre><code>rclone backend COMMAND remote:</code></pre>
<p>The help below will explain what arguments each command takes.</p>
<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>
<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>
<h3 id="stats">stats</h3>
<p>Print stats on the cache backend in JSON format.</p>
<pre><code>rclone backend stats remote: [options] [&lt;arguments&gt;+]</code></pre>
<h1 id="chunker-beta">Chunker (BETA)</h1>
<p>The <code>chunker</code> overlay transparently splits large files
into smaller chunks during upload to wrapped remote and transparently
assembles them back when the file is downloaded. This allows to
effectively overcome size limits imposed by storage providers.</p>
<h2 id="configuration-7">Configuration</h2>
<p>To use it, first set up the underlying remote following the
configuration instructions for that remote. You can also use a local
pathname instead of a remote.</p>
<p>First check your chosen remote is working - we’ll call it
<code>remote:path</code> here. Note that anything inside
<code>remote:path</code> will be chunked and anything outside won’t.
This means that if you are using a bucket-based remote (e.g. S3, B2,
swift) then you should probably put the bucket in the remote
<code>s3:bucket</code>.</p>
<p>Now configure <code>chunker</code> using <code>rclone config</code>.
We will call this one <code>overlay</code> to separate it from the
<code>remote</code> itself.</p>
<pre><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; overlay
Type of storage to configure.
Choose a number from below, or type in your own value
[snip]
XX / Transparently chunk/split large files
   \ &quot;chunker&quot;
[snip]
Storage&gt; chunker
Remote to chunk/unchunk.
Normally should contain a &#39;:&#39; and a path, e.g. &quot;myremote:path/to/dir&quot;,
&quot;myremote:bucket&quot; or maybe &quot;myremote:&quot; (not recommended).
Enter a string value. Press Enter for the default (&quot;&quot;).
remote&gt; 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 (&quot;2G&quot;).
chunk_size&gt; 100M
Choose how chunker handles hash sums. All modes but &quot;none&quot; require metadata.
Enter a string value. Press Enter for the default (&quot;md5&quot;).
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
   \ &quot;none&quot;
 2 / MD5 for composite files
   \ &quot;md5&quot;
 3 / SHA1 for composite files
   \ &quot;sha1&quot;
 4 / MD5 for all files
   \ &quot;md5all&quot;
 5 / SHA1 for all files
   \ &quot;sha1all&quot;
 6 / Copying a file to chunker will request MD5 from the source falling back to SHA1 if unsupported
   \ &quot;md5quick&quot;
 7 / Similar to &quot;md5quick&quot; but prefers SHA1 over MD5
   \ &quot;sha1quick&quot;
hash_type&gt; md5
Edit advanced config? (y/n)
y) Yes
n) No
y/n&gt; 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&gt; y</code></pre>
<h3 id="specifying-the-remote">Specifying the remote</h3>
<p>In normal use, make sure the remote has a <code>:</code> in. If you
specify the remote without a <code>:</code> then rclone will use a local
directory of that name. So if you use a remote of
<code>/path/to/secret/files</code> then rclone will chunk stuff in that
directory. If you use a remote of <code>name</code> then rclone will put
files in a directory called <code>name</code> in the current
directory.</p>
<h3 id="chunking">Chunking</h3>
<p>When rclone starts a file upload, chunker checks the file size. If it
doesn’t exceed the configured chunk size, chunker will just pass the
file to the wrapped remote. If a file is large, chunker will
transparently cut data in pieces with temporary names and stream them
one by one, on the fly. Each data chunk will contain the specified
number of bytes, except for the last one which may have less data. If
file size is unknown in advance (this is called a streaming upload),
chunker will internally create a temporary copy, record its size and
repeat the above process.</p>
<p>When upload completes, temporary chunk files are finally renamed.
This scheme guarantees that operations can be run in parallel and look
from outside as atomic. A similar method with hidden temporary chunks is
used for other operations (copy/move/rename, etc.). If an operation
fails, hidden chunks are normally destroyed, and the target composite
file stays intact.</p>
<p>When a composite file download is requested, chunker transparently
assembles it by concatenating data chunks in order. As the split is
trivial one could even manually concatenate data chunks together to
obtain the original content.</p>
<p>When the <code>list</code> rclone command scans a directory on
wrapped remote, the potential chunk files are accounted for, grouped and
assembled into composite directory entries. Any temporary chunks are
hidden.</p>
<p>List and other commands can sometimes come across composite files
with missing or invalid chunks, e.g. shadowed by like-named directory or
another file. This usually means that wrapped file system has been
directly tampered with or damaged. If chunker detects a missing chunk it
will by default print warning, skip the whole incomplete group of chunks
but proceed with current command. You can set the
<code>--chunker-fail-hard</code> flag to have commands abort with error
message in such cases.</p>
<h4 id="chunk-names">Chunk names</h4>
<p>The default chunk name format is <code>*.rclone_chunk.###</code>,
hence by default chunk names are
<code>BIG_FILE_NAME.rclone_chunk.001</code>,
<code>BIG_FILE_NAME.rclone_chunk.002</code> etc. You can configure
another name format using the <code>name_format</code> configuration
file option. The format uses asterisk <code>*</code> as a placeholder
for the base file name and one or more consecutive hash characters
<code>#</code> as a placeholder for sequential chunk number. There must
be one and only one asterisk. The number of consecutive hash characters
defines the minimum length of a string representing a chunk number. If
decimal chunk number has less digits than the number of hashes, it is
left-padded by zeros. If the decimal string is longer, it is left
intact. By default numbering starts from 1 but there is another option
that allows user to start from 0, e.g. for compatibility with legacy
software.</p>
<p>For example, if name format is <code>big_*-##.part</code> and
original file name is <code>data.txt</code> and numbering starts from 0,
then the first chunk will be named <code>big_data.txt-00.part</code>,
the 99th chunk will be <code>big_data.txt-98.part</code> and the 302nd
chunk will become <code>big_data.txt-301.part</code>.</p>
<p>Note that <code>list</code> assembles composite directory entries
only when chunk names match the configured format and treats
non-conforming file names as normal non-chunked files.</p>
<p>When using <code>norename</code> transactions, chunk names will
additionally have a unique file version suffix. For example,
<code>BIG_FILE_NAME.rclone_chunk.001_bp562k</code>.</p>
<h3 id="metadata-3">Metadata</h3>
<p>Besides data chunks chunker will by default create metadata object
for a composite file. The object is named after the original file.
Chunker allows user to disable metadata completely (the
<code>none</code> format). Note that metadata is normally not created
for files smaller than the configured chunk size. This may change in
future rclone releases.</p>
<h4 id="simple-json-metadata-format">Simple JSON metadata format</h4>
<p>This is the default format. It supports hash sums and chunk
validation for composite files. Meta objects carry the following
fields:</p>
<ul>
<li><code>ver</code> - version of format, currently <code>1</code></li>
<li><code>size</code> - total size of composite file</li>
<li><code>nchunks</code> - number of data chunks in file</li>
<li><code>md5</code> - MD5 hashsum of composite file (if present)</li>
<li><code>sha1</code> - SHA1 hashsum (if present)</li>
<li><code>txn</code> - identifies current version of the file</li>
</ul>
<p>There is no field for composite file name as it’s simply equal to the
name of meta object on the wrapped remote. Please refer to respective
sections for details on hashsums and modified time handling.</p>
<h4 id="no-metadata">No metadata</h4>
<p>You can disable meta objects by setting the meta format option to
<code>none</code>. In this mode chunker will scan directory for all
files that follow configured chunk name format, group them by detecting
chunks with the same base name and show group names as virtual composite
files. This method is more prone to missing chunk errors (especially
missing last chunk) than format with metadata enabled.</p>
<h3 id="hashsums">Hashsums</h3>
<p>Chunker supports hashsums only when a compatible metadata is present.
Hence, if you choose metadata format of <code>none</code>, chunker will
report hashsum as <code>UNSUPPORTED</code>.</p>
<p>Please note that by default metadata is stored only for composite
files. If a file is smaller than configured chunk size, chunker will
transparently redirect hash requests to wrapped remote, so support
depends on that. You will see the empty string as a hashsum of requested
type for small files if the wrapped remote doesn’t support it.</p>
<p>Many storage backends support MD5 and SHA1 hash types, so does
chunker. With chunker you can choose one or another but not both. MD5 is
set by default as the most supported type. Since chunker keeps hashes
for composite files and falls back to the wrapped remote hash for
non-chunked ones, we advise you to choose the same hash type as
supported by wrapped remote so that your file listings look
coherent.</p>
<p>If your storage backend does not support MD5 or SHA1 but you need
consistent file hashing, configure chunker with <code>md5all</code> or
<code>sha1all</code>. These two modes guarantee given hash for all
files. If wrapped remote doesn’t support it, chunker will then add
metadata to all files, even small. However, this can double the amount
of small files in storage and incur additional service charges. You can
even use chunker to force md5/sha1 support in any other remote at
expense of sidecar meta objects by setting
e.g. <code>chunk_type=sha1all</code> to force hashsums and
<code>chunk_size=1P</code> to effectively disable chunking.</p>
<p>Normally, when a file is copied to chunker controlled remote, chunker
will ask the file source for compatible file hash and revert to
on-the-fly calculation if none is found. This involves some CPU overhead
but provides a guarantee that given hashsum is available. Also, chunker
will reject a server-side copy or move operation if source and
destination hashsum types are different resulting in the extra network
bandwidth, too. In some rare cases this may be undesired, so chunker
provides two optional choices: <code>sha1quick</code> and
<code>md5quick</code>. If the source does not support primary hash type
and the quick mode is enabled, chunker will try to fall back to the
secondary type. This will save CPU and bandwidth but can result in empty
hashsums at destination. Beware of consequences: the <code>sync</code>
command will revert (sometimes silently) to time/size comparison if
compatible hashsums between source and target are not found.</p>
<h3 id="modified-time-2">Modified time</h3>
<p>Chunker stores modification times using the wrapped remote so support
depends on that. For a small non-chunked file the chunker overlay simply
manipulates modification time of the wrapped remote file. For a
composite file with metadata chunker will get and set modification time
of the metadata object on the wrapped remote. If file is chunked but
metadata format is <code>none</code> then chunker will use modification
time of the first data chunk.</p>
<h3 id="migrations">Migrations</h3>
<p>The idiomatic way to migrate to a different chunk size, hash type,
transaction style or chunk naming scheme is to:</p>
<ul>
<li>Collect all your chunked files under a directory and have your
chunker remote point to it.</li>
<li>Create another directory (most probably on the same cloud storage)
and configure a new remote with desired metadata format, hash type,
chunk naming etc.</li>
<li>Now run <code>rclone sync -i oldchunks: newchunks:</code> and all
your data will be transparently converted in transfer. This may take
some time, yet chunker will try server-side copy if possible.</li>
<li>After checking data integrity you may remove configuration section
of the old remote.</li>
</ul>
<p>If rclone gets killed during a long operation on a big composite
file, hidden temporary chunks may stay in the directory. They will not
be shown by the <code>list</code> command but will eat up your account
quota. Please note that the <code>deletefile</code> command deletes only
active chunks of a file. As a workaround, you can use remote of the
wrapped file system to see them. An easy way to get rid of hidden
garbage is to copy littered directory somewhere using the chunker remote
and purge the original directory. The <code>copy</code> command will
copy only active chunks while the <code>purge</code> will remove
everything including garbage.</p>
<h3 id="caveats-and-limitations">Caveats and Limitations</h3>
<p>Chunker requires wrapped remote to support server-side
<code>move</code> (or <code>copy</code> + <code>delete</code>)
operations, otherwise it will explicitly refuse to start. This is
because it internally renames temporary chunk files to their final names
when an operation completes successfully.</p>
<p>Chunker encodes chunk number in file name, so with default
<code>name_format</code> setting it adds 17 characters. Also chunker
adds 7 characters of temporary suffix during operations. Many file
systems limit base file name without path by 255 characters. Using
rclone’s crypt remote as a base file system limits file name by 143
characters. Thus, maximum name length is 231 for most files and 119 for
chunker-over-crypt. A user in need can change name format to
e.g. <code>*.rcc##</code> and save 10 characters (provided at most 99
chunks per file).</p>
<p>Note that a move implemented using the copy-and-delete method may
incur double charging with some cloud storage providers.</p>
<p>Chunker will not automatically rename existing chunks when you run
<code>rclone config</code> on a live remote and change the chunk name
format. Beware that in result of this some files which have been treated
as chunks before the change can pop up in directory listings as normal
files and vice versa. The same warning holds for the chunk size. If you
desperately need to change critical chunking settings, you should run
data migration as described above.</p>
<p>If wrapped remote is case insensitive, the chunker overlay will
inherit that property (so you can’t have a file called “Hello.doc” and
“hello.doc” in the same directory).</p>
<p>Chunker included in rclone releases up to <code>v1.54</code> can
sometimes fail to detect metadata produced by recent versions of rclone.
We recommend users to keep rclone up-to-date to avoid data
corruption.</p>
<p>Changing <code>transactions</code> is dangerous and requires explicit
migration.</p>
<h3 id="standard-options-7">Standard options</h3>
<p>Here are the Standard options specific to chunker (Transparently
chunk/split large files).</p>
<h4 id="chunker-remote">–chunker-remote</h4>
<p>Remote to chunk/unchunk.</p>
<p>Normally should contain a ‘:’ and a path,
e.g. “myremote:path/to/dir”, “myremote:bucket” or maybe “myremote:” (not
recommended).</p>
<p>Properties:</p>
<ul>
<li>Config: remote</li>
<li>Env Var: RCLONE_CHUNKER_REMOTE</li>
<li>Type: string</li>
<li>Required: true</li>
</ul>
<h4 id="chunker-chunk-size">–chunker-chunk-size</h4>
<p>Files larger than chunk size will be split in chunks.</p>
<p>Properties:</p>
<ul>
<li>Config: chunk_size</li>
<li>Env Var: RCLONE_CHUNKER_CHUNK_SIZE</li>
<li>Type: SizeSuffix</li>
<li>Default: 2Gi</li>
</ul>
<h4 id="chunker-hash-type">–chunker-hash-type</h4>
<p>Choose how chunker handles hash sums.</p>
<p>All modes but “none” require metadata.</p>
<p>Properties:</p>
<ul>
<li>Config: hash_type</li>
<li>Env Var: RCLONE_CHUNKER_HASH_TYPE</li>
<li>Type: string</li>
<li>Default: “md5”</li>
<li>Examples:
<ul>
<li>“none”
<ul>
<li>Pass any hash supported by wrapped remote for non-chunked
files.</li>
<li>Return nothing otherwise.</li>
</ul></li>
<li>“md5”
<ul>
<li>MD5 for composite files.</li>
</ul></li>
<li>“sha1”
<ul>
<li>SHA1 for composite files.</li>
</ul></li>
<li>“md5all”
<ul>
<li>MD5 for all files.</li>
</ul></li>
<li>“sha1all”
<ul>
<li>SHA1 for all files.</li>
</ul></li>
<li>“md5quick”
<ul>
<li>Copying a file to chunker will request MD5 from the source.</li>
<li>Falling back to SHA1 if unsupported.</li>
</ul></li>
<li>“sha1quick”
<ul>
<li>Similar to “md5quick” but prefers SHA1 over MD5.</li>
</ul></li>
</ul></li>
</ul>
<h3 id="advanced-options-6">Advanced options</h3>
<p>Here are the Advanced options specific to chunker (Transparently
chunk/split large files).</p>
<h4 id="chunker-name-format">–chunker-name-format</h4>
<p>String format of chunk file names.</p>
<p>The two placeholders are: base file name (*) and chunk number (#…).
There must be one and only one asterisk and one or more consecutive hash
characters. If chunk number has less digits than the number of hashes,
it is left-padded by zeros. If there are more digits in the number, they
are left as is. Possible chunk files are ignored if their name does not
match given format.</p>
<p>Properties:</p>
<ul>
<li>Config: name_format</li>
<li>Env Var: RCLONE_CHUNKER_NAME_FORMAT</li>
<li>Type: string</li>
<li>Default: “*.rclone_chunk.###”</li>
</ul>
<h4 id="chunker-start-from">–chunker-start-from</h4>
<p>Minimum valid chunk number. Usually 0 or 1.</p>
<p>By default chunk numbers start from 1.</p>
<p>Properties:</p>
<ul>
<li>Config: start_from</li>
<li>Env Var: RCLONE_CHUNKER_START_FROM</li>
<li>Type: int</li>
<li>Default: 1</li>
</ul>
<h4 id="chunker-meta-format">–chunker-meta-format</h4>
<p>Format of the metadata object or “none”.</p>
<p>By default “simplejson”. Metadata is a small JSON file named after
the composite file.</p>
<p>Properties:</p>
<ul>
<li>Config: meta_format</li>
<li>Env Var: RCLONE_CHUNKER_META_FORMAT</li>
<li>Type: string</li>
<li>Default: “simplejson”</li>
<li>Examples:
<ul>
<li>“none”
<ul>
<li>Do not use metadata files at all.</li>
<li>Requires hash type “none”.</li>
</ul></li>
<li>“simplejson”
<ul>
<li>Simple JSON supports hash sums and chunk validation.</li>
<li></li>
<li>It has the following fields: ver, size, nchunks, md5, sha1.</li>
</ul></li>
</ul></li>
</ul>
<h4 id="chunker-fail-hard">–chunker-fail-hard</h4>
<p>Choose how chunker should handle files with missing or invalid
chunks.</p>
<p>Properties:</p>
<ul>
<li>Config: fail_hard</li>
<li>Env Var: RCLONE_CHUNKER_FAIL_HARD</li>
<li>Type: bool</li>
<li>Default: false</li>
<li>Examples:
<ul>
<li>“true”
<ul>
<li>Report errors and abort current command.</li>
</ul></li>
<li>“false”
<ul>
<li>Warn user, skip incomplete file and proceed.</li>
</ul></li>
</ul></li>
</ul>
<h4 id="chunker-transactions">–chunker-transactions</h4>
<p>Choose how chunker should handle temporary files during
transactions.</p>
<p>Properties:</p>
<ul>
<li>Config: transactions</li>
<li>Env Var: RCLONE_CHUNKER_TRANSACTIONS</li>
<li>Type: string</li>
<li>Default: “rename”</li>
<li>Examples:
<ul>
<li>“rename”
<ul>
<li>Rename temporary files after a successful transaction.</li>
</ul></li>
<li>“norename”
<ul>
<li>Leave temporary file names and write transaction ID to metadata
file.</li>
<li>Metadata is required for no rename transactions (meta format cannot
be “none”).</li>
<li>If you are using norename transactions you should be careful not to
downgrade Rclone</li>
<li>as older versions of Rclone don’t support this transaction style and
will misinterpret</li>
<li>files manipulated by norename transactions.</li>
<li>This method is EXPERIMENTAL, don’t use on production systems.</li>
</ul></li>
<li>“auto”
<ul>
<li>Rename or norename will be used depending on capabilities of the
backend.</li>
<li>If meta format is set to “none”, rename transactions will always be
used.</li>
<li>This method is EXPERIMENTAL, don’t use on production systems.</li>
</ul></li>
</ul></li>
</ul>
<h1 id="citrix-sharefile">Citrix ShareFile</h1>
<p><a href="https://sharefile.com">Citrix ShareFile</a> is a secure file
sharing and transfer service aimed as business.</p>
<h2 id="configuration-8">Configuration</h2>
<p>The initial setup for Citrix ShareFile involves getting a token from
Citrix ShareFile which you can in your browser.
<code>rclone config</code> walks you through it.</p>
<p>Here is an example of how to make a remote called
<code>remote</code>. First run:</p>
<pre><code> rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<pre><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; remote
Type of storage to configure.
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
XX / Citrix Sharefile
   \ &quot;sharefile&quot;
Storage&gt; sharefile
** See help for sharefile backend at: https://rclone.org/sharefile/ **

ID of the root folder

Leave blank to access &quot;Personal Folders&quot;.  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 (&quot;&quot;).
Choose a number from below, or type in your own value
 1 / Access the Personal Folders. (Default)
   \ &quot;&quot;
 2 / Access the Favorites folder.
   \ &quot;favorites&quot;
 3 / Access all the shared folders.
   \ &quot;allshared&quot;
 4 / Access all the individual connectors.
   \ &quot;connectors&quot;
 5 / Access the home, favorites, and shared folders as well as the connectors.
   \ &quot;top&quot;
root_folder_id&gt; 
Edit advanced config? (y/n)
y) Yes
n) No
y/n&gt; n
Remote config
Use auto config?
 * Say Y if not sure
 * Say N if you are working on a remote or headless machine
y) Yes
n) No
y/n&gt; y
If your browser doesn&#39;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 = {&quot;access_token&quot;:&quot;XXX&quot;,&quot;token_type&quot;:&quot;bearer&quot;,&quot;refresh_token&quot;:&quot;XXX&quot;,&quot;expiry&quot;:&quot;2019-09-30T19:41:45.878561877+01:00&quot;}
--------------------
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<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>
<p>Note that rclone runs a webserver on your local machine to collect
the token as returned from Citrix ShareFile. This only runs from the
moment it opens your browser to the moment you get back the verification
code. This is on <code>http://127.0.0.1:53682/</code> and this it may
require you to unblock it temporarily if you are running a host
firewall.</p>
<p>Once configured you can then use <code>rclone</code> like this,</p>
<p>List directories in top level of your ShareFile</p>
<pre><code>rclone lsd remote:</code></pre>
<p>List all the files in your ShareFile</p>
<pre><code>rclone ls remote:</code></pre>
<p>To copy a local directory to an ShareFile directory called backup</p>
<pre><code>rclone copy /home/source remote:backup</code></pre>
<p>Paths may be as deep as required,
e.g. <code>remote:directory/subdirectory</code>.</p>
<h3 id="modified-time-and-hashes-2">Modified time and hashes</h3>
<p>ShareFile allows modification times to be set on objects accurate to
1 second. These will be used to detect whether objects need syncing or
not.</p>
<p>ShareFile supports MD5 type hashes, so you can use the
<code>--checksum</code> flag.</p>
<h3 id="transfers-2">Transfers</h3>
<p>For files above 128 MiB rclone will use a chunked transfer. Rclone
will upload up to <code>--transfers</code> chunks at the same time
(shared among all the multipart uploads). Chunks are buffered in memory
and are normally 64 MiB so increasing <code>--transfers</code> will
increase memory use.</p>
<h3 id="restricted-filename-characters-5">Restricted filename
characters</h3>
<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>
<table>
<thead>
<tr class="header">
<th>Character</th>
<th style="text-align: center;">Value</th>
<th style="text-align: center;">Replacement</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>\</td>
<td style="text-align: center;">0x5C</td>
<td style="text-align: center;">＼</td>
</tr>
<tr class="even">
<td>*</td>
<td style="text-align: center;">0x2A</td>
<td style="text-align: center;">＊</td>
</tr>
<tr class="odd">
<td>&lt;</td>
<td style="text-align: center;">0x3C</td>
<td style="text-align: center;">＜</td>
</tr>
<tr class="even">
<td>&gt;</td>
<td style="text-align: center;">0x3E</td>
<td style="text-align: center;">＞</td>
</tr>
<tr class="odd">
<td>?</td>
<td style="text-align: center;">0x3F</td>
<td style="text-align: center;">？</td>
</tr>
<tr class="even">
<td>:</td>
<td style="text-align: center;">0x3A</td>
<td style="text-align: center;">：</td>
</tr>
<tr class="odd">
<td>|</td>
<td style="text-align: center;">0x7C</td>
<td style="text-align: center;">｜</td>
</tr>
<tr class="even">
<td>”</td>
<td style="text-align: center;">0x22</td>
<td style="text-align: center;">＂</td>
</tr>
</tbody>
</table>
<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>
<table>
<thead>
<tr class="header">
<th>Character</th>
<th style="text-align: center;">Value</th>
<th style="text-align: center;">Replacement</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>SP</td>
<td style="text-align: center;">0x20</td>
<td style="text-align: center;">␠</td>
</tr>
<tr class="even">
<td>.</td>
<td style="text-align: center;">0x2E</td>
<td style="text-align: center;">．</td>
</tr>
</tbody>
</table>
<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>
<h3 id="standard-options-8">Standard options</h3>
<p>Here are the Standard options specific to sharefile (Citrix
Sharefile).</p>
<h4 id="sharefile-root-folder-id">–sharefile-root-folder-id</h4>
<p>ID of the root folder.</p>
<p>Leave blank to access “Personal Folders”. You can use one of the
standard values here or any folder ID (long hex number ID).</p>
<p>Properties:</p>
<ul>
<li>Config: root_folder_id</li>
<li>Env Var: RCLONE_SHAREFILE_ROOT_FOLDER_ID</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“”
<ul>
<li>Access the Personal Folders (default).</li>
</ul></li>
<li>“favorites”
<ul>
<li>Access the Favorites folder.</li>
</ul></li>
<li>“allshared”
<ul>
<li>Access all the shared folders.</li>
</ul></li>
<li>“connectors”
<ul>
<li>Access all the individual connectors.</li>
</ul></li>
<li>“top”
<ul>
<li>Access the home, favorites, and shared folders as well as the
connectors.</li>
</ul></li>
</ul></li>
</ul>
<h3 id="advanced-options-7">Advanced options</h3>
<p>Here are the Advanced options specific to sharefile (Citrix
Sharefile).</p>
<h4 id="sharefile-upload-cutoff">–sharefile-upload-cutoff</h4>
<p>Cutoff for switching to multipart upload.</p>
<p>Properties:</p>
<ul>
<li>Config: upload_cutoff</li>
<li>Env Var: RCLONE_SHAREFILE_UPLOAD_CUTOFF</li>
<li>Type: SizeSuffix</li>
<li>Default: 128Mi</li>
</ul>
<h4 id="sharefile-chunk-size">–sharefile-chunk-size</h4>
<p>Upload chunk size.</p>
<p>Must a power of 2 &gt;= 256k.</p>
<p>Making this larger will improve performance, but note that each chunk
is buffered in memory one per transfer.</p>
<p>Reducing this will reduce memory usage but decrease performance.</p>
<p>Properties:</p>
<ul>
<li>Config: chunk_size</li>
<li>Env Var: RCLONE_SHAREFILE_CHUNK_SIZE</li>
<li>Type: SizeSuffix</li>
<li>Default: 64Mi</li>
</ul>
<h4 id="sharefile-endpoint">–sharefile-endpoint</h4>
<p>Endpoint for API calls.</p>
<p>This is usually auto discovered as part of the oauth process, but can
be set manually to something like: https://XXX.sharefile.com</p>
<p>Properties:</p>
<ul>
<li>Config: endpoint</li>
<li>Env Var: RCLONE_SHAREFILE_ENDPOINT</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="sharefile-encoding">–sharefile-encoding</h4>
<p>The encoding for the backend.</p>
<p>See the <a href="https://rclone.org/overview/#encoding">encoding
section in the overview</a> for more info.</p>
<p>Properties:</p>
<ul>
<li>Config: encoding</li>
<li>Env Var: RCLONE_SHAREFILE_ENCODING</li>
<li>Type: MultiEncoder</li>
<li>Default:
Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot</li>
</ul>
<h2 id="limitations-8">Limitations</h2>
<p>Note that ShareFile is case insensitive so you can’t have a file
called “Hello.doc” and one called “hello.doc”.</p>
<p>ShareFile only supports filenames up to 256 characters in length.</p>
<p><code>rclone about</code> is not supported by the Citrix ShareFile
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>
<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>
<h1 id="crypt">Crypt</h1>
<p>Rclone <code>crypt</code> remotes encrypt and decrypt other
remotes.</p>
<p>A remote of type <code>crypt</code> does not access a <a
href="https://rclone.org/overview/">storage system</a> directly, but
instead wraps another remote, which in turn accesses the storage system.
This is similar to how <a href="https://rclone.org/alias/">alias</a>, <a
href="https://rclone.org/union/">union</a>, <a
href="https://rclone.org/chunker/">chunker</a> and a few others work. It
makes the usage very flexible, as you can add a layer, in this case an
encryption layer, on top of any other backend, even in multiple layers.
Rclone’s functionality can be used as with any other remote, for example
you can <a href="https://rclone.org/commands/rclone_mount/">mount</a> a
crypt remote.</p>
<p>Accessing a storage system through a crypt remote realizes
client-side encryption, which makes it safe to keep your data in a
location you do not trust will not get compromised. When working against
the <code>crypt</code> remote, rclone will automatically encrypt (before
uploading) and decrypt (after downloading) on your local system as
needed on the fly, leaving the data encrypted at rest in the wrapped
remote. If you access the storage system using an application other than
rclone, or access the wrapped remote directly using rclone, there will
not be any encryption/decryption: Downloading existing content will just
give you the encrypted (scrambled) format, and anything you upload will
<em>not</em> become encrypted.</p>
<p>The encryption is a secret-key encryption (also called symmetric key
encryption) algorithm, where a password (or pass phrase) is used to
generate real encryption key. The password can be supplied by user, or
you may chose to let rclone generate one. It will be stored in the
configuration file, in a lightly obscured form. If you are in an
environment where you are not able to keep your configuration secured,
you should add <a
href="https://rclone.org/docs/#configuration-encryption">configuration
encryption</a> as protection. As long as you have this configuration
file, you will be able to decrypt your data. Without the configuration
file, as long as you remember the password (or keep it in a safe place),
you can re-create the configuration and gain access to the existing
data. You may also configure a corresponding remote in a different
installation to access the same data. See below for guidance to <a
href="#changing-password">changing password</a>.</p>
<p>Encryption uses <a
href="https://en.wikipedia.org/wiki/Salt_(cryptography)">cryptographic
salt</a>, to permute the encryption key so that the same string may be
encrypted in different ways. When configuring the crypt remote it is
optional to enter a salt, or to let rclone generate a unique salt. If
omitted, rclone uses a built-in unique string. Normally in cryptography,
the salt is stored together with the encrypted content, and do not have
to be memorized by the user. This is not the case in rclone, because
rclone does not store any additional information on the remotes. Use of
custom salt is effectively a second password that must be memorized.</p>
<p><a href="#file-encryption">File content</a> encryption is performed
using <a
href="https://godoc.org/golang.org/x/crypto/nacl/secretbox">NaCl
SecretBox</a>, based on XSalsa20 cipher and Poly1305 for integrity. <a
href="#name-encryption">Names</a> (file- and directory names) are also
encrypted by default, but this has some implications and is therefore
possible to turned off.</p>
<h2 id="configuration-9">Configuration</h2>
<p>Here is an example of how to make a remote called
<code>secret</code>.</p>
<p>To use <code>crypt</code>, first set up the underlying remote. Follow
the <code>rclone config</code> instructions for the specific
backend.</p>
<p>Before configuring the crypt remote, check the underlying remote is
working. In this example the underlying remote is called
<code>remote</code>. We will configure a path <code>path</code> within
this remote to contain the encrypted content. Anything inside
<code>remote:path</code> will be encrypted and anything outside will
not.</p>
<p>Configure <code>crypt</code> using <code>rclone config</code>. In
this example the <code>crypt</code> remote is called
<code>secret</code>, to differentiate it from the underlying
<code>remote</code>.</p>
<p>When you are done you can use the crypt remote named
<code>secret</code> just as you would with any other remote,
e.g. <code>rclone copy D:\docs secret:\docs</code>, and rclone will
encrypt and decrypt as needed on the fly. If you access the wrapped
remote <code>remote:path</code> directly you will bypass the encryption,
and anything you read will be in encrypted form, and anything you write
will be unencrypted. To avoid issues it is best to configure a dedicated
path for encrypted content, and access it exclusively through a crypt
remote.</p>
<pre><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; secret
Type of storage to configure.
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
[snip]
XX / Encrypt/Decrypt a remote
   \ &quot;crypt&quot;
[snip]
Storage&gt; crypt
** See help for crypt backend at: https://rclone.org/crypt/ **

Remote to encrypt/decrypt.
Normally should contain a &#39;:&#39; and a path, eg &quot;myremote:path/to/dir&quot;,
&quot;myremote:bucket&quot; or maybe &quot;myremote:&quot; (not recommended).
Enter a string value. Press Enter for the default (&quot;&quot;).
remote&gt; remote:path
How to encrypt the filenames.
Enter a string value. Press Enter for the default (&quot;standard&quot;).
Choose a number from below, or type in your own value.
   / Encrypt the filenames.
 1 | See the docs for the details.
   \ &quot;standard&quot;
 2 / Very simple filename obfuscation.
   \ &quot;obfuscate&quot;
   / Don&#39;t encrypt the file names.
 3 | Adds a &quot;.bin&quot; extension only.
   \ &quot;off&quot;
filename_encryption&gt;
Option to either encrypt directory names or leave them intact.

NB If filename_encryption is &quot;off&quot; then this option will do nothing.
Enter a boolean value (true or false). Press Enter for the default (&quot;true&quot;).
Choose a number from below, or type in your own value
 1 / Encrypt directory names.
   \ &quot;true&quot;
 2 / Don&#39;t encrypt directory names, leave them intact.
   \ &quot;false&quot;
directory_name_encryption&gt;
Password or pass phrase for encryption.
y) Yes type in my own password
g) Generate random password
y/g&gt; 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&gt; g
Password strength in bits.
64 is just about memorable
128 is secure
1024 is the maximum
Bits&gt; 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&gt;
Edit advanced config? (y/n)
y) Yes
n) No (default)
y/n&gt;
Remote config
--------------------
[secret]
type = crypt
remote = remote:path
password = *** ENCRYPTED ***
password2 = *** ENCRYPTED ***
--------------------
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d&gt;</code></pre>
<p><strong>Important</strong> The crypt password stored in
<code>rclone.conf</code> is lightly obscured. That only protects it from
cursory inspection. It is not secure unless <a
href="https://rclone.org/docs/#configuration-encryption">configuration
encryption</a> of <code>rclone.conf</code> is specified.</p>
<p>A long passphrase is recommended, or <code>rclone config</code> can
generate a random one.</p>
<p>The obscured password is created using AES-CTR with a static key. The
salt is stored verbatim at the beginning of the obscured password. This
static key is shared between all versions of rclone.</p>
<p>If you reconfigure rclone with the same passwords/passphrases
elsewhere it will be compatible, but the obscured version will be
different due to the different salt.</p>
<p>Rclone does not encrypt</p>
<ul>
<li>file length - this can be calculated within 16 bytes</li>
<li>modification time - used for syncing</li>
</ul>
<h3 id="specifying-the-remote-1">Specifying the remote</h3>
<p>When configuring the remote to encrypt/decrypt, you may specify any
string that rclone accepts as a source/destination of other
commands.</p>
<p>The primary use case is to specify the path into an already
configured remote (e.g. <code>remote:path/to/dir</code> or
<code>remote:bucket</code>), such that data in a remote untrusted
location can be stored encrypted.</p>
<p>You may also specify a local filesystem path, such as
<code>/path/to/dir</code> on Linux, <code>C:\path\to\dir</code> on
Windows. By creating a crypt remote pointing to such a local filesystem
path, you can use rclone as a utility for pure local file encryption,
for example to keep encrypted files on a removable USB drive.</p>
<p><strong>Note</strong>: A string which do not contain a <code>:</code>
will by rclone be treated as a relative path in the local filesystem.
For example, if you enter the name <code>remote</code> without the
trailing <code>:</code>, it will be treated as a subdirectory of the
current directory with name “remote”.</p>
<p>If a path <code>remote:path/to/dir</code> is specified, rclone stores
encrypted files in <code>path/to/dir</code> on the remote. With file
name encryption, files saved to <code>secret:subdir/subfile</code> are
stored in the unencrypted path <code>path/to/dir</code> but the
<code>subdir/subpath</code> element is encrypted.</p>
<p>The path you specify does not have to exist, rclone will create it
when needed.</p>
<p>If you intend to use the wrapped remote both directly for keeping
unencrypted content, as well as through a crypt remote for encrypted
content, it is recommended to point the crypt remote to a separate
directory within the wrapped remote. If you use a bucket-based storage
system (e.g. Swift, S3, Google Compute Storage, B2) it is generally
advisable to wrap the crypt remote around a specific bucket
(<code>s3:bucket</code>). If wrapping around the entire root of the
storage (<code>s3:</code>), and use the optional file name encryption,
rclone will encrypt the bucket name.</p>
<h3 id="changing-password">Changing password</h3>
<p>Should the password, or the configuration file containing a lightly
obscured form of the password, be compromised, you need to re-encrypt
your data with a new password. Since rclone uses secret-key encryption,
where the encryption key is generated directly from the password kept on
the client, it is not possible to change the password/key of already
encrypted content. Just changing the password configured for an existing
crypt remote means you will no longer able to decrypt any of the
previously encrypted content. The only possibility is to re-upload
everything via a crypt remote configured with your new password.</p>
<p>Depending on the size of your data, your bandwidth, storage quota
etc, there are different approaches you can take: - If you have
everything in a different location, for example on your local system,
you could remove all of the prior encrypted files, change the password
for your configured crypt remote (or delete and re-create the crypt
configuration), and then re-upload everything from the alternative
location. - If you have enough space on the storage system you can
create a new crypt remote pointing to a separate directory on the same
backend, and then use rclone to copy everything from the original crypt
remote to the new, effectively decrypting everything on the fly using
the old password and re-encrypting using the new password. When done,
delete the original crypt remote directory and finally the rclone crypt
configuration with the old password. All data will be streamed from the
storage system and back, so you will get half the bandwidth and be
charged twice if you have upload and download quota on the storage
system.</p>
<p><strong>Note</strong>: A security problem related to the random
password generator was fixed in rclone version 1.53.3 (released
2020-11-19). Passwords generated by rclone config in version 1.49.0
(released 2019-08-26) to 1.53.2 (released 2020-10-26) are not considered
secure and should be changed. If you made up your own password, or used
rclone version older than 1.49.0 or newer than 1.53.2 to generate it,
you are <em>not</em> affected by this issue. See <a
href="https://github.com/rclone/rclone/issues/4783">issue #4783</a> for
more details, and a tool you can use to check if you are affected.</p>
<h3 id="example">Example</h3>
<p>Create the following file structure using “standard” file name
encryption.</p>
<pre><code>plaintext/
├── file0.txt
├── file1.txt
└── subdir
    ├── file2.txt
    ├── file3.txt
    └── subsubdir
        └── file4.txt</code></pre>
<p>Copy these to the remote, and list them</p>
<pre><code>$ 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</code></pre>
<p>The crypt remote looks like</p>
<pre><code>$ rclone -q ls remote:path
       55 hagjclgavj2mbiqm6u6cnjjqcg
       54 v05749mltvv1tf4onltun46gls
       57 86vhrsv86mpbtd3a0akjuqslj8/dlj7fkq4kdq72emafg7a7s41uo
       58 86vhrsv86mpbtd3a0akjuqslj8/7uu829995du6o42n32otfhjqp4/b9pausrfansjth5ob3jkdqd4lc
       56 86vhrsv86mpbtd3a0akjuqslj8/8njh1sk437gttmep3p70g81aps</code></pre>
<p>The directory structure is preserved</p>
<pre><code>$ rclone -q ls secret:subdir
        8 file2.txt
        9 file3.txt
       10 subsubdir/file4.txt</code></pre>
<p>Without file name encryption <code>.bin</code> extensions are added
to underlying names. This prevents the cloud provider attempting to
interpret file content.</p>
<pre><code>$ 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</code></pre>
<h3 id="file-name-encryption-modes">File name encryption modes</h3>
<p>Off</p>
<ul>
<li>doesn’t hide file names or directory structure</li>
<li>allows for longer file names (~246 characters)</li>
<li>can use sub paths and copy single files</li>
</ul>
<p>Standard</p>
<ul>
<li>file names encrypted</li>
<li>file names can’t be as long (~143 characters)</li>
<li>can use sub paths and copy single files</li>
<li>directory structure visible</li>
<li>identical files names will have identical uploaded names</li>
<li>can use shortcuts to shorten the directory recursion</li>
</ul>
<p>Obfuscation</p>
<p>This is a simple “rotate” of the filename, with each file having a
rot distance based on the filename. Rclone stores the distance at the
beginning of the filename. A file called “hello” may become
“53.jgnnq”.</p>
<p>Obfuscation is not a strong encryption of filenames, but hinders
automated scanning tools picking up on filename patterns. It is an
intermediate between “off” and “standard” which allows for longer path
segment names.</p>
<p>There is a possibility with some unicode based filenames that the
obfuscation is weak and may map lower case characters to upper case
equivalents.</p>
<p>Obfuscation cannot be relied upon for strong protection.</p>
<ul>
<li>file names very lightly obfuscated</li>
<li>file names can be longer than standard encryption</li>
<li>can use sub paths and copy single files</li>
<li>directory structure visible</li>
<li>identical files names will have identical uploaded names</li>
</ul>
<p>Cloud storage systems have limits on file name length and total path
length which rclone is more likely to breach using “Standard” file name
encryption. Where file names are less than 156 characters in length
issues should not be encountered, irrespective of cloud storage
provider.</p>
<p>An experimental advanced option <code>filename_encoding</code> is now
provided to address this problem to a certain degree. For cloud storage
systems with case sensitive file names (e.g. Google Drive),
<code>base64</code> can be used to reduce file name length. For cloud
storage systems using UTF-16 to store file names internally
(e.g. OneDrive), <code>base32768</code> can be used to drastically
reduce file name length.</p>
<p>An alternative, future rclone file name encryption mode may tolerate
backend provider path length limits.</p>
<h3 id="directory-name-encryption">Directory name encryption</h3>
<p>Crypt offers the option of encrypting dir names or leaving them
intact. There are two options:</p>
<p>True</p>
<p>Encrypts the whole file path including directory names Example:
<code>1/12/123.txt</code> is encrypted to
<code>p0e52nreeaj0a5ea7s64m4j72s/l42g6771hnv3an9cgc8cr2n1ng/qgm4avr35m5loi1th53ato71v0</code></p>
<p>False</p>
<p>Only encrypts file names, skips directory names Example:
<code>1/12/123.txt</code> is encrypted to
<code>1/12/qgm4avr35m5loi1th53ato71v0</code></p>
<h3 id="modified-time-and-hashes-3">Modified time and hashes</h3>
<p>Crypt stores modification times using the underlying remote so
support depends on that.</p>
<p>Hashes are not stored for crypt. However the data integrity is
protected by an extremely strong crypto authenticator.</p>
<p>Use the <code>rclone cryptcheck</code> command to check the integrity
of a crypted remote instead of <code>rclone check</code> which can’t
check the checksums properly.</p>
<h3 id="standard-options-9">Standard options</h3>
<p>Here are the Standard options specific to crypt (Encrypt/Decrypt a
remote).</p>
<h4 id="crypt-remote">–crypt-remote</h4>
<p>Remote to encrypt/decrypt.</p>
<p>Normally should contain a ‘:’ and a path,
e.g. “myremote:path/to/dir”, “myremote:bucket” or maybe “myremote:” (not
recommended).</p>
<p>Properties:</p>
<ul>
<li>Config: remote</li>
<li>Env Var: RCLONE_CRYPT_REMOTE</li>
<li>Type: string</li>
<li>Required: true</li>
</ul>
<h4 id="crypt-filename-encryption">–crypt-filename-encryption</h4>
<p>How to encrypt the filenames.</p>
<p>Properties:</p>
<ul>
<li>Config: filename_encryption</li>
<li>Env Var: RCLONE_CRYPT_FILENAME_ENCRYPTION</li>
<li>Type: string</li>
<li>Default: “standard”</li>
<li>Examples:
<ul>
<li>“standard”
<ul>
<li>Encrypt the filenames.</li>
<li>See the docs for the details.</li>
</ul></li>
<li>“obfuscate”
<ul>
<li>Very simple filename obfuscation.</li>
</ul></li>
<li>“off”
<ul>
<li>Don’t encrypt the file names.</li>
<li>Adds a “.bin” extension only.</li>
</ul></li>
</ul></li>
</ul>
<h4
id="crypt-directory-name-encryption">–crypt-directory-name-encryption</h4>
<p>Option to either encrypt directory names or leave them intact.</p>
<p>NB If filename_encryption is “off” then this option will do
nothing.</p>
<p>Properties:</p>
<ul>
<li>Config: directory_name_encryption</li>
<li>Env Var: RCLONE_CRYPT_DIRECTORY_NAME_ENCRYPTION</li>
<li>Type: bool</li>
<li>Default: true</li>
<li>Examples:
<ul>
<li>“true”
<ul>
<li>Encrypt directory names.</li>
</ul></li>
<li>“false”
<ul>
<li>Don’t encrypt directory names, leave them intact.</li>
</ul></li>
</ul></li>
</ul>
<h4 id="crypt-password">–crypt-password</h4>
<p>Password or pass phrase for encryption.</p>
<p><strong>NB</strong> Input to this must be obscured - see <a
href="https://rclone.org/commands/rclone_obscure/">rclone
obscure</a>.</p>
<p>Properties:</p>
<ul>
<li>Config: password</li>
<li>Env Var: RCLONE_CRYPT_PASSWORD</li>
<li>Type: string</li>
<li>Required: true</li>
</ul>
<h4 id="crypt-password2">–crypt-password2</h4>
<p>Password or pass phrase for salt.</p>
<p>Optional but recommended. Should be different to the previous
password.</p>
<p><strong>NB</strong> Input to this must be obscured - see <a
href="https://rclone.org/commands/rclone_obscure/">rclone
obscure</a>.</p>
<p>Properties:</p>
<ul>
<li>Config: password2</li>
<li>Env Var: RCLONE_CRYPT_PASSWORD2</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h3 id="advanced-options-8">Advanced options</h3>
<p>Here are the Advanced options specific to crypt (Encrypt/Decrypt a
remote).</p>
<h4
id="crypt-server-side-across-configs">–crypt-server-side-across-configs</h4>
<p>Allow server-side operations (e.g. copy) to work across different
crypt configs.</p>
<p>Normally this option is not what you want, but if you have two crypts
pointing to the same backend you can use it.</p>
<p>This can be used, for example, to change file name encryption type
without re-uploading all the data. Just make two crypt backends pointing
to two different directories with the single changed parameter and use
rclone move to move the files between the crypt remotes.</p>
<p>Properties:</p>
<ul>
<li>Config: server_side_across_configs</li>
<li>Env Var: RCLONE_CRYPT_SERVER_SIDE_ACROSS_CONFIGS</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="crypt-show-mapping">–crypt-show-mapping</h4>
<p>For all files listed show how the names encrypt.</p>
<p>If this flag is set then for each file that the remote is asked to
list, it will log (at level INFO) a line stating the decrypted file name
and the encrypted file name.</p>
<p>This is so you can work out which encrypted names are which decrypted
names just in case you need to do something with the encrypted file
names, or for debugging purposes.</p>
<p>Properties:</p>
<ul>
<li>Config: show_mapping</li>
<li>Env Var: RCLONE_CRYPT_SHOW_MAPPING</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="crypt-no-data-encryption">–crypt-no-data-encryption</h4>
<p>Option to either encrypt file data or leave it unencrypted.</p>
<p>Properties:</p>
<ul>
<li>Config: no_data_encryption</li>
<li>Env Var: RCLONE_CRYPT_NO_DATA_ENCRYPTION</li>
<li>Type: bool</li>
<li>Default: false</li>
<li>Examples:
<ul>
<li>“true”
<ul>
<li>Don’t encrypt file data, leave it unencrypted.</li>
</ul></li>
<li>“false”
<ul>
<li>Encrypt file data.</li>
</ul></li>
</ul></li>
</ul>
<h4 id="crypt-filename-encoding">–crypt-filename-encoding</h4>
<p>How to encode the encrypted filename to text string.</p>
<p>This option could help with shortening the encrypted filename. The
suitable option would depend on the way your remote count the filename
length and if it’s case sensitive.</p>
<p>Properties:</p>
<ul>
<li>Config: filename_encoding</li>
<li>Env Var: RCLONE_CRYPT_FILENAME_ENCODING</li>
<li>Type: string</li>
<li>Default: “base32”</li>
<li>Examples:
<ul>
<li>“base32”
<ul>
<li>Encode using base32. Suitable for all remote.</li>
</ul></li>
<li>“base64”
<ul>
<li>Encode using base64. Suitable for case sensitive remote.</li>
</ul></li>
<li>“base32768”
<ul>
<li>Encode using base32768. Suitable if your remote counts UTF-16
or</li>
<li>Unicode codepoint instead of UTF-8 byte length. (Eg. Onedrive)</li>
</ul></li>
</ul></li>
</ul>
<h3 id="metadata-4">Metadata</h3>
<p>Any metadata supported by the underlying remote is read and
written.</p>
<p>See the <a href="https://rclone.org/docs/#metadata">metadata</a> docs
for more info.</p>
<h2 id="backend-commands-2">Backend commands</h2>
<p>Here are the commands specific to the crypt backend.</p>
<p>Run them with</p>
<pre><code>rclone backend COMMAND remote:</code></pre>
<p>The help below will explain what arguments each command takes.</p>
<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>
<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>
<h3 id="encode">encode</h3>
<p>Encode the given filename(s)</p>
<pre><code>rclone backend encode remote: [options] [&lt;arguments&gt;+]</code></pre>
<p>This encodes the filenames given as arguments returning a list of
strings of the encoded results.</p>
<p>Usage Example:</p>
<pre><code>rclone backend encode crypt: file1 [file2...]
rclone rc backend/command command=encode fs=crypt: file1 [file2...]</code></pre>
<h3 id="decode">decode</h3>
<p>Decode the given filename(s)</p>
<pre><code>rclone backend decode remote: [options] [&lt;arguments&gt;+]</code></pre>
<p>This decodes the filenames given as arguments returning a list of
strings of the decoded results. It will return an error if any of the
inputs are invalid.</p>
<p>Usage Example:</p>
<pre><code>rclone backend decode crypt: encryptedfile1 [encryptedfile2...]
rclone rc backend/command command=decode fs=crypt: encryptedfile1 [encryptedfile2...]</code></pre>
<h2 id="backing-up-a-crypted-remote">Backing up a crypted remote</h2>
<p>If you wish to backup a crypted remote, it is recommended that you
use <code>rclone sync</code> on the encrypted files, and make sure the
passwords are the same in the new encrypted remote.</p>
<p>This will have the following advantages</p>
<ul>
<li><code>rclone sync</code> will check the checksums while copying</li>
<li>you can use <code>rclone check</code> between the encrypted
remotes</li>
<li>you don’t decrypt and encrypt unnecessarily</li>
</ul>
<p>For example, let’s say you have your original remote at
<code>remote:</code> with the encrypted version at <code>eremote:</code>
with path <code>remote:crypt</code>. You would then set up the new
remote <code>remote2:</code> and then the encrypted version
<code>eremote2:</code> with path <code>remote2:crypt</code> using the
same passwords as <code>eremote:</code>.</p>
<p>To sync the two remotes you would do</p>
<pre><code>rclone sync -i remote:crypt remote2:crypt</code></pre>
<p>And to check the integrity you would do</p>
<pre><code>rclone check remote:crypt remote2:crypt</code></pre>
<h2 id="file-formats">File formats</h2>
<h3 id="file-encryption">File encryption</h3>
<p>Files are encrypted 1:1 source file to destination object. The file
has a header and is divided into chunks.</p>
<h4 id="header-1">Header</h4>
<ul>
<li>8 bytes magic string <code>RCLONE\x00\x00</code></li>
<li>24 bytes Nonce (IV)</li>
</ul>
<p>The initial nonce is generated from the operating systems crypto
strong random number generator. The nonce is incremented for each chunk
read making sure each nonce is unique for each block written. The chance
of a nonce being re-used is minuscule. If you wrote an exabyte of data
(10¹⁸ bytes) you would have a probability of approximately 2×10⁻³² of
re-using a nonce.</p>
<h4 id="chunk">Chunk</h4>
<p>Each chunk will contain 64 KiB of data, except for the last one which
may have less data. The data chunk is in standard NaCl SecretBox format.
SecretBox uses XSalsa20 and Poly1305 to encrypt and authenticate
messages.</p>
<p>Each chunk contains:</p>
<ul>
<li>16 Bytes of Poly1305 authenticator</li>
<li>1 - 65536 bytes XSalsa20 encrypted data</li>
</ul>
<p>64k chunk size was chosen as the best performing chunk size (the
authenticator takes too much time below this and the performance drops
off due to cache effects above this). Note that these chunks are
buffered in memory so they can’t be too big.</p>
<p>This uses a 32 byte (256 bit key) key derived from the user
password.</p>
<h4 id="examples-1">Examples</h4>
<p>1 byte file will encrypt to</p>
<ul>
<li>32 bytes header</li>
<li>17 bytes data chunk</li>
</ul>
<p>49 bytes total</p>
<p>1 MiB (1048576 bytes) file will encrypt to</p>
<ul>
<li>32 bytes header</li>
<li>16 chunks of 65568 bytes</li>
</ul>
<p>1049120 bytes total (a 0.05% overhead). This is the overhead for big
files.</p>
<h3 id="name-encryption">Name encryption</h3>
<p>File names are encrypted segment by segment - the path is broken up
into <code>/</code> separated strings and these are encrypted
individually.</p>
<p>File segments are padded using PKCS#7 to a multiple of 16 bytes
before encryption.</p>
<p>They are then encrypted with EME using AES with 256 bit key. EME
(ECB-Mix-ECB) is a wide-block encryption mode presented in the 2003
paper “A Parallelizable Enciphering Mode” by Halevi and Rogaway.</p>
<p>This makes for deterministic encryption which is what we want - the
same filename must encrypt to the same thing otherwise we can’t find it
on the cloud storage system.</p>
<p>This means that</p>
<ul>
<li>filenames with the same name will encrypt the same</li>
<li>filenames which start the same won’t have a common prefix</li>
</ul>
<p>This uses a 32 byte key (256 bits) and a 16 byte (128 bits) IV both
of which are derived from the user password.</p>
<p>After encryption they are written out using a modified version of
standard <code>base32</code> encoding as described in RFC4648. The
standard encoding is modified in two ways:</p>
<ul>
<li>it becomes lower case (no-one likes upper case filenames!)</li>
<li>we strip the padding character <code>=</code></li>
</ul>
<p><code>base32</code> is used rather than the more efficient
<code>base64</code> so rclone can be used on case insensitive remotes
(e.g. Windows, Amazon Drive).</p>
<h3 id="key-derivation">Key derivation</h3>
<p>Rclone uses <code>scrypt</code> with parameters
<code>N=16384, r=8, p=1</code> with an optional user supplied salt
(password2) to derive the 32+32+16 = 80 bytes of key material required.
If the user doesn’t supply a salt then rclone uses an internal one.</p>
<p><code>scrypt</code> makes it impractical to mount a dictionary attack
on rclone encrypted data. For full protection against this you should
always use a salt.</p>
<h2 id="see-also-85">SEE ALSO</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone_cryptdecode/">rclone
cryptdecode</a> - Show forward/reverse mapping of encrypted
filenames</li>
</ul>
<h1 id="compress-experimental">Compress (Experimental)</h1>
<h2 id="warning">Warning</h2>
<p>This remote is currently <strong>experimental</strong>. Things may
break and data may be lost. Anything you do with this remote is at your
own risk. Please understand the risks associated with using experimental
code and don’t use this remote in critical applications.</p>
<p>The <code>Compress</code> remote adds compression to another remote.
It is best used with remotes containing many large compressible
files.</p>
<h2 id="configuration-10">Configuration</h2>
<p>To use this remote, all you need to do is specify another remote and
a compression mode to use:</p>
<pre><code>Current remotes:

Name                 Type
====                 ====
remote_to_press      sometype

e) Edit existing remote
$ rclone config
n) New remote
d) Delete remote
r) Rename remote
c) Copy remote
s) Set configuration password
q) Quit config
e/n/d/r/c/s/q&gt; n
name&gt; compress
...
 8 / Compress a remote
   \ &quot;compress&quot;
...
Storage&gt; compress
** See help for compress backend at: https://rclone.org/compress/ **

Remote to compress.
Enter a string value. Press Enter for the default (&quot;&quot;).
remote&gt; remote_to_press:subdir 
Compression mode.
Enter a string value. Press Enter for the default (&quot;gzip&quot;).
Choose a number from below, or type in your own value
 1 / Gzip compression balanced for speed and compression strength.
   \ &quot;gzip&quot;
compression_mode&gt; gzip
Edit advanced config? (y/n)
y) Yes
n) No (default)
y/n&gt; 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&gt; y</code></pre>
<h3 id="compression-modes">Compression Modes</h3>
<p>Currently only gzip compression is supported. It provides a decent
balance between speed and size and is well supported by other
applications. Compression strength can further be configured via an
advanced setting where 0 is no compression and 9 is strongest
compression.</p>
<h3 id="file-types">File types</h3>
<p>If you open a remote wrapped by compress, you will see that there are
many files with an extension corresponding to the compression algorithm
you chose. These files are standard files that can be opened by various
archive programs, but they have some hidden metadata that allows them to
be used by rclone. While you may download and decompress these files at
will, do <strong>not</strong> manually delete or rename files. Files
without correct metadata files will not be recognized by rclone.</p>
<h3 id="file-names">File names</h3>
<p>The compressed files will be named <code>*.###########.gz</code>
where <code>*</code> is the base file and the <code>#</code> part is
base64 encoded size of the uncompressed file. The file names should not
be changed by anything other than the rclone compression backend.</p>
<h3 id="standard-options-10">Standard options</h3>
<p>Here are the Standard options specific to compress (Compress a
remote).</p>
<h4 id="compress-remote">–compress-remote</h4>
<p>Remote to compress.</p>
<p>Properties:</p>
<ul>
<li>Config: remote</li>
<li>Env Var: RCLONE_COMPRESS_REMOTE</li>
<li>Type: string</li>
<li>Required: true</li>
</ul>
<h4 id="compress-mode">–compress-mode</h4>
<p>Compression mode.</p>
<p>Properties:</p>
<ul>
<li>Config: mode</li>
<li>Env Var: RCLONE_COMPRESS_MODE</li>
<li>Type: string</li>
<li>Default: “gzip”</li>
<li>Examples:
<ul>
<li>“gzip”
<ul>
<li>Standard gzip compression with fastest parameters.</li>
</ul></li>
</ul></li>
</ul>
<h3 id="advanced-options-9">Advanced options</h3>
<p>Here are the Advanced options specific to compress (Compress a
remote).</p>
<h4 id="compress-level">–compress-level</h4>
<p>GZIP compression level (-2 to 9).</p>
<p>Generally -1 (default, equivalent to 5) is recommended. Levels 1 to 9
increase compression at the cost of speed. Going past 6 generally offers
very little return.</p>
<p>Level -2 uses Huffman encoding only. Only use if you know what you
are doing. Level 0 turns off compression.</p>
<p>Properties:</p>
<ul>
<li>Config: level</li>
<li>Env Var: RCLONE_COMPRESS_LEVEL</li>
<li>Type: int</li>
<li>Default: -1</li>
</ul>
<h4 id="compress-ram-cache-limit">–compress-ram-cache-limit</h4>
<p>Some remotes don’t allow the upload of files with unknown size. In
this case the compressed file will need to be cached to determine it’s
size.</p>
<p>Files smaller than this limit will be cached in RAM, files larger
than this limit will be cached on disk.</p>
<p>Properties:</p>
<ul>
<li>Config: ram_cache_limit</li>
<li>Env Var: RCLONE_COMPRESS_RAM_CACHE_LIMIT</li>
<li>Type: SizeSuffix</li>
<li>Default: 20Mi</li>
</ul>
<h3 id="metadata-5">Metadata</h3>
<p>Any metadata supported by the underlying remote is read and
written.</p>
<p>See the <a href="https://rclone.org/docs/#metadata">metadata</a> docs
for more info.</p>
<h1 id="combine">Combine</h1>
<p>The <code>combine</code> backend joins remotes together into a single
directory tree.</p>
<p>For example you might have a remote for images on one provider:</p>
<pre><code>$ rclone tree s3:imagesbucket
/
├── image1.jpg
└── image2.jpg</code></pre>
<p>And a remote for files on another:</p>
<pre><code>$ rclone tree drive:important/files
/
├── file1.txt
└── file2.txt</code></pre>
<p>The <code>combine</code> backend can join these together into a
synthetic directory structure like this:</p>
<pre><code>$ rclone tree combined:
/
├── files
│   ├── file1.txt
│   └── file2.txt
└── images
    ├── image1.jpg
    └── image2.jpg</code></pre>
<p>You’d do this by specifying an <code>upstreams</code> parameter in
the config like this</p>
<pre><code>upstreams = images=s3:imagesbucket files=drive:important/files</code></pre>
<p>During the initial setup with <code>rclone config</code> you will
specify the upstreams remotes as a space separated list. The upstream
remotes can either be a local paths or other remotes.</p>
<h2 id="configuration-11">Configuration</h2>
<p>Here is an example of how to make a combine called
<code>remote</code> for the example above. First run:</p>
<pre><code> rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<pre><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; 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&gt; 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
    &quot;dir=remote:path with space&quot; &quot;dir2=remote2:path with space&quot;
Enter a fs.SpaceSepList value.
upstreams&gt; 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&gt; y</code></pre>
<h3 id="configuring-for-google-drive-shared-drives">Configuring for
Google Drive Shared Drives</h3>
<p>Rclone has a convenience feature for making a combine backend for all
the shared drives you have access to.</p>
<p>Assuming your main (non shared drive) Google drive remote is called
<code>drive:</code> you would run</p>
<pre><code>rclone backend -o config drives drive:</code></pre>
<p>This would produce something like this:</p>
<pre><code>[My Drive]
type = alias
remote = drive,team_drive=0ABCDEF-01234567890,root_folder_id=:

[Test Drive]
type = alias
remote = drive,team_drive=0ABCDEFabcdefghijkl,root_folder_id=:

[AllDrives]
type = combine
upstreams = &quot;My Drive=My Drive:&quot; &quot;Test Drive=Test Drive:&quot;</code></pre>
<p>If you then add that config to your config file (find it with
<code>rclone config file</code>) then you can access all the shared
drives in one place with the <code>AllDrives:</code> remote.</p>
<p>See <a href="https://rclone.org/drive/#drives">the Google Drive
docs</a> for full info.</p>
<h3 id="standard-options-11">Standard options</h3>
<p>Here are the Standard options specific to combine (Combine several
remotes into one).</p>
<h4 id="combine-upstreams">–combine-upstreams</h4>
<p>Upstreams for combining</p>
<p>These should be in the form</p>
<pre><code>dir=remote:path dir2=remote2:path</code></pre>
<p>Where before the = is specified the root directory and after is the
remote to put there.</p>
<p>Embedded spaces can be added using quotes</p>
<pre><code>&quot;dir=remote:path with space&quot; &quot;dir2=remote2:path with space&quot;</code></pre>
<p>Properties:</p>
<ul>
<li>Config: upstreams</li>
<li>Env Var: RCLONE_COMBINE_UPSTREAMS</li>
<li>Type: SpaceSepList</li>
<li>Default:</li>
</ul>
<h3 id="metadata-6">Metadata</h3>
<p>Any metadata supported by the underlying remote is read and
written.</p>
<p>See the <a href="https://rclone.org/docs/#metadata">metadata</a> docs
for more info.</p>
<h1 id="dropbox">Dropbox</h1>
<p>Paths are specified as <code>remote:path</code></p>
<p>Dropbox paths may be as deep as required, e.g.
<code>remote:directory/subdirectory</code>.</p>
<h2 id="configuration-12">Configuration</h2>
<p>The initial setup for dropbox involves getting a token from Dropbox
which you need to do in your browser. <code>rclone config</code> walks
you through it.</p>
<p>Here is an example of how to make a remote called
<code>remote</code>. First run:</p>
<pre><code> rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<pre><code>n) New remote
d) Delete remote
q) Quit config
e/n/d/q&gt; n
name&gt; remote
Type of storage to configure.
Choose a number from below, or type in your own value
[snip]
XX / Dropbox
   \ &quot;dropbox&quot;
[snip]
Storage&gt; dropbox
Dropbox App Key - leave blank normally.
app_key&gt;
Dropbox App Secret - leave blank normally.
app_secret&gt;
Remote config
Please visit:
https://www.dropbox.com/1/oauth2/authorize?client_id=XXXXXXXXXXXXXXX&amp;response_type=code
Enter the code: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX_XXXXXXXXXX
--------------------
[remote]
app_key =
app_secret =
token = XXXXXXXXXXXXXXXXXXXXXXXXXXXXX_XXXX_XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
--------------------
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<p>You can then use it like this,</p>
<p>List directories in top level of your dropbox</p>
<pre><code>rclone lsd remote:</code></pre>
<p>List all the files in your dropbox</p>
<pre><code>rclone ls remote:</code></pre>
<p>To copy a local directory to a dropbox directory called backup</p>
<pre><code>rclone copy /home/source remote:backup</code></pre>
<h3 id="dropbox-for-business">Dropbox for business</h3>
<p>Rclone supports Dropbox for business and Team Folders.</p>
<p>When using Dropbox for business <code>remote:</code> and
<code>remote:path/to/file</code> will refer to your personal folder.</p>
<p>If you wish to see Team Folders you must use a leading <code>/</code>
in the path, so <code>rclone lsd remote:/</code> will refer to the root
and show you all Team Folders and your User Folder.</p>
<p>You can then use team folders like this
<code>remote:/TeamFolder</code> and
<code>remote:/TeamFolder/path/to/file</code>.</p>
<p>A leading <code>/</code> for a Dropbox personal account will do
nothing, but it will take an extra HTTP transaction so it should be
avoided.</p>
<h3 id="modified-time-and-hashes-4">Modified time and Hashes</h3>
<p>Dropbox supports modified times, but the only way to set a
modification time is to re-upload the file.</p>
<p>This means that if you uploaded your data with an older version of
rclone which didn’t support the v2 API and modified times, rclone will
decide to upload all your old data to fix the modification times. If you
don’t want this to happen use <code>--size-only</code> or
<code>--checksum</code> flag to stop it.</p>
<p>Dropbox supports <a
href="https://www.dropbox.com/developers/reference/content-hash">its own
hash type</a> which is checked for all transfers.</p>
<h3 id="restricted-filename-characters-6">Restricted filename
characters</h3>
<table>
<thead>
<tr class="header">
<th>Character</th>
<th style="text-align: center;">Value</th>
<th style="text-align: center;">Replacement</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>NUL</td>
<td style="text-align: center;">0x00</td>
<td style="text-align: center;">␀</td>
</tr>
<tr class="even">
<td>/</td>
<td style="text-align: center;">0x2F</td>
<td style="text-align: center;">／</td>
</tr>
<tr class="odd">
<td>DEL</td>
<td style="text-align: center;">0x7F</td>
<td style="text-align: center;">␡</td>
</tr>
<tr class="even">
<td>\</td>
<td style="text-align: center;">0x5C</td>
<td style="text-align: center;">＼</td>
</tr>
</tbody>
</table>
<p>File names can also not end with the following characters. These only
get replaced if they are the last character in the name:</p>
<table>
<thead>
<tr class="header">
<th>Character</th>
<th style="text-align: center;">Value</th>
<th style="text-align: center;">Replacement</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>SP</td>
<td style="text-align: center;">0x20</td>
<td style="text-align: center;">␠</td>
</tr>
</tbody>
</table>
<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>
<h3 id="batch-mode">Batch mode uploads</h3>
<p>Using batch mode uploads is very important for performance when using
the Dropbox API. See <a
href="https://developers.dropbox.com/dbx-performance-guide">the dropbox
performance guide</a> for more info.</p>
<p>There are 3 modes rclone can use for uploads.</p>
<h4 id="dropbox-batch-mode-off">–dropbox-batch-mode off</h4>
<p>In this mode rclone will not use upload batching. This was the
default before rclone v1.55. It has the disadvantage that it is very
likely to encounter <code>too_many_requests</code> errors like this</p>
<pre><code>NOTICE: too_many_requests/.: Too many requests or write operations. Trying again in 15 seconds.</code></pre>
<p>When rclone receives these it has to wait for 15s or sometimes 300s
before continuing which really slows down transfers.</p>
<p>This will happen especially if <code>--transfers</code> is large, so
this mode isn’t recommended except for compatibility or investigating
problems.</p>
<h4 id="dropbox-batch-mode-sync">–dropbox-batch-mode sync</h4>
<p>In this mode rclone will batch up uploads to the size specified by
<code>--dropbox-batch-size</code> and commit them together.</p>
<p>Using this mode means you can use a much higher
<code>--transfers</code> parameter (32 or 64 works fine) without
receiving <code>too_many_requests</code> errors.</p>
<p>This mode ensures full data integrity.</p>
<p>Note that there may be a pause when quitting rclone while rclone
finishes up the last batch using this mode.</p>
<h4 id="dropbox-batch-mode-async">–dropbox-batch-mode async</h4>
<p>In this mode rclone will batch up uploads to the size specified by
<code>--dropbox-batch-size</code> and commit them together.</p>
<p>However it will not wait for the status of the batch to be returned
to the caller. This means rclone can use a much bigger batch size (much
bigger than <code>--transfers</code>), at the cost of not being able to
check the status of the upload.</p>
<p>This provides the maximum possible upload speed especially with lots
of small files, however rclone can’t check the file got uploaded
properly using this mode.</p>
<p>If you are using this mode then using “rclone check” after the
transfer completes is recommended. Or you could do an initial transfer
with <code>--dropbox-batch-mode async</code> then do a final transfer
with <code>--dropbox-batch-mode sync</code> (the default).</p>
<p>Note that there may be a pause when quitting rclone while rclone
finishes up the last batch using this mode.</p>
<h3 id="standard-options-12">Standard options</h3>
<p>Here are the Standard options specific to dropbox (Dropbox).</p>
<h4 id="dropbox-client-id">–dropbox-client-id</h4>
<p>OAuth Client Id.</p>
<p>Leave blank normally.</p>
<p>Properties:</p>
<ul>
<li>Config: client_id</li>
<li>Env Var: RCLONE_DROPBOX_CLIENT_ID</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="dropbox-client-secret">–dropbox-client-secret</h4>
<p>OAuth Client Secret.</p>
<p>Leave blank normally.</p>
<p>Properties:</p>
<ul>
<li>Config: client_secret</li>
<li>Env Var: RCLONE_DROPBOX_CLIENT_SECRET</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h3 id="advanced-options-10">Advanced options</h3>
<p>Here are the Advanced options specific to dropbox (Dropbox).</p>
<h4 id="dropbox-token">–dropbox-token</h4>
<p>OAuth Access Token as a JSON blob.</p>
<p>Properties:</p>
<ul>
<li>Config: token</li>
<li>Env Var: RCLONE_DROPBOX_TOKEN</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="dropbox-auth-url">–dropbox-auth-url</h4>
<p>Auth server URL.</p>
<p>Leave blank to use the provider defaults.</p>
<p>Properties:</p>
<ul>
<li>Config: auth_url</li>
<li>Env Var: RCLONE_DROPBOX_AUTH_URL</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="dropbox-token-url">–dropbox-token-url</h4>
<p>Token server url.</p>
<p>Leave blank to use the provider defaults.</p>
<p>Properties:</p>
<ul>
<li>Config: token_url</li>
<li>Env Var: RCLONE_DROPBOX_TOKEN_URL</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="dropbox-chunk-size">–dropbox-chunk-size</h4>
<p>Upload chunk size (&lt; 150Mi).</p>
<p>Any files larger than this will be uploaded in chunks of this
size.</p>
<p>Note that chunks are buffered in memory (one at a time) so rclone can
deal with retries. Setting this larger will increase the speed slightly
(at most 10% for 128 MiB in tests) at the cost of using more memory. It
can be set smaller if you are tight on memory.</p>
<p>Properties:</p>
<ul>
<li>Config: chunk_size</li>
<li>Env Var: RCLONE_DROPBOX_CHUNK_SIZE</li>
<li>Type: SizeSuffix</li>
<li>Default: 48Mi</li>
</ul>
<h4 id="dropbox-impersonate">–dropbox-impersonate</h4>
<p>Impersonate this user when using a business account.</p>
<p>Note that if you want to use impersonate, you should make sure this
flag is set when running “rclone config” as this will cause rclone to
request the “members.read” scope which it won’t normally. This is needed
to lookup a members email address into the internal ID that dropbox uses
in the API.</p>
<p>Using the “members.read” scope will require a Dropbox Team Admin to
approve during the OAuth flow.</p>
<p>You will have to use your own App (setting your own client_id and
client_secret) to use this option as currently rclone’s default set of
permissions doesn’t include “members.read”. This can be added once v1.55
or later is in use everywhere.</p>
<p>Properties:</p>
<ul>
<li>Config: impersonate</li>
<li>Env Var: RCLONE_DROPBOX_IMPERSONATE</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="dropbox-shared-files">–dropbox-shared-files</h4>
<p>Instructs rclone to work on individual shared files.</p>
<p>In this mode rclone’s features are extremely limited - only list (ls,
lsl, etc.) operations and read operations (e.g. downloading) are
supported in this mode. All other operations will be disabled.</p>
<p>Properties:</p>
<ul>
<li>Config: shared_files</li>
<li>Env Var: RCLONE_DROPBOX_SHARED_FILES</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="dropbox-shared-folders">–dropbox-shared-folders</h4>
<p>Instructs rclone to work on shared folders.</p>
<p>When this flag is used with no path only the List operation is
supported and all available shared folders will be listed. If you
specify a path the first part will be interpreted as the name of shared
folder. Rclone will then try to mount this shared to the root namespace.
On success shared folder rclone proceeds normally. The shared folder is
now pretty much a normal folder and all normal operations are
supported.</p>
<p>Note that we don’t unmount the shared folder afterwards so the
–dropbox-shared-folders can be omitted after the first use of a
particular shared folder.</p>
<p>Properties:</p>
<ul>
<li>Config: shared_folders</li>
<li>Env Var: RCLONE_DROPBOX_SHARED_FOLDERS</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="dropbox-batch-mode">–dropbox-batch-mode</h4>
<p>Upload file batching sync|async|off.</p>
<p>This sets the batch mode used by rclone.</p>
<p>For full info see <a
href="https://rclone.org/dropbox/#batch-mode">the main docs</a></p>
<p>This has 3 possible values</p>
<ul>
<li>off - no batching</li>
<li>sync - batch uploads and check completion (default)</li>
<li>async - batch upload and don’t check completion</li>
</ul>
<p>Rclone will close any outstanding batches when it exits which may
make a delay on quit.</p>
<p>Properties:</p>
<ul>
<li>Config: batch_mode</li>
<li>Env Var: RCLONE_DROPBOX_BATCH_MODE</li>
<li>Type: string</li>
<li>Default: “sync”</li>
</ul>
<h4 id="dropbox-batch-size">–dropbox-batch-size</h4>
<p>Max number of files in upload batch.</p>
<p>This sets the batch size of files to upload. It has to be less than
1000.</p>
<p>By default this is 0 which means rclone which calculate the batch
size depending on the setting of batch_mode.</p>
<ul>
<li>batch_mode: async - default batch_size is 100</li>
<li>batch_mode: sync - default batch_size is the same as –transfers</li>
<li>batch_mode: off - not in use</li>
</ul>
<p>Rclone will close any outstanding batches when it exits which may
make a delay on quit.</p>
<p>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.</p>
<p>Properties:</p>
<ul>
<li>Config: batch_size</li>
<li>Env Var: RCLONE_DROPBOX_BATCH_SIZE</li>
<li>Type: int</li>
<li>Default: 0</li>
</ul>
<h4 id="dropbox-batch-timeout">–dropbox-batch-timeout</h4>
<p>Max time to allow an idle upload batch before uploading.</p>
<p>If an upload batch is idle for more than this long then it will be
uploaded.</p>
<p>The default for this is 0 which means rclone will choose a sensible
default based on the batch_mode in use.</p>
<ul>
<li>batch_mode: async - default batch_timeout is 500ms</li>
<li>batch_mode: sync - default batch_timeout is 10s</li>
<li>batch_mode: off - not in use</li>
</ul>
<p>Properties:</p>
<ul>
<li>Config: batch_timeout</li>
<li>Env Var: RCLONE_DROPBOX_BATCH_TIMEOUT</li>
<li>Type: Duration</li>
<li>Default: 0s</li>
</ul>
<h4 id="dropbox-batch-commit-timeout">–dropbox-batch-commit-timeout</h4>
<p>Max time to wait for a batch to finish committing</p>
<p>Properties:</p>
<ul>
<li>Config: batch_commit_timeout</li>
<li>Env Var: RCLONE_DROPBOX_BATCH_COMMIT_TIMEOUT</li>
<li>Type: Duration</li>
<li>Default: 10m0s</li>
</ul>
<h4 id="dropbox-encoding">–dropbox-encoding</h4>
<p>The encoding for the backend.</p>
<p>See the <a href="https://rclone.org/overview/#encoding">encoding
section in the overview</a> for more info.</p>
<p>Properties:</p>
<ul>
<li>Config: encoding</li>
<li>Env Var: RCLONE_DROPBOX_ENCODING</li>
<li>Type: MultiEncoder</li>
<li>Default: Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot</li>
</ul>
<h2 id="limitations-9">Limitations</h2>
<p>Note that Dropbox is case insensitive so you can’t have a file called
“Hello.doc” and one called “hello.doc”.</p>
<p>There are some file names such as <code>thumbs.db</code> which
Dropbox can’t store. There is a full list of them in the <a
href="https://www.dropbox.com/en/help/145">“Ignored Files” section of
this document</a>. Rclone will issue an error message
<code>File name disallowed - not uploading</code> if it attempts to
upload one of those file names, but the sync won’t fail.</p>
<p>Some errors may occur if you try to sync copyright-protected files
because Dropbox has its own <a
href="https://techcrunch.com/2014/03/30/how-dropbox-knows-when-youre-sharing-copyrighted-stuff-without-actually-looking-at-your-stuff/">copyright
detector</a> that prevents this sort of file being downloaded. This will
return the error
<code>ERROR : /path/to/your/file: Failed to copy: failed to open source object: path/restricted_content/.</code></p>
<p>If you have more than 10,000 files in a directory then
<code>rclone purge dropbox:dir</code> will return the error
<code>Failed to purge: There are too many files involved in this operation</code>.
As a work-around do an <code>rclone delete dropbox:dir</code> followed
by an <code>rclone rmdir dropbox:dir</code>.</p>
<p>When using <code>rclone link</code> you’ll need to set
<code>--expire</code> if using a non-personal account otherwise the
visibility may not be correct. (Note that <code>--expire</code> isn’t
supported on personal accounts). See the <a
href="https://forum.rclone.org/t/rclone-link-dropbox-permissions/23211">forum
discussion</a> and the <a
href="https://github.com/dropbox/dropbox-sdk-go-unofficial/issues/75">dropbox
SDK issue</a>.</p>
<h2 id="get-your-own-dropbox-app-id">Get your own Dropbox App ID</h2>
<p>When you use rclone with Dropbox in its default configuration you are
using rclone’s App ID. This is shared between all the rclone users.</p>
<p>Here is how to create your own Dropbox App ID for rclone:</p>
<ol type="1">
<li><p>Log into the <a
href="https://www.dropbox.com/developers/apps/create">Dropbox App
console</a> with your Dropbox Account (It need not to be the same
account as the Dropbox you want to access)</p></li>
<li><p>Choose an API =&gt; Usually this should be
<code>Dropbox API</code></p></li>
<li><p>Choose the type of access you want to use =&gt;
<code>Full Dropbox</code> or <code>App Folder</code></p></li>
<li><p>Name your App. The app name is global, so you can’t use
<code>rclone</code> for example</p></li>
<li><p>Click the button <code>Create App</code></p></li>
<li><p>Switch to the <code>Permissions</code> tab. Enable at least the
following permissions: <code>account_info.read</code>,
<code>files.metadata.write</code>, <code>files.content.write</code>,
<code>files.content.read</code>, <code>sharing.write</code>. The
<code>files.metadata.read</code> and <code>sharing.read</code>
checkboxes will be marked too. Click <code>Submit</code></p></li>
<li><p>Switch to the <code>Settings</code> tab. Fill
<code>OAuth2 - Redirect URIs</code> as
<code>http://localhost:53682/</code></p></li>
<li><p>Find the <code>App key</code> and <code>App secret</code> values
on the <code>Settings</code> tab. Use these values in rclone config to
add a new remote or edit an existing remote. The <code>App key</code>
setting corresponds to <code>client_id</code> in rclone config, the
<code>App secret</code> corresponds to
<code>client_secret</code></p></li>
</ol>
<h1 id="enterprise-file-fabric">Enterprise File Fabric</h1>
<p>This backend supports <a
href="https://storagemadeeasy.com/about/">Storage Made Easy’s Enterprise
File Fabric™</a> which provides a software solution to integrate and
unify File and Object Storage accessible through a global file
system.</p>
<h2 id="configuration-13">Configuration</h2>
<p>The initial setup for the Enterprise File Fabric backend involves
getting a token from the Enterprise File Fabric which you need to do in
your browser. <code>rclone config</code> walks you through it.</p>
<p>Here is an example of how to make a remote called
<code>remote</code>. First run:</p>
<pre><code> rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<pre><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; remote
Type of storage to configure.
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
[snip]
XX / Enterprise File Fabric
   \ &quot;filefabric&quot;
[snip]
Storage&gt; filefabric
** See help for filefabric backend at: https://rclone.org/filefabric/ **

URL of the Enterprise File Fabric to connect to
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
 1 / Storage Made Easy US
   \ &quot;https://storagemadeeasy.com&quot;
 2 / Storage Made Easy EU
   \ &quot;https://eu.storagemadeeasy.com&quot;
 3 / Connect to your Enterprise File Fabric
   \ &quot;https://yourfabric.smestorage.com&quot;
url&gt; https://yourfabric.smestorage.com/
ID of the root folder
Leave blank normally.

Fill in to make rclone start with directory of a given ID.

Enter a string value. Press Enter for the default (&quot;&quot;).
root_folder_id&gt; 
Permanent Authentication Token

A Permanent Authentication Token can be created in the Enterprise File
Fabric, on the users Dashboard under Security, there is an entry
you&#39;ll see called &quot;My Authentication Tokens&quot;. Click the Manage button
to create one.

These tokens are normally valid for several years.

For more info see: https://docs.storagemadeeasy.com/organisationcloud/api-tokens

Enter a string value. Press Enter for the default (&quot;&quot;).
permanent_token&gt; xxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx
Edit advanced config? (y/n)
y) Yes
n) No (default)
y/n&gt; 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&gt; y</code></pre>
<p>Once configured you can then use <code>rclone</code> like this,</p>
<p>List directories in top level of your Enterprise File Fabric</p>
<pre><code>rclone lsd remote:</code></pre>
<p>List all the files in your Enterprise File Fabric</p>
<pre><code>rclone ls remote:</code></pre>
<p>To copy a local directory to an Enterprise File Fabric directory
called backup</p>
<pre><code>rclone copy /home/source remote:backup</code></pre>
<h3 id="modified-time-and-hashes-5">Modified time and hashes</h3>
<p>The Enterprise File Fabric allows modification times to be set on
files accurate to 1 second. These will be used to detect whether objects
need syncing or not.</p>
<p>The Enterprise File Fabric does not support any data hashes at this
time.</p>
<h3 id="restricted-filename-characters-7">Restricted filename
characters</h3>
<p>The <a
href="https://rclone.org/overview/#restricted-characters">default
restricted characters set</a> will be replaced.</p>
<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>
<h3 id="empty-files">Empty files</h3>
<p>Empty files aren’t supported by the Enterprise File Fabric. Rclone
will therefore upload an empty file as a single space with a mime type
of <code>application/vnd.rclone.empty.file</code> and files with that
mime type are treated as empty.</p>
<h3 id="root-folder-id-1">Root folder ID</h3>
<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 Enterprise File Fabric.</p>
<p>Normally you will leave this blank and rclone will determine the
correct root to use itself.</p>
<p>However you can set this to restrict rclone to a specific folder
hierarchy.</p>
<p>In order to do this you will have to find the <code>Folder ID</code>
of the directory you wish rclone to display. These aren’t displayed in
the web interface, but you can use <code>rclone lsf</code> to find them,
for example</p>
<pre><code>$ 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/</code></pre>
<p>The ID for “S3 Storage” would be <code>120673761</code>.</p>
<h3 id="standard-options-13">Standard options</h3>
<p>Here are the Standard options specific to filefabric (Enterprise File
Fabric).</p>
<h4 id="filefabric-url">–filefabric-url</h4>
<p>URL of the Enterprise File Fabric to connect to.</p>
<p>Properties:</p>
<ul>
<li>Config: url</li>
<li>Env Var: RCLONE_FILEFABRIC_URL</li>
<li>Type: string</li>
<li>Required: true</li>
<li>Examples:
<ul>
<li>“https://storagemadeeasy.com”
<ul>
<li>Storage Made Easy US</li>
</ul></li>
<li>“https://eu.storagemadeeasy.com”
<ul>
<li>Storage Made Easy EU</li>
</ul></li>
<li>“https://yourfabric.smestorage.com”
<ul>
<li>Connect to your Enterprise File Fabric</li>
</ul></li>
</ul></li>
</ul>
<h4 id="filefabric-root-folder-id">–filefabric-root-folder-id</h4>
<p>ID of the root folder.</p>
<p>Leave blank normally.</p>
<p>Fill in to make rclone start with directory of a given ID.</p>
<p>Properties:</p>
<ul>
<li>Config: root_folder_id</li>
<li>Env Var: RCLONE_FILEFABRIC_ROOT_FOLDER_ID</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="filefabric-permanent-token">–filefabric-permanent-token</h4>
<p>Permanent Authentication Token.</p>
<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>
<p>These tokens are normally valid for several years.</p>
<p>For more info see:
https://docs.storagemadeeasy.com/organisationcloud/api-tokens</p>
<p>Properties:</p>
<ul>
<li>Config: permanent_token</li>
<li>Env Var: RCLONE_FILEFABRIC_PERMANENT_TOKEN</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h3 id="advanced-options-11">Advanced options</h3>
<p>Here are the Advanced options specific to filefabric (Enterprise File
Fabric).</p>
<h4 id="filefabric-token">–filefabric-token</h4>
<p>Session Token.</p>
<p>This is a session token which rclone caches in the config file. It is
usually valid for 1 hour.</p>
<p>Don’t set this value - rclone will set it automatically.</p>
<p>Properties:</p>
<ul>
<li>Config: token</li>
<li>Env Var: RCLONE_FILEFABRIC_TOKEN</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="filefabric-token-expiry">–filefabric-token-expiry</h4>
<p>Token expiry time.</p>
<p>Don’t set this value - rclone will set it automatically.</p>
<p>Properties:</p>
<ul>
<li>Config: token_expiry</li>
<li>Env Var: RCLONE_FILEFABRIC_TOKEN_EXPIRY</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="filefabric-version">–filefabric-version</h4>
<p>Version read from the file fabric.</p>
<p>Don’t set this value - rclone will set it automatically.</p>
<p>Properties:</p>
<ul>
<li>Config: version</li>
<li>Env Var: RCLONE_FILEFABRIC_VERSION</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="filefabric-encoding">–filefabric-encoding</h4>
<p>The encoding for the backend.</p>
<p>See the <a href="https://rclone.org/overview/#encoding">encoding
section in the overview</a> for more info.</p>
<p>Properties:</p>
<ul>
<li>Config: encoding</li>
<li>Env Var: RCLONE_FILEFABRIC_ENCODING</li>
<li>Type: MultiEncoder</li>
<li>Default: Slash,Del,Ctl,InvalidUtf8,Dot</li>
</ul>
<h1 id="ftp">FTP</h1>
<p>FTP is the File Transfer Protocol. Rclone FTP support is provided
using the <a
href="https://godoc.org/github.com/jlaffaye/ftp">github.com/jlaffaye/ftp</a>
package.</p>
<p><a href="#limitations">Limitations of Rclone’s FTP backend</a></p>
<p>Paths are specified as <code>remote:path</code>. If the path does not
begin with a <code>/</code> it is relative to the home directory of the
user. An empty path <code>remote:</code> refers to the user’s home
directory.</p>
<h2 id="configuration-14">Configuration</h2>
<p>To create an FTP configuration named <code>remote</code>, run</p>
<pre><code>rclone config</code></pre>
<p>Rclone config guides you through an interactive setup process. A
minimal rclone FTP remote definition only requires host, username and
password. For an anonymous FTP server, see <a
href="#anonymous-ftp">below</a>.</p>
<pre><code>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&gt; n
name&gt; remote
Type of storage to configure.
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
[snip]
XX / FTP
   \ &quot;ftp&quot;
[snip]
Storage&gt; ftp
** See help for ftp backend at: https://rclone.org/ftp/ **

FTP host to connect to
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
 1 / Connect to ftp.example.com
   \ &quot;ftp.example.com&quot;
host&gt; ftp.example.com
FTP username
Enter a string value. Press Enter for the default (&quot;$USER&quot;).
user&gt; 
FTP port number
Enter a signed integer. Press Enter for the default (21).
port&gt; 
FTP password
y) Yes type in my own password
g) Generate random password
y/g&gt; 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 (&quot;false&quot;).
tls&gt; 
Use FTP over TLS (Explicit)
Enter a boolean value (true or false). Press Enter for the default (&quot;false&quot;).
explicit_tls&gt; 
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&gt; y</code></pre>
<p>To see all directories in the home directory of
<code>remote</code></p>
<pre><code>rclone lsd remote:</code></pre>
<p>Make a new directory</p>
<pre><code>rclone mkdir remote:path/to/directory</code></pre>
<p>List the contents of a directory</p>
<pre><code>rclone ls remote:path/to/directory</code></pre>
<p>Sync <code>/home/local/directory</code> to the remote directory,
deleting any excess files in the directory.</p>
<pre><code>rclone sync -i /home/local/directory remote:directory</code></pre>
<h3 id="anonymous-ftp">Anonymous FTP</h3>
<p>When connecting to a FTP server that allows anonymous login, you can
use the special “anonymous” username. Traditionally, this user account
accepts any string as a password, although it is common to use either
the password “anonymous” or “guest”. Some servers require the use of a
valid e-mail address as password.</p>
<p>Using <a href="#backend-path-to-dir">on-the-fly</a> or <a
href="https://rclone.org/docs/#connection-strings">connection string</a>
remotes makes it easy to access such servers, without requiring any
configuration in advance. The following are examples of that:</p>
<pre><code>rclone lsf :ftp: --ftp-host=speedtest.tele2.net --ftp-user=anonymous --ftp-pass=$(rclone obscure dummy)
rclone lsf :ftp,host=speedtest.tele2.net,user=anonymous,pass=$(rclone obscure dummy):</code></pre>
<p>The above examples work in Linux shells and in PowerShell, but not
Windows Command Prompt. They execute the <a
href="https://rclone.org/commands/rclone_obscure/">rclone obscure</a>
command to create a password string in the format required by the <a
href="#ftp-pass">pass</a> option. The following examples are exactly the
same, except use an already obscured string representation of the same
password “dummy”, and therefore works even in Windows Command
Prompt:</p>
<pre><code>rclone lsf :ftp: --ftp-host=speedtest.tele2.net --ftp-user=anonymous --ftp-pass=IXs2wc8OJOz7SYLBk47Ji1rHTmxM
rclone lsf :ftp,host=speedtest.tele2.net,user=anonymous,pass=IXs2wc8OJOz7SYLBk47Ji1rHTmxM:</code></pre>
<h3 id="implicit-tls">Implicit TLS</h3>
<p>Rlone FTP supports implicit FTP over TLS servers (FTPS). This has to
be enabled in the FTP backend config for the remote, or with <a
href="#ftp-tls"><code>--ftp-tls</code></a>. The default FTPS port is
<code>990</code>, not <code>21</code> and can be set with <a
href="#ftp-port"><code>--ftp-port</code></a>.</p>
<h3 id="restricted-filename-characters-8">Restricted filename
characters</h3>
<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>
<p>File names cannot end with the following characters. Replacement is
limited to the last character in a file name:</p>
<table>
<thead>
<tr class="header">
<th>Character</th>
<th style="text-align: center;">Value</th>
<th style="text-align: center;">Replacement</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>SP</td>
<td style="text-align: center;">0x20</td>
<td style="text-align: center;">␠</td>
</tr>
</tbody>
</table>
<p>Not all FTP servers can have all characters in file names, for
example:</p>
<table>
<thead>
<tr class="header">
<th>FTP Server</th>
<th style="text-align: center;">Forbidden characters</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>proftpd</td>
<td style="text-align: center;"><code>*</code></td>
</tr>
<tr class="even">
<td>pureftpd</td>
<td style="text-align: center;"><code>\ [ ]</code></td>
</tr>
</tbody>
</table>
<p>This backend’s interactive configuration wizard provides a selection
of sensible encoding settings for major FTP servers: ProFTPd, PureFTPd,
VsFTPd. Just hit a selection number when prompted.</p>
<h3 id="standard-options-14">Standard options</h3>
<p>Here are the Standard options specific to ftp (FTP).</p>
<h4 id="ftp-host">–ftp-host</h4>
<p>FTP host to connect to.</p>
<p>E.g. “ftp.example.com”.</p>
<p>Properties:</p>
<ul>
<li>Config: host</li>
<li>Env Var: RCLONE_FTP_HOST</li>
<li>Type: string</li>
<li>Required: true</li>
</ul>
<h4 id="ftp-user">–ftp-user</h4>
<p>FTP username.</p>
<p>Properties:</p>
<ul>
<li>Config: user</li>
<li>Env Var: RCLONE_FTP_USER</li>
<li>Type: string</li>
<li>Default: “$USER”</li>
</ul>
<h4 id="ftp-port">–ftp-port</h4>
<p>FTP port number.</p>
<p>Properties:</p>
<ul>
<li>Config: port</li>
<li>Env Var: RCLONE_FTP_PORT</li>
<li>Type: int</li>
<li>Default: 21</li>
</ul>
<h4 id="ftp-pass">–ftp-pass</h4>
<p>FTP password.</p>
<p><strong>NB</strong> Input to this must be obscured - see <a
href="https://rclone.org/commands/rclone_obscure/">rclone
obscure</a>.</p>
<p>Properties:</p>
<ul>
<li>Config: pass</li>
<li>Env Var: RCLONE_FTP_PASS</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="ftp-tls">–ftp-tls</h4>
<p>Use Implicit FTPS (FTP over TLS).</p>
<p>When using implicit FTP over TLS the client connects using TLS right
from the start which breaks compatibility with non-TLS-aware servers.
This is usually served over port 990 rather than port 21. Cannot be used
in combination with explicit FTP.</p>
<p>Properties:</p>
<ul>
<li>Config: tls</li>
<li>Env Var: RCLONE_FTP_TLS</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="ftp-explicit-tls">–ftp-explicit-tls</h4>
<p>Use Explicit FTPS (FTP over TLS).</p>
<p>When using explicit FTP over TLS the client explicitly requests
security from the server in order to upgrade a plain text connection to
an encrypted one. Cannot be used in combination with implicit FTP.</p>
<p>Properties:</p>
<ul>
<li>Config: explicit_tls</li>
<li>Env Var: RCLONE_FTP_EXPLICIT_TLS</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h3 id="advanced-options-12">Advanced options</h3>
<p>Here are the Advanced options specific to ftp (FTP).</p>
<h4 id="ftp-concurrency">–ftp-concurrency</h4>
<p>Maximum number of FTP simultaneous connections, 0 for unlimited.</p>
<p>Note that setting this is very likely to cause deadlocks so it should
be used with care.</p>
<p>If you are doing a sync or copy then make sure concurrency is one
more than the sum of <code>--transfers</code> and
<code>--checkers</code>.</p>
<p>If you use <code>--check-first</code> then it just needs to be one
more than the maximum of <code>--checkers</code> and
<code>--transfers</code>.</p>
<p>So for <code>concurrency 3</code> you’d use
<code>--checkers 2 --transfers 2 --check-first</code> or
<code>--checkers 1 --transfers 1</code>.</p>
<p>Properties:</p>
<ul>
<li>Config: concurrency</li>
<li>Env Var: RCLONE_FTP_CONCURRENCY</li>
<li>Type: int</li>
<li>Default: 0</li>
</ul>
<h4 id="ftp-no-check-certificate">–ftp-no-check-certificate</h4>
<p>Do not verify the TLS certificate of the server.</p>
<p>Properties:</p>
<ul>
<li>Config: no_check_certificate</li>
<li>Env Var: RCLONE_FTP_NO_CHECK_CERTIFICATE</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="ftp-disable-epsv">–ftp-disable-epsv</h4>
<p>Disable using EPSV even if server advertises support.</p>
<p>Properties:</p>
<ul>
<li>Config: disable_epsv</li>
<li>Env Var: RCLONE_FTP_DISABLE_EPSV</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="ftp-disable-mlsd">–ftp-disable-mlsd</h4>
<p>Disable using MLSD even if server advertises support.</p>
<p>Properties:</p>
<ul>
<li>Config: disable_mlsd</li>
<li>Env Var: RCLONE_FTP_DISABLE_MLSD</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="ftp-disable-utf8">–ftp-disable-utf8</h4>
<p>Disable using UTF-8 even if server advertises support.</p>
<p>Properties:</p>
<ul>
<li>Config: disable_utf8</li>
<li>Env Var: RCLONE_FTP_DISABLE_UTF8</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="ftp-writing-mdtm">–ftp-writing-mdtm</h4>
<p>Use MDTM to set modification time (VsFtpd quirk)</p>
<p>Properties:</p>
<ul>
<li>Config: writing_mdtm</li>
<li>Env Var: RCLONE_FTP_WRITING_MDTM</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="ftp-force-list-hidden">–ftp-force-list-hidden</h4>
<p>Use LIST -a to force listing of hidden files and folders. This will
disable the use of MLSD.</p>
<p>Properties:</p>
<ul>
<li>Config: force_list_hidden</li>
<li>Env Var: RCLONE_FTP_FORCE_LIST_HIDDEN</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="ftp-idle-timeout">–ftp-idle-timeout</h4>
<p>Max time before closing idle connections.</p>
<p>If no connections have been returned to the connection pool in the
time given, rclone will empty the connection pool.</p>
<p>Set to 0 to keep connections indefinitely.</p>
<p>Properties:</p>
<ul>
<li>Config: idle_timeout</li>
<li>Env Var: RCLONE_FTP_IDLE_TIMEOUT</li>
<li>Type: Duration</li>
<li>Default: 1m0s</li>
</ul>
<h4 id="ftp-close-timeout">–ftp-close-timeout</h4>
<p>Maximum time to wait for a response to close.</p>
<p>Properties:</p>
<ul>
<li>Config: close_timeout</li>
<li>Env Var: RCLONE_FTP_CLOSE_TIMEOUT</li>
<li>Type: Duration</li>
<li>Default: 1m0s</li>
</ul>
<h4 id="ftp-tls-cache-size">–ftp-tls-cache-size</h4>
<p>Size of TLS session cache for all control and data connections.</p>
<p>TLS cache allows to resume TLS sessions and reuse PSK between
connections. Increase if default size is not enough resulting in TLS
resumption errors. Enabled by default. Use 0 to disable.</p>
<p>Properties:</p>
<ul>
<li>Config: tls_cache_size</li>
<li>Env Var: RCLONE_FTP_TLS_CACHE_SIZE</li>
<li>Type: int</li>
<li>Default: 32</li>
</ul>
<h4 id="ftp-disable-tls13">–ftp-disable-tls13</h4>
<p>Disable TLS 1.3 (workaround for FTP servers with buggy TLS)</p>
<p>Properties:</p>
<ul>
<li>Config: disable_tls13</li>
<li>Env Var: RCLONE_FTP_DISABLE_TLS13</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="ftp-shut-timeout">–ftp-shut-timeout</h4>
<p>Maximum time to wait for data connection closing status.</p>
<p>Properties:</p>
<ul>
<li>Config: shut_timeout</li>
<li>Env Var: RCLONE_FTP_SHUT_TIMEOUT</li>
<li>Type: Duration</li>
<li>Default: 1m0s</li>
</ul>
<h4 id="ftp-ask-password">–ftp-ask-password</h4>
<p>Allow asking for FTP password when needed.</p>
<p>If this is set and no password is supplied then rclone will ask for a
password</p>
<p>Properties:</p>
<ul>
<li>Config: ask_password</li>
<li>Env Var: RCLONE_FTP_ASK_PASSWORD</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="ftp-encoding">–ftp-encoding</h4>
<p>The encoding for the backend.</p>
<p>See the <a href="https://rclone.org/overview/#encoding">encoding
section in the overview</a> for more info.</p>
<p>Properties:</p>
<ul>
<li>Config: encoding</li>
<li>Env Var: RCLONE_FTP_ENCODING</li>
<li>Type: MultiEncoder</li>
<li>Default: Slash,Del,Ctl,RightSpace,Dot</li>
<li>Examples:
<ul>
<li>“Asterisk,Ctl,Dot,Slash”
<ul>
<li>ProFTPd can’t handle ’*’ in file names</li>
</ul></li>
<li>“BackSlash,Ctl,Del,Dot,RightSpace,Slash,SquareBracket”
<ul>
<li>PureFTPd can’t handle ‘[]’ or ’*’ in file names</li>
</ul></li>
<li>“Ctl,LeftPeriod,Slash”
<ul>
<li>VsFTPd can’t handle file names starting with dot</li>
</ul></li>
</ul></li>
</ul>
<h2 id="limitations-10">Limitations</h2>
<p>FTP servers acting as rclone remotes must support
<code>passive</code> mode. The mode cannot be configured as
<code>passive</code> is the only supported one. Rclone’s FTP
implementation is not compatible with <code>active</code> mode as <a
href="https://github.com/jlaffaye/ftp/issues/29">the library it uses
doesn’t support it</a>. This will likely never be supported due to
security concerns.</p>
<p>Rclone’s FTP backend does not support any checksums but can compare
file sizes.</p>
<p><code>rclone about</code> is not supported by the FTP 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>
<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>
<p>The implementation of : <code>--dump headers</code>,
<code>--dump bodies</code>, <code>--dump auth</code> for debugging isn’t
the same as for rclone HTTP based backends - it has less fine grained
control.</p>
<p><code>--timeout</code> isn’t supported (but <code>--contimeout</code>
is).</p>
<p><code>--bind</code> isn’t supported.</p>
<p>Rclone’s FTP backend could support server-side move but does not at
present.</p>
<p>The <code>ftp_proxy</code> environment variable is not currently
supported.</p>
<h4 id="modified-time-3">Modified time</h4>
<p>File modification time (timestamps) is supported to 1 second
resolution for major FTP servers: ProFTPd, PureFTPd, VsFTPd, and
FileZilla FTP server. The <code>VsFTPd</code> server has non-standard
implementation of time related protocol commands and needs a special
configuration setting: <code>writing_mdtm = true</code>.</p>
<p>Support for precise file time with other FTP servers varies depending
on what protocol extensions they advertise. If all the
<code>MLSD</code>, <code>MDTM</code> and <code>MFTM</code> extensions
are present, rclone will use them together to provide precise time.
Otherwise the times you see on the FTP server through rclone are those
of the last file upload.</p>
<p>You can use the following command to check whether rclone can use
precise time with your FTP server:
<code>rclone backend features your_ftp_remote:</code> (the trailing
colon is important). Look for the number in the line tagged by
<code>Precision</code> designating the remote time precision expressed
as nanoseconds. A value of <code>1000000000</code> means that file time
precision of 1 second is available. A value of
<code>3153600000000000000</code> (or another large number) means
“unsupported”.</p>
<h1 id="google-cloud-storage">Google Cloud Storage</h1>
<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>
<h2 id="configuration-15">Configuration</h2>
<p>The initial setup for google cloud storage involves getting a token
from Google Cloud Storage which you need to do in your browser.
<code>rclone config</code> walks you through it.</p>
<p>Here is an example of how to make a remote called
<code>remote</code>. First run:</p>
<pre><code> rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<pre><code>n) New remote
d) Delete remote
q) Quit config
e/n/d/q&gt; n
name&gt; 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)
   \ &quot;google cloud storage&quot;
[snip]
Storage&gt; google cloud storage
Google Application Client Id - leave blank normally.
client_id&gt;
Google Application Client Secret - leave blank normally.
client_secret&gt;
Project number optional - needed only for list/create/delete buckets - see your developer console.
project_number&gt; 12345678
Service Account Credentials JSON file path - needed only if you want use SA instead of interactive login.
service_account_file&gt;
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.
   \ &quot;authenticatedRead&quot;
 2 / Object owner gets OWNER access, and project team owners get OWNER access.
   \ &quot;bucketOwnerFullControl&quot;
 3 / Object owner gets OWNER access, and project team owners get READER access.
   \ &quot;bucketOwnerRead&quot;
 4 / Object owner gets OWNER access [default if left blank].
   \ &quot;private&quot;
 5 / Object owner gets OWNER access, and project team members get access according to their roles.
   \ &quot;projectPrivate&quot;
 6 / Object owner gets OWNER access, and all Users get READER access.
   \ &quot;publicRead&quot;
object_acl&gt; 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.
   \ &quot;authenticatedRead&quot;
 2 / Project team owners get OWNER access [default if left blank].
   \ &quot;private&quot;
 3 / Project team members get access according to their roles.
   \ &quot;projectPrivate&quot;
 4 / Project team owners get OWNER access, and all Users get READER access.
   \ &quot;publicRead&quot;
 5 / Project team owners get OWNER access, and all Users get WRITER access.
   \ &quot;publicReadWrite&quot;
bucket_acl&gt; 2
Location for the newly created buckets.
Choose a number from below, or type in your own value
 1 / Empty for default location (US).
   \ &quot;&quot;
 2 / Multi-regional location for Asia.
   \ &quot;asia&quot;
 3 / Multi-regional location for Europe.
   \ &quot;eu&quot;
 4 / Multi-regional location for United States.
   \ &quot;us&quot;
 5 / Taiwan.
   \ &quot;asia-east1&quot;
 6 / Tokyo.
   \ &quot;asia-northeast1&quot;
 7 / Singapore.
   \ &quot;asia-southeast1&quot;
 8 / Sydney.
   \ &quot;australia-southeast1&quot;
 9 / Belgium.
   \ &quot;europe-west1&quot;
10 / London.
   \ &quot;europe-west2&quot;
11 / Iowa.
   \ &quot;us-central1&quot;
12 / South Carolina.
   \ &quot;us-east1&quot;
13 / Northern Virginia.
   \ &quot;us-east4&quot;
14 / Oregon.
   \ &quot;us-west1&quot;
location&gt; 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
   \ &quot;&quot;
 2 / Multi-regional storage class
   \ &quot;MULTI_REGIONAL&quot;
 3 / Regional storage class
   \ &quot;REGIONAL&quot;
 4 / Nearline storage class
   \ &quot;NEARLINE&quot;
 5 / Coldline storage class
   \ &quot;COLDLINE&quot;
 6 / Durable reduced availability storage class
   \ &quot;DURABLE_REDUCED_AVAILABILITY&quot;
storage_class&gt; 5
Remote config
Use auto config?
 * Say Y if not sure
 * Say N if you are working on a remote or headless machine or Y didn&#39;t work
y) Yes
n) No
y/n&gt; y
If your browser doesn&#39;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 = {&quot;AccessToken&quot;:&quot;xxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&quot;,&quot;RefreshToken&quot;:&quot;x/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxxxxx&quot;,&quot;Expiry&quot;:&quot;2014-07-17T20:49:14.929208288+01:00&quot;,&quot;Extra&quot;:null}
project_number = 12345678
object_acl = private
bucket_acl = private
--------------------
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<p>Note that rclone runs a webserver on your local machine to collect
the token as returned from Google if you use auto config mode. This only
runs from the moment it opens your browser to the moment you get back
the verification code. This is on <code>http://127.0.0.1:53682/</code>
and this it may require you to unblock it temporarily if you are running
a host firewall, or use manual mode.</p>
<p>This remote is called <code>remote</code> and can now be used like
this</p>
<p>See all the buckets in your project</p>
<pre><code>rclone lsd remote:</code></pre>
<p>Make a new bucket</p>
<pre><code>rclone mkdir remote:bucket</code></pre>
<p>List the contents of a bucket</p>
<pre><code>rclone ls remote:bucket</code></pre>
<p>Sync <code>/home/local/directory</code> to the remote bucket,
deleting any excess files in the bucket.</p>
<pre><code>rclone sync -i /home/local/directory remote:bucket</code></pre>
<h3 id="service-account-support">Service Account support</h3>
<p>You can set up rclone with Google Cloud Storage in an unattended
mode, i.e. not tied to a specific end-user Google account. This is
useful when you want to synchronise files onto machines that don’t have
actively logged-in users, for example build machines.</p>
<p>To get credentials for Google Cloud Platform <a
href="https://cloud.google.com/iam/docs/service-accounts">IAM Service
Accounts</a>, please head to the <a
href="https://console.cloud.google.com/permissions/serviceaccounts">Service
Account</a> section of the Google Developer Console. Service Accounts
behave just like normal <code>User</code> permissions in <a
href="https://cloud.google.com/storage/docs/access-control">Google Cloud
Storage ACLs</a>, so you can limit their access (e.g. make them read
only). After creating an account, a JSON file containing the Service
Account’s credentials will be downloaded onto your machines. These
credentials are what rclone will use for authentication.</p>
<p>To use a Service Account instead of OAuth2 token flow, enter the path
to your Service Account credentials at the
<code>service_account_file</code> prompt and rclone won’t use the
browser based authentication flow. If you’d rather stuff the contents of
the credentials file into the rclone config file, you can set
<code>service_account_credentials</code> with the actual contents of the
file instead, or set the equivalent environment variable.</p>
<h3 id="anonymous-access">Anonymous Access</h3>
<p>For downloads of objects that permit public access you can configure
rclone to use anonymous access by setting <code>anonymous</code> to
<code>true</code>. With unauthorized access you can’t write or create
files but only read or list those buckets and objects that have public
read access.</p>
<h3 id="application-default-credentials">Application Default
Credentials</h3>
<p>If no other source of credentials is provided, rclone will fall back
to <a
href="https://cloud.google.com/video-intelligence/docs/common/auth#authenticating_with_application_default_credentials">Application
Default Credentials</a> this is useful both when you already have
configured authentication for your developer account, or in production
when running on a google compute host. Note that if running in docker,
you may need to run additional commands on your google compute machine -
<a
href="https://cloud.google.com/container-registry/docs/advanced-authentication#gcloud_as_a_docker_credential_helper">see
this page</a>.</p>
<p>Note that in the case application default credentials are used, there
is no need to explicitly configure a project number.</p>
<h3 id="fast-list-2">–fast-list</h3>
<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>
<h3 id="custom-upload-headers">Custom upload headers</h3>
<p>You can set custom upload headers with the
<code>--header-upload</code> flag. Google Cloud Storage supports the
headers as described in the <a
href="https://cloud.google.com/storage/docs/gsutil/addlhelp/WorkingWithObjectMetadata">working
with metadata documentation</a></p>
<ul>
<li>Cache-Control</li>
<li>Content-Disposition</li>
<li>Content-Encoding</li>
<li>Content-Language</li>
<li>Content-Type</li>
<li>X-Goog-Storage-Class</li>
<li>X-Goog-Meta-</li>
</ul>
<p>Eg <code>--header-upload "Content-Type text/potato"</code></p>
<p>Note that the last of these is for setting custom metadata in the
form <code>--header-upload "x-goog-meta-key: value"</code></p>
<h3 id="modification-time-1">Modification time</h3>
<p>Google Cloud Storage stores md5sum natively. Google’s <a
href="https://cloud.google.com/storage/docs/gsutil">gsutil</a> tool
stores modification time with one-second precision as
<code>goog-reserved-file-mtime</code> in file metadata.</p>
<p>To ensure compatibility with gsutil, rclone stores modification time
in 2 separate metadata entries. <code>mtime</code> uses RFC3339 format
with one-nanosecond precision. <code>goog-reserved-file-mtime</code>
uses Unix timestamp format with one-second precision. To get
modification time from object metadata, rclone reads the metadata in the
following order: <code>mtime</code>,
<code>goog-reserved-file-mtime</code>, object updated time.</p>
<p>Note that rclone’s default modify window is 1ns. Files uploaded by
gsutil only contain timestamps with one-second precision. If you use
rclone to sync files previously uploaded by gsutil, rclone will attempt
to update modification time for all these files. To avoid these possibly
unnecessary updates, use <code>--modify-window 1s</code>.</p>
<h3 id="restricted-filename-characters-9">Restricted filename
characters</h3>
<table>
<thead>
<tr class="header">
<th>Character</th>
<th style="text-align: center;">Value</th>
<th style="text-align: center;">Replacement</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>NUL</td>
<td style="text-align: center;">0x00</td>
<td style="text-align: center;">␀</td>
</tr>
<tr class="even">
<td>LF</td>
<td style="text-align: center;">0x0A</td>
<td style="text-align: center;">␊</td>
</tr>
<tr class="odd">
<td>CR</td>
<td style="text-align: center;">0x0D</td>
<td style="text-align: center;">␍</td>
</tr>
<tr class="even">
<td>/</td>
<td style="text-align: center;">0x2F</td>
<td style="text-align: center;">／</td>
</tr>
</tbody>
</table>
<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>
<h3 id="standard-options-15">Standard options</h3>
<p>Here are the Standard options specific to google cloud storage
(Google Cloud Storage (this is not Google Drive)).</p>
<h4 id="gcs-client-id">–gcs-client-id</h4>
<p>OAuth Client Id.</p>
<p>Leave blank normally.</p>
<p>Properties:</p>
<ul>
<li>Config: client_id</li>
<li>Env Var: RCLONE_GCS_CLIENT_ID</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="gcs-client-secret">–gcs-client-secret</h4>
<p>OAuth Client Secret.</p>
<p>Leave blank normally.</p>
<p>Properties:</p>
<ul>
<li>Config: client_secret</li>
<li>Env Var: RCLONE_GCS_CLIENT_SECRET</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="gcs-project-number">–gcs-project-number</h4>
<p>Project number.</p>
<p>Optional - needed only for list/create/delete buckets - see your
developer console.</p>
<p>Properties:</p>
<ul>
<li>Config: project_number</li>
<li>Env Var: RCLONE_GCS_PROJECT_NUMBER</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="gcs-service-account-file">–gcs-service-account-file</h4>
<p>Service Account Credentials JSON file path.</p>
<p>Leave blank normally. Needed only if you want use SA instead of
interactive login.</p>
<p>Leading <code>~</code> will be expanded in the file name as will
environment variables such as <code>${RCLONE_CONFIG_DIR}</code>.</p>
<p>Properties:</p>
<ul>
<li>Config: service_account_file</li>
<li>Env Var: RCLONE_GCS_SERVICE_ACCOUNT_FILE</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4
id="gcs-service-account-credentials">–gcs-service-account-credentials</h4>
<p>Service Account Credentials JSON blob.</p>
<p>Leave blank normally. Needed only if you want use SA instead of
interactive login.</p>
<p>Properties:</p>
<ul>
<li>Config: service_account_credentials</li>
<li>Env Var: RCLONE_GCS_SERVICE_ACCOUNT_CREDENTIALS</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="gcs-anonymous">–gcs-anonymous</h4>
<p>Access public buckets and objects without credentials.</p>
<p>Set to ‘true’ if you just want to download files and don’t configure
credentials.</p>
<p>Properties:</p>
<ul>
<li>Config: anonymous</li>
<li>Env Var: RCLONE_GCS_ANONYMOUS</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="gcs-object-acl">–gcs-object-acl</h4>
<p>Access Control List for new objects.</p>
<p>Properties:</p>
<ul>
<li>Config: object_acl</li>
<li>Env Var: RCLONE_GCS_OBJECT_ACL</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“authenticatedRead”
<ul>
<li>Object owner gets OWNER access.</li>
<li>All Authenticated Users get READER access.</li>
</ul></li>
<li>“bucketOwnerFullControl”
<ul>
<li>Object owner gets OWNER access.</li>
<li>Project team owners get OWNER access.</li>
</ul></li>
<li>“bucketOwnerRead”
<ul>
<li>Object owner gets OWNER access.</li>
<li>Project team owners get READER access.</li>
</ul></li>
<li>“private”
<ul>
<li>Object owner gets OWNER access.</li>
<li>Default if left blank.</li>
</ul></li>
<li>“projectPrivate”
<ul>
<li>Object owner gets OWNER access.</li>
<li>Project team members get access according to their roles.</li>
</ul></li>
<li>“publicRead”
<ul>
<li>Object owner gets OWNER access.</li>
<li>All Users get READER access.</li>
</ul></li>
</ul></li>
</ul>
<h4 id="gcs-bucket-acl">–gcs-bucket-acl</h4>
<p>Access Control List for new buckets.</p>
<p>Properties:</p>
<ul>
<li>Config: bucket_acl</li>
<li>Env Var: RCLONE_GCS_BUCKET_ACL</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“authenticatedRead”
<ul>
<li>Project team owners get OWNER access.</li>
<li>All Authenticated Users get READER access.</li>
</ul></li>
<li>“private”
<ul>
<li>Project team owners get OWNER access.</li>
<li>Default if left blank.</li>
</ul></li>
<li>“projectPrivate”
<ul>
<li>Project team members get access according to their roles.</li>
</ul></li>
<li>“publicRead”
<ul>
<li>Project team owners get OWNER access.</li>
<li>All Users get READER access.</li>
</ul></li>
<li>“publicReadWrite”
<ul>
<li>Project team owners get OWNER access.</li>
<li>All Users get WRITER access.</li>
</ul></li>
</ul></li>
</ul>
<h4 id="gcs-bucket-policy-only">–gcs-bucket-policy-only</h4>
<p>Access checks should use bucket-level IAM policies.</p>
<p>If you want to upload objects to a bucket with Bucket Policy Only set
then you will need to set this.</p>
<p>When it is set, rclone:</p>
<ul>
<li>ignores ACLs set on buckets</li>
<li>ignores ACLs set on objects</li>
<li>creates buckets with Bucket Policy Only set</li>
</ul>
<p>Docs: https://cloud.google.com/storage/docs/bucket-policy-only</p>
<p>Properties:</p>
<ul>
<li>Config: bucket_policy_only</li>
<li>Env Var: RCLONE_GCS_BUCKET_POLICY_ONLY</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="gcs-location">–gcs-location</h4>
<p>Location for the newly created buckets.</p>
<p>Properties:</p>
<ul>
<li>Config: location</li>
<li>Env Var: RCLONE_GCS_LOCATION</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“”
<ul>
<li>Empty for default location (US)</li>
</ul></li>
<li>“asia”
<ul>
<li>Multi-regional location for Asia</li>
</ul></li>
<li>“eu”
<ul>
<li>Multi-regional location for Europe</li>
</ul></li>
<li>“us”
<ul>
<li>Multi-regional location for United States</li>
</ul></li>
<li>“asia-east1”
<ul>
<li>Taiwan</li>
</ul></li>
<li>“asia-east2”
<ul>
<li>Hong Kong</li>
</ul></li>
<li>“asia-northeast1”
<ul>
<li>Tokyo</li>
</ul></li>
<li>“asia-northeast2”
<ul>
<li>Osaka</li>
</ul></li>
<li>“asia-northeast3”
<ul>
<li>Seoul</li>
</ul></li>
<li>“asia-south1”
<ul>
<li>Mumbai</li>
</ul></li>
<li>“asia-south2”
<ul>
<li>Delhi</li>
</ul></li>
<li>“asia-southeast1”
<ul>
<li>Singapore</li>
</ul></li>
<li>“asia-southeast2”
<ul>
<li>Jakarta</li>
</ul></li>
<li>“australia-southeast1”
<ul>
<li>Sydney</li>
</ul></li>
<li>“australia-southeast2”
<ul>
<li>Melbourne</li>
</ul></li>
<li>“europe-north1”
<ul>
<li>Finland</li>
</ul></li>
<li>“europe-west1”
<ul>
<li>Belgium</li>
</ul></li>
<li>“europe-west2”
<ul>
<li>London</li>
</ul></li>
<li>“europe-west3”
<ul>
<li>Frankfurt</li>
</ul></li>
<li>“europe-west4”
<ul>
<li>Netherlands</li>
</ul></li>
<li>“europe-west6”
<ul>
<li>Zürich</li>
</ul></li>
<li>“europe-central2”
<ul>
<li>Warsaw</li>
</ul></li>
<li>“us-central1”
<ul>
<li>Iowa</li>
</ul></li>
<li>“us-east1”
<ul>
<li>South Carolina</li>
</ul></li>
<li>“us-east4”
<ul>
<li>Northern Virginia</li>
</ul></li>
<li>“us-west1”
<ul>
<li>Oregon</li>
</ul></li>
<li>“us-west2”
<ul>
<li>California</li>
</ul></li>
<li>“us-west3”
<ul>
<li>Salt Lake City</li>
</ul></li>
<li>“us-west4”
<ul>
<li>Las Vegas</li>
</ul></li>
<li>“northamerica-northeast1”
<ul>
<li>Montréal</li>
</ul></li>
<li>“northamerica-northeast2”
<ul>
<li>Toronto</li>
</ul></li>
<li>“southamerica-east1”
<ul>
<li>São Paulo</li>
</ul></li>
<li>“southamerica-west1”
<ul>
<li>Santiago</li>
</ul></li>
<li>“asia1”
<ul>
<li>Dual region: asia-northeast1 and asia-northeast2.</li>
</ul></li>
<li>“eur4”
<ul>
<li>Dual region: europe-north1 and europe-west4.</li>
</ul></li>
<li>“nam4”
<ul>
<li>Dual region: us-central1 and us-east1.</li>
</ul></li>
</ul></li>
</ul>
<h4 id="gcs-storage-class">–gcs-storage-class</h4>
<p>The storage class to use when storing objects in Google Cloud
Storage.</p>
<p>Properties:</p>
<ul>
<li>Config: storage_class</li>
<li>Env Var: RCLONE_GCS_STORAGE_CLASS</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“”
<ul>
<li>Default</li>
</ul></li>
<li>“MULTI_REGIONAL”
<ul>
<li>Multi-regional storage class</li>
</ul></li>
<li>“REGIONAL”
<ul>
<li>Regional storage class</li>
</ul></li>
<li>“NEARLINE”
<ul>
<li>Nearline storage class</li>
</ul></li>
<li>“COLDLINE”
<ul>
<li>Coldline storage class</li>
</ul></li>
<li>“ARCHIVE”
<ul>
<li>Archive storage class</li>
</ul></li>
<li>“DURABLE_REDUCED_AVAILABILITY”
<ul>
<li>Durable reduced availability storage class</li>
</ul></li>
</ul></li>
</ul>
<h3 id="advanced-options-13">Advanced options</h3>
<p>Here are the Advanced options specific to google cloud storage
(Google Cloud Storage (this is not Google Drive)).</p>
<h4 id="gcs-token">–gcs-token</h4>
<p>OAuth Access Token as a JSON blob.</p>
<p>Properties:</p>
<ul>
<li>Config: token</li>
<li>Env Var: RCLONE_GCS_TOKEN</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="gcs-auth-url">–gcs-auth-url</h4>
<p>Auth server URL.</p>
<p>Leave blank to use the provider defaults.</p>
<p>Properties:</p>
<ul>
<li>Config: auth_url</li>
<li>Env Var: RCLONE_GCS_AUTH_URL</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="gcs-token-url">–gcs-token-url</h4>
<p>Token server url.</p>
<p>Leave blank to use the provider defaults.</p>
<p>Properties:</p>
<ul>
<li>Config: token_url</li>
<li>Env Var: RCLONE_GCS_TOKEN_URL</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="gcs-no-check-bucket">–gcs-no-check-bucket</h4>
<p>If set, don’t attempt to check the bucket exists or create it.</p>
<p>This can be useful when trying to minimise the number of transactions
rclone does if you know the bucket exists already.</p>
<p>Properties:</p>
<ul>
<li>Config: no_check_bucket</li>
<li>Env Var: RCLONE_GCS_NO_CHECK_BUCKET</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="gcs-decompress">–gcs-decompress</h4>
<p>If set this will decompress gzip encoded objects.</p>
<p>It is possible to upload objects to GCS with “Content-Encoding: gzip”
set. Normally rclone will download these files as compressed
objects.</p>
<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>
<p>Properties:</p>
<ul>
<li>Config: decompress</li>
<li>Env Var: RCLONE_GCS_DECOMPRESS</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="gcs-endpoint">–gcs-endpoint</h4>
<p>Endpoint for the service.</p>
<p>Leave blank normally.</p>
<p>Properties:</p>
<ul>
<li>Config: endpoint</li>
<li>Env Var: RCLONE_GCS_ENDPOINT</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="gcs-encoding">–gcs-encoding</h4>
<p>The encoding for the backend.</p>
<p>See the <a href="https://rclone.org/overview/#encoding">encoding
section in the overview</a> for more info.</p>
<p>Properties:</p>
<ul>
<li>Config: encoding</li>
<li>Env Var: RCLONE_GCS_ENCODING</li>
<li>Type: MultiEncoder</li>
<li>Default: Slash,CrLf,InvalidUtf8,Dot</li>
</ul>
<h2 id="limitations-11">Limitations</h2>
<p><code>rclone about</code> is not supported by the Google Cloud
Storage 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>
<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>
<h1 id="google-drive">Google Drive</h1>
<p>Paths are specified as <code>drive:path</code></p>
<p>Drive paths may be as deep as required,
e.g. <code>drive:directory/subdirectory</code>.</p>
<h2 id="configuration-16">Configuration</h2>
<p>The initial setup for drive involves getting a token from Google
drive which you need to do in your browser. <code>rclone config</code>
walks you through it.</p>
<p>Here is an example of how to make a remote called
<code>remote</code>. First run:</p>
<pre><code> rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<pre><code>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&gt; n
name&gt; remote
Type of storage to configure.
Choose a number from below, or type in your own value
[snip]
XX / Google Drive
   \ &quot;drive&quot;
[snip]
Storage&gt; drive
Google Application Client Id - leave blank normally.
client_id&gt;
Google Application Client Secret - leave blank normally.
client_secret&gt;
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.
   \ &quot;drive&quot;
 2 / Read-only access to file metadata and file contents.
   \ &quot;drive.readonly&quot;
   / 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.
   \ &quot;drive.file&quot;
   / Allows read and write access to the Application Data folder.
 4 | This is not visible in the drive website.
   \ &quot;drive.appfolder&quot;
   / Allows read-only access to file metadata but
 5 | does not allow any access to read or download file content.
   \ &quot;drive.metadata.readonly&quot;
scope&gt; 1
Service Account Credentials JSON file path - needed only if you want use SA instead of interactive login.
service_account_file&gt;
Remote config
Use auto config?
 * Say Y if not sure
 * Say N if you are working on a remote or headless machine or Y didn&#39;t work
y) Yes
n) No
y/n&gt; y
If your browser doesn&#39;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&gt; n
--------------------
[remote]
client_id = 
client_secret = 
scope = drive
root_folder_id = 
service_account_file =
token = {&quot;access_token&quot;:&quot;XXX&quot;,&quot;token_type&quot;:&quot;Bearer&quot;,&quot;refresh_token&quot;:&quot;XXX&quot;,&quot;expiry&quot;:&quot;2014-03-16T13:57:58.955387075Z&quot;}
--------------------
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<p>Note that rclone runs a webserver on your local machine to collect
the token as returned from Google if you use auto config mode. This only
runs from the moment it opens your browser to the moment you get back
the verification code. This is on <code>http://127.0.0.1:53682/</code>
and it may require you to unblock it temporarily if you are running a
host firewall, or use manual mode.</p>
<p>You can then use it like this,</p>
<p>List directories in top level of your drive</p>
<pre><code>rclone lsd remote:</code></pre>
<p>List all the files in your drive</p>
<pre><code>rclone ls remote:</code></pre>
<p>To copy a local directory to a drive directory called backup</p>
<pre><code>rclone copy /home/source remote:backup</code></pre>
<h3 id="scopes">Scopes</h3>
<p>Rclone allows you to select which scope you would like for rclone to
use. This changes what type of token is granted to rclone. <a
href="https://developers.google.com/drive/v3/web/about-auth">The scopes
are defined here</a>.</p>
<p>The scope are</p>
<h4 id="drive">drive</h4>
<p>This is the default scope and allows full access to all files, except
for the Application Data Folder (see below).</p>
<p>Choose this one if you aren’t sure.</p>
<h4 id="drive.readonly">drive.readonly</h4>
<p>This allows read only access to all files. Files may be listed and
downloaded but not uploaded, renamed or deleted.</p>
<h4 id="drive.file">drive.file</h4>
<p>With this scope rclone can read/view/modify only those files and
folders it creates.</p>
<p>So if you uploaded files to drive via the web interface (or any other
means) they will not be visible to rclone.</p>
<p>This can be useful if you are using rclone to backup data and you
want to be sure confidential data on your drive is not visible to
rclone.</p>
<p>Files created with this scope are visible in the web interface.</p>
<h4 id="drive.appfolder">drive.appfolder</h4>
<p>This gives rclone its own private area to store files. Rclone will
not be able to see any other files on your drive and you won’t be able
to see rclone’s files from the web interface either.</p>
<h4 id="drive.metadata.readonly">drive.metadata.readonly</h4>
<p>This allows read only access to file names only. It does not allow
rclone to download or upload data, or rename or delete files or
directories.</p>
<h3 id="root-folder-id-2">Root folder ID</h3>
<p>This option has been moved to the advanced section. You can set the
<code>root_folder_id</code> for rclone. This is the directory
(identified by its <code>Folder ID</code>) that rclone considers to be
the root of your drive.</p>
<p>Normally you will leave this blank and rclone will determine the
correct root to use itself.</p>
<p>However you can set this to restrict rclone to a specific folder
hierarchy or to access data within the “Computers” tab on the drive web
interface (where files from Google’s Backup and Sync desktop program
go).</p>
<p>In order to do this you will have to find the <code>Folder ID</code>
of the directory you wish rclone to display. This will be the last
segment of the URL when you open the relevant folder in the drive web
interface.</p>
<p>So if the folder you want rclone to use has a URL which looks like
<code>https://drive.google.com/drive/folders/1XyfxxxxxxxxxxxxxxxxxxxxxxxxxKHCh</code>
in the browser, then you use
<code>1XyfxxxxxxxxxxxxxxxxxxxxxxxxxKHCh</code> as the
<code>root_folder_id</code> in the config.</p>
<p><strong>NB</strong> folders under the “Computers” tab seem to be read
only (drive gives a 500 error) when using rclone.</p>
<p>There doesn’t appear to be an API to discover the folder IDs of the
“Computers” tab - please contact us if you know otherwise!</p>
<p>Note also that rclone can’t access any data under the “Backups” tab
on the google drive web interface yet.</p>
<h3 id="service-account-support-1">Service Account support</h3>
<p>You can set up rclone with Google Drive in an unattended mode,
i.e. not tied to a specific end-user Google account. This is useful when
you want to synchronise files onto machines that don’t have actively
logged-in users, for example build machines.</p>
<p>To use a Service Account instead of OAuth2 token flow, enter the path
to your Service Account credentials at the
<code>service_account_file</code> prompt during
<code>rclone config</code> and rclone won’t use the browser based
authentication flow. If you’d rather stuff the contents of the
credentials file into the rclone config file, you can set
<code>service_account_credentials</code> with the actual contents of the
file instead, or set the equivalent environment variable.</p>
<h4 id="use-case---google-appsg-suite-account-and-individual-drive">Use
case - Google Apps/G-suite account and individual Drive</h4>
<p>Let’s say that you are the administrator of a Google Apps (old) or
G-suite account. The goal is to store data on an individual’s Drive
account, who IS a member of the domain. We’ll call the domain
<strong>example.com</strong>, and the user
<strong>foo@example.com</strong>.</p>
<p>There’s a few steps we need to go through to accomplish this:</p>
<h5 id="create-a-service-account-for-example.com">1. Create a service
account for example.com</h5>
<ul>
<li>To create a service account and obtain its credentials, go to the <a
href="https://console.developers.google.com">Google Developer
Console</a>.</li>
<li>You must have a project - create one if you don’t.</li>
<li>Then go to “IAM &amp; admin” -&gt; “Service Accounts”.</li>
<li>Use the “Create Credentials” button. Fill in “Service account name”
with something that identifies your client. “Role” can be empty.</li>
<li>Tick “Furnish a new private key” - select “Key type JSON”.</li>
<li>Tick “Enable G Suite Domain-wide Delegation”. This option makes
“impersonation” possible, as documented here: <a
href="https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority">Delegating
domain-wide authority to the service account</a></li>
<li>These credentials are what rclone will use for authentication. If
you ever need to remove access, press the “Delete service account key”
button.</li>
</ul>
<h5 id="allowing-api-access-to-example.com-google-drive">2. Allowing API
access to example.com Google Drive</h5>
<ul>
<li>Go to example.com’s admin console</li>
<li>Go into “Security” (or use the search bar)</li>
<li>Select “Show more” and then “Advanced settings”</li>
<li>Select “Manage API client access” in the “Authentication”
section</li>
<li>In the “Client Name” field enter the service account’s “Client ID” -
this can be found in the Developer Console under “IAM &amp; Admin” -&gt;
“Service Accounts”, then “View Client ID” for the newly created service
account. It is a ~21 character numerical string.</li>
<li>In the next field, “One or More API Scopes”, enter
<code>https://www.googleapis.com/auth/drive</code> to grant access to
Google Drive specifically.</li>
</ul>
<h5 id="configure-rclone-assuming-a-new-install">3. Configure rclone,
assuming a new install</h5>
<pre><code>rclone config

n/s/q&gt; n         # New
name&gt;gdrive      # Gdrive is an example name
Storage&gt;         # Select the number shown for Google Drive
client_id&gt;       # Can be left blank
client_secret&gt;   # Can be left blank
scope&gt;           # Select your scope, 1 for example
root_folder_id&gt;  # Can be left blank
service_account_file&gt; /home/foo/myJSONfile.json # This is where the JSON file goes!
y/n&gt;             # Auto config, n
</code></pre>
<h5 id="verify-that-its-working">4. Verify that it’s working</h5>
<ul>
<li><code>rclone -v --drive-impersonate foo@example.com lsf gdrive:backup</code></li>
<li>The arguments do:
<ul>
<li><code>-v</code> - verbose logging</li>
<li><code>--drive-impersonate foo@example.com</code> - this is what does
the magic, pretending to be user foo.</li>
<li><code>lsf</code> - list files in a parsing friendly way</li>
<li><code>gdrive:backup</code> - use the remote called gdrive, work in
the folder named backup.</li>
</ul></li>
</ul>
<p>Note: in case you configured a specific root folder on gdrive and
rclone is unable to access the contents of that folder when using
<code>--drive-impersonate</code>, do this instead: - in the gdrive web
interface, share your root folder with the user/email of the new Service
Account you created/selected at step #1 - use rclone without specifying
the <code>--drive-impersonate</code> option, like this:
<code>rclone -v lsf gdrive:backup</code></p>
<h3 id="shared-drives-team-drives">Shared drives (team drives)</h3>
<p>If you want to configure the remote to point to a Google Shared Drive
(previously known as Team Drives) then answer <code>y</code> to the
question
<code>Configure this as a Shared Drive (Team Drive)?</code>.</p>
<p>This will fetch the list of Shared Drives from google and allow you
to configure which one you want to use. You can also type in a Shared
Drive ID if you prefer.</p>
<p>For example:</p>
<pre><code>Configure this as a Shared Drive (Team Drive)?
y) Yes
n) No
y/n&gt; y
Fetching Shared Drive list...
Choose a number from below, or type in your own value
 1 / Rclone Test
   \ &quot;xxxxxxxxxxxxxxxxxxxx&quot;
 2 / Rclone Test 2
   \ &quot;yyyyyyyyyyyyyyyyyyyy&quot;
 3 / Rclone Test 3
   \ &quot;zzzzzzzzzzzzzzzzzzzz&quot;
Enter a Shared Drive ID&gt; 1
--------------------
[remote]
client_id =
client_secret =
token = {&quot;AccessToken&quot;:&quot;xxxx.x.xxxxx_xxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&quot;,&quot;RefreshToken&quot;:&quot;1/xxxxxxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxx&quot;,&quot;Expiry&quot;:&quot;2014-03-16T13:57:58.955387075Z&quot;,&quot;Extra&quot;:null}
team_drive = xxxxxxxxxxxxxxxxxxxx
--------------------
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<h3 id="fast-list-3">–fast-list</h3>
<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>
<p>It does this by combining multiple <code>list</code> calls into a
single API request.</p>
<p>This works by combining many <code>'%s' in parents</code> filters
into one expression. To list the contents of directories a, b and c, the
following requests will be send by the regular <code>List</code>
function:</p>
<pre><code>trashed=false and &#39;a&#39; in parents
trashed=false and &#39;b&#39; in parents
trashed=false and &#39;c&#39; in parents</code></pre>
<p>These can now be combined into a single request:</p>
<pre><code>trashed=false and (&#39;a&#39; in parents or &#39;b&#39; in parents or &#39;c&#39; in parents)</code></pre>
<p>The implementation of <code>ListR</code> will put up to 50
<code>parents</code> filters into one request. It will use the
<code>--checkers</code> value to specify the number of requests to run
in parallel.</p>
<p>In tests, these batch requests were up to 20x faster than the regular
method. Running the following command against different sized folders
gives:</p>
<pre><code>rclone lsjson -vv -R --checkers=6 gdrive:folder</code></pre>
<p>small folder (220 directories, 700 files):</p>
<ul>
<li>without <code>--fast-list</code>: 38s</li>
<li>with <code>--fast-list</code>: 10s</li>
</ul>
<p>large folder (10600 directories, 39000 files):</p>
<ul>
<li>without <code>--fast-list</code>: 22:05 min</li>
<li>with <code>--fast-list</code>: 58s</li>
</ul>
<h3 id="modified-time-4">Modified time</h3>
<p>Google drive stores modification times accurate to 1 ms.</p>
<h3 id="restricted-filename-characters-10">Restricted filename
characters</h3>
<p>Only Invalid UTF-8 bytes will be <a
href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they
can’t be used in JSON strings.</p>
<p>In contrast to other backends, <code>/</code> can also be used in
names and <code>.</code> or <code>..</code> are valid names.</p>
<h3 id="revisions">Revisions</h3>
<p>Google drive stores revisions of files. When you upload a change to
an existing file to google drive using rclone it will create a new
revision of that file.</p>
<p>Revisions follow the standard google policy which at time of writing
was</p>
<ul>
<li>They are deleted after 30 days or 100 revisions (whatever comes
first).</li>
<li>They do not count towards a user storage quota.</li>
</ul>
<h3 id="deleting-files-2">Deleting files</h3>
<p>By default rclone will send all files to the trash when deleting
files. If deleting them permanently is required then use the
<code>--drive-use-trash=false</code> flag, or set the equivalent
environment variable.</p>
<h3 id="shortcuts">Shortcuts</h3>
<p>In March 2020 Google introduced a new feature in Google Drive called
<a href="https://support.google.com/drive/answer/9700156">drive
shortcuts</a> (<a
href="https://developers.google.com/drive/api/v3/shortcuts">API</a>).
These will (by September 2020) <a
href="https://cloud.google.com/blog/products/g-suite/simplifying-google-drives-folder-structure-and-sharing-models">replace
the ability for files or folders to be in multiple folders at
once</a>.</p>
<p>Shortcuts are files that link to other files on Google Drive somewhat
like a symlink in unix, except they point to the underlying file data
(e.g. the inode in unix terms) so they don’t break if the source is
renamed or moved about.</p>
<p>Be default rclone treats these as follows.</p>
<p>For shortcuts pointing to files:</p>
<ul>
<li>When listing a file shortcut appears as the destination file.</li>
<li>When downloading the contents of the destination file is
downloaded.</li>
<li>When updating shortcut file with a non shortcut file, the shortcut
is removed then a new file is uploaded in place of the shortcut.</li>
<li>When server-side moving (renaming) the shortcut is renamed, not the
destination file.</li>
<li>When server-side copying the shortcut is copied, not the contents of
the shortcut. (unless <code>--drive-copy-shortcut-content</code> is in
use in which case the contents of the shortcut gets copied).</li>
<li>When deleting the shortcut is deleted not the linked file.</li>
<li>When setting the modification time, the modification time of the
linked file will be set.</li>
</ul>
<p>For shortcuts pointing to folders:</p>
<ul>
<li>When listing the shortcut appears as a folder and that folder will
contain the contents of the linked folder appear (including any sub
folders)</li>
<li>When downloading the contents of the linked folder and sub contents
are downloaded</li>
<li>When uploading to a shortcut folder the file will be placed in the
linked folder</li>
<li>When server-side moving (renaming) the shortcut is renamed, not the
destination folder</li>
<li>When server-side copying the contents of the linked folder is
copied, not the shortcut.</li>
<li>When deleting with <code>rclone rmdir</code> or
<code>rclone purge</code> the shortcut is deleted not the linked
folder.</li>
<li><strong>NB</strong> When deleting with <code>rclone remove</code> or
<code>rclone mount</code> the contents of the linked folder will be
deleted.</li>
</ul>
<p>The <a href="https://rclone.org/commands/rclone_backend/">rclone
backend</a> command can be used to create shortcuts.</p>
<p>Shortcuts can be completely ignored with the
<code>--drive-skip-shortcuts</code> flag or the corresponding
<code>skip_shortcuts</code> configuration setting.</p>
<h3 id="emptying-trash">Emptying trash</h3>
<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>
<p>Note that Google Drive takes some time (minutes to days) to empty the
trash even though the command returns within a few seconds. No output is
echoed, so there will be no confirmation even using -v or -vv.</p>
<h3 id="quota-information">Quota information</h3>
<p>To view your current quota you can use the
<code>rclone about remote:</code> command which will display your usage
limit (quota), the usage in Google Drive, the size of all files in the
Trash and the space used by other Google services such as Gmail. This
command does not take any path arguments.</p>
<h4 id="importexport-of-google-documents">Import/Export of google
documents</h4>
<p>Google documents can be exported from and uploaded to Google
Drive.</p>
<p>When rclone downloads a Google doc it chooses a format to download
depending upon the <code>--drive-export-formats</code> setting. By
default the export formats are <code>docx,xlsx,pptx,svg</code> which are
a sensible default for an editable document.</p>
<p>When choosing a format, rclone runs down the list provided in order
and chooses the first file format the doc can be exported as from the
list. If the file can’t be exported to a format on the formats list,
then rclone will choose a format from the default list.</p>
<p>If you prefer an archive copy then you might use
<code>--drive-export-formats pdf</code>, or if you prefer
openoffice/libreoffice formats you might use
<code>--drive-export-formats ods,odt,odp</code>.</p>
<p>Note that rclone adds the extension to the google doc, so if it is
called <code>My Spreadsheet</code> on google docs, it will be exported
as <code>My Spreadsheet.xlsx</code> or <code>My Spreadsheet.pdf</code>
etc.</p>
<p>When importing files into Google Drive, rclone will convert all files
with an extension in <code>--drive-import-formats</code> to their
associated document type. rclone will not convert any files by default,
since the conversion is lossy process.</p>
<p>The conversion must result in a file with the same extension when the
<code>--drive-export-formats</code> rules are applied to the uploaded
document.</p>
<p>Here are some examples for allowed and prohibited conversions.</p>
<table>
<colgroup>
<col style="width: 24%" />
<col style="width: 24%" />
<col style="width: 17%" />
<col style="width: 21%" />
<col style="width: 12%" />
</colgroup>
<thead>
<tr class="header">
<th>export-formats</th>
<th>import-formats</th>
<th>Upload Ext</th>
<th>Document Ext</th>
<th>Allowed</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>odt</td>
<td>odt</td>
<td>odt</td>
<td>odt</td>
<td>Yes</td>
</tr>
<tr class="even">
<td>odt</td>
<td>docx,odt</td>
<td>odt</td>
<td>odt</td>
<td>Yes</td>
</tr>
<tr class="odd">
<td></td>
<td>docx</td>
<td>docx</td>
<td>docx</td>
<td>Yes</td>
</tr>
<tr class="even">
<td></td>
<td>odt</td>
<td>odt</td>
<td>docx</td>
<td>No</td>
</tr>
<tr class="odd">
<td>odt,docx</td>
<td>docx,odt</td>
<td>docx</td>
<td>odt</td>
<td>No</td>
</tr>
<tr class="even">
<td>docx,odt</td>
<td>docx,odt</td>
<td>docx</td>
<td>docx</td>
<td>Yes</td>
</tr>
<tr class="odd">
<td>docx,odt</td>
<td>docx,odt</td>
<td>odt</td>
<td>docx</td>
<td>No</td>
</tr>
</tbody>
</table>
<p>This limitation can be disabled by specifying
<code>--drive-allow-import-name-change</code>. When using this flag,
rclone can convert multiple files types resulting in the same document
type at once, e.g. with
<code>--drive-import-formats docx,odt,txt</code>, all files having these
extension would result in a document represented as a docx file. This
brings the additional risk of overwriting a document, if multiple files
have the same stem. Many rclone operations will not handle this name
change in any way. They assume an equal name when copying files and
might copy the file again or delete them when the name changes.</p>
<p>Here are the possible export extensions with their corresponding mime
types. Most of these can also be used for importing, but there more that
are not listed here. Some of these additional ones might only be
available when the operating system provides the correct MIME type
entries.</p>
<p>This list can be changed by Google Drive at any time and might not
represent the currently available conversions.</p>
<table>
<colgroup>
<col style="width: 28%" />
<col style="width: 34%" />
<col style="width: 37%" />
</colgroup>
<thead>
<tr class="header">
<th>Extension</th>
<th>Mime Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>bmp</td>
<td>image/bmp</td>
<td>Windows Bitmap format</td>
</tr>
<tr class="even">
<td>csv</td>
<td>text/csv</td>
<td>Standard CSV format for Spreadsheets</td>
</tr>
<tr class="odd">
<td>doc</td>
<td>application/msword</td>
<td>Classic Word file</td>
</tr>
<tr class="even">
<td>docx</td>
<td>application/vnd.openxmlformats-officedocument.wordprocessingml.document</td>
<td>Microsoft Office Document</td>
</tr>
<tr class="odd">
<td>epub</td>
<td>application/epub+zip</td>
<td>E-book format</td>
</tr>
<tr class="even">
<td>html</td>
<td>text/html</td>
<td>An HTML Document</td>
</tr>
<tr class="odd">
<td>jpg</td>
<td>image/jpeg</td>
<td>A JPEG Image File</td>
</tr>
<tr class="even">
<td>json</td>
<td>application/vnd.google-apps.script+json</td>
<td>JSON Text Format for Google Apps scripts</td>
</tr>
<tr class="odd">
<td>odp</td>
<td>application/vnd.oasis.opendocument.presentation</td>
<td>Openoffice Presentation</td>
</tr>
<tr class="even">
<td>ods</td>
<td>application/vnd.oasis.opendocument.spreadsheet</td>
<td>Openoffice Spreadsheet</td>
</tr>
<tr class="odd">
<td>ods</td>
<td>application/x-vnd.oasis.opendocument.spreadsheet</td>
<td>Openoffice Spreadsheet</td>
</tr>
<tr class="even">
<td>odt</td>
<td>application/vnd.oasis.opendocument.text</td>
<td>Openoffice Document</td>
</tr>
<tr class="odd">
<td>pdf</td>
<td>application/pdf</td>
<td>Adobe PDF Format</td>
</tr>
<tr class="even">
<td>pjpeg</td>
<td>image/pjpeg</td>
<td>Progressive JPEG Image</td>
</tr>
<tr class="odd">
<td>png</td>
<td>image/png</td>
<td>PNG Image Format</td>
</tr>
<tr class="even">
<td>pptx</td>
<td>application/vnd.openxmlformats-officedocument.presentationml.presentation</td>
<td>Microsoft Office Powerpoint</td>
</tr>
<tr class="odd">
<td>rtf</td>
<td>application/rtf</td>
<td>Rich Text Format</td>
</tr>
<tr class="even">
<td>svg</td>
<td>image/svg+xml</td>
<td>Scalable Vector Graphics Format</td>
</tr>
<tr class="odd">
<td>tsv</td>
<td>text/tab-separated-values</td>
<td>Standard TSV format for spreadsheets</td>
</tr>
<tr class="even">
<td>txt</td>
<td>text/plain</td>
<td>Plain Text</td>
</tr>
<tr class="odd">
<td>wmf</td>
<td>application/x-msmetafile</td>
<td>Windows Meta File</td>
</tr>
<tr class="even">
<td>xls</td>
<td>application/vnd.ms-excel</td>
<td>Classic Excel file</td>
</tr>
<tr class="odd">
<td>xlsx</td>
<td>application/vnd.openxmlformats-officedocument.spreadsheetml.sheet</td>
<td>Microsoft Office Spreadsheet</td>
</tr>
<tr class="even">
<td>zip</td>
<td>application/zip</td>
<td>A ZIP file of HTML, Images CSS</td>
</tr>
</tbody>
</table>
<p>Google documents can also be exported as link files. These files will
open a browser window for the Google Docs website of that document when
opened. The link file extension has to be specified as a
<code>--drive-export-formats</code> parameter. They will match all
available Google Documents.</p>
<table>
<thead>
<tr class="header">
<th>Extension</th>
<th>Description</th>
<th>OS Support</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>desktop</td>
<td>freedesktop.org specified desktop entry</td>
<td>Linux</td>
</tr>
<tr class="even">
<td>link.html</td>
<td>An HTML Document with a redirect</td>
<td>All</td>
</tr>
<tr class="odd">
<td>url</td>
<td>INI style link file</td>
<td>macOS, Windows</td>
</tr>
<tr class="even">
<td>webloc</td>
<td>macOS specific XML format</td>
<td>macOS</td>
</tr>
</tbody>
</table>
<h3 id="standard-options-16">Standard options</h3>
<p>Here are the Standard options specific to drive (Google Drive).</p>
<h4 id="drive-client-id">–drive-client-id</h4>
<p>Google Application Client Id Setting your own is recommended. See
https://rclone.org/drive/#making-your-own-client-id for how to create
your own. If you leave this blank, it will use an internal key which is
low performance.</p>
<p>Properties:</p>
<ul>
<li>Config: client_id</li>
<li>Env Var: RCLONE_DRIVE_CLIENT_ID</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="drive-client-secret">–drive-client-secret</h4>
<p>OAuth Client Secret.</p>
<p>Leave blank normally.</p>
<p>Properties:</p>
<ul>
<li>Config: client_secret</li>
<li>Env Var: RCLONE_DRIVE_CLIENT_SECRET</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="drive-scope">–drive-scope</h4>
<p>Scope that rclone should use when requesting access from drive.</p>
<p>Properties:</p>
<ul>
<li>Config: scope</li>
<li>Env Var: RCLONE_DRIVE_SCOPE</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“drive”
<ul>
<li>Full access all files, excluding Application Data Folder.</li>
</ul></li>
<li>“drive.readonly”
<ul>
<li>Read-only access to file metadata and file contents.</li>
</ul></li>
<li>“drive.file”
<ul>
<li>Access to files created by rclone only.</li>
<li>These are visible in the drive website.</li>
<li>File authorization is revoked when the user deauthorizes the
app.</li>
</ul></li>
<li>“drive.appfolder”
<ul>
<li>Allows read and write access to the Application Data folder.</li>
<li>This is not visible in the drive website.</li>
</ul></li>
<li>“drive.metadata.readonly”
<ul>
<li>Allows read-only access to file metadata but</li>
<li>does not allow any access to read or download file content.</li>
</ul></li>
</ul></li>
</ul>
<h4 id="drive-service-account-file">–drive-service-account-file</h4>
<p>Service Account Credentials JSON file path.</p>
<p>Leave blank normally. Needed only if you want use SA instead of
interactive login.</p>
<p>Leading <code>~</code> will be expanded in the file name as will
environment variables such as <code>${RCLONE_CONFIG_DIR}</code>.</p>
<p>Properties:</p>
<ul>
<li>Config: service_account_file</li>
<li>Env Var: RCLONE_DRIVE_SERVICE_ACCOUNT_FILE</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="drive-alternate-export">–drive-alternate-export</h4>
<p>Deprecated: No longer needed.</p>
<p>Properties:</p>
<ul>
<li>Config: alternate_export</li>
<li>Env Var: RCLONE_DRIVE_ALTERNATE_EXPORT</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h3 id="advanced-options-14">Advanced options</h3>
<p>Here are the Advanced options specific to drive (Google Drive).</p>
<h4 id="drive-token">–drive-token</h4>
<p>OAuth Access Token as a JSON blob.</p>
<p>Properties:</p>
<ul>
<li>Config: token</li>
<li>Env Var: RCLONE_DRIVE_TOKEN</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="drive-auth-url">–drive-auth-url</h4>
<p>Auth server URL.</p>
<p>Leave blank to use the provider defaults.</p>
<p>Properties:</p>
<ul>
<li>Config: auth_url</li>
<li>Env Var: RCLONE_DRIVE_AUTH_URL</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="drive-token-url">–drive-token-url</h4>
<p>Token server url.</p>
<p>Leave blank to use the provider defaults.</p>
<p>Properties:</p>
<ul>
<li>Config: token_url</li>
<li>Env Var: RCLONE_DRIVE_TOKEN_URL</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="drive-root-folder-id">–drive-root-folder-id</h4>
<p>ID of the root folder. Leave blank normally.</p>
<p>Fill in to access “Computers” folders (see docs), or for rclone to
use a non root folder as its starting point.</p>
<p>Properties:</p>
<ul>
<li>Config: root_folder_id</li>
<li>Env Var: RCLONE_DRIVE_ROOT_FOLDER_ID</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4
id="drive-service-account-credentials">–drive-service-account-credentials</h4>
<p>Service Account Credentials JSON blob.</p>
<p>Leave blank normally. Needed only if you want use SA instead of
interactive login.</p>
<p>Properties:</p>
<ul>
<li>Config: service_account_credentials</li>
<li>Env Var: RCLONE_DRIVE_SERVICE_ACCOUNT_CREDENTIALS</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="drive-team-drive">–drive-team-drive</h4>
<p>ID of the Shared Drive (Team Drive).</p>
<p>Properties:</p>
<ul>
<li>Config: team_drive</li>
<li>Env Var: RCLONE_DRIVE_TEAM_DRIVE</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="drive-auth-owner-only">–drive-auth-owner-only</h4>
<p>Only consider files owned by the authenticated user.</p>
<p>Properties:</p>
<ul>
<li>Config: auth_owner_only</li>
<li>Env Var: RCLONE_DRIVE_AUTH_OWNER_ONLY</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="drive-use-trash">–drive-use-trash</h4>
<p>Send files to the trash instead of deleting permanently.</p>
<p>Defaults to true, namely sending files to the trash. Use
<code>--drive-use-trash=false</code> to delete files permanently
instead.</p>
<p>Properties:</p>
<ul>
<li>Config: use_trash</li>
<li>Env Var: RCLONE_DRIVE_USE_TRASH</li>
<li>Type: bool</li>
<li>Default: true</li>
</ul>
<h4 id="drive-copy-shortcut-content">–drive-copy-shortcut-content</h4>
<p>Server side copy contents of shortcuts instead of the shortcut.</p>
<p>When doing server side copies, normally rclone will copy shortcuts as
shortcuts.</p>
<p>If this flag is used then rclone will copy the contents of shortcuts
rather than shortcuts themselves when doing server side copies.</p>
<p>Properties:</p>
<ul>
<li>Config: copy_shortcut_content</li>
<li>Env Var: RCLONE_DRIVE_COPY_SHORTCUT_CONTENT</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="drive-skip-gdocs">–drive-skip-gdocs</h4>
<p>Skip google documents in all listings.</p>
<p>If given, gdocs practically become invisible to rclone.</p>
<p>Properties:</p>
<ul>
<li>Config: skip_gdocs</li>
<li>Env Var: RCLONE_DRIVE_SKIP_GDOCS</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="drive-skip-checksum-gphotos">–drive-skip-checksum-gphotos</h4>
<p>Skip MD5 checksum on Google photos and videos only.</p>
<p>Use this if you get checksum errors when transferring Google photos
or videos.</p>
<p>Setting this flag will cause Google photos and videos to return a
blank MD5 checksum.</p>
<p>Google photos are identified by being in the “photos” space.</p>
<p>Corrupted checksums are caused by Google modifying the image/video
but not updating the checksum.</p>
<p>Properties:</p>
<ul>
<li>Config: skip_checksum_gphotos</li>
<li>Env Var: RCLONE_DRIVE_SKIP_CHECKSUM_GPHOTOS</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="drive-shared-with-me">–drive-shared-with-me</h4>
<p>Only show files that are shared with me.</p>
<p>Instructs rclone to operate on your “Shared with me” folder (where
Google Drive lets you access the files and folders others have shared
with you).</p>
<p>This works both with the “list” (lsd, lsl, etc.) and the “copy”
commands (copy, sync, etc.), and with all other commands too.</p>
<p>Properties:</p>
<ul>
<li>Config: shared_with_me</li>
<li>Env Var: RCLONE_DRIVE_SHARED_WITH_ME</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="drive-trashed-only">–drive-trashed-only</h4>
<p>Only show files that are in the trash.</p>
<p>This will show trashed files in their original directory
structure.</p>
<p>Properties:</p>
<ul>
<li>Config: trashed_only</li>
<li>Env Var: RCLONE_DRIVE_TRASHED_ONLY</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="drive-starred-only">–drive-starred-only</h4>
<p>Only show files that are starred.</p>
<p>Properties:</p>
<ul>
<li>Config: starred_only</li>
<li>Env Var: RCLONE_DRIVE_STARRED_ONLY</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="drive-formats">–drive-formats</h4>
<p>Deprecated: See export_formats.</p>
<p>Properties:</p>
<ul>
<li>Config: formats</li>
<li>Env Var: RCLONE_DRIVE_FORMATS</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="drive-export-formats">–drive-export-formats</h4>
<p>Comma separated list of preferred formats for downloading Google
docs.</p>
<p>Properties:</p>
<ul>
<li>Config: export_formats</li>
<li>Env Var: RCLONE_DRIVE_EXPORT_FORMATS</li>
<li>Type: string</li>
<li>Default: “docx,xlsx,pptx,svg”</li>
</ul>
<h4 id="drive-import-formats">–drive-import-formats</h4>
<p>Comma separated list of preferred formats for uploading Google
docs.</p>
<p>Properties:</p>
<ul>
<li>Config: import_formats</li>
<li>Env Var: RCLONE_DRIVE_IMPORT_FORMATS</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4
id="drive-allow-import-name-change">–drive-allow-import-name-change</h4>
<p>Allow the filetype to change when uploading Google docs.</p>
<p>E.g. file.doc to file.docx. This will confuse sync and reupload every
time.</p>
<p>Properties:</p>
<ul>
<li>Config: allow_import_name_change</li>
<li>Env Var: RCLONE_DRIVE_ALLOW_IMPORT_NAME_CHANGE</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="drive-use-created-date">–drive-use-created-date</h4>
<p>Use file created date instead of modified date.</p>
<p>Useful when downloading data and you want the creation date used in
place of the last modified date.</p>
<p><strong>WARNING</strong>: This flag may have some unexpected
consequences.</p>
<p>When uploading to your drive all files will be overwritten unless
they haven’t been modified since their creation. And the inverse will
occur while downloading. This side effect can be avoided by using the
“–checksum” flag.</p>
<p>This feature was implemented to retain photos capture date as
recorded by google photos. You will first need to check the “Create a
Google Photos folder” option in your google drive settings. You can then
copy or move the photos locally and use the date the image was taken
(created) set as the modification date.</p>
<p>Properties:</p>
<ul>
<li>Config: use_created_date</li>
<li>Env Var: RCLONE_DRIVE_USE_CREATED_DATE</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="drive-use-shared-date">–drive-use-shared-date</h4>
<p>Use date file was shared instead of modified date.</p>
<p>Note that, as with “–drive-use-created-date”, this flag may have
unexpected consequences when uploading/downloading files.</p>
<p>If both this flag and “–drive-use-created-date” are set, the created
date is used.</p>
<p>Properties:</p>
<ul>
<li>Config: use_shared_date</li>
<li>Env Var: RCLONE_DRIVE_USE_SHARED_DATE</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="drive-list-chunk">–drive-list-chunk</h4>
<p>Size of listing chunk 100-1000, 0 to disable.</p>
<p>Properties:</p>
<ul>
<li>Config: list_chunk</li>
<li>Env Var: RCLONE_DRIVE_LIST_CHUNK</li>
<li>Type: int</li>
<li>Default: 1000</li>
</ul>
<h4 id="drive-impersonate">–drive-impersonate</h4>
<p>Impersonate this user when using a service account.</p>
<p>Properties:</p>
<ul>
<li>Config: impersonate</li>
<li>Env Var: RCLONE_DRIVE_IMPERSONATE</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="drive-upload-cutoff">–drive-upload-cutoff</h4>
<p>Cutoff for switching to chunked upload.</p>
<p>Properties:</p>
<ul>
<li>Config: upload_cutoff</li>
<li>Env Var: RCLONE_DRIVE_UPLOAD_CUTOFF</li>
<li>Type: SizeSuffix</li>
<li>Default: 8Mi</li>
</ul>
<h4 id="drive-chunk-size">–drive-chunk-size</h4>
<p>Upload chunk size.</p>
<p>Must a power of 2 &gt;= 256k.</p>
<p>Making this larger will improve performance, but note that each chunk
is buffered in memory one per transfer.</p>
<p>Reducing this will reduce memory usage but decrease performance.</p>
<p>Properties:</p>
<ul>
<li>Config: chunk_size</li>
<li>Env Var: RCLONE_DRIVE_CHUNK_SIZE</li>
<li>Type: SizeSuffix</li>
<li>Default: 8Mi</li>
</ul>
<h4 id="drive-acknowledge-abuse">–drive-acknowledge-abuse</h4>
<p>Set to allow files which return cannotDownloadAbusiveFile to be
downloaded.</p>
<p>If downloading a file returns the error “This file has been
identified as malware or spam and cannot be downloaded” with the error
code “cannotDownloadAbusiveFile” then supply this flag to rclone to
indicate you acknowledge the risks of downloading the file and rclone
will download it anyway.</p>
<p>Properties:</p>
<ul>
<li>Config: acknowledge_abuse</li>
<li>Env Var: RCLONE_DRIVE_ACKNOWLEDGE_ABUSE</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="drive-keep-revision-forever">–drive-keep-revision-forever</h4>
<p>Keep new head revision of each file forever.</p>
<p>Properties:</p>
<ul>
<li>Config: keep_revision_forever</li>
<li>Env Var: RCLONE_DRIVE_KEEP_REVISION_FOREVER</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="drive-size-as-quota">–drive-size-as-quota</h4>
<p>Show sizes as storage quota usage, not actual size.</p>
<p>Show the size of a file as the storage quota used. This is the
current version plus any older versions that have been set to keep
forever.</p>
<p><strong>WARNING</strong>: This flag may have some unexpected
consequences.</p>
<p>It is not recommended to set this flag in your config - the
recommended usage is using the flag form –drive-size-as-quota when doing
rclone ls/lsl/lsf/lsjson/etc only.</p>
<p>If you do use this flag for syncing (not recommended) then you will
need to use –ignore size also.</p>
<p>Properties:</p>
<ul>
<li>Config: size_as_quota</li>
<li>Env Var: RCLONE_DRIVE_SIZE_AS_QUOTA</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="drive-v2-download-min-size">–drive-v2-download-min-size</h4>
<p>If Object’s are greater, use drive v2 API to download.</p>
<p>Properties:</p>
<ul>
<li>Config: v2_download_min_size</li>
<li>Env Var: RCLONE_DRIVE_V2_DOWNLOAD_MIN_SIZE</li>
<li>Type: SizeSuffix</li>
<li>Default: off</li>
</ul>
<h4 id="drive-pacer-min-sleep">–drive-pacer-min-sleep</h4>
<p>Minimum time to sleep between API calls.</p>
<p>Properties:</p>
<ul>
<li>Config: pacer_min_sleep</li>
<li>Env Var: RCLONE_DRIVE_PACER_MIN_SLEEP</li>
<li>Type: Duration</li>
<li>Default: 100ms</li>
</ul>
<h4 id="drive-pacer-burst">–drive-pacer-burst</h4>
<p>Number of API calls to allow without sleeping.</p>
<p>Properties:</p>
<ul>
<li>Config: pacer_burst</li>
<li>Env Var: RCLONE_DRIVE_PACER_BURST</li>
<li>Type: int</li>
<li>Default: 100</li>
</ul>
<h4
id="drive-server-side-across-configs">–drive-server-side-across-configs</h4>
<p>Allow server-side operations (e.g. copy) to work across different
drive configs.</p>
<p>This can be useful if you wish to do a server-side copy between two
different Google drives. Note that this isn’t enabled by default because
it isn’t easy to tell if it will work between any two
configurations.</p>
<p>Properties:</p>
<ul>
<li>Config: server_side_across_configs</li>
<li>Env Var: RCLONE_DRIVE_SERVER_SIDE_ACROSS_CONFIGS</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="drive-disable-http2">–drive-disable-http2</h4>
<p>Disable drive using http2.</p>
<p>There is currently an unsolved issue with the google drive backend
and HTTP/2. HTTP/2 is therefore disabled by default for the drive
backend but can be re-enabled here. When the issue is solved this flag
will be removed.</p>
<p>See: https://github.com/rclone/rclone/issues/3631</p>
<p>Properties:</p>
<ul>
<li>Config: disable_http2</li>
<li>Env Var: RCLONE_DRIVE_DISABLE_HTTP2</li>
<li>Type: bool</li>
<li>Default: true</li>
</ul>
<h4 id="drive-stop-on-upload-limit">–drive-stop-on-upload-limit</h4>
<p>Make upload limit errors be fatal.</p>
<p>At the time of writing it is only possible to upload 750 GiB of data
to Google Drive a day (this is an undocumented limit). When this limit
is reached Google Drive produces a slightly different error message.
When this flag is set it causes these errors to be fatal. These will
stop the in-progress sync.</p>
<p>Note that this detection is relying on error message strings which
Google don’t document so it may break in the future.</p>
<p>See: https://github.com/rclone/rclone/issues/3857</p>
<p>Properties:</p>
<ul>
<li>Config: stop_on_upload_limit</li>
<li>Env Var: RCLONE_DRIVE_STOP_ON_UPLOAD_LIMIT</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="drive-stop-on-download-limit">–drive-stop-on-download-limit</h4>
<p>Make download limit errors be fatal.</p>
<p>At the time of writing it is only possible to download 10 TiB of data
from Google Drive a day (this is an undocumented limit). When this limit
is reached Google Drive produces a slightly different error message.
When this flag is set it causes these errors to be fatal. These will
stop the in-progress sync.</p>
<p>Note that this detection is relying on error message strings which
Google don’t document so it may break in the future.</p>
<p>Properties:</p>
<ul>
<li>Config: stop_on_download_limit</li>
<li>Env Var: RCLONE_DRIVE_STOP_ON_DOWNLOAD_LIMIT</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="drive-skip-shortcuts">–drive-skip-shortcuts</h4>
<p>If set skip shortcut files.</p>
<p>Normally rclone dereferences shortcut files making them appear as if
they are the original file (see <a href="#shortcuts">the shortcuts
section</a>). If this flag is set then rclone will ignore shortcut files
completely.</p>
<p>Properties:</p>
<ul>
<li>Config: skip_shortcuts</li>
<li>Env Var: RCLONE_DRIVE_SKIP_SHORTCUTS</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4
id="drive-skip-dangling-shortcuts">–drive-skip-dangling-shortcuts</h4>
<p>If set skip dangling shortcut files.</p>
<p>If this is set then rclone will not show any dangling shortcuts in
listings.</p>
<p>Properties:</p>
<ul>
<li>Config: skip_dangling_shortcuts</li>
<li>Env Var: RCLONE_DRIVE_SKIP_DANGLING_SHORTCUTS</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="drive-resource-key">–drive-resource-key</h4>
<p>Resource key for accessing a link-shared file.</p>
<p>If you need to access files shared with a link like this</p>
<pre><code>https://drive.google.com/drive/folders/XXX?resourcekey=YYY&amp;usp=sharing</code></pre>
<p>Then you will need to use the first part “XXX” as the
“root_folder_id” and the second part “YYY” as the “resource_key”
otherwise you will get 404 not found errors when trying to access the
directory.</p>
<p>See: https://developers.google.com/drive/api/guides/resource-keys</p>
<p>This resource key requirement only applies to a subset of old
files.</p>
<p>Note also that opening the folder once in the web interface (with the
user you’ve authenticated rclone with) seems to be enough so that the
resource key is no needed.</p>
<p>Properties:</p>
<ul>
<li>Config: resource_key</li>
<li>Env Var: RCLONE_DRIVE_RESOURCE_KEY</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="drive-encoding">–drive-encoding</h4>
<p>The encoding for the backend.</p>
<p>See the <a href="https://rclone.org/overview/#encoding">encoding
section in the overview</a> for more info.</p>
<p>Properties:</p>
<ul>
<li>Config: encoding</li>
<li>Env Var: RCLONE_DRIVE_ENCODING</li>
<li>Type: MultiEncoder</li>
<li>Default: InvalidUtf8</li>
</ul>
<h2 id="backend-commands-3">Backend commands</h2>
<p>Here are the commands specific to the drive backend.</p>
<p>Run them with</p>
<pre><code>rclone backend COMMAND remote:</code></pre>
<p>The help below will explain what arguments each command takes.</p>
<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>
<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>
<h3 id="get">get</h3>
<p>Get command for fetching the drive config parameters</p>
<pre><code>rclone backend get remote: [options] [&lt;arguments&gt;+]</code></pre>
<p>This is a get command which will be used to fetch the various drive
config parameters</p>
<p>Usage Examples:</p>
<pre><code>rclone backend get drive: [-o service_account_file] [-o chunk_size]
rclone rc backend/command command=get fs=drive: [-o service_account_file] [-o chunk_size]</code></pre>
<p>Options:</p>
<ul>
<li>“chunk_size”: show the current upload chunk size</li>
<li>“service_account_file”: show the current service account file</li>
</ul>
<h3 id="set">set</h3>
<p>Set command for updating the drive config parameters</p>
<pre><code>rclone backend set remote: [options] [&lt;arguments&gt;+]</code></pre>
<p>This is a set command which will be used to update the various drive
config parameters</p>
<p>Usage Examples:</p>
<pre><code>rclone backend set drive: [-o service_account_file=sa.json] [-o chunk_size=67108864]
rclone rc backend/command command=set fs=drive: [-o service_account_file=sa.json] [-o chunk_size=67108864]</code></pre>
<p>Options:</p>
<ul>
<li>“chunk_size”: update the current upload chunk size</li>
<li>“service_account_file”: update the current service account file</li>
</ul>
<h3 id="shortcut">shortcut</h3>
<p>Create shortcuts from files or directories</p>
<pre><code>rclone backend shortcut remote: [options] [&lt;arguments&gt;+]</code></pre>
<p>This command creates shortcuts from files or directories.</p>
<p>Usage:</p>
<pre><code>rclone backend shortcut drive: source_item destination_shortcut
rclone backend shortcut drive: source_item -o target=drive2: destination_shortcut</code></pre>
<p>In the first example this creates a shortcut from the “source_item”
which can be a file or a directory to the “destination_shortcut”. The
“source_item” and the “destination_shortcut” should be relative paths
from “drive:”</p>
<p>In the second example this creates a shortcut from the “source_item”
relative to “drive:” to the “destination_shortcut” relative to
“drive2:”. This may fail with a permission error if the user
authenticated with “drive2:” can’t read files from “drive:”.</p>
<p>Options:</p>
<ul>
<li>“target”: optional target remote for the shortcut destination</li>
</ul>
<h3 id="drives">drives</h3>
<p>List the Shared Drives available to this account</p>
<pre><code>rclone backend drives remote: [options] [&lt;arguments&gt;+]</code></pre>
<p>This command lists the Shared Drives (Team Drives) available to this
account.</p>
<p>Usage:</p>
<pre><code>rclone backend [-o config] drives drive:</code></pre>
<p>This will return a JSON list of objects like this</p>
<pre><code>[
    {
        &quot;id&quot;: &quot;0ABCDEF-01234567890&quot;,
        &quot;kind&quot;: &quot;drive#teamDrive&quot;,
        &quot;name&quot;: &quot;My Drive&quot;
    },
    {
        &quot;id&quot;: &quot;0ABCDEFabcdefghijkl&quot;,
        &quot;kind&quot;: &quot;drive#teamDrive&quot;,
        &quot;name&quot;: &quot;Test Drive&quot;
    }
]</code></pre>
<p>With the -o config parameter it will output the list in a format
suitable for adding to a config file to make aliases for all the drives
found and a combined drive.</p>
<pre><code>[My Drive]
type = alias
remote = drive,team_drive=0ABCDEF-01234567890,root_folder_id=:

[Test Drive]
type = alias
remote = drive,team_drive=0ABCDEFabcdefghijkl,root_folder_id=:

[AllDrives]
type = combine
upstreams = &quot;My Drive=My Drive:&quot; &quot;Test Drive=Test Drive:&quot;</code></pre>
<p>Adding this to the rclone config file will cause those team drives to
be accessible with the aliases shown. Any illegal characters will be
substituted with “_” and duplicate names will have numbers suffixed. It
will also add a remote called AllDrives which shows all the shared
drives combined into one directory tree.</p>
<h3 id="untrash">untrash</h3>
<p>Untrash files and directories</p>
<pre><code>rclone backend untrash remote: [options] [&lt;arguments&gt;+]</code></pre>
<p>This command untrashes all the files and directories in the directory
passed in recursively.</p>
<p>Usage:</p>
<p>This takes an optional directory to trash which make this easier to
use via the API.</p>
<pre><code>rclone backend untrash drive:directory
rclone backend -i untrash drive:directory subdir</code></pre>
<p>Use the -i flag to see what would be restored before restoring
it.</p>
<p>Result:</p>
<pre><code>{
    &quot;Untrashed&quot;: 17,
    &quot;Errors&quot;: 0
}</code></pre>
<h3 id="copyid">copyid</h3>
<p>Copy files by ID</p>
<pre><code>rclone backend copyid remote: [options] [&lt;arguments&gt;+]</code></pre>
<p>This command copies files by ID</p>
<p>Usage:</p>
<pre><code>rclone backend copyid drive: ID path
rclone backend copyid drive: ID1 path1 ID2 path2</code></pre>
<p>It copies the drive file with ID given to the path (an rclone path
which will be passed internally to rclone copyto). The ID and path pairs
can be repeated.</p>
<p>The path should end with a / to indicate copy the file as named to
this directory. If it doesn’t end with a / then the last path component
will be used as the file name.</p>
<p>If the destination is a drive backend then server-side copying will
be attempted if possible.</p>
<p>Use the -i flag to see what would be copied before copying.</p>
<h3 id="exportformats">exportformats</h3>
<p>Dump the export formats for debug purposes</p>
<pre><code>rclone backend exportformats remote: [options] [&lt;arguments&gt;+]</code></pre>
<h3 id="importformats">importformats</h3>
<p>Dump the import formats for debug purposes</p>
<pre><code>rclone backend importformats remote: [options] [&lt;arguments&gt;+]</code></pre>
<h2 id="limitations-12">Limitations</h2>
<p>Drive has quite a lot of rate limiting. This causes rclone to be
limited to transferring about 2 files per second only. Individual files
may be transferred much faster at 100s of MiB/s but lots of small files
can take a long time.</p>
<p>Server side copies are also subject to a separate rate limit. If you
see User rate limit exceeded errors, wait at least 24 hours and retry.
You can disable server-side copies with <code>--disable copy</code> to
download and upload the files if you prefer.</p>
<h3 id="limitations-of-google-docs">Limitations of Google Docs</h3>
<p>Google docs will appear as size -1 in <code>rclone ls</code>,
<code>rclone ncdu</code> etc, and as size 0 in anything which uses the
VFS layer, e.g. <code>rclone mount</code> and <code>rclone serve</code>.
When calculating directory totals, e.g. in <code>rclone size</code> and
<code>rclone ncdu</code>, they will be counted in as empty files.</p>
<p>This is because rclone can’t find out the size of the Google docs
without downloading them.</p>
<p>Google docs will transfer correctly with <code>rclone sync</code>,
<code>rclone copy</code> etc as rclone knows to ignore the size when
doing the transfer.</p>
<p>However an unfortunate consequence of this is that you may not be
able to download Google docs using <code>rclone mount</code>. If it
doesn’t work you will get a 0 sized file. If you try again the doc may
gain its correct size and be downloadable. Whether it will work on not
depends on the application accessing the mount and the OS you are
running - experiment to find out if it does work for you!</p>
<h3 id="duplicated-files-1">Duplicated files</h3>
<p>Sometimes, for no reason I’ve been able to track down, drive will
duplicate a file that rclone uploads. Drive unlike all the other remotes
can have duplicated files.</p>
<p>Duplicated files cause problems with the syncing and you will see
messages in the log about duplicates.</p>
<p>Use <code>rclone dedupe</code> to fix duplicated files.</p>
<p>Note that this isn’t just a problem with rclone, even Google Photos
on Android duplicates files on drive sometimes.</p>
<h3 id="rclone-appears-to-be-re-copying-files-it-shouldnt">Rclone
appears to be re-copying files it shouldn’t</h3>
<p>The most likely cause of this is the duplicated file issue above -
run <code>rclone dedupe</code> and check your logs for duplicate object
or directory messages.</p>
<p>This can also be caused by a delay/caching on google drive’s end when
comparing directory listings. Specifically with team drives used in
combination with –fast-list. Files that were uploaded recently may not
appear on the directory list sent to rclone when using –fast-list.</p>
<p>Waiting a moderate period of time between attempts (estimated to be
approximately 1 hour) and/or not using –fast-list both seem to be
effective in preventing the problem.</p>
<h2 id="making-your-own-client_id">Making your own client_id</h2>
<p>When you use rclone with Google drive in its default configuration
you are using rclone’s client_id. This is shared between all the rclone
users. There is a global rate limit on the number of queries per second
that each client_id can do set by Google. rclone already has a high
quota and I will continue to make sure it is high enough by contacting
Google.</p>
<p>It is strongly recommended to use your own client ID as the default
rclone ID is heavily used. If you have multiple services running, it is
recommended to use an API key for each service. The default Google quota
is 10 transactions per second so it is recommended to stay under that
number as if you use more than that, it will cause rclone to rate limit
and make things slower.</p>
<p>Here is how to create your own Google Drive client ID for rclone:</p>
<ol type="1">
<li><p>Log into the <a
href="https://console.developers.google.com/">Google API Console</a>
with your Google account. It doesn’t matter what Google account you use.
(It need not be the same account as the Google Drive you want to
access)</p></li>
<li><p>Select a project or create a new project.</p></li>
<li><p>Under “ENABLE APIS AND SERVICES” search for “Drive”, and enable
the “Google Drive API”.</p></li>
<li><p>Click “Credentials” in the left-side panel (not “Create
credentials”, which opens the wizard), then “Create
credentials”</p></li>
<li><p>If you already configured an “Oauth Consent Screen”, then skip to
the next step; if not, click on “CONFIGURE CONSENT SCREEN” button (near
the top right corner of the right panel), then select “External” and
click on “CREATE”; on the next screen, enter an “Application name”
(“rclone” is OK); enter “User Support Email” (your own email is OK);
enter “Developer Contact Email” (your own email is OK); then click on
“Save” (all other data is optional). Click again on “Credentials” on the
left panel to go back to the “Credentials” screen.</p>
<p>(PS: if you are a GSuite user, you could also select “Internal”
instead of “External” above, but this will restrict API use to Google
Workspace users in your organisation).</p></li>
<li><p>Click on the “+ CREATE CREDENTIALS” button at the top of the
screen, then select “OAuth client ID”.</p></li>
<li><p>Choose an application type of “Desktop app” and click “Create”.
(the default name is fine)</p></li>
<li><p>It will show you a client ID and client secret. Make a note of
these.</p>
<p>(If you selected “External” at Step 5 continue to “Publish App” in
the Steps 9 and 10. If you chose “Internal” you don’t need to publish
and can skip straight to Step 11.)</p></li>
<li><p>Go to “Oauth consent screen” and press “Publish App”</p></li>
<li><p>Click “OAuth consent screen”, then click “PUBLISH APP” button and
confirm, or add your account under “Test users”.</p></li>
<li><p>Provide the noted client ID and client secret to rclone.</p></li>
</ol>
<p>Be aware that, due to the “enhanced security” recently introduced by
Google, you are theoretically expected to “submit your app for
verification” and then wait a few weeks(!) for their response; in
practice, you can go right ahead and use the client ID and client secret
with rclone, the only issue will be a very scary confirmation screen
shown when you connect via your browser for rclone to be able to get its
token-id (but as this only happens during the remote configuration, it’s
not such a big deal).</p>
<p>(Thanks to <span class="citation"
data-cites="balazer">@balazer</span> on github for these
instructions.)</p>
<p>Sometimes, creation of an OAuth consent in Google API Console fails
due to an error message “The request failed because changes to one of
the field of the resource is not supported”. As a convenient workaround,
the necessary Google Drive API key can be created on the <a
href="https://developers.google.com/drive/api/v3/quickstart/python">Python
Quickstart</a> page. Just push the Enable the Drive API button to
receive the Client ID and Secret. Note that it will automatically create
a new project in the API Console.</p>
<h1 id="google-photos">Google Photos</h1>
<p>The rclone backend for <a
href="https://www.google.com/photos/about/">Google Photos</a> is a
specialized backend for transferring photos and videos to and from
Google Photos.</p>
<p><strong>NB</strong> The Google Photos API which rclone uses has quite
a few limitations, so please read the <a href="#limitations">limitations
section</a> carefully to make sure it is suitable for your use.</p>
<h2 id="configuration-17">Configuration</h2>
<p>The initial setup for google cloud storage involves getting a token
from Google Photos which you need to do in your browser.
<code>rclone config</code> walks you through it.</p>
<p>Here is an example of how to make a remote called
<code>remote</code>. First run:</p>
<pre><code> rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<pre><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; remote
Type of storage to configure.
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
[snip]
XX / Google Photos
   \ &quot;google photos&quot;
[snip]
Storage&gt; google photos
** See help for google photos backend at: https://rclone.org/googlephotos/ **

Google Application Client Id
Leave blank normally.
Enter a string value. Press Enter for the default (&quot;&quot;).
client_id&gt; 
Google Application Client Secret
Leave blank normally.
Enter a string value. Press Enter for the default (&quot;&quot;).
client_secret&gt; 
Set to make the Google Photos backend read only.

If you choose read only then rclone will only request read only access
to your photos, otherwise rclone will request full access.
Enter a boolean value (true or false). Press Enter for the default (&quot;false&quot;).
read_only&gt; 
Edit advanced config? (y/n)
y) Yes
n) No
y/n&gt; n
Remote config
Use auto config?
 * Say Y if not sure
 * Say N if you are working on a remote or headless machine
y) Yes
n) No
y/n&gt; y
If your browser doesn&#39;t open automatically go to the following link: http://127.0.0.1:53682/auth
Log in and authorize rclone for access
Waiting for code...
Got code

*** IMPORTANT: All media items uploaded to Google Photos with rclone
*** are stored in full resolution at original quality.  These uploads
*** will count towards storage in your Google Account.

--------------------
[remote]
type = google photos
token = {&quot;access_token&quot;:&quot;XXX&quot;,&quot;token_type&quot;:&quot;Bearer&quot;,&quot;refresh_token&quot;:&quot;XXX&quot;,&quot;expiry&quot;:&quot;2019-06-28T17:38:04.644930156+01:00&quot;}
--------------------
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<p>Note that rclone runs a webserver on your local machine to collect
the token as returned from Google if you use auto config mode. This only
runs from the moment it opens your browser to the moment you get back
the verification code. This is on <code>http://127.0.0.1:53682/</code>
and this may require you to unblock it temporarily if you are running a
host firewall, or use manual mode.</p>
<p>This remote is called <code>remote</code> and can now be used like
this</p>
<p>See all the albums in your photos</p>
<pre><code>rclone lsd remote:album</code></pre>
<p>Make a new album</p>
<pre><code>rclone mkdir remote:album/newAlbum</code></pre>
<p>List the contents of an album</p>
<pre><code>rclone ls remote:album/newAlbum</code></pre>
<p>Sync <code>/home/local/images</code> to the Google Photos, removing
any excess files in the album.</p>
<pre><code>rclone sync -i /home/local/image remote:album/newAlbum</code></pre>
<h3 id="layout">Layout</h3>
<p>As Google Photos is not a general purpose cloud storage system the
backend is laid out to help you navigate it.</p>
<p>The directories under <code>media</code> show different ways of
categorizing the media. Each file will appear multiple times. So if you
want to make a backup of your google photos you might choose to backup
<code>remote:media/by-month</code>. (<strong>NB</strong>
<code>remote:media/by-day</code> is rather slow at the moment so avoid
for syncing.)</p>
<p>Note that all your photos and videos will appear somewhere under
<code>media</code>, but they may not appear under <code>album</code>
unless you’ve put them into albums.</p>
<pre><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></pre>
<p>There are two writable parts of the tree, the <code>upload</code>
directory and sub directories of the <code>album</code> directory.</p>
<p>The <code>upload</code> directory is for uploading files you don’t
want to put into albums. This will be empty to start with and will
contain the files you’ve uploaded for one rclone session only, becoming
empty again when you restart rclone. The use case for this would be if
you have a load of files you just want to once off dump into Google
Photos. For repeated syncing, uploading to <code>album</code> will work
better.</p>
<p>Directories within the <code>album</code> directory are also
writeable and you may create new directories (albums) under
<code>album</code>. If you copy files with a directory hierarchy in
there then rclone will create albums with the <code>/</code> character
in them. For example if you do</p>
<pre><code>rclone copy /path/to/images remote:album/images</code></pre>
<p>and the images directory contains</p>
<pre><code>images
    - file1.jpg
    dir
        file2.jpg
    dir2
        dir3
            file3.jpg</code></pre>
<p>Then rclone will create the following albums with the following files
in</p>
<ul>
<li>images
<ul>
<li>file1.jpg</li>
</ul></li>
<li>images/dir
<ul>
<li>file2.jpg</li>
</ul></li>
<li>images/dir2/dir3
<ul>
<li>file3.jpg</li>
</ul></li>
</ul>
<p>This means that you can use the <code>album</code> path pretty much
like a normal filesystem and it is a good target for repeated
syncing.</p>
<p>The <code>shared-album</code> directory shows albums shared with you
or by you. This is similar to the Sharing tab in the Google Photos web
interface.</p>
<h3 id="standard-options-17">Standard options</h3>
<p>Here are the Standard options specific to google photos (Google
Photos).</p>
<h4 id="gphotos-client-id">–gphotos-client-id</h4>
<p>OAuth Client Id.</p>
<p>Leave blank normally.</p>
<p>Properties:</p>
<ul>
<li>Config: client_id</li>
<li>Env Var: RCLONE_GPHOTOS_CLIENT_ID</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="gphotos-client-secret">–gphotos-client-secret</h4>
<p>OAuth Client Secret.</p>
<p>Leave blank normally.</p>
<p>Properties:</p>
<ul>
<li>Config: client_secret</li>
<li>Env Var: RCLONE_GPHOTOS_CLIENT_SECRET</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="gphotos-read-only">–gphotos-read-only</h4>
<p>Set to make the Google Photos backend read only.</p>
<p>If you choose read only then rclone will only request read only
access to your photos, otherwise rclone will request full access.</p>
<p>Properties:</p>
<ul>
<li>Config: read_only</li>
<li>Env Var: RCLONE_GPHOTOS_READ_ONLY</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h3 id="advanced-options-15">Advanced options</h3>
<p>Here are the Advanced options specific to google photos (Google
Photos).</p>
<h4 id="gphotos-token">–gphotos-token</h4>
<p>OAuth Access Token as a JSON blob.</p>
<p>Properties:</p>
<ul>
<li>Config: token</li>
<li>Env Var: RCLONE_GPHOTOS_TOKEN</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="gphotos-auth-url">–gphotos-auth-url</h4>
<p>Auth server URL.</p>
<p>Leave blank to use the provider defaults.</p>
<p>Properties:</p>
<ul>
<li>Config: auth_url</li>
<li>Env Var: RCLONE_GPHOTOS_AUTH_URL</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="gphotos-token-url">–gphotos-token-url</h4>
<p>Token server url.</p>
<p>Leave blank to use the provider defaults.</p>
<p>Properties:</p>
<ul>
<li>Config: token_url</li>
<li>Env Var: RCLONE_GPHOTOS_TOKEN_URL</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="gphotos-read-size">–gphotos-read-size</h4>
<p>Set to read the size of media items.</p>
<p>Normally rclone does not read the size of media items since this
takes another transaction. This isn’t necessary for syncing. However
rclone mount needs to know the size of files in advance of reading them,
so setting this flag when using rclone mount is recommended if you want
to read the media.</p>
<p>Properties:</p>
<ul>
<li>Config: read_size</li>
<li>Env Var: RCLONE_GPHOTOS_READ_SIZE</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="gphotos-start-year">–gphotos-start-year</h4>
<p>Year limits the photos to be downloaded to those which are uploaded
after the given year.</p>
<p>Properties:</p>
<ul>
<li>Config: start_year</li>
<li>Env Var: RCLONE_GPHOTOS_START_YEAR</li>
<li>Type: int</li>
<li>Default: 2000</li>
</ul>
<h4 id="gphotos-include-archived">–gphotos-include-archived</h4>
<p>Also view and download archived media.</p>
<p>By default, rclone does not request archived media. Thus, when
syncing, archived media is not visible in directory listings or
transferred.</p>
<p>Note that media in albums is always visible and synced, no matter
their archive status.</p>
<p>With this flag, archived media are always visible in directory
listings and transferred.</p>
<p>Without this flag, archived media will not be visible in directory
listings and won’t be transferred.</p>
<p>Properties:</p>
<ul>
<li>Config: include_archived</li>
<li>Env Var: RCLONE_GPHOTOS_INCLUDE_ARCHIVED</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="gphotos-encoding">–gphotos-encoding</h4>
<p>The encoding for the backend.</p>
<p>See the <a href="https://rclone.org/overview/#encoding">encoding
section in the overview</a> for more info.</p>
<p>Properties:</p>
<ul>
<li>Config: encoding</li>
<li>Env Var: RCLONE_GPHOTOS_ENCODING</li>
<li>Type: MultiEncoder</li>
<li>Default: Slash,CrLf,InvalidUtf8,Dot</li>
</ul>
<h2 id="limitations-13">Limitations</h2>
<p>Only images and videos can be uploaded. If you attempt to upload non
videos or images or formats that Google Photos doesn’t understand,
rclone will upload the file, then Google Photos will give an error when
it is put turned into a media item.</p>
<p>Note that all media items uploaded to Google Photos through the API
are stored in full resolution at “original quality” and
<strong>will</strong> count towards your storage quota in your Google
Account. The API does <strong>not</strong> offer a way to upload in
“high quality” mode..</p>
<p><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.</p>
<p>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></p>
<h3 id="downloading-images">Downloading Images</h3>
<p>When Images are downloaded this strips EXIF location (according to
the docs and my tests). This is a limitation of the Google Photos API
and is covered by <a
href="https://issuetracker.google.com/issues/112096115">bug
#112096115</a>.</p>
<p><strong>The current google API does not allow photos to be downloaded
at original resolution. This is very important if you are, for example,
relying on “Google Photos” as a backup of your photos. You will not be
able to use rclone to redownload original images. You could use ‘google
takeout’ to recover the original photos as a last resort</strong></p>
<h3 id="downloading-videos">Downloading Videos</h3>
<p>When videos are downloaded they are downloaded in a really compressed
version of the video compared to downloading it via the Google Photos
web interface. This is covered by <a
href="https://issuetracker.google.com/issues/113672044">bug
#113672044</a>.</p>
<h3 id="duplicates">Duplicates</h3>
<p>If a file name is duplicated in a directory then rclone will add the
file ID into its name. So two files called <code>file.jpg</code> would
then appear as <code>file {123456}.jpg</code> and
<code>file {ABCDEF}.jpg</code> (the actual IDs are a lot longer
alas!).</p>
<p>If you upload the same image (with the same binary data) twice then
Google Photos will deduplicate it. However it will retain the filename
from the first upload which may confuse rclone. For example if you
uploaded an image to <code>upload</code> then uploaded the same image to
<code>album/my_album</code> the filename of the image in
<code>album/my_album</code> will be what it was uploaded with initially,
not what you uploaded it with to <code>album</code>. In practise this
shouldn’t cause too many problems.</p>
<h3 id="modified-time-5">Modified time</h3>
<p>The date shown of media in Google Photos is the creation date as
determined by the EXIF information, or the upload date if that is not
known.</p>
<p>This is not changeable by rclone and is not the modification date of
the media on local disk. This means that rclone cannot use the dates
from Google Photos for syncing purposes.</p>
<h3 id="size">Size</h3>
<p>The Google Photos API does not return the size of media. This means
that when syncing to Google Photos, rclone can only do a file existence
check.</p>
<p>It is possible to read the size of the media, but this needs an extra
HTTP HEAD request per media item so is <strong>very slow</strong> and
uses up a lot of transactions. This can be enabled with the
<code>--gphotos-read-size</code> option or the
<code>read_size = true</code> config parameter.</p>
<p>If you want to use the backend with <code>rclone mount</code> you may
need to enable this flag (depending on your OS and application using the
photos) otherwise you may not be able to read media off the mount.
You’ll need to experiment to see if it works for you without the
flag.</p>
<h3 id="albums">Albums</h3>
<p>Rclone can only upload files to albums it created. This is a <a
href="https://developers.google.com/photos/library/guides/manage-albums">limitation
of the Google Photos API</a>.</p>
<p>Rclone can remove files it uploaded from albums it created only.</p>
<h3 id="deleting-files-3">Deleting files</h3>
<p>Rclone can remove files from albums it created, but note that the
Google Photos API does not allow media to be deleted permanently so this
media will still remain. See <a
href="https://issuetracker.google.com/issues/109759781">bug
#109759781</a>.</p>
<p>Rclone cannot delete files anywhere except under
<code>album</code>.</p>
<h3 id="deleting-albums">Deleting albums</h3>
<p>The Google Photos API does not support deleting albums - see <a
href="https://issuetracker.google.com/issues/135714733">bug
#135714733</a>.</p>
<h1 id="hasher-experimental">Hasher (EXPERIMENTAL)</h1>
<p>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</p>
<h2 id="getting-started-1">Getting started</h2>
<p>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.</p>
<p>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>.</p>
<p>Now proceed to interactive or manual configuration.</p>
<h3 id="interactive-configuration">Interactive configuration</h3>
<p>Run <code>rclone config</code>:</p>
<pre><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; Hasher1
Type of storage to configure.
Choose a number from below, or type in your own value
[snip]
XX / Handle checksums for other remotes
   \ &quot;hasher&quot;
[snip]
Storage&gt; hasher
Remote to cache checksums for, like myremote:mypath.
Enter a string value. Press Enter for the default (&quot;&quot;).
remote&gt; myRemote:path
Comma separated list of supported checksum types.
Enter a string value. Press Enter for the default (&quot;md5,sha1&quot;).
hashsums&gt; md5
Maximum time to keep checksums in cache. 0 = no cache, off = cache forever.
max_age&gt; off
Edit advanced config? (y/n)
y) Yes
n) No
y/n&gt; n
Remote config
--------------------
[Hasher1]
type = hasher
remote = myRemote:path
hashsums = md5
max_age = off
--------------------
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<h3 id="manual-configuration">Manual configuration</h3>
<p>Run <code>rclone config path</code> to see the path of current active
config file, usually <code>YOURHOME/.config/rclone/rclone.conf</code>.
Open it in your favorite text editor, find section for the base remote
and create new section for hasher like in the following examples:</p>
<pre><code>[Hasher1]
type = hasher
remote = myRemote:path
hashes = md5
max_age = off

[Hasher2]
type = hasher
remote = /local/path
hashes = dropbox,sha1
max_age = 24h</code></pre>
<p>Hasher takes basically the following parameters: -
<code>remote</code> is required, - <code>hashes</code> is a comma
separated list of supported checksums (by default
<code>md5,sha1</code>), - <code>max_age</code> - maximum time to keep a
checksum value in the cache, <code>0</code> will disable caching
completely, <code>off</code> will cache “forever” (that is until the
files get changed).</p>
<p>Make sure the <code>remote</code> has <code>:</code> (colon) in. If
you specify the remote without a colon then rclone will use a local
directory of that name. So if you use a remote of
<code>/local/path</code> then rclone will handle hashes for that
directory. If you use <code>remote = name</code> literally then rclone
will put files <strong>in a directory called <code>name</code> located
under current directory</strong>.</p>
<h2 id="usage-1">Usage</h2>
<h3 id="basic-operations">Basic operations</h3>
<p>Now you can use it as <code>Hasher2:subdir/file</code> instead of
base remote. Hasher will transparently update cache with new checksums
when a file is fully read or overwritten, like:</p>
<pre><code>rclone copy External:path/file Hasher:dest/path

rclone cat Hasher:path/to/file &gt; /dev/null</code></pre>
<p>The way to refresh <strong>all</strong> cached checksums (even
unsupported by the base backend) for a subtree is to
<strong>re-download</strong> all files in the subtree. For example, use
<code>hashsum --download</code> using <strong>any</strong> supported
hashsum on the command line (we just care to re-read):</p>
<pre><code>rclone hashsum MD5 --download Hasher:path/to/subtree &gt; /dev/null

rclone backend dump Hasher:path/to/subtree</code></pre>
<p>You can print or drop hashsum cache using custom backend
commands:</p>
<pre><code>rclone backend dump Hasher:dir/subdir

rclone backend drop Hasher:</code></pre>
<h3 id="pre-seed-from-a-sum-file">Pre-Seed from a SUM File</h3>
<p>Hasher supports two backend commands: generic SUM file
<code>import</code> and faster but less consistent
<code>stickyimport</code>.</p>
<pre><code>rclone backend import Hasher:dir/subdir SHA1 /path/to/SHA1SUM [--checkers 4]</code></pre>
<p>Instead of SHA1 it can be any hash supported by the remote. The last
argument can point to either a local or an
<code>other-remote:path</code> text file in SUM format. The command will
parse the SUM file, then walk down the path given by the first argument,
snapshot current fingerprints and fill in the cache entries
correspondingly. - Paths in the SUM file are treated as relative to
<code>hasher:dir/subdir</code>. - The command will <strong>not</strong>
check that supplied values are correct. You <strong>must know</strong>
what you are doing. - This is a one-time action. The SUM file will not
get “attached” to the remote. Cache entries can still be overwritten
later, should the object’s fingerprint change. - The tree walk can take
long depending on the tree size. You can increase
<code>--checkers</code> to make it faster. Or use
<code>stickyimport</code> if you don’t care about fingerprints and
consistency.</p>
<pre><code>rclone backend stickyimport hasher:path/to/data sha1 remote:/path/to/sum.sha1</code></pre>
<p><code>stickyimport</code> is similar to <code>import</code> but works
much faster because it does not need to stat existing files and skips
initial tree walk. Instead of binding cache entries to file fingerprints
it creates <em>sticky</em> entries bound to the file name alone ignoring
size, modification time etc. Such hash entries can be replaced only by
<code>purge</code>, <code>delete</code>, <code>backend drop</code> or by
full re-read/re-write of the files.</p>
<h2 id="configuration-reference">Configuration reference</h2>
<h3 id="standard-options-18">Standard options</h3>
<p>Here are the Standard options specific to hasher (Better checksums
for other remotes).</p>
<h4 id="hasher-remote">–hasher-remote</h4>
<p>Remote to cache checksums for (e.g. myRemote:path).</p>
<p>Properties:</p>
<ul>
<li>Config: remote</li>
<li>Env Var: RCLONE_HASHER_REMOTE</li>
<li>Type: string</li>
<li>Required: true</li>
</ul>
<h4 id="hasher-hashes">–hasher-hashes</h4>
<p>Comma separated list of supported checksum types.</p>
<p>Properties:</p>
<ul>
<li>Config: hashes</li>
<li>Env Var: RCLONE_HASHER_HASHES</li>
<li>Type: CommaSepList</li>
<li>Default: md5,sha1</li>
</ul>
<h4 id="hasher-max-age">–hasher-max-age</h4>
<p>Maximum time to keep checksums in cache (0 = no cache, off = cache
forever).</p>
<p>Properties:</p>
<ul>
<li>Config: max_age</li>
<li>Env Var: RCLONE_HASHER_MAX_AGE</li>
<li>Type: Duration</li>
<li>Default: off</li>
</ul>
<h3 id="advanced-options-16">Advanced options</h3>
<p>Here are the Advanced options specific to hasher (Better checksums
for other remotes).</p>
<h4 id="hasher-auto-size">–hasher-auto-size</h4>
<p>Auto-update checksum for files smaller than this size (disabled by
default).</p>
<p>Properties:</p>
<ul>
<li>Config: auto_size</li>
<li>Env Var: RCLONE_HASHER_AUTO_SIZE</li>
<li>Type: SizeSuffix</li>
<li>Default: 0</li>
</ul>
<h3 id="metadata-7">Metadata</h3>
<p>Any metadata supported by the underlying remote is read and
written.</p>
<p>See the <a href="https://rclone.org/docs/#metadata">metadata</a> docs
for more info.</p>
<h2 id="backend-commands-4">Backend commands</h2>
<p>Here are the commands specific to the hasher backend.</p>
<p>Run them with</p>
<pre><code>rclone backend COMMAND remote:</code></pre>
<p>The help below will explain what arguments each command takes.</p>
<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>
<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>
<h3 id="drop">drop</h3>
<p>Drop cache</p>
<pre><code>rclone backend drop remote: [options] [&lt;arguments&gt;+]</code></pre>
<p>Completely drop checksum cache. Usage Example: rclone backend drop
hasher:</p>
<h3 id="dump">dump</h3>
<p>Dump the database</p>
<pre><code>rclone backend dump remote: [options] [&lt;arguments&gt;+]</code></pre>
<p>Dump cache records covered by the current remote</p>
<h3 id="fulldump">fulldump</h3>
<p>Full dump of the database</p>
<pre><code>rclone backend fulldump remote: [options] [&lt;arguments&gt;+]</code></pre>
<p>Dump all cache records in the database</p>
<h3 id="import">import</h3>
<p>Import a SUM file</p>
<pre><code>rclone backend import remote: [options] [&lt;arguments&gt;+]</code></pre>
<p>Amend hash cache from a SUM file and bind checksums to files by
size/time. Usage Example: rclone backend import hasher:subdir md5
/path/to/sum.md5</p>
<h3 id="stickyimport">stickyimport</h3>
<p>Perform fast import of a SUM file</p>
<pre><code>rclone backend stickyimport remote: [options] [&lt;arguments&gt;+]</code></pre>
<p>Fill hash cache from a SUM file without verifying file fingerprints.
Usage Example: rclone backend stickyimport hasher:subdir md5
remote:path/to/sum.md5</p>
<h2 id="implementation-details-advanced">Implementation details
(advanced)</h2>
<p>This section explains how various rclone operations work on a hasher
remote.</p>
<p><strong>Disclaimer. This section describes current implementation
which can change in future rclone versions!.</strong></p>
<h3 id="hashsum-command">Hashsum command</h3>
<p>The <code>rclone hashsum</code> (or <code>md5sum</code> or
<code>sha1sum</code>) command will:</p>
<ol type="1">
<li>if requested hash is supported by lower level, just pass it.</li>
<li>if object size is below <code>auto_size</code> then download object
and calculate <em>requested</em> hashes on the fly.</li>
<li>if unsupported and the size is big enough, build object
<code>fingerprint</code> (including size, modtime if supported,
first-found <em>other</em> hash if any).</li>
<li>if the strict match is found in cache for the requested remote,
return the stored hash.</li>
<li>if remote found but fingerprint mismatched, then purge the entry and
proceed to step 6.</li>
<li>if remote not found or had no requested hash type or after step 5:
download object, calculate all <em>supported</em> hashes on the fly and
store in cache; return requested hash.</li>
</ol>
<h3 id="other-operations">Other operations</h3>
<ul>
<li>whenever a file is uploaded or downloaded <strong>in full</strong>,
capture the stream to calculate all supported hashes on the fly and
update database</li>
<li>server-side <code>move</code> will update keys of existing cache
entries</li>
<li><code>deletefile</code> will remove a single cache entry</li>
<li><code>purge</code> will remove all cache entries under the purged
path</li>
</ul>
<p>Note that setting <code>max_age = 0</code> will disable checksum
caching completely.</p>
<p>If you set <code>max_age = off</code>, checksums in cache will never
age, unless you fully rewrite or delete the file.</p>
<h3 id="cache-storage">Cache storage</h3>
<p>Cached checksums are stored as <code>bolt</code> database files under
rclone cache directory, usually <code>~/.cache/rclone/kv/</code>.
Databases are maintained one per <em>base</em> backend, named like
<code>BaseRemote~hasher.bolt</code>. Checksums for multiple
<code>alias</code>-es into a single base backend will be stored in the
single database. All local paths are treated as aliases into the
<code>local</code> backend (unless crypted or chunked) and stored in
<code>~/.cache/rclone/kv/local~hasher.bolt</code>. Databases can be
shared between multiple rclone processes.</p>
<h1 id="hdfs">HDFS</h1>
<p><a
href="https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-hdfs/HdfsDesign.html">HDFS</a>
is a distributed file-system, part of the <a
href="https://hadoop.apache.org/">Apache Hadoop</a> framework.</p>
<p>Paths are specified as <code>remote:</code> or
<code>remote:path/to/dir</code>.</p>
<h2 id="configuration-18">Configuration</h2>
<p>Here is an example of how to make a remote called
<code>remote</code>. First run:</p>
<pre><code> rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<pre><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; remote
Type of storage to configure.
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
[skip]
XX / Hadoop distributed file system
   \ &quot;hdfs&quot;
[skip]
Storage&gt; hdfs
** See help for hdfs backend at: https://rclone.org/hdfs/ **

hadoop name node and port
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
 1 / Connect to host namenode at port 8020
   \ &quot;namenode:8020&quot;
namenode&gt; namenode.hadoop:8020
hadoop user name
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
 1 / Connect to hdfs as root
   \ &quot;root&quot;
username&gt; root
Edit advanced config? (y/n)
y) Yes
n) No (default)
y/n&gt; 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&gt; y
Current remotes:

Name                 Type
====                 ====
hadoop               hdfs

rclone lsd remote:/users/test/path</code></pre>
<p>See the below section about configuration options for more
details.</p>
<h3 id="directory-member-count">Directory member count</h3>
<p>By default, rclone will know the number of directory members
contained in a directory. For example, <code>rclone lsd</code> uses this
information.</p>
<p>The acquisition of this information will result in additional time
costs for HiDrive’s API. When dealing with large directory structures,
it may be desirable to circumvent this time cost, especially when this
information is not explicitly needed. For this, the
<code>disable_fetching_member_count</code> option can be used.</p>
<p>See the below section about configuration options for more
details.</p>
<h3 id="standard-options-20">Standard options</h3>
<p>Here are the Standard options specific to hidrive (HiDrive).</p>
<h4 id="hidrive-client-id">–hidrive-client-id</h4>
<p>OAuth Client Id.</p>
<p>Leave blank normally.</p>
<p>Properties:</p>
<ul>
<li>Config: client_id</li>
<li>Env Var: RCLONE_HIDRIVE_CLIENT_ID</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="hidrive-client-secret">–hidrive-client-secret</h4>
<p>OAuth Client Secret.</p>
<p>Leave blank normally.</p>
<p>Properties:</p>
<ul>
<li>Config: client_secret</li>
<li>Env Var: RCLONE_HIDRIVE_CLIENT_SECRET</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="hidrive-scope-access">–hidrive-scope-access</h4>
<p>Access permissions that rclone should use when requesting access from
HiDrive.</p>
<p>Properties:</p>
<ul>
<li>Config: scope_access</li>
<li>Env Var: RCLONE_HIDRIVE_SCOPE_ACCESS</li>
<li>Type: string</li>
<li>Default: “rw”</li>
<li>Examples:
<ul>
<li>“rw”
<ul>
<li>Read and write access to resources.</li>
</ul></li>
<li>“ro”
<ul>
<li>Read-only access to resources.</li>
</ul></li>
</ul></li>
</ul>
<h3 id="advanced-options-18">Advanced options</h3>
<p>Here are the Advanced options specific to hidrive (HiDrive).</p>
<h4 id="hidrive-token">–hidrive-token</h4>
<p>OAuth Access Token as a JSON blob.</p>
<p>Properties:</p>
<ul>
<li>Config: token</li>
<li>Env Var: RCLONE_HIDRIVE_TOKEN</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="hidrive-auth-url">–hidrive-auth-url</h4>
<p>Auth server URL.</p>
<p>Leave blank to use the provider defaults.</p>
<p>Properties:</p>
<ul>
<li>Config: auth_url</li>
<li>Env Var: RCLONE_HIDRIVE_AUTH_URL</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="hidrive-token-url">–hidrive-token-url</h4>
<p>Token server url.</p>
<p>Leave blank to use the provider defaults.</p>
<p>Properties:</p>
<ul>
<li>Config: token_url</li>
<li>Env Var: RCLONE_HIDRIVE_TOKEN_URL</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="hidrive-scope-role">–hidrive-scope-role</h4>
<p>User-level that rclone should use when requesting access from
HiDrive.</p>
<p>Properties:</p>
<ul>
<li>Config: scope_role</li>
<li>Env Var: RCLONE_HIDRIVE_SCOPE_ROLE</li>
<li>Type: string</li>
<li>Default: “user”</li>
<li>Examples:
<ul>
<li>“user”
<ul>
<li>User-level access to management permissions.</li>
<li>This will be sufficient in most cases.</li>
</ul></li>
<li>“admin”
<ul>
<li>Extensive access to management permissions.</li>
</ul></li>
<li>“owner”
<ul>
<li>Full access to management permissions.</li>
</ul></li>
</ul></li>
</ul>
<h4 id="hidrive-root-prefix">–hidrive-root-prefix</h4>
<p>The root/parent folder for all paths.</p>
<p>Fill in to use the specified folder as the parent for all paths given
to the remote. This way rclone can use any folder as its starting
point.</p>
<p>Properties:</p>
<ul>
<li>Config: root_prefix</li>
<li>Env Var: RCLONE_HIDRIVE_ROOT_PREFIX</li>
<li>Type: string</li>
<li>Default: “/”</li>
<li>Examples:
<ul>
<li>“/”
<ul>
<li>The topmost directory accessible by rclone.</li>
<li>This will be equivalent with “root” if rclone uses a regular HiDrive
user account.</li>
</ul></li>
<li>“root”
<ul>
<li>The topmost directory of the HiDrive user account</li>
</ul></li>
<li>“”
<ul>
<li>This specifies that there is no root-prefix for your paths.</li>
<li>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”.</li>
</ul></li>
</ul></li>
</ul>
<h4 id="hidrive-endpoint">–hidrive-endpoint</h4>
<p>Endpoint for the service.</p>
<p>This is the URL that API-calls will be made to.</p>
<p>Properties:</p>
<ul>
<li>Config: endpoint</li>
<li>Env Var: RCLONE_HIDRIVE_ENDPOINT</li>
<li>Type: string</li>
<li>Default: “https://api.hidrive.strato.com/2.1”</li>
</ul>
<h4
id="hidrive-disable-fetching-member-count">–hidrive-disable-fetching-member-count</h4>
<p>Do not fetch number of objects in directories unless it is absolutely
necessary.</p>
<p>Requests may be faster if the number of objects in subdirectories is
not fetched.</p>
<p>Properties:</p>
<ul>
<li>Config: disable_fetching_member_count</li>
<li>Env Var: RCLONE_HIDRIVE_DISABLE_FETCHING_MEMBER_COUNT</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="hidrive-chunk-size">–hidrive-chunk-size</h4>
<p>Chunksize for chunked uploads.</p>
<p>Any files larger than the configured cutoff (or files of unknown
size) will be uploaded in chunks of this size.</p>
<p>The upper limit for this is 2147483647 bytes (about 2.000Gi). That is
the maximum amount of bytes a single upload-operation will support.
Setting this above the upper limit or to a negative value will cause
uploads to fail.</p>
<p>Setting this to larger values may increase the upload speed at the
cost of using more memory. It can be set to smaller values smaller to
save on memory.</p>
<p>Properties:</p>
<ul>
<li>Config: chunk_size</li>
<li>Env Var: RCLONE_HIDRIVE_CHUNK_SIZE</li>
<li>Type: SizeSuffix</li>
<li>Default: 48Mi</li>
</ul>
<h4 id="hidrive-upload-cutoff">–hidrive-upload-cutoff</h4>
<p>Cutoff/Threshold for chunked uploads.</p>
<p>Any files larger than this will be uploaded in chunks of the
configured chunksize.</p>
<p>The upper limit for this is 2147483647 bytes (about 2.000Gi). That is
the maximum amount of bytes a single upload-operation will support.
Setting this above the upper limit will cause uploads to fail.</p>
<p>Properties:</p>
<ul>
<li>Config: upload_cutoff</li>
<li>Env Var: RCLONE_HIDRIVE_UPLOAD_CUTOFF</li>
<li>Type: SizeSuffix</li>
<li>Default: 96Mi</li>
</ul>
<h4 id="hidrive-upload-concurrency">–hidrive-upload-concurrency</h4>
<p>Concurrency for chunked uploads.</p>
<p>This is the upper limit for how many transfers for the same file are
running concurrently. Setting this above to a value smaller than 1 will
cause uploads to deadlock.</p>
<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>
<p>Properties:</p>
<ul>
<li>Config: upload_concurrency</li>
<li>Env Var: RCLONE_HIDRIVE_UPLOAD_CONCURRENCY</li>
<li>Type: int</li>
<li>Default: 4</li>
</ul>
<h4 id="hidrive-encoding">–hidrive-encoding</h4>
<p>The encoding for the backend.</p>
<p>See the <a href="https://rclone.org/overview/#encoding">encoding
section in the overview</a> for more info.</p>
<p>Properties:</p>
<ul>
<li>Config: encoding</li>
<li>Env Var: RCLONE_HIDRIVE_ENCODING</li>
<li>Type: MultiEncoder</li>
<li>Default: Slash,Dot</li>
</ul>
<h2 id="limitations-15">Limitations</h2>
<h3 id="symbolic-links">Symbolic links</h3>
<p>HiDrive is able to store symbolic links (<em>symlinks</em>) by
design, for example, when unpacked from a zip archive.</p>
<p>There exists no direct mechanism to manage native symlinks in
remotes. As such this implementation has chosen to ignore any native
symlinks present in the remote. rclone will not be able to access or
show any symlinks stored in the hidrive-remote. This means symlinks
cannot be individually removed, copied, or moved, except when removing,
copying, or moving the parent folder.</p>
<p><em>This does not affect the <code>.rclonelink</code>-files that
rclone uses to encode and store symbolic links.</em></p>
<h3 id="sparse-files">Sparse files</h3>
<p>It is possible to store sparse files in HiDrive.</p>
<p>Note that copying a sparse file will expand the holes into null-byte
(0x00) regions that will then consume disk space. Likewise, when
downloading a sparse file, the resulting file will have null-byte
regions in the place of file holes.</p>
<h1 id="http">HTTP</h1>
<p>The HTTP remote is a read only remote for reading files of a
webserver. The webserver should provide file listings which rclone will
read and turn into a remote. This has been tested with common webservers
such as Apache/Nginx/Caddy and will likely work with file listings from
most web servers. (If it doesn’t then please file an issue, or send a
pull request!)</p>
<p>Paths are specified as <code>remote:</code> or
<code>remote:path</code>.</p>
<p>The <code>remote:</code> represents the configured <a
href="#http-url">url</a>, and any path following it will be resolved
relative to this url, according to the URL standard. This means with
remote url <code>https://beta.rclone.org/branch</code> and path
<code>fix</code>, the resolved URL will be
<code>https://beta.rclone.org/branch/fix</code>, while with path
<code>/fix</code> the resolved URL will be
<code>https://beta.rclone.org/fix</code> as the absolute path is
resolved from the root of the domain.</p>
<p>If the path following the <code>remote:</code> ends with
<code>/</code> it will be assumed to point to a directory. If the path
does not end with <code>/</code>, then a HEAD request is sent and the
response used to decide if it it is treated as a file or a directory
(run with <code>-vv</code> to see details). When <a
href="#http-no-head">–http-no-head</a> is specified, a path without
ending <code>/</code> is always assumed to be a file. If rclone
incorrectly assumes the path is a file, the solution is to specify the
path with ending <code>/</code>. When you know the path is a directory,
ending it with <code>/</code> is always better as it avoids the initial
HEAD request.</p>
<p>To just download a single file it is easier to use <a
href="https://rclone.org/commands/rclone_copyurl/">copyurl</a>.</p>
<h2 id="configuration-20">Configuration</h2>
<p>Here is an example of how to make a remote called
<code>remote</code>. First run:</p>
<pre><code> rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<pre><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; remote
Type of storage to configure.
Choose a number from below, or type in your own value
[snip]
XX / HTTP
   \ &quot;http&quot;
[snip]
Storage&gt; http
URL of http host to connect to
Choose a number from below, or type in your own value
 1 / Connect to example.com
   \ &quot;https://example.com&quot;
url&gt; 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&gt; y
Current remotes:

Name                 Type
====                 ====
remote               http

e) Edit existing remote
n) New remote
d) Delete remote
r) Rename remote
c) Copy remote
s) Set configuration password
q) Quit config
e/n/d/r/c/s/q&gt; q</code></pre>
<p>This remote is called <code>remote</code> and can now be used like
this</p>
<p>See all the top level directories</p>
<pre><code>rclone lsd remote:</code></pre>
<p>List the contents of a directory</p>
<pre><code>rclone ls remote:directory</code></pre>
<p>Sync the remote <code>directory</code> to
<code>/home/local/directory</code>, deleting any excess files.</p>
<pre><code>rclone sync -i remote:directory /home/local/directory</code></pre>
<h3 id="read-only">Read only</h3>
<p>This remote is read only - you can’t upload files to an HTTP
server.</p>
<h3 id="modified-time-7">Modified time</h3>
<p>Most HTTP servers store time accurate to 1 second.</p>
<h3 id="checksum-1">Checksum</h3>
<p>No checksums are stored.</p>
<h3 id="usage-without-a-config-file">Usage without a config file</h3>
<p>Since the http remote only has one config parameter it is easy to use
without a config file:</p>
<pre><code>rclone lsd --http-url https://beta.rclone.org :http:</code></pre>
<p>or:</p>
<pre><code>rclone lsd :http,url=&#39;https://beta.rclone.org&#39;:</code></pre>
<h3 id="standard-options-21">Standard options</h3>
<p>Here are the Standard options specific to http (HTTP).</p>
<h4 id="http-url">–http-url</h4>
<p>URL of HTTP host to connect to.</p>
<p>E.g. “https://example.com”, or “https://user:pass@example.com” to use
a username and password.</p>
<p>Properties:</p>
<ul>
<li>Config: url</li>
<li>Env Var: RCLONE_HTTP_URL</li>
<li>Type: string</li>
<li>Required: true</li>
</ul>
<h3 id="advanced-options-19">Advanced options</h3>
<p>Here are the Advanced options specific to http (HTTP).</p>
<h4 id="http-headers">–http-headers</h4>
<p>Set HTTP headers for all transactions.</p>
<p>Use this to set additional HTTP headers for all transactions.</p>
<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>
<p>For example, to set a Cookie use ‘Cookie,name=value’, or
‘“Cookie”,“name=value”’.</p>
<p>You can set multiple headers,
e.g. ‘“Cookie”,“name=value”,“Authorization”,“xxx”’.</p>
<p>Properties:</p>
<ul>
<li>Config: headers</li>
<li>Env Var: RCLONE_HTTP_HEADERS</li>
<li>Type: CommaSepList</li>
<li>Default:</li>
</ul>
<h4 id="http-no-slash">–http-no-slash</h4>
<p>Set this if the site doesn’t end directories with /.</p>
<p>Use this if your target website does not use / on the end of
directories.</p>
<p>A / on the end of a path is how rclone normally tells the difference
between files and directories. If this flag is set, then rclone will
treat all files with Content-Type: text/html as directories and read
URLs from them rather than downloading them.</p>
<p>Note that this may cause rclone to confuse genuine HTML files with
directories.</p>
<p>Properties:</p>
<ul>
<li>Config: no_slash</li>
<li>Env Var: RCLONE_HTTP_NO_SLASH</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="http-no-head">–http-no-head</h4>
<p>Don’t use HEAD requests.</p>
<p>HEAD requests are mainly used to find file sizes in dir listing. If
your site is being very slow to load then you can try this option.
Normally rclone does a HEAD request for each potential file in a
directory listing to:</p>
<ul>
<li>find its size</li>
<li>check it really exists</li>
<li>check to see if it is a directory</li>
</ul>
<p>If you set this option, rclone will not do the HEAD request. This
will mean that directory listings are much quicker, but rclone won’t
have the times or sizes of any files, and some files that don’t exist
may be in the listing.</p>
<p>Properties:</p>
<ul>
<li>Config: no_head</li>
<li>Env Var: RCLONE_HTTP_NO_HEAD</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h2 id="limitations-16">Limitations</h2>
<p><code>rclone about</code> is not supported by the HTTP 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>
<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>
<h1 id="internet-archive">Internet Archive</h1>
<p>The Internet Archive backend utilizes Items on <a
href="https://archive.org/">archive.org</a></p>
<p>Refer to <a
href="https://archive.org/services/docs/api/ias3.html">IAS3 API
documentation</a> for the API this backend uses.</p>
<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:item/path/to/dir</code>.</p>
<p>Unlike S3, listing up all items uploaded by you isn’t supported.</p>
<p>Once you have made a remote, you can use it like this:</p>
<p>Make a new item</p>
<pre><code>rclone mkdir remote:item</code></pre>
<p>List the contents of a item</p>
<pre><code>rclone ls remote:item</code></pre>
<p>Sync <code>/home/local/directory</code> to the remote item, deleting
any excess files in the item.</p>
<pre><code>rclone sync -i /home/local/directory remote:item</code></pre>
<h2 id="notes-1">Notes</h2>
<p>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. The per-item queue is enqueued to an another queue, Item
Deriver Queue. <a
href="https://catalogd.archive.org/catalog.php?whereami=1">You can check
the status of Item Deriver Queue here.</a> 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.</p>
<p>You can optionally wait for the server’s processing to finish, by
setting non-zero value to <code>wait_archive</code> key. By making it
wait, rclone can do normal file comparison. Make sure to set a large
enough value (e.g. <code>30m0s</code> for smaller files) as it can take
a long time depending on server’s queue.</p>
<h2 id="about-metadata">About metadata</h2>
<p>This backend supports setting, updating and reading metadata of each
file. The metadata will appear as file metadata on Internet Archive.
However, some fields are reserved by both Internet Archive and
rclone.</p>
<p>The following are reserved by Internet Archive: - <code>name</code> -
<code>source</code> - <code>size</code> - <code>md5</code> -
<code>crc32</code> - <code>sha1</code> - <code>format</code> -
<code>old_version</code> - <code>viruscheck</code> -
<code>summation</code></p>
<p>Trying to set values to these keys is ignored with a warning. Only
setting <code>mtime</code> is an exception. Doing so make it the
identical behavior as setting ModTime.</p>
<p>rclone reserves all the keys starting with <code>rclone-</code>.
Setting value for these keys will give you warnings, but values are set
according to request.</p>
<p>If there are multiple values for a key, only the first one is
returned. This is a limitation of rclone, that supports one value per
one key. It can be triggered when you did a server-side copy.</p>
<p>Reading metadata will also provide custom (non-standard nor reserved)
ones.</p>
<h2 id="configuration-21">Configuration</h2>
<p>Here is an example of making an internetarchive configuration. Most
applies to the other providers as well, any differences are described <a
href="#providers">below</a>.</p>
<p>First run</p>
<pre><code>rclone config</code></pre>
<p>This will guide you through an interactive setup process.</p>
<pre><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; remote
Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
XX / InternetArchive Items
   \ (internetarchive)
Storage&gt; 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&gt; 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&gt; XXXX
Edit advanced config?
y) Yes
n) No (default)
y/n&gt; 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&gt; 
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&gt; 
Option disable_checksum.
Don&#39;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&gt; true
Option encoding.
The encoding for the backend.
See the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info.
Enter a encoder.MultiEncoder value. Press Enter for the default (Slash,Question,Hash,Percent,Del,Ctl,InvalidUtf8,Dot).
encoding&gt; 
Edit advanced config?
y) Yes
n) No (default)
y/n&gt; 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&gt; y</code></pre>
<h3 id="standard-options-22">Standard options</h3>
<p>Here are the Standard options specific to internetarchive (Internet
Archive).</p>
<h4
id="internetarchive-access-key-id">–internetarchive-access-key-id</h4>
<p>IAS3 Access Key.</p>
<p>Leave blank for anonymous access. You can find one here:
https://archive.org/account/s3.php</p>
<p>Properties:</p>
<ul>
<li>Config: access_key_id</li>
<li>Env Var: RCLONE_INTERNETARCHIVE_ACCESS_KEY_ID</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4
id="internetarchive-secret-access-key">–internetarchive-secret-access-key</h4>
<p>IAS3 Secret Key (password).</p>
<p>Leave blank for anonymous access.</p>
<p>Properties:</p>
<ul>
<li>Config: secret_access_key</li>
<li>Env Var: RCLONE_INTERNETARCHIVE_SECRET_ACCESS_KEY</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h3 id="advanced-options-20">Advanced options</h3>
<p>Here are the Advanced options specific to internetarchive (Internet
Archive).</p>
<h4 id="internetarchive-endpoint">–internetarchive-endpoint</h4>
<p>IAS3 Endpoint.</p>
<p>Leave blank for default value.</p>
<p>Properties:</p>
<ul>
<li>Config: endpoint</li>
<li>Env Var: RCLONE_INTERNETARCHIVE_ENDPOINT</li>
<li>Type: string</li>
<li>Default: “https://s3.us.archive.org”</li>
</ul>
<h4
id="internetarchive-front-endpoint">–internetarchive-front-endpoint</h4>
<p>Host of InternetArchive Frontend.</p>
<p>Leave blank for default value.</p>
<p>Properties:</p>
<ul>
<li>Config: front_endpoint</li>
<li>Env Var: RCLONE_INTERNETARCHIVE_FRONT_ENDPOINT</li>
<li>Type: string</li>
<li>Default: “https://archive.org”</li>
</ul>
<h4
id="internetarchive-disable-checksum">–internetarchive-disable-checksum</h4>
<p>Don’t ask the server to test against MD5 checksum calculated by
rclone. Normally rclone will calculate the MD5 checksum of the input
before uploading it so it can ask the server to check the object against
checksum. This is great for data integrity checking but can cause long
delays for large files to start uploading.</p>
<p>Properties:</p>
<ul>
<li>Config: disable_checksum</li>
<li>Env Var: RCLONE_INTERNETARCHIVE_DISABLE_CHECKSUM</li>
<li>Type: bool</li>
<li>Default: true</li>
</ul>
<h4 id="internetarchive-wait-archive">–internetarchive-wait-archive</h4>
<p>Timeout for waiting the server’s processing tasks (specifically
archive and book_op) to finish. Only enable if you need to be guaranteed
to be reflected after write operations. 0 to disable waiting. No errors
to be thrown in case of timeout.</p>
<p>Properties:</p>
<ul>
<li>Config: wait_archive</li>
<li>Env Var: RCLONE_INTERNETARCHIVE_WAIT_ARCHIVE</li>
<li>Type: Duration</li>
<li>Default: 0s</li>
</ul>
<h4 id="internetarchive-encoding">–internetarchive-encoding</h4>
<p>The encoding for the backend.</p>
<p>See the <a href="https://rclone.org/overview/#encoding">encoding
section in the overview</a> for more info.</p>
<p>Properties:</p>
<ul>
<li>Config: encoding</li>
<li>Env Var: RCLONE_INTERNETARCHIVE_ENCODING</li>
<li>Type: MultiEncoder</li>
<li>Default: Slash,LtGt,CrLf,Del,Ctl,InvalidUtf8,Dot</li>
</ul>
<h3 id="metadata-8">Metadata</h3>
<p>Metadata fields provided by Internet Archive. If there are multiple
values for a key, only the first one is returned. This is a limitation
of Rclone, that supports one value per one key.</p>
<p>Owner is able to add custom keys. Metadata feature grabs all the keys
including them.</p>
<p>Here are the possible system metadata items for the internetarchive
backend.</p>
<table>
<colgroup>
<col style="width: 15%" />
<col style="width: 15%" />
<col style="width: 15%" />
<col style="width: 23%" />
<col style="width: 28%" />
</colgroup>
<thead>
<tr class="header">
<th>Name</th>
<th>Help</th>
<th>Type</th>
<th>Example</th>
<th>Read Only</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>crc32</td>
<td>CRC32 calculated by Internet Archive</td>
<td>string</td>
<td>01234567</td>
<td><strong>Y</strong></td>
</tr>
<tr class="even">
<td>format</td>
<td>Name of format identified by Internet Archive</td>
<td>string</td>
<td>Comma-Separated Values</td>
<td><strong>Y</strong></td>
</tr>
<tr class="odd">
<td>md5</td>
<td>MD5 hash calculated by Internet Archive</td>
<td>string</td>
<td>01234567012345670123456701234567</td>
<td><strong>Y</strong></td>
</tr>
<tr class="even">
<td>mtime</td>
<td>Time of last modification, managed by Rclone</td>
<td>RFC 3339</td>
<td>2006-01-02T15:04:05.999999999Z</td>
<td><strong>Y</strong></td>
</tr>
<tr class="odd">
<td>name</td>
<td>Full file path, without the bucket part</td>
<td>filename</td>
<td>backend/internetarchive/internetarchive.go</td>
<td><strong>Y</strong></td>
</tr>
<tr class="even">
<td>old_version</td>
<td>Whether the file was replaced and moved by keep-old-version
flag</td>
<td>boolean</td>
<td>true</td>
<td><strong>Y</strong></td>
</tr>
<tr class="odd">
<td>rclone-ia-mtime</td>
<td>Time of last modification, managed by Internet Archive</td>
<td>RFC 3339</td>
<td>2006-01-02T15:04:05.999999999Z</td>
<td>N</td>
</tr>
<tr class="even">
<td>rclone-mtime</td>
<td>Time of last modification, managed by Rclone</td>
<td>RFC 3339</td>
<td>2006-01-02T15:04:05.999999999Z</td>
<td>N</td>
</tr>
<tr class="odd">
<td>rclone-update-track</td>
<td>Random value used by Rclone for tracking changes inside Internet
Archive</td>
<td>string</td>
<td>aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa</td>
<td>N</td>
</tr>
<tr class="even">
<td>sha1</td>
<td>SHA1 hash calculated by Internet Archive</td>
<td>string</td>
<td>0123456701234567012345670123456701234567</td>
<td><strong>Y</strong></td>
</tr>
<tr class="odd">
<td>size</td>
<td>File size in bytes</td>
<td>decimal number</td>
<td>123456</td>
<td><strong>Y</strong></td>
</tr>
<tr class="even">
<td>source</td>
<td>The source of the file</td>
<td>string</td>
<td>original</td>
<td><strong>Y</strong></td>
</tr>
<tr class="odd">
<td>summation</td>
<td>Check https://forum.rclone.org/t/31922 for how it is used</td>
<td>string</td>
<td>md5</td>
<td><strong>Y</strong></td>
</tr>
<tr class="even">
<td>viruscheck</td>
<td>The last time viruscheck process was run for the file (?)</td>
<td>unixtime</td>
<td>1654191352</td>
<td><strong>Y</strong></td>
</tr>
</tbody>
</table>
<p>See the <a href="https://rclone.org/docs/#metadata">metadata</a> docs
for more info.</p>
<h1 id="jottacloud">Jottacloud</h1>
<p>Jottacloud is a cloud storage service provider from a Norwegian
company, using its own datacenters in Norway. In addition to the
official service at <a
href="https://www.jottacloud.com/">jottacloud.com</a>, it also provides
white-label solutions to different companies, such as: * Telia * Telia
Cloud (cloud.telia.se) * Telia Sky (sky.telia.no) * Tele2 * Tele2 Cloud
(mittcloud.tele2.se) * Elkjøp (with subsidiaries): * Elkjøp Cloud
(cloud.elkjop.no) * Elgiganten Sweden (cloud.elgiganten.se) * Elgiganten
Denmark (cloud.elgiganten.dk) * Giganti Cloud (cloud.gigantti.fi) * ELKO
Cloud (cloud.elko.is)</p>
<p>Most of the white-label versions are supported by this backend,
although may require different authentication setup - described
below.</p>
<p>Paths are specified as <code>remote:path</code></p>
<p>Paths may be as deep as required,
e.g. <code>remote:directory/subdirectory</code>.</p>
<h2 id="authentication-types">Authentication types</h2>
<p>Some of the whitelabel versions uses a different authentication
method than the official service, and you have to choose the correct one
when setting up the remote.</p>
<h3 id="standard-authentication">Standard authentication</h3>
<p>The standard authentication method used by the official service
(jottacloud.com), as well as some of the whitelabel services, requires
you to generate a single-use personal login token from the account
security settings in the service’s web interface. Log in to your
account, go to “Settings” and then “Security”, or use the direct link
presented to you by rclone when configuring the remote: <a
href="https://www.jottacloud.com/web/secure"
class="uri">https://www.jottacloud.com/web/secure</a>. Scroll down to
the section “Personal login token”, and click the “Generate” button.
Note that if you are using a whitelabel service you probably can’t use
the direct link, you need to find the same page in their dedicated web
interface, and also it may be in a different location than described
above.</p>
<p>To access your account from multiple instances of rclone, you need to
configure each of them with a separate personal login token. E.g. you
create a Jottacloud remote with rclone in one location, and copy the
configuration file to a second location where you also want to run
rclone and access the same remote. Then you need to replace the token
for one of them, using the <a
href="https://rclone.org/commands/rclone_config_reconnect/">config
reconnect</a> command, which requires you to generate a new personal
login token and supply as input. If you do not do this, the token may
easily end up being invalidated, resulting in both instances failing
with an error message something along the lines of:</p>
<pre><code>oauth2: cannot fetch token: 400 Bad Request
Response: {&quot;error&quot;:&quot;invalid_grant&quot;,&quot;error_description&quot;:&quot;Stale token&quot;}</code></pre>
<p>When this happens, you need to replace the token as described above
to be able to use your remote again.</p>
<p>All personal login tokens you have taken into use will be listed in
the web interface under “My logged in devices”, and from the right side
of that list you can click the “X” button to revoke individual
tokens.</p>
<h3 id="legacy-authentication">Legacy authentication</h3>
<p>If you are using one of the whitelabel versions (e.g. from Elkjøp)
you may not have the option to generate a CLI token. In this case you’ll
have to use the legacy authentication. To do this select yes when the
setup asks for legacy authentication and enter your username and
password. The rest of the setup is identical to the default setup.</p>
<h3 id="telia-cloud-authentication">Telia Cloud authentication</h3>
<p>Similar to other whitelabel versions Telia Cloud doesn’t offer the
option of creating a CLI token, and additionally uses a separate
authentication flow where the username is generated internally. To setup
rclone to use Telia Cloud, choose Telia Cloud authentication in the
setup. The rest of the setup is identical to the default setup.</p>
<h3 id="tele2-cloud-authentication">Tele2 Cloud authentication</h3>
<p>As Tele2-Com Hem merger was completed this authentication can be used
for former Com Hem Cloud and Tele2 Cloud customers as no support for
creating a CLI token exists, and additionally uses a separate
authentication flow where the username is generated internally. To setup
rclone to use Tele2 Cloud, choose Tele2 Cloud authentication in the
setup. The rest of the setup is identical to the default setup.</p>
<h2 id="configuration-22">Configuration</h2>
<p>Here is an example of how to make a remote called <code>remote</code>
with the default setup. First run:</p>
<pre><code>rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<pre><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; 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&gt; jottacloud
Edit advanced config?
y) Yes
n) No (default)
y/n&gt; 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&#39;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)
config_type&gt; 1
Personal login token.
Generate here: https://www.jottacloud.com/web/secure
Login Token&gt; &lt;your token here&gt;
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&gt; 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 &gt; DESKTOP-3H31129
 2 &gt; Jotta
config_device&gt; 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 &gt; Archive
 2 &gt; Shared
 3 &gt; Sync
config_mountpoint&gt; 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&gt; y</code></pre>
<p>Once configured you can then use <code>rclone</code> like this,</p>
<p>List directories in top level of your Jottacloud</p>
<pre><code>rclone lsd remote:</code></pre>
<p>List all the files in your Jottacloud</p>
<pre><code>rclone ls remote:</code></pre>
<p>To copy a local directory to an Jottacloud directory called
backup</p>
<pre><code>rclone copy /home/source remote:backup</code></pre>
<h3 id="devices-and-mountpoints">Devices and Mountpoints</h3>
<p>The official Jottacloud client registers a device for each computer
you install it on, and shows them in the backup section of the user
interface. For each folder you select for backup it will create a
mountpoint within this device. A built-in device called Jotta is
special, and contains mountpoints Archive, Sync and some others, used
for corresponding features in official clients.</p>
<p>With rclone you’ll want to use the standard Jotta/Archive
device/mountpoint in most cases. However, you may for example want to
access files from the sync or backup functionality provided by the
official clients, and rclone therefore provides the option to select
other devices and mountpoints during config.</p>
<p>You are allowed to create new devices and mountpoints. All devices
except the built-in Jotta device are treated as backup devices by
official Jottacloud clients, and the mountpoints on them are individual
backup sets.</p>
<p>With the built-in Jotta device, only existing, built-in, mountpoints
can be selected. In addition to the mentioned Archive and Sync, it may
contain several other mountpoints such as: Latest, Links, Shared and
Trash. All of these are special mountpoints with a different internal
representation than the “regular” mountpoints. Rclone will only to a
very limited degree support them. Generally you should avoid these,
unless you know what you are doing.</p>
<h3 id="fast-list-4">–fast-list</h3>
<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>
<p>Note that the implementation in Jottacloud always uses only a single
API request to get the entire list, so for large folders this could lead
to long wait time before the first results are shown.</p>
<p>Note also that with rclone version 1.58 and newer information about
<a href="https://rclone.org/overview/#mime-type">MIME types</a> are not
available when using <code>--fast-list</code>.</p>
<h3 id="modified-time-and-hashes-7">Modified time and hashes</h3>
<p>Jottacloud allows modification times to be set on objects accurate to
1 second. These will be used to detect whether objects need syncing or
not.</p>
<p>Jottacloud supports MD5 type hashes, so you can use the
<code>--checksum</code> flag.</p>
<p>Note that Jottacloud requires the MD5 hash before upload so if the
source does not have an MD5 checksum then the file will be cached
temporarily on disk (in location given by <a
href="https://rclone.org/docs/#temp-dir-dir">–temp-dir</a>) before it is
uploaded. Small files will be cached in memory - see the <a
href="#jottacloud-md5-memory-limit">–jottacloud-md5-memory-limit</a>
flag. When uploading from local disk the source checksum is always
available, so this does not apply. Starting with rclone version 1.52 the
same is true for crypted remotes (in older versions the crypt backend
would not calculate hashes for uploads from local disk, so the
Jottacloud backend had to do it as described above).</p>
<h3 id="restricted-filename-characters-13">Restricted filename
characters</h3>
<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>
<table>
<thead>
<tr class="header">
<th>Character</th>
<th style="text-align: center;">Value</th>
<th style="text-align: center;">Replacement</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>”</td>
<td style="text-align: center;">0x22</td>
<td style="text-align: center;">＂</td>
</tr>
<tr class="even">
<td>*</td>
<td style="text-align: center;">0x2A</td>
<td style="text-align: center;">＊</td>
</tr>
<tr class="odd">
<td>:</td>
<td style="text-align: center;">0x3A</td>
<td style="text-align: center;">：</td>
</tr>
<tr class="even">
<td>&lt;</td>
<td style="text-align: center;">0x3C</td>
<td style="text-align: center;">＜</td>
</tr>
<tr class="odd">
<td>&gt;</td>
<td style="text-align: center;">0x3E</td>
<td style="text-align: center;">＞</td>
</tr>
<tr class="even">
<td>?</td>
<td style="text-align: center;">0x3F</td>
<td style="text-align: center;">？</td>
</tr>
<tr class="odd">
<td>|</td>
<td style="text-align: center;">0x7C</td>
<td style="text-align: center;">｜</td>
</tr>
</tbody>
</table>
<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>
<h3 id="deleting-files-4">Deleting files</h3>
<p>By default, rclone will send all files to the trash when deleting
files. They will be permanently deleted automatically after 30 days. You
may bypass the trash and permanently delete files immediately by using
the <a href="#jottacloud-hard-delete">–jottacloud-hard-delete</a> flag,
or set the equivalent environment variable. Emptying the trash is
supported by the <a
href="https://rclone.org/commands/rclone_cleanup/">cleanup</a>
command.</p>
<h3 id="versions-3">Versions</h3>
<p>Jottacloud supports file versioning. When rclone uploads a new
version of a file it creates a new version of it. Currently rclone only
supports retrieving the current version but older versions can be
accessed via the Jottacloud Website.</p>
<p>Versioning can be disabled by <code>--jottacloud-no-versions</code>
option. This is achieved by deleting the remote file prior to uploading
a new version. If the upload the fails no version of the file will be
available in the remote.</p>
<h3 id="quota-information-1">Quota information</h3>
<p>To view your current quota you can use the
<code>rclone about remote:</code> command which will display your usage
limit (unless it is unlimited) and the current usage.</p>
<h3 id="advanced-options-21">Advanced options</h3>
<p>Here are the Advanced options specific to jottacloud
(Jottacloud).</p>
<h4 id="jottacloud-md5-memory-limit">–jottacloud-md5-memory-limit</h4>
<p>Files bigger than this will be cached on disk to calculate the MD5 if
required.</p>
<p>Properties:</p>
<ul>
<li>Config: md5_memory_limit</li>
<li>Env Var: RCLONE_JOTTACLOUD_MD5_MEMORY_LIMIT</li>
<li>Type: SizeSuffix</li>
<li>Default: 10Mi</li>
</ul>
<h4 id="jottacloud-trashed-only">–jottacloud-trashed-only</h4>
<p>Only show files that are in the trash.</p>
<p>This will show trashed files in their original directory
structure.</p>
<p>Properties:</p>
<ul>
<li>Config: trashed_only</li>
<li>Env Var: RCLONE_JOTTACLOUD_TRASHED_ONLY</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="jottacloud-hard-delete">–jottacloud-hard-delete</h4>
<p>Delete files permanently rather than putting them into the trash.</p>
<p>Properties:</p>
<ul>
<li>Config: hard_delete</li>
<li>Env Var: RCLONE_JOTTACLOUD_HARD_DELETE</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4
id="jottacloud-upload-resume-limit">–jottacloud-upload-resume-limit</h4>
<p>Files bigger than this can be resumed if the upload fail’s.</p>
<p>Properties:</p>
<ul>
<li>Config: upload_resume_limit</li>
<li>Env Var: RCLONE_JOTTACLOUD_UPLOAD_RESUME_LIMIT</li>
<li>Type: SizeSuffix</li>
<li>Default: 10Mi</li>
</ul>
<h4 id="jottacloud-no-versions">–jottacloud-no-versions</h4>
<p>Avoid server side versioning by deleting files and recreating files
instead of overwriting them.</p>
<p>Properties:</p>
<ul>
<li>Config: no_versions</li>
<li>Env Var: RCLONE_JOTTACLOUD_NO_VERSIONS</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="jottacloud-encoding">–jottacloud-encoding</h4>
<p>The encoding for the backend.</p>
<p>See the <a href="https://rclone.org/overview/#encoding">encoding
section in the overview</a> for more info.</p>
<p>Properties:</p>
<ul>
<li>Config: encoding</li>
<li>Env Var: RCLONE_JOTTACLOUD_ENCODING</li>
<li>Type: MultiEncoder</li>
<li>Default:
Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot</li>
</ul>
<h2 id="limitations-17">Limitations</h2>
<p>Note that Jottacloud is case insensitive so you can’t have a file
called “Hello.doc” and one called “hello.doc”.</p>
<p>There are quite a few characters that can’t be in Jottacloud file
names. Rclone will map these names to and from an identical looking
unicode equivalent. For example if a file has a ? in it will be mapped
to ？ instead.</p>
<p>Jottacloud only supports filenames up to 255 characters in
length.</p>
<h2 id="troubleshooting-1">Troubleshooting</h2>
<p>Jottacloud exhibits some inconsistent behaviours regarding deleted
files and folders which may cause Copy, Move and DirMove operations to
previously deleted paths to fail. Emptying the trash should help in such
cases.</p>
<h1 id="koofr">Koofr</h1>
<p>Paths are specified as <code>remote:path</code></p>
<p>Paths may be as deep as required,
e.g. <code>remote:directory/subdirectory</code>.</p>
<h2 id="configuration-23">Configuration</h2>
<p>The initial setup for Koofr involves creating an application password
for rclone. You can do that by opening the Koofr <a
href="https://app.koofr.net/app/admin/preferences/password">web
application</a>, giving the password a nice name like
<code>rclone</code> and clicking on generate.</p>
<p>Here is an example of how to make a remote called <code>koofr</code>.
First run:</p>
<pre><code> rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<pre><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; 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&gt; 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&gt; 1    
Option user.
Your user name.
Enter a value.
user&gt; 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&gt; y
Enter the password:
password:
Confirm the password:
password:
Edit advanced config?
y) Yes
n) No (default)
y/n&gt; 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&gt; y</code></pre>
<p>You can choose to edit advanced config in order to enter your own
service URL if you use an on-premise or white label Koofr instance, or
choose an alternative mount instead of your primary storage.</p>
<p>Once configured you can then use <code>rclone</code> like this,</p>
<p>List directories in top level of your Koofr</p>
<pre><code>rclone lsd koofr:</code></pre>
<p>List all the files in your Koofr</p>
<pre><code>rclone ls koofr:</code></pre>
<p>To copy a local directory to an Koofr directory called backup</p>
<pre><code>rclone copy /home/source koofr:backup</code></pre>
<h3 id="restricted-filename-characters-14">Restricted filename
characters</h3>
<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>
<table>
<thead>
<tr class="header">
<th>Character</th>
<th style="text-align: center;">Value</th>
<th style="text-align: center;">Replacement</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>\</td>
<td style="text-align: center;">0x5C</td>
<td style="text-align: center;">＼</td>
</tr>
</tbody>
</table>
<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>
<h3 id="standard-options-23">Standard options</h3>
<p>Here are the Standard options specific to koofr (Koofr, Digi Storage
and other Koofr-compatible storage providers).</p>
<h4 id="koofr-provider">–koofr-provider</h4>
<p>Choose your storage provider.</p>
<p>Properties:</p>
<ul>
<li>Config: provider</li>
<li>Env Var: RCLONE_KOOFR_PROVIDER</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“koofr”
<ul>
<li>Koofr, https://app.koofr.net/</li>
</ul></li>
<li>“digistorage”
<ul>
<li>Digi Storage, https://storage.rcs-rds.ro/</li>
</ul></li>
<li>“other”
<ul>
<li>Any other Koofr API compatible storage service</li>
</ul></li>
</ul></li>
</ul>
<h4 id="koofr-endpoint">–koofr-endpoint</h4>
<p>The Koofr API endpoint to use.</p>
<p>Properties:</p>
<ul>
<li>Config: endpoint</li>
<li>Env Var: RCLONE_KOOFR_ENDPOINT</li>
<li>Provider: other</li>
<li>Type: string</li>
<li>Required: true</li>
</ul>
<h4 id="koofr-user">–koofr-user</h4>
<p>Your user name.</p>
<p>Properties:</p>
<ul>
<li>Config: user</li>
<li>Env Var: RCLONE_KOOFR_USER</li>
<li>Type: string</li>
<li>Required: true</li>
</ul>
<h4 id="koofr-password">–koofr-password</h4>
<p>Your password for rclone (generate one at
https://app.koofr.net/app/admin/preferences/password).</p>
<p><strong>NB</strong> Input to this must be obscured - see <a
href="https://rclone.org/commands/rclone_obscure/">rclone
obscure</a>.</p>
<p>Properties:</p>
<ul>
<li>Config: password</li>
<li>Env Var: RCLONE_KOOFR_PASSWORD</li>
<li>Provider: koofr</li>
<li>Type: string</li>
<li>Required: true</li>
</ul>
<h4 id="koofr-password-1">–koofr-password</h4>
<p>Your password for rclone (generate one at
https://storage.rcs-rds.ro/app/admin/preferences/password).</p>
<p><strong>NB</strong> Input to this must be obscured - see <a
href="https://rclone.org/commands/rclone_obscure/">rclone
obscure</a>.</p>
<p>Properties:</p>
<ul>
<li>Config: password</li>
<li>Env Var: RCLONE_KOOFR_PASSWORD</li>
<li>Provider: digistorage</li>
<li>Type: string</li>
<li>Required: true</li>
</ul>
<h4 id="koofr-password-2">–koofr-password</h4>
<p>Your password for rclone (generate one at your service’s settings
page).</p>
<p><strong>NB</strong> Input to this must be obscured - see <a
href="https://rclone.org/commands/rclone_obscure/">rclone
obscure</a>.</p>
<p>Properties:</p>
<ul>
<li>Config: password</li>
<li>Env Var: RCLONE_KOOFR_PASSWORD</li>
<li>Provider: other</li>
<li>Type: string</li>
<li>Required: true</li>
</ul>
<h3 id="advanced-options-22">Advanced options</h3>
<p>Here are the Advanced options specific to koofr (Koofr, Digi Storage
and other Koofr-compatible storage providers).</p>
<h4 id="koofr-mountid">–koofr-mountid</h4>
<p>Mount ID of the mount to use.</p>
<p>If omitted, the primary mount is used.</p>
<p>Properties:</p>
<ul>
<li>Config: mountid</li>
<li>Env Var: RCLONE_KOOFR_MOUNTID</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="koofr-setmtime">–koofr-setmtime</h4>
<p>Does the backend support setting modification time.</p>
<p>Set this to false if you use a mount ID that points to a Dropbox or
Amazon Drive backend.</p>
<p>Properties:</p>
<ul>
<li>Config: setmtime</li>
<li>Env Var: RCLONE_KOOFR_SETMTIME</li>
<li>Type: bool</li>
<li>Default: true</li>
</ul>
<h4 id="koofr-encoding">–koofr-encoding</h4>
<p>The encoding for the backend.</p>
<p>See the <a href="https://rclone.org/overview/#encoding">encoding
section in the overview</a> for more info.</p>
<p>Properties:</p>
<ul>
<li>Config: encoding</li>
<li>Env Var: RCLONE_KOOFR_ENCODING</li>
<li>Type: MultiEncoder</li>
<li>Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot</li>
</ul>
<h2 id="limitations-18">Limitations</h2>
<p>Note that Koofr is case insensitive so you can’t have a file called
“Hello.doc” and one called “hello.doc”.</p>
<h2 id="providers-2">Providers</h2>
<h3 id="koofr-1">Koofr</h3>
<p>This is the original <a href="https://koofr.eu">Koofr</a> storage
provider used as main example and described in the <a
href="#configuration">configuration</a> section above.</p>
<h3 id="digi-storage">Digi Storage</h3>
<p><a href="https://www.digi.ro/servicii/online/digi-storage">Digi
Storage</a> is a cloud storage service run by <a
href="https://www.digi.ro/">Digi.ro</a> that provides a Koofr API.</p>
<p>Here is an example of how to make a remote called <code>ds</code>.
First run:</p>
<pre><code> rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<pre><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; 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&gt; 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&gt; 2
Option user.
Your user name.
Enter a value.
user&gt; 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&gt; y
Enter the password:
password:
Confirm the password:
password:
Edit advanced config?
y) Yes
n) No (default)
y/n&gt; 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&gt; y</code></pre>
<h3 id="other">Other</h3>
<p>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.</p>
<p>Here is an example of how to make a remote called <code>other</code>.
First run:</p>
<pre><code> rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<pre><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; 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&gt; 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&gt; 3
Option endpoint.
The Koofr API endpoint to use.
Enter a value.
endpoint&gt; https://koofr.other.org
Option user.
Your user name.
Enter a value.
user&gt; USERNAME
Option password.
Your password for rclone (generate one at your service&#39;s settings page).
Choose an alternative below.
y) Yes, type in my own password
g) Generate random password
y/g&gt; y
Enter the password:
password:
Confirm the password:
password:
Edit advanced config?
y) Yes
n) No (default)
y/n&gt; 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&gt; y</code></pre>
<h1 id="mail.ru-cloud">Mail.ru Cloud</h1>
<p><a href="https://cloud.mail.ru/">Mail.ru Cloud</a> is a cloud storage
provided by a Russian internet company <a href="https://mail.ru">Mail.Ru
Group</a>. The official desktop client is <a
href="https://disk-o.cloud/en">Disk-O:</a>, available on Windows and Mac
OS.</p>
<p>Currently it is recommended to disable 2FA on Mail.ru accounts
intended for rclone until it gets eventually implemented.</p>
<h2 id="features-highlights">Features highlights</h2>
<ul>
<li>Paths may be as deep as required,
e.g. <code>remote:directory/subdirectory</code></li>
<li>Files have a <code>last modified time</code> property, directories
don’t</li>
<li>Deleted files are by default moved to the trash</li>
<li>Files and directories can be shared via public links</li>
<li>Partial uploads or streaming are not supported, file size must be
known before upload</li>
<li>Maximum file size is limited to 2G for a free account, unlimited for
paid accounts</li>
<li>Storage keeps hash for all files and performs transparent
deduplication, the hash algorithm is a modified SHA1</li>
<li>If a particular file is already present in storage, one can quickly
submit file hash instead of long file upload (this optimization is
supported by rclone)</li>
</ul>
<h2 id="configuration-24">Configuration</h2>
<p>Here is an example of making a mailru configuration.</p>
<p>First create a Mail.ru Cloud account and choose a tariff.</p>
<p>You will need to log in and create an app password for rclone. Rclone
<strong>will not work</strong> with your normal username and password -
it will give an error like
<code>oauth2: server response missing access_token</code>.</p>
<ul>
<li>Click on your user icon in the top right</li>
<li>Go to Security / “Пароль и безопасность”</li>
<li>Click password for apps / “Пароли для внешних приложений”</li>
<li>Add the password - give it a name - eg “rclone”</li>
<li>Copy the password and use this password below - your normal login
password won’t work.</li>
</ul>
<p>Now run</p>
<pre><code>rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<pre><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; remote
Type of storage to configure.
Type of storage to configure.
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
[snip]
XX / Mail.ru Cloud
   \ &quot;mailru&quot;
[snip]
Storage&gt; mailru
User name (usually email)
Enter a string value. Press Enter for the default (&quot;&quot;).
user&gt; username@mail.ru
Password

This must be an app password - rclone will not work with your normal
password. See the Configuration section in the docs for how to make an
app password.
y) Yes type in my own password
g) Generate random password
y/g&gt; 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 &quot;speedup&quot; or &quot;put by hash&quot;. 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 (&quot;true&quot;).
Choose a number from below, or type in your own value
 1 / Enable
   \ &quot;true&quot;
 2 / Disable
   \ &quot;false&quot;
speedup_enable&gt; 1
Edit advanced config? (y/n)
y) Yes
n) No
y/n&gt; 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&gt; y</code></pre>
<p>Configuration of this backend does not require a local web browser.
You can use the configured backend as shown below:</p>
<p>See top level directories</p>
<pre><code>rclone lsd remote:</code></pre>
<p>Make a new directory</p>
<pre><code>rclone mkdir remote:directory</code></pre>
<p>List the contents of a directory</p>
<pre><code>rclone ls remote:directory</code></pre>
<p>Sync <code>/home/local/directory</code> to the remote path, deleting
any excess files in the path.</p>
<pre><code>rclone sync -i /home/local/directory remote:directory</code></pre>
<h3 id="modified-time-8">Modified time</h3>
<p>Files support a modification time attribute with up to 1 second
precision. Directories do not have a modification time, which is shown
as “Jan 1 1970”.</p>
<h3 id="hash-checksums">Hash checksums</h3>
<p>Hash sums use a custom Mail.ru algorithm based on SHA1. If file size
is less than or equal to the SHA1 block size (20 bytes), its hash is
simply its data right-padded with zero bytes. Hash sum of a larger file
is computed as a SHA1 sum of the file data bytes concatenated with a
decimal representation of the data length.</p>
<h3 id="emptying-trash-1">Emptying Trash</h3>
<p>Removing a file or directory actually moves it to the trash, which is
not visible to rclone but can be seen in a web browser. The trashed file
still occupies part of total quota. If you wish to empty your trash and
free some quota, you can use the <code>rclone cleanup remote:</code>
command, which will permanently delete all your trashed files. This
command does not take any path arguments.</p>
<h3 id="quota-information-2">Quota information</h3>
<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>
<h3 id="restricted-filename-characters-15">Restricted filename
characters</h3>
<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>
<table>
<thead>
<tr class="header">
<th>Character</th>
<th style="text-align: center;">Value</th>
<th style="text-align: center;">Replacement</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>”</td>
<td style="text-align: center;">0x22</td>
<td style="text-align: center;">＂</td>
</tr>
<tr class="even">
<td>*</td>
<td style="text-align: center;">0x2A</td>
<td style="text-align: center;">＊</td>
</tr>
<tr class="odd">
<td>:</td>
<td style="text-align: center;">0x3A</td>
<td style="text-align: center;">：</td>
</tr>
<tr class="even">
<td>&lt;</td>
<td style="text-align: center;">0x3C</td>
<td style="text-align: center;">＜</td>
</tr>
<tr class="odd">
<td>&gt;</td>
<td style="text-align: center;">0x3E</td>
<td style="text-align: center;">＞</td>
</tr>
<tr class="even">
<td>?</td>
<td style="text-align: center;">0x3F</td>
<td style="text-align: center;">？</td>
</tr>
<tr class="odd">
<td>\</td>
<td style="text-align: center;">0x5C</td>
<td style="text-align: center;">＼</td>
</tr>
<tr class="even">
<td>|</td>
<td style="text-align: center;">0x7C</td>
<td style="text-align: center;">｜</td>
</tr>
</tbody>
</table>
<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>
<h3 id="standard-options-24">Standard options</h3>
<p>Here are the Standard options specific to mailru (Mail.ru Cloud).</p>
<h4 id="mailru-user">–mailru-user</h4>
<p>User name (usually email).</p>
<p>Properties:</p>
<ul>
<li>Config: user</li>
<li>Env Var: RCLONE_MAILRU_USER</li>
<li>Type: string</li>
<li>Required: true</li>
</ul>
<h4 id="mailru-pass">–mailru-pass</h4>
<p>Password.</p>
<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.</p>
<p><strong>NB</strong> Input to this must be obscured - see <a
href="https://rclone.org/commands/rclone_obscure/">rclone
obscure</a>.</p>
<p>Properties:</p>
<ul>
<li>Config: pass</li>
<li>Env Var: RCLONE_MAILRU_PASS</li>
<li>Type: string</li>
<li>Required: true</li>
</ul>
<h4 id="mailru-speedup-enable">–mailru-speedup-enable</h4>
<p>Skip full upload if there is another file with same data hash.</p>
<p>This feature is called “speedup” or “put by hash”. It is especially
efficient in case of generally available files like popular books, video
or audio clips, because files are searched by hash in all accounts of
all mailru users. It is meaningless and ineffective if source file is
unique or encrypted. Please note that rclone may need local memory and
disk space to calculate content hash in advance and decide whether full
upload is required. Also, if rclone does not know file size in advance
(e.g. in case of streaming or partial uploads), it will not even try
this optimization.</p>
<p>Properties:</p>
<ul>
<li>Config: speedup_enable</li>
<li>Env Var: RCLONE_MAILRU_SPEEDUP_ENABLE</li>
<li>Type: bool</li>
<li>Default: true</li>
<li>Examples:
<ul>
<li>“true”
<ul>
<li>Enable</li>
</ul></li>
<li>“false”
<ul>
<li>Disable</li>
</ul></li>
</ul></li>
</ul>
<h3 id="advanced-options-23">Advanced options</h3>
<p>Here are the Advanced options specific to mailru (Mail.ru Cloud).</p>
<h4 id="mailru-speedup-file-patterns">–mailru-speedup-file-patterns</h4>
<p>Comma separated list of file name patterns eligible for speedup (put
by hash).</p>
<p>Patterns are case insensitive and can contain ’*’ or ‘?’ meta
characters.</p>
<p>Properties:</p>
<ul>
<li>Config: speedup_file_patterns</li>
<li>Env Var: RCLONE_MAILRU_SPEEDUP_FILE_PATTERNS</li>
<li>Type: string</li>
<li>Default:
“<em>.mkv,</em>.avi,<em>.mp4,</em>.mp3,<em>.zip,</em>.gz,<em>.rar,</em>.pdf”</li>
<li>Examples:
<ul>
<li>“”
<ul>
<li>Empty list completely disables speedup (put by hash).</li>
</ul></li>
<li>“*”
<ul>
<li>All files will be attempted for speedup.</li>
</ul></li>
<li>“<em>.mkv,</em>.avi,<em>.mp4,</em>.mp3”
<ul>
<li>Only common audio/video files will be tried for put by hash.</li>
</ul></li>
<li>“<em>.zip,</em>.gz,<em>.rar,</em>.pdf”
<ul>
<li>Only common archives or PDF books will be tried for speedup.</li>
</ul></li>
</ul></li>
</ul>
<h4 id="mailru-speedup-max-disk">–mailru-speedup-max-disk</h4>
<p>This option allows you to disable speedup (put by hash) for large
files.</p>
<p>Reason is that preliminary hashing can exhaust your RAM or disk
space.</p>
<p>Properties:</p>
<ul>
<li>Config: speedup_max_disk</li>
<li>Env Var: RCLONE_MAILRU_SPEEDUP_MAX_DISK</li>
<li>Type: SizeSuffix</li>
<li>Default: 3Gi</li>
<li>Examples:
<ul>
<li>“0”
<ul>
<li>Completely disable speedup (put by hash).</li>
</ul></li>
<li>“1G”
<ul>
<li>Files larger than 1Gb will be uploaded directly.</li>
</ul></li>
<li>“3G”
<ul>
<li>Choose this option if you have less than 3Gb free on local
disk.</li>
</ul></li>
</ul></li>
</ul>
<h4 id="mailru-speedup-max-memory">–mailru-speedup-max-memory</h4>
<p>Files larger than the size given below will always be hashed on
disk.</p>
<p>Properties:</p>
<ul>
<li>Config: speedup_max_memory</li>
<li>Env Var: RCLONE_MAILRU_SPEEDUP_MAX_MEMORY</li>
<li>Type: SizeSuffix</li>
<li>Default: 32Mi</li>
<li>Examples:
<ul>
<li>“0”
<ul>
<li>Preliminary hashing will always be done in a temporary disk
location.</li>
</ul></li>
<li>“32M”
<ul>
<li>Do not dedicate more than 32Mb RAM for preliminary hashing.</li>
</ul></li>
<li>“256M”
<ul>
<li>You have at most 256Mb RAM free for hash calculations.</li>
</ul></li>
</ul></li>
</ul>
<h4 id="mailru-check-hash">–mailru-check-hash</h4>
<p>What should copy do if file checksum is mismatched or invalid.</p>
<p>Properties:</p>
<ul>
<li>Config: check_hash</li>
<li>Env Var: RCLONE_MAILRU_CHECK_HASH</li>
<li>Type: bool</li>
<li>Default: true</li>
<li>Examples:
<ul>
<li>“true”
<ul>
<li>Fail with error.</li>
</ul></li>
<li>“false”
<ul>
<li>Ignore and continue.</li>
</ul></li>
</ul></li>
</ul>
<h4 id="mailru-user-agent">–mailru-user-agent</h4>
<p>HTTP user agent used internally by client.</p>
<p>Defaults to “rclone/VERSION” or “–user-agent” provided on command
line.</p>
<p>Properties:</p>
<ul>
<li>Config: user_agent</li>
<li>Env Var: RCLONE_MAILRU_USER_AGENT</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="mailru-quirks">–mailru-quirks</h4>
<p>Comma separated list of internal maintenance flags.</p>
<p>This option must not be used by an ordinary user. It is intended only
to facilitate remote troubleshooting of backend issues. Strict meaning
of flags is not documented and not guaranteed to persist between
releases. Quirks will be removed when the backend grows stable.
Supported quirks: atomicmkdir binlist unknowndirs</p>
<p>Properties:</p>
<ul>
<li>Config: quirks</li>
<li>Env Var: RCLONE_MAILRU_QUIRKS</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="mailru-encoding">–mailru-encoding</h4>
<p>The encoding for the backend.</p>
<p>See the <a href="https://rclone.org/overview/#encoding">encoding
section in the overview</a> for more info.</p>
<p>Properties:</p>
<ul>
<li>Config: encoding</li>
<li>Env Var: RCLONE_MAILRU_ENCODING</li>
<li>Type: MultiEncoder</li>
<li>Default:
Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot</li>
</ul>
<h2 id="limitations-19">Limitations</h2>
<p>File size limits depend on your account. A single file size is
limited by 2G for a free account and unlimited for paid tariffs. Please
refer to the Mail.ru site for the total uploaded size limits.</p>
<p>Note that Mailru is case insensitive so you can’t have a file called
“Hello.doc” and one called “hello.doc”.</p>
<h1 id="mega">Mega</h1>
<p><a href="https://mega.nz/">Mega</a> is a cloud storage and file
hosting service known for its security feature where all files are
encrypted locally before they are uploaded. This prevents anyone
(including employees of Mega) from accessing the files without knowledge
of the key used for encryption.</p>
<p>This is an rclone backend for Mega which supports the file transfer
features of Mega using the same client side encryption.</p>
<p>Paths are specified as <code>remote:path</code></p>
<p>Paths may be as deep as required,
e.g. <code>remote:directory/subdirectory</code>.</p>
<h2 id="configuration-25">Configuration</h2>
<p>Here is an example of how to make a remote called
<code>remote</code>. First run:</p>
<pre><code> rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<pre><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; remote
Type of storage to configure.
Choose a number from below, or type in your own value
[snip]
XX / Mega
   \ &quot;mega&quot;
[snip]
Storage&gt; mega
User name
user&gt; 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&gt; 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&gt; y</code></pre>
<p><strong>NOTE:</strong> The encryption keys need to have been already
generated after a regular login via the browser, otherwise attempting to
use the credentials in <code>rclone</code> will fail.</p>
<p>Once configured you can then use <code>rclone</code> like this,</p>
<p>List directories in top level of your Mega</p>
<pre><code>rclone lsd remote:</code></pre>
<p>List all the files in your Mega</p>
<pre><code>rclone ls remote:</code></pre>
<p>To copy a local directory to an Mega directory called backup</p>
<pre><code>rclone copy /home/source remote:backup</code></pre>
<h3 id="modified-time-and-hashes-8">Modified time and hashes</h3>
<p>Mega does not support modification times or hashes yet.</p>
<h3 id="restricted-filename-characters-16">Restricted filename
characters</h3>
<table>
<thead>
<tr class="header">
<th>Character</th>
<th style="text-align: center;">Value</th>
<th style="text-align: center;">Replacement</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>NUL</td>
<td style="text-align: center;">0x00</td>
<td style="text-align: center;">␀</td>
</tr>
<tr class="even">
<td>/</td>
<td style="text-align: center;">0x2F</td>
<td style="text-align: center;">／</td>
</tr>
</tbody>
</table>
<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>
<h3 id="duplicated-files-2">Duplicated files</h3>
<p>Mega can have two files with exactly the same name and path (unlike a
normal file system).</p>
<p>Duplicated files cause problems with the syncing and you will see
messages in the log about duplicates.</p>
<p>Use <code>rclone dedupe</code> to fix duplicated files.</p>
<h3 id="failure-to-log-in">Failure to log-in</h3>
<h4 id="object-not-found">Object not found</h4>
<p>If you are connecting to your Mega remote for the first time, to test
access and synchronization, you may receive an error such as</p>
<pre><code>Failed to create file system for &quot;my-mega-remote:&quot;: 
couldn&#39;t login: Object (typically, node or user) not found</code></pre>
<p>The diagnostic steps often recommended in the <a
href="https://forum.rclone.org/search?q=mega">rclone forum</a> start
with the <strong>MEGAcmd</strong> utility. Note that this refers to the
official C++ command from https://github.com/meganz/MEGAcmd and not the
go language built command from t3rm1n4l/megacmd that is no longer
maintained.</p>
<p>Follow the instructions for installing MEGAcmd and try accessing your
remote as they recommend. You can establish whether or not you can log
in using MEGAcmd, and obtain diagnostic information to help you, and
search or work with others in the forum.</p>
<pre><code>MEGA CMD&gt; login me@example.com
Password:
Fetching nodes ...
Loading transfers from local cache
Login complete as me@example.com
me@example.com:/$ </code></pre>
<p>Note that some have found issues with passwords containing special
characters. If you can not log on with rclone, but MEGAcmd logs on just
fine, then consider changing your password temporarily to pure
alphanumeric characters, in case that helps.</p>
<h4 id="repeated-commands-blocks-access">Repeated commands blocks
access</h4>
<p>Mega remotes seem to get blocked (reject logins) under “heavy use”.
We haven’t worked out the exact blocking rules but it seems to be
related to fast paced, successive rclone commands.</p>
<p>For example, executing this command 90 times in a row
<code>rclone link remote:file</code> will cause the remote to become
“blocked”. This is not an abnormal situation, for example if you wish to
get the public links of a directory with hundred of files… After more or
less a week, the remote will remote accept rclone logins normally
again.</p>
<p>You can mitigate this issue by mounting the remote it with
<code>rclone mount</code>. This will log-in when mounting and a log-out
when unmounting only. You can also run <code>rclone rcd</code> and then
use <code>rclone rc</code> to run the commands over the API to avoid
logging in each time.</p>
<p>Rclone does not currently close mega sessions (you can see them in
the web interface), however closing the sessions does not solve the
issue.</p>
<p>If you space rclone commands by 3 seconds it will avoid blocking the
remote. We haven’t identified the exact blocking rules, so perhaps one
could execute the command 80 times without waiting and avoid blocking by
waiting 3 seconds, then continuing…</p>
<p>Note that this has been observed by trial and error and might not be
set in stone.</p>
<p>Other tools seem not to produce this blocking effect, as they use a
different working approach (state-based, using sessionIDs instead of
log-in) which isn’t compatible with the current stateless rclone
approach.</p>
<p>Note that once blocked, the use of other tools (such as megacmd) is
not a sure workaround: following megacmd login times have been observed
in succession for blocked remote: 7 minutes, 20 min, 30min, 30 min,
30min. Web access looks unaffected though.</p>
<p>Investigation is continuing in relation to workarounds based on
timeouts, pacers, retrials and tpslimits - if you discover something
relevant, please post on the forum.</p>
<p>So, if rclone was working nicely and suddenly you are unable to
log-in and you are sure the user and the password are correct, likely
you have got the remote blocked for a while.</p>
<h3 id="standard-options-25">Standard options</h3>
<p>Here are the Standard options specific to mega (Mega).</p>
<h4 id="mega-user">–mega-user</h4>
<p>User name.</p>
<p>Properties:</p>
<ul>
<li>Config: user</li>
<li>Env Var: RCLONE_MEGA_USER</li>
<li>Type: string</li>
<li>Required: true</li>
</ul>
<h4 id="mega-pass">–mega-pass</h4>
<p>Password.</p>
<p><strong>NB</strong> Input to this must be obscured - see <a
href="https://rclone.org/commands/rclone_obscure/">rclone
obscure</a>.</p>
<p>Properties:</p>
<ul>
<li>Config: pass</li>
<li>Env Var: RCLONE_MEGA_PASS</li>
<li>Type: string</li>
<li>Required: true</li>
</ul>
<h3 id="advanced-options-24">Advanced options</h3>
<p>Here are the Advanced options specific to mega (Mega).</p>
<h4 id="mega-debug">–mega-debug</h4>
<p>Output more debug from Mega.</p>
<p>If this flag is set (along with -vv) it will print further debugging
information from the mega backend.</p>
<p>Properties:</p>
<ul>
<li>Config: debug</li>
<li>Env Var: RCLONE_MEGA_DEBUG</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="mega-hard-delete">–mega-hard-delete</h4>
<p>Delete files permanently rather than putting them into the trash.</p>
<p>Normally the mega backend will put all deletions into the trash
rather than permanently deleting them. If you specify this then rclone
will permanently delete objects instead.</p>
<p>Properties:</p>
<ul>
<li>Config: hard_delete</li>
<li>Env Var: RCLONE_MEGA_HARD_DELETE</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="mega-encoding">–mega-encoding</h4>
<p>The encoding for the backend.</p>
<p>See the <a href="https://rclone.org/overview/#encoding">encoding
section in the overview</a> for more info.</p>
<p>Properties:</p>
<ul>
<li>Config: encoding</li>
<li>Env Var: RCLONE_MEGA_ENCODING</li>
<li>Type: MultiEncoder</li>
<li>Default: Slash,InvalidUtf8,Dot</li>
</ul>
<h2 id="limitations-20">Limitations</h2>
<p>This backend uses the <a
href="https://github.com/t3rm1n4l/go-mega">go-mega go library</a> which
is an opensource go library implementing the Mega API. There doesn’t
appear to be any documentation for the mega protocol beyond the <a
href="https://github.com/meganz/sdk">mega C++ SDK</a> source code so
there are likely quite a few errors still remaining in this library.</p>
<p>Mega allows duplicate files which may confuse rclone.</p>
<h1 id="memory">Memory</h1>
<p>The memory backend is an in RAM backend. It does not persist its data
- use the local backend for that.</p>
<p>The memory backend behaves like a bucket-based remote (e.g. like s3).
Because it has no parameters you can just use it with the
<code>:memory:</code> remote name.</p>
<h2 id="configuration-26">Configuration</h2>
<p>You can configure it as a remote like this with
<code>rclone config</code> too if you want to:</p>
<pre><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; remote
Type of storage to configure.
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
[snip]
XX / Memory
   \ &quot;memory&quot;
[snip]
Storage&gt; memory
** See help for memory backend at: https://rclone.org/memory/ **

Remote config

--------------------
[remote]
type = memory
--------------------
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<p>Because the memory backend isn’t persistent it is most useful for
testing or with an rclone server or rclone mount, e.g.</p>
<pre><code>rclone mount :memory: /mnt/tmp
rclone serve webdav :memory:
rclone serve sftp :memory:</code></pre>
<h3 id="modified-time-and-hashes-9">Modified time and hashes</h3>
<p>The memory backend supports MD5 hashes and modification times
accurate to 1 nS.</p>
<h3 id="restricted-filename-characters-17">Restricted filename
characters</h3>
<p>The memory backend replaces the <a
href="https://rclone.org/overview/#restricted-characters">default
restricted characters set</a>.</p>
<h1 id="akamai-netstorage">Akamai NetStorage</h1>
<p>Paths are specified as <code>remote:</code> You may put
subdirectories in too, e.g. <code>remote:/path/to/dir</code>. If you
have a CP code you can use that as the folder after the domain such as
&lt;domain&gt;/&lt;cpcode&gt;/&lt;internal directories within
cpcode&gt;.</p>
<p>For example, this is commonly configured with or without a CP code: *
<strong>With a CP code</strong>.
<code>[your-domain-prefix]-nsu.akamaihd.net/123456/subdirectory/</code>
* <strong>Without a CP code</strong>.
<code>[your-domain-prefix]-nsu.akamaihd.net</code></p>
<p>See all buckets rclone lsd remote: The initial setup for Netstorage
involves getting an account and secret. Use <code>rclone config</code>
to walk you through the setup process.</p>
<h2 id="configuration-27">Configuration</h2>
<p>Here’s an example of how to make a remote called
<code>ns1</code>.</p>
<ol type="1">
<li>To begin the interactive configuration process, enter this
command:</li>
</ol>
<pre><code>rclone config</code></pre>
<ol start="2" type="1">
<li>Type <code>n</code> to create a new remote.</li>
</ol>
<pre><code>n) New remote
d) Delete remote
q) Quit config
e/n/d/q&gt; n</code></pre>
<ol start="3" type="1">
<li>For this example, enter <code>ns1</code> when you reach the name&gt;
prompt.</li>
</ol>
<pre><code>name&gt; ns1</code></pre>
<ol start="4" type="1">
<li>Enter <code>netstorage</code> as the type of storage to
configure.</li>
</ol>
<pre><code>Type of storage to configure.
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
XX / NetStorage
   \ &quot;netstorage&quot;
Storage&gt; netstorage</code></pre>
<ol start="5" type="1">
<li>Select between the HTTP or HTTPS protocol. Most users should choose
HTTPS, which is the default. HTTP is provided primarily for debugging
purposes.</li>
</ol>
<pre><code>Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
 1 / HTTP protocol
   \ &quot;http&quot;
 2 / HTTPS protocol
   \ &quot;https&quot;
protocol&gt; 1</code></pre>
<ol start="6" type="1">
<li>Specify your NetStorage host, CP code, and any necessary content
paths using this format:
<code>&lt;domain&gt;/&lt;cpcode&gt;/&lt;content&gt;/</code></li>
</ol>
<pre><code>Enter a string value. Press Enter for the default (&quot;&quot;).
host&gt; baseball-nsu.akamaihd.net/123456/content/</code></pre>
<ol start="7" type="1">
<li>Set the netstorage account name</li>
</ol>
<pre><code>Enter a string value. Press Enter for the default (&quot;&quot;).
account&gt; username</code></pre>
<ol start="8" type="1">
<li>Set the Netstorage account secret/G2O key which will be used for
authentication purposes. Select the <code>y</code> option to set your
own password then enter your secret. Note: The secret is stored in the
<code>rclone.conf</code> file with hex-encoded encryption.</li>
</ol>
<pre><code>y) Yes type in my own password
g) Generate random password
y/g&gt; y
Enter the password:
password:
Confirm the password:
password:</code></pre>
<ol start="9" type="1">
<li>View the summary and confirm your remote configuration.</li>
</ol>
<pre><code>[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&gt; y</code></pre>
<p>This remote is called <code>ns1</code> and can now be used.</p>
<h2 id="example-operations">Example operations</h2>
<p>Get started with rclone and NetStorage with these examples. For
additional rclone commands, visit https://rclone.org/commands/.</p>
<h3 id="see-contents-of-a-directory-in-your-project">See contents of a
directory in your project</h3>
<pre><code>rclone lsd ns1:/974012/testing/</code></pre>
<h3 id="sync-the-contents-local-with-remote">Sync the contents local
with remote</h3>
<pre><code>rclone sync . ns1:/974012/testing/</code></pre>
<h3 id="upload-local-content-to-remote">Upload local content to
remote</h3>
<pre><code>rclone copy notes.txt ns1:/974012/testing/</code></pre>
<h3 id="delete-content-on-remote">Delete content on remote</h3>
<pre><code>rclone delete ns1:/974012/testing/notes.txt</code></pre>
<h3 id="move-or-copy-content-between-cp-codes.">Move or copy content
between CP codes.</h3>
<p>Your credentials must have access to two CP codes on the same remote.
You can’t perform operations between different remotes.</p>
<pre><code>rclone move ns1:/974012/testing/notes.txt ns1:/974450/testing2/</code></pre>
<h2 id="features-2">Features</h2>
<h3 id="symlink-support">Symlink Support</h3>
<p>The Netstorage backend changes the rclone <code>--links, -l</code>
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.</p>
<p>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.</p>
<p>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.</p>
<p><strong>Note</strong>: 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.</p>
<h3 id="implicit-vs.-explicit-directories">Implicit vs. Explicit
Directories</h3>
<p>With NetStorage, directories can exist in one of two forms:</p>
<ol type="1">
<li><strong>Explicit Directory</strong>. This is an actual, physical
directory that you have created in a storage group.</li>
<li><strong>Implicit Directory</strong>. 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.</li>
</ol>
<p>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.</p>
<h3 id="fast-list-listr-support"><code>--fast-list</code> / ListR
support</h3>
<p>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.</p>
<ul>
<li><p><strong>Rclone will use the ListR method for some commands by
default</strong>. Commands such as <code>lsf -R</code> will use ListR by
default. To disable this, include the <code>--disable listR</code>
option to use the non-recursive method of listing objects.</p></li>
<li><p><strong>Rclone will not use the ListR method for some
commands</strong>. Commands such as <code>sync</code> don’t use ListR by
default. To force using the ListR method, include the
<code>--fast-list</code> option.</p></li>
</ul>
<p>There are pros and cons of using the ListR method, refer to <a
href="https://rclone.org/docs/#fast-list">rclone documentation</a>. 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.</p>
<p><strong>Note</strong>: 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.</p>
<h3 id="purge-1">Purge</h3>
<p>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.</p>
<p><strong>Note</strong>: Read the <a
href="https://learn.akamai.com/en-us/webhelp/netstorage/netstorage-http-api-developer-guide/GUID-15836617-9F50-405A-833C-EA2556756A30.html">NetStorage
Usage API</a> 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.</p>
<h3 id="standard-options-26">Standard options</h3>
<p>Here are the Standard options specific to netstorage (Akamai
NetStorage).</p>
<h4 id="netstorage-host">–netstorage-host</h4>
<p>Domain+path of NetStorage host to connect to.</p>
<p>Format should be
<code>&lt;domain&gt;/&lt;internal folders&gt;</code></p>
<p>Properties:</p>
<ul>
<li>Config: host</li>
<li>Env Var: RCLONE_NETSTORAGE_HOST</li>
<li>Type: string</li>
<li>Required: true</li>
</ul>
<h4 id="netstorage-account">–netstorage-account</h4>
<p>Set the NetStorage account name</p>
<p>Properties:</p>
<ul>
<li>Config: account</li>
<li>Env Var: RCLONE_NETSTORAGE_ACCOUNT</li>
<li>Type: string</li>
<li>Required: true</li>
</ul>
<h4 id="netstorage-secret">–netstorage-secret</h4>
<p>Set the NetStorage account secret/G2O key for authentication.</p>
<p>Please choose the ‘y’ option to set your own password then enter your
secret.</p>
<p><strong>NB</strong> Input to this must be obscured - see <a
href="https://rclone.org/commands/rclone_obscure/">rclone
obscure</a>.</p>
<p>Properties:</p>
<ul>
<li>Config: secret</li>
<li>Env Var: RCLONE_NETSTORAGE_SECRET</li>
<li>Type: string</li>
<li>Required: true</li>
</ul>
<h3 id="advanced-options-25">Advanced options</h3>
<p>Here are the Advanced options specific to netstorage (Akamai
NetStorage).</p>
<h4 id="netstorage-protocol">–netstorage-protocol</h4>
<p>Select between HTTP or HTTPS protocol.</p>
<p>Most users should choose HTTPS, which is the default. HTTP is
provided primarily for debugging purposes.</p>
<p>Properties:</p>
<ul>
<li>Config: protocol</li>
<li>Env Var: RCLONE_NETSTORAGE_PROTOCOL</li>
<li>Type: string</li>
<li>Default: “https”</li>
<li>Examples:
<ul>
<li>“http”
<ul>
<li>HTTP protocol</li>
</ul></li>
<li>“https”
<ul>
<li>HTTPS protocol</li>
</ul></li>
</ul></li>
</ul>
<h2 id="backend-commands-5">Backend commands</h2>
<p>Here are the commands specific to the netstorage backend.</p>
<p>Run them with</p>
<pre><code>rclone backend COMMAND remote:</code></pre>
<p>The help below will explain what arguments each command takes.</p>
<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>
<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>
<h3 id="du">du</h3>
<p>Return disk usage information for a specified directory</p>
<pre><code>rclone backend du remote: [options] [&lt;arguments&gt;+]</code></pre>
<p>The usage information returned, includes the targeted directory as
well as all files stored in any sub-directories that may exist.</p>
<h3 id="symlink">symlink</h3>
<p>You can create a symbolic link in ObjectStore with the symlink
action.</p>
<pre><code>rclone backend symlink remote: [options] [&lt;arguments&gt;+]</code></pre>
<p>The desired path location (including applicable sub-directories)
ending in the object that will be the target of the symlink (for
example, /links/mylink). Include the file extension for the object, if
applicable.
<code>rclone backend symlink &lt;src&gt; &lt;path&gt;</code></p>
<h1 id="microsoft-azure-blob-storage">Microsoft Azure Blob Storage</h1>
<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>
<h2 id="configuration-28">Configuration</h2>
<p>Here is an example of making a Microsoft Azure Blob Storage
configuration. For a remote called <code>remote</code>. First run:</p>
<pre><code> rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<pre><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; remote
Type of storage to configure.
Choose a number from below, or type in your own value
[snip]
XX / Microsoft Azure Blob Storage
   \ &quot;azureblob&quot;
[snip]
Storage&gt; azureblob
Storage Account Name
account&gt; account_name
Storage Account Key
key&gt; base64encodedkey==
Endpoint for the service - leave blank normally.
endpoint&gt; 
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&gt; y</code></pre>
<p>See all containers</p>
<pre><code>rclone lsd remote:</code></pre>
<p>Make a new container</p>
<pre><code>rclone mkdir remote:container</code></pre>
<p>List the contents of a container</p>
<pre><code>rclone ls remote:container</code></pre>
<p>Sync <code>/home/local/directory</code> to the remote container,
deleting any excess files in the container.</p>
<pre><code>rclone sync -i /home/local/directory remote:container</code></pre>
<h3 id="fast-list-5">–fast-list</h3>
<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>
<h3 id="modified-time-9">Modified time</h3>
<p>The modified time is stored as metadata on the object with the
<code>mtime</code> key. It is stored using RFC3339 Format time with
nanosecond precision. The metadata is supplied during directory listings
so there is no overhead to using it.</p>
<h3 id="performance">Performance</h3>
<p>When uploading large files, increasing the value of
<code>--azureblob-upload-concurrency</code> will increase performance at
the cost of using more memory. The default of 16 is set quite
conservatively to use less memory. It maybe be necessary raise it to 64
or higher to fully utilize a 1 GBit/s link with a single file
transfer.</p>
<h3 id="restricted-filename-characters-18">Restricted filename
characters</h3>
<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>
<table>
<thead>
<tr class="header">
<th>Character</th>
<th style="text-align: center;">Value</th>
<th style="text-align: center;">Replacement</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>/</td>
<td style="text-align: center;">0x2F</td>
<td style="text-align: center;">／</td>
</tr>
<tr class="even">
<td>\</td>
<td style="text-align: center;">0x5C</td>
<td style="text-align: center;">＼</td>
</tr>
</tbody>
</table>
<p>File names can also not end with the following characters. These only
get replaced if they are the last character in the name:</p>
<table>
<thead>
<tr class="header">
<th>Character</th>
<th style="text-align: center;">Value</th>
<th style="text-align: center;">Replacement</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>.</td>
<td style="text-align: center;">0x2E</td>
<td style="text-align: center;">．</td>
</tr>
</tbody>
</table>
<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>
<h3 id="hashes-1">Hashes</h3>
<p>MD5 hashes are stored with blobs. However blobs that were uploaded in
chunks only have an MD5 if the source remote was capable of MD5 hashes,
e.g. the local disk.</p>
<h3 id="authenticating-with-azure-blob-storage">Authenticating with
Azure Blob Storage</h3>
<p>Rclone has 3 ways of authenticating with Azure Blob Storage:</p>
<h4 id="account-and-key">Account and Key</h4>
<p>This is the most straight forward and least flexible way. Just fill
in the <code>account</code> and <code>key</code> lines and leave the
rest blank.</p>
<h4 id="sas-url">SAS URL</h4>
<p>This can be an account level SAS URL or container level SAS URL.</p>
<p>To use it leave <code>account</code>, <code>key</code> blank and fill
in <code>sas_url</code>.</p>
<p>An account level SAS URL or container level SAS URL can be obtained
from the Azure portal or the Azure Storage Explorer. To get a container
level SAS URL right click on a container in the Azure Blob explorer in
the Azure portal.</p>
<p>If you use a container level SAS URL, rclone operations are permitted
only on a particular container, e.g.</p>
<pre><code>rclone ls azureblob:container</code></pre>
<p>You can also list the single container from the root. This will only
show the container specified by the SAS URL.</p>
<pre><code>$ rclone lsd azureblob:
container/</code></pre>
<p>Note that you can’t see or access any other containers - this will
fail</p>
<pre><code>rclone ls azureblob:othercontainer</code></pre>
<p>Container level SAS URLs are useful for temporarily allowing third
parties access to a single container or putting credentials into an
untrusted environment such as a CI build server.</p>
<h3 id="standard-options-27">Standard options</h3>
<p>Here are the Standard options specific to azureblob (Microsoft Azure
Blob Storage).</p>
<h4 id="azureblob-account">–azureblob-account</h4>
<p>Storage Account Name.</p>
<p>Leave blank to use SAS URL or Emulator.</p>
<p>Properties:</p>
<ul>
<li>Config: account</li>
<li>Env Var: RCLONE_AZUREBLOB_ACCOUNT</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4
id="azureblob-service-principal-file">–azureblob-service-principal-file</h4>
<p>Path to file containing credentials for use with a service
principal.</p>
<p>Leave blank normally. Needed only if you want to use a service
principal instead of interactive login.</p>
<pre><code>$ az ad sp create-for-rbac --name &quot;&lt;name&gt;&quot; \
  --role &quot;Storage Blob Data Owner&quot; \
  --scopes &quot;/subscriptions/&lt;subscription&gt;/resourceGroups/&lt;resource-group&gt;/providers/Microsoft.Storage/storageAccounts/&lt;storage-account&gt;/blobServices/default/containers/&lt;container&gt;&quot; \
  &gt; azure-principal.json</code></pre>
<p>See <a
href="https://docs.microsoft.com/en-us/cli/azure/create-an-azure-service-principal-azure-cli">“Create
an Azure service principal”</a> and <a
href="https://docs.microsoft.com/en-us/azure/storage/common/storage-auth-aad-rbac-cli">“Assign
an Azure role for access to blob data”</a> pages for more details.</p>
<p>Properties:</p>
<ul>
<li>Config: service_principal_file</li>
<li>Env Var: RCLONE_AZUREBLOB_SERVICE_PRINCIPAL_FILE</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="azureblob-key">–azureblob-key</h4>
<p>Storage Account Key.</p>
<p>Leave blank to use SAS URL or Emulator.</p>
<p>Properties:</p>
<ul>
<li>Config: key</li>
<li>Env Var: RCLONE_AZUREBLOB_KEY</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="azureblob-sas-url">–azureblob-sas-url</h4>
<p>SAS URL for container level access only.</p>
<p>Leave blank if using account/key or Emulator.</p>
<p>Properties:</p>
<ul>
<li>Config: sas_url</li>
<li>Env Var: RCLONE_AZUREBLOB_SAS_URL</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="azureblob-use-msi">–azureblob-use-msi</h4>
<p>Use a managed service identity to authenticate (only works in
Azure).</p>
<p>When true, use a <a
href="https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/">managed
service identity</a> to authenticate to Azure Storage instead of a SAS
token or account key.</p>
<p>If the VM(SS) on which this program is running has a system-assigned
identity, it will be used by default. If the resource has no
system-assigned but exactly one user-assigned identity, the
user-assigned identity will be used by default. If the resource has
multiple user-assigned identities, the identity to use must be
explicitly specified using exactly one of the msi_object_id,
msi_client_id, or msi_mi_res_id parameters.</p>
<p>Properties:</p>
<ul>
<li>Config: use_msi</li>
<li>Env Var: RCLONE_AZUREBLOB_USE_MSI</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="azureblob-use-emulator">–azureblob-use-emulator</h4>
<p>Uses local storage emulator if provided as ‘true’.</p>
<p>Leave blank if using real azure storage endpoint.</p>
<p>Properties:</p>
<ul>
<li>Config: use_emulator</li>
<li>Env Var: RCLONE_AZUREBLOB_USE_EMULATOR</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h3 id="advanced-options-26">Advanced options</h3>
<p>Here are the Advanced options specific to azureblob (Microsoft Azure
Blob Storage).</p>
<h4 id="azureblob-msi-object-id">–azureblob-msi-object-id</h4>
<p>Object ID of the user-assigned MSI to use, if any.</p>
<p>Leave blank if msi_client_id or msi_mi_res_id specified.</p>
<p>Properties:</p>
<ul>
<li>Config: msi_object_id</li>
<li>Env Var: RCLONE_AZUREBLOB_MSI_OBJECT_ID</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="azureblob-msi-client-id">–azureblob-msi-client-id</h4>
<p>Object ID of the user-assigned MSI to use, if any.</p>
<p>Leave blank if msi_object_id or msi_mi_res_id specified.</p>
<p>Properties:</p>
<ul>
<li>Config: msi_client_id</li>
<li>Env Var: RCLONE_AZUREBLOB_MSI_CLIENT_ID</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="azureblob-msi-mi-res-id">–azureblob-msi-mi-res-id</h4>
<p>Azure resource ID of the user-assigned MSI to use, if any.</p>
<p>Leave blank if msi_client_id or msi_object_id specified.</p>
<p>Properties:</p>
<ul>
<li>Config: msi_mi_res_id</li>
<li>Env Var: RCLONE_AZUREBLOB_MSI_MI_RES_ID</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="azureblob-endpoint">–azureblob-endpoint</h4>
<p>Endpoint for the service.</p>
<p>Leave blank normally.</p>
<p>Properties:</p>
<ul>
<li>Config: endpoint</li>
<li>Env Var: RCLONE_AZUREBLOB_ENDPOINT</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="azureblob-upload-cutoff">–azureblob-upload-cutoff</h4>
<p>Cutoff for switching to chunked upload (&lt;= 256 MiB)
(deprecated).</p>
<p>Properties:</p>
<ul>
<li>Config: upload_cutoff</li>
<li>Env Var: RCLONE_AZUREBLOB_UPLOAD_CUTOFF</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="azureblob-chunk-size">–azureblob-chunk-size</h4>
<p>Upload chunk size.</p>
<p>Note that this is stored in memory and there may be up to
“–transfers” * “–azureblob-upload-concurrency” chunks stored at once in
memory.</p>
<p>Properties:</p>
<ul>
<li>Config: chunk_size</li>
<li>Env Var: RCLONE_AZUREBLOB_CHUNK_SIZE</li>
<li>Type: SizeSuffix</li>
<li>Default: 4Mi</li>
</ul>
<h4 id="azureblob-upload-concurrency">–azureblob-upload-concurrency</h4>
<p>Concurrency for multipart uploads.</p>
<p>This is the number of chunks of the same file that are uploaded
concurrently.</p>
<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>
<p>In tests, upload speed increases almost linearly with upload
concurrency. For example to fill a gigabit pipe it may be necessary to
raise this to 64. Note that this will use more memory.</p>
<p>Note that chunks are stored in memory and there may be up to
“–transfers” * “–azureblob-upload-concurrency” chunks stored at once in
memory.</p>
<p>Properties:</p>
<ul>
<li>Config: upload_concurrency</li>
<li>Env Var: RCLONE_AZUREBLOB_UPLOAD_CONCURRENCY</li>
<li>Type: int</li>
<li>Default: 16</li>
</ul>
<h4 id="azureblob-list-chunk">–azureblob-list-chunk</h4>
<p>Size of blob list.</p>
<p>This sets the number of blobs requested in each listing chunk.
Default is the maximum, 5000. “List blobs” requests are permitted 2
minutes per megabyte to complete. If an operation is taking longer than
2 minutes per megabyte on average, it will time out ( <a
href="https://docs.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-blob-service-operations#exceptions-to-default-timeout-interval">source</a>
). This can be used to limit the number of blobs items to return, to
avoid the time out.</p>
<p>Properties:</p>
<ul>
<li>Config: list_chunk</li>
<li>Env Var: RCLONE_AZUREBLOB_LIST_CHUNK</li>
<li>Type: int</li>
<li>Default: 5000</li>
</ul>
<h4 id="azureblob-access-tier">–azureblob-access-tier</h4>
<p>Access tier of blob: hot, cool or archive.</p>
<p>Archived blobs can be restored by setting access tier to hot or cool.
Leave blank if you intend to use default access tier, which is set at
account level</p>
<p>If there is no “access tier” specified, rclone doesn’t apply any
tier. rclone performs “Set Tier” operation on blobs while uploading, if
objects are not modified, specifying “access tier” to new one will have
no effect. If blobs are in “archive tier” at remote, trying to perform
data transfer operations from remote will not be allowed. User should
first restore by tiering blob to “Hot” or “Cool”.</p>
<p>Properties:</p>
<ul>
<li>Config: access_tier</li>
<li>Env Var: RCLONE_AZUREBLOB_ACCESS_TIER</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4
id="azureblob-archive-tier-delete">–azureblob-archive-tier-delete</h4>
<p>Delete archive tier blobs before overwriting.</p>
<p>Archive tier blobs cannot be updated. So without this flag, if you
attempt to update an archive tier blob, then rclone will produce the
error:</p>
<pre><code>can&#39;t update archive tier blob without --azureblob-archive-tier-delete</code></pre>
<p>With this flag set then before rclone attempts to overwrite an
archive tier blob, it will delete the existing blob before uploading its
replacement. This has the potential for data loss if the upload fails
(unlike updating a normal blob) and also may cost more since deleting
archive tier blobs early may be chargable.</p>
<p>Properties:</p>
<ul>
<li>Config: archive_tier_delete</li>
<li>Env Var: RCLONE_AZUREBLOB_ARCHIVE_TIER_DELETE</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="azureblob-disable-checksum">–azureblob-disable-checksum</h4>
<p>Don’t store MD5 checksum with object metadata.</p>
<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>
<p>Properties:</p>
<ul>
<li>Config: disable_checksum</li>
<li>Env Var: RCLONE_AZUREBLOB_DISABLE_CHECKSUM</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4
id="azureblob-memory-pool-flush-time">–azureblob-memory-pool-flush-time</h4>
<p>How often internal memory buffer pools will be flushed.</p>
<p>Uploads which requires additional buffers (f.e multipart) will use
memory pool for allocations. This option controls how often unused
buffers will be removed from the pool.</p>
<p>Properties:</p>
<ul>
<li>Config: memory_pool_flush_time</li>
<li>Env Var: RCLONE_AZUREBLOB_MEMORY_POOL_FLUSH_TIME</li>
<li>Type: Duration</li>
<li>Default: 1m0s</li>
</ul>
<h4
id="azureblob-memory-pool-use-mmap">–azureblob-memory-pool-use-mmap</h4>
<p>Whether to use mmap buffers in internal memory pool.</p>
<p>Properties:</p>
<ul>
<li>Config: memory_pool_use_mmap</li>
<li>Env Var: RCLONE_AZUREBLOB_MEMORY_POOL_USE_MMAP</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="azureblob-encoding">–azureblob-encoding</h4>
<p>The encoding for the backend.</p>
<p>See the <a href="https://rclone.org/overview/#encoding">encoding
section in the overview</a> for more info.</p>
<p>Properties:</p>
<ul>
<li>Config: encoding</li>
<li>Env Var: RCLONE_AZUREBLOB_ENCODING</li>
<li>Type: MultiEncoder</li>
<li>Default: Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8</li>
</ul>
<h4 id="azureblob-public-access">–azureblob-public-access</h4>
<p>Public access level of a container: blob or container.</p>
<p>Properties:</p>
<ul>
<li>Config: public_access</li>
<li>Env Var: RCLONE_AZUREBLOB_PUBLIC_ACCESS</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“”
<ul>
<li>The container and its blobs can be accessed only with an authorized
request.</li>
<li>It’s a default value.</li>
</ul></li>
<li>“blob”
<ul>
<li>Blob data within this container can be read via anonymous
request.</li>
</ul></li>
<li>“container”
<ul>
<li>Allow full public read access for container and blob data.</li>
</ul></li>
</ul></li>
</ul>
<h4 id="azureblob-no-head-object">–azureblob-no-head-object</h4>
<p>If set, do not do HEAD before GET when getting objects.</p>
<p>Properties:</p>
<ul>
<li>Config: no_head_object</li>
<li>Env Var: RCLONE_AZUREBLOB_NO_HEAD_OBJECT</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h2 id="limitations-21">Limitations</h2>
<p>MD5 sums are only uploaded with chunked files if the source has an
MD5 sum. This will always be the case for a local to azure copy.</p>
<p><code>rclone about</code> is not supported by the Microsoft Azure
Blob storage backend. Backends without this capability cannot determine
free space for an rclone mount or use policy <code>mfs</code> (most free
space) as a member of an rclone union remote.</p>
<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>
<h2 id="azure-storage-emulator-support">Azure Storage Emulator
Support</h2>
<p>You can run rclone with storage emulator (usually
<em>azurite</em>).</p>
<p>To do this, just set up a new remote with <code>rclone config</code>
following instructions described in introduction and set
<code>use_emulator</code> config as <code>true</code>. You do not need
to provide default account name neither an account key.</p>
<p>Also, if you want to access a storage emulator instance running on a
different machine, you can override <em>Endpoint</em> parameter in
advanced settings, setting it to
<code>http(s)://&lt;host&gt;:&lt;port&gt;/devstoreaccount1</code>
(e.g. <code>http://10.254.2.5:10000/devstoreaccount1</code>).</p>
<h1 id="microsoft-onedrive">Microsoft OneDrive</h1>
<p>Paths are specified as <code>remote:path</code></p>
<p>Paths may be as deep as required,
e.g. <code>remote:directory/subdirectory</code>.</p>
<h2 id="configuration-29">Configuration</h2>
<p>The initial setup for OneDrive involves getting a token from
Microsoft which you need to do in your browser.
<code>rclone config</code> walks you through it.</p>
<p>Here is an example of how to make a remote called
<code>remote</code>. First run:</p>
<pre><code> rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<pre><code>e) Edit existing remote
n) New remote
d) Delete remote
r) Rename remote
c) Copy remote
s) Set configuration password
q) Quit config
e/n/d/r/c/s/q&gt; n
name&gt; remote
Type of storage to configure.
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
[snip]
XX / Microsoft OneDrive
   \ &quot;onedrive&quot;
[snip]
Storage&gt; onedrive
Microsoft App Client Id
Leave blank normally.
Enter a string value. Press Enter for the default (&quot;&quot;).
client_id&gt;
Microsoft App Client Secret
Leave blank normally.
Enter a string value. Press Enter for the default (&quot;&quot;).
client_secret&gt;
Edit advanced config? (y/n)
y) Yes
n) No
y/n&gt; n
Remote config
Use auto config?
 * Say Y if not sure
 * Say N if you are working on a remote or headless machine
y) Yes
n) No
y/n&gt; y
If your browser doesn&#39;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
   \ &quot;onedrive&quot;
 2 / Sharepoint site
   \ &quot;sharepoint&quot;
 3 / Type in driveID
   \ &quot;driveid&quot;
 4 / Type in SiteID
   \ &quot;siteid&quot;
 5 / Search a Sharepoint site
   \ &quot;search&quot;
Your choice&gt; 1
Found 1 drives, please select the one you want to use:
0: OneDrive (business) id=b!Eqwertyuiopasdfghjklzxcvbnm-7mnbvcxzlkjhgfdsapoiuytrewqk
Chose drive to use:&gt; 0
Found drive &#39;root&#39; of type &#39;business&#39;, URL: https://org-my.sharepoint.com/personal/you/Documents
Is that okay?
y) Yes
n) No
y/n&gt; y
--------------------
[remote]
type = onedrive
token = {&quot;access_token&quot;:&quot;youraccesstoken&quot;,&quot;token_type&quot;:&quot;Bearer&quot;,&quot;refresh_token&quot;:&quot;yourrefreshtoken&quot;,&quot;expiry&quot;:&quot;2018-08-26T22:39:52.486512262+08:00&quot;}
drive_id = b!Eqwertyuiopasdfghjklzxcvbnm-7mnbvcxzlkjhgfdsapoiuytrewqk
drive_type = business
--------------------
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<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>
<p>Note that rclone runs a webserver on your local machine to collect
the token as returned from Microsoft. This only runs from the moment it
opens your browser to the moment you get back the verification code.
This is on <code>http://127.0.0.1:53682/</code> and this it may require
you to unblock it temporarily if you are running a host firewall.</p>
<p>Once configured you can then use <code>rclone</code> like this,</p>
<p>List directories in top level of your OneDrive</p>
<pre><code>rclone lsd remote:</code></pre>
<p>List all the files in your OneDrive</p>
<pre><code>rclone ls remote:</code></pre>
<p>To copy a local directory to an OneDrive directory called backup</p>
<pre><code>rclone copy /home/source remote:backup</code></pre>
<h3 id="getting-your-own-client-id-and-key">Getting your own Client ID
and Key</h3>
<p>rclone uses a default Client ID when talking to OneDrive, unless a
custom <code>client_id</code> is specified in the config. The default
Client ID and Key are shared by all rclone users when performing
requests.</p>
<p>You may choose to create and use your own Client ID, in case the
default one does not work well for you. For example, you might see
throttling.</p>
<h4 id="creating-client-id-for-onedrive-personal">Creating Client ID for
OneDrive Personal</h4>
<p>To create your own Client ID, please follow these steps:</p>
<ol type="1">
<li>Open
https://portal.azure.com/#blade/Microsoft_AAD_RegisteredApps/ApplicationsListBlade
and then click <code>New registration</code>.</li>
<li>Enter a name for your app, choose account type
<code>Accounts in any organizational directory (Any Azure AD directory - Multitenant) and personal Microsoft accounts (e.g. Skype, Xbox)</code>,
select <code>Web</code> in <code>Redirect URI</code>, then type (do not
copy and paste) <code>http://localhost:53682/</code> and click Register.
Copy and keep the <code>Application (client) ID</code> under the app
name for later use.</li>
<li>Under <code>manage</code> select
<code>Certificates &amp; secrets</code>, click
<code>New client secret</code>. Enter a description (can be anything)
and set <code>Expires</code> to 24 months. Copy and keep that secret
<em>Value</em> for later use (you <em>won’t</em> be able to see this
value afterwards).</li>
<li>Under <code>manage</code> select <code>API permissions</code>, click
<code>Add a permission</code> and select <code>Microsoft Graph</code>
then select <code>delegated permissions</code>.</li>
<li>Search and select the following permissions:
<code>Files.Read</code>, <code>Files.ReadWrite</code>,
<code>Files.Read.All</code>, <code>Files.ReadWrite.All</code>,
<code>offline_access</code>, <code>User.Read</code> and
<code>Sites.Read.All</code> (if custom access scopes are configured,
select the permissions accordingly). Once selected click
<code>Add permissions</code> at the bottom.</li>
</ol>
<p>Now the application is complete. Run <code>rclone config</code> to
create or edit a OneDrive remote. Supply the app ID and password as
Client ID and Secret, respectively. rclone will walk you through the
remaining steps.</p>
<p>The access_scopes option allows you to configure the permissions
requested by rclone. See <a
href="https://docs.microsoft.com/en-us/graph/permissions-reference#files-permissions">Microsoft
Docs</a> for more information about the different scopes.</p>
<p>The <code>Sites.Read.All</code> permission is required if you need to
<a href="https://github.com/rclone/rclone/pull/5883">search SharePoint
sites when configuring the remote</a>. However, if that permission is
not assigned, you need to exclude <code>Sites.Read.All</code> from your
access scopes or set <code>disable_site_permission</code> option to true
in the advanced options.</p>
<h4 id="creating-client-id-for-onedrive-business">Creating Client ID for
OneDrive Business</h4>
<p>The steps for OneDrive Personal may or may not work for OneDrive
Business, depending on the security settings of the organization. A
common error is that the publisher of the App is not verified.</p>
<p>You may try to <a
href="https://docs.microsoft.com/en-us/azure/active-directory/develop/publisher-verification-overview">verify
you account</a>, or try to limit the App to your organization only, as
shown below.</p>
<ol type="1">
<li>Make sure to create the App with your business account.</li>
<li>Follow the steps above to create an App. However, we need a
different account type here:
<code>Accounts in this organizational directory only (*** - Single tenant)</code>.
Note that you can also change the account type after creating the
App.</li>
<li>Find the <a
href="https://docs.microsoft.com/en-us/azure/active-directory/fundamentals/active-directory-how-to-find-tenant">tenant
ID</a> of your organization.</li>
<li>In the rclone config, set <code>auth_url</code> to
<code>https://login.microsoftonline.com/YOUR_TENANT_ID/oauth2/v2.0/authorize</code>.</li>
<li>In the rclone config, set <code>token_url</code> to
<code>https://login.microsoftonline.com/YOUR_TENANT_ID/oauth2/v2.0/token</code>.</li>
</ol>
<p>Note: If you have a special region, you may need a different host in
step 4 and 5. Here are <a
href="https://github.com/rclone/rclone/blob/bc23bf11db1c78c6ebbf8ea538fbebf7058b4176/backend/onedrive/onedrive.go#L86">some
hints</a>.</p>
<h3 id="modification-time-and-hashes">Modification time and hashes</h3>
<p>OneDrive allows modification times to be set on objects accurate to 1
second. These will be used to detect whether objects need syncing or
not.</p>
<p>OneDrive personal supports SHA1 type hashes. OneDrive for business
and Sharepoint Server support <a
href="https://docs.microsoft.com/en-us/onedrive/developer/code-snippets/quickxorhash">QuickXorHash</a>.</p>
<p>For all types of OneDrive you can use the <code>--checksum</code>
flag.</p>
<h3 id="restricted-filename-characters-19">Restricted filename
characters</h3>
<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>
<table>
<thead>
<tr class="header">
<th>Character</th>
<th style="text-align: center;">Value</th>
<th style="text-align: center;">Replacement</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>”</td>
<td style="text-align: center;">0x22</td>
<td style="text-align: center;">＂</td>
</tr>
<tr class="even">
<td>*</td>
<td style="text-align: center;">0x2A</td>
<td style="text-align: center;">＊</td>
</tr>
<tr class="odd">
<td>:</td>
<td style="text-align: center;">0x3A</td>
<td style="text-align: center;">：</td>
</tr>
<tr class="even">
<td>&lt;</td>
<td style="text-align: center;">0x3C</td>
<td style="text-align: center;">＜</td>
</tr>
<tr class="odd">
<td>&gt;</td>
<td style="text-align: center;">0x3E</td>
<td style="text-align: center;">＞</td>
</tr>
<tr class="even">
<td>?</td>
<td style="text-align: center;">0x3F</td>
<td style="text-align: center;">？</td>
</tr>
<tr class="odd">
<td>\</td>
<td style="text-align: center;">0x5C</td>
<td style="text-align: center;">＼</td>
</tr>
<tr class="even">
<td>|</td>
<td style="text-align: center;">0x7C</td>
<td style="text-align: center;">｜</td>
</tr>
</tbody>
</table>
<p>File names can also not end with the following characters. These only
get replaced if they are the last character in the name:</p>
<table>
<thead>
<tr class="header">
<th>Character</th>
<th style="text-align: center;">Value</th>
<th style="text-align: center;">Replacement</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>SP</td>
<td style="text-align: center;">0x20</td>
<td style="text-align: center;">␠</td>
</tr>
<tr class="even">
<td>.</td>
<td style="text-align: center;">0x2E</td>
<td style="text-align: center;">．</td>
</tr>
</tbody>
</table>
<p>File names can also not begin with the following characters. These
only get replaced if they are the first character in the name:</p>
<table>
<thead>
<tr class="header">
<th>Character</th>
<th style="text-align: center;">Value</th>
<th style="text-align: center;">Replacement</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>SP</td>
<td style="text-align: center;">0x20</td>
<td style="text-align: center;">␠</td>
</tr>
<tr class="even">
<td>~</td>
<td style="text-align: center;">0x7E</td>
<td style="text-align: center;">～</td>
</tr>
</tbody>
</table>
<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>
<h3 id="deleting-files-5">Deleting files</h3>
<p>Any files you delete with rclone will end up in the trash. Microsoft
doesn’t provide an API to permanently delete files, nor to empty the
trash, so you will have to do that with one of Microsoft’s apps or via
the OneDrive website.</p>
<h3 id="standard-options-28">Standard options</h3>
<p>Here are the Standard options specific to onedrive (Microsoft
OneDrive).</p>
<h4 id="onedrive-client-id">–onedrive-client-id</h4>
<p>OAuth Client Id.</p>
<p>Leave blank normally.</p>
<p>Properties:</p>
<ul>
<li>Config: client_id</li>
<li>Env Var: RCLONE_ONEDRIVE_CLIENT_ID</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="onedrive-client-secret">–onedrive-client-secret</h4>
<p>OAuth Client Secret.</p>
<p>Leave blank normally.</p>
<p>Properties:</p>
<ul>
<li>Config: client_secret</li>
<li>Env Var: RCLONE_ONEDRIVE_CLIENT_SECRET</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="onedrive-region">–onedrive-region</h4>
<p>Choose national cloud region for OneDrive.</p>
<p>Properties:</p>
<ul>
<li>Config: region</li>
<li>Env Var: RCLONE_ONEDRIVE_REGION</li>
<li>Type: string</li>
<li>Default: “global”</li>
<li>Examples:
<ul>
<li>“global”
<ul>
<li>Microsoft Cloud Global</li>
</ul></li>
<li>“us”
<ul>
<li>Microsoft Cloud for US Government</li>
</ul></li>
<li>“de”
<ul>
<li>Microsoft Cloud Germany</li>
</ul></li>
<li>“cn”
<ul>
<li>Azure and Office 365 operated by Vnet Group in China</li>
</ul></li>
</ul></li>
</ul>
<h3 id="advanced-options-27">Advanced options</h3>
<p>Here are the Advanced options specific to onedrive (Microsoft
OneDrive).</p>
<h4 id="onedrive-token">–onedrive-token</h4>
<p>OAuth Access Token as a JSON blob.</p>
<p>Properties:</p>
<ul>
<li>Config: token</li>
<li>Env Var: RCLONE_ONEDRIVE_TOKEN</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="onedrive-auth-url">–onedrive-auth-url</h4>
<p>Auth server URL.</p>
<p>Leave blank to use the provider defaults.</p>
<p>Properties:</p>
<ul>
<li>Config: auth_url</li>
<li>Env Var: RCLONE_ONEDRIVE_AUTH_URL</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="onedrive-token-url">–onedrive-token-url</h4>
<p>Token server url.</p>
<p>Leave blank to use the provider defaults.</p>
<p>Properties:</p>
<ul>
<li>Config: token_url</li>
<li>Env Var: RCLONE_ONEDRIVE_TOKEN_URL</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="onedrive-chunk-size">–onedrive-chunk-size</h4>
<p>Chunk size to upload files with - must be multiple of 320k (327,680
bytes).</p>
<p>Above this size files will be chunked - must be multiple of 320k
(327,680 bytes) and should not exceed 250M (262,144,000 bytes) else you
may encounter "Microsoft.SharePoint.Client.InvalidClientQueryException:
The request message is too big." Note that the chunks will be buffered
into memory.</p>
<p>Properties:</p>
<ul>
<li>Config: chunk_size</li>
<li>Env Var: RCLONE_ONEDRIVE_CHUNK_SIZE</li>
<li>Type: SizeSuffix</li>
<li>Default: 10Mi</li>
</ul>
<h4 id="onedrive-drive-id">–onedrive-drive-id</h4>
<p>The ID of the drive to use.</p>
<p>Properties:</p>
<ul>
<li>Config: drive_id</li>
<li>Env Var: RCLONE_ONEDRIVE_DRIVE_ID</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="onedrive-drive-type">–onedrive-drive-type</h4>
<p>The type of the drive (personal | business | documentLibrary).</p>
<p>Properties:</p>
<ul>
<li>Config: drive_type</li>
<li>Env Var: RCLONE_ONEDRIVE_DRIVE_TYPE</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="onedrive-root-folder-id">–onedrive-root-folder-id</h4>
<p>ID of the root folder.</p>
<p>This isn’t normally needed, but in special circumstances you might
know the folder ID that you wish to access but not be able to get there
through a path traversal.</p>
<p>Properties:</p>
<ul>
<li>Config: root_folder_id</li>
<li>Env Var: RCLONE_ONEDRIVE_ROOT_FOLDER_ID</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="onedrive-access-scopes">–onedrive-access-scopes</h4>
<p>Set scopes to be requested by rclone.</p>
<p>Choose or manually enter a custom space separated list with all
scopes, that rclone should request.</p>
<p>Properties:</p>
<ul>
<li>Config: access_scopes</li>
<li>Env Var: RCLONE_ONEDRIVE_ACCESS_SCOPES</li>
<li>Type: SpaceSepList</li>
<li>Default: Files.Read Files.ReadWrite Files.Read.All
Files.ReadWrite.All Sites.Read.All offline_access</li>
<li>Examples:
<ul>
<li>“Files.Read Files.ReadWrite Files.Read.All Files.ReadWrite.All
Sites.Read.All offline_access”
<ul>
<li>Read and write access to all resources</li>
</ul></li>
<li>“Files.Read Files.Read.All Sites.Read.All offline_access”
<ul>
<li>Read only access to all resources</li>
</ul></li>
<li>“Files.Read Files.ReadWrite Files.Read.All Files.ReadWrite.All
offline_access”
<ul>
<li>Read and write access to all resources, without the ability to
browse SharePoint sites.</li>
<li>Same as if disable_site_permission was set to true</li>
</ul></li>
</ul></li>
</ul>
<h4
id="onedrive-disable-site-permission">–onedrive-disable-site-permission</h4>
<p>Disable the request for Sites.Read.All permission.</p>
<p>If set to true, you will no longer be able to search for a SharePoint
site when configuring drive ID, because rclone will not request
Sites.Read.All permission. Set it to true if your organization didn’t
assign Sites.Read.All permission to the application, and your
organization disallows users to consent app permission request on their
own.</p>
<p>Properties:</p>
<ul>
<li>Config: disable_site_permission</li>
<li>Env Var: RCLONE_ONEDRIVE_DISABLE_SITE_PERMISSION</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4
id="onedrive-expose-onenote-files">–onedrive-expose-onenote-files</h4>
<p>Set to make OneNote files show up in directory listings.</p>
<p>By default, rclone will hide OneNote files in directory listings
because operations like “Open” and “Update” won’t work on them. But this
behaviour may also prevent you from deleting them. If you want to delete
OneNote files or otherwise want them to show up in directory listing,
set this option.</p>
<p>Properties:</p>
<ul>
<li>Config: expose_onenote_files</li>
<li>Env Var: RCLONE_ONEDRIVE_EXPOSE_ONENOTE_FILES</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4
id="onedrive-server-side-across-configs">–onedrive-server-side-across-configs</h4>
<p>Allow server-side operations (e.g. copy) to work across different
onedrive configs.</p>
<p>This will only work if you are copying between two OneDrive
<em>Personal</em> drives AND the files to copy are already shared
between them. In other cases, rclone will fall back to normal copy
(which will be slightly slower).</p>
<p>Properties:</p>
<ul>
<li>Config: server_side_across_configs</li>
<li>Env Var: RCLONE_ONEDRIVE_SERVER_SIDE_ACROSS_CONFIGS</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="onedrive-list-chunk">–onedrive-list-chunk</h4>
<p>Size of listing chunk.</p>
<p>Properties:</p>
<ul>
<li>Config: list_chunk</li>
<li>Env Var: RCLONE_ONEDRIVE_LIST_CHUNK</li>
<li>Type: int</li>
<li>Default: 1000</li>
</ul>
<h4 id="onedrive-no-versions">–onedrive-no-versions</h4>
<p>Remove all versions on modifying operations.</p>
<p>Onedrive for business creates versions when rclone uploads new files
overwriting an existing one and when it sets the modification time.</p>
<p>These versions take up space out of the quota.</p>
<p>This flag checks for versions after file upload and setting
modification time and removes all but the last version.</p>
<p><strong>NB</strong> Onedrive personal can’t currently delete versions
so don’t use this flag there.</p>
<p>Properties:</p>
<ul>
<li>Config: no_versions</li>
<li>Env Var: RCLONE_ONEDRIVE_NO_VERSIONS</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="onedrive-link-scope">–onedrive-link-scope</h4>
<p>Set the scope of the links created by the link command.</p>
<p>Properties:</p>
<ul>
<li>Config: link_scope</li>
<li>Env Var: RCLONE_ONEDRIVE_LINK_SCOPE</li>
<li>Type: string</li>
<li>Default: “anonymous”</li>
<li>Examples:
<ul>
<li>“anonymous”
<ul>
<li>Anyone with the link has access, without needing to sign in.</li>
<li>This may include people outside of your organization.</li>
<li>Anonymous link support may be disabled by an administrator.</li>
</ul></li>
<li>“organization”
<ul>
<li>Anyone signed into your organization (tenant) can use the link to
get access.</li>
<li>Only available in OneDrive for Business and SharePoint.</li>
</ul></li>
</ul></li>
</ul>
<h4 id="onedrive-link-type">–onedrive-link-type</h4>
<p>Set the type of the links created by the link command.</p>
<p>Properties:</p>
<ul>
<li>Config: link_type</li>
<li>Env Var: RCLONE_ONEDRIVE_LINK_TYPE</li>
<li>Type: string</li>
<li>Default: “view”</li>
<li>Examples:
<ul>
<li>“view”
<ul>
<li>Creates a read-only link to the item.</li>
</ul></li>
<li>“edit”
<ul>
<li>Creates a read-write link to the item.</li>
</ul></li>
<li>“embed”
<ul>
<li>Creates an embeddable link to the item.</li>
</ul></li>
</ul></li>
</ul>
<h4 id="onedrive-link-password">–onedrive-link-password</h4>
<p>Set the password for links created by the link command.</p>
<p>At the time of writing this only works with OneDrive personal paid
accounts.</p>
<p>Properties:</p>
<ul>
<li>Config: link_password</li>
<li>Env Var: RCLONE_ONEDRIVE_LINK_PASSWORD</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="onedrive-encoding">–onedrive-encoding</h4>
<p>The encoding for the backend.</p>
<p>See the <a href="https://rclone.org/overview/#encoding">encoding
section in the overview</a> for more info.</p>
<p>Properties:</p>
<ul>
<li>Config: encoding</li>
<li>Env Var: RCLONE_ONEDRIVE_ENCODING</li>
<li>Type: MultiEncoder</li>
<li>Default:
Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot</li>
</ul>
<h2 id="limitations-22">Limitations</h2>
<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>
<h3 id="naming">Naming</h3>
<p>Note that OneDrive is case insensitive so you can’t have a file
called “Hello.doc” and one called “hello.doc”.</p>
<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>
<h3 id="file-sizes">File sizes</h3>
<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&amp;rs=en-us&amp;ad=us#individualfilesize">(Updated
13 Jan 2021)</a>.</p>
<h3 id="path-length">Path length</h3>
<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>
<h3 id="number-of-files">Number of files</h3>
<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>
<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>
<h2 id="versions-4">Versions</h2>
<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>
<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>
<p>You can use the <code>rclone cleanup</code> command (see below) to
remove all old versions.</p>
<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>
<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>
<h3 id="disabling-versioning">Disabling versioning</h3>
<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>
<ol type="1">
<li><code>Install-Module -Name Microsoft.Online.SharePoint.PowerShell</code>
(in case you haven’t installed this already)</li>
<li><code>Import-Module Microsoft.Online.SharePoint.PowerShell -DisableNameChecking</code></li>
<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>
<li><code>Set-SPOTenant -EnableMinimumVersionRequirement $False</code></li>
<li><code>Disconnect-SPOService</code> (to disconnect from the
server)</li>
</ol>
<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>
<p>User <a href="https://github.com/Weropol">Weropol</a> has found a
method to disable versioning on OneDrive</p>
<ol type="1">
<li>Open the settings menu by clicking on the gear symbol at the top of
the OneDrive Business page.</li>
<li>Click Site settings.</li>
<li>Once on the Site settings page, navigate to Site Administration &gt;
Site libraries and lists.</li>
<li>Click Customize “Documents”.</li>
<li>Click General Settings &gt; Versioning Settings.</li>
<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>
<li>Apply the changes by clicking OK.</li>
<li>Use rclone to upload or modify files. (I also use the
–no-update-modtime flag)</li>
<li>Restore the versioning settings after using rclone. (Optional)</li>
</ol>
<h2 id="cleanup-3">Cleanup</h2>
<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>-i</code> which is a great way to see what it would do.</p>
<pre><code>rclone cleanup -i remote:path/subdir # interactively remove all old version for path/subdir
rclone cleanup remote:path/subdir    # unconditionally remove all old version for path/subdir</code></pre>
<p><strong>NB</strong> Onedrive personal can’t currently delete
versions</p>
<h2 id="troubleshooting-2">Troubleshooting</h2>
<h3 id="excessive-throttling-or-blocked-on-sharepoint">Excessive
throttling or blocked on SharePoint</h3>
<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>
<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>
<h3 id="unexpected-file-sizehash-differences-on-sharepoint">Unexpected
file size/hash differences on Sharepoint</h3>
<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>
<pre><code>--ignore-checksum --ignore-size</code></pre>
<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>
<h3
id="replacingdeleting-existing-files-on-sharepoint-gets-item-not-found">Replacing/deleting
existing files on Sharepoint gets “item not found”</h3>
<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 &lt;BACKUP_DIR&gt;</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>
<pre><code>--backup-dir mysharepoint:rclone-backup-dir</code></pre>
<h3 id="access_denied-aadsts65005">access_denied (AADSTS65005)</h3>
<pre><code>Error: access_denied
Code: AADSTS65005
Description: Using application &#39;rclone&#39; 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>
<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>
<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>
<h3 id="invalid_grant-aadsts50076">invalid_grant (AADSTS50076)</h3>
<pre><code>Error: invalid_grant
Code: AADSTS50076
Description: Due to a configuration change made by your administrator, or because you moved to a new location, you must use multi-factor authentication to access &#39;...&#39;.</code></pre>
<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>
<h3 id="invalid-request-when-making-public-links">Invalid request when
making public links</h3>
<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>
<h1 id="opendrive">OpenDrive</h1>
<p>Paths are specified as <code>remote:path</code></p>
<p>Paths may be as deep as required,
e.g. <code>remote:directory/subdirectory</code>.</p>
<h2 id="configuration-30">Configuration</h2>
<p>Here is an example of how to make a remote called
<code>remote</code>. First run:</p>
<pre><code> rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<pre><code>n) New remote
d) Delete remote
q) Quit config
e/n/d/q&gt; n
name&gt; remote
Type of storage to configure.
Choose a number from below, or type in your own value
[snip]
XX / OpenDrive
   \ &quot;opendrive&quot;
[snip]
Storage&gt; opendrive
Username
username&gt;
Password
y) Yes type in my own password
g) Generate random password
y/g&gt; y
Enter the password:
password:
Confirm the password:
password:
--------------------
[remote]
username =
password = *** ENCRYPTED ***
--------------------
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<p>List directories in top level of your OpenDrive</p>
<pre><code>rclone lsd remote:</code></pre>
<p>List all the files in your OpenDrive</p>
<pre><code>rclone ls remote:</code></pre>
<p>To copy a local directory to an OpenDrive directory called backup</p>
<pre><code>rclone copy /home/source remote:backup</code></pre>
<h3 id="modified-time-and-md5sums-1">Modified time and MD5SUMs</h3>
<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>
<h3 id="restricted-filename-characters-20">Restricted filename
characters</h3>
<table>
<thead>
<tr class="header">
<th>Character</th>
<th style="text-align: center;">Value</th>
<th style="text-align: center;">Replacement</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>NUL</td>
<td style="text-align: center;">0x00</td>
<td style="text-align: center;">␀</td>
</tr>
<tr class="even">
<td>/</td>
<td style="text-align: center;">0x2F</td>
<td style="text-align: center;">／</td>
</tr>
<tr class="odd">
<td>”</td>
<td style="text-align: center;">0x22</td>
<td style="text-align: center;">＂</td>
</tr>
<tr class="even">
<td>*</td>
<td style="text-align: center;">0x2A</td>
<td style="text-align: center;">＊</td>
</tr>
<tr class="odd">
<td>:</td>
<td style="text-align: center;">0x3A</td>
<td style="text-align: center;">：</td>
</tr>
<tr class="even">
<td>&lt;</td>
<td style="text-align: center;">0x3C</td>
<td style="text-align: center;">＜</td>
</tr>
<tr class="odd">
<td>&gt;</td>
<td style="text-align: center;">0x3E</td>
<td style="text-align: center;">＞</td>
</tr>
<tr class="even">
<td>?</td>
<td style="text-align: center;">0x3F</td>
<td style="text-align: center;">？</td>
</tr>
<tr class="odd">
<td>\</td>
<td style="text-align: center;">0x5C</td>
<td style="text-align: center;">＼</td>
</tr>
<tr class="even">
<td>|</td>
<td style="text-align: center;">0x7C</td>
<td style="text-align: center;">｜</td>
</tr>
</tbody>
</table>
<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>
<table>
<thead>
<tr class="header">
<th>Character</th>
<th style="text-align: center;">Value</th>
<th style="text-align: center;">Replacement</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>SP</td>
<td style="text-align: center;">0x20</td>
<td style="text-align: center;">␠</td>
</tr>
<tr class="even">
<td>HT</td>
<td style="text-align: center;">0x09</td>
<td style="text-align: center;">␉</td>
</tr>
<tr class="odd">
<td>LF</td>
<td style="text-align: center;">0x0A</td>
<td style="text-align: center;">␊</td>
</tr>
<tr class="even">
<td>VT</td>
<td style="text-align: center;">0x0B</td>
<td style="text-align: center;">␋</td>
</tr>
<tr class="odd">
<td>CR</td>
<td style="text-align: center;">0x0D</td>
<td style="text-align: center;">␍</td>
</tr>
</tbody>
</table>
<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>
<h3 id="standard-options-29">Standard options</h3>
<p>Here are the Standard options specific to opendrive (OpenDrive).</p>
<h4 id="opendrive-username">–opendrive-username</h4>
<p>Username.</p>
<p>Properties:</p>
<ul>
<li>Config: username</li>
<li>Env Var: RCLONE_OPENDRIVE_USERNAME</li>
<li>Type: string</li>
<li>Required: true</li>
</ul>
<h4 id="opendrive-password">–opendrive-password</h4>
<p>Password.</p>
<p><strong>NB</strong> Input to this must be obscured - see <a
href="https://rclone.org/commands/rclone_obscure/">rclone
obscure</a>.</p>
<p>Properties:</p>
<ul>
<li>Config: password</li>
<li>Env Var: RCLONE_OPENDRIVE_PASSWORD</li>
<li>Type: string</li>
<li>Required: true</li>
</ul>
<h3 id="advanced-options-28">Advanced options</h3>
<p>Here are the Advanced options specific to opendrive (OpenDrive).</p>
<h4 id="opendrive-encoding">–opendrive-encoding</h4>
<p>The encoding for the backend.</p>
<p>See the <a href="https://rclone.org/overview/#encoding">encoding
section in the overview</a> for more info.</p>
<p>Properties:</p>
<ul>
<li>Config: encoding</li>
<li>Env Var: RCLONE_OPENDRIVE_ENCODING</li>
<li>Type: MultiEncoder</li>
<li>Default:
Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,LeftSpace,LeftCrLfHtVt,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot</li>
</ul>
<h4 id="opendrive-chunk-size">–opendrive-chunk-size</h4>
<p>Files will be uploaded in chunks this size.</p>
<p>Note that these chunks are buffered in memory so increasing them will
increase memory use.</p>
<p>Properties:</p>
<ul>
<li>Config: chunk_size</li>
<li>Env Var: RCLONE_OPENDRIVE_CHUNK_SIZE</li>
<li>Type: SizeSuffix</li>
<li>Default: 10Mi</li>
</ul>
<h2 id="limitations-23">Limitations</h2>
<p>Note that OpenDrive is case insensitive so you can’t have a file
called “Hello.doc” and one called “hello.doc”.</p>
<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>
<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>
<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>
<h1 id="oracle-object-storage">Oracle Object Storage</h1>
<p><a
href="https://docs.oracle.com/en-us/iaas/Content/Object/Concepts/objectstorageoverview.htm">Oracle
Object Storage Overview</a></p>
<p><a
href="https://www.oracle.com/cloud/storage/object-storage/faq/">Oracle
Object Storage FAQ</a></p>
<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>
<h2 id="configuration-31">Configuration</h2>
<p>Here is an example of making an oracle object storage configuration.
<code>rclone config</code> walks you through it.</p>
<p>Here is an example of how to make a remote called
<code>remote</code>. First run:</p>
<pre><code> rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<pre><code>n) New remote
d) Delete remote
r) Rename remote
c) Copy remote
s) Set configuration password
q) Quit config
e/n/d/r/c/s/q&gt; n

Enter name for new remote.
name&gt; remote

Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
[snip]
XX / Oracle Cloud Infrastructure Object Storage
   \ (oracleobjectstorage)
Storage&gt; oracleobjectstorage

Option provider.
Choose your Auth Provider
Choose a number from below, or type in your own string value.
Press Enter for the default (env_auth).
 1 / automatically pickup the credentials from runtime(env), first one to provide auth wins
   \ (env_auth)
   / use an OCI user and an API key for authentication.
 2 | you’ll need to put in a config file your tenancy OCID, user OCID, region, the path, fingerprint to an API key.
   | https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdkconfig.htm
   \ (user_principal_auth)
   / use instance principals to authorize an instance to make API calls. 
 3 | each instance has its own identity, and authenticates using the certificates that are read from instance metadata. 
   | https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/callingservicesfrominstances.htm
   \ (instance_principal_auth)
 4 / use resource principals to make API calls
   \ (resource_principal_auth)
 5 / no credentials needed, this is typically for reading public buckets
   \ (no_auth)
provider&gt; 2

Option namespace.
Object storage namespace
Enter a value.
namespace&gt; idbamagbg734

Option compartment.
Object storage compartment OCID
Enter a value.
compartment&gt; ocid1.compartment.oc1..aaaaaaaapufkxc7ame3sthry5i7ujrwfc7ejnthhu6bhanm5oqfjpyasjkba

Option region.
Object storage Region
Enter a value.
region&gt; us-ashburn-1

Option endpoint.
Endpoint for Object storage API.
Leave blank to use the default endpoint for the region.
Enter a value. Press Enter to leave empty.
endpoint&gt;

Option config_file.
Path to OCI config file
Choose a number from below, or type in your own string value.
Press Enter for the default (~/.oci/config).
 1 / oci configuration file location
   \ (~/.oci/config)
config_file&gt; /etc/oci/dev.conf

Option config_profile.
Profile name inside OCI config file
Choose a number from below, or type in your own string value.
Press Enter for the default (Default).
 1 / Use the default profile
   \ (Default)
config_profile&gt; Test

Edit advanced config?
y) Yes
n) No (default)
y/n&gt; n

Configuration complete.
Options:
- type: oracleobjectstorage
- namespace: idbamagbg734
- compartment: ocid1.compartment.oc1..aaaaaaaapufkxc7ame3sthry5i7ujrwfc7ejnthhu6bhanm5oqfjpyasjkba
- region: us-ashburn-1
- provider: user_principal_auth
- config_file: /etc/oci/dev.conf
- config_profile: Test
Keep this &quot;remote&quot; remote?
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<p>See all buckets</p>
<pre><code>rclone lsd remote:</code></pre>
<p>Create a new bucket</p>
<pre><code>rclone mkdir remote:bucket</code></pre>
<p>List the contents of a bucket</p>
<pre><code>rclone ls remote:bucket
rclone ls remote:bucket --max-depth 1</code></pre>
<h3 id="modified-time-10">Modified time</h3>
<p>The modified 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>
<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>
<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>
<h3 id="multipart-uploads-1">Multipart uploads</h3>
<p>rclone supports multipart uploads with OOS which means that it can
upload files bigger than 5 GiB.</p>
<p>Note that files uploaded <em>both</em> with multipart upload
<em>and</em> through crypt remotes do not have MD5 sums.</p>
<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>
<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>
<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>
<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>
<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>
<h3 id="standard-options-30">Standard options</h3>
<p>Here are the Standard options specific to oracleobjectstorage (Oracle
Cloud Infrastructure Object Storage).</p>
<h4 id="oos-provider">–oos-provider</h4>
<p>Choose your Auth Provider</p>
<p>Properties:</p>
<ul>
<li>Config: provider</li>
<li>Env Var: RCLONE_OOS_PROVIDER</li>
<li>Type: string</li>
<li>Default: “env_auth”</li>
<li>Examples:
<ul>
<li>“env_auth”
<ul>
<li>automatically pickup the credentials from runtime(env), first one to
provide auth wins</li>
</ul></li>
<li>“user_principal_auth”
<ul>
<li>use an OCI user and an API key for authentication.</li>
<li>you’ll need to put in a config file your tenancy OCID, user OCID,
region, the path, fingerprint to an API key.</li>
<li>https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdkconfig.htm</li>
</ul></li>
<li>“instance_principal_auth”
<ul>
<li>use instance principals to authorize an instance to make API
calls.</li>
<li>each instance has its own identity, and authenticates using the
certificates that are read from instance metadata.</li>
<li>https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/callingservicesfrominstances.htm</li>
</ul></li>
<li>“resource_principal_auth”
<ul>
<li>use resource principals to make API calls</li>
</ul></li>
<li>“no_auth”
<ul>
<li>no credentials needed, this is typically for reading public
buckets</li>
</ul></li>
</ul></li>
</ul>
<h4 id="oos-namespace">–oos-namespace</h4>
<p>Object storage namespace</p>
<p>Properties:</p>
<ul>
<li>Config: namespace</li>
<li>Env Var: RCLONE_OOS_NAMESPACE</li>
<li>Type: string</li>
<li>Required: true</li>
</ul>
<h4 id="oos-compartment">–oos-compartment</h4>
<p>Object storage compartment OCID</p>
<p>Properties:</p>
<ul>
<li>Config: compartment</li>
<li>Env Var: RCLONE_OOS_COMPARTMENT</li>
<li>Provider: !no_auth</li>
<li>Type: string</li>
<li>Required: true</li>
</ul>
<h4 id="oos-region">–oos-region</h4>
<p>Object storage Region</p>
<p>Properties:</p>
<ul>
<li>Config: region</li>
<li>Env Var: RCLONE_OOS_REGION</li>
<li>Type: string</li>
<li>Required: true</li>
</ul>
<h4 id="oos-endpoint">–oos-endpoint</h4>
<p>Endpoint for Object storage API.</p>
<p>Leave blank to use the default endpoint for the region.</p>
<p>Properties:</p>
<ul>
<li>Config: endpoint</li>
<li>Env Var: RCLONE_OOS_ENDPOINT</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="oos-config-file">–oos-config-file</h4>
<p>Path to OCI config file</p>
<p>Properties:</p>
<ul>
<li>Config: config_file</li>
<li>Env Var: RCLONE_OOS_CONFIG_FILE</li>
<li>Provider: user_principal_auth</li>
<li>Type: string</li>
<li>Default: “~/.oci/config”</li>
<li>Examples:
<ul>
<li>“~/.oci/config”
<ul>
<li>oci configuration file location</li>
</ul></li>
</ul></li>
</ul>
<h4 id="oos-config-profile">–oos-config-profile</h4>
<p>Profile name inside the oci config file</p>
<p>Properties:</p>
<ul>
<li>Config: config_profile</li>
<li>Env Var: RCLONE_OOS_CONFIG_PROFILE</li>
<li>Provider: user_principal_auth</li>
<li>Type: string</li>
<li>Default: “Default”</li>
<li>Examples:
<ul>
<li>“Default”
<ul>
<li>Use the default profile</li>
</ul></li>
</ul></li>
</ul>
<h3 id="advanced-options-29">Advanced options</h3>
<p>Here are the Advanced options specific to oracleobjectstorage (Oracle
Cloud Infrastructure Object Storage).</p>
<h4 id="oos-upload-cutoff">–oos-upload-cutoff</h4>
<p>Cutoff for switching to chunked upload.</p>
<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>
<p>Properties:</p>
<ul>
<li>Config: upload_cutoff</li>
<li>Env Var: RCLONE_OOS_UPLOAD_CUTOFF</li>
<li>Type: SizeSuffix</li>
<li>Default: 200Mi</li>
</ul>
<h4 id="oos-chunk-size">–oos-chunk-size</h4>
<p>Chunk size to use for uploading.</p>
<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>
<p>Note that “upload_concurrency” chunks of this size are buffered in
memory per transfer.</p>
<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>
<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>
<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>
<p>Increasing the chunk size decreases the accuracy of the progress
statistics displayed with “-P” flag.</p>
<p>Properties:</p>
<ul>
<li>Config: chunk_size</li>
<li>Env Var: RCLONE_OOS_CHUNK_SIZE</li>
<li>Type: SizeSuffix</li>
<li>Default: 5Mi</li>
</ul>
<h4 id="oos-upload-concurrency">–oos-upload-concurrency</h4>
<p>Concurrency for multipart uploads.</p>
<p>This is the number of chunks of the same file that are uploaded
concurrently.</p>
<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>
<p>Properties:</p>
<ul>
<li>Config: upload_concurrency</li>
<li>Env Var: RCLONE_OOS_UPLOAD_CONCURRENCY</li>
<li>Type: int</li>
<li>Default: 10</li>
</ul>
<h4 id="oos-copy-cutoff">–oos-copy-cutoff</h4>
<p>Cutoff for switching to multipart copy.</p>
<p>Any files larger than this that need to be server-side copied will be
copied in chunks of this size.</p>
<p>The minimum is 0 and the maximum is 5 GiB.</p>
<p>Properties:</p>
<ul>
<li>Config: copy_cutoff</li>
<li>Env Var: RCLONE_OOS_COPY_CUTOFF</li>
<li>Type: SizeSuffix</li>
<li>Default: 4.656Gi</li>
</ul>
<h4 id="oos-copy-timeout">–oos-copy-timeout</h4>
<p>Timeout for copy.</p>
<p>Copy is an asynchronous operation, specify timeout to wait for copy
to succeed</p>
<p>Properties:</p>
<ul>
<li>Config: copy_timeout</li>
<li>Env Var: RCLONE_OOS_COPY_TIMEOUT</li>
<li>Type: Duration</li>
<li>Default: 1m0s</li>
</ul>
<h4 id="oos-disable-checksum">–oos-disable-checksum</h4>
<p>Don’t store MD5 checksum with object metadata.</p>
<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>
<p>Properties:</p>
<ul>
<li>Config: disable_checksum</li>
<li>Env Var: RCLONE_OOS_DISABLE_CHECKSUM</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="oos-encoding">–oos-encoding</h4>
<p>The encoding for the backend.</p>
<p>See the <a href="https://rclone.org/overview/#encoding">encoding
section in the overview</a> for more info.</p>
<p>Properties:</p>
<ul>
<li>Config: encoding</li>
<li>Env Var: RCLONE_OOS_ENCODING</li>
<li>Type: MultiEncoder</li>
<li>Default: Slash,InvalidUtf8,Dot</li>
</ul>
<h4 id="oos-leave-parts-on-error">–oos-leave-parts-on-error</h4>
<p>If true avoid calling abort upload on a failure, leaving all
successfully uploaded parts on S3 for manual recovery.</p>
<p>It should be set to true for resuming uploads across different
sessions.</p>
<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>
<p>Properties:</p>
<ul>
<li>Config: leave_parts_on_error</li>
<li>Env Var: RCLONE_OOS_LEAVE_PARTS_ON_ERROR</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="oos-no-check-bucket">–oos-no-check-bucket</h4>
<p>If set, don’t attempt to check the bucket exists or create it.</p>
<p>This can be useful when trying to minimise the number of transactions
rclone does if you know the bucket exists already.</p>
<p>It can also be needed if the user you are using does not have bucket
creation permissions.</p>
<p>Properties:</p>
<ul>
<li>Config: no_check_bucket</li>
<li>Env Var: RCLONE_OOS_NO_CHECK_BUCKET</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h2 id="backend-commands-6">Backend commands</h2>
<p>Here are the commands specific to the oracleobjectstorage
backend.</p>
<p>Run them with</p>
<pre><code>rclone backend COMMAND remote:</code></pre>
<p>The help below will explain what arguments each command takes.</p>
<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>
<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>
<h3 id="rename">rename</h3>
<p>change the name of an object</p>
<pre><code>rclone backend rename remote: [options] [&lt;arguments&gt;+]</code></pre>
<p>This command can be used to rename a object.</p>
<p>Usage Examples:</p>
<pre><code>rclone backend rename oos:bucket relative-object-path-under-bucket object-new-name</code></pre>
<h3 id="list-multipart-uploads-1">list-multipart-uploads</h3>
<p>List the unfinished multipart uploads</p>
<pre><code>rclone backend list-multipart-uploads remote: [options] [&lt;arguments&gt;+]</code></pre>
<p>This command lists the unfinished multipart uploads in JSON
format.</p>
<pre><code>rclone backend list-multipart-uploads oos:bucket/path/to/object</code></pre>
<p>It returns a dictionary of buckets with values as lists of unfinished
multipart uploads.</p>
<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>
<pre><code>{
  &quot;test-bucket&quot;: [
            {
                    &quot;namespace&quot;: &quot;test-namespace&quot;,
                    &quot;bucket&quot;: &quot;test-bucket&quot;,
                    &quot;object&quot;: &quot;600m.bin&quot;,
                    &quot;uploadId&quot;: &quot;51dd8114-52a4-b2f2-c42f-5291f05eb3c8&quot;,
                    &quot;timeCreated&quot;: &quot;2022-07-29T06:21:16.595Z&quot;,
                    &quot;storageTier&quot;: &quot;Standard&quot;
            }
    ]</code></pre>
<h3 id="cleanup-4">cleanup</h3>
<p>Remove unfinished multipart uploads.</p>
<pre><code>rclone backend cleanup remote: [options] [&lt;arguments&gt;+]</code></pre>
<p>This command removes unfinished multipart uploads of age greater than
max-age which defaults to 24 hours.</p>
<p>Note that you can use -i/–dry-run with this command to see what it
would do.</p>
<pre><code>rclone backend cleanup oos:bucket/path/to/object
rclone backend cleanup -o max-age=7w oos:bucket/path/to/object</code></pre>
<p>Durations are parsed as per the rest of rclone, 2h, 7d, 7w etc.</p>
<p>Options:</p>
<ul>
<li>“max-age”: Max age of upload to delete</li>
</ul>
<h1 id="qingstor">QingStor</h1>
<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>
<h2 id="configuration-32">Configuration</h2>
<p>Here is an example of making an QingStor configuration. First run</p>
<pre><code>rclone config</code></pre>
<p>This will guide you through an interactive setup process.</p>
<pre><code>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&gt; n
name&gt; remote
Type of storage to configure.
Choose a number from below, or type in your own value
[snip]
XX / QingStor Object Storage
   \ &quot;qingstor&quot;
[snip]
Storage&gt; qingstor
Get QingStor credentials from runtime. Only applies if access_key_id and secret_access_key is blank.
Choose a number from below, or type in your own value
 1 / Enter QingStor credentials in the next step
   \ &quot;false&quot;
 2 / Get QingStor credentials from the environment (env vars or IAM)
   \ &quot;true&quot;
env_auth&gt; 1
QingStor Access Key ID - leave blank for anonymous access or runtime credentials.
access_key_id&gt; access_key
QingStor Secret Access Key (password) - leave blank for anonymous access or runtime credentials.
secret_access_key&gt; secret_key
Enter an endpoint URL to connection QingStor API.
Leave blank will use the default value &quot;https://qingstor.com:443&quot;
endpoint&gt;
Zone connect to. Default is &quot;pek3a&quot;.
Choose a number from below, or type in your own value
   / The Beijing (China) Three Zone
 1 | Needs location constraint pek3a.
   \ &quot;pek3a&quot;
   / The Shanghai (China) First Zone
 2 | Needs location constraint sh1a.
   \ &quot;sh1a&quot;
zone&gt; 1
Number of connection retry.
Leave blank will use the default value &quot;3&quot;.
connection_retries&gt;
Remote config
--------------------
[remote]
env_auth = false
access_key_id = access_key
secret_access_key = secret_key
endpoint =
zone = pek3a
connection_retries =
--------------------
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<p>This remote is called <code>remote</code> and can now be used like
this</p>
<p>See all buckets</p>
<pre><code>rclone lsd remote:</code></pre>
<p>Make a new bucket</p>
<pre><code>rclone mkdir remote:bucket</code></pre>
<p>List the contents of a bucket</p>
<pre><code>rclone ls remote:bucket</code></pre>
<p>Sync <code>/home/local/directory</code> to the remote bucket,
deleting any excess files in the bucket.</p>
<pre><code>rclone sync -i /home/local/directory remote:bucket</code></pre>
<h3 id="fast-list-6">–fast-list</h3>
<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>
<h3 id="multipart-uploads-2">Multipart uploads</h3>
<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>
<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>
<h3 id="buckets-and-zone">Buckets and Zone</h3>
<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>
<h3 id="authentication-5">Authentication</h3>
<p>There are two ways to supply <code>rclone</code> with a set of
QingStor credentials. In order of precedence:</p>
<ul>
<li>Directly in the rclone configuration file (as configured by
<code>rclone config</code>)
<ul>
<li>set <code>access_key_id</code> and
<code>secret_access_key</code></li>
</ul></li>
<li>Runtime configuration:
<ul>
<li>set <code>env_auth</code> to <code>true</code> in the config
file</li>
<li>Exporting the following environment variables before running
<code>rclone</code>
<ul>
<li>Access Key ID: <code>QS_ACCESS_KEY_ID</code> or
<code>QS_ACCESS_KEY</code></li>
<li>Secret Access Key: <code>QS_SECRET_ACCESS_KEY</code> or
<code>QS_SECRET_KEY</code></li>
</ul></li>
</ul></li>
</ul>
<h3 id="restricted-filename-characters-21">Restricted filename
characters</h3>
<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>
<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>
<h3 id="standard-options-31">Standard options</h3>
<p>Here are the Standard options specific to qingstor (QingCloud Object
Storage).</p>
<h4 id="qingstor-env-auth">–qingstor-env-auth</h4>
<p>Get QingStor credentials from runtime.</p>
<p>Only applies if access_key_id and secret_access_key is blank.</p>
<p>Properties:</p>
<ul>
<li>Config: env_auth</li>
<li>Env Var: RCLONE_QINGSTOR_ENV_AUTH</li>
<li>Type: bool</li>
<li>Default: false</li>
<li>Examples:
<ul>
<li>“false”
<ul>
<li>Enter QingStor credentials in the next step.</li>
</ul></li>
<li>“true”
<ul>
<li>Get QingStor credentials from the environment (env vars or
IAM).</li>
</ul></li>
</ul></li>
</ul>
<h4 id="qingstor-access-key-id">–qingstor-access-key-id</h4>
<p>QingStor Access Key ID.</p>
<p>Leave blank for anonymous access or runtime credentials.</p>
<p>Properties:</p>
<ul>
<li>Config: access_key_id</li>
<li>Env Var: RCLONE_QINGSTOR_ACCESS_KEY_ID</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="qingstor-secret-access-key">–qingstor-secret-access-key</h4>
<p>QingStor Secret Access Key (password).</p>
<p>Leave blank for anonymous access or runtime credentials.</p>
<p>Properties:</p>
<ul>
<li>Config: secret_access_key</li>
<li>Env Var: RCLONE_QINGSTOR_SECRET_ACCESS_KEY</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="qingstor-endpoint">–qingstor-endpoint</h4>
<p>Enter an endpoint URL to connection QingStor API.</p>
<p>Leave blank will use the default value
“https://qingstor.com:443”.</p>
<p>Properties:</p>
<ul>
<li>Config: endpoint</li>
<li>Env Var: RCLONE_QINGSTOR_ENDPOINT</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="qingstor-zone">–qingstor-zone</h4>
<p>Zone to connect to.</p>
<p>Default is “pek3a”.</p>
<p>Properties:</p>
<ul>
<li>Config: zone</li>
<li>Env Var: RCLONE_QINGSTOR_ZONE</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“pek3a”
<ul>
<li>The Beijing (China) Three Zone.</li>
<li>Needs location constraint pek3a.</li>
</ul></li>
<li>“sh1a”
<ul>
<li>The Shanghai (China) First Zone.</li>
<li>Needs location constraint sh1a.</li>
</ul></li>
<li>“gd2a”
<ul>
<li>The Guangdong (China) Second Zone.</li>
<li>Needs location constraint gd2a.</li>
</ul></li>
</ul></li>
</ul>
<h3 id="advanced-options-30">Advanced options</h3>
<p>Here are the Advanced options specific to qingstor (QingCloud Object
Storage).</p>
<h4 id="qingstor-connection-retries">–qingstor-connection-retries</h4>
<p>Number of connection retries.</p>
<p>Properties:</p>
<ul>
<li>Config: connection_retries</li>
<li>Env Var: RCLONE_QINGSTOR_CONNECTION_RETRIES</li>
<li>Type: int</li>
<li>Default: 3</li>
</ul>
<h4 id="qingstor-upload-cutoff">–qingstor-upload-cutoff</h4>
<p>Cutoff for switching to chunked upload.</p>
<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>
<p>Properties:</p>
<ul>
<li>Config: upload_cutoff</li>
<li>Env Var: RCLONE_QINGSTOR_UPLOAD_CUTOFF</li>
<li>Type: SizeSuffix</li>
<li>Default: 200Mi</li>
</ul>
<h4 id="qingstor-chunk-size">–qingstor-chunk-size</h4>
<p>Chunk size to use for uploading.</p>
<p>When uploading files larger than upload_cutoff they will be uploaded
as multipart uploads using this chunk size.</p>
<p>Note that “–qingstor-upload-concurrency” chunks of this size are
buffered in memory per transfer.</p>
<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>
<p>Properties:</p>
<ul>
<li>Config: chunk_size</li>
<li>Env Var: RCLONE_QINGSTOR_CHUNK_SIZE</li>
<li>Type: SizeSuffix</li>
<li>Default: 4Mi</li>
</ul>
<h4 id="qingstor-upload-concurrency">–qingstor-upload-concurrency</h4>
<p>Concurrency for multipart uploads.</p>
<p>This is the number of chunks of the same file that are uploaded
concurrently.</p>
<p>NB if you set this to &gt; 1 then the checksums of multipart uploads
become corrupted (the uploads themselves are not corrupted though).</p>
<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>
<p>Properties:</p>
<ul>
<li>Config: upload_concurrency</li>
<li>Env Var: RCLONE_QINGSTOR_UPLOAD_CONCURRENCY</li>
<li>Type: int</li>
<li>Default: 1</li>
</ul>
<h4 id="qingstor-encoding">–qingstor-encoding</h4>
<p>The encoding for the backend.</p>
<p>See the <a href="https://rclone.org/overview/#encoding">encoding
section in the overview</a> for more info.</p>
<p>Properties:</p>
<ul>
<li>Config: encoding</li>
<li>Env Var: RCLONE_QINGSTOR_ENCODING</li>
<li>Type: MultiEncoder</li>
<li>Default: Slash,Ctl,InvalidUtf8</li>
</ul>
<h2 id="limitations-24">Limitations</h2>
<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>
<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>
<h1 id="sia">Sia</h1>
<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>
<h2 id="introduction-1">Introduction</h2>
<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>
<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>
<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>
<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>
<h2 id="configuration-33">Configuration</h2>
<p>Here is an example of how to make a <code>sia</code> remote called
<code>mySia</code>. First, run:</p>
<pre><code> rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<pre><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; mySia
Type of storage to configure.
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
...
29 / Sia Decentralized Cloud
   \ &quot;sia&quot;
...
Storage&gt; sia
Sia daemon API URL, like http://sia.daemon.host:9980.
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.
Enter a string value. Press Enter for the default (&quot;http://127.0.0.1:9980&quot;).
api_url&gt; http://127.0.0.1:9980
Sia Daemon API Password.
Can be found in the apipassword file located in HOME/.sia/ or in the daemon directory.
y) Yes type in my own password
g) Generate random password
n) No leave this optional password blank (default)
y/g/n&gt; y
Enter the password:
password:
Confirm the password:
password:
Edit advanced config?
y) Yes
n) No (default)
y/n&gt; n
--------------------
[mySia]
type = sia
api_url = http://127.0.0.1:9980
api_password = *** ENCRYPTED ***
--------------------
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<p>Once configured, you can then use <code>rclone</code> like this:</p>
<ul>
<li>List directories in top level of your Sia storage</li>
</ul>
<pre><code>rclone lsd mySia:</code></pre>
<ul>
<li>List all the files in your Sia storage</li>
</ul>
<pre><code>rclone ls mySia:</code></pre>
<ul>
<li>Upload a local directory to the Sia directory called
<em>backup</em></li>
</ul>
<pre><code>rclone copy /home/source mySia:backup</code></pre>
<h3 id="standard-options-32">Standard options</h3>
<p>Here are the Standard options specific to sia (Sia Decentralized
Cloud).</p>
<h4 id="sia-api-url">–sia-api-url</h4>
<p>Sia daemon API URL, like http://sia.daemon.host:9980.</p>
<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>
<p>Properties:</p>
<ul>
<li>Config: api_url</li>
<li>Env Var: RCLONE_SIA_API_URL</li>
<li>Type: string</li>
<li>Default: “http://127.0.0.1:9980”</li>
</ul>
<h4 id="sia-api-password">–sia-api-password</h4>
<p>Sia Daemon API Password.</p>
<p>Can be found in the apipassword file located in HOME/.sia/ or in the
daemon directory.</p>
<p><strong>NB</strong> Input to this must be obscured - see <a
href="https://rclone.org/commands/rclone_obscure/">rclone
obscure</a>.</p>
<p>Properties:</p>
<ul>
<li>Config: api_password</li>
<li>Env Var: RCLONE_SIA_API_PASSWORD</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h3 id="advanced-options-31">Advanced options</h3>
<p>Here are the Advanced options specific to sia (Sia Decentralized
Cloud).</p>
<h4 id="sia-user-agent">–sia-user-agent</h4>
<p>Siad User Agent</p>
<p>Sia daemon requires the ‘Sia-Agent’ user agent by default for
security</p>
<p>Properties:</p>
<ul>
<li>Config: user_agent</li>
<li>Env Var: RCLONE_SIA_USER_AGENT</li>
<li>Type: string</li>
<li>Default: “Sia-Agent”</li>
</ul>
<h4 id="sia-encoding">–sia-encoding</h4>
<p>The encoding for the backend.</p>
<p>See the <a href="https://rclone.org/overview/#encoding">encoding
section in the overview</a> for more info.</p>
<p>Properties:</p>
<ul>
<li>Config: encoding</li>
<li>Env Var: RCLONE_SIA_ENCODING</li>
<li>Type: MultiEncoder</li>
<li>Default: Slash,Question,Hash,Percent,Del,Ctl,InvalidUtf8,Dot</li>
</ul>
<h2 id="limitations-25">Limitations</h2>
<ul>
<li>Modification times not supported</li>
<li>Checksums not supported</li>
<li><code>rclone about</code> not supported</li>
<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>
<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>
</ul>
<h1 id="swift">Swift</h1>
<p>Swift refers to <a
href="https://docs.openstack.org/swift/latest/">OpenStack Object
Storage</a>. Commercial implementations of that being:</p>
<ul>
<li><a href="https://www.rackspace.com/cloud/files/">Rackspace Cloud
Files</a></li>
<li><a href="https://www.memset.com/cloud/storage/">Memset
Memstore</a></li>
<li><a
href="https://www.ovh.co.uk/public-cloud/storage/object-storage/">OVH
Object Storage</a></li>
<li><a
href="https://docs.oracle.com/en-us/iaas/integration/doc/configure-object-storage.html">Oracle
Cloud Storage</a></li>
<li><a
href="https://console.bluemix.net/docs/infrastructure/objectstorage-swift/index.html">IBM
Bluemix Cloud ObjectStorage Swift</a></li>
</ul>
<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>
<h2 id="configuration-34">Configuration</h2>
<p>Here is an example of making a swift configuration. First run</p>
<pre><code>rclone config</code></pre>
<p>This will guide you through an interactive setup process.</p>
<pre><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; remote
Type of storage to configure.
Choose a number from below, or type in your own value
[snip]
XX / OpenStack Swift (Rackspace Cloud Files, Memset Memstore, OVH)
   \ &quot;swift&quot;
[snip]
Storage&gt; swift
Get swift credentials from environment variables in standard OpenStack form.
Choose a number from below, or type in your own value
 1 / Enter swift credentials in the next step
   \ &quot;false&quot;
 2 / Get swift credentials from environment vars. Leave other fields blank if using this.
   \ &quot;true&quot;
env_auth&gt; true
User name to log in (OS_USERNAME).
user&gt; 
API key or password (OS_PASSWORD).
key&gt; 
Authentication URL for server (OS_AUTH_URL).
Choose a number from below, or type in your own value
 1 / Rackspace US
   \ &quot;https://auth.api.rackspacecloud.com/v1.0&quot;
 2 / Rackspace UK
   \ &quot;https://lon.auth.api.rackspacecloud.com/v1.0&quot;
 3 / Rackspace v2
   \ &quot;https://identity.api.rackspacecloud.com/v2.0&quot;
 4 / Memset Memstore UK
   \ &quot;https://auth.storage.memset.com/v1.0&quot;
 5 / Memset Memstore UK v2
   \ &quot;https://auth.storage.memset.com/v2.0&quot;
 6 / OVH
   \ &quot;https://auth.cloud.ovh.net/v3&quot;
auth&gt; 
User ID to log in - optional - most swift systems use user and leave this blank (v3 auth) (OS_USER_ID).
user_id&gt; 
User domain - optional (v3 auth) (OS_USER_DOMAIN_NAME)
domain&gt; 
Tenant name - optional for v1 auth, this or tenant_id required otherwise (OS_TENANT_NAME or OS_PROJECT_NAME)
tenant&gt; 
Tenant ID - optional for v1 auth, this or tenant required otherwise (OS_TENANT_ID)
tenant_id&gt; 
Tenant domain - optional (v3 auth) (OS_PROJECT_DOMAIN_NAME)
tenant_domain&gt; 
Region name - optional (OS_REGION_NAME)
region&gt; 
Storage URL - optional (OS_STORAGE_URL)
storage_url&gt; 
Auth Token from alternate authentication - optional (OS_AUTH_TOKEN)
auth_token&gt; 
AuthVersion - optional - set to (1,2,3) if your auth URL has no version (ST_AUTH_VERSION)
auth_version&gt; 
Endpoint type to choose from the service catalogue (OS_ENDPOINT_TYPE)
Choose a number from below, or type in your own value
 1 / Public (default, choose this if not sure)
   \ &quot;public&quot;
 2 / Internal (use internal service net)
   \ &quot;internal&quot;
 3 / Admin
   \ &quot;admin&quot;
endpoint_type&gt; 
Remote config
--------------------
[test]
env_auth = true
user = 
key = 
auth = 
user_id = 
domain = 
tenant = 
tenant_id = 
tenant_domain = 
region = 
storage_url = 
auth_token = 
auth_version = 
endpoint_type = 
--------------------
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<p>This remote is called <code>remote</code> and can now be used like
this</p>
<p>See all containers</p>
<pre><code>rclone lsd remote:</code></pre>
<p>Make a new container</p>
<pre><code>rclone mkdir remote:container</code></pre>
<p>List the contents of a container</p>
<pre><code>rclone ls remote:container</code></pre>
<p>Sync <code>/home/local/directory</code> to the remote container,
deleting any excess files in the container.</p>
<pre><code>rclone sync -i /home/local/directory remote:container</code></pre>
<h3 id="configuration-from-an-openstack-credentials-file">Configuration
from an OpenStack credentials file</h3>
<p>An OpenStack credentials file typically looks something something
like this (without the comments)</p>
<pre><code>export OS_AUTH_URL=https://a.provider.net/v2.0
export OS_TENANT_ID=ffffffffffffffffffffffffffffffff
export OS_TENANT_NAME=&quot;1234567890123456&quot;
export OS_USERNAME=&quot;123abc567xy&quot;
echo &quot;Please enter your OpenStack Password: &quot;
read -sr OS_PASSWORD_INPUT
export OS_PASSWORD=$OS_PASSWORD_INPUT
export OS_REGION_NAME=&quot;SBG1&quot;
if [ -z &quot;$OS_REGION_NAME&quot; ]; then unset OS_REGION_NAME; fi</code></pre>
<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>
<pre><code>[remote]
type = swift
user = $OS_USERNAME
key = $OS_PASSWORD
auth = $OS_AUTH_URL
tenant = $OS_TENANT_NAME</code></pre>
<p>Note that you may (or may not) need to set <code>region</code> too -
try without first.</p>
<h3 id="configuration-from-the-environment">Configuration from the
environment</h3>
<p>If you prefer you can configure rclone to use swift using a standard
set of OpenStack environment variables.</p>
<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>
<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>
<h3 id="using-an-alternate-authentication-method">Using an alternate
authentication method</h3>
<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>
<h4 id="using-rclone-without-a-config-file">Using rclone without a
config file</h4>
<p>You can use rclone with swift without a config file, if desired, like
this:</p>
<pre><code>source openstack-credentials-file
export RCLONE_CONFIG_MYREMOTE_TYPE=swift
export RCLONE_CONFIG_MYREMOTE_ENV_AUTH=true
rclone lsd myremote:</code></pre>
<h3 id="fast-list-7">–fast-list</h3>
<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>
<h3 id="update-and-use-server-modtime">–update and
–use-server-modtime</h3>
<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>
<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>
<h3 id="modified-time-11">Modified time</h3>
<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>
<p>This is a de facto standard (used in the official python-swiftclient
amongst others) for storing the modification time for an object.</p>
<h3 id="restricted-filename-characters-22">Restricted filename
characters</h3>
<table>
<thead>
<tr class="header">
<th>Character</th>
<th style="text-align: center;">Value</th>
<th style="text-align: center;">Replacement</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>NUL</td>
<td style="text-align: center;">0x00</td>
<td style="text-align: center;">␀</td>
</tr>
<tr class="even">
<td>/</td>
<td style="text-align: center;">0x2F</td>
<td style="text-align: center;">／</td>
</tr>
</tbody>
</table>
<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>
<h3 id="standard-options-33">Standard options</h3>
<p>Here are the Standard options specific to swift (OpenStack Swift
(Rackspace Cloud Files, Memset Memstore, OVH)).</p>
<h4 id="swift-env-auth">–swift-env-auth</h4>
<p>Get swift credentials from environment variables in standard
OpenStack form.</p>
<p>Properties:</p>
<ul>
<li>Config: env_auth</li>
<li>Env Var: RCLONE_SWIFT_ENV_AUTH</li>
<li>Type: bool</li>
<li>Default: false</li>
<li>Examples:
<ul>
<li>“false”
<ul>
<li>Enter swift credentials in the next step.</li>
</ul></li>
<li>“true”
<ul>
<li>Get swift credentials from environment vars.</li>
<li>Leave other fields blank if using this.</li>
</ul></li>
</ul></li>
</ul>
<h4 id="swift-user">–swift-user</h4>
<p>User name to log in (OS_USERNAME).</p>
<p>Properties:</p>
<ul>
<li>Config: user</li>
<li>Env Var: RCLONE_SWIFT_USER</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="swift-key">–swift-key</h4>
<p>API key or password (OS_PASSWORD).</p>
<p>Properties:</p>
<ul>
<li>Config: key</li>
<li>Env Var: RCLONE_SWIFT_KEY</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="swift-auth">–swift-auth</h4>
<p>Authentication URL for server (OS_AUTH_URL).</p>
<p>Properties:</p>
<ul>
<li>Config: auth</li>
<li>Env Var: RCLONE_SWIFT_AUTH</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“https://auth.api.rackspacecloud.com/v1.0”
<ul>
<li>Rackspace US</li>
</ul></li>
<li>“https://lon.auth.api.rackspacecloud.com/v1.0”
<ul>
<li>Rackspace UK</li>
</ul></li>
<li>“https://identity.api.rackspacecloud.com/v2.0”
<ul>
<li>Rackspace v2</li>
</ul></li>
<li>“https://auth.storage.memset.com/v1.0”
<ul>
<li>Memset Memstore UK</li>
</ul></li>
<li>“https://auth.storage.memset.com/v2.0”
<ul>
<li>Memset Memstore UK v2</li>
</ul></li>
<li>“https://auth.cloud.ovh.net/v3”
<ul>
<li>OVH</li>
</ul></li>
</ul></li>
</ul>
<h4 id="swift-user-id">–swift-user-id</h4>
<p>User ID to log in - optional - most swift systems use user and leave
this blank (v3 auth) (OS_USER_ID).</p>
<p>Properties:</p>
<ul>
<li>Config: user_id</li>
<li>Env Var: RCLONE_SWIFT_USER_ID</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="swift-domain">–swift-domain</h4>
<p>User domain - optional (v3 auth) (OS_USER_DOMAIN_NAME)</p>
<p>Properties:</p>
<ul>
<li>Config: domain</li>
<li>Env Var: RCLONE_SWIFT_DOMAIN</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="swift-tenant">–swift-tenant</h4>
<p>Tenant name - optional for v1 auth, this or tenant_id required
otherwise (OS_TENANT_NAME or OS_PROJECT_NAME).</p>
<p>Properties:</p>
<ul>
<li>Config: tenant</li>
<li>Env Var: RCLONE_SWIFT_TENANT</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="swift-tenant-id">–swift-tenant-id</h4>
<p>Tenant ID - optional for v1 auth, this or tenant required otherwise
(OS_TENANT_ID).</p>
<p>Properties:</p>
<ul>
<li>Config: tenant_id</li>
<li>Env Var: RCLONE_SWIFT_TENANT_ID</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="swift-tenant-domain">–swift-tenant-domain</h4>
<p>Tenant domain - optional (v3 auth) (OS_PROJECT_DOMAIN_NAME).</p>
<p>Properties:</p>
<ul>
<li>Config: tenant_domain</li>
<li>Env Var: RCLONE_SWIFT_TENANT_DOMAIN</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="swift-region">–swift-region</h4>
<p>Region name - optional (OS_REGION_NAME).</p>
<p>Properties:</p>
<ul>
<li>Config: region</li>
<li>Env Var: RCLONE_SWIFT_REGION</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="swift-storage-url">–swift-storage-url</h4>
<p>Storage URL - optional (OS_STORAGE_URL).</p>
<p>Properties:</p>
<ul>
<li>Config: storage_url</li>
<li>Env Var: RCLONE_SWIFT_STORAGE_URL</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="swift-auth-token">–swift-auth-token</h4>
<p>Auth Token from alternate authentication - optional
(OS_AUTH_TOKEN).</p>
<p>Properties:</p>
<ul>
<li>Config: auth_token</li>
<li>Env Var: RCLONE_SWIFT_AUTH_TOKEN</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4
id="swift-application-credential-id">–swift-application-credential-id</h4>
<p>Application Credential ID (OS_APPLICATION_CREDENTIAL_ID).</p>
<p>Properties:</p>
<ul>
<li>Config: application_credential_id</li>
<li>Env Var: RCLONE_SWIFT_APPLICATION_CREDENTIAL_ID</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4
id="swift-application-credential-name">–swift-application-credential-name</h4>
<p>Application Credential Name (OS_APPLICATION_CREDENTIAL_NAME).</p>
<p>Properties:</p>
<ul>
<li>Config: application_credential_name</li>
<li>Env Var: RCLONE_SWIFT_APPLICATION_CREDENTIAL_NAME</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4
id="swift-application-credential-secret">–swift-application-credential-secret</h4>
<p>Application Credential Secret (OS_APPLICATION_CREDENTIAL_SECRET).</p>
<p>Properties:</p>
<ul>
<li>Config: application_credential_secret</li>
<li>Env Var: RCLONE_SWIFT_APPLICATION_CREDENTIAL_SECRET</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="swift-auth-version">–swift-auth-version</h4>
<p>AuthVersion - optional - set to (1,2,3) if your auth URL has no
version (ST_AUTH_VERSION).</p>
<p>Properties:</p>
<ul>
<li>Config: auth_version</li>
<li>Env Var: RCLONE_SWIFT_AUTH_VERSION</li>
<li>Type: int</li>
<li>Default: 0</li>
</ul>
<h4 id="swift-endpoint-type">–swift-endpoint-type</h4>
<p>Endpoint type to choose from the service catalogue
(OS_ENDPOINT_TYPE).</p>
<p>Properties:</p>
<ul>
<li>Config: endpoint_type</li>
<li>Env Var: RCLONE_SWIFT_ENDPOINT_TYPE</li>
<li>Type: string</li>
<li>Default: “public”</li>
<li>Examples:
<ul>
<li>“public”
<ul>
<li>Public (default, choose this if not sure)</li>
</ul></li>
<li>“internal”
<ul>
<li>Internal (use internal service net)</li>
</ul></li>
<li>“admin”
<ul>
<li>Admin</li>
</ul></li>
</ul></li>
</ul>
<h4 id="swift-storage-policy">–swift-storage-policy</h4>
<p>The storage policy to use when creating a new container.</p>
<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>
<p>Properties:</p>
<ul>
<li>Config: storage_policy</li>
<li>Env Var: RCLONE_SWIFT_STORAGE_POLICY</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“”
<ul>
<li>Default</li>
</ul></li>
<li>“pcs”
<ul>
<li>OVH Public Cloud Storage</li>
</ul></li>
<li>“pca”
<ul>
<li>OVH Public Cloud Archive</li>
</ul></li>
</ul></li>
</ul>
<h3 id="advanced-options-32">Advanced options</h3>
<p>Here are the Advanced options specific to swift (OpenStack Swift
(Rackspace Cloud Files, Memset Memstore, OVH)).</p>
<h4 id="swift-leave-parts-on-error">–swift-leave-parts-on-error</h4>
<p>If true avoid calling abort upload on a failure.</p>
<p>It should be set to true for resuming uploads across different
sessions.</p>
<p>Properties:</p>
<ul>
<li>Config: leave_parts_on_error</li>
<li>Env Var: RCLONE_SWIFT_LEAVE_PARTS_ON_ERROR</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="swift-chunk-size">–swift-chunk-size</h4>
<p>Above this size files will be chunked into a _segments container.</p>
<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>
<p>Properties:</p>
<ul>
<li>Config: chunk_size</li>
<li>Env Var: RCLONE_SWIFT_CHUNK_SIZE</li>
<li>Type: SizeSuffix</li>
<li>Default: 5Gi</li>
</ul>
<h4 id="swift-no-chunk">–swift-no-chunk</h4>
<p>Don’t chunk files during streaming upload.</p>
<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>
<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>
<p>Rclone will still chunk files bigger than chunk_size when doing
normal copy operations.</p>
<p>Properties:</p>
<ul>
<li>Config: no_chunk</li>
<li>Env Var: RCLONE_SWIFT_NO_CHUNK</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="swift-no-large-objects">–swift-no-large-objects</h4>
<p>Disable support for static and dynamic large objects</p>
<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>
<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>
<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>
<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>
<p>Properties:</p>
<ul>
<li>Config: no_large_objects</li>
<li>Env Var: RCLONE_SWIFT_NO_LARGE_OBJECTS</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="swift-encoding">–swift-encoding</h4>
<p>The encoding for the backend.</p>
<p>See the <a href="https://rclone.org/overview/#encoding">encoding
section in the overview</a> for more info.</p>
<p>Properties:</p>
<ul>
<li>Config: encoding</li>
<li>Env Var: RCLONE_SWIFT_ENCODING</li>
<li>Type: MultiEncoder</li>
<li>Default: Slash,InvalidUtf8</li>
</ul>
<h2 id="limitations-26">Limitations</h2>
<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>
<h2 id="troubleshooting-3">Troubleshooting</h2>
<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>
<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>
<p>So this most likely means your username / password is wrong. You can
investigate further with the <code>--dump-bodies</code> flag.</p>
<p>This may also be caused by specifying the region when you shouldn’t
have (e.g. OVH).</p>
<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>
<p>This is most likely caused by forgetting to specify your tenant when
setting up a swift remote.</p>
<h2 id="ovh-cloud-archive">OVH Cloud Archive</h2>
<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>
<h3 id="uploading-objects">Uploading Objects</h3>
<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>
<h3 id="retrieving-objects">Retrieving Objects</h3>
<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>
<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>
<p>Rclone will wait for the time specified then retry the copy.</p>
<h1 id="pcloud">pCloud</h1>
<p>Paths are specified as <code>remote:path</code></p>
<p>Paths may be as deep as required,
e.g. <code>remote:directory/subdirectory</code>.</p>
<h2 id="configuration-35">Configuration</h2>
<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>
<p>Here is an example of how to make a remote called
<code>remote</code>. First run:</p>
<pre><code> rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<pre><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; remote
Type of storage to configure.
Choose a number from below, or type in your own value
[snip]
XX / Pcloud
   \ &quot;pcloud&quot;
[snip]
Storage&gt; pcloud
Pcloud App Client Id - leave blank normally.
client_id&gt; 
Pcloud App Client Secret - leave blank normally.
client_secret&gt; 
Remote config
Use auto config?
 * Say Y if not sure
 * Say N if you are working on a remote or headless machine
y) Yes
n) No
y/n&gt; y
If your browser doesn&#39;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 = {&quot;access_token&quot;:&quot;XXX&quot;,&quot;token_type&quot;:&quot;bearer&quot;,&quot;expiry&quot;:&quot;0001-01-01T00:00:00Z&quot;}
--------------------
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<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>
<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>
<p>Once configured you can then use <code>rclone</code> like this,</p>
<p>List directories in top level of your pCloud</p>
<pre><code>rclone lsd remote:</code></pre>
<p>List all the files in your pCloud</p>
<pre><code>rclone ls remote:</code></pre>
<p>To copy a local directory to a pCloud directory called backup</p>
<pre><code>rclone copy /home/source remote:backup</code></pre>
<h3 id="modified-time-and-hashes-10">Modified time and hashes</h3>
<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>
<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>
<h3 id="restricted-filename-characters-23">Restricted filename
characters</h3>
<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>
<table>
<thead>
<tr class="header">
<th>Character</th>
<th style="text-align: center;">Value</th>
<th style="text-align: center;">Replacement</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>\</td>
<td style="text-align: center;">0x5C</td>
<td style="text-align: center;">＼</td>
</tr>
</tbody>
</table>
<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>
<h3 id="deleting-files-6">Deleting files</h3>
<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>
<h3 id="emptying-the-trash">Emptying the trash</h3>
<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>
<h3 id="root-folder-id-3">Root folder ID</h3>
<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>
<p>Normally you will leave this blank and rclone will determine the
correct root to use itself.</p>
<p>However you can set this to restrict rclone to a specific folder
hierarchy.</p>
<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>
<p>So if the folder you want rclone to use has a URL which looks like
<code>https://my.pcloud.com/#page=filemanager&amp;folder=5xxxxxxxx8&amp;tpl=foldergrid</code>
in the browser, then you use <code>5xxxxxxxx8</code> as the
<code>root_folder_id</code> in the config.</p>
<h3 id="standard-options-34">Standard options</h3>
<p>Here are the Standard options specific to pcloud (Pcloud).</p>
<h4 id="pcloud-client-id">–pcloud-client-id</h4>
<p>OAuth Client Id.</p>
<p>Leave blank normally.</p>
<p>Properties:</p>
<ul>
<li>Config: client_id</li>
<li>Env Var: RCLONE_PCLOUD_CLIENT_ID</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="pcloud-client-secret">–pcloud-client-secret</h4>
<p>OAuth Client Secret.</p>
<p>Leave blank normally.</p>
<p>Properties:</p>
<ul>
<li>Config: client_secret</li>
<li>Env Var: RCLONE_PCLOUD_CLIENT_SECRET</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h3 id="advanced-options-33">Advanced options</h3>
<p>Here are the Advanced options specific to pcloud (Pcloud).</p>
<h4 id="pcloud-token">–pcloud-token</h4>
<p>OAuth Access Token as a JSON blob.</p>
<p>Properties:</p>
<ul>
<li>Config: token</li>
<li>Env Var: RCLONE_PCLOUD_TOKEN</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="pcloud-auth-url">–pcloud-auth-url</h4>
<p>Auth server URL.</p>
<p>Leave blank to use the provider defaults.</p>
<p>Properties:</p>
<ul>
<li>Config: auth_url</li>
<li>Env Var: RCLONE_PCLOUD_AUTH_URL</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="pcloud-token-url">–pcloud-token-url</h4>
<p>Token server url.</p>
<p>Leave blank to use the provider defaults.</p>
<p>Properties:</p>
<ul>
<li>Config: token_url</li>
<li>Env Var: RCLONE_PCLOUD_TOKEN_URL</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="pcloud-encoding">–pcloud-encoding</h4>
<p>The encoding for the backend.</p>
<p>See the <a href="https://rclone.org/overview/#encoding">encoding
section in the overview</a> for more info.</p>
<p>Properties:</p>
<ul>
<li>Config: encoding</li>
<li>Env Var: RCLONE_PCLOUD_ENCODING</li>
<li>Type: MultiEncoder</li>
<li>Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot</li>
</ul>
<h4 id="pcloud-root-folder-id">–pcloud-root-folder-id</h4>
<p>Fill in for rclone to use a non root folder as its starting
point.</p>
<p>Properties:</p>
<ul>
<li>Config: root_folder_id</li>
<li>Env Var: RCLONE_PCLOUD_ROOT_FOLDER_ID</li>
<li>Type: string</li>
<li>Default: “d0”</li>
</ul>
<h4 id="pcloud-hostname">–pcloud-hostname</h4>
<p>Hostname to connect to.</p>
<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>
<p>Properties:</p>
<ul>
<li>Config: hostname</li>
<li>Env Var: RCLONE_PCLOUD_HOSTNAME</li>
<li>Type: string</li>
<li>Default: “api.pcloud.com”</li>
<li>Examples:
<ul>
<li>“api.pcloud.com”
<ul>
<li>Original/US region</li>
</ul></li>
<li>“eapi.pcloud.com”
<ul>
<li>EU region</li>
</ul></li>
</ul></li>
</ul>
<h4 id="pcloud-username">–pcloud-username</h4>
<p>Your pcloud username.</p>
<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>
<p>Properties:</p>
<ul>
<li>Config: username</li>
<li>Env Var: RCLONE_PCLOUD_USERNAME</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="pcloud-password">–pcloud-password</h4>
<p>Your pcloud password.</p>
<p><strong>NB</strong> Input to this must be obscured - see <a
href="https://rclone.org/commands/rclone_obscure/">rclone
obscure</a>.</p>
<p>Properties:</p>
<ul>
<li>Config: password</li>
<li>Env Var: RCLONE_PCLOUD_PASSWORD</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h1 id="premiumize.me">premiumize.me</h1>
<p>Paths are specified as <code>remote:path</code></p>
<p>Paths may be as deep as required,
e.g. <code>remote:directory/subdirectory</code>.</p>
<h2 id="configuration-36">Configuration</h2>
<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>
<p>Here is an example of how to make a remote called
<code>remote</code>. First run:</p>
<pre><code> rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<pre><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; remote
Type of storage to configure.
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
[snip]
XX / premiumize.me
   \ &quot;premiumizeme&quot;
[snip]
Storage&gt; premiumizeme
** See help for premiumizeme backend at: https://rclone.org/premiumizeme/ **

Remote config
Use auto config?
 * Say Y if not sure
 * Say N if you are working on a remote or headless machine
y) Yes
n) No
y/n&gt; y
If your browser doesn&#39;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 = premiumizeme
token = {&quot;access_token&quot;:&quot;XXX&quot;,&quot;token_type&quot;:&quot;Bearer&quot;,&quot;refresh_token&quot;:&quot;XXX&quot;,&quot;expiry&quot;:&quot;2029-08-07T18:44:15.548915378+01:00&quot;}
--------------------
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d&gt; </code></pre>
<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>
<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>
<p>Once configured you can then use <code>rclone</code> like this,</p>
<p>List directories in top level of your premiumize.me</p>
<pre><code>rclone lsd remote:</code></pre>
<p>List all the files in your premiumize.me</p>
<pre><code>rclone ls remote:</code></pre>
<p>To copy a local directory to an premiumize.me directory called
backup</p>
<pre><code>rclone copy /home/source remote:backup</code></pre>
<h3 id="modified-time-and-hashes-11">Modified time and hashes</h3>
<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>
<h3 id="restricted-filename-characters-24">Restricted filename
characters</h3>
<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>
<table>
<thead>
<tr class="header">
<th>Character</th>
<th style="text-align: center;">Value</th>
<th style="text-align: center;">Replacement</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>\</td>
<td style="text-align: center;">0x5C</td>
<td style="text-align: center;">＼</td>
</tr>
<tr class="even">
<td>”</td>
<td style="text-align: center;">0x22</td>
<td style="text-align: center;">＂</td>
</tr>
</tbody>
</table>
<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>
<h3 id="standard-options-35">Standard options</h3>
<p>Here are the Standard options specific to premiumizeme
(premiumize.me).</p>
<h4 id="premiumizeme-api-key">–premiumizeme-api-key</h4>
<p>API Key.</p>
<p>This is not normally used - use oauth instead.</p>
<p>Properties:</p>
<ul>
<li>Config: api_key</li>
<li>Env Var: RCLONE_PREMIUMIZEME_API_KEY</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h3 id="advanced-options-34">Advanced options</h3>
<p>Here are the Advanced options specific to premiumizeme
(premiumize.me).</p>
<h4 id="premiumizeme-encoding">–premiumizeme-encoding</h4>
<p>The encoding for the backend.</p>
<p>See the <a href="https://rclone.org/overview/#encoding">encoding
section in the overview</a> for more info.</p>
<p>Properties:</p>
<ul>
<li>Config: encoding</li>
<li>Env Var: RCLONE_PREMIUMIZEME_ENCODING</li>
<li>Type: MultiEncoder</li>
<li>Default: Slash,DoubleQuote,BackSlash,Del,Ctl,InvalidUtf8,Dot</li>
</ul>
<h2 id="limitations-27">Limitations</h2>
<p>Note that premiumize.me is case insensitive so you can’t have a file
called “Hello.doc” and one called “hello.doc”.</p>
<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>
<p>premiumize.me only supports filenames up to 255 characters in
length.</p>
<h1 id="put.io">put.io</h1>
<p>Paths are specified as <code>remote:path</code></p>
<p>put.io paths may be as deep as required, e.g.
<code>remote:directory/subdirectory</code>.</p>
<h2 id="configuration-37">Configuration</h2>
<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>
<p>Here is an example of how to make a remote called
<code>remote</code>. First run:</p>
<pre><code> rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<pre><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; putio
Type of storage to configure.
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
[snip]
XX / Put.io
   \ &quot;putio&quot;
[snip]
Storage&gt; putio
** See help for putio backend at: https://rclone.org/putio/ **

Name                 Type
====                 ====
putio                putio

e) Edit existing remote
n) New remote
d) Delete remote
r) Rename remote
c) Copy remote
s) Set configuration password
q) Quit config
e/n/d/r/c/s/q&gt; q</code></pre>
<p>Note that rclone runs a webserver on your local machine to collect
the token as returned from Google if you use auto config mode. This only
runs from the moment it opens your browser to the moment you get back
the verification code. This is on <code>http://127.0.0.1:53682/</code>
and this it may require you to unblock it temporarily if you are running
a host firewall, or use manual mode.</p>
<p>You can then use it like this,</p>
<p>List directories in top level of your put.io</p>
<pre><code>rclone lsd remote:</code></pre>
<p>List all the files in your put.io</p>
<pre><code>rclone ls remote:</code></pre>
<p>To copy a local directory to a put.io directory called backup</p>
<pre><code>rclone copy /home/source remote:backup</code></pre>
<h3 id="restricted-filename-characters-25">Restricted filename
characters</h3>
<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>
<table>
<thead>
<tr class="header">
<th>Character</th>
<th style="text-align: center;">Value</th>
<th style="text-align: center;">Replacement</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>\</td>
<td style="text-align: center;">0x5C</td>
<td style="text-align: center;">＼</td>
</tr>
</tbody>
</table>
<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>
<h3 id="advanced-options-35">Advanced options</h3>
<p>Here are the Advanced options specific to putio (Put.io).</p>
<h4 id="putio-encoding">–putio-encoding</h4>
<p>The encoding for the backend.</p>
<p>See the <a href="https://rclone.org/overview/#encoding">encoding
section in the overview</a> for more info.</p>
<p>Properties:</p>
<ul>
<li>Config: encoding</li>
<li>Env Var: RCLONE_PUTIO_ENCODING</li>
<li>Type: MultiEncoder</li>
<li>Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot</li>
</ul>
<h2 id="limitations-28">Limitations</h2>
<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>
<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>
<h1 id="seafile">Seafile</h1>
<p>This is a backend for the <a
href="https://www.seafile.com/">Seafile</a> storage service: - It works
with both the free community edition or the professional edition. -
Seafile versions 6.x and 7.x are all supported. - Encrypted libraries
are also supported. - It supports 2FA enabled users</p>
<h2 id="configuration-38">Configuration</h2>
<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>
<h3 id="configuration-in-root-mode">Configuration in root mode</h3>
<p>Here is an example of making a seafile configuration for a user with
<strong>no</strong> two-factor authentication. First run</p>
<pre><code>rclone config</code></pre>
<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>
<pre><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; seafile
Type of storage to configure.
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
[snip]
XX / Seafile
   \ &quot;seafile&quot;
[snip]
Storage&gt; seafile
** See help for seafile backend at: https://rclone.org/seafile/ **

URL of seafile host to connect to
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
 1 / Connect to cloud.seafile.com
   \ &quot;https://cloud.seafile.com/&quot;
url&gt; http://my.seafile.server/
User name (usually email address)
Enter a string value. Press Enter for the default (&quot;&quot;).
user&gt; me@example.com
Password
y) Yes type in my own password
g) Generate random password
n) No leave this optional password blank (default)
y/g&gt; y
Enter the password:
password:
Confirm the password:
password:
Two-factor authentication (&#39;true&#39; if the account has 2FA enabled)
Enter a boolean value (true or false). Press Enter for the default (&quot;false&quot;).
2fa&gt; true
Name of the library. Leave blank to access all non-encrypted libraries.
Enter a string value. Press Enter for the default (&quot;&quot;).
library&gt; My Library
Library password (for encrypted libraries only). Leave blank if you pass it through the command line.
y) Yes type in my own password
g) Generate random password
n) No leave this optional password blank (default)
y/g/n&gt; n
Edit advanced config? (y/n)
y) Yes
n) No (default)
y/n&gt; n
Remote config
Two-factor authentication: please enter your 2FA code
2fa code&gt; 123456
Authenticating...
Success!
--------------------
[seafile]
type = seafile
url = http://my.seafile.server/
user = me@example.com
pass = 
2fa = true
library = My Library
--------------------
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<p>You’ll notice your password is blank in the configuration. It’s
because we only need the password to authenticate you once.</p>
<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>
<p>See all files in the library:</p>
<pre><code>rclone lsd seafile:</code></pre>
<p>Create a new directory inside the library</p>
<pre><code>rclone mkdir seafile:directory</code></pre>
<p>List the contents of a directory</p>
<pre><code>rclone ls seafile:directory</code></pre>
<p>Sync <code>/home/local/directory</code> to the remote library,
deleting any excess files in the library.</p>
<pre><code>rclone sync -i /home/local/directory seafile:</code></pre>
<h3 id="fast-list-8">–fast-list</h3>
<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>
<h3 id="restricted-filename-characters-26">Restricted filename
characters</h3>
<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>
<table>
<thead>
<tr class="header">
<th>Character</th>
<th style="text-align: center;">Value</th>
<th style="text-align: center;">Replacement</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>/</td>
<td style="text-align: center;">0x2F</td>
<td style="text-align: center;">／</td>
</tr>
<tr class="even">
<td>”</td>
<td style="text-align: center;">0x22</td>
<td style="text-align: center;">＂</td>
</tr>
<tr class="odd">
<td>\</td>
<td style="text-align: center;">0x5C</td>
<td style="text-align: center;">＼</td>
</tr>
</tbody>
</table>
<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>
<h3 id="seafile-and-rclone-link">Seafile and rclone link</h3>
<p>Rclone supports generating share links for non-encrypted libraries
only. They can either be for a file or a directory:</p>
<pre><code>rclone link seafile:seafile-tutorial.doc
http://my.seafile.server/f/fdcd8a2f93f84b8b90f4/
</code></pre>
<p>or if run on a directory you will get:</p>
<pre><code>rclone link seafile:dir
http://my.seafile.server/d/9ea2455f6f55478bbb0d/</code></pre>
<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>
<h3 id="compatibility">Compatibility</h3>
<p>It has been actively tested using the <a
href="https://github.com/haiwen/seafile-docker">seafile docker image</a>
of these versions: - 6.3.4 community edition - 7.0.5 community edition -
7.1.3 community edition</p>
<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>
<h3 id="standard-options-36">Standard options</h3>
<p>Here are the Standard options specific to seafile (seafile).</p>
<h4 id="seafile-url">–seafile-url</h4>
<p>URL of seafile host to connect to.</p>
<p>Properties:</p>
<ul>
<li>Config: url</li>
<li>Env Var: RCLONE_SEAFILE_URL</li>
<li>Type: string</li>
<li>Required: true</li>
<li>Examples:
<ul>
<li>“https://cloud.seafile.com/”
<ul>
<li>Connect to cloud.seafile.com.</li>
</ul></li>
</ul></li>
</ul>
<h4 id="seafile-user">–seafile-user</h4>
<p>User name (usually email address).</p>
<p>Properties:</p>
<ul>
<li>Config: user</li>
<li>Env Var: RCLONE_SEAFILE_USER</li>
<li>Type: string</li>
<li>Required: true</li>
</ul>
<h4 id="seafile-pass">–seafile-pass</h4>
<p>Password.</p>
<p><strong>NB</strong> Input to this must be obscured - see <a
href="https://rclone.org/commands/rclone_obscure/">rclone
obscure</a>.</p>
<p>Properties:</p>
<ul>
<li>Config: pass</li>
<li>Env Var: RCLONE_SEAFILE_PASS</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="seafile-2fa">–seafile-2fa</h4>
<p>Two-factor authentication (‘true’ if the account has 2FA
enabled).</p>
<p>Properties:</p>
<ul>
<li>Config: 2fa</li>
<li>Env Var: RCLONE_SEAFILE_2FA</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="seafile-library">–seafile-library</h4>
<p>Name of the library.</p>
<p>Leave blank to access all non-encrypted libraries.</p>
<p>Properties:</p>
<ul>
<li>Config: library</li>
<li>Env Var: RCLONE_SEAFILE_LIBRARY</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="seafile-library-key">–seafile-library-key</h4>
<p>Library password (for encrypted libraries only).</p>
<p>Leave blank if you pass it through the command line.</p>
<p><strong>NB</strong> Input to this must be obscured - see <a
href="https://rclone.org/commands/rclone_obscure/">rclone
obscure</a>.</p>
<p>Properties:</p>
<ul>
<li>Config: library_key</li>
<li>Env Var: RCLONE_SEAFILE_LIBRARY_KEY</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="seafile-auth-token">–seafile-auth-token</h4>
<p>Authentication token.</p>
<p>Properties:</p>
<ul>
<li>Config: auth_token</li>
<li>Env Var: RCLONE_SEAFILE_AUTH_TOKEN</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h3 id="advanced-options-36">Advanced options</h3>
<p>Here are the Advanced options specific to seafile (seafile).</p>
<h4 id="seafile-create-library">–seafile-create-library</h4>
<p>Should rclone create a library if it doesn’t exist.</p>
<p>Properties:</p>
<ul>
<li>Config: create_library</li>
<li>Env Var: RCLONE_SEAFILE_CREATE_LIBRARY</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="seafile-encoding">–seafile-encoding</h4>
<p>The encoding for the backend.</p>
<p>See the <a href="https://rclone.org/overview/#encoding">encoding
section in the overview</a> for more info.</p>
<p>Properties:</p>
<ul>
<li>Config: encoding</li>
<li>Env Var: RCLONE_SEAFILE_ENCODING</li>
<li>Type: MultiEncoder</li>
<li>Default: Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8</li>
</ul>
<h1 id="sftp">SFTP</h1>
<p>SFTP is the <a
href="https://en.wikipedia.org/wiki/SSH_File_Transfer_Protocol">Secure
(or SSH) File Transfer Protocol</a>.</p>
<p>The SFTP backend can be used with a number of different
providers:</p>
<ul>
<li>Hetzner Storage Box</li>
<li>rsync.net</li>
</ul>
<p>SFTP runs over SSH v2 and is installed as standard with most modern
SSH installations.</p>
<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>
<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>
<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>
<h2 id="configuration-39">Configuration</h2>
<p>Here is an example of making an SFTP configuration. First run</p>
<pre><code>rclone config</code></pre>
<p>This will guide you through an interactive setup process.</p>
<pre><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; remote
Type of storage to configure.
Choose a number from below, or type in your own value
[snip]
XX / SSH/SFTP
   \ &quot;sftp&quot;
[snip]
Storage&gt; sftp
SSH host to connect to
Choose a number from below, or type in your own value
 1 / Connect to example.com
   \ &quot;example.com&quot;
host&gt; example.com
SSH username
Enter a string value. Press Enter for the default (&quot;$USER&quot;).
user&gt; sftpuser
SSH port number
Enter a signed integer. Press Enter for the default (22).
port&gt;
SSH password, leave blank to use ssh-agent.
y) Yes type in my own password
g) Generate random password
n) No leave this optional password blank
y/g/n&gt; n
Path to unencrypted PEM-encoded private key file, leave blank to use ssh-agent.
key_file&gt;
Remote config
--------------------
[remote]
host = example.com
user = sftpuser
port =
pass =
key_file =
--------------------
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<p>This remote is called <code>remote</code> and can now be used like
this:</p>
<p>See all directories in the home directory</p>
<pre><code>rclone lsd remote:</code></pre>
<p>See all directories in the root directory</p>
<pre><code>rclone lsd remote:/</code></pre>
<p>Make a new directory</p>
<pre><code>rclone mkdir remote:path/to/directory</code></pre>
<p>List the contents of a directory</p>
<pre><code>rclone ls remote:path/to/directory</code></pre>
<p>Sync <code>/home/local/directory</code> to the remote directory,
deleting any excess files in the directory.</p>
<pre><code>rclone sync -i /home/local/directory remote:directory</code></pre>
<p>Mount the remote path <code>/srv/www-data/</code> to the local path
<code>/mnt/www-data</code></p>
<pre><code>rclone mount remote:/srv/www-data/ /mnt/www-data</code></pre>
<h3 id="ssh-authentication">SSH Authentication</h3>
<p>The SFTP remote supports three authentication methods:</p>
<ul>
<li>Password</li>
<li>Key file, including certificate signed keys</li>
<li>ssh-agent</li>
</ul>
<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>
<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>
<pre><code>key_pem = -----BEGIN RSA PRIVATE KEY-----\nMaMbaIXtE\n0gAMbMbaSsd\nMbaass\n-----END RSA PRIVATE KEY-----</code></pre>
<p>This will generate it correctly for key_pem for use in the
config:</p>
<pre><code>awk &#39;{printf &quot;%s\\n&quot;, $0}&#39; &lt; ~/.ssh/id_rsa</code></pre>
<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>
<p>Using an ssh-agent is the only way to load encrypted OpenSSH keys at
the moment.</p>
<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>
<h4 id="certificate-signed-keys">Certificate-signed keys</h4>
<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>
<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>
<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>
<p>Example:</p>
<pre><code>[remote]
type = sftp
host = example.com
user = sftpuser
key_file = ~/id_rsa
pubkey_file = ~/id_rsa-cert.pub</code></pre>
<p>If you concatenate a cert with a private key then you can specify the
merged file in both places.</p>
<p>Note: the cert must come first in the file. e.g.</p>
<pre><code>cat id_rsa-cert.pub id_rsa &gt; merged_key</code></pre>
<h3 id="host-key-validation">Host key validation</h3>
<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>
<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>
<p>e.g. using the OpenSSH <code>known_hosts</code> file:</p>
<pre><code>[remote]
type = sftp
host = example.com
user = sftpuser
pass = 
known_hosts_file = ~/.ssh/known_hosts</code></pre>
<p>Alternatively you can create your own known hosts file like this:</p>
<pre><code>ssh-keyscan -t dsa,rsa,ecdsa,ed25519 example.com &gt;&gt; known_hosts</code></pre>
<p>There are some limitations:</p>
<ul>
<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>
<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>
</ul>
<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>
<pre><code>NewFs: couldn&#39;t connect SSH: ssh: handshake failed: knownhosts: key mismatch</code></pre>
<p>or</p>
<pre><code>NewFs: couldn&#39;t connect SSH: ssh: handshake failed: knownhosts: key is unknown</code></pre>
<p>If you see an error such as</p>
<pre><code>NewFs: couldn&#39;t connect SSH: ssh: handshake failed: ssh: no authorities for hostname: example.com:22</code></pre>
<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>
<p>The <code>known_hosts_file</code> setting can be set during
<code>rclone config</code> as an advanced option.</p>
<h3 id="ssh-agent-on-macos">ssh-agent on macOS</h3>
<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>
<pre><code>eval `ssh-agent -s` &amp;&amp; ssh-add -A</code></pre>
<p>And then at the end of the session</p>
<pre><code>eval `ssh-agent -k`</code></pre>
<p>These commands can be used in scripts of course.</p>
<h3 id="shell-access">Shell access</h3>
<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>
<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>
<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>
<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>
<h4 id="shell-access-considerations">Shell access considerations</h4>
<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>
<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>
<h3 id="checksum-2">Checksum</h3>
<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>
<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>
<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>
<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>
<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>
<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>
<h3 id="modified-time-12">Modified time</h3>
<p>Modified times are stored on the server to 1 second precision.</p>
<p>Modified times are used in syncing and are fully supported.</p>
<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>
<h3 id="about-command">About command</h3>
<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>
<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>
<h3 id="standard-options-37">Standard options</h3>
<p>Here are the Standard options specific to sftp (SSH/SFTP).</p>
<h4 id="sftp-host">–sftp-host</h4>
<p>SSH host to connect to.</p>
<p>E.g. “example.com”.</p>
<p>Properties:</p>
<ul>
<li>Config: host</li>
<li>Env Var: RCLONE_SFTP_HOST</li>
<li>Type: string</li>
<li>Required: true</li>
</ul>
<h4 id="sftp-user">–sftp-user</h4>
<p>SSH username.</p>
<p>Properties:</p>
<ul>
<li>Config: user</li>
<li>Env Var: RCLONE_SFTP_USER</li>
<li>Type: string</li>
<li>Default: “$USER”</li>
</ul>
<h4 id="sftp-port">–sftp-port</h4>
<p>SSH port number.</p>
<p>Properties:</p>
<ul>
<li>Config: port</li>
<li>Env Var: RCLONE_SFTP_PORT</li>
<li>Type: int</li>
<li>Default: 22</li>
</ul>
<h4 id="sftp-pass">–sftp-pass</h4>
<p>SSH password, leave blank to use ssh-agent.</p>
<p><strong>NB</strong> Input to this must be obscured - see <a
href="https://rclone.org/commands/rclone_obscure/">rclone
obscure</a>.</p>
<p>Properties:</p>
<ul>
<li>Config: pass</li>
<li>Env Var: RCLONE_SFTP_PASS</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="sftp-key-pem">–sftp-key-pem</h4>
<p>Raw PEM-encoded private key.</p>
<p>If specified, will override key_file parameter.</p>
<p>Properties:</p>
<ul>
<li>Config: key_pem</li>
<li>Env Var: RCLONE_SFTP_KEY_PEM</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="sftp-key-file">–sftp-key-file</h4>
<p>Path to PEM-encoded private key file.</p>
<p>Leave blank or set key-use-agent to use ssh-agent.</p>
<p>Leading <code>~</code> will be expanded in the file name as will
environment variables such as <code>${RCLONE_CONFIG_DIR}</code>.</p>
<p>Properties:</p>
<ul>
<li>Config: key_file</li>
<li>Env Var: RCLONE_SFTP_KEY_FILE</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="sftp-key-file-pass">–sftp-key-file-pass</h4>
<p>The passphrase to decrypt the PEM-encoded private key file.</p>
<p>Only PEM encrypted key files (old OpenSSH format) are supported.
Encrypted keys in the new OpenSSH format can’t be used.</p>
<p><strong>NB</strong> Input to this must be obscured - see <a
href="https://rclone.org/commands/rclone_obscure/">rclone
obscure</a>.</p>
<p>Properties:</p>
<ul>
<li>Config: key_file_pass</li>
<li>Env Var: RCLONE_SFTP_KEY_FILE_PASS</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="sftp-pubkey-file">–sftp-pubkey-file</h4>
<p>Optional path to public key file.</p>
<p>Set this if you have a signed certificate you want to use for
authentication.</p>
<p>Leading <code>~</code> will be expanded in the file name as will
environment variables such as <code>${RCLONE_CONFIG_DIR}</code>.</p>
<p>Properties:</p>
<ul>
<li>Config: pubkey_file</li>
<li>Env Var: RCLONE_SFTP_PUBKEY_FILE</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="sftp-key-use-agent">–sftp-key-use-agent</h4>
<p>When set forces the usage of the ssh-agent.</p>
<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>
<p>Properties:</p>
<ul>
<li>Config: key_use_agent</li>
<li>Env Var: RCLONE_SFTP_KEY_USE_AGENT</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="sftp-use-insecure-cipher">–sftp-use-insecure-cipher</h4>
<p>Enable the use of insecure ciphers and key exchange methods.</p>
<p>This enables the use of the following insecure ciphers and key
exchange methods:</p>
<ul>
<li>aes128-cbc</li>
<li>aes192-cbc</li>
<li>aes256-cbc</li>
<li>3des-cbc</li>
<li>diffie-hellman-group-exchange-sha256</li>
<li>diffie-hellman-group-exchange-sha1</li>
</ul>
<p>Those algorithms are insecure and may allow plaintext data to be
recovered by an attacker.</p>
<p>Properties:</p>
<ul>
<li>Config: use_insecure_cipher</li>
<li>Env Var: RCLONE_SFTP_USE_INSECURE_CIPHER</li>
<li>Type: bool</li>
<li>Default: false</li>
<li>Examples:
<ul>
<li>“false”
<ul>
<li>Use default Cipher list.</li>
</ul></li>
<li>“true”
<ul>
<li>Enables the use of the aes128-cbc cipher and
diffie-hellman-group-exchange-sha256, diffie-hellman-group-exchange-sha1
key exchange.</li>
</ul></li>
</ul></li>
</ul>
<h4 id="sftp-disable-hashcheck">–sftp-disable-hashcheck</h4>
<p>Disable the execution of SSH commands to determine if remote file
hashing is available.</p>
<p>Leave blank or set to false to enable hashing (recommended), set to
true to disable hashing.</p>
<p>Properties:</p>
<ul>
<li>Config: disable_hashcheck</li>
<li>Env Var: RCLONE_SFTP_DISABLE_HASHCHECK</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h3 id="advanced-options-37">Advanced options</h3>
<p>Here are the Advanced options specific to sftp (SSH/SFTP).</p>
<h4 id="sftp-known-hosts-file">–sftp-known-hosts-file</h4>
<p>Optional path to known_hosts file.</p>
<p>Set this value to enable server host key validation.</p>
<p>Leading <code>~</code> will be expanded in the file name as will
environment variables such as <code>${RCLONE_CONFIG_DIR}</code>.</p>
<p>Properties:</p>
<ul>
<li>Config: known_hosts_file</li>
<li>Env Var: RCLONE_SFTP_KNOWN_HOSTS_FILE</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“~/.ssh/known_hosts”
<ul>
<li>Use OpenSSH’s known_hosts file.</li>
</ul></li>
</ul></li>
</ul>
<h4 id="sftp-ask-password">–sftp-ask-password</h4>
<p>Allow asking for SFTP password when needed.</p>
<p>If this is set and no password is supplied then rclone will: - ask
for a password - not contact the ssh agent</p>
<p>Properties:</p>
<ul>
<li>Config: ask_password</li>
<li>Env Var: RCLONE_SFTP_ASK_PASSWORD</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="sftp-path-override">–sftp-path-override</h4>
<p>Override path used by SSH shell commands.</p>
<p>This allows checksum calculation when SFTP and SSH paths are
different. This issue affects among others Synology NAS boxes.</p>
<p>E.g. if shared folders can be found in directories representing
volumes:</p>
<pre><code>rclone sync /home/local/directory remote:/directory --sftp-path-override /volume2/directory</code></pre>
<p>E.g. if home directory can be found in a shared folder called
“home”:</p>
<pre><code>rclone sync /home/local/directory remote:/home/directory --sftp-path-override /volume1/homes/USER/directory</code></pre>
<p>Properties:</p>
<ul>
<li>Config: path_override</li>
<li>Env Var: RCLONE_SFTP_PATH_OVERRIDE</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="sftp-set-modtime">–sftp-set-modtime</h4>
<p>Set the modified time on the remote if set.</p>
<p>Properties:</p>
<ul>
<li>Config: set_modtime</li>
<li>Env Var: RCLONE_SFTP_SET_MODTIME</li>
<li>Type: bool</li>
<li>Default: true</li>
</ul>
<h4 id="sftp-shell-type">–sftp-shell-type</h4>
<p>The type of SSH shell on remote server, if any.</p>
<p>Leave blank for autodetect.</p>
<p>Properties:</p>
<ul>
<li>Config: shell_type</li>
<li>Env Var: RCLONE_SFTP_SHELL_TYPE</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“none”
<ul>
<li>No shell access</li>
</ul></li>
<li>“unix”
<ul>
<li>Unix shell</li>
</ul></li>
<li>“powershell”
<ul>
<li>PowerShell</li>
</ul></li>
<li>“cmd”
<ul>
<li>Windows Command Prompt</li>
</ul></li>
</ul></li>
</ul>
<h4 id="sftp-md5sum-command">–sftp-md5sum-command</h4>
<p>The command used to read md5 hashes.</p>
<p>Leave blank for autodetect.</p>
<p>Properties:</p>
<ul>
<li>Config: md5sum_command</li>
<li>Env Var: RCLONE_SFTP_MD5SUM_COMMAND</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="sftp-sha1sum-command">–sftp-sha1sum-command</h4>
<p>The command used to read sha1 hashes.</p>
<p>Leave blank for autodetect.</p>
<p>Properties:</p>
<ul>
<li>Config: sha1sum_command</li>
<li>Env Var: RCLONE_SFTP_SHA1SUM_COMMAND</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="sftp-skip-links">–sftp-skip-links</h4>
<p>Set to skip any symlinks and any other non regular files.</p>
<p>Properties:</p>
<ul>
<li>Config: skip_links</li>
<li>Env Var: RCLONE_SFTP_SKIP_LINKS</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="sftp-subsystem">–sftp-subsystem</h4>
<p>Specifies the SSH2 subsystem on the remote host.</p>
<p>Properties:</p>
<ul>
<li>Config: subsystem</li>
<li>Env Var: RCLONE_SFTP_SUBSYSTEM</li>
<li>Type: string</li>
<li>Default: “sftp”</li>
</ul>
<h4 id="sftp-server-command">–sftp-server-command</h4>
<p>Specifies the path or command to run a sftp server on the remote
host.</p>
<p>The subsystem option is ignored when server_command is defined.</p>
<p>Properties:</p>
<ul>
<li>Config: server_command</li>
<li>Env Var: RCLONE_SFTP_SERVER_COMMAND</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="sftp-use-fstat">–sftp-use-fstat</h4>
<p>If set use fstat instead of stat.</p>
<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>
<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>
<p>Properties:</p>
<ul>
<li>Config: use_fstat</li>
<li>Env Var: RCLONE_SFTP_USE_FSTAT</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4
id="sftp-disable-concurrent-reads">–sftp-disable-concurrent-reads</h4>
<p>If set don’t use concurrent reads.</p>
<p>Normally concurrent reads are safe to use and not using them will
degrade performance, so this option is disabled by default.</p>
<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>
<pre><code>Failed to copy: file does not exist</code></pre>
<p>Then you may need to enable this flag.</p>
<p>If concurrent reads are disabled, the use_fstat option is
ignored.</p>
<p>Properties:</p>
<ul>
<li>Config: disable_concurrent_reads</li>
<li>Env Var: RCLONE_SFTP_DISABLE_CONCURRENT_READS</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4
id="sftp-disable-concurrent-writes">–sftp-disable-concurrent-writes</h4>
<p>If set don’t use concurrent writes.</p>
<p>Normally rclone uses concurrent writes to upload files. This improves
the performance greatly, especially for distant servers.</p>
<p>This option disables concurrent writes should that be necessary.</p>
<p>Properties:</p>
<ul>
<li>Config: disable_concurrent_writes</li>
<li>Env Var: RCLONE_SFTP_DISABLE_CONCURRENT_WRITES</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="sftp-idle-timeout">–sftp-idle-timeout</h4>
<p>Max time before closing idle connections.</p>
<p>If no connections have been returned to the connection pool in the
time given, rclone will empty the connection pool.</p>
<p>Set to 0 to keep connections indefinitely.</p>
<p>Properties:</p>
<ul>
<li>Config: idle_timeout</li>
<li>Env Var: RCLONE_SFTP_IDLE_TIMEOUT</li>
<li>Type: Duration</li>
<li>Default: 1m0s</li>
</ul>
<h4 id="sftp-chunk-size">–sftp-chunk-size</h4>
<p>Upload and download chunk size.</p>
<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>
<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>
<p>Properties:</p>
<ul>
<li>Config: chunk_size</li>
<li>Env Var: RCLONE_SFTP_CHUNK_SIZE</li>
<li>Type: SizeSuffix</li>
<li>Default: 32Ki</li>
</ul>
<h4 id="sftp-concurrency">–sftp-concurrency</h4>
<p>The maximum number of outstanding requests for one file</p>
<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>
<p>Properties:</p>
<ul>
<li>Config: concurrency</li>
<li>Env Var: RCLONE_SFTP_CONCURRENCY</li>
<li>Type: int</li>
<li>Default: 64</li>
</ul>
<h4 id="sftp-set-env">–sftp-set-env</h4>
<p>Environment variables to pass to sftp and commands</p>
<p>Set environment variables in the form:</p>
<pre><code>VAR=value</code></pre>
<p>to be passed to the sftp client and to any commands run (eg
md5sum).</p>
<p>Pass multiple variables space separated, eg</p>
<pre><code>VAR1=value VAR2=value</code></pre>
<p>and pass variables with spaces in in quotes, eg</p>
<pre><code>&quot;VAR3=value with space&quot; &quot;VAR4=value with space&quot; VAR5=nospacehere</code></pre>
<p>Properties:</p>
<ul>
<li>Config: set_env</li>
<li>Env Var: RCLONE_SFTP_SET_ENV</li>
<li>Type: SpaceSepList</li>
<li>Default:</li>
</ul>
<h2 id="limitations-29">Limitations</h2>
<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>
<p>The only ssh agent supported under Windows is Putty’s pageant.</p>
<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>
<p>SFTP isn’t supported under plan9 until <a
href="https://github.com/pkg/sftp/issues/156">this issue</a> is
fixed.</p>
<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>
<p>Note that <code>--timeout</code> and <code>--contimeout</code> are
both supported.</p>
<h2 id="rsync-net">rsync.net</h2>
<p>rsync.net is supported through the SFTP backend.</p>
<p>See <a href="https://www.rsync.net/products/rclone.html">rsync.net’s
documentation of rclone examples</a>.</p>
<h2 id="hetzner-storage-box">Hetzner Storage Box</h2>
<p>Hetzner Storage Boxes are supported through the SFTP backend on port
23.</p>
<p>See <a
href="https://docs.hetzner.com/robot/storage-box/access/access-ssh-rsync-borg#rclone">Hetzner’s
documentation for details</a></p>
<h1 id="smb">SMB</h1>
<p>SMB is <a href="https://en.wikipedia.org/wiki/Server_Message_Block">a
communication protocol to share files over network</a>.</p>
<p>This relies on <a
href="https://github.com/hirochachacha/go-smb2/">go-smb2 library</a> for
communication with SMB protocol.</p>
<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>
<h2 id="notes-2">Notes</h2>
<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 quering the root if you’re unsure
(e.g. <code>rclone lsd remote:</code>).</p>
<p>You can’t access to the shared printers from rclone, obviously.</p>
<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>
<h2 id="configuration-40">Configuration</h2>
<p>Here is an example of making a SMB configuration.</p>
<p>First run</p>
<pre><code>rclone config</code></pre>
<p>This will guide you through an interactive setup process.</p>
<pre><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; remote
Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
XX / SMB / CIFS
   \ (smb)
Storage&gt; smb

Option host.
Samba hostname to connect to.
E.g. &quot;example.com&quot;.
Enter a value.
host&gt; localhost

Option user.
Samba username.
Enter a string value. Press Enter for the default (lesmi).
user&gt; guest

Option port.
Samba port number.
Enter a signed integer. Press Enter for the default (445).
port&gt;

Option pass.
Samba password.
Choose an alternative below. Press Enter for the default (n).
y) Yes, type in my own password
g) Generate random password
n) No, leave this optional password blank (default)
y/g/n&gt; g
Password strength in bits.
64 is just about memorable
128 is secure
1024 is the maximum
Bits&gt; 64
Your password is: XXXX
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&gt; y

Option domain.
Domain name for NTLM authentication.
Enter a string value. Press Enter for the default (WORKGROUP).
domain&gt;

Edit advanced config?
y) Yes
n) No (default)
y/n&gt; n

Configuration complete.
Options:
- type: samba
- host: localhost
- user: guest
- pass: *** ENCRYPTED ***
Keep this &quot;remote&quot; remote?
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d&gt; d</code></pre>
<h3 id="standard-options-38">Standard options</h3>
<p>Here are the Standard options specific to smb (SMB / CIFS).</p>
<h4 id="smb-host">–smb-host</h4>
<p>SMB server hostname to connect to.</p>
<p>E.g. “example.com”.</p>
<p>Properties:</p>
<ul>
<li>Config: host</li>
<li>Env Var: RCLONE_SMB_HOST</li>
<li>Type: string</li>
<li>Required: true</li>
</ul>
<h4 id="smb-user">–smb-user</h4>
<p>SMB username.</p>
<p>Properties:</p>
<ul>
<li>Config: user</li>
<li>Env Var: RCLONE_SMB_USER</li>
<li>Type: string</li>
<li>Default: “$USER”</li>
</ul>
<h4 id="smb-port">–smb-port</h4>
<p>SMB port number.</p>
<p>Properties:</p>
<ul>
<li>Config: port</li>
<li>Env Var: RCLONE_SMB_PORT</li>
<li>Type: int</li>
<li>Default: 445</li>
</ul>
<h4 id="smb-pass">–smb-pass</h4>
<p>SMB password.</p>
<p><strong>NB</strong> Input to this must be obscured - see <a
href="https://rclone.org/commands/rclone_obscure/">rclone
obscure</a>.</p>
<p>Properties:</p>
<ul>
<li>Config: pass</li>
<li>Env Var: RCLONE_SMB_PASS</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="smb-domain">–smb-domain</h4>
<p>Domain name for NTLM authentication.</p>
<p>Properties:</p>
<ul>
<li>Config: domain</li>
<li>Env Var: RCLONE_SMB_DOMAIN</li>
<li>Type: string</li>
<li>Default: “WORKGROUP”</li>
</ul>
<h3 id="advanced-options-38">Advanced options</h3>
<p>Here are the Advanced options specific to smb (SMB / CIFS).</p>
<h4 id="smb-idle-timeout">–smb-idle-timeout</h4>
<p>Max time before closing idle connections.</p>
<p>If no connections have been returned to the connection pool in the
time given, rclone will empty the connection pool.</p>
<p>Set to 0 to keep connections indefinitely.</p>
<p>Properties:</p>
<ul>
<li>Config: idle_timeout</li>
<li>Env Var: RCLONE_SMB_IDLE_TIMEOUT</li>
<li>Type: Duration</li>
<li>Default: 1m0s</li>
</ul>
<h4 id="smb-hide-special-share">–smb-hide-special-share</h4>
<p>Hide special shares (e.g. print$) which users aren’t supposed to
access.</p>
<p>Properties:</p>
<ul>
<li>Config: hide_special_share</li>
<li>Env Var: RCLONE_SMB_HIDE_SPECIAL_SHARE</li>
<li>Type: bool</li>
<li>Default: true</li>
</ul>
<h4 id="smb-case-insensitive">–smb-case-insensitive</h4>
<p>Whether the server is configured to be case-insensitive.</p>
<p>Always true on Windows shares.</p>
<p>Properties:</p>
<ul>
<li>Config: case_insensitive</li>
<li>Env Var: RCLONE_SMB_CASE_INSENSITIVE</li>
<li>Type: bool</li>
<li>Default: true</li>
</ul>
<h4 id="smb-encoding">–smb-encoding</h4>
<p>The encoding for the backend.</p>
<p>See the <a href="https://rclone.org/overview/#encoding">encoding
section in the overview</a> for more info.</p>
<p>Properties:</p>
<ul>
<li>Config: encoding</li>
<li>Env Var: RCLONE_SMB_ENCODING</li>
<li>Type: MultiEncoder</li>
<li>Default:
Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot</li>
</ul>
<h1 id="storj-1">Storj</h1>
<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>
<h2 id="backend-options">Backend options</h2>
<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>
<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>
<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>
<p>Side by side comparison with more details:</p>
<ul>
<li>Characteristics:
<ul>
<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>
<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>
</ul></li>
<li>Typical usage:
<ul>
<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>
<li><em>S3 backend</em>: Desktops and similar with limited resources,
internet speed or connectivity.</li>
</ul></li>
<li>Security:
<ul>
<li><em>Storj backend</em>: <strong>strong</strong>. Private encryption
key doesn’t need to leave the local computer.</li>
<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>
</ul></li>
<li>Bandwidth usage (upload):
<ul>
<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>
<li><em>S3 backend</em>: <strong>normal</strong>. Only the raw data is
uploaded, erasure coding happens on the gateway.</li>
</ul></li>
<li>Bandwidth usage (download)
<ul>
<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>
<li><em>S3 backend</em>: <strong>normal</strong>. Only the raw data is
downloaded, erasure coding happens on the shared gateway.</li>
</ul></li>
<li>CPU usage:
<ul>
<li><em>Storj backend</em>: <strong>higher</strong>, but more
predictable. Erasure code and encryption/decryption happens locally
which requires significant CPU usage.</li>
<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>
</ul></li>
<li>TCP connection usage:
<ul>
<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>
<li><em>S3 backend</em>: <strong>normal</strong>. Only one connection
per download/upload thread is required to the shared gateway.</li>
</ul></li>
<li>Overall performance:
<ul>
<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>
<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>
</ul></li>
<li>Decentralization:
<ul>
<li><em>Storj backend</em>: <strong>high</strong>. Data is downloaded
directly from the distributed cloud of storage providers.</li>
<li><em>S3 backend</em>: <strong>low</strong>. Requires a running S3
gateway (either self-hosted or Storj-hosted).</li>
</ul></li>
<li>Limitations:
<ul>
<li><em>Storj backend</em>: <code>rclone checksum</code> is not possible
without download, as checksum metadata is not calculated during
upload</li>
<li><em>S3 backend</em>: secret encryption key is shared with the
gateway</li>
</ul></li>
</ul>
<h2 id="configuration-41">Configuration</h2>
<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>
<p>Here is an example of how to make a remote called
<code>remote</code>. First run:</p>
<pre><code> rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<h3 id="setup-with-access-grant">Setup with access grant</h3>
<pre><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; remote
Type of storage to configure.
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
[snip]
XX / Storj Decentralized Cloud Storage
   \ &quot;storj&quot;
[snip]
Storage&gt; storj
** See help for storj backend at: https://rclone.org/storj/ **

Choose an authentication method.
Enter a string value. Press Enter for the default (&quot;existing&quot;).
Choose a number from below, or type in your own value
 1 / Use an existing access grant.
   \ &quot;existing&quot;
 2 / Create a new access grant from satellite address, API key, and passphrase.
   \ &quot;new&quot;
provider&gt; new
Satellite Address. Custom satellite address should match the format: `&lt;nodeid&gt;@&lt;address&gt;:&lt;port&gt;`.
Enter a string value. Press Enter for the default (&quot;us-central-1.storj.io&quot;).
Choose a number from below, or type in your own value
 1 / US Central 1
   \ &quot;us-central-1.storj.io&quot;
 2 / Europe West 1
   \ &quot;europe-west-1.storj.io&quot;
 3 / Asia East 1
   \ &quot;asia-east-1.storj.io&quot;
satellite_address&gt; 1
API Key.
Enter a string value. Press Enter for the default (&quot;&quot;).
api_key&gt; your-api-key-for-your-storj-project
Encryption Passphrase. To access existing objects enter passphrase used for uploading.
Enter a string value. Press Enter for the default (&quot;&quot;).
passphrase&gt; your-human-readable-encryption-passphrase
Remote config
--------------------
[remote]
type = storj
satellite_address = 12EayRS2V1kEsWESU9QMRseFhdxYxKicsiFmxrsLZHeLUtdps3S@us-central-1.tardigrade.io:7777
api_key = your-api-key-for-your-storj-project
passphrase = your-human-readable-encryption-passphrase
access_grant = the-access-grant-generated-from-the-api-key-and-passphrase
--------------------
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<h3 id="standard-options-39">Standard options</h3>
<p>Here are the Standard options specific to storj (Storj Decentralized
Cloud Storage).</p>
<h4 id="storj-provider">–storj-provider</h4>
<p>Choose an authentication method.</p>
<p>Properties:</p>
<ul>
<li>Config: provider</li>
<li>Env Var: RCLONE_STORJ_PROVIDER</li>
<li>Type: string</li>
<li>Default: “existing”</li>
<li>Examples:
<ul>
<li>“existing”
<ul>
<li>Use an existing access grant.</li>
</ul></li>
<li>“new”
<ul>
<li>Create a new access grant from satellite address, API key, and
passphrase.</li>
</ul></li>
</ul></li>
</ul>
<h4 id="storj-access-grant">–storj-access-grant</h4>
<p>Access grant.</p>
<p>Properties:</p>
<ul>
<li>Config: access_grant</li>
<li>Env Var: RCLONE_STORJ_ACCESS_GRANT</li>
<li>Provider: existing</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="storj-satellite-address">–storj-satellite-address</h4>
<p>Satellite address.</p>
<p>Custom satellite address should match the format:
<code>&lt;nodeid&gt;@&lt;address&gt;:&lt;port&gt;</code>.</p>
<p>Properties:</p>
<ul>
<li>Config: satellite_address</li>
<li>Env Var: RCLONE_STORJ_SATELLITE_ADDRESS</li>
<li>Provider: new</li>
<li>Type: string</li>
<li>Default: “us-central-1.storj.io”</li>
<li>Examples:
<ul>
<li>“us-central-1.storj.io”
<ul>
<li>US Central 1</li>
</ul></li>
<li>“europe-west-1.storj.io”
<ul>
<li>Europe West 1</li>
</ul></li>
<li>“asia-east-1.storj.io”
<ul>
<li>Asia East 1</li>
</ul></li>
</ul></li>
</ul>
<h4 id="storj-api-key">–storj-api-key</h4>
<p>API key.</p>
<p>Properties:</p>
<ul>
<li>Config: api_key</li>
<li>Env Var: RCLONE_STORJ_API_KEY</li>
<li>Provider: new</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="storj-passphrase">–storj-passphrase</h4>
<p>Encryption passphrase.</p>
<p>To access existing objects enter passphrase used for uploading.</p>
<p>Properties:</p>
<ul>
<li>Config: passphrase</li>
<li>Env Var: RCLONE_STORJ_PASSPHRASE</li>
<li>Provider: new</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h2 id="usage-2">Usage</h2>
<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>
<p>Once configured you can then use <code>rclone</code> like this.</p>
<h3 id="create-a-new-bucket">Create a new bucket</h3>
<p>Use the <code>mkdir</code> command to create new bucket,
e.g. <code>bucket</code>.</p>
<pre><code>rclone mkdir remote:bucket</code></pre>
<h3 id="list-all-buckets">List all buckets</h3>
<p>Use the <code>lsf</code> command to list all buckets.</p>
<pre><code>rclone lsf remote:</code></pre>
<p>Note the colon (<code>:</code>) character at the end of the command
line.</p>
<h3 id="delete-a-bucket">Delete a bucket</h3>
<p>Use the <code>rmdir</code> command to delete an empty bucket.</p>
<pre><code>rclone rmdir remote:bucket</code></pre>
<p>Use the <code>purge</code> command to delete a non-empty bucket with
all its content.</p>
<pre><code>rclone purge remote:bucket</code></pre>
<h3 id="upload-objects">Upload objects</h3>
<p>Use the <code>copy</code> command to upload an object.</p>
<pre><code>rclone copy --progress /home/local/directory/file.ext remote:bucket/path/to/dir/</code></pre>
<p>The <code>--progress</code> flag is for displaying progress
information. Remove it if you don’t need this information.</p>
<p>Use a folder in the local path to upload all its objects.</p>
<pre><code>rclone copy --progress /home/local/directory/ remote:bucket/path/to/dir/</code></pre>
<p>Only modified files will be copied.</p>
<h3 id="list-objects">List objects</h3>
<p>Use the <code>ls</code> command to list recursively all objects in a
bucket.</p>
<pre><code>rclone ls remote:bucket</code></pre>
<p>Add the folder to the remote path to list recursively all objects in
this folder.</p>
<pre><code>rclone ls remote:bucket/path/to/dir/</code></pre>
<p>Use the <code>lsf</code> command to list non-recursively all objects
in a bucket or a folder.</p>
<pre><code>rclone lsf remote:bucket/path/to/dir/</code></pre>
<h3 id="download-objects">Download objects</h3>
<p>Use the <code>copy</code> command to download an object.</p>
<pre><code>rclone copy --progress remote:bucket/path/to/dir/file.ext /home/local/directory/</code></pre>
<p>The <code>--progress</code> flag is for displaying progress
information. Remove it if you don’t need this information.</p>
<p>Use a folder in the remote path to download all its objects.</p>
<pre><code>rclone copy --progress remote:bucket/path/to/dir/ /home/local/directory/</code></pre>
<h3 id="delete-objects">Delete objects</h3>
<p>Use the <code>deletefile</code> command to delete a single
object.</p>
<pre><code>rclone deletefile remote:bucket/path/to/dir/file.ext</code></pre>
<p>Use the <code>delete</code> command to delete all object in a
folder.</p>
<pre><code>rclone delete remote:bucket/path/to/dir/</code></pre>
<h3 id="print-the-total-size-of-objects">Print the total size of
objects</h3>
<p>Use the <code>size</code> command to print the total size of objects
in a bucket or a folder.</p>
<pre><code>rclone size remote:bucket/path/to/dir/</code></pre>
<h3 id="sync-two-locations">Sync two Locations</h3>
<p>Use the <code>sync</code> command to sync the source to the
destination, changing the destination only, deleting any excess
files.</p>
<pre><code>rclone sync -i --progress /home/local/directory/ remote:bucket/path/to/dir/</code></pre>
<p>The <code>--progress</code> flag is for displaying progress
information. Remove it if you don’t need this information.</p>
<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>
<p>The sync can be done also from Storj to the local file system.</p>
<pre><code>rclone sync -i --progress remote:bucket/path/to/dir/ /home/local/directory/</code></pre>
<p>Or between two Storj buckets.</p>
<pre><code>rclone sync -i --progress remote-us:bucket/path/to/dir/ remote-europe:bucket/path/to/dir/</code></pre>
<p>Or even between another cloud storage and Storj.</p>
<pre><code>rclone sync -i --progress s3:bucket/path/to/dir/ storj:bucket/path/to/dir/</code></pre>
<h2 id="limitations-30">Limitations</h2>
<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>
<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>
<h2 id="known-issues-1">Known issues</h2>
<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>
<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>
<h1 id="sugarsync">SugarSync</h1>
<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>
<h2 id="configuration-42">Configuration</h2>
<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>
<p>Here is an example of how to make a remote called
<code>remote</code>. First run:</p>
<pre><code> rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<pre><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; remote
Type of storage to configure.
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
[snip]
XX / Sugarsync
   \ &quot;sugarsync&quot;
[snip]
Storage&gt; sugarsync
** See help for sugarsync backend at: https://rclone.org/sugarsync/ **

Sugarsync App ID.
Leave blank to use rclone&#39;s.
Enter a string value. Press Enter for the default (&quot;&quot;).
app_id&gt; 
Sugarsync Access Key ID.
Leave blank to use rclone&#39;s.
Enter a string value. Press Enter for the default (&quot;&quot;).
access_key_id&gt; 
Sugarsync Private Access Key
Leave blank to use rclone&#39;s.
Enter a string value. Press Enter for the default (&quot;&quot;).
private_access_key&gt; 
Permanently delete files if true
otherwise put them in the deleted files.
Enter a boolean value (true or false). Press Enter for the default (&quot;false&quot;).
hard_delete&gt; 
Edit advanced config? (y/n)
y) Yes
n) No (default)
y/n&gt; n
Remote config
Username (email address)&gt; nick@craig-wood.com
Your Sugarsync password is only required during setup and will not be stored.
password:
--------------------
[remote]
type = sugarsync
refresh_token = https://api.sugarsync.com/app-authorization/XXXXXXXXXXXXXXXXXX
--------------------
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<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>
<p>Once configured you can then use <code>rclone</code> like this,</p>
<p>List directories (sync folders) in top level of your SugarSync</p>
<pre><code>rclone lsd remote:</code></pre>
<p>List all the files in your SugarSync folder “Test”</p>
<pre><code>rclone ls remote:Test</code></pre>
<p>To copy a local directory to an SugarSync folder called backup</p>
<pre><code>rclone copy /home/source remote:backup</code></pre>
<p>Paths are specified as <code>remote:path</code></p>
<p>Paths may be as deep as required,
e.g. <code>remote:directory/subdirectory</code>.</p>
<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>
<h3 id="modified-time-and-hashes-12">Modified time and hashes</h3>
<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>
<h3 id="restricted-filename-characters-27">Restricted filename
characters</h3>
<p>SugarSync replaces the <a
href="https://rclone.org/overview/#restricted-characters">default
restricted characters set</a> except for DEL.</p>
<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>
<h3 id="deleting-files-7">Deleting files</h3>
<p>Deleted files will be moved to the “Deleted items” folder by
default.</p>
<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>
<h3 id="standard-options-40">Standard options</h3>
<p>Here are the Standard options specific to sugarsync (Sugarsync).</p>
<h4 id="sugarsync-app-id">–sugarsync-app-id</h4>
<p>Sugarsync App ID.</p>
<p>Leave blank to use rclone’s.</p>
<p>Properties:</p>
<ul>
<li>Config: app_id</li>
<li>Env Var: RCLONE_SUGARSYNC_APP_ID</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="sugarsync-access-key-id">–sugarsync-access-key-id</h4>
<p>Sugarsync Access Key ID.</p>
<p>Leave blank to use rclone’s.</p>
<p>Properties:</p>
<ul>
<li>Config: access_key_id</li>
<li>Env Var: RCLONE_SUGARSYNC_ACCESS_KEY_ID</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="sugarsync-private-access-key">–sugarsync-private-access-key</h4>
<p>Sugarsync Private Access Key.</p>
<p>Leave blank to use rclone’s.</p>
<p>Properties:</p>
<ul>
<li>Config: private_access_key</li>
<li>Env Var: RCLONE_SUGARSYNC_PRIVATE_ACCESS_KEY</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="sugarsync-hard-delete">–sugarsync-hard-delete</h4>
<p>Permanently delete files if true otherwise put them in the deleted
files.</p>
<p>Properties:</p>
<ul>
<li>Config: hard_delete</li>
<li>Env Var: RCLONE_SUGARSYNC_HARD_DELETE</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h3 id="advanced-options-39">Advanced options</h3>
<p>Here are the Advanced options specific to sugarsync (Sugarsync).</p>
<h4 id="sugarsync-refresh-token">–sugarsync-refresh-token</h4>
<p>Sugarsync refresh token.</p>
<p>Leave blank normally, will be auto configured by rclone.</p>
<p>Properties:</p>
<ul>
<li>Config: refresh_token</li>
<li>Env Var: RCLONE_SUGARSYNC_REFRESH_TOKEN</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="sugarsync-authorization">–sugarsync-authorization</h4>
<p>Sugarsync authorization.</p>
<p>Leave blank normally, will be auto configured by rclone.</p>
<p>Properties:</p>
<ul>
<li>Config: authorization</li>
<li>Env Var: RCLONE_SUGARSYNC_AUTHORIZATION</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4
id="sugarsync-authorization-expiry">–sugarsync-authorization-expiry</h4>
<p>Sugarsync authorization expiry.</p>
<p>Leave blank normally, will be auto configured by rclone.</p>
<p>Properties:</p>
<ul>
<li>Config: authorization_expiry</li>
<li>Env Var: RCLONE_SUGARSYNC_AUTHORIZATION_EXPIRY</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="sugarsync-user">–sugarsync-user</h4>
<p>Sugarsync user.</p>
<p>Leave blank normally, will be auto configured by rclone.</p>
<p>Properties:</p>
<ul>
<li>Config: user</li>
<li>Env Var: RCLONE_SUGARSYNC_USER</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="sugarsync-root-id">–sugarsync-root-id</h4>
<p>Sugarsync root id.</p>
<p>Leave blank normally, will be auto configured by rclone.</p>
<p>Properties:</p>
<ul>
<li>Config: root_id</li>
<li>Env Var: RCLONE_SUGARSYNC_ROOT_ID</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="sugarsync-deleted-id">–sugarsync-deleted-id</h4>
<p>Sugarsync deleted folder id.</p>
<p>Leave blank normally, will be auto configured by rclone.</p>
<p>Properties:</p>
<ul>
<li>Config: deleted_id</li>
<li>Env Var: RCLONE_SUGARSYNC_DELETED_ID</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="sugarsync-encoding">–sugarsync-encoding</h4>
<p>The encoding for the backend.</p>
<p>See the <a href="https://rclone.org/overview/#encoding">encoding
section in the overview</a> for more info.</p>
<p>Properties:</p>
<ul>
<li>Config: encoding</li>
<li>Env Var: RCLONE_SUGARSYNC_ENCODING</li>
<li>Type: MultiEncoder</li>
<li>Default: Slash,Ctl,InvalidUtf8,Dot</li>
</ul>
<h2 id="limitations-31">Limitations</h2>
<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>
<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>
<h1 id="tardigrade">Tardigrade</h1>
<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>
<h1 id="uptobox">Uptobox</h1>
<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>
<p>Paths are specified as <code>remote:path</code></p>
<p>Paths may be as deep as required,
e.g. <code>remote:directory/subdirectory</code>.</p>
<h2 id="configuration-43">Configuration</h2>
<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>
<p>Here is an example of how to make a remote called <code>remote</code>
with the default setup. First run:</p>
<pre><code>rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<pre><code>Current remotes:

Name                 Type
====                 ====
TestUptobox          uptobox

e) Edit existing remote
n) New remote
d) Delete remote
r) Rename remote
c) Copy remote
s) Set configuration password
q) Quit config
e/n/d/r/c/s/q&gt; n
name&gt; uptobox
Type of storage to configure.
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
[...]
37 / Uptobox
   \ &quot;uptobox&quot;
[...]
Storage&gt; uptobox
** See help for uptobox backend at: https://rclone.org/uptobox/ **

Your API Key, get it from https://uptobox.com/my_account
Enter a string value. Press Enter for the default (&quot;&quot;).
api_key&gt; xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Edit advanced config? (y/n)
y) Yes
n) No (default)
y/n&gt; n
Remote config
--------------------
[uptobox]
type = uptobox
api_key = xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
--------------------
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d&gt; </code></pre>
<p>Once configured you can then use <code>rclone</code> like this,</p>
<p>List directories in top level of your Uptobox</p>
<pre><code>rclone lsd remote:</code></pre>
<p>List all the files in your Uptobox</p>
<pre><code>rclone ls remote:</code></pre>
<p>To copy a local directory to an Uptobox directory called backup</p>
<pre><code>rclone copy /home/source remote:backup</code></pre>
<h3 id="modified-time-and-hashes-13">Modified time and hashes</h3>
<p>Uptobox supports neither modified times nor checksums.</p>
<h3 id="restricted-filename-characters-28">Restricted filename
characters</h3>
<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>
<table>
<thead>
<tr class="header">
<th>Character</th>
<th style="text-align: center;">Value</th>
<th style="text-align: center;">Replacement</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>”</td>
<td style="text-align: center;">0x22</td>
<td style="text-align: center;">＂</td>
</tr>
<tr class="even">
<td>`</td>
<td style="text-align: center;">0x41</td>
<td style="text-align: center;">｀</td>
</tr>
</tbody>
</table>
<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>
<h3 id="standard-options-41">Standard options</h3>
<p>Here are the Standard options specific to uptobox (Uptobox).</p>
<h4 id="uptobox-access-token">–uptobox-access-token</h4>
<p>Your access token.</p>
<p>Get it from https://uptobox.com/my_account.</p>
<p>Properties:</p>
<ul>
<li>Config: access_token</li>
<li>Env Var: RCLONE_UPTOBOX_ACCESS_TOKEN</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h3 id="advanced-options-40">Advanced options</h3>
<p>Here are the Advanced options specific to uptobox (Uptobox).</p>
<h4 id="uptobox-encoding">–uptobox-encoding</h4>
<p>The encoding for the backend.</p>
<p>See the <a href="https://rclone.org/overview/#encoding">encoding
section in the overview</a> for more info.</p>
<p>Properties:</p>
<ul>
<li>Config: encoding</li>
<li>Env Var: RCLONE_UPTOBOX_ENCODING</li>
<li>Type: MultiEncoder</li>
<li>Default:
Slash,LtGt,DoubleQuote,BackQuote,Del,Ctl,LeftSpace,InvalidUtf8,Dot</li>
</ul>
<h2 id="limitations-32">Limitations</h2>
<p>Uptobox will delete inactive files that have not been accessed in 60
days.</p>
<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>
<h1 id="union">Union</h1>
<p>The <code>union</code> remote provides a unification similar to
UnionFS using other remotes.</p>
<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>
<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>
<p>Attribute <code>:ro</code> and <code>:nc</code> can be attach to the
end of path to tag the remote as <strong>read only</strong> or
<strong>no create</strong>,
e.g. <code>remote:directory/subdirectory:ro</code> or
<code>remote:directory/subdirectory:nc</code>.</p>
<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>
<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>.</p>
<h2 id="configuration-44">Configuration</h2>
<p>Here is an example of how to make a union called <code>remote</code>
for local folders. First run:</p>
<pre><code> rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<pre><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; remote
Type of storage to configure.
Choose a number from below, or type in your own value
[snip]
XX / Union merges the contents of several remotes
   \ &quot;union&quot;
[snip]
Storage&gt; union
List of space separated upstreams.
Can be &#39;upstreama:test/dir upstreamb:&#39;, &#39;\&quot;upstreama:test/space:ro dir\&quot; upstreamb:&#39;, etc.
Enter a string value. Press Enter for the default (&quot;&quot;).
upstreams&gt; remote1:dir1 remote2:dir2 remote3:dir3
Policy to choose upstream on ACTION class.
Enter a string value. Press Enter for the default (&quot;epall&quot;).
action_policy&gt;
Policy to choose upstream on CREATE class.
Enter a string value. Press Enter for the default (&quot;epmfs&quot;).
create_policy&gt;
Policy to choose upstream on SEARCH class.
Enter a string value. Press Enter for the default (&quot;ff&quot;).
search_policy&gt;
Cache time of usage and free space (in seconds). This option is only useful when a path preserving policy is used.
Enter a signed integer. Press Enter for the default (&quot;120&quot;).
cache_time&gt;
Remote config
--------------------
[remote]
type = union
upstreams = remote1:dir1 remote2:dir2 remote3:dir3
--------------------
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d&gt; y
Current remotes:

Name                 Type
====                 ====
remote               union

e) Edit existing remote
n) New remote
d) Delete remote
r) Rename remote
c) Copy remote
s) Set configuration password
q) Quit config
e/n/d/r/c/s/q&gt; q</code></pre>
<p>Once configured you can then use <code>rclone</code> like this,</p>
<p>List directories in top level in <code>remote1:dir1</code>,
<code>remote2:dir2</code> and <code>remote3:dir3</code></p>
<pre><code>rclone lsd remote:</code></pre>
<p>List all the files in <code>remote1:dir1</code>,
<code>remote2:dir2</code> and <code>remote3:dir3</code></p>
<pre><code>rclone ls remote:</code></pre>
<p>Copy another local directory to the union directory called source,
which will be placed into <code>remote3:dir3</code></p>
<pre><code>rclone copy C:\source remote:source</code></pre>
<h3 id="behavior-policies">Behavior / Policies</h3>
<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>
<h3 id="function-category-classifications">Function / Category
classifications</h3>
<table>
<colgroup>
<col style="width: 8%" />
<col style="width: 21%" />
<col style="width: 70%" />
</colgroup>
<thead>
<tr class="header">
<th>Category</th>
<th>Description</th>
<th>Functions</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>action</td>
<td>Writing Existing file</td>
<td>move, rmdir, rmdirs, delete, purge and copy, sync (as destination
when file exist)</td>
</tr>
<tr class="even">
<td>create</td>
<td>Create non-existing file</td>
<td>copy, sync (as destination when file not exist)</td>
</tr>
<tr class="odd">
<td>search</td>
<td>Reading and listing file</td>
<td>ls, lsd, lsl, cat, md5sum, sha1sum and copy, sync (as source)</td>
</tr>
<tr class="even">
<td>N/A</td>
<td></td>
<td>size, about</td>
</tr>
</tbody>
</table>
<h3 id="path-preservation">Path Preservation</h3>
<p>Policies, as described below, are of two basic types.
<code>path preserving</code> and <code>non-path preserving</code>.</p>
<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>
<p>A path preserving policy will only consider upstreams where the
relative path being accessed already exists.</p>
<p>When using non-path preserving policies paths will be created in
target upstreams as necessary.</p>
<h3 id="quota-relevant-policies">Quota Relevant Policies</h3>
<p>Some policies rely on quota information. These policies should be
used only if your upstreams support the respective quota fields.</p>
<table>
<thead>
<tr class="header">
<th>Policy</th>
<th>Required Field</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>lfs, eplfs</td>
<td>Free</td>
</tr>
<tr class="even">
<td>mfs, epmfs</td>
<td>Free</td>
</tr>
<tr class="odd">
<td>lus, eplus</td>
<td>Used</td>
</tr>
<tr class="even">
<td>lno, eplno</td>
<td>Objects</td>
</tr>
</tbody>
</table>
<p>To check if your upstream supports the field, run
<code>rclone about remote: [flags]</code> and see if the required field
exists.</p>
<h3 id="filters-1">Filters</h3>
<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>
<ul>
<li>No <strong>search</strong> policies filter.</li>
<li>All <strong>action</strong> policies will filter out remotes which
are tagged as <strong>read-only</strong>.</li>
<li>All <strong>create</strong> policies will filter out remotes which
are tagged <strong>read-only</strong> or
<strong>no-create</strong>.</li>
</ul>
<p>If all remotes are filtered an error will be returned.</p>
<h3 id="policy-descriptions">Policy descriptions</h3>
<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>
<table>
<colgroup>
<col style="width: 23%" />
<col style="width: 76%" />
</colgroup>
<thead>
<tr class="header">
<th>Policy</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>all</td>
<td>Search category: same as <strong>epall</strong>. Action category:
same as <strong>epall</strong>. Create category: act on all
upstreams.</td>
</tr>
<tr class="even">
<td>epall (existing path, all)</td>
<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>
</tr>
<tr class="odd">
<td>epff (existing path, first found)</td>
<td>Act on the first one found, by the time upstreams reply, where the
relative path exists.</td>
</tr>
<tr class="even">
<td>eplfs (existing path, least free space)</td>
<td>Of all the upstreams on which the relative path exists choose the
one with the least free space.</td>
</tr>
<tr class="odd">
<td>eplus (existing path, least used space)</td>
<td>Of all the upstreams on which the relative path exists choose the
one with the least used space.</td>
</tr>
<tr class="even">
<td>eplno (existing path, least number of objects)</td>
<td>Of all the upstreams on which the relative path exists choose the
one with the least number of objects.</td>
</tr>
<tr class="odd">
<td>epmfs (existing path, most free space)</td>
<td>Of all the upstreams on which the relative path exists choose the
one with the most free space.</td>
</tr>
<tr class="even">
<td>eprand (existing path, random)</td>
<td>Calls <strong>epall</strong> and then randomizes. Returns only one
upstream.</td>
</tr>
<tr class="odd">
<td>ff (first found)</td>
<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>
</tr>
<tr class="even">
<td>lfs (least free space)</td>
<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>
</tr>
<tr class="odd">
<td>lus (least used space)</td>
<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>
</tr>
<tr class="even">
<td>lno (least number of objects)</td>
<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>
</tr>
<tr class="odd">
<td>mfs (most free space)</td>
<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>
</tr>
<tr class="even">
<td>newest</td>
<td>Pick the file / directory with the largest mtime.</td>
</tr>
<tr class="odd">
<td>rand (random)</td>
<td>Calls <strong>all</strong> and then randomizes. Returns only one
upstream.</td>
</tr>
</tbody>
</table>
<h3 id="standard-options-42">Standard options</h3>
<p>Here are the Standard options specific to union (Union merges the
contents of several upstream fs).</p>
<h4 id="union-upstreams">–union-upstreams</h4>
<p>List of space separated upstreams.</p>
<p>Can be ‘upstreama:test/dir upstreamb:’, ‘“upstreama:test/space:ro
dir” upstreamb:’, etc.</p>
<p>Properties:</p>
<ul>
<li>Config: upstreams</li>
<li>Env Var: RCLONE_UNION_UPSTREAMS</li>
<li>Type: string</li>
<li>Required: true</li>
</ul>
<h4 id="union-action-policy">–union-action-policy</h4>
<p>Policy to choose upstream on ACTION category.</p>
<p>Properties:</p>
<ul>
<li>Config: action_policy</li>
<li>Env Var: RCLONE_UNION_ACTION_POLICY</li>
<li>Type: string</li>
<li>Default: “epall”</li>
</ul>
<h4 id="union-create-policy">–union-create-policy</h4>
<p>Policy to choose upstream on CREATE category.</p>
<p>Properties:</p>
<ul>
<li>Config: create_policy</li>
<li>Env Var: RCLONE_UNION_CREATE_POLICY</li>
<li>Type: string</li>
<li>Default: “epmfs”</li>
</ul>
<h4 id="union-search-policy">–union-search-policy</h4>
<p>Policy to choose upstream on SEARCH category.</p>
<p>Properties:</p>
<ul>
<li>Config: search_policy</li>
<li>Env Var: RCLONE_UNION_SEARCH_POLICY</li>
<li>Type: string</li>
<li>Default: “ff”</li>
</ul>
<h4 id="union-cache-time">–union-cache-time</h4>
<p>Cache time of usage and free space (in seconds).</p>
<p>This option is only useful when a path preserving policy is used.</p>
<p>Properties:</p>
<ul>
<li>Config: cache_time</li>
<li>Env Var: RCLONE_UNION_CACHE_TIME</li>
<li>Type: int</li>
<li>Default: 120</li>
</ul>
<h3 id="advanced-options-41">Advanced options</h3>
<p>Here are the Advanced options specific to union (Union merges the
contents of several upstream fs).</p>
<h4 id="union-min-free-space">–union-min-free-space</h4>
<p>Minimum viable free space for lfs/eplfs policies.</p>
<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>
<p>Properties:</p>
<ul>
<li>Config: min_free_space</li>
<li>Env Var: RCLONE_UNION_MIN_FREE_SPACE</li>
<li>Type: SizeSuffix</li>
<li>Default: 1Gi</li>
</ul>
<h3 id="metadata-9">Metadata</h3>
<p>Any metadata supported by the underlying remote is read and
written.</p>
<p>See the <a href="https://rclone.org/docs/#metadata">metadata</a> docs
for more info.</p>
<h1 id="webdav">WebDAV</h1>
<p>Paths are specified as <code>remote:path</code></p>
<p>Paths may be as deep as required,
e.g. <code>remote:directory/subdirectory</code>.</p>
<h2 id="configuration-45">Configuration</h2>
<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>
<p>Here is an example of how to make a remote called
<code>remote</code>. First run:</p>
<pre><code> rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<pre><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
name&gt; remote
Type of storage to configure.
Choose a number from below, or type in your own value
[snip]
XX / WebDAV
   \ &quot;webdav&quot;
[snip]
Storage&gt; webdav
URL of http host to connect to
Choose a number from below, or type in your own value
 1 / Connect to example.com
   \ &quot;https://example.com&quot;
url&gt; https://example.com/remote.php/webdav/
Name of the WebDAV site/service/software you are using
Choose a number from below, or type in your own value
 1 / Nextcloud
   \ &quot;nextcloud&quot;
 2 / Owncloud
   \ &quot;owncloud&quot;
 3 / Sharepoint Online, authenticated by Microsoft account.
   \ &quot;sharepoint&quot;
 4 / Sharepoint with NTLM authentication. Usually self-hosted or on-premises.
   \ &quot;sharepoint-ntlm&quot;
 5 / Other site/service or software
   \ &quot;other&quot;
vendor&gt; 1
User name
user&gt; user
Password.
y) Yes type in my own password
g) Generate random password
n) No leave this optional password blank
y/g/n&gt; y
Enter the password:
password:
Confirm the password:
password:
Bearer token instead of user/pass (e.g. a Macaroon)
bearer_token&gt;
Remote config
--------------------
[remote]
type = webdav
url = https://example.com/remote.php/webdav/
vendor = nextcloud
user = user
pass = *** ENCRYPTED ***
bearer_token =
--------------------
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<p>Once configured you can then use <code>rclone</code> like this,</p>
<p>List directories in top level of your WebDAV</p>
<pre><code>rclone lsd remote:</code></pre>
<p>List all the files in your WebDAV</p>
<pre><code>rclone ls remote:</code></pre>
<p>To copy a local directory to an WebDAV directory called backup</p>
<pre><code>rclone copy /home/source remote:backup</code></pre>
<h3 id="modified-time-and-hashes-14">Modified time and hashes</h3>
<p>Plain WebDAV does not support modified times. However when used with
Owncloud or Nextcloud rclone will support modified times.</p>
<p>Likewise plain WebDAV does not support hashes, however when used with
Owncloud or Nextcloud rclone will support SHA1 and MD5 hashes. Depending
on the exact version of Owncloud or Nextcloud hashes may appear on all
objects, or only on objects which had a hash uploaded with them.</p>
<h3 id="standard-options-43">Standard options</h3>
<p>Here are the Standard options specific to webdav (WebDAV).</p>
<h4 id="webdav-url">–webdav-url</h4>
<p>URL of http host to connect to.</p>
<p>E.g. https://example.com.</p>
<p>Properties:</p>
<ul>
<li>Config: url</li>
<li>Env Var: RCLONE_WEBDAV_URL</li>
<li>Type: string</li>
<li>Required: true</li>
</ul>
<h4 id="webdav-vendor">–webdav-vendor</h4>
<p>Name of the WebDAV site/service/software you are using.</p>
<p>Properties:</p>
<ul>
<li>Config: vendor</li>
<li>Env Var: RCLONE_WEBDAV_VENDOR</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“nextcloud”
<ul>
<li>Nextcloud</li>
</ul></li>
<li>“owncloud”
<ul>
<li>Owncloud</li>
</ul></li>
<li>“sharepoint”
<ul>
<li>Sharepoint Online, authenticated by Microsoft account</li>
</ul></li>
<li>“sharepoint-ntlm”
<ul>
<li>Sharepoint with NTLM authentication, usually self-hosted or
on-premises</li>
</ul></li>
<li>“other”
<ul>
<li>Other site/service or software</li>
</ul></li>
</ul></li>
</ul>
<h4 id="webdav-user">–webdav-user</h4>
<p>User name.</p>
<p>In case NTLM authentication is used, the username should be in the
format ‘Domain’.</p>
<p>Properties:</p>
<ul>
<li>Config: user</li>
<li>Env Var: RCLONE_WEBDAV_USER</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="webdav-pass">–webdav-pass</h4>
<p>Password.</p>
<p><strong>NB</strong> Input to this must be obscured - see <a
href="https://rclone.org/commands/rclone_obscure/">rclone
obscure</a>.</p>
<p>Properties:</p>
<ul>
<li>Config: pass</li>
<li>Env Var: RCLONE_WEBDAV_PASS</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="webdav-bearer-token">–webdav-bearer-token</h4>
<p>Bearer token instead of user/pass (e.g. a Macaroon).</p>
<p>Properties:</p>
<ul>
<li>Config: bearer_token</li>
<li>Env Var: RCLONE_WEBDAV_BEARER_TOKEN</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h3 id="advanced-options-42">Advanced options</h3>
<p>Here are the Advanced options specific to webdav (WebDAV).</p>
<h4 id="webdav-bearer-token-command">–webdav-bearer-token-command</h4>
<p>Command to run to get a bearer token.</p>
<p>Properties:</p>
<ul>
<li>Config: bearer_token_command</li>
<li>Env Var: RCLONE_WEBDAV_BEARER_TOKEN_COMMAND</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="webdav-encoding">–webdav-encoding</h4>
<p>The encoding for the backend.</p>
<p>See the <a href="https://rclone.org/overview/#encoding">encoding
section in the overview</a> for more info.</p>
<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>
<p>Properties:</p>
<ul>
<li>Config: encoding</li>
<li>Env Var: RCLONE_WEBDAV_ENCODING</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="webdav-headers">–webdav-headers</h4>
<p>Set HTTP headers for all transactions.</p>
<p>Use this to set additional HTTP headers for all transactions</p>
<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>
<p>For example, to set a Cookie use ‘Cookie,name=value’, or
‘“Cookie”,“name=value”’.</p>
<p>You can set multiple headers,
e.g. ‘“Cookie”,“name=value”,“Authorization”,“xxx”’.</p>
<p>Properties:</p>
<ul>
<li>Config: headers</li>
<li>Env Var: RCLONE_WEBDAV_HEADERS</li>
<li>Type: CommaSepList</li>
<li>Default:</li>
</ul>
<h2 id="provider-notes">Provider notes</h2>
<p>See below for notes on specific providers.</p>
<h3 id="owncloud">Owncloud</h3>
<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>
<p>Owncloud supports modified times using the <code>X-OC-Mtime</code>
header.</p>
<h3 id="nextcloud">Nextcloud</h3>
<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>
<h3 id="sharepoint-online">Sharepoint Online</h3>
<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>
<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>
<p>To use a sharepoint remote with rclone, add it like this: First, you
need to get your remote’s URL:</p>
<ul>
<li>Go <a href="https://onedrive.live.com/about/en-us/signin/">here</a>
to open your OneDrive or to sign in</li>
<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>
</ul>
<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>
<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>
<p>Your config file should look like this:</p>
<pre><code>[sharepoint]
type = webdav
url = https://[YOUR-DOMAIN]-my.sharepoint.com/personal/[YOUR-EMAIL]/Documents
vendor = sharepoint
user = YourEmailAddress
pass = encryptedpassword</code></pre>
<h3 id="sharepoint-with-ntlm-authentication">Sharepoint with NTLM
Authentication</h3>
<p>Use this option in case your (hosted) Sharepoint is not tied to
OneDrive accounts and uses NTLM authentication.</p>
<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>
<p>Example: If the URL is:
https://example.sharepoint.com/sites/12345/Documents/Forms/AllItems.aspx</p>
<p>The configuration to use would be:
https://example.sharepoint.com/sites/12345/Documents</p>
<p>Set the <code>vendor</code> to <code>sharepoint-ntlm</code>.</p>
<p>NTLM uses domain and user name combination for authentication, set
<code>user</code> to <code>DOMAIN\username</code>.</p>
<p>Your config file should look like this:</p>
<pre><code>[sharepoint]
type = webdav
url = https://[YOUR-DOMAIN]/some-path-to/Documents
vendor = sharepoint-ntlm
user = DOMAIN\user
pass = encryptedpassword</code></pre>
<h4 id="required-flags-for-sharepoint">Required Flags for
SharePoint</h4>
<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>
<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>
<pre><code>--ignore-size --ignore-checksum --update</code></pre>
<h3 id="dcache">dCache</h3>
<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>
<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>
<p>The config will end up looking something like this.</p>
<pre><code>[dcache]
type = webdav
url = https://dcache...
vendor = other
user =
pass =
bearer_token = your-macaroon</code></pre>
<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>
<p>Macaroons may also be obtained from the dCacheView
web-browser/JavaScript client that comes with dCache.</p>
<h3 id="openid-connect">OpenID-Connect</h3>
<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>
<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>
<pre><code>paul@celebrimbor:~$ oidc-token XDC
eyJraWQ[...]QFXDt0
paul@celebrimbor:~$</code></pre>
<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>
<p>The rclone <code>bearer_token_command</code> configuration option is
used to fetch the access token from oidc-agent.</p>
<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>
<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>
<pre><code>[dcache]
type = webdav
url = https://dcache.example.org/
vendor = other
bearer_token_command = oidc-token XDC</code></pre>
<h1 id="yandex-disk">Yandex Disk</h1>
<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>
<h2 id="configuration-46">Configuration</h2>
<p>Here is an example of making a yandex configuration. First run</p>
<pre><code>rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<pre><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
n/s&gt; n
name&gt; remote
Type of storage to configure.
Choose a number from below, or type in your own value
[snip]
XX / Yandex Disk
   \ &quot;yandex&quot;
[snip]
Storage&gt; yandex
Yandex Client Id - leave blank normally.
client_id&gt;
Yandex Client Secret - leave blank normally.
client_secret&gt;
Remote config
Use auto config?
 * Say Y if not sure
 * Say N if you are working on a remote or headless machine
y) Yes
n) No
y/n&gt; y
If your browser doesn&#39;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 = {&quot;access_token&quot;:&quot;xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&quot;,&quot;token_type&quot;:&quot;OAuth&quot;,&quot;expiry&quot;:&quot;2016-12-29T12:27:11.362788025Z&quot;}
--------------------
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<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>
<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>
<p>Once configured you can then use <code>rclone</code> like this,</p>
<p>See top level directories</p>
<pre><code>rclone lsd remote:</code></pre>
<p>Make a new directory</p>
<pre><code>rclone mkdir remote:directory</code></pre>
<p>List the contents of a directory</p>
<pre><code>rclone ls remote:directory</code></pre>
<p>Sync <code>/home/local/directory</code> to the remote path, deleting
any excess files in the path.</p>
<pre><code>rclone sync -i /home/local/directory remote:directory</code></pre>
<p>Yandex paths may be as deep as required,
e.g. <code>remote:directory/subdirectory</code>.</p>
<h3 id="modified-time-13">Modified time</h3>
<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>
<h3 id="md5-checksums">MD5 checksums</h3>
<p>MD5 checksums are natively supported by Yandex Disk.</p>
<h3 id="emptying-trash-2">Emptying Trash</h3>
<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>
<h3 id="quota-information-3">Quota information</h3>
<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>
<h3 id="restricted-filename-characters-29">Restricted filename
characters</h3>
<p>The <a
href="https://rclone.org/overview/#restricted-characters">default
restricted characters set</a> are replaced.</p>
<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>
<h3 id="standard-options-44">Standard options</h3>
<p>Here are the Standard options specific to yandex (Yandex Disk).</p>
<h4 id="yandex-client-id">–yandex-client-id</h4>
<p>OAuth Client Id.</p>
<p>Leave blank normally.</p>
<p>Properties:</p>
<ul>
<li>Config: client_id</li>
<li>Env Var: RCLONE_YANDEX_CLIENT_ID</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="yandex-client-secret">–yandex-client-secret</h4>
<p>OAuth Client Secret.</p>
<p>Leave blank normally.</p>
<p>Properties:</p>
<ul>
<li>Config: client_secret</li>
<li>Env Var: RCLONE_YANDEX_CLIENT_SECRET</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h3 id="advanced-options-43">Advanced options</h3>
<p>Here are the Advanced options specific to yandex (Yandex Disk).</p>
<h4 id="yandex-token">–yandex-token</h4>
<p>OAuth Access Token as a JSON blob.</p>
<p>Properties:</p>
<ul>
<li>Config: token</li>
<li>Env Var: RCLONE_YANDEX_TOKEN</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="yandex-auth-url">–yandex-auth-url</h4>
<p>Auth server URL.</p>
<p>Leave blank to use the provider defaults.</p>
<p>Properties:</p>
<ul>
<li>Config: auth_url</li>
<li>Env Var: RCLONE_YANDEX_AUTH_URL</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="yandex-token-url">–yandex-token-url</h4>
<p>Token server url.</p>
<p>Leave blank to use the provider defaults.</p>
<p>Properties:</p>
<ul>
<li>Config: token_url</li>
<li>Env Var: RCLONE_YANDEX_TOKEN_URL</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="yandex-hard-delete">–yandex-hard-delete</h4>
<p>Delete files permanently rather than putting them into the trash.</p>
<p>Properties:</p>
<ul>
<li>Config: hard_delete</li>
<li>Env Var: RCLONE_YANDEX_HARD_DELETE</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="yandex-encoding">–yandex-encoding</h4>
<p>The encoding for the backend.</p>
<p>See the <a href="https://rclone.org/overview/#encoding">encoding
section in the overview</a> for more info.</p>
<p>Properties:</p>
<ul>
<li>Config: encoding</li>
<li>Env Var: RCLONE_YANDEX_ENCODING</li>
<li>Type: MultiEncoder</li>
<li>Default: Slash,Del,Ctl,InvalidUtf8,Dot</li>
</ul>
<h2 id="limitations-33">Limitations</h2>
<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>
<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>
<pre><code>[403 - DiskUnsupportedUserAccountTypeError] User account type is not supported.</code></pre>
<h1 id="zoho-workdrive">Zoho Workdrive</h1>
<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>
<h2 id="configuration-47">Configuration</h2>
<p>Here is an example of making a zoho configuration. First run</p>
<pre><code>rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<pre><code>No remotes found, make a new one?
n) New remote
s) Set configuration password
n/s&gt; n
name&gt; remote
Type of storage to configure.
Enter a string value. Press Enter for the default (&quot;&quot;).
Choose a number from below, or type in your own value
[snip]
XX / Zoho
   \ &quot;zoho&quot;
[snip]
Storage&gt; zoho
** See help for zoho backend at: https://rclone.org/zoho/ **

OAuth Client Id
Leave blank normally.
Enter a string value. Press Enter for the default (&quot;&quot;).
client_id&gt; 
OAuth Client Secret
Leave blank normally.
Enter a string value. Press Enter for the default (&quot;&quot;).
client_secret&gt; 
Edit advanced config? (y/n)
y) Yes
n) No (default)
y/n&gt; n
Remote config
Use auto config?
 * Say Y if not sure
 * Say N if you are working on a remote or headless machine
y) Yes (default)
n) No
y/n&gt; 
If your browser doesn&#39;t open automatically go to the following link: http://127.0.0.1:53682/auth?state=LVn0IHzxej1ZkmQw31d0wQ
Log in and authorize rclone for access
Waiting for code...
Got code
Choose a number from below, or type in your own value
 1 / MyTeam
   \ &quot;4u28602177065ff22426787a6745dba8954eb&quot;
Enter a Team ID&gt; 1
Choose a number from below, or type in your own value
 1 / General
   \ &quot;4u2869d2aa6fca04f4f2f896b6539243b85b1&quot;
Enter a Workspace ID&gt; 1
--------------------
[remote]
type = zoho
token = {&quot;access_token&quot;:&quot;xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&quot;,&quot;token_type&quot;:&quot;Zoho-oauthtoken&quot;,&quot;refresh_token&quot;:&quot;xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&quot;,&quot;expiry&quot;:&quot;2020-10-12T00:54:52.370275223+02:00&quot;}
root_folder_id = xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
--------------------
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d&gt; </code></pre>
<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>
<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>
<p>Once configured you can then use <code>rclone</code> like this,</p>
<p>See top level directories</p>
<pre><code>rclone lsd remote:</code></pre>
<p>Make a new directory</p>
<pre><code>rclone mkdir remote:directory</code></pre>
<p>List the contents of a directory</p>
<pre><code>rclone ls remote:directory</code></pre>
<p>Sync <code>/home/local/directory</code> to the remote path, deleting
any excess files in the path.</p>
<pre><code>rclone sync -i /home/local/directory remote:directory</code></pre>
<p>Zoho paths may be as deep as required, eg
<code>remote:directory/subdirectory</code>.</p>
<h3 id="modified-time-14">Modified time</h3>
<p>Modified times are currently not supported for Zoho Workdrive</p>
<h3 id="checksums">Checksums</h3>
<p>No checksums are supported.</p>
<h3 id="usage-information-1">Usage information</h3>
<p>To view your current quota you can use the
<code>rclone about remote:</code> command which will display your
current usage.</p>
<h3 id="restricted-filename-characters-30">Restricted filename
characters</h3>
<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>
<h3 id="standard-options-45">Standard options</h3>
<p>Here are the Standard options specific to zoho (Zoho).</p>
<h4 id="zoho-client-id">–zoho-client-id</h4>
<p>OAuth Client Id.</p>
<p>Leave blank normally.</p>
<p>Properties:</p>
<ul>
<li>Config: client_id</li>
<li>Env Var: RCLONE_ZOHO_CLIENT_ID</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="zoho-client-secret">–zoho-client-secret</h4>
<p>OAuth Client Secret.</p>
<p>Leave blank normally.</p>
<p>Properties:</p>
<ul>
<li>Config: client_secret</li>
<li>Env Var: RCLONE_ZOHO_CLIENT_SECRET</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="zoho-region">–zoho-region</h4>
<p>Zoho region to connect to.</p>
<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>
<p>Properties:</p>
<ul>
<li>Config: region</li>
<li>Env Var: RCLONE_ZOHO_REGION</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
<ul>
<li>“com”
<ul>
<li>United states / Global</li>
</ul></li>
<li>“eu”
<ul>
<li>Europe</li>
</ul></li>
<li>“in”
<ul>
<li>India</li>
</ul></li>
<li>“jp”
<ul>
<li>Japan</li>
</ul></li>
<li>“com.cn”
<ul>
<li>China</li>
</ul></li>
<li>“com.au”
<ul>
<li>Australia</li>
</ul></li>
</ul></li>
</ul>
<h3 id="advanced-options-44">Advanced options</h3>
<p>Here are the Advanced options specific to zoho (Zoho).</p>
<h4 id="zoho-token">–zoho-token</h4>
<p>OAuth Access Token as a JSON blob.</p>
<p>Properties:</p>
<ul>
<li>Config: token</li>
<li>Env Var: RCLONE_ZOHO_TOKEN</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="zoho-auth-url">–zoho-auth-url</h4>
<p>Auth server URL.</p>
<p>Leave blank to use the provider defaults.</p>
<p>Properties:</p>
<ul>
<li>Config: auth_url</li>
<li>Env Var: RCLONE_ZOHO_AUTH_URL</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="zoho-token-url">–zoho-token-url</h4>
<p>Token server url.</p>
<p>Leave blank to use the provider defaults.</p>
<p>Properties:</p>
<ul>
<li>Config: token_url</li>
<li>Env Var: RCLONE_ZOHO_TOKEN_URL</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
<h4 id="zoho-encoding">–zoho-encoding</h4>
<p>The encoding for the backend.</p>
<p>See the <a href="https://rclone.org/overview/#encoding">encoding
section in the overview</a> for more info.</p>
<p>Properties:</p>
<ul>
<li>Config: encoding</li>
<li>Env Var: RCLONE_ZOHO_ENCODING</li>
<li>Type: MultiEncoder</li>
<li>Default: Del,Ctl,InvalidUtf8</li>
</ul>
<h2 id="setting-up-your-own-client_id">Setting up your own
client_id</h2>
<p>For Zoho we advise you to set up your own client_id. To do so you
have to complete the following steps.</p>
<ol type="1">
<li><p>Log in to the <a href="https://api-console.zoho.com">Zoho API
Console</a></p></li>
<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>
<li><p>Once the client is created, you can go to the settings tab and
enable it in other regions.</p></li>
</ol>
<p>The client id and client secret can now be used with rclone.</p>
<h1 id="local-filesystem">Local Filesystem</h1>
<p>Local paths are specified as normal filesystem paths,
e.g. <code>/path/to/wherever</code>, so</p>
<pre><code>rclone sync -i /home/source /tmp/destination</code></pre>
<p>Will sync <code>/home/source</code> to
<code>/tmp/destination</code>.</p>
<h2 id="configuration-48">Configuration</h2>
<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>
<h3 id="modified-time-15">Modified time</h3>
<p>Rclone reads and writes the modified time using an accuracy
determined by the OS. Typically this is 1ns on Linux, 10 ns on Windows
and 1 Second on OS X.</p>
<h3 id="filenames">Filenames</h3>
<p>Filenames should be encoded in UTF-8 on disk. This is the normal case
for Windows and OS X.</p>
<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>
<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>
<pre><code>Local file system at .: Replacing invalid UTF-8 characters in &quot;gro\xdf&quot;</code></pre>
<h4 id="restricted-characters-1">Restricted characters</h4>
<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>
<p>On non Windows platforms the following characters are replaced when
handling file names.</p>
<table>
<thead>
<tr class="header">
<th>Character</th>
<th style="text-align: center;">Value</th>
<th style="text-align: center;">Replacement</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>NUL</td>
<td style="text-align: center;">0x00</td>
<td style="text-align: center;">␀</td>
</tr>
<tr class="even">
<td>/</td>
<td style="text-align: center;">0x2F</td>
<td style="text-align: center;">／</td>
</tr>
</tbody>
</table>
<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>
<table>
<thead>
<tr class="header">
<th>Character</th>
<th style="text-align: center;">Value</th>
<th style="text-align: center;">Replacement</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>NUL</td>
<td style="text-align: center;">0x00</td>
<td style="text-align: center;">␀</td>
</tr>
<tr class="even">
<td>SOH</td>
<td style="text-align: center;">0x01</td>
<td style="text-align: center;">␁</td>
</tr>
<tr class="odd">
<td>STX</td>
<td style="text-align: center;">0x02</td>
<td style="text-align: center;">␂</td>
</tr>
<tr class="even">
<td>ETX</td>
<td style="text-align: center;">0x03</td>
<td style="text-align: center;">␃</td>
</tr>
<tr class="odd">
<td>EOT</td>
<td style="text-align: center;">0x04</td>
<td style="text-align: center;">␄</td>
</tr>
<tr class="even">
<td>ENQ</td>
<td style="text-align: center;">0x05</td>
<td style="text-align: center;">␅</td>
</tr>
<tr class="odd">
<td>ACK</td>
<td style="text-align: center;">0x06</td>
<td style="text-align: center;">␆</td>
</tr>
<tr class="even">
<td>BEL</td>
<td style="text-align: center;">0x07</td>
<td style="text-align: center;">␇</td>
</tr>
<tr class="odd">
<td>BS</td>
<td style="text-align: center;">0x08</td>
<td style="text-align: center;">␈</td>
</tr>
<tr class="even">
<td>HT</td>
<td style="text-align: center;">0x09</td>
<td style="text-align: center;">␉</td>
</tr>
<tr class="odd">
<td>LF</td>
<td style="text-align: center;">0x0A</td>
<td style="text-align: center;">␊</td>
</tr>
<tr class="even">
<td>VT</td>
<td style="text-align: center;">0x0B</td>
<td style="text-align: center;">␋</td>
</tr>
<tr class="odd">
<td>FF</td>
<td style="text-align: center;">0x0C</td>
<td style="text-align: center;">␌</td>
</tr>
<tr class="even">
<td>CR</td>
<td style="text-align: center;">0x0D</td>
<td style="text-align: center;">␍</td>
</tr>
<tr class="odd">
<td>SO</td>
<td style="text-align: center;">0x0E</td>
<td style="text-align: center;">␎</td>
</tr>
<tr class="even">
<td>SI</td>
<td style="text-align: center;">0x0F</td>
<td style="text-align: center;">␏</td>
</tr>
<tr class="odd">
<td>DLE</td>
<td style="text-align: center;">0x10</td>
<td style="text-align: center;">␐</td>
</tr>
<tr class="even">
<td>DC1</td>
<td style="text-align: center;">0x11</td>
<td style="text-align: center;">␑</td>
</tr>
<tr class="odd">
<td>DC2</td>
<td style="text-align: center;">0x12</td>
<td style="text-align: center;">␒</td>
</tr>
<tr class="even">
<td>DC3</td>
<td style="text-align: center;">0x13</td>
<td style="text-align: center;">␓</td>
</tr>
<tr class="odd">
<td>DC4</td>
<td style="text-align: center;">0x14</td>
<td style="text-align: center;">␔</td>
</tr>
<tr class="even">
<td>NAK</td>
<td style="text-align: center;">0x15</td>
<td style="text-align: center;">␕</td>
</tr>
<tr class="odd">
<td>SYN</td>
<td style="text-align: center;">0x16</td>
<td style="text-align: center;">␖</td>
</tr>
<tr class="even">
<td>ETB</td>
<td style="text-align: center;">0x17</td>
<td style="text-align: center;">␗</td>
</tr>
<tr class="odd">
<td>CAN</td>
<td style="text-align: center;">0x18</td>
<td style="text-align: center;">␘</td>
</tr>
<tr class="even">
<td>EM</td>
<td style="text-align: center;">0x19</td>
<td style="text-align: center;">␙</td>
</tr>
<tr class="odd">
<td>SUB</td>
<td style="text-align: center;">0x1A</td>
<td style="text-align: center;">␚</td>
</tr>
<tr class="even">
<td>ESC</td>
<td style="text-align: center;">0x1B</td>
<td style="text-align: center;">␛</td>
</tr>
<tr class="odd">
<td>FS</td>
<td style="text-align: center;">0x1C</td>
<td style="text-align: center;">␜</td>
</tr>
<tr class="even">
<td>GS</td>
<td style="text-align: center;">0x1D</td>
<td style="text-align: center;">␝</td>
</tr>
<tr class="odd">
<td>RS</td>
<td style="text-align: center;">0x1E</td>
<td style="text-align: center;">␞</td>
</tr>
<tr class="even">
<td>US</td>
<td style="text-align: center;">0x1F</td>
<td style="text-align: center;">␟</td>
</tr>
<tr class="odd">
<td>/</td>
<td style="text-align: center;">0x2F</td>
<td style="text-align: center;">／</td>
</tr>
<tr class="even">
<td>”</td>
<td style="text-align: center;">0x22</td>
<td style="text-align: center;">＂</td>
</tr>
<tr class="odd">
<td>*</td>
<td style="text-align: center;">0x2A</td>
<td style="text-align: center;">＊</td>
</tr>
<tr class="even">
<td>:</td>
<td style="text-align: center;">0x3A</td>
<td style="text-align: center;">：</td>
</tr>
<tr class="odd">
<td>&lt;</td>
<td style="text-align: center;">0x3C</td>
<td style="text-align: center;">＜</td>
</tr>
<tr class="even">
<td>&gt;</td>
<td style="text-align: center;">0x3E</td>
<td style="text-align: center;">＞</td>
</tr>
<tr class="odd">
<td>?</td>
<td style="text-align: center;">0x3F</td>
<td style="text-align: center;">？</td>
</tr>
<tr class="even">
<td>\</td>
<td style="text-align: center;">0x5C</td>
<td style="text-align: center;">＼</td>
</tr>
<tr class="odd">
<td>|</td>
<td style="text-align: center;">0x7C</td>
<td style="text-align: center;">｜</td>
</tr>
</tbody>
</table>
<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>
<table>
<thead>
<tr class="header">
<th>Character</th>
<th style="text-align: center;">Value</th>
<th style="text-align: center;">Replacement</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>SP</td>
<td style="text-align: center;">0x20</td>
<td style="text-align: center;">␠</td>
</tr>
<tr class="even">
<td>.</td>
<td style="text-align: center;">0x2E</td>
<td style="text-align: center;">．</td>
</tr>
</tbody>
</table>
<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>
<h3 id="paths-on-windows">Paths on Windows</h3>
<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>
<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>
<h4 id="long-paths">Long paths</h4>
<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>
<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>
<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>
<pre><code>[local]
nounc = true</code></pre>
<p>If you want to selectively disable UNC, you can add it to a separate
entry like this:</p>
<pre><code>[nounc]
type = local
nounc = true</code></pre>
<p>And use rclone like this:</p>
<p><code>rclone copy c:\src nounc:z:\dst</code></p>
<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>
<h3 id="symlinks-junction-points">Symlinks / Junction points</h3>
<p>Normally rclone will ignore symlinks or junction points (which behave
like symlinks under Windows).</p>
<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>
<p>This flag applies to all commands.</p>
<p>For example, supposing you have a directory structure like this</p>
<pre><code>$ tree /tmp/a
/tmp/a
├── b -&gt; ../b
├── expected -&gt; ../expected
├── one
└── two
    └── three</code></pre>
<p>Then you can see the difference with and without the flag like
this</p>
<pre><code>$ rclone ls /tmp/a
        6 one
        6 two/three</code></pre>
<p>and</p>
<pre><code>$ rclone -L ls /tmp/a
     4174 expected
        6 one
        6 two/three
        6 b/two
        6 b/one</code></pre>
<h4 id="links--l">–links, -l</h4>
<p>Normally rclone will ignore symlinks or junction points (which behave
like symlinks under Windows).</p>
<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>
<p>The text file will contain the target of the symbolic link (see
example).</p>
<p>This flag applies to all commands.</p>
<p>For example, supposing you have a directory structure like this</p>
<pre><code>$ tree /tmp/a
/tmp/a
├── file1 -&gt; ./file4
└── file2 -&gt; /home/user/file3</code></pre>
<p>Copying the entire directory with ‘-l’</p>
<pre><code>$ rclone copyto -l /tmp/a/file1 remote:/tmp/a/</code></pre>
<p>The remote files are created with a ‘.rclonelink’ suffix</p>
<pre><code>$ rclone ls remote:/tmp/a
       5 file1.rclonelink
      14 file2.rclonelink</code></pre>
<p>The remote files will contain the target of the symbolic links</p>
<pre><code>$ rclone cat remote:/tmp/a/file1.rclonelink
./file4

$ rclone cat remote:/tmp/a/file2.rclonelink
/home/user/file3</code></pre>
<p>Copying them back with ‘-l’</p>
<pre><code>$ rclone copyto -l remote:/tmp/a/ /tmp/b/

$ tree /tmp/b
/tmp/b
├── file1 -&gt; ./file4
└── file2 -&gt; /home/user/file3</code></pre>
<p>However, if copied back without ‘-l’</p>
<pre><code>$ rclone copyto remote:/tmp/a/ /tmp/b/

$ tree /tmp/b
/tmp/b
├── file1.rclonelink
└── file2.rclonelink</code></pre>
<p>Note that this flag is incompatible with <code>-copy-links</code> /
<code>-L</code>.</p>
<h3 id="restricting-filesystems-with-one-file-system">Restricting
filesystems with –one-file-system</h3>
<p>Normally rclone will recurse through filesystems as mounted.</p>
<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>
<p>For example if you have a directory hierarchy like this</p>
<pre><code>root
├── disk1     - disk1 mounted on the root
│   └── file3 - stored on disk1
├── disk2     - disk2 mounted on the root
│   └── file4 - stored on disk12
├── file1     - stored on the root disk
└── file2     - stored on the root disk</code></pre>
<p>Using <code>rclone --one-file-system copy root remote:</code> will
only copy <code>file1</code> and <code>file2</code>. Eg</p>
<pre><code>$ rclone -q --one-file-system ls root
        0 file1
        0 file2</code></pre>
<pre><code>$ rclone -q ls root
        0 disk1/file3
        0 disk2/file4
        0 file1
        0 file2</code></pre>
<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>
<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>
<h3 id="advanced-options-45">Advanced options</h3>
<p>Here are the Advanced options specific to local (Local Disk).</p>
<h4 id="local-nounc">–local-nounc</h4>
<p>Disable UNC (long path names) conversion on Windows.</p>
<p>Properties:</p>
<ul>
<li>Config: nounc</li>
<li>Env Var: RCLONE_LOCAL_NOUNC</li>
<li>Type: bool</li>
<li>Default: false</li>
<li>Examples:
<ul>
<li>“true”
<ul>
<li>Disables long file names.</li>
</ul></li>
</ul></li>
</ul>
<h4 id="copy-links--l">–copy-links / -L</h4>
<p>Follow symlinks and copy the pointed to item.</p>
<p>Properties:</p>
<ul>
<li>Config: copy_links</li>
<li>Env Var: RCLONE_LOCAL_COPY_LINKS</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="links--l-1">–links / -l</h4>
<p>Translate symlinks to/from regular files with a ‘.rclonelink’
extension.</p>
<p>Properties:</p>
<ul>
<li>Config: links</li>
<li>Env Var: RCLONE_LOCAL_LINKS</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="skip-links">–skip-links</h4>
<p>Don’t warn about skipped symlinks.</p>
<p>This flag disables warning messages on skipped symlinks or junction
points, as you explicitly acknowledge that they should be skipped.</p>
<p>Properties:</p>
<ul>
<li>Config: skip_links</li>
<li>Env Var: RCLONE_LOCAL_SKIP_LINKS</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="local-zero-size-links">–local-zero-size-links</h4>
<p>Assume the Stat size of links is zero (and read them instead)
(deprecated).</p>
<p>Rclone used to use the Stat size of links as the link size, but this
fails in quite a few places:</p>
<ul>
<li>Windows</li>
<li>On some virtual filesystems (such ash LucidLink)</li>
<li>Android</li>
</ul>
<p>So rclone now always reads the link.</p>
<p>Properties:</p>
<ul>
<li>Config: zero_size_links</li>
<li>Env Var: RCLONE_LOCAL_ZERO_SIZE_LINKS</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="local-unicode-normalization">–local-unicode-normalization</h4>
<p>Apply unicode NFC normalization to paths and filenames.</p>
<p>This flag can be used to normalize file names into unicode NFC form
that are read from the local filesystem.</p>
<p>Rclone does not normally touch the encoding of file names it reads
from the file system.</p>
<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>
<p>Note that rclone compares filenames with unicode normalization in the
sync routine so this flag shouldn’t normally be used.</p>
<p>Properties:</p>
<ul>
<li>Config: unicode_normalization</li>
<li>Env Var: RCLONE_LOCAL_UNICODE_NORMALIZATION</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="local-no-check-updated">–local-no-check-updated</h4>
<p>Don’t check to see if the files change during upload.</p>
<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>
<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>
<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>
<p>If the file is being modified throughout (not just appended to) then
the transfer may fail with a hash check failure.</p>
<p>In detail, once the file has had stat() called on it for the first
time we:</p>
<ul>
<li>Only transfer the size that stat gave</li>
<li>Only checksum the size that stat gave</li>
<li>Don’t update the stat info for the file</li>
</ul>
<p>Properties:</p>
<ul>
<li>Config: no_check_updated</li>
<li>Env Var: RCLONE_LOCAL_NO_CHECK_UPDATED</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="one-file-system--x">–one-file-system / -x</h4>
<p>Don’t cross filesystem boundaries (unix/macOS only).</p>
<p>Properties:</p>
<ul>
<li>Config: one_file_system</li>
<li>Env Var: RCLONE_LOCAL_ONE_FILE_SYSTEM</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="local-case-sensitive">–local-case-sensitive</h4>
<p>Force the filesystem to report itself as case sensitive.</p>
<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>
<p>Properties:</p>
<ul>
<li>Config: case_sensitive</li>
<li>Env Var: RCLONE_LOCAL_CASE_SENSITIVE</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="local-case-insensitive">–local-case-insensitive</h4>
<p>Force the filesystem to report itself as case insensitive.</p>
<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>
<p>Properties:</p>
<ul>
<li>Config: case_insensitive</li>
<li>Env Var: RCLONE_LOCAL_CASE_INSENSITIVE</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="local-no-preallocate">–local-no-preallocate</h4>
<p>Disable preallocation of disk space for transferred files.</p>
<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>
<p>Properties:</p>
<ul>
<li>Config: no_preallocate</li>
<li>Env Var: RCLONE_LOCAL_NO_PREALLOCATE</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="local-no-sparse">–local-no-sparse</h4>
<p>Disable sparse files for multi-thread downloads.</p>
<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>
<p>Properties:</p>
<ul>
<li>Config: no_sparse</li>
<li>Env Var: RCLONE_LOCAL_NO_SPARSE</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="local-no-set-modtime">–local-no-set-modtime</h4>
<p>Disable setting modtime.</p>
<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>
<p>Properties:</p>
<ul>
<li>Config: no_set_modtime</li>
<li>Env Var: RCLONE_LOCAL_NO_SET_MODTIME</li>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
<h4 id="local-encoding">–local-encoding</h4>
<p>The encoding for the backend.</p>
<p>See the <a href="https://rclone.org/overview/#encoding">encoding
section in the overview</a> for more info.</p>
<p>Properties:</p>
<ul>
<li>Config: encoding</li>
<li>Env Var: RCLONE_LOCAL_ENCODING</li>
<li>Type: MultiEncoder</li>
<li>Default: Slash,Dot</li>
</ul>
<h3 id="metadata-10">Metadata</h3>
<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>
<p>User metadata is stored as extended attributes (which may not be
supported by all file systems) under the “user.*” prefix.</p>
<p>Here are the possible system metadata items for the local
backend.</p>
<table>
<colgroup>
<col style="width: 15%" />
<col style="width: 15%" />
<col style="width: 15%" />
<col style="width: 23%" />
<col style="width: 28%" />
</colgroup>
<thead>
<tr class="header">
<th>Name</th>
<th>Help</th>
<th>Type</th>
<th>Example</th>
<th>Read Only</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>atime</td>
<td>Time of last access</td>
<td>RFC 3339</td>
<td>2006-01-02T15:04:05.999999999Z07:00</td>
<td>N</td>
</tr>
<tr class="even">
<td>btime</td>
<td>Time of file birth (creation)</td>
<td>RFC 3339</td>
<td>2006-01-02T15:04:05.999999999Z07:00</td>
<td>N</td>
</tr>
<tr class="odd">
<td>gid</td>
<td>Group ID of owner</td>
<td>decimal number</td>
<td>500</td>
<td>N</td>
</tr>
<tr class="even">
<td>mode</td>
<td>File type and mode</td>
<td>octal, unix style</td>
<td>0100664</td>
<td>N</td>
</tr>
<tr class="odd">
<td>mtime</td>
<td>Time of last modification</td>
<td>RFC 3339</td>
<td>2006-01-02T15:04:05.999999999Z07:00</td>
<td>N</td>
</tr>
<tr class="even">
<td>rdev</td>
<td>Device ID (if special file)</td>
<td>hexadecimal</td>
<td>1abc</td>
<td>N</td>
</tr>
<tr class="odd">
<td>uid</td>
<td>User ID of owner</td>
<td>decimal number</td>
<td>500</td>
<td>N</td>
</tr>
</tbody>
</table>
<p>See the <a href="https://rclone.org/docs/#metadata">metadata</a> docs
for more info.</p>
<h2 id="backend-commands-7">Backend commands</h2>
<p>Here are the commands specific to the local backend.</p>
<p>Run them with</p>
<pre><code>rclone backend COMMAND remote:</code></pre>
<p>The help below will explain what arguments each command takes.</p>
<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>
<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>
<h3 id="noop">noop</h3>
<p>A null operation for testing backend commands</p>
<pre><code>rclone backend noop remote: [options] [&lt;arguments&gt;+]</code></pre>
<p>This is a test command which has some options you can try to change
the output.</p>
<p>Options:</p>
<ul>
<li>“echo”: echo the input arguments</li>
<li>“error”: return an error based on option value</li>
</ul>
<h1 id="changelog">Changelog</h1>
<h2 id="v1.60.1---2022-11-17">v1.60.1 - 2022-11-17</h2>
<p><a
href="https://github.com/rclone/rclone/compare/v1.60.0...v1.60.1">See
commits</a></p>
<ul>
<li>Bug Fixes
<ul>
<li>lib/cache: Fix alias backend shutting down too soon (Nick
Craig-Wood)</li>
<li>wasm: Fix walltime link error by adding up-to-date wasm_exec.js
(João Henrique Franco)</li>
<li>docs
<ul>
<li>Update faq.md with bisync (Samuel Johnson)</li>
<li>Corrected download links in windows install docs (coultonluke)</li>
<li>Add direct download link for windows arm64 (albertony)</li>
<li>Remove link to rclone slack as it is no longer supported (Nick
Craig-Wood)</li>
<li>Faq: how to use a proxy server that requires a username and password
(asdffdsazqqq)</li>
<li>Oracle-object-storage: doc fix (Manoj Ghosh)</li>
<li>Fix typo <code>remove</code> in rclone_serve_restic command (Joda
Stößer)</li>
<li>Fix character that was incorrectly interpreted as markdown (Clément
Notin)</li>
</ul></li>
</ul></li>
<li>VFS
<ul>
<li>Fix deadlock caused by cache cleaner and upload finishing (Nick
Craig-Wood)</li>
</ul></li>
<li>Local
<ul>
<li>Clean absolute paths (albertony)</li>
<li>Fix -L/–copy-links with filters missing directories (Nick
Craig-Wood)</li>
</ul></li>
<li>Mailru
<ul>
<li>Note that an app password is now needed (Nick Craig-Wood)</li>
<li>Allow timestamps to be before the epoch 1970-01-01 (Nick
Craig-Wood)</li>
</ul></li>
<li>S3
<ul>
<li>Add provider quirk <code>--s3-might-gzip</code> to fix corrupted on
transfer: sizes differ (Nick Craig-Wood)</li>
<li>Allow Storj to server side copy since it seems to work now (Nick
Craig-Wood)</li>
<li>Fix for unchecked err value in s3 listv2 (Aaron Gokaslan)</li>
<li>Add additional Wasabi locations (techknowlogick)</li>
</ul></li>
<li>Smb
<ul>
<li>Fix <code>Failed to sync: context canceled</code> at the end of
syncs (Nick Craig-Wood)</li>
</ul></li>
<li>WebDAV
<ul>
<li>Fix Move/Copy/DirMove when using -server-side-across-configs (Nick
Craig-Wood)</li>
</ul></li>
</ul>
<h2 id="v1.60.0---2022-10-21">v1.60.0 - 2022-10-21</h2>
<p><a
href="https://github.com/rclone/rclone/compare/v1.59.0...v1.60.0">See
commits</a></p>
<ul>
<li>New backends
<ul>
<li><a href="https://rclone.org/oracleobjectstorage/">Oracle object
storage</a> (Manoj Ghosh)</li>
<li><a href="https://rclone.org/smb/">SMB</a> / CIFS (Windows file
sharing) (Lesmiscore)</li>
<li>New S3 providers
<ul>
<li><a href="https://rclone.org/s3/#ionos">IONOS Cloud Storage</a>
(Dmitry Deniskin)</li>
<li><a href="https://rclone.org/s3/#qiniu">Qiniu KODO</a> (Bachue
Zhou)</li>
</ul></li>
</ul></li>
<li>New Features
<ul>
<li>build
<ul>
<li>Update to go1.19 and make go1.17 the minimum required version (Nick
Craig-Wood)</li>
<li>Install.sh: fix arm-v7 download (Ole Frost)</li>
</ul></li>
<li>fs: Warn the user when using an existing remote name without a colon
(Nick Craig-Wood)</li>
<li>httplib: Add <code>--xxx-min-tls-version</code> option to select
minimum TLS version for HTTP servers (Robert Newson)</li>
<li>librclone: Add PHP bindings and test program (Jordi Gonzalez
Muñoz)</li>
<li>operations
<ul>
<li>Add <code>--server-side-across-configs</code> global flag for any
backend (Nick Craig-Wood)</li>
<li>Optimise <code>--copy-dest</code> and <code>--compare-dest</code>
(Nick Craig-Wood)</li>
</ul></li>
<li>rc: add <code>job/stopgroup</code> to stop group (Evan
Spensley)</li>
<li>serve dlna
<ul>
<li>Add <code>--announce-interval</code> to control SSDP Announce
Interval (YanceyChiew)</li>
<li>Add <code>--interface</code> to Specify SSDP interface names line
(Simon Bos)</li>
<li>Add support for more external subtitles (YanceyChiew)</li>
<li>Add verification of addresses (YanceyChiew)</li>
</ul></li>
<li>sync: Optimise <code>--copy-dest</code> and
<code>--compare-dest</code> (Nick Craig-Wood)</li>
<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>
</ul></li>
<li>Bug Fixes
<ul>
<li>filter
<ul>
<li>Fix incorrect filtering with <code>UseFilter</code> context flag and
wrapping backends (Nick Craig-Wood)</li>
<li>Make sure we check <code>--files-from</code> when looking for a
single file (Nick Craig-Wood)</li>
</ul></li>
<li>rc
<ul>
<li>Fix <code>mount/listmounts</code> not returning the full Fs entered
in <code>mount/mount</code> (Tom Mombourquette)</li>
<li>Handle external unmount when mounting (Isaac Aymerich)</li>
<li>Validate Daemon option is not set when mounting a volume via RC
(Isaac Aymerich)</li>
</ul></li>
<li>sync: Update docs and error messages to reflect fixes to overlap
checks (Nick Naumann)</li>
</ul></li>
<li>VFS
<ul>
<li>Reduce memory use by embedding <code>sync.Cond</code> (Nick
Craig-Wood)</li>
<li>Reduce memory usage by re-ordering commonly used structures (Nick
Craig-Wood)</li>
<li>Fix excess CPU used by VFS cache cleaner looping (Nick
Craig-Wood)</li>
</ul></li>
<li>Local
<ul>
<li>Obey file filters in listing to fix errors on excluded files (Nick
Craig-Wood)</li>
<li>Fix “Failed to read metadata: function not implemented” on old Linux
kernels (Nick Craig-Wood)</li>
</ul></li>
<li>Compress
<ul>
<li>Fix crash due to nil metadata (Nick Craig-Wood)</li>
<li>Fix error handling to not use or return nil objects (Nick
Craig-Wood)</li>
</ul></li>
<li>Drive
<ul>
<li>Make <code>--drive-stop-on-upload-limit</code> obey quota exceeded
error (Steve Kowalik)</li>
</ul></li>
<li>FTP
<ul>
<li>Add <code>--ftp-force-list-hidden</code> option to show hidden items
(Øyvind Heddeland Instefjord)</li>
<li>Fix hang when using ExplicitTLS to certain servers. (Nick
Craig-Wood)</li>
</ul></li>
<li>Google Cloud Storage
<ul>
<li>Add <code>--gcs-endpoint</code> flag and config parameter (Nick
Craig-Wood)</li>
</ul></li>
<li>Hubic
<ul>
<li>Remove backend as service has now shut down (Nick Craig-Wood)</li>
</ul></li>
<li>Onedrive
<ul>
<li>Rename Onedrive(cn) 21Vianet to Vnet Group (Yen Hu)</li>
<li>Disable change notify in China region since it is not supported
(Nick Craig-Wood)</li>
</ul></li>
<li>S3
<ul>
<li>Implement <code>--s3-versions</code> flag to show old versions of
objects if enabled (Nick Craig-Wood)</li>
<li>Implement <code>--s3-version-at</code> flag to show versions of
objects at a particular time (Nick Craig-Wood)</li>
<li>Implement <code>backend versioning</code> command to get/set bucket
versioning (Nick Craig-Wood)</li>
<li>Implement <code>Purge</code> to purge versions and
<code>backend cleanup-hidden</code> (Nick Craig-Wood)</li>
<li>Add <code>--s3-decompress</code> flag to decompress gzip-encoded
files (Nick Craig-Wood)</li>
<li>Add <code>--s3-sse-customer-key-base64</code> to supply keys with
binary data (Richard Bateman)</li>
<li>Try to keep the maximum precision in ModTime with
<code>--user-server-modtime</code> (Nick Craig-Wood)</li>
<li>Drop binary metadata with an ERROR message as it can’t be stored
(Nick Craig-Wood)</li>
<li>Add <code>--s3-no-system-metadata</code> to suppress read and write
of system metadata (Nick Craig-Wood)</li>
</ul></li>
<li>SFTP
<ul>
<li>Fix directory creation races (Lesmiscore)</li>
</ul></li>
<li>Swift
<ul>
<li>Add <code>--swift-no-large-objects</code> to reduce HEAD requests
(Nick Craig-Wood)</li>
</ul></li>
<li>Union
<ul>
<li>Propagate SlowHash feature to fix hasher interaction
(Lesmiscore)</li>
</ul></li>
</ul>
<h2 id="v1.59.2---2022-09-15">v1.59.2 - 2022-09-15</h2>
<p><a
href="https://github.com/rclone/rclone/compare/v1.59.1...v1.59.2">See
commits</a></p>
<ul>
<li>Bug Fixes
<ul>
<li>config: Move locking to fix fatal error: concurrent map read and map
write (Nick Craig-Wood)</li>
</ul></li>
<li>Local
<ul>
<li>Disable xattr support if the filesystems indicates it is not
supported (Nick Craig-Wood)</li>
</ul></li>
<li>Azure Blob
<ul>
<li>Fix chunksize calculations producing too many parts (Nick
Craig-Wood)</li>
</ul></li>
<li>B2
<ul>
<li>Fix chunksize calculations producing too many parts (Nick
Craig-Wood)</li>
</ul></li>
<li>S3
<ul>
<li>Fix chunksize calculations producing too many parts (Nick
Craig-Wood)</li>
</ul></li>
</ul>
<h2 id="v1.59.1---2022-08-08">v1.59.1 - 2022-08-08</h2>
<p><a
href="https://github.com/rclone/rclone/compare/v1.59.0...v1.59.1">See
commits</a></p>
<ul>
<li>Bug Fixes
<ul>
<li>accounting: Fix panic in core/stats-reset with unknown group (Nick
Craig-Wood)</li>
<li>build: Fix android build after GitHub actions change (Nick
Craig-Wood)</li>
<li>dlna: Fix SOAP action header parsing (Joram Schrijver)</li>
<li>docs: Fix links to mount command from install docs (albertony)</li>
<li>dropbox: Fix ChangeNotify was unable to decrypt errors (Nick
Craig-Wood)</li>
<li>fs: Fix parsing of times and durations of the form “YYYY-MM-DD
HH:MM:SS” (Nick Craig-Wood)</li>
<li>serve sftp: Fix checksum detection (Nick Craig-Wood)</li>
<li>sync: Add accidentally missed filter-sensitivity to –backup-dir
option (Nick Naumann)</li>
</ul></li>
<li>Combine
<ul>
<li>Fix docs showing <code>remote=</code> instead of
<code>upstreams=</code> (Nick Craig-Wood)</li>
<li>Throw error if duplicate directory name is specified (Nick
Craig-Wood)</li>
<li>Fix errors with backends shutting down while in use (Nick
Craig-Wood)</li>
</ul></li>
<li>Dropbox
<ul>
<li>Fix hang on quit with –dropbox-batch-mode off (Nick Craig-Wood)</li>
<li>Fix infinite loop on uploading a corrupted file (Nick
Craig-Wood)</li>
</ul></li>
<li>Internetarchive
<ul>
<li>Ignore checksums for files using the different method
(Lesmiscore)</li>
<li>Handle hash symbol in the middle of filename (Lesmiscore)</li>
</ul></li>
<li>Jottacloud
<ul>
<li>Fix working with whitelabel Elgiganten Cloud</li>
<li>Do not store username in config when using standard auth
(albertony)</li>
</ul></li>
<li>Mega
<ul>
<li>Fix nil pointer exception when bad node received (Nick
Craig-Wood)</li>
</ul></li>
<li>S3
<ul>
<li>Fix –s3-no-head panic: reflect: Elem of invalid type
s3.PutObjectInput (Nick Craig-Wood)</li>
</ul></li>
<li>SFTP
<ul>
<li>Fix issue with WS_FTP by working around failing RealPath
(albertony)</li>
</ul></li>
<li>Union
<ul>
<li>Fix duplicated files when using directories with leading / (Nick
Craig-Wood)</li>
<li>Fix multiple files being uploaded when roots don’t exist (Nick
Craig-Wood)</li>
<li>Fix panic due to misalignment of struct field in 32 bit
architectures (r-ricci)</li>
</ul></li>
</ul>
<h2 id="v1.59.0---2022-07-09">v1.59.0 - 2022-07-09</h2>
<p><a
href="https://github.com/rclone/rclone/compare/v1.58.0...v1.59.0">See
commits</a></p>
<ul>
<li>New backends
<ul>
<li><a href="/combine">Combine</a> multiple remotes in one directory
tree (Nick Craig-Wood)</li>
<li><a href="https://rclone.org/hidrive/">Hidrive</a> (Ovidiu Victor
Tatar)</li>
<li><a href="https://rclone.org/internetarchive/">Internet Archive</a>
(Lesmiscore (Naoya Ozaki))</li>
<li>New S3 providers
<ul>
<li><a href="https://rclone.org/s3/#arvan-cloud">ArvanCloud AOS</a>
(ehsantdy)</li>
<li><a href="https://rclone.org/s3/#cloudflare-r2">Cloudflare R2</a>
(Nick Craig-Wood)</li>
<li><a href="https://rclone.org/s3/#huawei-obs">Huawei OBS</a>
(m00594701)</li>
<li><a href="https://rclone.org/s3/#idrive-e2">IDrive e2</a>
(vyloy)</li>
</ul></li>
</ul></li>
<li>New commands
<ul>
<li><a href="https://rclone.org/commands/rclone_test_makefile/">test
makefile</a>: Create a single file for testing (Nick Craig-Wood)</li>
</ul></li>
<li>New Features
<ul>
<li><a href="https://rclone.org/docs/#metadata">Metadata framework</a>
to read and write system and user metadata on backends (Nick Craig-Wood)
<ul>
<li>Implemented initially for <code>local</code>, <code>s3</code> and
<code>internetarchive</code> backends</li>
<li><code>--metadata</code>/<code>-M</code> flag to control whether
metadata is copied</li>
<li><code>--metadata-set</code> flag to specify metadata for
uploads</li>
<li>Thanks to <a href="https://manz-solutions.at/">Manz Solutions</a>
for sponsoring this work.</li>
</ul></li>
<li>build
<ul>
<li>Update to go1.18 and make go1.16 the minimum required version (Nick
Craig-Wood)</li>
<li>Update android go build to 1.18.x and NDK to 23.1.7779620 (Nick
Craig-Wood)</li>
<li>All windows binaries now no longer CGO (Nick Craig-Wood)</li>
<li>Add <code>linux/arm/v6</code> to docker images (Nick
Craig-Wood)</li>
<li>A huge number of fixes found with <a
href="https://staticcheck.io/">staticcheck</a> (albertony)</li>
<li>Configurable version suffix independent of version number
(albertony)</li>
</ul></li>
<li>check: Implement <code>--no-traverse</code> and
<code>--no-unicode-normalization</code> (Nick Craig-Wood)</li>
<li>config: Readability improvements (albertony)</li>
<li>copyurl: Add <code>--header-filename</code> to honor the HTTP header
filename directive (J-P Treen)</li>
<li>filter: Allow multiple <code>--exclude-if-present</code> flags
(albertony)</li>
<li>fshttp: Add <code>--disable-http-keep-alives</code> to disable HTTP
Keep Alives (Nick Craig-Wood)</li>
<li>install.sh
<ul>
<li>Set the modes on the files and/or directories on macOS (Michael C
Tiernan - MIT-Research Computing Project)</li>
<li>Pre verify sudo authorization <code>-v</code> before calling curl.
(Michael C Tiernan - MIT-Research Computing Project)</li>
</ul></li>
<li>lib/encoder: Add Semicolon encoding (Nick Craig-Wood)</li>
<li>lsf: Add metadata support with <code>M</code> flag (Nick
Craig-Wood)</li>
<li>lsjson: Add <code>--metadata</code>/<code>-M</code> flag (Nick
Craig-Wood)</li>
<li>ncdu
<ul>
<li>Implement multi selection (CrossR)</li>
<li>Replace termbox with tcell’s termbox wrapper (eNV25)</li>
<li>Display correct path in delete confirmation dialog (Roberto
Ricci)</li>
</ul></li>
<li>operations
<ul>
<li>Speed up hash checking by aborting the other hash if first returns
nothing (Nick Craig-Wood)</li>
<li>Use correct src/dst in some log messages (zzr93)</li>
</ul></li>
<li>rcat: Check checksums by default like copy does (Nick
Craig-Wood)</li>
<li>selfupdate: Replace deprecated <code>x/crypto/openpgp</code> package
with <code>ProtonMail/go-crypto</code> (albertony)</li>
<li>serve ftp: Check <code>--passive-port</code> arguments are correct
(Nick Craig-Wood)</li>
<li>size: Warn about inaccurate results when objects with unknown size
(albertony)</li>
<li>sync: Overlap check is now filter-sensitive so
<code>--backup-dir</code> can be in the root provided it is filtered
(Nick)</li>
<li>test info: Check file name lengths using 1,2,3,4 byte unicode
characters (Nick Craig-Wood)</li>
<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>
<li>Make sure we call the <code>Shutdown</code> method on backends
(Martin Czygan)</li>
</ul></li>
<li>Bug Fixes
<ul>
<li>accounting: Fix unknown length file transfers counting 3 transfers
each (buda)</li>
<li>ncdu: Fix issue where dir size is summed when file sizes are -1
(albertony)</li>
<li>sync/copy/move
<ul>
<li>Fix <code>--fast-list</code> <code>--create-empty-src-dirs</code>
and <code>--exclude</code> (Nick Craig-Wood)</li>
<li>Fix <code>--max-duration</code> and <code>--cutoff-mode soft</code>
(Nick Craig-Wood)</li>
</ul></li>
<li>Fix fs cache unpin (Martin Czygan)</li>
<li>Set proper exit code for errors that are not low-level retried
(e.g. size/timestamp changing) (albertony)</li>
</ul></li>
<li>Mount
<ul>
<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>
<li>Log IO errors at ERROR level (Nick Craig-Wood)</li>
<li>Ignore <code>_netdev</code> mount argument (Hugal31)</li>
</ul></li>
<li>VFS
<ul>
<li>Add <code>--vfs-fast-fingerprint</code> for less accurate but faster
fingerprints (Nick Craig-Wood)</li>
<li>Add <code>--vfs-disk-space-total-size</code> option to manually set
the total disk space (Claudio Maradonna)</li>
<li>vfscache: Fix fatal error: sync: unlock of unlocked mutex error
(Nick Craig-Wood)</li>
</ul></li>
<li>Local
<ul>
<li>Fix parsing of <code>--local-nounc</code> flag (Nick
Craig-Wood)</li>
<li>Add Metadata support (Nick Craig-Wood)</li>
</ul></li>
<li>Crypt
<ul>
<li>Support metadata (Nick Craig-Wood)</li>
</ul></li>
<li>Azure Blob
<ul>
<li>Calculate Chunksize/blocksize to stay below maxUploadParts (Leroy
van Logchem)</li>
<li>Use chunksize lib to determine chunksize dynamically (Derek
Battams)</li>
<li>Case insensitive access tier (Rob Pickerill)</li>
<li>Allow remote emulator (azurite) (Lorenzo Maiorfi)</li>
</ul></li>
<li>B2
<ul>
<li>Add <code>--b2-version-at</code> flag to show file versions at time
specified (SwazRGB)</li>
<li>Use chunksize lib to determine chunksize dynamically (Derek
Battams)</li>
</ul></li>
<li>Chunker
<ul>
<li>Mark as not supporting metadata (Nick Craig-Wood)</li>
</ul></li>
<li>Compress
<ul>
<li>Support metadata (Nick Craig-Wood)</li>
</ul></li>
<li>Drive
<ul>
<li>Make <code>backend config -o config</code> add a combined
<code>AllDrives:</code> remote (Nick Craig-Wood)</li>
<li>Make <code>--drive-shared-with-me</code> work with shared drives
(Nick Craig-Wood)</li>
<li>Add <code>--drive-resource-key</code> for accessing link-shared
files (Nick Craig-Wood)</li>
<li>Add backend commands <code>exportformats</code> and
<code>importformats</code> for debugging (Nick Craig-Wood)</li>
<li>Fix 404 errors on copy/server side copy objects from public folder
(Nick Craig-Wood)</li>
<li>Update Internal OAuth consent screen docs (Phil Shackleton)</li>
<li>Moved <code>root_folder_id</code> to advanced section (Abhiraj)</li>
</ul></li>
<li>Dropbox
<ul>
<li>Migrate from deprecated api (m8rge)</li>
<li>Add logs to show when poll interval limits are exceeded (Nick
Craig-Wood)</li>
<li>Fix nil pointer exception on dropbox impersonate user not found
(Nick Craig-Wood)</li>
</ul></li>
<li>Fichier
<ul>
<li>Parse api error codes and them accordingly (buengese)</li>
</ul></li>
<li>FTP
<ul>
<li>Add support for <code>disable_utf8</code> option (Jason Zheng)</li>
<li>Revert to upstream <code>github.com/jlaffaye/ftp</code> from our
fork (Nick Craig-Wood)</li>
</ul></li>
<li>Google Cloud Storage
<ul>
<li>Add <code>--gcs-no-check-bucket</code> to minimise transactions and
perms (Nick Gooding)</li>
<li>Add <code>--gcs-decompress</code> flag to decompress gzip-encoded
files (Nick Craig-Wood)
<ul>
<li>by default these will be downloaded compressed (which previously
failed)</li>
</ul></li>
</ul></li>
<li>Hasher
<ul>
<li>Support metadata (Nick Craig-Wood)</li>
</ul></li>
<li>HTTP
<ul>
<li>Fix missing response when using custom auth handler (albertony)</li>
</ul></li>
<li>Jottacloud
<ul>
<li>Add support for upload to custom device and mountpoint
(albertony)</li>
<li>Always store username in config and use it to avoid initial API
request (albertony)</li>
<li>Fix issue with server-side copy when destination is in trash
(albertony)</li>
<li>Fix listing output of remote with special characters
(albertony)</li>
</ul></li>
<li>Mailru
<ul>
<li>Fix timeout by using int instead of time.Duration for keeping number
of seconds (albertony)</li>
</ul></li>
<li>Mega
<ul>
<li>Document using MEGAcmd to help with login failures (Art M.
Gallagher)</li>
</ul></li>
<li>Onedrive
<ul>
<li>Implement <code>--poll-interval</code> for onedrive (Hugo
Laloge)</li>
<li>Add access scopes option (Sven Gerber)</li>
</ul></li>
<li>Opendrive
<ul>
<li>Resolve lag and truncate bugs (Scott Grimes)</li>
</ul></li>
<li>Pcloud
<ul>
<li>Fix about with no free space left (buengese)</li>
<li>Fix cleanup (buengese)</li>
</ul></li>
<li>S3
<ul>
<li>Use PUT Object instead of presigned URLs to upload single part
objects (Nick Craig-Wood)</li>
<li>Backend restore command to skip non-GLACIER objects (Vincent
Murphy)</li>
<li>Use chunksize lib to determine chunksize dynamically (Derek
Battams)</li>
<li>Retry RequestTimeout errors (Nick Craig-Wood)</li>
<li>Implement reading and writing of metadata (Nick Craig-Wood)</li>
</ul></li>
<li>SFTP
<ul>
<li>Add support for about and hashsum on windows server (albertony)</li>
<li>Use vendor-specific VFS statistics extension for about if available
(albertony)</li>
<li>Add <code>--sftp-chunk-size</code> to control packets sizes for high
latency links (Nick Craig-Wood)</li>
<li>Add <code>--sftp-concurrency</code> to improve high latency
transfers (Nick Craig-Wood)</li>
<li>Add <code>--sftp-set-env</code> option to set environment variables
(Nick Craig-Wood)</li>
<li>Add Hetzner Storage Boxes to supported sftp backends (Anthrazz)</li>
</ul></li>
<li>Storj
<ul>
<li>Fix put which lead to the file being unreadable when using mount
(Erik van Velzen)</li>
</ul></li>
<li>Union
<ul>
<li>Add <code>min_free_space</code> option for
<code>lfs</code>/<code>eplfs</code> policies (Nick Craig-Wood)</li>
<li>Fix uploading files to union of all bucket based remotes (Nick
Craig-Wood)</li>
<li>Fix get free space for remotes which don’t support it (Nick
Craig-Wood)</li>
<li>Fix <code>eplus</code> policy to select correct entry for existing
files (Nick Craig-Wood)</li>
<li>Support metadata (Nick Craig-Wood)</li>
</ul></li>
<li>Uptobox
<ul>
<li>Fix root path handling (buengese)</li>
</ul></li>
<li>WebDAV
<ul>
<li>Add SharePoint in other specific regions support (Noah Hsu)</li>
</ul></li>
<li>Yandex
<ul>
<li>Handle api error on server-side move (albertony)</li>
</ul></li>
<li>Zoho
<ul>
<li>Add Japan and China regions (buengese)</li>
</ul></li>
</ul>
<h2 id="v1.58.1---2022-04-29">v1.58.1 - 2022-04-29</h2>
<p><a
href="https://github.com/rclone/rclone/compare/v1.58.0...v1.58.1">See
commits</a></p>
<ul>
<li>Bug Fixes
<ul>
<li>build: Update github.com/billziss-gh to github.com/winfsp (Nick
Craig-Wood)</li>
<li>filter: Fix timezone of <code>--min-age</code>/<code>-max-age</code>
from UTC to local as documented (Nick Craig-Wood)</li>
<li>rc/js: Correct RC method names (Sơn Trần-Nguyễn)</li>
<li>docs
<ul>
<li>Fix some links to command pages (albertony)</li>
<li>Add <code>--multi-thread-streams</code> note to
<code>--transfers</code>. (Zsolt Ero)</li>
</ul></li>
</ul></li>
<li>Mount
<ul>
<li>Fix <code>--devname</code> and fusermount: unknown option ‘fsname’
when mounting via rc (Nick Craig-Wood)</li>
</ul></li>
<li>VFS
<ul>
<li>Remove wording which suggests VFS is only for mounting (Nick
Craig-Wood)</li>
</ul></li>
<li>Dropbox
<ul>
<li>Fix retries of multipart uploads with incorrect_offset error (Nick
Craig-Wood)</li>
</ul></li>
<li>Google Cloud Storage
<ul>
<li>Use the s3 pacer to speed up transactions (Nick Craig-Wood)</li>
<li>pacer: Default the Google pacer to a burst of 100 to fix gcs pacing
(Nick Craig-Wood)</li>
</ul></li>
<li>Jottacloud
<ul>
<li>Fix scope in token request (albertony)</li>
</ul></li>
<li>Netstorage
<ul>
<li>Fix unescaped HTML in documentation (Nick Craig-Wood)</li>
<li>Make levels of headings consistent (Nick Craig-Wood)</li>
<li>Add support contacts to netstorage doc (Nil Alexandrov)</li>
</ul></li>
<li>Onedrive
<ul>
<li>Note that sharepoint also changes web files (.html, .aspx) (GH)</li>
</ul></li>
<li>Putio
<ul>
<li>Handle rate limit errors (Berkan Teber)</li>
<li>Fix multithread download and other ranged requests (rafma0)</li>
</ul></li>
<li>S3
<ul>
<li>Add ChinaMobile EOS to provider list (GuoXingbin)</li>
<li>Sync providers in config description with providers (Nick
Craig-Wood)</li>
</ul></li>
<li>SFTP
<ul>
<li>Fix OpenSSH 8.8+ RSA keys incompatibility (KARBOWSKI Piotr)</li>
<li>Note that Scaleway C14 is deprecating SFTP in favor of S3 (Adrien
Rey-Jarthon)</li>
</ul></li>
<li>Storj
<ul>
<li>Fix bucket creation on Move (Nick Craig-Wood)</li>
</ul></li>
<li>WebDAV
<ul>
<li>Don’t override Referer if user sets it (Nick Craig-Wood)</li>
</ul></li>
</ul>
<h2 id="v1.58.0---2022-03-18">v1.58.0 - 2022-03-18</h2>
<p><a
href="https://github.com/rclone/rclone/compare/v1.57.0...v1.58.0">See
commits</a></p>
<ul>
<li>New backends
<ul>
<li><a href="/netstorage">Akamai Netstorage</a> (Nil Alexandrov)</li>
<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>
<li><a href="https://rclone.org/storj/">Storj</a> (renamed from
Tardigrade - your old config files will continue working)</li>
</ul></li>
<li>New commands
<ul>
<li><a href="https://rclone.org/bisync/">bisync</a> - experimental
bidirectional cloud sync (Ivan Andreev, Chris Nelson)</li>
</ul></li>
<li>New Features
<ul>
<li>build
<ul>
<li>Add <code>windows/arm64</code> build (<code>rclone mount</code> not
supported yet) (Nick Craig-Wood)</li>
<li>Raise minimum go version to go1.15 (Nick Craig-Wood)</li>
</ul></li>
<li>config: Allow dot in remote names and improve config editing
(albertony)</li>
<li>dedupe: Add quit as a choice in interactive mode (albertony)</li>
<li>dlna: Change icons to the newest ones. (Alain Nussbaumer)</li>
<li>filter: Add <a
href="https://rclone.org/filtering/#regexp"><code>{{ regexp }}</code>
syntax</a> to pattern matches (Nick Craig-Wood)</li>
<li>fshttp: Add prometheus metrics for HTTP status code (Michał
Matczuk)</li>
<li>hashsum: Support creating hash from data received on stdin
(albertony)</li>
<li>librclone
<ul>
<li>Allow empty string or null input instead of empty json object
(albertony)</li>
<li>Add support for mount commands (albertony)</li>
</ul></li>
<li>operations: Add server-side moves to stats (Ole Frost)</li>
<li>rc: Allow user to disable authentication for web gui
(negative0)</li>
<li>tree: Remove obsolete <code>--human</code> replaced by global
<code>--human-readable</code> (albertony)</li>
<li>version: Report correct friendly-name for newer Windows 10/11
versions (albertony)</li>
</ul></li>
<li>Bug Fixes
<ul>
<li>build
<ul>
<li>Fix ARM architecture version in .deb packages after nfpm change
(Nick Craig-Wood)</li>
<li>Hard fork <code>github.com/jlaffaye/ftp</code> to fix
<code>go get github.com/rclone/rclone</code> (Nick Craig-Wood)</li>
</ul></li>
<li>oauthutil: Fix crash when webbrowser requests
<code>/robots.txt</code> (Nick Craig-Wood)</li>
<li>operations: Fix goroutine leak in case of copy retry (Ankur
Gupta)</li>
<li>rc:
<ul>
<li>Fix <code>operations/publiclink</code> default for
<code>expires</code> parameter (Nick Craig-Wood)</li>
<li>Fix missing computation of <code>transferQueueSize</code> when
summing up statistics group (Carlo Mion)</li>
<li>Fix missing <code>StatsInfo</code> fields in the computation of the
group sum (Carlo Mion)</li>
</ul></li>
<li>sync: Fix <code>--max-duration</code> so it doesn’t retry when the
duration is exceeded (Nick Craig-Wood)</li>
<li>touch: Fix issue where a directory is created instead of a file
(albertony)</li>
</ul></li>
<li>Mount
<ul>
<li>Add <code>--devname</code> to set the device name sent to FUSE for
mount display (Nick Craig-Wood)</li>
</ul></li>
<li>VFS
<ul>
<li>Add <code>vfs/stats</code> remote control to show statistics (Nick
Craig-Wood)</li>
<li>Fix
<code>failed to _ensure cache internal error: downloaders is nil error</code>
(Nick Craig-Wood)</li>
<li>Fix handling of special characters in file names (Bumsu Hyeon)</li>
</ul></li>
<li>Local
<ul>
<li>Fix hash invalidation which caused errors with local crypt mount
(Nick Craig-Wood)</li>
</ul></li>
<li>Crypt
<ul>
<li>Add <code>base64</code> and <code>base32768</code> filename encoding
options (Max Sum, Sinan Tan)</li>
</ul></li>
<li>Azure Blob
<ul>
<li>Implement <code>--azureblob-upload-concurrency</code> parameter to
speed uploads (Nick Craig-Wood)</li>
<li>Remove 100MB upper limit on <code>chunk_size</code> as it is no
longer needed (Nick Craig-Wood)</li>
<li>Raise <code>--azureblob-upload-concurrency</code> to 16 by default
(Nick Craig-Wood)</li>
<li>Fix crash with SAS URL and no container (Nick Craig-Wood)</li>
</ul></li>
<li>Compress
<ul>
<li>Fix crash if metadata upload failed (Nick Craig-Wood)</li>
<li>Fix memory leak (Nick Craig-Wood)</li>
</ul></li>
<li>Drive
<ul>
<li>Added <code>--drive-copy-shortcut-content</code> (Abhiraj)</li>
<li>Disable OAuth OOB flow (copy a token) due to Google deprecation
(Nick Craig-Wood)
<ul>
<li>See <a
href="https://developers.googleblog.com/2022/02/making-oauth-flows-safer.html#disallowed-oob">the
deprecation note</a>.</li>
</ul></li>
<li>Add <code>--drive-skip-dangling-shortcuts</code> flag (Nick
Craig-Wood)</li>
<li>When using a link type <code>--drive-export-formats</code> shows all
doc types (Nick Craig-Wood)</li>
</ul></li>
<li>Dropbox
<ul>
<li>Speed up directory listings by specifying 1000 items in a chunk
(Nick Craig-Wood)</li>
<li>Save an API request when at the root (Nick Craig-Wood)</li>
</ul></li>
<li>Fichier
<ul>
<li>Implemented About functionality (Gourav T)</li>
</ul></li>
<li>FTP
<ul>
<li>Add <code>--ftp-ask-password</code> to prompt for password when
needed (Borna Butkovic)</li>
</ul></li>
<li>Google Cloud Storage
<ul>
<li>Add missing regions (Nick Craig-Wood)</li>
<li>Disable OAuth OOB flow (copy a token) due to Google deprecation
(Nick Craig-Wood)
<ul>
<li>See <a
href="https://developers.googleblog.com/2022/02/making-oauth-flows-safer.html#disallowed-oob">the
deprecation note</a>.</li>
</ul></li>
</ul></li>
<li>Googlephotos
<ul>
<li>Disable OAuth OOB flow (copy a token) due to Google deprecation
(Nick Craig-Wood)
<ul>
<li>See <a
href="https://developers.googleblog.com/2022/02/making-oauth-flows-safer.html#disallowed-oob">the
deprecation note</a>.</li>
</ul></li>
</ul></li>
<li>Hasher
<ul>
<li>Fix crash on object not found (Nick Craig-Wood)</li>
</ul></li>
<li>Hdfs
<ul>
<li>Add file (Move) and directory move (DirMove) support (Andy
Jackson)</li>
</ul></li>
<li>HTTP
<ul>
<li>Improved recognition of URL pointing to a single file
(albertony)</li>
</ul></li>
<li>Jottacloud
<ul>
<li>Change API used by recursive list (ListR) (Kim)</li>
<li>Add support for Tele2 Cloud (Fredric Arklid)</li>
</ul></li>
<li>Koofr
<ul>
<li>Add Digistorage service as a Koofr provider. (jaKa)</li>
</ul></li>
<li>Mailru
<ul>
<li>Fix int32 overflow on arm32 (Ivan Andreev)</li>
</ul></li>
<li>Onedrive
<ul>
<li>Add config option for oauth scope <code>Sites.Read.All</code>
(Charlie Jiang)</li>
<li>Minor optimization of quickxorhash (Isaac Levy)</li>
<li>Add <code>--onedrive-root-folder-id</code> flag (Nick
Craig-Wood)</li>
<li>Do not retry on <code>400 pathIsTooLong</code> error (ctrl-q)</li>
</ul></li>
<li>Pcloud
<ul>
<li>Add support for recursive list (ListR) (Niels van de Weem)</li>
<li>Fix pre-1970 time stamps (Nick Craig-Wood)</li>
</ul></li>
<li>S3
<ul>
<li>Use <code>ListObjectsV2</code> for faster listings (Felix Bünemann)
<ul>
<li>Fallback to <code>ListObject</code> v1 on unsupported providers
(Nick Craig-Wood)</li>
</ul></li>
<li>Use the <code>ETag</code> on multipart transfers to verify the
transfer was OK (Nick Craig-Wood)
<ul>
<li>Add <code>--s3-use-multipart-etag</code> provider quirk to disable
this on unsupported providers (Nick Craig-Wood)</li>
</ul></li>
<li>New Providers
<ul>
<li>RackCorp object storage (bbabich)</li>
<li>Seagate Lyve Cloud storage (Nick Craig-Wood)</li>
<li>SeaweedFS (Chris Lu)</li>
<li>Storj Shared gateways (Márton Elek, Nick Craig-Wood)</li>
</ul></li>
<li>Add Wasabi AP Northeast 2 endpoint info (lindwurm)</li>
<li>Add <code>GLACIER_IR</code> storage class (Yunhai Luo)</li>
<li>Document <code>Content-MD5</code> workaround for object-lock enabled
buckets (Paulo Martins)</li>
<li>Fix multipart upload with <code>--no-head</code> flag (Nick
Craig-Wood)</li>
<li>Simplify content length processing in s3 with download url
(Logeshwaran Murugesan)</li>
</ul></li>
<li>SFTP
<ul>
<li>Add rclone to list of supported
<code>md5sum</code>/<code>sha1sum</code> commands to look for
(albertony)</li>
<li>Refactor so we only have one way of running remote commands (Nick
Craig-Wood)</li>
<li>Fix timeout on hashing large files by sending keepalives (Nick
Craig-Wood)</li>
<li>Fix unnecessary seeking when uploading and downloading files (Nick
Craig-Wood)</li>
<li>Update docs on how to create <code>known_hosts</code> file (Nick
Craig-Wood)</li>
</ul></li>
<li>Storj
<ul>
<li>Rename tardigrade backend to storj backend (Nick Craig-Wood)</li>
<li>Implement server side Move for files (Nick Craig-Wood)</li>
<li>Update docs to explain differences between s3 and this backend
(Elek, Márton)</li>
</ul></li>
<li>Swift
<ul>
<li>Fix About so it shows info about the current container only (Nick
Craig-Wood)</li>
</ul></li>
<li>Union
<ul>
<li>Fix treatment of remotes with <code>//</code> in (Nick
Craig-Wood)</li>
<li>Fix deadlock when one part of a multi-upload fails (Nick
Craig-Wood)</li>
<li>Fix eplus policy returned nil (Vitor Arruda)</li>
</ul></li>
<li>Yandex
<ul>
<li>Add permanent deletion support (deinferno)</li>
</ul></li>
</ul>
<h2 id="v1.57.0---2021-11-01">v1.57.0 - 2021-11-01</h2>
<p><a
href="https://github.com/rclone/rclone/compare/v1.56.0...v1.57.0">See
commits</a></p>
<ul>
<li>New backends
<ul>
<li>Sia: for Sia decentralized cloud (Ian Levesque, Matthew Sevey, Ivan
Andreev)</li>
<li>Hasher: caches hashes and enable hashes for backends that don’t
support them (Ivan Andreev)</li>
</ul></li>
<li>New commands
<ul>
<li>lsjson –stat: to get info about a single file/dir and
<code>operations/stat</code> api (Nick Craig-Wood)</li>
<li>config paths: show configured paths (albertony)</li>
</ul></li>
<li>New Features
<ul>
<li>about: Make human-readable output more consistent with other
commands (albertony)</li>
<li>build
<ul>
<li>Use go1.17 for building and make go1.14 the minimum supported (Nick
Craig-Wood)</li>
<li>Update Go to 1.16 and NDK to 22b for Android builds (x0b)</li>
</ul></li>
<li>config
<ul>
<li>Support hyphen in remote name from environment variable
(albertony)</li>
<li>Make temporary directory user-configurable (albertony)</li>
<li>Convert <code>--cache-dir</code> value to an absolute path
(albertony)</li>
<li>Do not override MIME types from OS defaults (albertony)</li>
</ul></li>
<li>docs
<ul>
<li>Toc styling and header levels cleanup (albertony)</li>
<li>Extend documentation on valid remote names (albertony)</li>
<li>Mention make for building and cmount tag for macos (Alex Chen)</li>
<li>…and many more contributions to numerous to mention!</li>
</ul></li>
<li>fs: Move with <code>--ignore-existing</code> will not delete skipped
files (Nathan Collins)</li>
<li>hashsum
<ul>
<li>Treat hash values in sum file as case insensitive (Ivan
Andreev)</li>
<li>Don’t put <code>ERROR</code> or <code>UNSUPPORTED</code> in output
(Ivan Andreev)</li>
</ul></li>
<li>lib/encoder: Add encoding of square brackets (Ivan Andreev)</li>
<li>lib/file: Improve error message when attempting to create dir on
nonexistent drive on windows (albertony)</li>
<li>lib/http: Factor password hash salt into options with default (Nolan
Woods)</li>
<li>lib/kv: Add key-value database api (Ivan Andreev)</li>
<li>librclone
<ul>
<li>Add <code>RcloneFreeString</code> function (albertony)</li>
<li>Free strings in python example (albertony)</li>
</ul></li>
<li>log: Optionally print pid in logs (Ivan Andreev)</li>
<li>ls: Introduce <code>--human-readable</code> global option to print
human-readable sizes (albertony)</li>
<li>ncdu: Introduce key <code>u</code> to toggle human-readable
(albertony)</li>
<li>operations: Add <code>rmdirs -v</code> output (Justin Winokur)</li>
<li>serve sftp
<ul>
<li>Generate an ECDSA server key as well as RSA (Nick Craig-Wood)</li>
<li>Generate an Ed25519 server key as well as ECDSA and RSA
(albertony)</li>
</ul></li>
<li>serve docker
<ul>
<li>Allow to customize proxy settings of docker plugin (Ivan
Andreev)</li>
<li>Build docker plugin for multiple platforms (Thomas Stachl)</li>
</ul></li>
<li>size: Include human-readable count (albertony)</li>
<li>touch: Add support for touching files in directory, with recursive
option, filtering and <code>--dry-run</code>/<code>-i</code>
(albertony)</li>
<li>tree: Option to print human-readable sizes removed in favor of
global option (albertony)</li>
</ul></li>
<li>Bug Fixes
<ul>
<li>lib/http
<ul>
<li>Fix bad username check in single auth secret provider (Nolan
Woods)</li>
<li>Fix handling of SSL credentials (Nolan Woods)</li>
</ul></li>
<li>serve ftp: Ensure modtime is passed as UTC always to fix timezone
oddities (Nick Craig-Wood)</li>
<li>serve sftp: Fix generation of server keys on windows
(albertony)</li>
<li>serve docker: Fix octal umask (Ivan Andreev)</li>
</ul></li>
<li>Mount
<ul>
<li>Enable rclone to be run as mount helper direct from the fstab (Ivan
Andreev)</li>
<li>Use procfs to validate mount on linux (Ivan Andreev)</li>
<li>Correctly daemonize for compatibility with automount (Ivan
Andreev)</li>
</ul></li>
<li>VFS
<ul>
<li>Ensure names used in cache path are legal on current OS
(albertony)</li>
<li>Ignore <code>ECLOSED</code> when truncating file handles to fix
intermittent bad file descriptor error (Nick Craig-Wood)</li>
</ul></li>
<li>Local
<ul>
<li>Refactor default OS encoding out from local backend into shared
encoder lib (albertony)</li>
</ul></li>
<li>Crypt
<ul>
<li>Return wrapped object even with
<code>--crypt-no-data-encryption</code> (Ivan Andreev)</li>
<li>Fix uploads with <code>--crypt-no-data-encryption</code> (Nick
Craig-Wood)</li>
</ul></li>
<li>Azure Blob
<ul>
<li>Add <code>--azureblob-no-head-object</code> (Tatsuya Noyori)</li>
</ul></li>
<li>Box
<ul>
<li>Make listings of heavily used directories more reliable (Nick
Craig-Wood)</li>
<li>When doing cleanup delete as much as possible (Nick Craig-Wood)</li>
<li>Add <code>--box-list-chunk</code> to control listing chunk size
(Nick Craig-Wood)</li>
<li>Delete items in parallel in cleanup using <code>--checkers</code>
threads (Nick Craig-Wood)</li>
<li>Add <code>--box-owned-by</code> to only show items owned by the
login passed (Nick Craig-Wood)</li>
<li>Retry <code>operation_blocked_temporary</code> errors (Nick
Craig-Wood)</li>
</ul></li>
<li>Chunker
<ul>
<li>Md5all must create metadata if base hash is slow (Ivan Andreev)</li>
</ul></li>
<li>Drive
<ul>
<li>Speed up directory listings by constraining the API listing using
the current filters (fotile96, Ivan Andreev)</li>
<li>Fix buffering for single request upload for files smaller than
<code>--drive-upload-cutoff</code> (YenForYang)</li>
<li>Add <code>-o config</code> option to <code>backend drives</code> to
make config for all shared drives (Nick Craig-Wood)</li>
</ul></li>
<li>Dropbox
<ul>
<li>Add <code>--dropbox-batch-commit-timeout</code> to control batch
timeout (Nick Craig-Wood)</li>
</ul></li>
<li>Filefabric
<ul>
<li>Make backoff exponential for error_background to fix errors (Nick
Craig-Wood)</li>
<li>Fix directory move after API change (Nick Craig-Wood)</li>
</ul></li>
<li>FTP
<ul>
<li>Enable tls session cache by default (Ivan Andreev)</li>
<li>Add option to disable tls13 (Ivan Andreev)</li>
<li>Fix timeout after long uploads (Ivan Andreev)</li>
<li>Add support for precise time (Ivan Andreev)</li>
<li>Enable CI for ProFtpd, PureFtpd, VsFtpd (Ivan Andreev)</li>
</ul></li>
<li>Googlephotos
<ul>
<li>Use encoder for album names to fix albums with control characters
(Parth Shukla)</li>
</ul></li>
<li>Jottacloud
<ul>
<li>Implement <code>SetModTime</code> to support modtime-only changes
(albertony)</li>
<li>Improved error handling with <code>SetModTime</code> and corrupt
files in general (albertony)</li>
<li>Add support for <code>UserInfo</code>
(<code>rclone config userinfo</code>) feature (albertony)</li>
<li>Return direct download link from <code>rclone link</code> command
(albertony)</li>
</ul></li>
<li>Koofr
<ul>
<li>Create direct share link (Dmitry Bogatov)</li>
</ul></li>
<li>Pcloud
<ul>
<li>Add sha256 support (Ken Enrique Morel)</li>
</ul></li>
<li>Premiumizeme
<ul>
<li>Fix directory listing after API changes (Nick Craig-Wood)</li>
<li>Fix server side move after API change (Nick Craig-Wood)</li>
<li>Fix server side directory move after API changes (Nick
Craig-Wood)</li>
</ul></li>
<li>S3
<ul>
<li>Add support to use CDN URL to download the file (Logeshwaran)</li>
<li>Add AWS Snowball Edge to providers examples (r0kk3rz)</li>
<li>Use a combination of SDK retries and rclone retries (Nick
Craig-Wood)</li>
<li>Fix IAM Role for Service Account not working and other auth problems
(Nick Craig-Wood)</li>
<li>Fix <code>shared_credentials_file</code> auth after reverting
incorrect fix (Nick Craig-Wood)</li>
<li>Fix corrupted on transfer: sizes differ 0 vs xxxx with Ceph (Nick
Craig-Wood)</li>
</ul></li>
<li>Seafile
<ul>
<li>Fix error when not configured for 2fa (Fred)</li>
</ul></li>
<li>SFTP
<ul>
<li>Fix timeout when doing MD5SUM of large file (Nick Craig-Wood)</li>
</ul></li>
<li>Swift
<ul>
<li>Update OCI URL (David Liu)</li>
<li>Document OVH Cloud Archive (HNGamingUK)</li>
</ul></li>
<li>Union
<ul>
<li>Fix rename not working with union of local disk and bucket based
remote (Nick Craig-Wood)</li>
</ul></li>
</ul>
<h2 id="v1.56.2---2021-10-01">v1.56.2 - 2021-10-01</h2>
<p><a
href="https://github.com/rclone/rclone/compare/v1.56.1...v1.56.2">See
commits</a></p>
<ul>
<li>Bug Fixes
<ul>
<li>serve http: Re-add missing auth to http service (Nolan Woods)</li>
<li>build: Update golang.org/x/sys to fix crash on macOS when compiled
with go1.17 (Herby Gillot)</li>
</ul></li>
<li>FTP
<ul>
<li>Fix deadlock after failed update when concurrency=1 (Ivan
Andreev)</li>
</ul></li>
</ul>
<h2 id="v1.56.1---2021-09-19">v1.56.1 - 2021-09-19</h2>
<p><a
href="https://github.com/rclone/rclone/compare/v1.56.0...v1.56.1">See
commits</a></p>
<ul>
<li>Bug Fixes
<ul>
<li>accounting: Fix maximum bwlimit by scaling scale max token bucket
size (Nick Craig-Wood)</li>
<li>rc: Fix speed does not update in core/stats (negative0)</li>
<li>selfupdate: Fix <code>--quiet</code> option, not quite quiet
(yedamo)</li>
<li>serve http: Fix <code>serve http</code> exiting directly after
starting (Cnly)</li>
<li>build
<ul>
<li>Apply gofmt from golang 1.17 (Ivan Andreev)</li>
<li>Update Go to 1.16 and NDK to 22b for android/any (x0b)</li>
</ul></li>
</ul></li>
<li>Mount
<ul>
<li>Fix <code>--daemon</code> mode (Ivan Andreev)</li>
</ul></li>
<li>VFS
<ul>
<li>Fix duplicates on rename (Nick Craig-Wood)</li>
<li>Fix crash when truncating a just uploaded object (Nick
Craig-Wood)</li>
<li>Fix issue where empty dirs would build up in cache meta dir
(albertony)</li>
</ul></li>
<li>Drive
<ul>
<li>Fix instructions for auto config (Greg Sadetsky)</li>
<li>Fix lsf example without drive-impersonate (Greg Sadetsky)</li>
</ul></li>
<li>Onedrive
<ul>
<li>Handle HTTP 400 better in PublicLink (Alex Chen)</li>
<li>Clarification of the process for creating custom client_id (Mariano
Absatz)</li>
</ul></li>
<li>Pcloud
<ul>
<li>Return an early error when Put is called with an unknown size (Nick
Craig-Wood)</li>
<li>Try harder to delete a failed upload (Nick Craig-Wood)</li>
</ul></li>
<li>S3
<ul>
<li>Add Wasabi’s AP-Northeast endpoint info (hota)</li>
<li>Fix typo in s3 documentation (Greg Sadetsky)</li>
</ul></li>
<li>Seafile
<ul>
<li>Fix 2fa config state machine (Fred)</li>
</ul></li>
<li>SFTP
<ul>
<li>Remove spurious error message on
<code>--sftp-disable-concurrent-reads</code> (Nick Craig-Wood)</li>
</ul></li>
<li>Sugarsync
<ul>
<li>Fix initial connection after config re-arrangement (Nick
Craig-Wood)</li>
</ul></li>
</ul>
<h2 id="v1.56.0---2021-07-20">v1.56.0 - 2021-07-20</h2>
<p><a
href="https://github.com/rclone/rclone/compare/v1.55.0...v1.56.0">See
commits</a></p>
<ul>
<li>New backends
<ul>
<li><a href="https://rclone.org/uptobox/">Uptobox</a> (buengese)</li>
</ul></li>
<li>New commands
<ul>
<li><a href="https://rclone.org/commands/rclone_serve_docker/">serve
docker</a> (Antoine GIRARD) (Ivan Andreev)
<ul>
<li>and accompanying <a href="https://rclone.org/docker/">docker volume
plugin</a></li>
</ul></li>
<li><a href="https://rclone.org/commands/rclone_checksum/">checksum</a>
to check files against a file of checksums (Ivan Andreev)
<ul>
<li>this is also available as <code>rclone md5sum -C</code> etc</li>
</ul></li>
<li><a href="https://rclone.org/commands/rclone_config_touch/">config
touch</a>: ensure config exists at configured location (albertony)</li>
<li><a href="https://rclone.org/commands/rclone_test_changenotify/">test
changenotify</a>: command to help debugging changenotify (Nick
Craig-Wood)</li>
</ul></li>
<li>Deprecations
<ul>
<li><code>dbhashsum</code>: Remove command deprecated a year ago (Ivan
Andreev)</li>
<li><code>cache</code>: Deprecate cache backend (Ivan Andreev)</li>
</ul></li>
<li>New Features
<ul>
<li>rework config system so it can be used non-interactively via cli and
rc API.
<ul>
<li>See docs in <a
href="https://rclone.org/commands/rclone_config_create/">config
create</a></li>
<li>This is a very big change to all the backends so may cause breakages
- please file bugs!</li>
</ul></li>
<li>librclone - export the rclone RC as a C library (lewisxy) (Nick
Craig-Wood)
<ul>
<li>Link a C-API rclone shared object into your project</li>
<li>Use the RC as an in memory interface</li>
<li>Python example supplied</li>
<li>Also supports Android and gomobile</li>
</ul></li>
<li>fs
<ul>
<li>Add <code>--disable-http2</code> for global http2 disable (Nick
Craig-Wood)</li>
<li>Make <code>--dump</code> imply <code>-vv</code> (Alex Chen)</li>
<li>Use binary prefixes for size and rate units (albertony)</li>
<li>Use decimal prefixes for counts (albertony)</li>
<li>Add google search widget to rclone.org (Ivan Andreev)</li>
</ul></li>
<li>accounting: Calculate rolling average speed (Haochen Tong)</li>
<li>atexit: Terminate with non-zero status after receiving signal
(Michael Hanselmann)</li>
<li>build
<ul>
<li>Only run event-based workflow scripts under rclone repo with manual
override (Mathieu Carbou)</li>
<li>Add Android build with gomobile (x0b)</li>
</ul></li>
<li>check: Log the hash in use like cryptcheck does (Nick
Craig-Wood)</li>
<li>version: Print os/version, kernel and bitness (Ivan Andreev)</li>
<li>config
<ul>
<li>Prevent use of Windows reserved names in config file name
(albertony)</li>
<li>Create config file in windows appdata directory by default
(albertony)</li>
<li>Treat any config file paths with filename notfound as memory-only
config (albertony)</li>
<li>Delay load config file (albertony)</li>
<li>Replace defaultConfig with a thread-safe in-memory implementation
(Chris Macklin)</li>
<li>Allow <code>config create</code> and friends to take
<code>key=value</code> parameters (Nick Craig-Wood)</li>
<li>Fixed issues with flags/options set by environment vars. (Ole
Frost)</li>
</ul></li>
<li>fshttp: Implement graceful DSCP error handling (Tyson Moore)</li>
<li>lib/http - provides an abstraction for a central http server that
services can bind routes to (Nolan Woods)
<ul>
<li>Add <code>--template</code> config and flags to serve/data (Nolan
Woods)</li>
<li>Add default 404 handler (Nolan Woods)</li>
</ul></li>
<li>link: Use “off” value for unset expiry (Nick Craig-Wood)</li>
<li>oauthutil: Raise fatal error if token expired without refresh token
(Alex Chen)</li>
<li>rcat: Add <code>--size</code> flag for more efficient uploads of
known size (Nazar Mishturak)</li>
<li>serve sftp: Add <code>--stdio</code> flag to serve via stdio
(Tom)</li>
<li>sync: Don’t warn about <code>--no-traverse</code> when
<code>--files-from</code> is set (Nick Gaya)</li>
<li><code>test makefiles</code>
<ul>
<li>Add <code>--seed</code> flag and make data generated repeatable
(Nick Craig-Wood)</li>
<li>Add log levels and speed summary (Nick Craig-Wood)</li>
</ul></li>
</ul></li>
<li>Bug Fixes
<ul>
<li>accounting: Fix startTime of statsGroups.sum (Haochen Tong)</li>
<li>cmd/ncdu: Fix out of range panic in delete (buengese)</li>
<li>config
<ul>
<li>Fix issues with memory-only config file paths (albertony)</li>
<li>Fix in memory config not saving on the fly backend config (Nick
Craig-Wood)</li>
</ul></li>
<li>fshttp: Fix address parsing for DSCP (Tyson Moore)</li>
<li>ncdu: Update termbox-go library to fix crash (Nick Craig-Wood)</li>
<li>oauthutil: Fix old authorize result not recognised (Cnly)</li>
<li>operations: Don’t update timestamps of files in
<code>--compare-dest</code> (Nick Gaya)</li>
<li>selfupdate: fix archive name on macos (Ivan Andreev)</li>
</ul></li>
<li>Mount
<ul>
<li>Refactor before adding serve docker (Antoine GIRARD)</li>
</ul></li>
<li>VFS
<ul>
<li>Add cache reset for <code>--vfs-cache-max-size</code> handling at
cache poll interval (Leo Luan)</li>
<li>Fix modtime changing when reading file into cache (Nick
Craig-Wood)</li>
<li>Avoid unnecessary subdir in cache path (albertony)</li>
<li>Fix that umask option cannot be set as environment variable
(albertony)</li>
<li>Do not print notice about missing poll-interval support when set to
0 (albertony)</li>
</ul></li>
<li>Local
<ul>
<li>Always use readlink to read symlink size for better compatibility
(Nick Craig-Wood)</li>
<li>Add <code>--local-unicode-normalization</code> (and remove
<code>--local-no-unicode-normalization</code>) (Nick Craig-Wood)</li>
<li>Skip entries removed concurrently with List() (Ivan Andreev)</li>
</ul></li>
<li>Crypt
<ul>
<li>Support timestamped filenames from <code>--b2-versions</code>
(Dominik Mydlil)</li>
</ul></li>
<li>B2
<ul>
<li>Don’t include the bucket name in public link file prefixes (Jeffrey
Tolar)</li>
<li>Fix versions and .files with no extension (Nick Craig-Wood)</li>
<li>Factor version handling into lib/version (Dominik Mydlil)</li>
</ul></li>
<li>Box
<ul>
<li>Use upload preflight check to avoid listings in file uploads (Nick
Craig-Wood)</li>
<li>Return errors instead of calling log.Fatal with them (Nick
Craig-Wood)</li>
</ul></li>
<li>Drive
<ul>
<li>Switch to the Drives API for looking up shared drives (Nick
Craig-Wood)</li>
<li>Fix some google docs being treated as files (Nick Craig-Wood)</li>
</ul></li>
<li>Dropbox
<ul>
<li>Add <code>--dropbox-batch-mode</code> flag to speed up uploading
(Nick Craig-Wood)
<ul>
<li>Read the <a href="https://rclone.org/dropbox/#batch-mode">batch
mode</a> docs for more info</li>
</ul></li>
<li>Set visibility in link sharing when <code>--expire</code> is set
(Nick Craig-Wood)</li>
<li>Simplify chunked uploads (Alexey Ivanov)</li>
<li>Improve “own App IP” instructions (Ivan Andreev)</li>
</ul></li>
<li>Fichier
<ul>
<li>Check if more than one upload link is returned (Nick
Craig-Wood)</li>
<li>Support downloading password protected files and folders (Florian
Penzkofer)</li>
<li>Make error messages report text from the API (Nick Craig-Wood)</li>
<li>Fix move of files in the same directory (Nick Craig-Wood)</li>
<li>Check that we actually got a download token and retry if we didn’t
(buengese)</li>
</ul></li>
<li>Filefabric
<ul>
<li>Fix listing after change of from field from “int” to int. (Nick
Craig-Wood)</li>
</ul></li>
<li>FTP
<ul>
<li>Make upload error 250 indicate success (Nick Craig-Wood)</li>
</ul></li>
<li>GCS
<ul>
<li>Make compatible with gsutil’s mtime metadata (database64128)</li>
<li>Clean up time format constants (database64128)</li>
</ul></li>
<li>Google Photos
<ul>
<li>Fix read only scope not being used properly (Nick Craig-Wood)</li>
</ul></li>
<li>HTTP
<ul>
<li>Replace httplib with lib/http (Nolan Woods)</li>
<li>Clean up Bind to better use middleware (Nolan Woods)</li>
</ul></li>
<li>Jottacloud
<ul>
<li>Fix legacy auth with state based config system (buengese)</li>
<li>Fix invalid url in output from link command (albertony)</li>
<li>Add no versions option (buengese)</li>
</ul></li>
<li>Onedrive
<ul>
<li>Add <code>list_chunk option</code> (Nick Gaya)</li>
<li>Also report root error if unable to cancel multipart upload
(Cnly)</li>
<li>Fix failed to configure: empty token found error (Nick
Craig-Wood)</li>
<li>Make link return direct download link (Xuanchen Wu)</li>
</ul></li>
<li>S3
<ul>
<li>Add <code>--s3-no-head-object</code> (Tatsuya Noyori)</li>
<li>Remove WebIdentityRoleProvider to fix crash on auth (Nick
Craig-Wood)</li>
<li>Don’t check to see if remote is object if it ends with / (Nick
Craig-Wood)</li>
<li>Add SeaweedFS (Chris Lu)</li>
<li>Update Alibaba OSS endpoints (Chuan Zh)</li>
</ul></li>
<li>SFTP
<ul>
<li>Fix performance regression by re-enabling concurrent writes (Nick
Craig-Wood)</li>
<li>Expand tilde and environment variables in configured
<code>known_hosts_file</code> (albertony)</li>
</ul></li>
<li>Tardigrade
<ul>
<li>Upgrade to uplink v1.4.6 (Caleb Case)</li>
<li>Use negative offset (Caleb Case)</li>
<li>Add warning about <code>too many open files</code> (acsfer)</li>
</ul></li>
<li>WebDAV
<ul>
<li>Fix sharepoint auth over http (Nick Craig-Wood)</li>
<li>Add headers option (Antoon Prins)</li>
</ul></li>
</ul>
<h2 id="v1.55.1---2021-04-26">v1.55.1 - 2021-04-26</h2>
<p><a
href="https://github.com/rclone/rclone/compare/v1.55.0...v1.55.1">See
commits</a></p>
<ul>
<li>Bug Fixes
<ul>
<li>selfupdate
<ul>
<li>Dont detect FUSE if build is static (Ivan Andreev)</li>
<li>Add build tag noselfupdate (Ivan Andreev)</li>
</ul></li>
<li>sync: Fix incorrect error reported by graceful cutoff (Nick
Craig-Wood)</li>
<li>install.sh: fix macOS arm64 download (Nick Craig-Wood)</li>
<li>build: Fix version numbers in android branch builds (Nick
Craig-Wood)</li>
<li>docs
<ul>
<li>Contributing.md: update setup instructions for go1.16 (Nick
Gaya)</li>
<li>WinFsp 2021 is out of beta (albertony)</li>
<li>Minor cleanup of space around code section (albertony)</li>
<li>Fixed some typos (albertony)</li>
</ul></li>
</ul></li>
<li>VFS
<ul>
<li>Fix a code path which allows dirty data to be removed causing data
loss (Nick Craig-Wood)</li>
</ul></li>
<li>Compress
<ul>
<li>Fix compressed name regexp (buengese)</li>
</ul></li>
<li>Drive
<ul>
<li>Fix backend copyid of google doc to directory (Nick Craig-Wood)</li>
<li>Don’t open browser when service account… (Ansh Mittal)</li>
</ul></li>
<li>Dropbox
<ul>
<li>Add missing team_data.member scope for use with –impersonate (Nick
Craig-Wood)</li>
<li>Fix About after scopes changes - rclone config reconnect needed
(Nick Craig-Wood)</li>
<li>Fix Unable to decrypt returned paths from changeNotify (Nick
Craig-Wood)</li>
</ul></li>
<li>FTP
<ul>
<li>Fix implicit TLS (Ivan Andreev)</li>
</ul></li>
<li>Onedrive
<ul>
<li>Work around for random “Unable to initialize RPS” errors
(OleFrost)</li>
</ul></li>
<li>SFTP
<ul>
<li>Revert sftp library to v1.12.0 from v1.13.0 to fix performance
regression (Nick Craig-Wood)</li>
<li>Fix Update ReadFrom failed: failed to send packet: EOF errors (Nick
Craig-Wood)</li>
</ul></li>
<li>Zoho
<ul>
<li>Fix error when region isn’t set (buengese)</li>
<li>Do not ask for mountpoint twice when using headless setup
(buengese)</li>
</ul></li>
</ul>
<h2 id="v1.55.0---2021-03-31">v1.55.0 - 2021-03-31</h2>
<p><a
href="https://github.com/rclone/rclone/compare/v1.54.0...v1.55.0">See
commits</a></p>
<ul>
<li>New commands
<ul>
<li><a
href="https://rclone.org/commands/rclone_selfupdate/">selfupdate</a>
(Ivan Andreev)
<ul>
<li>Allows rclone to update itself in-place or via a package (using
<code>--package</code> flag)</li>
<li>Reads cryptographically signed signatures for non beta releases</li>
<li>Works on all OSes.</li>
</ul></li>
<li><a href="https://rclone.org/commands/rclone_test/">test</a> - these
are test commands - use with care!
<ul>
<li><code>histogram</code> - Makes a histogram of file name
characters.</li>
<li><code>info</code> - Discovers file name or other limitations for
paths.</li>
<li><code>makefiles</code> - Make a random file hierarchy for
testing.</li>
<li><code>memory</code> - Load all the objects at remote:path into
memory and report memory stats.</li>
</ul></li>
</ul></li>
<li>New Features
<ul>
<li><a href="https://rclone.org/docs/#connection-strings">Connection
strings</a>
<ul>
<li>Config parameters can now be passed as part of the remote name as a
connection string.</li>
<li>For example, to do the equivalent of
<code>--drive-shared-with-me</code> use
<code>drive,shared_with_me:</code></li>
<li>Make sure we don’t save on the fly remote config to the config file
(Nick Craig-Wood)</li>
<li>Make sure backends with additional config have a different name for
caching (Nick Craig-Wood)</li>
<li>This work was sponsored by CERN, through the <a
href="https://cs3mesh4eosc.eu/">CS3MESH4EOSC Project</a>.
<ul>
<li>CS3MESH4EOSC has received funding from the European Union’s Horizon
2020</li>
<li>research and innovation programme under Grant Agreement no.
863353.</li>
</ul></li>
</ul></li>
<li>build
<ul>
<li>Update go build version to go1.16 and raise minimum go version to
go1.13 (Nick Craig-Wood)</li>
<li>Make a macOS ARM64 build to support Apple Silicon (Nick
Craig-Wood)</li>
<li>Install macfuse 4.x instead of osxfuse 3.x (Nick Craig-Wood)</li>
<li>Use <code>GO386=softfloat</code> instead of deprecated
<code>GO386=387</code> for 386 builds (Nick Craig-Wood)</li>
<li>Disable IOS builds for the time being (Nick Craig-Wood)</li>
<li>Androids builds made with up to date NDK (x0b)</li>
<li>Add an rclone user to the Docker image but don’t use it by default
(cynthia kwok)</li>
</ul></li>
<li>dedupe: Make largest directory primary to minimize data moved
(Saksham Khanna)</li>
<li>config
<ul>
<li>Wrap config library in an interface (Fionera)</li>
<li>Make config file system pluggable (Nick Craig-Wood)</li>
<li><code>--config ""</code> or <code>"/notfound"</code> for in memory
config only (Nick Craig-Wood)</li>
<li>Clear fs cache of stale entries when altering config (Nick
Craig-Wood)</li>
</ul></li>
<li>copyurl: Add option to print resulting auto-filename
(albertony)</li>
<li>delete: Make <code>--rmdirs</code> obey the filters (Nick
Craig-Wood)</li>
<li>docs - many fixes and reworks from edwardxml, albertony, pvalls,
Ivan Andreev, Evan Harris, buengese, Alexey Tabakman</li>
<li>encoder/filename - add SCSU as tables (Klaus Post)</li>
<li>Add multiple paths support to <code>--compare-dest</code> and
<code>--copy-dest</code> flag (K265)</li>
<li>filter: Make <code>--exclude "dir/"</code> equivalent to
<code>--exclude "dir/**"</code> (Nick Craig-Wood)</li>
<li>fshttp: Add DSCP support with <code>--dscp</code> for QoS with
differentiated services (Max Sum)</li>
<li>lib/cache: Add Delete and DeletePrefix methods (Nick
Craig-Wood)</li>
<li>lib/file
<ul>
<li>Make pre-allocate detect disk full errors and return them (Nick
Craig-Wood)</li>
<li>Don’t run preallocate concurrently (Nick Craig-Wood)</li>
<li>Retry preallocate on EINTR (Nick Craig-Wood)</li>
</ul></li>
<li>operations: Made copy and sync operations obey a RetryAfterError
(Ankur Gupta)</li>
<li>rc
<ul>
<li>Add string alternatives for setting options over the rc (Nick
Craig-Wood)</li>
<li>Add <code>options/local</code> to see the options configured in the
context (Nick Craig-Wood)</li>
<li>Add <code>_config</code> parameter to set global config for just
this rc call (Nick Craig-Wood)</li>
<li>Implement passing filter config with <code>_filter</code> parameter
(Nick Craig-Wood)</li>
<li>Add <code>fscache/clear</code> and <code>fscache/entries</code> to
control the fs cache (Nick Craig-Wood)</li>
<li>Avoid +Inf value for speed in <code>core/stats</code>
(albertony)</li>
<li>Add a full set of stats to <code>core/stats</code> (Nick
Craig-Wood)</li>
<li>Allow <code>fs=</code> params to be a JSON blob (Nick
Craig-Wood)</li>
</ul></li>
<li>rcd: Added systemd notification during the <code>rclone rcd</code>
command. (Naveen Honest Raj)</li>
<li>rmdirs: Make <code>--rmdirs</code> obey the filters (Nick
Craig-Wood)</li>
<li>version: Show build tags and type of executable (Ivan Andreev)</li>
</ul></li>
<li>Bug Fixes
<ul>
<li>install.sh: make it fail on download errors (Ivan Andreev)</li>
<li>Fix excessive retries missing <code>--max-duration</code> timeout
(Nick Craig-Wood)</li>
<li>Fix crash when <code>--low-level-retries=0</code> (Nick
Craig-Wood)</li>
<li>Fix failed token refresh on mounts created via the rc (Nick
Craig-Wood)</li>
<li>fshttp: Fix bandwidth limiting after bad merge (Nick
Craig-Wood)</li>
<li>lib/atexit
<ul>
<li>Unregister interrupt handler once it has fired so users can
interrupt again (Nick Craig-Wood)</li>
<li>Fix occasional failure to unmount with CTRL-C (Nick Craig-Wood)</li>
<li>Fix deadlock calling Finalise while Run is running (Nick
Craig-Wood)</li>
</ul></li>
<li>lib/rest: Fix multipart uploads not stopping on context cancel (Nick
Craig-Wood)</li>
</ul></li>
<li>Mount
<ul>
<li>Allow mounting to root directory on windows (albertony)</li>
<li>Improved handling of relative paths on windows (albertony)</li>
<li>Fix unicode issues with accented characters on macOS (Nick
Craig-Wood)</li>
<li>Docs: document the new FileSecurity option in WinFsp 2021
(albertony)</li>
<li>Docs: add note about volume path syntax on windows (albertony)</li>
<li>Fix caching of old directories after renaming them (Nick
Craig-Wood)</li>
<li>Update cgofuse to the latest version to bring in macfuse 4 fix (Nick
Craig-Wood)</li>
</ul></li>
<li>VFS
<ul>
<li><code>--vfs-used-is-size</code> to report used space using recursive
scan (tYYGH)</li>
<li>Don’t set modification time if it was already correct (Nick
Craig-Wood)</li>
<li>Fix Create causing windows explorer to truncate files on CTRL-C
CTRL-V (Nick Craig-Wood)</li>
<li>Fix modtimes not updating when writing via cache (Nick
Craig-Wood)</li>
<li>Fix modtimes changing by fractional seconds after upload (Nick
Craig-Wood)</li>
<li>Fix modtime set if
<code>--vfs-cache-mode writes</code>/<code>full</code> and no write
(Nick Craig-Wood)</li>
<li>Rename files in cache and cancel uploads on directory rename (Nick
Craig-Wood)</li>
<li>Fix directory renaming by renaming dirs cached in memory (Nick
Craig-Wood)</li>
</ul></li>
<li>Local
<ul>
<li>Add flag <code>--local-no-preallocate</code> (David Sze)</li>
<li>Make <code>nounc</code> an advanced option except on Windows
(albertony)</li>
<li>Don’t ignore preallocate disk full errors (Nick Craig-Wood)</li>
</ul></li>
<li>Cache
<ul>
<li>Add <code>--fs-cache-expire-duration</code> to control the fs cache
(Nick Craig-Wood)</li>
</ul></li>
<li>Crypt
<ul>
<li>Add option to not encrypt data (Vesnyx)</li>
<li>Log hash ok on upload (albertony)</li>
</ul></li>
<li>Azure Blob
<ul>
<li>Add container public access level support. (Manish Kumar)</li>
</ul></li>
<li>B2
<ul>
<li>Fix HTML files downloaded via cloudflare (Nick Craig-Wood)</li>
</ul></li>
<li>Box
<ul>
<li>Fix transfers getting stuck on token expiry after API change (Nick
Craig-Wood)</li>
</ul></li>
<li>Chunker
<ul>
<li>Partially implement no-rename transactions (Maxwell Calman)</li>
</ul></li>
<li>Drive
<ul>
<li>Don’t stop server side copy if couldn’t read description (Nick
Craig-Wood)</li>
<li>Pass context on to drive SDK - to help with cancellation (Nick
Craig-Wood)</li>
</ul></li>
<li>Dropbox
<ul>
<li>Add polling for changes support (Robert Thomas)</li>
<li>Make <code>--timeout 0</code> work properly (Nick Craig-Wood)</li>
<li>Raise priority of rate limited message to INFO to make it more
noticeable (Nick Craig-Wood)</li>
</ul></li>
<li>Fichier
<ul>
<li>Implement copy &amp; move (buengese)</li>
<li>Implement public link (buengese)</li>
</ul></li>
<li>FTP
<ul>
<li>Implement Shutdown method (Nick Craig-Wood)</li>
<li>Close idle connections after <code>--ftp-idle-timeout</code> (1m by
default) (Nick Craig-Wood)</li>
<li>Make <code>--timeout 0</code> work properly (Nick Craig-Wood)</li>
<li>Add <code>--ftp-close-timeout</code> flag for use with awkward ftp
servers (Nick Craig-Wood)</li>
<li>Retry connections and logins on 421 errors (Nick Craig-Wood)</li>
</ul></li>
<li>Hdfs
<ul>
<li>Fix permissions for when directory is created (Lucas Messenger)</li>
</ul></li>
<li>Onedrive
<ul>
<li>Make <code>--timeout 0</code> work properly (Nick Craig-Wood)</li>
</ul></li>
<li>S3
<ul>
<li>Fix <code>--s3-profile</code> which wasn’t working (Nick
Craig-Wood)</li>
</ul></li>
<li>SFTP
<ul>
<li>Close idle connections after <code>--sftp-idle-timeout</code> (1m by
default) (Nick Craig-Wood)</li>
<li>Fix “file not found” errors for read once servers (Nick
Craig-Wood)</li>
<li>Fix SetModTime stat failed: object not found with
<code>--sftp-set-modtime=false</code> (Nick Craig-Wood)</li>
</ul></li>
<li>Swift
<ul>
<li>Update github.com/ncw/swift to v2.0.0 (Nick Craig-Wood)</li>
<li>Implement copying large objects (nguyenhuuluan434)</li>
</ul></li>
<li>Union
<ul>
<li>Fix crash when using epff policy (Nick Craig-Wood)</li>
<li>Fix union attempting to update files on a read only file system
(Nick Craig-Wood)</li>
<li>Refactor to use fspath.SplitFs instead of fs.ParseRemote (Nick
Craig-Wood)</li>
<li>Fix initialisation broken in refactor (Nick Craig-Wood)</li>
</ul></li>
<li>WebDAV
<ul>
<li>Add support for sharepoint with NTLM authentication (Rauno Ots)</li>
<li>Make sharepoint-ntlm docs more consistent (Alex Chen)</li>
<li>Improve terminology in sharepoint-ntlm docs (Ivan Andreev)</li>
<li>Disable HTTP/2 for NTLM authentication (georne)</li>
<li>Fix sharepoint-ntlm error 401 for parallel actions (Ivan
Andreev)</li>
<li>Check that purged directory really exists (Ivan Andreev)</li>
</ul></li>
<li>Yandex
<ul>
<li>Make <code>--timeout 0</code> work properly (Nick Craig-Wood)</li>
</ul></li>
<li>Zoho
<ul>
<li>Replace client id - you will need to
<code>rclone config reconnect</code> after this (buengese)</li>
<li>Add forgotten setupRegion() to NewFs - this finally fixes regions
other than EU (buengese)</li>
</ul></li>
</ul>
<h2 id="v1.54.1---2021-03-08">v1.54.1 - 2021-03-08</h2>
<p><a
href="https://github.com/rclone/rclone/compare/v1.54.0...v1.54.1">See
commits</a></p>
<ul>
<li>Bug Fixes
<ul>
<li>accounting: Fix –bwlimit when up or down is off (Nick
Craig-Wood)</li>
<li>docs
<ul>
<li>Fix nesting of brackets and backticks in ftp docs (edwardxml)</li>
<li>Fix broken link in sftp page (edwardxml)</li>
<li>Fix typo in crypt.md (Romeo Kienzler)</li>
<li>Changelog: Correct link to digitalis.io (Alex JOST)</li>
<li>Replace #file-caching with #vfs-file-caching (Miron Veryanskiy)</li>
<li>Convert bogus example link to code (edwardxml)</li>
<li>Remove dead link from rc.md (edwardxml)</li>
</ul></li>
<li>rc: Sync,copy,move: document createEmptySrcDirs parameter (Nick
Craig-Wood)</li>
<li>lsjson: Fix unterminated JSON in the presence of errors (Nick
Craig-Wood)</li>
</ul></li>
<li>Mount
<ul>
<li>Fix mount dropping on macOS by setting –daemon-timeout 10m (Nick
Craig-Wood)</li>
</ul></li>
<li>VFS
<ul>
<li>Document simultaneous usage with the same cache shouldn’t be used
(Nick Craig-Wood)</li>
</ul></li>
<li>B2
<ul>
<li>Automatically raise upload cutoff to avoid spurious error (Nick
Craig-Wood)</li>
<li>Fix failed to create file system with application key limited to a
prefix (Nick Craig-Wood)</li>
</ul></li>
<li>Drive
<ul>
<li>Refer to Shared Drives instead of Team Drives (Nick Craig-Wood)</li>
</ul></li>
<li>Dropbox
<ul>
<li>Add scopes to oauth request and optionally “members.read” (Nick
Craig-Wood)</li>
</ul></li>
<li>S3
<ul>
<li>Fix failed to create file system with folder level permissions
policy (Nick Craig-Wood)</li>
<li>Fix Wasabi HEAD requests returning stale data by using only 1
transport (Nick Craig-Wood)</li>
<li>Fix shared_credentials_file auth (Dmitry Chepurovskiy)</li>
<li>Add –s3-no-head to reducing costs docs (Nick Craig-Wood)</li>
</ul></li>
<li>Union
<ul>
<li>Fix mkdir at root with remote:/ (Nick Craig-Wood)</li>
</ul></li>
<li>Zoho
<ul>
<li>Fix custom client id’s (buengese)</li>
</ul></li>
</ul>
<h2 id="v1.54.0---2021-02-02">v1.54.0 - 2021-02-02</h2>
<p><a
href="https://github.com/rclone/rclone/compare/v1.53.0...v1.54.0">See
commits</a></p>
<ul>
<li>New backends
<ul>
<li>Compression remote (experimental) (buengese)</li>
<li>Enterprise File Fabric (Nick Craig-Wood)
<ul>
<li>This work was sponsored by <a
href="https://storagemadeeasy.com/">Storage Made Easy</a></li>
</ul></li>
<li>HDFS (Hadoop Distributed File System) (Yury Stankevich)</li>
<li>Zoho workdrive (buengese)</li>
</ul></li>
<li>New Features
<ul>
<li>Deglobalise the config (Nick Craig-Wood)
<ul>
<li>Global config now read from the context</li>
<li>This will enable passing of global config via the rc</li>
<li>This work was sponsored by <a
href="https://digitalis.io/">Digitalis</a></li>
</ul></li>
<li>Add <code>--bwlimit</code> for upload and download (Nick Craig-Wood)
<ul>
<li>Obey bwlimit in http Transport for better limiting</li>
</ul></li>
<li>Enhance systemd integration (Hekmon)
<ul>
<li>log level identification, manual activation with flag, automatic
systemd launch detection</li>
<li>Don’t compile systemd log integration for non unix systems (Benjamin
Gustin)</li>
</ul></li>
<li>Add a <code>--download</code> flag to md5sum/sha1sum/hashsum to
force rclone to download and hash files locally (lostheli)</li>
<li>Add <code>--progress-terminal-title</code> to print ETA to terminal
title (LaSombra)</li>
<li>Make backend env vars show in help as the defaults for backend flags
(Nick Craig-Wood)</li>
<li>build
<ul>
<li>Raise minimum go version to go1.12 (Nick Craig-Wood)</li>
</ul></li>
<li>dedupe
<ul>
<li>Add <code>--by-hash</code> to dedupe on content hash not file name
(Nick Craig-Wood)</li>
<li>Add <code>--dedupe-mode list</code> to just list dupes, changing
nothing (Nick Craig-Wood)</li>
<li>Add warning if used on a remote which can’t have duplicate names
(Nick Craig-Wood)</li>
</ul></li>
<li>fs
<ul>
<li>Add Shutdown optional method for backends (Nick Craig-Wood)</li>
<li>When using <code>--files-from</code> check files concurrently
(zhucan)</li>
<li>Accumulate stats when using <code>--dry-run</code> (Ingo Weiss)</li>
<li>Always show stats when using <code>--dry-run</code> or
<code>--interactive</code> (Nick Craig-Wood)</li>
<li>Add support for flag <code>--no-console</code> on windows to hide
the console window (albertony)</li>
</ul></li>
<li>genautocomplete: Add support to output to stdout (Ingo)</li>
<li>ncdu
<ul>
<li>Highlight read errors instead of aborting (Claudio Bantaloukas)</li>
<li>Add sort by average size in directory (Adam Plánský)</li>
<li>Add toggle option for average s3ize in directory - key ‘a’ (Adam
Plánský)</li>
<li>Add empty folder flag into ncdu browser (Adam Plánský)</li>
<li>Add <code>!</code> (error) and <code>.</code> (unreadable) file
flags to go with <code>e</code> (empty) (Nick Craig-Wood)</li>
</ul></li>
<li>obscure: Make <code>rclone obscure -</code> ignore newline at end of
line (Nick Craig-Wood)</li>
<li>operations
<ul>
<li>Add logs when need to upload files to set mod times (Nick
Craig-Wood)</li>
<li>Move and copy log name of the destination object in verbose (Adam
Plánský)</li>
<li>Add size if known to skipped items and JSON log (Nick
Craig-Wood)</li>
</ul></li>
<li>rc
<ul>
<li>Prefer actual listener address if using “:port” or “addr:0” only
(Nick Craig-Wood)</li>
<li>Add listener for finished jobs (Aleksandar Jankovic)</li>
</ul></li>
<li>serve ftp: Add options to enable TLS (Deepak Sah)</li>
<li>serve http/webdav: Redirect requests to the base url without the /
(Nick Craig-Wood)</li>
<li>serve restic: Implement object cache (Nick Craig-Wood)</li>
<li>stats: Add counter for deleted directories (Nick Craig-Wood)</li>
<li>sync: Only print “There was nothing to transfer” if no errors (Nick
Craig-Wood)</li>
<li>webui
<ul>
<li>Prompt user for updating webui if an update is available (Chaitanya
Bankanhal)</li>
<li>Fix plugins initialization (negative0)</li>
</ul></li>
</ul></li>
<li>Bug Fixes
<ul>
<li>fs
<ul>
<li>Fix nil pointer on copy &amp; move operations directly to remote
(Anagh Kumar Baranwal)</li>
<li>Fix parsing of .. when joining remotes (Nick Craig-Wood)</li>
</ul></li>
<li>log: Fix enabling systemd logging when using <code>--log-file</code>
(Nick Craig-Wood)</li>
<li>check
<ul>
<li>Make the error count match up in the log message (Nick
Craig-Wood)</li>
</ul></li>
<li>move: Fix data loss when source and destination are the same object
(Nick Craig-Wood)</li>
<li>operations
<ul>
<li>Fix <code>--cutoff-mode</code> hard not cutting off immediately
(Nick Craig-Wood)</li>
<li>Fix <code>--immutable</code> error message (Nick Craig-Wood)</li>
</ul></li>
<li>sync
<ul>
<li>Fix <code>--cutoff-mode</code> soft &amp; cautious so it doesn’t end
the transfer early (Nick Craig-Wood)</li>
<li>Fix <code>--immutable</code> errors retrying many times (Nick
Craig-Wood)</li>
</ul></li>
</ul></li>
<li>Docs
<ul>
<li>Many fixes and a rewrite of the filtering docs (edwardxml)</li>
<li>Many spelling and grammar fixes (Josh Soref)</li>
<li>Doc fixes for commands delete, purge, rmdir, rmdirs and mount
(albertony)</li>
<li>And thanks to these people for many doc fixes too numerous to list
<ul>
<li>Ameer Dawood, Antoine GIRARD, Bob Bagwill, Christopher Stewart</li>
<li>CokeMine, David, Dov Murik, Durval Menezes, Evan Harris,
gtorelly</li>
<li>Ilyess Bachiri, Janne Johansson, Kerry Su, Marcin Zelent,</li>
<li>Martin Michlmayr, Milly, Sơn Trần-Nguyễn</li>
</ul></li>
</ul></li>
<li>Mount
<ul>
<li>Update systemd status with cache stats (Hekmon)</li>
<li>Disable bazil/fuse based mount on macOS (Nick Craig-Wood)
<ul>
<li>Make <code>rclone mount</code> actually run
<code>rclone cmount</code> under macOS (Nick Craig-Wood)</li>
</ul></li>
<li>Implement mknod to make NFS file creation work (Nick
Craig-Wood)</li>
<li>Make sure we don’t call umount more than once (Nick Craig-Wood)</li>
<li>More user friendly mounting as network drive on windows
(albertony)</li>
<li>Detect if uid or gid are set in same option string: -o
uid=123,gid=456 (albertony)</li>
<li>Don’t attempt to unmount if fs has been destroyed already (Nick
Craig-Wood)</li>
</ul></li>
<li>VFS
<ul>
<li>Fix virtual entries causing deleted files to still appear (Nick
Craig-Wood)</li>
<li>Fix “file already exists” error for stale cache files (Nick
Craig-Wood)</li>
<li>Fix file leaks with <code>--vfs-cache-mode</code> full and
<code>--buffer-size 0</code> (Nick Craig-Wood)</li>
<li>Fix invalid cache path on windows when using :backend: as remote
(albertony)</li>
</ul></li>
<li>Local
<ul>
<li>Continue listing files/folders when a circular symlink is detected
(Manish Gupta)</li>
<li>New flag <code>--local-zero-size-links</code> to fix sync on some
virtual filesystems (Riccardo Iaconelli)</li>
</ul></li>
<li>Azure Blob
<ul>
<li>Add support for service principals (James Lim)</li>
<li>Add support for managed identities (Brad Ackerman)</li>
<li>Add examples for access tier (Bob Pusateri)</li>
<li>Utilize the streaming capabilities from the SDK for multipart
uploads (Denis Neuling)</li>
<li>Fix setting of mime types (Nick Craig-Wood)</li>
<li>Fix crash when listing outside a SAS URL’s root (Nick
Craig-Wood)</li>
<li>Delete archive tier blobs before update if
<code>--azureblob-archive-tier-delete</code> (Nick Craig-Wood)</li>
<li>Fix crash on startup (Nick Craig-Wood)</li>
<li>Fix memory usage by upgrading the SDK to v0.13.0 and implementing a
TransferManager (Nick Craig-Wood)</li>
<li>Require go1.14+ to compile due to SDK changes (Nick Craig-Wood)</li>
</ul></li>
<li>B2
<ul>
<li>Make NewObject use less expensive API calls (Nick Craig-Wood)
<ul>
<li>This will improve <code>--files-from</code> and
<code>restic serve</code> in particular</li>
</ul></li>
<li>Fixed crash on an empty file name (lluuaapp)</li>
</ul></li>
<li>Box
<ul>
<li>Fix NewObject for files that differ in case (Nick Craig-Wood)</li>
<li>Fix finding directories in a case insensitive way (Nick
Craig-Wood)</li>
</ul></li>
<li>Chunker
<ul>
<li>Skip long local hashing, hash in-transit (fixes) (Ivan Andreev)</li>
<li>Set Features ReadMimeType to false as Object.MimeType not supported
(Nick Craig-Wood)</li>
<li>Fix case-insensitive NewObject, test metadata detection (Ivan
Andreev)</li>
</ul></li>
<li>Drive
<ul>
<li>Implement <code>rclone backend copyid</code> command for copying
files by ID (Nick Craig-Wood)</li>
<li>Added flag <code>--drive-stop-on-download-limit</code> to stop
transfers when the download limit is exceeded (Anagh Kumar
Baranwal)</li>
<li>Implement CleanUp workaround for team drives (buengese)</li>
<li>Allow shortcut resolution and creation to be retried (Nick
Craig-Wood)</li>
<li>Log that emptying the trash can take some time (Nick
Craig-Wood)</li>
<li>Add xdg office icons to xdg desktop files (Pau
Rodriguez-Estivill)</li>
</ul></li>
<li>Dropbox
<ul>
<li>Add support for viewing shared files and folders (buengese)</li>
<li>Enable short lived access tokens (Nick Craig-Wood)</li>
<li>Implement IDer on Objects so <code>rclone lsf</code> etc can read
the IDs (buengese)</li>
<li>Set Features ReadMimeType to false as Object.MimeType not supported
(Nick Craig-Wood)</li>
<li>Make malformed_path errors from too long files not retriable (Nick
Craig-Wood)</li>
<li>Test file name length before upload to fix upload loop (Nick
Craig-Wood)</li>
</ul></li>
<li>Fichier
<ul>
<li>Set Features ReadMimeType to true as Object.MimeType is supported
(Nick Craig-Wood)</li>
</ul></li>
<li>FTP
<ul>
<li>Add <code>--ftp-disable-msld</code> option to ignore MLSD for really
old servers (Nick Craig-Wood)</li>
<li>Make <code>--tpslimit apply</code> (Nick Craig-Wood)</li>
</ul></li>
<li>Google Cloud Storage
<ul>
<li>Storage class object header support (Laurens Janssen)</li>
<li>Fix anonymous client to use rclone’s HTTP client (Nick
Craig-Wood)</li>
<li>Fix
<code>Entry doesn't belong in directory "" (same as directory) - ignoring</code>
(Nick Craig-Wood)</li>
</ul></li>
<li>Googlephotos
<ul>
<li>New flag <code>--gphotos-include-archived</code> to show archived
photos as well (Nicolas Rueff)</li>
</ul></li>
<li>Jottacloud
<ul>
<li>Don’t erroneously report support for writing mime types
(buengese)</li>
<li>Add support for Telia Cloud (Patrik Nordlén)</li>
</ul></li>
<li>Mailru
<ul>
<li>Accept special folders eg camera-upload (Ivan Andreev)</li>
<li>Avoid prehashing of large local files (Ivan Andreev)</li>
<li>Fix uploads after recent changes on server (Ivan Andreev)</li>
<li>Fix range requests after June 2020 changes on server (Ivan
Andreev)</li>
<li>Fix invalid timestamp on corrupted files (fixes) (Ivan Andreev)</li>
<li>Remove deprecated protocol quirks (Ivan Andreev)</li>
</ul></li>
<li>Memory
<ul>
<li>Fix setting of mime types (Nick Craig-Wood)</li>
</ul></li>
<li>Onedrive
<ul>
<li>Add support for China region operated by 21vianet and other regional
suppliers (NyaMisty)</li>
<li>Warn on gateway timeout errors (Nick Craig-Wood)</li>
<li>Fall back to normal copy if server-side copy unavailable (Alex
Chen)</li>
<li>Fix server-side copy completely disabled on OneDrive for Business
(Cnly)</li>
<li>(business only) workaround to replace existing file on server-side
copy (Alex Chen)</li>
<li>Enhance link creation with expiry, scope, type and password (Nick
Craig-Wood)</li>
<li>Remove % and # from the set of encoded characters (Alex Chen)</li>
<li>Support addressing site by server-relative URL (kice)</li>
</ul></li>
<li>Opendrive
<ul>
<li>Fix finding directories in a case insensitive way (Nick
Craig-Wood)</li>
</ul></li>
<li>Pcloud
<ul>
<li>Fix setting of mime types (Nick Craig-Wood)</li>
</ul></li>
<li>Premiumizeme
<ul>
<li>Fix finding directories in a case insensitive way (Nick
Craig-Wood)</li>
</ul></li>
<li>Qingstor
<ul>
<li>Fix error propagation in CleanUp (Nick Craig-Wood)</li>
<li>Fix rclone cleanup (Nick Craig-Wood)</li>
</ul></li>
<li>S3
<ul>
<li>Added <code>--s3-disable-http2</code> to disable http/2 (Anagh Kumar
Baranwal)</li>
<li>Complete SSE-C implementation (Nick Craig-Wood)
<ul>
<li>Fix hashes on small files with AWS:KMS and SSE-C (Nick
Craig-Wood)</li>
<li>Add MD5 metadata to objects uploaded with SSE-AWS/SSE-C (Nick
Craig-Wood)</li>
</ul></li>
<li>Add <code>--s3-no-head parameter</code> to minimise transactions on
upload (Nick Craig-Wood)</li>
<li>Update docs with a Reducing Costs section (Nick Craig-Wood)</li>
<li>Added error handling for error code 429 indicating too many requests
(Anagh Kumar Baranwal)</li>
<li>Add requester pays option (kelv)</li>
<li>Fix copy multipart with v2 auth failing with ‘SignatureDoesNotMatch’
(Louis Koo)</li>
</ul></li>
<li>SFTP
<ul>
<li>Allow cert based auth via optional pubkey (Stephen Harris)</li>
<li>Allow user to optionally check server hosts key to add security
(Stephen Harris)</li>
<li>Defer asking for user passwords until the SSH connection succeeds
(Stephen Harris)</li>
<li>Remember entered password in AskPass mode (Stephen Harris)</li>
<li>Implement Shutdown method (Nick Craig-Wood)</li>
<li>Implement keyboard interactive authentication (Nick Craig-Wood)</li>
<li>Make <code>--tpslimit</code> apply (Nick Craig-Wood)</li>
<li>Implement <code>--sftp-use-fstat</code> for unusual SFTP servers
(Nick Craig-Wood)</li>
</ul></li>
<li>Sugarsync
<ul>
<li>Fix NewObject for files that differ in case (Nick Craig-Wood)</li>
<li>Fix finding directories in a case insensitive way (Nick
Craig-Wood)</li>
</ul></li>
<li>Swift
<ul>
<li>Fix deletion of parts of Static Large Object (SLO) (Nguyễn Hữu
Luân)</li>
<li>Ensure partially uploaded large files are uploaded unless
<code>--swift-leave-parts-on-error</code> (Nguyễn Hữu Luân)</li>
</ul></li>
<li>Tardigrade
<ul>
<li>Upgrade to uplink v1.4.1 (Caleb Case)</li>
</ul></li>
<li>WebDAV
<ul>
<li>Updated docs to show streaming to nextcloud is working (Durval
Menezes)</li>
</ul></li>
<li>Yandex
<ul>
<li>Set Features WriteMimeType to false as Yandex ignores mime types
(Nick Craig-Wood)</li>
</ul></li>
</ul>
<h2 id="v1.53.4---2021-01-20">v1.53.4 - 2021-01-20</h2>
<p><a
href="https://github.com/rclone/rclone/compare/v1.53.3...v1.53.4">See
commits</a></p>
<ul>
<li>Bug Fixes
<ul>
<li>accounting: Fix data race in Transferred() (Maciej Zimnoch)</li>
<li>build
<ul>
<li>Stop tagged releases making a current beta (Nick Craig-Wood)</li>
<li>Upgrade docker buildx action (Matteo Pietro Dazzi)</li>
<li>Add -buildmode to cross-compile.go (Nick Craig-Wood)</li>
<li>Fix docker build by upgrading ilteoood/docker_buildx (Nick
Craig-Wood)</li>
<li>Revert GitHub actions brew fix since this is now fixed (Nick
Craig-Wood)</li>
<li>Fix brew install –cask syntax for macOS build (Nick Craig-Wood)</li>
<li>Update nfpm syntax to fix build of .deb/.rpm packages (Nick
Craig-Wood)</li>
<li>Fix for Windows build errors (Ivan Andreev)</li>
</ul></li>
<li>fs: Parseduration: fixed tests to use UTC time (Ankur Gupta)</li>
<li>fshttp: Prevent overlap of HTTP headers in logs (Nathan
Collins)</li>
<li>rc
<ul>
<li>Fix core/command giving 500 internal error (Nick Craig-Wood)</li>
<li>Add Copy method to rc.Params (Nick Craig-Wood)</li>
<li>Fix 500 error when marshalling errors from core/command (Nick
Craig-Wood)</li>
<li>plugins: Create plugins files only if webui is enabled.
(negative0)</li>
</ul></li>
<li>serve http: Fix serving files of unknown length (Nick
Craig-Wood)</li>
<li>serve sftp: Fix authentication on one connection blocking others
(Nick Craig-Wood)</li>
</ul></li>
<li>Mount
<ul>
<li>Add optional <code>brew</code> tag to throw an error when using
mount in the binaries installed via Homebrew (Anagh Kumar Baranwal)</li>
<li>Add “.” and “..” to directories to match cmount and expectations
(Nick Craig-Wood)</li>
</ul></li>
<li>VFS
<ul>
<li>Make cache dir absolute before using it to fix path too long errors
(Nick Craig-Wood)</li>
</ul></li>
<li>Chunker
<ul>
<li>Improve detection of incompatible metadata (Ivan Andreev)</li>
</ul></li>
<li>Google Cloud Storage
<ul>
<li>Fix server side copy of large objects (Nick Craig-Wood)</li>
</ul></li>
<li>Jottacloud
<ul>
<li>Fix token renewer to fix long uploads (Nick Craig-Wood)</li>
<li>Fix token refresh failed: is not a regular file error (Nick
Craig-Wood)</li>
</ul></li>
<li>Pcloud
<ul>
<li>Only use SHA1 hashes in EU region (Nick Craig-Wood)</li>
</ul></li>
<li>Sharefile
<ul>
<li>Undo Fix backend due to API swapping integers for strings (Nick
Craig-Wood)</li>
</ul></li>
<li>WebDAV
<ul>
<li>Fix Open Range requests to fix 4shared mount (Nick Craig-Wood)</li>
<li>Add “Depth: 0” to GET requests to fix bitrix (Nick Craig-Wood)</li>
</ul></li>
</ul>
<h2 id="v1.53.3---2020-11-19">v1.53.3 - 2020-11-19</h2>
<p><a
href="https://github.com/rclone/rclone/compare/v1.53.2...v1.53.3">See
commits</a></p>
<ul>
<li>Bug Fixes
<ul>
<li>random: Fix incorrect use of math/rand instead of crypto/rand
CVE-2020-28924 (Nick Craig-Wood)
<ul>
<li>Passwords you have generated with <code>rclone config</code> may be
insecure</li>
<li>See <a href="https://github.com/rclone/rclone/issues/4783">issue
#4783</a> for more details and a checking tool</li>
</ul></li>
<li>random: Seed math/rand in one place with crypto strong seed (Nick
Craig-Wood)</li>
</ul></li>
<li>VFS
<ul>
<li>Fix vfs/refresh calls with fs= parameter (Nick Craig-Wood)</li>
</ul></li>
<li>Sharefile
<ul>
<li>Fix backend due to API swapping integers for strings (Nick
Craig-Wood)</li>
</ul></li>
</ul>
<h2 id="v1.53.2---2020-10-26">v1.53.2 - 2020-10-26</h2>
<p><a
href="https://github.com/rclone/rclone/compare/v1.53.1...v1.53.2">See
commits</a></p>
<ul>
<li>Bug Fixes
<ul>
<li>accounting
<ul>
<li>Fix incorrect speed and transferTime in core/stats (Nick
Craig-Wood)</li>
<li>Stabilize display order of transfers on Windows (Nick
Craig-Wood)</li>
</ul></li>
<li>operations
<ul>
<li>Fix use of –suffix without –backup-dir (Nick Craig-Wood)</li>
<li>Fix spurious “–checksum is in use but the source and destination
have no hashes in common” (Nick Craig-Wood)</li>
</ul></li>
<li>build
<ul>
<li>Work around GitHub actions brew problem (Nick Craig-Wood)</li>
<li>Stop using set-env and set-path in the GitHub actions (Nick
Craig-Wood)</li>
</ul></li>
</ul></li>
<li>Mount
<ul>
<li>mount2: Fix the swapped UID / GID values (Russell Cattelan)</li>
</ul></li>
<li>VFS
<ul>
<li>Detect and recover from a file being removed externally from the
cache (Nick Craig-Wood)</li>
<li>Fix a deadlock vulnerability in downloaders.Close (Leo Luan)</li>
<li>Fix a race condition in retryFailedResets (Leo Luan)</li>
<li>Fix missed concurrency control between some item operations and
reset (Leo Luan)</li>
<li>Add exponential backoff during ENOSPC retries (Leo Luan)</li>
<li>Add a missed update of used cache space (Leo Luan)</li>
<li>Fix –no-modtime to not attempt to set modtimes (as documented) (Nick
Craig-Wood)</li>
</ul></li>
<li>Local
<ul>
<li>Fix sizes and syncing with –links option on Windows (Nick
Craig-Wood)</li>
</ul></li>
<li>Chunker
<ul>
<li>Disable ListR to fix missing files on GDrive (workaround) (Ivan
Andreev)</li>
<li>Fix upload over crypt (Ivan Andreev)</li>
</ul></li>
<li>Fichier
<ul>
<li>Increase maximum file size from 100GB to 300GB (gyutw)</li>
</ul></li>
<li>Jottacloud
<ul>
<li>Remove clientSecret from config when upgrading to token based
authentication (buengese)</li>
<li>Avoid double url escaping of device/mountpoint (albertony)</li>
<li>Remove DirMove workaround as it’s not required anymore - also
(buengese)</li>
</ul></li>
<li>Mailru
<ul>
<li>Fix uploads after recent changes on server (Ivan Andreev)</li>
<li>Fix range requests after june changes on server (Ivan Andreev)</li>
<li>Fix invalid timestamp on corrupted files (fixes) (Ivan Andreev)</li>
</ul></li>
<li>Onedrive
<ul>
<li>Fix disk usage for sharepoint (Nick Craig-Wood)</li>
</ul></li>
<li>S3
<ul>
<li>Add missing regions for AWS (Anagh Kumar Baranwal)</li>
</ul></li>
<li>Seafile
<ul>
<li>Fix accessing libraries &gt; 2GB on 32 bit systems (Muffin
King)</li>
</ul></li>
<li>SFTP
<ul>
<li>Always convert the checksum to lower case (buengese)</li>
</ul></li>
<li>Union
<ul>
<li>Create root directories if none exist (Nick Craig-Wood)</li>
</ul></li>
</ul>
<h2 id="v1.53.1---2020-09-13">v1.53.1 - 2020-09-13</h2>
<p><a
href="https://github.com/rclone/rclone/compare/v1.53.0...v1.53.1">See
commits</a></p>
<ul>
<li>Bug Fixes
<ul>
<li>accounting: Remove new line from end of –stats-one-line display
(Nick Craig-Wood)</li>
<li>check
<ul>
<li>Add back missing –download flag (Nick Craig-Wood)</li>
<li>Fix docs (Nick Craig-Wood)</li>
</ul></li>
<li>docs
<ul>
<li>Note –log-file does append (Nick Craig-Wood)</li>
<li>Add full stops for consistency in rclone –help (edwardxml)</li>
<li>Add Tencent COS to s3 provider list (wjielai)</li>
<li>Updated mount command to reflect that it requires Go 1.13 or newer
(Evan Harris)</li>
<li>jottacloud: Mention that uploads from local disk will not need to
cache files to disk for md5 calculation (albertony)</li>
<li>Fix formatting of rc docs page (Nick Craig-Wood)</li>
</ul></li>
<li>build
<ul>
<li>Include vendor tar ball in release and fix startdev (Nick
Craig-Wood)</li>
<li>Fix “Illegal instruction” error for ARMv6 builds (Nick
Craig-Wood)</li>
<li>Fix architecture name in ARMv7 build (Nick Craig-Wood)</li>
</ul></li>
</ul></li>
<li>VFS
<ul>
<li>Fix spurious error “vfs cache: failed to _ensure cache EOF” (Nick
Craig-Wood)</li>
<li>Log an ERROR if we fail to set the file to be sparse (Nick
Craig-Wood)</li>
</ul></li>
<li>Local
<ul>
<li>Log an ERROR if we fail to set the file to be sparse (Nick
Craig-Wood)</li>
</ul></li>
<li>Drive
<ul>
<li>Re-adds special oauth help text (Tim Gallant)</li>
</ul></li>
<li>Opendrive
<ul>
<li>Do not retry 400 errors (Evan Harris)</li>
</ul></li>
</ul>
<h2 id="v1.53.0---2020-09-02">v1.53.0 - 2020-09-02</h2>
<p><a
href="https://github.com/rclone/rclone/compare/v1.52.0...v1.53.0">See
commits</a></p>
<ul>
<li>New Features
<ul>
<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>
<li>Interactive mode <a
href="https://rclone.org/docs/#interactive">-i/–interactive</a> for
destructive operations (fishbullet)</li>
<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>
<li>Transfers are sorted by start time in the stats and progress output
(Max Sum)</li>
<li>Make sure backends expand <code>~</code> and environment vars in
file names they use (Nick Craig-Wood)</li>
<li>Add <a
href="https://rclone.org/docs/#refresh-times">–refresh-times</a> flag to
set modtimes on hashless backends (Nick Craig-Wood)</li>
<li>build
<ul>
<li>Remove vendor directory in favour of Go modules (Nick
Craig-Wood)</li>
<li>Build with go1.15.x by default (Nick Craig-Wood)</li>
<li>Drop macOS 386 build as it is no longer supported by go1.15 (Nick
Craig-Wood)</li>
<li>Add ARMv7 to the supported builds (Nick Craig-Wood)</li>
<li>Enable <code>rclone cmount</code> on macOS (Nick Craig-Wood)</li>
<li>Make rclone build with gccgo (Nick Craig-Wood)</li>
<li>Make rclone build with wasm (Nick Craig-Wood)</li>
<li>Change beta numbering to be semver compatible (Nick Craig-Wood)</li>
<li>Add file properties and icon to Windows executable (albertony)</li>
<li>Add experimental interface for integrating rclone into browsers
(Nick Craig-Wood)</li>
</ul></li>
<li>lib: Add file name compression (Klaus Post)</li>
<li>rc
<ul>
<li>Allow installation and use of plugins and test plugins with
rclone-webui (Chaitanya Bankanhal)</li>
<li>Add reverse proxy pluginsHandler for serving plugins (Chaitanya
Bankanhal)</li>
<li>Add <code>mount/listmounts</code> option for listing current mounts
(Chaitanya Bankanhal)</li>
<li>Add <code>operations/uploadfile</code> to upload a file through rc
using encoding multipart/form-data (Chaitanya Bankanhal)</li>
<li>Add <code>core/command</code> to execute rclone terminal commands.
(Chaitanya Bankanhal)</li>
</ul></li>
<li><code>rclone check</code>
<ul>
<li>Add reporting of filenames for same/missing/changed (Nick
Craig-Wood)</li>
<li>Make check command obey
<code>--dry-run</code>/<code>-i</code>/<code>--interactive</code> (Nick
Craig-Wood)</li>
<li>Make check do <code>--checkers</code> files concurrently (Nick
Craig-Wood)</li>
<li>Retry downloads if they fail when using the <code>--download</code>
flag (Nick Craig-Wood)</li>
<li>Make it show stats by default (Nick Craig-Wood)</li>
</ul></li>
<li><code>rclone obscure</code>: Allow obscure command to accept
password on STDIN (David Ibarra)</li>
<li><code>rclone config</code>
<ul>
<li>Set RCLONE_CONFIG_DIR for use in config files and subprocesses (Nick
Craig-Wood)</li>
<li>Reject remote names starting with a dash. (jtagcat)</li>
</ul></li>
<li><code>rclone cryptcheck</code>: Add reporting of filenames for
same/missing/changed (Nick Craig-Wood)</li>
<li><code>rclone dedupe</code>: Make it obey the
<code>--size-only</code> flag for duplicate detection (Nick
Craig-Wood)</li>
<li><code>rclone link</code>: Add <code>--expire</code> and
<code>--unlink</code> flags (Roman Kredentser)</li>
<li><code>rclone mkdir</code>: Warn when using mkdir on remotes which
can’t have empty directories (Nick Craig-Wood)</li>
<li><code>rclone rc</code>: Allow JSON parameters to simplify command
line usage (Nick Craig-Wood)</li>
<li><code>rclone serve ftp</code>
<ul>
<li>Don’t compile on &lt; go1.13 after dependency update (Nick
Craig-Wood)</li>
<li>Add error message if auth proxy fails (Nick Craig-Wood)</li>
<li>Use refactored goftp.io/server library for binary shrink (Nick
Craig-Wood)</li>
</ul></li>
<li><code>rclone serve restic</code>: Expose interfaces so that rclone
can be used as a library from within restic (Jack)</li>
<li><code>rclone sync</code>: Add
<code>--track-renames-strategy leaf</code> (Nick Craig-Wood)</li>
<li><code>rclone touch</code>: Add ability to set nanosecond resolution
times (Nick Craig-Wood)</li>
<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>
</ul></li>
<li>Bug Fixes
<ul>
<li>accounting
<ul>
<li>Fix documentation for <code>speed</code>/<code>speedAvg</code> (Nick
Craig-Wood)</li>
<li>Fix elapsed time not show actual time since beginning (Chaitanya
Bankanhal)</li>
<li>Fix deadlock in stats printing (Nick Craig-Wood)</li>
</ul></li>
<li>build
<ul>
<li>Fix file handle leak in GitHub release tool (Garrett Squire)</li>
</ul></li>
<li><code>rclone check</code>: Fix successful retries with
<code>--download</code> counting errors (Nick Craig-Wood)</li>
<li><code>rclone dedupe</code>: Fix logging to be easier to understand
(Nick Craig-Wood)</li>
</ul></li>
<li>Mount
<ul>
<li>Warn macOS users that mount implementation is changing (Nick
Craig-Wood)
<ul>
<li>to test the new implementation use <code>rclone cmount</code>
instead of <code>rclone mount</code></li>
<li>this is because the library rclone uses has dropped macOS
support</li>
</ul></li>
<li>rc interface
<ul>
<li>Add call for unmount all (Chaitanya Bankanhal)</li>
<li>Make <code>mount/mount</code> remote control take vfsOpt option
(Nick Craig-Wood)</li>
<li>Add mountOpt to <code>mount/mount</code> (Nick Craig-Wood)</li>
<li>Add VFS and Mount options to <code>mount/listmounts</code> (Nick
Craig-Wood)</li>
</ul></li>
<li>Catch panics in cgofuse initialization and turn into error messages
(Nick Craig-Wood)</li>
<li>Always supply stat information in Readdir (Nick Craig-Wood)</li>
<li>Add support for reading unknown length files using direct IO
(Windows) (Nick Craig-Wood)</li>
<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>
<li>Fix macOS losing directory contents in cmount (Nick Craig-Wood)</li>
<li>Fix volume name broken in recent refactor (Nick Craig-Wood)</li>
</ul></li>
<li>VFS
<ul>
<li>Implement partial reads for <code>--vfs-cache-mode full</code> (Nick
Craig-Wood)</li>
<li>Add <code>--vfs-writeback</code> option to delay writes back to
cloud storage (Nick Craig-Wood)</li>
<li>Add <code>--vfs-read-ahead</code> parameter for use with
<code>--vfs-cache-mode full</code> (Nick Craig-Wood)</li>
<li>Restart pending uploads on restart of the cache (Nick
Craig-Wood)</li>
<li>Support synchronous cache space recovery upon ENOSPC (Leo Luan)</li>
<li>Allow ReadAt and WriteAt to run concurrently with themselves (Nick
Craig-Wood)</li>
<li>Change modtime of file before upload to current (Rob Calistri)</li>
<li>Recommend <code>--vfs-cache-modes writes</code> on backends which
can’t stream (Nick Craig-Wood)</li>
<li>Add an optional <code>fs</code> parameter to vfs rc methods (Nick
Craig-Wood)</li>
<li>Fix errors when using &gt; 260 char files in the cache in Windows
(Nick Craig-Wood)</li>
<li>Fix renaming of items while they are being uploaded (Nick
Craig-Wood)</li>
<li>Fix very high load caused by slow directory listings (Nick
Craig-Wood)</li>
<li>Fix renamed files not being uploaded with
<code>--vfs-cache-mode minimal</code> (Nick Craig-Wood)</li>
<li>Fix directory locking caused by slow directory listings (Nick
Craig-Wood)</li>
<li>Fix saving from chrome without <code>--vfs-cache-mode writes</code>
(Nick Craig-Wood)</li>
</ul></li>
<li>Local
<ul>
<li>Add <code>--local-no-updated</code> to provide a consistent view of
changing objects (Nick Craig-Wood)</li>
<li>Add <code>--local-no-set-modtime</code> option to prevent modtime
changes (tyhuber1)</li>
<li>Fix race conditions updating and reading Object metadata (Nick
Craig-Wood)</li>
</ul></li>
<li>Cache
<ul>
<li>Make any created backends be cached to fix rc problems (Nick
Craig-Wood)</li>
<li>Fix dedupe on caches wrapping drives (Nick Craig-Wood)</li>
</ul></li>
<li>Crypt
<ul>
<li>Add <code>--crypt-server-side-across-configs</code> flag (Nick
Craig-Wood)</li>
<li>Make any created backends be cached to fix rc problems (Nick
Craig-Wood)</li>
</ul></li>
<li>Alias
<ul>
<li>Make any created backends be cached to fix rc problems (Nick
Craig-Wood)</li>
</ul></li>
<li>Azure Blob
<ul>
<li>Don’t compile on &lt; go1.13 after dependency update (Nick
Craig-Wood)</li>
</ul></li>
<li>B2
<ul>
<li>Implement server-side copy for files &gt; 5GB (Nick Craig-Wood)</li>
<li>Cancel in progress multipart uploads and copies on rclone exit (Nick
Craig-Wood)</li>
<li>Note that b2’s encoding now allows  but rclone’s hasn’t changed
(Nick Craig-Wood)</li>
<li>Fix transfers when using download_url (Nick Craig-Wood)</li>
</ul></li>
<li>Box
<ul>
<li>Implement rclone cleanup (buengese)</li>
<li>Cancel in progress multipart uploads and copies on rclone exit (Nick
Craig-Wood)</li>
<li>Allow authentication with access token (David)</li>
</ul></li>
<li>Chunker
<ul>
<li>Make any created backends be cached to fix rc problems (Nick
Craig-Wood)</li>
</ul></li>
<li>Drive
<ul>
<li>Add <code>rclone backend drives</code> to list shared drives
(teamdrives) (Nick Craig-Wood)</li>
<li>Implement <code>rclone backend untrash</code> (Nick Craig-Wood)</li>
<li>Work around drive bug which didn’t set modtime of copied docs (Nick
Craig-Wood)</li>
<li>Added <code>--drive-starred-only</code> to only show starred files
(Jay McEntire)</li>
<li>Deprecate <code>--drive-alternate-export</code> as it is no longer
needed (themylogin)</li>
<li>Fix duplication of Google docs on server-side copy (Nick
Craig-Wood)</li>
<li>Fix “panic: send on closed channel” when recycling dir entries (Nick
Craig-Wood)</li>
</ul></li>
<li>Dropbox
<ul>
<li>Add copyright detector info in limitations section in the docs (Alex
Guerrero)</li>
<li>Fix <code>rclone link</code> by removing expires parameter (Nick
Craig-Wood)</li>
</ul></li>
<li>Fichier
<ul>
<li>Detect Flood detected: IP Locked error and sleep for 30s (Nick
Craig-Wood)</li>
</ul></li>
<li>FTP
<ul>
<li>Add explicit TLS support (Heiko Bornholdt)</li>
<li>Add support for <code>--dump bodies</code> and
<code>--dump auth</code> for debugging (Nick Craig-Wood)</li>
<li>Fix interoperation with pure-ftpd (Nick Craig-Wood)</li>
</ul></li>
<li>Google Cloud Storage
<ul>
<li>Add support for anonymous access (Kai Lüke)</li>
</ul></li>
<li>Jottacloud
<ul>
<li>Bring back legacy authentication for use with whitelabel versions
(buengese)</li>
<li>Switch to new api root - also implement a very ugly workaround for
the DirMove failures (buengese)</li>
</ul></li>
<li>Onedrive
<ul>
<li>Rework cancel of multipart uploads on rclone exit (Nick
Craig-Wood)</li>
<li>Implement rclone cleanup (Nick Craig-Wood)</li>
<li>Add <code>--onedrive-no-versions</code> flag to remove old versions
(Nick Craig-Wood)</li>
</ul></li>
<li>Pcloud
<ul>
<li>Implement <code>rclone link</code> for public link creation
(buengese)</li>
</ul></li>
<li>Qingstor
<ul>
<li>Cancel in progress multipart uploads on rclone exit (Nick
Craig-Wood)</li>
</ul></li>
<li>S3
<ul>
<li>Preserve metadata when doing multipart copy (Nick Craig-Wood)</li>
<li>Cancel in progress multipart uploads and copies on rclone exit (Nick
Craig-Wood)</li>
<li>Add <code>rclone link</code> for public link sharing (Roman
Kredentser)</li>
<li>Add <code>rclone backend restore</code> command to restore objects
from GLACIER (Nick Craig-Wood)</li>
<li>Add <code>rclone cleanup</code> and
<code>rclone backend cleanup</code> to clean unfinished multipart
uploads (Nick Craig-Wood)</li>
<li>Add <code>rclone backend list-multipart-uploads</code> to list
unfinished multipart uploads (Nick Craig-Wood)</li>
<li>Add <code>--s3-max-upload-parts</code> support (Kamil
Trzciński)</li>
<li>Add <code>--s3-no-check-bucket</code> for minimising rclone
transactions and perms (Nick Craig-Wood)</li>
<li>Add <code>--s3-profile</code> and
<code>--s3-shared-credentials-file</code> options (Nick Craig-Wood)</li>
<li>Use regional s3 us-east-1 endpoint (David)</li>
<li>Add Scaleway provider (Vincent Feltz)</li>
<li>Update IBM COS endpoints (Egor Margineanu)</li>
<li>Reduce the default <code>--s3-copy-cutoff</code> to &lt; 5GB for
Backblaze S3 compatibility (Nick Craig-Wood)</li>
<li>Fix detection of bucket existing (Nick Craig-Wood)</li>
</ul></li>
<li>SFTP
<ul>
<li>Use the absolute path instead of the relative path for listing for
improved compatibility (Nick Craig-Wood)</li>
<li>Add <code>--sftp-subsystem</code> and
<code>--sftp-server-command</code> options (aus)</li>
</ul></li>
<li>Swift
<ul>
<li>Fix dangling large objects breaking the listing (Nick
Craig-Wood)</li>
<li>Fix purge not deleting directory markers (Nick Craig-Wood)</li>
<li>Fix update multipart object removing all of its own parts (Nick
Craig-Wood)</li>
<li>Fix missing hash from object returned from upload (Nick
Craig-Wood)</li>
</ul></li>
<li>Tardigrade
<ul>
<li>Upgrade to uplink v1.2.0 (Kaloyan Raev)</li>
</ul></li>
<li>Union
<ul>
<li>Fix writing with the all policy (Nick Craig-Wood)</li>
</ul></li>
<li>WebDAV
<ul>
<li>Fix directory creation with 4shared (Nick Craig-Wood)</li>
</ul></li>
</ul>
<h2 id="v1.52.3---2020-08-07">v1.52.3 - 2020-08-07</h2>
<p><a
href="https://github.com/rclone/rclone/compare/v1.52.2...v1.52.3">See
commits</a></p>
<ul>
<li>Bug Fixes
<ul>
<li>docs
<ul>
<li>Disable smart typography (e.g. en-dash) in MANUAL.* and man page
(Nick Craig-Wood)</li>
<li>Update install.md to reflect minimum Go version (Evan Harris)</li>
<li>Update install from source instructions (Nick Craig-Wood)</li>
<li>make_manual: Support SOURCE_DATE_EPOCH (Morten Linderud)</li>
</ul></li>
<li>log: Fix –use-json-log going to stderr not –log-file on Windows
(Nick Craig-Wood)</li>
<li>serve dlna: Fix file list on Samsung Series 6+ TVs (Matteo Pietro
Dazzi)</li>
<li>sync: Fix deadlock with –track-renames-strategy modtime (Nick
Craig-Wood)</li>
</ul></li>
<li>Cache
<ul>
<li>Fix moveto/copyto remote:file remote:file2 (Nick Craig-Wood)</li>
</ul></li>
<li>Drive
<ul>
<li>Stop using root_folder_id as a cache (Nick Craig-Wood)</li>
<li>Make dangling shortcuts appear in listings (Nick Craig-Wood)</li>
<li>Drop “Disabling ListR” messages down to debug (Nick Craig-Wood)</li>
<li>Workaround and policy for Google Drive API (Dmitry Ustalov)</li>
</ul></li>
<li>FTP
<ul>
<li>Add note to docs about home vs root directory selection (Nick
Craig-Wood)</li>
</ul></li>
<li>Onedrive
<ul>
<li>Fix reverting to Copy when Move would have worked (Nick
Craig-Wood)</li>
<li>Avoid comma rendered in URL in onedrive.md (Kevin)</li>
</ul></li>
<li>Pcloud
<ul>
<li>Fix oauth on European region “eapi.pcloud.com” (Nick
Craig-Wood)</li>
</ul></li>
<li>S3
<ul>
<li>Fix bucket Region auto detection when Region unset in config (Nick
Craig-Wood)</li>
</ul></li>
</ul>
<h2 id="v1.52.2---2020-06-24">v1.52.2 - 2020-06-24</h2>
<p><a
href="https://github.com/rclone/rclone/compare/v1.52.1...v1.52.2">See
commits</a></p>
<ul>
<li>Bug Fixes
<ul>
<li>build
<ul>
<li>Fix docker release build action (Nick Craig-Wood)</li>
<li>Fix custom timezone in Docker image (NoLooseEnds)</li>
</ul></li>
<li>check: Fix misleading message which printed errors instead of
differences (Nick Craig-Wood)</li>
<li>errors: Add WSAECONNREFUSED and more to the list of retriable
Windows errors (Nick Craig-Wood)</li>
<li>rcd: Fix incorrect prometheus metrics (Gary Kim)</li>
<li>serve restic: Fix flags so they use environment variables (Nick
Craig-Wood)</li>
<li>serve webdav: Fix flags so they use environment variables (Nick
Craig-Wood)</li>
<li>sync: Fix –track-renames-strategy modtime (Nick Craig-Wood)</li>
</ul></li>
<li>Drive
<ul>
<li>Fix not being able to delete a directory with a trashed shortcut
(Nick Craig-Wood)</li>
<li>Fix creating a directory inside a shortcut (Nick Craig-Wood)</li>
<li>Fix –drive-impersonate with cached root_folder_id (Nick
Craig-Wood)</li>
</ul></li>
<li>SFTP
<ul>
<li>Fix SSH key PEM loading (Zac Rubin)</li>
</ul></li>
<li>Swift
<ul>
<li>Speed up deletes by not retrying segment container deletes (Nick
Craig-Wood)</li>
</ul></li>
<li>Tardigrade
<ul>
<li>Upgrade to uplink v1.1.1 (Caleb Case)</li>
</ul></li>
<li>WebDAV
<ul>
<li>Fix free/used display for rclone about/df for certain backends (Nick
Craig-Wood)</li>
</ul></li>
</ul>
<h2 id="v1.52.1---2020-06-10">v1.52.1 - 2020-06-10</h2>
<p><a
href="https://github.com/rclone/rclone/compare/v1.52.0...v1.52.1">See
commits</a></p>
<ul>
<li>Bug Fixes
<ul>
<li>lib/file: Fix SetSparse on Windows 7 which fixes downloads of files
&gt; 250MB (Nick Craig-Wood)</li>
<li>build
<ul>
<li>Update go.mod to go1.14 to enable -mod=vendor build (Nick
Craig-Wood)</li>
<li>Remove quicktest from Dockerfile (Nick Craig-Wood)</li>
<li>Build Docker images with GitHub actions (Matteo Pietro Dazzi)</li>
<li>Update Docker build workflows (Nick Craig-Wood)</li>
<li>Set user_allow_other in /etc/fuse.conf in the Docker image (Nick
Craig-Wood)</li>
<li>Fix xgo build after go1.14 go.mod update (Nick Craig-Wood)</li>
</ul></li>
<li>docs
<ul>
<li>Add link to source and modified time to footer of every page (Nick
Craig-Wood)</li>
<li>Remove manually set dates and use git dates instead (Nick
Craig-Wood)</li>
<li>Minor tense, punctuation, brevity and positivity changes for the
home page (edwardxml)</li>
<li>Remove leading slash in page reference in footer when present (Nick
Craig-Wood)</li>
<li>Note commands which need obscured input in the docs (Nick
Craig-Wood)</li>
<li>obscure: Write more help as we are referencing it elsewhere (Nick
Craig-Wood)</li>
</ul></li>
</ul></li>
<li>VFS
<ul>
<li>Fix OS vs Unix path confusion - fixes ChangeNotify on Windows (Nick
Craig-Wood)</li>
</ul></li>
<li>Drive
<ul>
<li>Fix missing items when listing using –fast-list / ListR (Nick
Craig-Wood)</li>
</ul></li>
<li>Putio
<ul>
<li>Fix panic on Object.Open (Cenk Alti)</li>
</ul></li>
<li>S3
<ul>
<li>Fix upload of single files into buckets without create permission
(Nick Craig-Wood)</li>
<li>Fix –header-upload (Nick Craig-Wood)</li>
</ul></li>
<li>Tardigrade
<ul>
<li>Fix listing bug by upgrading to v1.0.7</li>
<li>Set UserAgent to rclone (Caleb Case)</li>
</ul></li>
</ul>
<h2 id="v1.52.0---2020-05-27">v1.52.0 - 2020-05-27</h2>
<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>
<p><a
href="https://github.com/rclone/rclone/compare/v1.51.0...v1.52.0">See
commits</a></p>
<ul>
<li>New backends
<ul>
<li><a href="https://rclone.org/tardigrade/">Tardigrade</a> backend for
use with storj.io (Caleb Case)</li>
<li><a href="https://rclone.org/union/">Union</a> re-write to have
multiple writable remotes (Max Sum)</li>
<li><a href="/seafile">Seafile</a> for Seafile server (Fred <span
class="citation"
data-cites="creativeprojects">@creativeprojects</span>)</li>
</ul></li>
<li>New commands
<ul>
<li>backend: command for backend-specific commands (see backends) (Nick
Craig-Wood)</li>
<li>cachestats: Deprecate in favour of
<code>rclone backend stats cache:</code> (Nick Craig-Wood)</li>
<li>dbhashsum: Deprecate in favour of
<code>rclone hashsum DropboxHash</code> (Nick Craig-Wood)</li>
</ul></li>
<li>New Features
<ul>
<li>Add <code>--header-download</code> and <code>--header-upload</code>
flags for setting HTTP headers when uploading/downloading (Tim
Gallant)</li>
<li>Add <code>--header</code> flag to add HTTP headers to every HTTP
transaction (Nick Craig-Wood)</li>
<li>Add <code>--check-first</code> to do all checking before starting
transfers (Nick Craig-Wood)</li>
<li>Add <code>--track-renames-strategy</code> for configurable matching
criteria for <code>--track-renames</code> (Bernd Schoolmann)</li>
<li>Add <code>--cutoff-mode</code> hard,soft,cautious (Shing Kit Chan
&amp; Franklyn Tackitt)</li>
<li>Filter flags (e.g. <code>--files-from -</code>) can read from stdin
(fishbullet)</li>
<li>Add <code>--error-on-no-transfer</code> option (Jon Fautley)</li>
<li>Implement <code>--order-by xxx,mixed</code> for copying some small
and some big files (Nick Craig-Wood)</li>
<li>Allow <code>--max-backlog</code> to be negative meaning as large as
possible (Nick Craig-Wood)</li>
<li>Added <code>--no-unicode-normalization</code> flag to allow Unicode
filenames to remain unique (Ben Zenker)</li>
<li>Allow <code>--min-age</code>/<code>--max-age</code> to take a date
as well as a duration (Nick Craig-Wood)</li>
<li>Add rename statistics for file and directory renames (Nick
Craig-Wood)</li>
<li>Add statistics output to JSON log (reddi)</li>
<li>Make stats be printed on non-zero exit code (Nick Craig-Wood)</li>
<li>When running <code>--password-command</code> allow use of stdin
(Sébastien Gross)</li>
<li>Stop empty strings being a valid remote path (Nick Craig-Wood)</li>
<li>accounting: support WriterTo for less memory copying (Nick
Craig-Wood)</li>
<li>build
<ul>
<li>Update to use go1.14 for the build (Nick Craig-Wood)</li>
<li>Add <code>-trimpath</code> to release build for reproduceable builds
(Nick Craig-Wood)</li>
<li>Remove GOOS and GOARCH from Dockerfile (Brandon Philips)</li>
</ul></li>
<li>config
<ul>
<li>Fsync the config file after writing to save more reliably (Nick
Craig-Wood)</li>
<li>Add <code>--obscure</code> and <code>--no-obscure</code> flags to
<code>config create</code>/<code>update</code> (Nick Craig-Wood)</li>
<li>Make <code>config show</code> take <code>remote:</code> as well as
<code>remote</code> (Nick Craig-Wood)</li>
</ul></li>
<li>copyurl: Add <code>--no-clobber</code> flag (Denis)</li>
<li>delete: Added <code>--rmdirs</code> flag to delete directories as
well (Kush)</li>
<li>filter: Added <code>--files-from-raw</code> flag (Ankur Gupta)</li>
<li>genautocomplete: Add support for fish shell (Matan Rosenberg)</li>
<li>log: Add support for syslog LOCAL facilities (Patryk Jakuszew)</li>
<li>lsjson: Add <code>--hash-type</code> parameter and use it in lsf to
speed up hashing (Nick Craig-Wood)</li>
<li>rc
<ul>
<li>Add <code>-o</code>/<code>--opt</code> and
<code>-a</code>/<code>--arg</code> for more structured input (Nick
Craig-Wood)</li>
<li>Implement <code>backend/command</code> for running backend-specific
commands remotely (Nick Craig-Wood)</li>
<li>Add <code>mount/mount</code> command for starting
<code>rclone mount</code> via the API (Chaitanya)</li>
</ul></li>
<li>rcd: Add Prometheus metrics support (Gary Kim)</li>
<li>serve http
<ul>
<li>Added a <code>--template</code> flag for user defined markup
(calistri)</li>
<li>Add Last-Modified headers to files and directories (Nick
Craig-Wood)</li>
</ul></li>
<li>serve sftp: Add support for multiple host keys by repeating
<code>--key</code> flag (Maxime Suret)</li>
<li>touch: Add <code>--localtime</code> flag to make
<code>--timestamp</code> localtime not UTC (Nick Craig-Wood)</li>
</ul></li>
<li>Bug Fixes
<ul>
<li>accounting
<ul>
<li>Restore “Max number of stats groups reached” log line (Michał
Matczuk)</li>
<li>Correct exitcode on Transfer Limit Exceeded flag. (Anuar
Serdaliyev)</li>
<li>Reset bytes read during copy retry (Ankur Gupta)</li>
<li>Fix race clearing stats (Nick Craig-Wood)</li>
</ul></li>
<li>copy: Only create empty directories when they don’t exist on the
remote (Ishuah Kariuki)</li>
<li>dedupe: Stop dedupe deleting files with identical IDs (Nick
Craig-Wood)</li>
<li>oauth
<ul>
<li>Use custom http client so that <code>--no-check-certificate</code>
is honored by oauth token fetch (Mark Spieth)</li>
<li>Replace deprecated oauth2.NoContext (Lars Lehtonen)</li>
</ul></li>
<li>operations
<ul>
<li>Fix setting the timestamp on Windows for multithread copy (Nick
Craig-Wood)</li>
<li>Make rcat obey <code>--ignore-checksum</code> (Nick Craig-Wood)</li>
<li>Make <code>--max-transfer</code> more accurate (Nick
Craig-Wood)</li>
</ul></li>
<li>rc
<ul>
<li>Fix dropped error (Lars Lehtonen)</li>
<li>Fix misplaced http server config (Xiaoxing Ye)</li>
<li>Disable duplicate log (ElonH)</li>
</ul></li>
<li>serve dlna
<ul>
<li>Cds: don’t specify childCount at all when unknown (Dan Walters)</li>
<li>Cds: use modification time as date in dlna metadata (Dan
Walters)</li>
</ul></li>
<li>serve restic: Fix tests after restic project removed vendoring (Nick
Craig-Wood)</li>
<li>sync
<ul>
<li>Fix incorrect “nothing to transfer” message using
<code>--delete-before</code> (Nick Craig-Wood)</li>
<li>Only create empty directories when they don’t exist on the remote
(Ishuah Kariuki)</li>
</ul></li>
</ul></li>
<li>Mount
<ul>
<li>Add <code>--async-read</code> flag to disable asynchronous reads
(Nick Craig-Wood)</li>
<li>Ignore <code>--allow-root</code> flag with a warning as it has been
removed upstream (Nick Craig-Wood)</li>
<li>Warn if <code>--allow-non-empty</code> used on Windows and clarify
docs (Nick Craig-Wood)</li>
<li>Constrain to go1.13 or above otherwise bazil.org/fuse fails to
compile (Nick Craig-Wood)</li>
<li>Fix fail because of too long volume name (evileye)</li>
<li>Report 1PB free for unknown disk sizes (Nick Craig-Wood)</li>
<li>Map more rclone errors into file systems errors (Nick
Craig-Wood)</li>
<li>Fix disappearing cwd problem (Nick Craig-Wood)</li>
<li>Use ReaddirPlus on Windows to improve directory listing performance
(Nick Craig-Wood)</li>
<li>Send a hint as to whether the filesystem is case insensitive or not
(Nick Craig-Wood)</li>
<li>Add rc command <code>mount/types</code> (Nick Craig-Wood)</li>
<li>Change maximum leaf name length to 1024 bytes (Nick Craig-Wood)</li>
</ul></li>
<li>VFS
<ul>
<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>
<li>Change default <code>--vfs-read-wait</code> to 20ms (it was 5ms and
not configurable) (Nick Craig-Wood)</li>
<li>Make <code>df</code> output more consistent on a rclone mount. (Yves
G)</li>
<li>Report 1PB free for unknown disk sizes (Nick Craig-Wood)</li>
<li>Fix race condition caused by unlocked reading of Dir.path (Nick
Craig-Wood)</li>
<li>Make File lock and Dir lock not overlap to avoid deadlock (Nick
Craig-Wood)</li>
<li>Implement lock ordering between File and Dir to eliminate deadlocks
(Nick Craig-Wood)</li>
<li>Factor the vfs cache into its own package (Nick Craig-Wood)</li>
<li>Pin the Fs in use in the Fs cache (Nick Craig-Wood)</li>
<li>Add SetSys() methods to Node to allow caching stuff on a node (Nick
Craig-Wood)</li>
<li>Ignore file not found errors from Hash in Read.Release (Nick
Craig-Wood)</li>
<li>Fix hang in read wait code (Nick Craig-Wood)</li>
</ul></li>
<li>Local
<ul>
<li>Speed up multi thread downloads by using sparse files on Windows
(Nick Craig-Wood)</li>
<li>Implement <code>--local-no-sparse</code> flag for disabling sparse
files (Nick Craig-Wood)</li>
<li>Implement <code>rclone backend noop</code> for testing purposes
(Nick Craig-Wood)</li>
<li>Fix “file not found” errors on post transfer Hash calculation (Nick
Craig-Wood)</li>
</ul></li>
<li>Cache
<ul>
<li>Implement <code>rclone backend stats</code> command (Nick
Craig-Wood)</li>
<li>Fix Server Side Copy with Temp Upload (Brandon McNama)</li>
<li>Remove Unused Functions (Lars Lehtonen)</li>
<li>Disable race tests until bbolt is fixed (Nick Craig-Wood)</li>
<li>Move methods used for testing into test file (greatroar)</li>
<li>Add Pin and Unpin and canonicalised lookup (Nick Craig-Wood)</li>
<li>Use proper import path go.etcd.io/bbolt (Robert-André Mauchin)</li>
</ul></li>
<li>Crypt
<ul>
<li>Calculate hashes for uploads from local disk (Nick Craig-Wood)
<ul>
<li>This allows crypted Jottacloud uploads without using local disk</li>
<li>This means crypted s3/b2 uploads will now have hashes</li>
</ul></li>
<li>Added <code>rclone backend decode</code>/<code>encode</code>
commands to replicate functionality of <code>cryptdecode</code> (Anagh
Kumar Baranwal)</li>
<li>Get rid of the unused Cipher interface as it obfuscated the code
(Nick Craig-Wood)</li>
</ul></li>
<li>Azure Blob
<ul>
<li>Implement streaming of unknown sized files so <code>rcat</code> is
now supported (Nick Craig-Wood)</li>
<li>Implement memory pooling to control memory use (Nick
Craig-Wood)</li>
<li>Add <code>--azureblob-disable-checksum</code> flag (Nick
Craig-Wood)</li>
<li>Retry <code>InvalidBlobOrBlock</code> error as it may indicate block
concurrency problems (Nick Craig-Wood)</li>
<li>Remove unused <code>Object.parseTimeString()</code> (Lars
Lehtonen)</li>
<li>Fix permission error on SAS URL limited to container (Nick
Craig-Wood)</li>
</ul></li>
<li>B2
<ul>
<li>Add support for <code>--header-upload</code> and
<code>--header-download</code> (Tim Gallant)</li>
<li>Ignore directory markers at the root also (Nick Craig-Wood)</li>
<li>Force the case of the SHA1 to lowercase (Nick Craig-Wood)</li>
<li>Remove unused <code>largeUpload.clearUploadURL()</code> (Lars
Lehtonen)</li>
</ul></li>
<li>Box
<ul>
<li>Add support for <code>--header-upload</code> and
<code>--header-download</code> (Tim Gallant)</li>
<li>Implement About to read size used (Nick Craig-Wood)</li>
<li>Add token renew function for jwt auth (David Bramwell)</li>
<li>Added support for interchangeable root folder for Box backend (Sunil
Patra)</li>
<li>Remove unnecessary iat from jws claims (David)</li>
</ul></li>
<li>Drive
<ul>
<li>Follow shortcuts by default, skip with
<code>--drive-skip-shortcuts</code> (Nick Craig-Wood)</li>
<li>Implement <code>rclone backend shortcut</code> command for creating
shortcuts (Nick Craig-Wood)</li>
<li>Added <code>rclone backend</code> command to change
<code>service_account_file</code> and <code>chunk_size</code> (Anagh
Kumar Baranwal)</li>
<li>Fix missing files when using <code>--fast-list</code> and
<code>--drive-shared-with-me</code> (Nick Craig-Wood)</li>
<li>Fix duplicate items when using <code>--drive-shared-with-me</code>
(Nick Craig-Wood)</li>
<li>Extend <code>--drive-stop-on-upload-limit</code> to respond to
<code>teamDriveFileLimitExceeded</code>. (harry)</li>
<li>Don’t delete files with multiple parents to avoid data loss (Nick
Craig-Wood)</li>
<li>Server side copy docs use default description if empty (Nick
Craig-Wood)</li>
</ul></li>
<li>Dropbox
<ul>
<li>Make error insufficient space to be fatal (harry)</li>
<li>Add info about required redirect url (Elan Ruusamäe)</li>
</ul></li>
<li>Fichier
<ul>
<li>Add support for <code>--header-upload</code> and
<code>--header-download</code> (Tim Gallant)</li>
<li>Implement custom pacer to deal with the new rate limiting
(buengese)</li>
</ul></li>
<li>FTP
<ul>
<li>Fix lockup when using concurrency limit on failed connections (Nick
Craig-Wood)</li>
<li>Fix lockup on failed upload when using concurrency limit (Nick
Craig-Wood)</li>
<li>Fix lockup on Close failures when using concurrency limit (Nick
Craig-Wood)</li>
<li>Work around pureftp sending spurious 150 messages (Nick
Craig-Wood)</li>
</ul></li>
<li>Google Cloud Storage
<ul>
<li>Add support for <code>--header-upload</code> and
<code>--header-download</code> (Nick Craig-Wood)</li>
<li>Add <code>ARCHIVE</code> storage class to help (Adam Stroud)</li>
<li>Ignore directory markers at the root (Nick Craig-Wood)</li>
</ul></li>
<li>Googlephotos
<ul>
<li>Make the start year configurable (Daven)</li>
<li>Add support for <code>--header-upload</code> and
<code>--header-download</code> (Tim Gallant)</li>
<li>Create feature/favorites directory (Brandon Philips)</li>
<li>Fix “concurrent map write” error (Nick Craig-Wood)</li>
<li>Don’t put an image in error message (Nick Craig-Wood)</li>
</ul></li>
<li>HTTP
<ul>
<li>Improved directory listing with new template from Caddy project
(calisro)</li>
</ul></li>
<li>Jottacloud
<ul>
<li>Implement <code>--jottacloud-trashed-only</code> (buengese)</li>
<li>Add support for <code>--header-upload</code> and
<code>--header-download</code> (Tim Gallant)</li>
<li>Use <code>RawURLEncoding</code> when decoding base64 encoded login
token (buengese)</li>
<li>Implement cleanup (buengese)</li>
<li>Update docs regarding cleanup, removed remains from old auth, and
added warning about special mountpoints. (albertony)</li>
</ul></li>
<li>Mailru
<ul>
<li>Describe 2FA requirements (valery1707)</li>
</ul></li>
<li>Onedrive
<ul>
<li>Implement <code>--onedrive-server-side-across-configs</code> (Nick
Craig-Wood)</li>
<li>Add support for <code>--header-upload</code> and
<code>--header-download</code> (Tim Gallant)</li>
<li>Fix occasional 416 errors on multipart uploads (Nick
Craig-Wood)</li>
<li>Added maximum chunk size limit warning in the docs (Harry)</li>
<li>Fix missing drive on config (Nick Craig-Wood)</li>
<li>Make error <code>quotaLimitReached</code> to be fatal (harry)</li>
</ul></li>
<li>Opendrive
<ul>
<li>Add support for <code>--header-upload</code> and
<code>--header-download</code> (Tim Gallant)</li>
</ul></li>
<li>Pcloud
<ul>
<li>Added support for interchangeable root folder for pCloud backend
(Sunil Patra)</li>
<li>Add support for <code>--header-upload</code> and
<code>--header-download</code> (Tim Gallant)</li>
<li>Fix initial config “Auth state doesn’t match” message (Nick
Craig-Wood)</li>
</ul></li>
<li>Premiumizeme
<ul>
<li>Add support for <code>--header-upload</code> and
<code>--header-download</code> (Tim Gallant)</li>
<li>Prune unused functions (Lars Lehtonen)</li>
</ul></li>
<li>Putio
<ul>
<li>Add support for <code>--header-upload</code> and
<code>--header-download</code> (Nick Craig-Wood)</li>
<li>Make downloading files use the rclone http Client (Nick
Craig-Wood)</li>
<li>Fix parsing of remotes with leading and trailing / (Nick
Craig-Wood)</li>
</ul></li>
<li>Qingstor
<ul>
<li>Make <code>rclone cleanup</code> remove pending multipart uploads
older than 24h (Nick Craig-Wood)</li>
<li>Try harder to cancel failed multipart uploads (Nick Craig-Wood)</li>
<li>Prune <code>multiUploader.list()</code> (Lars Lehtonen)</li>
<li>Lint fix (Lars Lehtonen)</li>
</ul></li>
<li>S3
<ul>
<li>Add support for <code>--header-upload</code> and
<code>--header-download</code> (Tim Gallant)</li>
<li>Use memory pool for buffer allocations (Maciej Zimnoch)</li>
<li>Add SSE-C support for AWS, Ceph, and MinIO (Jack Anderson)</li>
<li>Fail fast multipart upload (Michał Matczuk)</li>
<li>Report errors on bucket creation (mkdir) correctly (Nick
Craig-Wood)</li>
<li>Specify that Minio supports URL encoding in listings (Nick
Craig-Wood)</li>
<li>Added 500 as retryErrorCode (Michał Matczuk)</li>
<li>Use <code>--low-level-retries</code> as the number of SDK retries
(Aleksandar Janković)</li>
<li>Fix multipart abort context (Aleksandar Jankovic)</li>
<li>Replace deprecated <code>session.New()</code> with
<code>session.NewSession()</code> (Lars Lehtonen)</li>
<li>Use the provided size parameter when allocating a new memory pool
(Joachim Brandon LeBlanc)</li>
<li>Use rclone’s low level retries instead of AWS SDK to fix listing
retries (Nick Craig-Wood)</li>
<li>Ignore directory markers at the root also (Nick Craig-Wood)</li>
<li>Use single memory pool (Michał Matczuk)</li>
<li>Do not resize buf on put to memBuf (Michał Matczuk)</li>
<li>Improve docs for <code>--s3-disable-checksum</code> (Nick
Craig-Wood)</li>
<li>Don’t leak memory or tokens in edge cases for multipart upload (Nick
Craig-Wood)</li>
</ul></li>
<li>Seafile
<ul>
<li>Implement 2FA (Fred)</li>
</ul></li>
<li>SFTP
<ul>
<li>Added <code>--sftp-pem-key</code> to support inline key files
(calisro)</li>
<li>Fix post transfer copies failing with 0 size when using
<code>set_modtime=false</code> (Nick Craig-Wood)</li>
</ul></li>
<li>Sharefile
<ul>
<li>Add support for <code>--header-upload</code> and
<code>--header-download</code> (Tim Gallant)</li>
</ul></li>
<li>Sugarsync
<ul>
<li>Add support for <code>--header-upload</code> and
<code>--header-download</code> (Tim Gallant)</li>
</ul></li>
<li>Swift
<ul>
<li>Add support for <code>--header-upload</code> and
<code>--header-download</code> (Nick Craig-Wood)</li>
<li>Fix cosmetic issue in error message (Martin Michlmayr)</li>
</ul></li>
<li>Union
<ul>
<li>Implement multiple writable remotes (Max Sum)</li>
<li>Fix server-side copy (Max Sum)</li>
<li>Implement ListR (Max Sum)</li>
<li>Enable ListR when upstreams contain local (Max Sum)</li>
</ul></li>
<li>WebDAV
<ul>
<li>Add support for <code>--header-upload</code> and
<code>--header-download</code> (Tim Gallant)</li>
<li>Fix <code>X-OC-Mtime</code> header for Transip compatibility (Nick
Craig-Wood)</li>
<li>Report full and consistent usage with <code>about</code> (Yves
G)</li>
</ul></li>
<li>Yandex
<ul>
<li>Add support for <code>--header-upload</code> and
<code>--header-download</code> (Tim Gallant)</li>
</ul></li>
</ul>
<h2 id="v1.51.0---2020-02-01">v1.51.0 - 2020-02-01</h2>
<ul>
<li>New backends
<ul>
<li><a href="https://rclone.org/memory/">Memory</a> (Nick
Craig-Wood)</li>
<li><a href="https://rclone.org/sugarsync/">Sugarsync</a> (Nick
Craig-Wood)</li>
</ul></li>
<li>New Features
<ul>
<li>Adjust all backends to have <code>--backend-encoding</code>
parameter (Nick Craig-Wood)
<ul>
<li>this enables the encoding for special characters to be adjusted or
disabled</li>
</ul></li>
<li>Add <code>--max-duration</code> flag to control the maximum duration
of a transfer session (boosh)</li>
<li>Add <code>--expect-continue-timeout</code> flag, default 1s (Nick
Craig-Wood)</li>
<li>Add <code>--no-check-dest</code> flag for copying without testing
the destination (Nick Craig-Wood)</li>
<li>Implement <code>--order-by</code> flag to order transfers (Nick
Craig-Wood)</li>
<li>accounting
<ul>
<li>Don’t show entries in both transferring and checking (Nick
Craig-Wood)</li>
<li>Add option to delete stats (Aleksandar Jankovic)</li>
</ul></li>
<li>build
<ul>
<li>Compress the test builds with gzip (Nick Craig-Wood)</li>
<li>Implement a framework for starting test servers during tests (Nick
Craig-Wood)</li>
</ul></li>
<li>cmd: Always print elapsed time to tenth place seconds in progress
(Gary Kim)</li>
<li>config
<ul>
<li>Add <code>--password-command</code> to allow dynamic config password
(Damon Permezel)</li>
<li>Give config questions default values (Nick Craig-Wood)</li>
<li>Check a remote exists when creating a new one (Nick Craig-Wood)</li>
</ul></li>
<li>copyurl: Add <code>--stdout</code> flag to write to stdout (Nick
Craig-Wood)</li>
<li>dedupe: Implement keep smallest too (Nick Craig-Wood)</li>
<li>hashsum: Add flag <code>--base64</code> flag (landall)</li>
<li>lsf: Speed up on s3/swift/etc by not reading mimetype by default
(Nick Craig-Wood)</li>
<li>lsjson: Add <code>--no-mimetype</code> flag (Nick Craig-Wood)</li>
<li>rc: Add methods to turn on blocking and mutex profiling (Nick
Craig-Wood)</li>
<li>rcd
<ul>
<li>Adding group parameter to stats (Chaitanya)</li>
<li>Move webgui apart; option to disable browser (Xiaoxing Ye)</li>
</ul></li>
<li>serve sftp: Add support for public key with auth proxy (Paul
Tinsley)</li>
<li>stats: Show deletes in stats and hide zero stats (anuar45)</li>
</ul></li>
<li>Bug Fixes
<ul>
<li>accounting
<ul>
<li>Fix error counter counting multiple times (Ankur Gupta)</li>
<li>Fix error count shown as checks (Cnly)</li>
<li>Clear finished transfer in stats-reset (Maciej Zimnoch)</li>
<li>Added StatsInfo locking in statsGroups sum function (Michał
Matczuk)</li>
</ul></li>
<li>asyncreader: Fix EOF error (buengese)</li>
<li>check: Fix <code>--one-way</code> recursing more directories than it
needs to (Nick Craig-Wood)</li>
<li>chunkedreader: Disable hash calculation for first segment (Nick
Craig-Wood)</li>
<li>config
<ul>
<li>Do not open browser on headless on drive/gcs/google photos (Xiaoxing
Ye)</li>
<li>SetValueAndSave ignore error if config section does not exist yet
(buengese)</li>
</ul></li>
<li>cmd: Fix completion with an encrypted config (Danil Semelenov)</li>
<li>dbhashsum: Stop it returning UNSUPPORTED on dropbox (Nick
Craig-Wood)</li>
<li>dedupe: Add missing modes to help string (Nick Craig-Wood)</li>
<li>operations
<ul>
<li>Fix dedupe continuing on errors like insufficientFilePersimmon
(SezalAgrawal)</li>
<li>Clear accounting before low level retry (Maciej Zimnoch)</li>
<li>Write debug message when hashes could not be checked (Ole
Schütt)</li>
<li>Move interface assertion to tests to remove pflag dependency (Nick
Craig-Wood)</li>
<li>Make NewOverrideObjectInfo public and factor uses (Nick
Craig-Wood)</li>
</ul></li>
<li>proxy: Replace use of bcrypt with sha256 (Nick Craig-Wood)</li>
<li>vendor
<ul>
<li>Update bazil.org/fuse to fix FreeBSD 12.1 (Nick Craig-Wood)</li>
<li>Update github.com/t3rm1n4l/go-mega to fix mega “illegal base64 data
at input byte 22” (Nick Craig-Wood)</li>
<li>Update termbox-go to fix ncdu command on FreeBSD (Kuang-che Wu)</li>
<li>Update t3rm1n4l/go-mega - fixes mega: couldn’t login: crypto/aes:
invalid key size 0 (Nick Craig-Wood)</li>
</ul></li>
</ul></li>
<li>Mount
<ul>
<li>Enable async reads for a 20% speedup (Nick Craig-Wood)</li>
<li>Replace use of WriteAt with Write for cache mode &gt;= writes and
O_APPEND (Brett Dutro)</li>
<li>Make sure we call unmount when exiting (Nick Craig-Wood)</li>
<li>Don’t build on go1.10 as bazil/fuse no longer supports it (Nick
Craig-Wood)</li>
<li>When setting dates discard out of range dates (Nick Craig-Wood)</li>
</ul></li>
<li>VFS
<ul>
<li>Add a newly created file straight into the directory (Nick
Craig-Wood)</li>
<li>Only calculate one hash for reads for a speedup (Nick
Craig-Wood)</li>
<li>Make ReadAt for non cached files work better with non-sequential
reads (Nick Craig-Wood)</li>
<li>Fix edge cases when reading ModTime from file (Nick Craig-Wood)</li>
<li>Make sure existing files opened for write show correct size (Nick
Craig-Wood)</li>
<li>Don’t cache the path in RW file objects to fix renaming (Nick
Craig-Wood)</li>
<li>Fix rename of open files when using the VFS cache (Nick
Craig-Wood)</li>
<li>When renaming files in the cache, rename the cache item in memory
too (Nick Craig-Wood)</li>
<li>Fix open file renaming on drive when using
<code>--vfs-cache-mode writes</code> (Nick Craig-Wood)</li>
<li>Fix incorrect modtime for mv into mount with
<code>--vfs-cache-modes writes</code> (Nick Craig-Wood)</li>
<li>On rename, rename in cache too if the file exists (Anagh Kumar
Baranwal)</li>
</ul></li>
<li>Local
<ul>
<li>Make source file being updated errors be NoLowLevelRetry errors
(Nick Craig-Wood)</li>
<li>Fix update of hidden files on Windows (Nick Craig-Wood)</li>
</ul></li>
<li>Cache
<ul>
<li>Follow move of upstream library github.com/coreos/bbolt
github.com/etcd-io/bbolt (Nick Craig-Wood)</li>
<li>Fix <code>fatal error: concurrent map writes</code> (Nick
Craig-Wood)</li>
</ul></li>
<li>Crypt
<ul>
<li>Reorder the filename encryption options (Thomas Eales)</li>
<li>Correctly handle trailing dot (buengese)</li>
</ul></li>
<li>Chunker
<ul>
<li>Reduce length of temporary suffix (Ivan Andreev)</li>
</ul></li>
<li>Drive
<ul>
<li>Add <code>--drive-stop-on-upload-limit</code> flag to stop syncs
when upload limit reached (Nick Craig-Wood)</li>
<li>Add <code>--drive-use-shared-date</code> to use date file was shared
instead of modified date (Garry McNulty)</li>
<li>Make sure invalid auth for teamdrives always reports an error (Nick
Craig-Wood)</li>
<li>Fix <code>--fast-list</code> when using appDataFolder (Nick
Craig-Wood)</li>
<li>Use multipart resumable uploads for streaming and uploads in mount
(Nick Craig-Wood)</li>
<li>Log an ERROR if an incomplete search is returned (Nick
Craig-Wood)</li>
<li>Hide dangerous config from the configurator (Nick Craig-Wood)</li>
</ul></li>
<li>Dropbox
<ul>
<li>Treat <code>insufficient_space</code> errors as non retriable errors
(Nick Craig-Wood)</li>
</ul></li>
<li>Jottacloud
<ul>
<li>Use new auth method used by official client (buengese)</li>
<li>Add URL to generate Login Token to config wizard (Nick
Craig-Wood)</li>
<li>Add support whitelabel versions (buengese)</li>
</ul></li>
<li>Koofr
<ul>
<li>Use rclone HTTP client. (jaKa)</li>
</ul></li>
<li>Onedrive
<ul>
<li>Add Sites.Read.All permission (Benjamin Richter)</li>
<li>Add support “Retry-After” header (Motonori IWAMURO)</li>
</ul></li>
<li>Opendrive
<ul>
<li>Implement <code>--opendrive-chunk-size</code> (Nick Craig-Wood)</li>
</ul></li>
<li>S3
<ul>
<li>Re-implement multipart upload to fix memory issues (Nick
Craig-Wood)</li>
<li>Add <code>--s3-copy-cutoff</code> for size to switch to multipart
copy (Nick Craig-Wood)</li>
<li>Add new region Asia Pacific (Hong Kong) (Outvi V)</li>
<li>Reduce memory usage streaming files by reducing max stream upload
size (Nick Craig-Wood)</li>
<li>Add <code>--s3-list-chunk</code> option for bucket listing (Thomas
Kriechbaumer)</li>
<li>Force path style bucket access to off for AWS deprecation (Nick
Craig-Wood)</li>
<li>Use AWS web identity role provider if available (Tennix)</li>
<li>Add StackPath Object Storage Support (Dave Koston)</li>
<li>Fix ExpiryWindow value (Aleksandar Jankovic)</li>
<li>Fix DisableChecksum condition (Aleksandar Janković)</li>
<li>Fix URL decoding of NextMarker (Nick Craig-Wood)</li>
</ul></li>
<li>SFTP
<ul>
<li>Add <code>--sftp-skip-links</code> to skip symlinks and non regular
files (Nick Craig-Wood)</li>
<li>Retry Creation of Connection (Sebastian Brandt)</li>
<li>Fix “failed to parse private key file: ssh: not an encrypted key”
error (Nick Craig-Wood)</li>
<li>Open files for update write only to fix AWS SFTP interop (Nick
Craig-Wood)</li>
</ul></li>
<li>Swift
<ul>
<li>Reserve segments of dynamic large object when delete objects in
container what was enabled versioning. (Nguyễn Hữu Luân)</li>
<li>Fix parsing of X-Object-Manifest (Nick Craig-Wood)</li>
<li>Update OVH API endpoint (unbelauscht)</li>
</ul></li>
<li>WebDAV
<ul>
<li>Make nextcloud only upload SHA1 checksums (Nick Craig-Wood)</li>
<li>Fix case of “Bearer” in Authorization: header to agree with RFC
(Nick Craig-Wood)</li>
<li>Add Referer header to fix problems with WAFs (Nick Craig-Wood)</li>
</ul></li>
</ul>
<h2 id="v1.50.2---2019-11-19">v1.50.2 - 2019-11-19</h2>
<ul>
<li>Bug Fixes
<ul>
<li>accounting: Fix memory leak on retries operations (Nick
Craig-Wood)</li>
</ul></li>
<li>Drive
<ul>
<li>Fix listing of the root directory with drive.files scope (Nick
Craig-Wood)</li>
<li>Fix –drive-root-folder-id with team/shared drives (Nick
Craig-Wood)</li>
</ul></li>
</ul>
<h2 id="v1.50.1---2019-11-02">v1.50.1 - 2019-11-02</h2>
<ul>
<li>Bug Fixes
<ul>
<li>hash: Fix accidentally changed hash names for
<code>DropboxHash</code> and <code>CRC-32</code> (Nick Craig-Wood)</li>
<li>fshttp: Fix error reporting on tpslimit token bucket errors (Nick
Craig-Wood)</li>
<li>fshttp: Don’t print token bucket errors on context cancelled (Nick
Craig-Wood)</li>
</ul></li>
<li>Local
<ul>
<li>Fix listings of . on Windows (Nick Craig-Wood)</li>
</ul></li>
<li>Onedrive
<ul>
<li>Fix DirMove/Move after Onedrive change (Xiaoxing Ye)</li>
</ul></li>
</ul>
<h2 id="v1.50.0---2019-10-26">v1.50.0 - 2019-10-26</h2>
<ul>
<li>New backends
<ul>
<li><a href="https://rclone.org/sharefile/">Citrix Sharefile</a> (Nick
Craig-Wood)</li>
<li><a href="https://rclone.org/chunker/">Chunker</a> - an overlay
backend to split files into smaller parts (Ivan Andreev)</li>
<li><a href="https://rclone.org/mailru/">Mail.ru Cloud</a> (Ivan
Andreev)</li>
</ul></li>
<li>New Features
<ul>
<li>encodings (Fabian Möller &amp; Nick Craig-Wood)
<ul>
<li>All backends now use file name encoding to ensure any file name can
be written to any backend.</li>
<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>
<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>
</ul></li>
<li>build
<ul>
<li>Update to use go1.13 for the build (Nick Craig-Wood)</li>
<li>Drop support for go1.9 (Nick Craig-Wood)</li>
<li>Build rclone with GitHub actions (Nick Craig-Wood)</li>
<li>Convert python scripts to python3 (Nick Craig-Wood)</li>
<li>Swap Azure/go-ansiterm for mattn/go-colorable (Nick Craig-Wood)</li>
<li>Dockerfile fixes (Matei David)</li>
<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>
</ul></li>
<li>config
<ul>
<li>Use alternating Red/Green in config to make more obvious (Nick
Craig-Wood)</li>
</ul></li>
<li>contrib
<ul>
<li>Add sample DLNA server Docker Compose manifest. (pataquets)</li>
<li>Add sample WebDAV server Docker Compose manifest. (pataquets)</li>
</ul></li>
<li>copyurl
<ul>
<li>Add <code>--auto-filename</code> flag for using file name from URL
in destination path (Denis)</li>
</ul></li>
<li>serve dlna:
<ul>
<li>Many compatibility improvements (Dan Walters)</li>
<li>Support for external srt subtitles (Dan Walters)</li>
</ul></li>
<li>rc
<ul>
<li>Added command core/quit (Saksham Khanna)</li>
</ul></li>
</ul></li>
<li>Bug Fixes
<ul>
<li>sync
<ul>
<li>Make <code>--update</code>/<code>-u</code> not transfer files that
haven’t changed (Nick Craig-Wood)</li>
<li>Free objects after they come out of the transfer pipe to save memory
(Nick Craig-Wood)</li>
<li>Fix <code>--files-from without --no-traverse</code> doing a
recursive scan (Nick Craig-Wood)</li>
</ul></li>
<li>operations
<ul>
<li>Fix accounting for server-side copies (Nick Craig-Wood)</li>
<li>Display ‘All duplicates removed’ only if dedupe successful (Sezal
Agrawal)</li>
<li>Display ‘Deleted X extra copies’ only if dedupe successful (Sezal
Agrawal)</li>
</ul></li>
<li>accounting
<ul>
<li>Only allow up to 100 completed transfers in the accounting list to
save memory (Nick Craig-Wood)</li>
<li>Cull the old time ranges when possible to save memory (Nick
Craig-Wood)</li>
<li>Fix panic due to server-side copy fallback (Ivan Andreev)</li>
<li>Fix memory leak noticeable for transfers of large numbers of objects
(Nick Craig-Wood)</li>
<li>Fix total duration calculation (Nick Craig-Wood)</li>
</ul></li>
<li>cmd
<ul>
<li>Fix environment variables not setting command line flags (Nick
Craig-Wood)</li>
<li>Make autocomplete compatible with bash’s posix mode for macOS (Danil
Semelenov)</li>
<li>Make <code>--progress</code> work in git bash on Windows (Nick
Craig-Wood)</li>
<li>Fix ‘compopt: command not found’ on autocomplete on macOS (Danil
Semelenov)</li>
</ul></li>
<li>config
<ul>
<li>Fix setting of non top level flags from environment variables (Nick
Craig-Wood)</li>
<li>Check config names more carefully and report errors (Nick
Craig-Wood)</li>
<li>Remove error: can’t use <code>--size-only</code> and
<code>--ignore-size</code> together. (Nick Craig-Wood)</li>
</ul></li>
<li>filter: Prevent mixing options when <code>--files-from</code> is in
use (Michele Caci)</li>
<li>serve sftp: Fix crash on unsupported operations (e.g. Readlink)
(Nick Craig-Wood)</li>
</ul></li>
<li>Mount
<ul>
<li>Allow files of unknown size to be read properly (Nick
Craig-Wood)</li>
<li>Skip tests on &lt;= 2 CPUs to avoid lockup (Nick Craig-Wood)</li>
<li>Fix panic on File.Open (Nick Craig-Wood)</li>
<li>Fix “mount_fusefs: -o timeout=: option not supported” on FreeBSD
(Nick Craig-Wood)</li>
<li>Don’t pass huge filenames (&gt;4k) to FUSE as it can’t cope (Nick
Craig-Wood)</li>
</ul></li>
<li>VFS
<ul>
<li>Add flag <code>--vfs-case-insensitive</code> for windows/macOS
mounts (Ivan Andreev)</li>
<li>Make objects of unknown size readable through the VFS (Nick
Craig-Wood)</li>
<li>Move writeback of dirty data out of close() method into its own
method (FlushWrites) and remove close() call from Flush() (Brett
Dutro)</li>
<li>Stop empty dirs disappearing when renamed on bucket-based remotes
(Nick Craig-Wood)</li>
<li>Stop change notify polling clearing so much of the directory cache
(Nick Craig-Wood)</li>
</ul></li>
<li>Azure Blob
<ul>
<li>Disable logging to the Windows event log (Nick Craig-Wood)</li>
</ul></li>
<li>B2
<ul>
<li>Remove <code>unverified:</code> prefix on sha1 to improve interop
(e.g. with CyberDuck) (Nick Craig-Wood)</li>
</ul></li>
<li>Box
<ul>
<li>Add options to get access token via JWT auth (David)</li>
</ul></li>
<li>Drive
<ul>
<li>Disable HTTP/2 by default to work around INTERNAL_ERROR problems
(Nick Craig-Wood)</li>
<li>Make sure that drive root ID is always canonical (Nick
Craig-Wood)</li>
<li>Fix <code>--drive-shared-with-me</code> from the root with lsand
<code>--fast-list</code> (Nick Craig-Wood)</li>
<li>Fix ChangeNotify polling for shared drives (Nick Craig-Wood)</li>
<li>Fix change notify polling when using appDataFolder (Nick
Craig-Wood)</li>
</ul></li>
<li>Dropbox
<ul>
<li>Make disallowed filenames errors not retry (Nick Craig-Wood)</li>
<li>Fix nil pointer exception on restricted files (Nick Craig-Wood)</li>
</ul></li>
<li>Fichier
<ul>
<li>Fix accessing files &gt; 2GB on 32 bit systems (Nick
Craig-Wood)</li>
</ul></li>
<li>FTP
<ul>
<li>Allow disabling EPSV mode (Jon Fautley)</li>
</ul></li>
<li>HTTP
<ul>
<li>HEAD directory entries in parallel to speedup (Nick Craig-Wood)</li>
<li>Add <code>--http-no-head</code> to stop rclone doing HEAD in
listings (Nick Craig-Wood)</li>
</ul></li>
<li>Putio
<ul>
<li>Add ability to resume uploads (Cenk Alti)</li>
</ul></li>
<li>S3
<ul>
<li>Fix signature v2_auth headers (Anthony Rusdi)</li>
<li>Fix encoding for control characters (Nick Craig-Wood)</li>
<li>Only ask for URL encoded directory listings if we need them on Ceph
(Nick Craig-Wood)</li>
<li>Add option for multipart failure behaviour (Aleksandar
Jankovic)</li>
<li>Support for multipart copy (庄天翼)</li>
<li>Fix nil pointer reference if no metadata returned for object (Nick
Craig-Wood)</li>
</ul></li>
<li>SFTP
<ul>
<li>Fix <code>--sftp-ask-password</code> trying to contact the ssh agent
(Nick Craig-Wood)</li>
<li>Fix hashes of files with backslashes (Nick Craig-Wood)</li>
<li>Include more ciphers with <code>--sftp-use-insecure-cipher</code>
(Carlos Ferreyra)</li>
</ul></li>
<li>WebDAV
<ul>
<li>Parse and return Sharepoint error response (Henning Surmeier)</li>
</ul></li>
</ul>
<h2 id="v1.49.5---2019-10-05">v1.49.5 - 2019-10-05</h2>
<ul>
<li>Bug Fixes
<ul>
<li>Revert back to go1.12.x for the v1.49.x builds as go1.13.x was
causing issues (Nick Craig-Wood)</li>
<li>Fix rpm packages by using master builds of nfpm (Nick
Craig-Wood)</li>
<li>Fix macOS build after brew changes (Nick Craig-Wood)</li>
</ul></li>
</ul>
<h2 id="v1.49.4---2019-09-29">v1.49.4 - 2019-09-29</h2>
<ul>
<li>Bug Fixes
<ul>
<li>cmd/rcd: Address ZipSlip vulnerability (Richard Patel)</li>
<li>accounting: Fix file handle leak on errors (Nick Craig-Wood)</li>
<li>oauthutil: Fix security problem when running with two users on the
same machine (Nick Craig-Wood)</li>
</ul></li>
<li>FTP
<ul>
<li>Fix listing of an empty root returning: error dir not found (Nick
Craig-Wood)</li>
</ul></li>
<li>S3
<ul>
<li>Fix SetModTime on GLACIER/ARCHIVE objects and implement set/get tier
(Nick Craig-Wood)</li>
</ul></li>
</ul>
<h2 id="v1.49.3---2019-09-15">v1.49.3 - 2019-09-15</h2>
<ul>
<li>Bug Fixes
<ul>
<li>accounting
<ul>
<li>Fix total duration calculation (Aleksandar Jankovic)</li>
<li>Fix “file already closed” on transfer retries (Nick Craig-Wood)</li>
</ul></li>
</ul></li>
</ul>
<h2 id="v1.49.2---2019-09-08">v1.49.2 - 2019-09-08</h2>
<ul>
<li>New Features
<ul>
<li>build: Add Docker workflow support (Alfonso Montero)</li>
</ul></li>
<li>Bug Fixes
<ul>
<li>accounting: Fix locking in Transfer to avoid deadlock with
<code>--progress</code> (Nick Craig-Wood)</li>
<li>docs: Fix template argument for mktemp in install.sh (Cnly)</li>
<li>operations: Fix <code>-u</code>/<code>--update</code> with google
photos / files of unknown size (Nick Craig-Wood)</li>
<li>rc: Fix docs for config/create /update /password (Nick
Craig-Wood)</li>
</ul></li>
<li>Google Cloud Storage
<ul>
<li>Fix need for elevated permissions on SetModTime (Nick
Craig-Wood)</li>
</ul></li>
</ul>
<h2 id="v1.49.1---2019-08-28">v1.49.1 - 2019-08-28</h2>
<ul>
<li>Bug Fixes
<ul>
<li>config: Fix generated passwords being stored as empty password (Nick
Craig-Wood)</li>
<li>rcd: Added missing parameter for web-gui info logs. (Chaitanya)</li>
</ul></li>
<li>Googlephotos
<ul>
<li>Fix crash on error response (Nick Craig-Wood)</li>
</ul></li>
<li>Onedrive
<ul>
<li>Fix crash on error response (Nick Craig-Wood)</li>
</ul></li>
</ul>
<h2 id="v1.49.0---2019-08-26">v1.49.0 - 2019-08-26</h2>
<ul>
<li>New backends
<ul>
<li><a href="https://rclone.org/fichier/">1fichier</a> (Laura
Hausmann)</li>
<li><a href="https://rclone.org/googlephotos/">Google Photos</a> (Nick
Craig-Wood)</li>
<li><a href="https://rclone.org/putio/">Putio</a> (Cenk Alti)</li>
<li><a href="https://rclone.org/premiumizeme/">premiumize.me</a> (Nick
Craig-Wood)</li>
</ul></li>
<li>New Features
<ul>
<li>Experimental <a href="https://rclone.org/gui/">web GUI</a>
(Chaitanya Bankanhal)</li>
<li>Implement <code>--compare-dest</code> &amp; <code>--copy-dest</code>
(yparitcher)</li>
<li>Implement <code>--suffix</code> without <code>--backup-dir</code>
for backup to current dir (yparitcher)</li>
<li><code>config reconnect</code> to re-login (re-run the oauth login)
for the backend. (Nick Craig-Wood)</li>
<li><code>config userinfo</code> to discover which user you are logged
in as. (Nick Craig-Wood)</li>
<li><code>config disconnect</code> to disconnect you (log out) from the
backend. (Nick Craig-Wood)</li>
<li>Add <code>--use-json-log</code> for JSON logging (justinalin)</li>
<li>Add context propagation to rclone (Aleksandar Jankovic)</li>
<li>Reworking internal statistics interfaces so they work with rc jobs
(Aleksandar Jankovic)</li>
<li>Add Higher units for ETA (AbelThar)</li>
<li>Update rclone logos to new design (Andreas Chlupka)</li>
<li>hash: Add CRC-32 support (Cenk Alti)</li>
<li>help showbackend: Fixed advanced option category when there are no
standard options (buengese)</li>
<li>ncdu: Display/Copy to Clipboard Current Path (Gary Kim)</li>
<li>operations:
<ul>
<li>Run hashing operations in parallel (Nick Craig-Wood)</li>
<li>Don’t calculate checksums when using <code>--ignore-checksum</code>
(Nick Craig-Wood)</li>
<li>Check transfer hashes when using <code>--size-only</code> mode (Nick
Craig-Wood)</li>
<li>Disable multi thread copy for local to local copies (Nick
Craig-Wood)</li>
<li>Debug successful hashes as well as failures (Nick Craig-Wood)</li>
</ul></li>
<li>rc
<ul>
<li>Add ability to stop async jobs (Aleksandar Jankovic)</li>
<li>Return current settings if core/bwlimit called without parameters
(Nick Craig-Wood)</li>
<li>Rclone-WebUI integration with rclone (Chaitanya Bankanhal)</li>
<li>Added command line parameter to control the cross origin resource
sharing (CORS) in the rcd. (Security Improvement) (Chaitanya
Bankanhal)</li>
<li>Add anchor tags to the docs so links are consistent (Nick
Craig-Wood)</li>
<li>Remove _async key from input parameters after parsing so later
operations won’t get confused (buengese)</li>
<li>Add call to clear stats (Aleksandar Jankovic)</li>
</ul></li>
<li>rcd
<ul>
<li>Auto-login for web-gui (Chaitanya Bankanhal)</li>
<li>Implement <code>--baseurl</code> for rcd and web-gui (Chaitanya
Bankanhal)</li>
</ul></li>
<li>serve dlna
<ul>
<li>Only select interfaces which can multicast for SSDP (Nick
Craig-Wood)</li>
<li>Add more builtin mime types to cover standard audio/video (Nick
Craig-Wood)</li>
<li>Fix missing mime types on Android causing missing videos (Nick
Craig-Wood)</li>
</ul></li>
<li>serve ftp
<ul>
<li>Refactor to bring into line with other serve commands (Nick
Craig-Wood)</li>
<li>Implement <code>--auth-proxy</code> (Nick Craig-Wood)</li>
</ul></li>
<li>serve http: Implement <code>--baseurl</code> (Nick Craig-Wood)</li>
<li>serve restic: Implement <code>--baseurl</code> (Nick
Craig-Wood)</li>
<li>serve sftp
<ul>
<li>Implement auth proxy (Nick Craig-Wood)</li>
<li>Fix detection of whether server is authorized (Nick Craig-Wood)</li>
</ul></li>
<li>serve webdav
<ul>
<li>Implement <code>--baseurl</code> (Nick Craig-Wood)</li>
<li>Support <code>--auth-proxy</code> (Nick Craig-Wood)</li>
</ul></li>
</ul></li>
<li>Bug Fixes
<ul>
<li>Make “bad record MAC” a retriable error (Nick Craig-Wood)</li>
<li>copyurl: Fix copying files that return HTTP errors (Nick
Craig-Wood)</li>
<li>march: Fix checking sub-directories when using
<code>--no-traverse</code> (buengese)</li>
<li>rc
<ul>
<li>Fix unmarshalable http.AuthFn in options and put in test for
marshalability (Nick Craig-Wood)</li>
<li>Move job expire flags to rc to fix initialization problem (Nick
Craig-Wood)</li>
<li>Fix <code>--loopback</code> with rc/list and others (Nick
Craig-Wood)</li>
</ul></li>
<li>rcat: Fix slowdown on systems with multiple hashes (Nick
Craig-Wood)</li>
<li>rcd: Fix permissions problems on cache directory with web gui
download (Nick Craig-Wood)</li>
</ul></li>
<li>Mount
<ul>
<li>Default <code>--daemon-timeout</code> to 15 minutes on macOS and
FreeBSD (Nick Craig-Wood)</li>
<li>Update docs to show mounting from root OK for bucket-based (Nick
Craig-Wood)</li>
<li>Remove nonseekable flag from write files (Nick Craig-Wood)</li>
</ul></li>
<li>VFS
<ul>
<li>Make write without cache more efficient (Nick Craig-Wood)</li>
<li>Fix <code>--vfs-cache-mode minimal</code> and <code>writes</code>
ignoring cached files (Nick Craig-Wood)</li>
</ul></li>
<li>Local
<ul>
<li>Add <code>--local-case-sensitive</code> and
<code>--local-case-insensitive</code> (Nick Craig-Wood)</li>
<li>Avoid polluting page cache when uploading local files to remote
backends (Michał Matczuk)</li>
<li>Don’t calculate any hashes by default (Nick Craig-Wood)</li>
<li>Fadvise run syscall on a dedicated go routine (Michał Matczuk)</li>
</ul></li>
<li>Azure Blob
<ul>
<li>Azure Storage Emulator support (Sandeep)</li>
<li>Updated config help details to remove connection string references
(Sandeep)</li>
<li>Make all operations work from the root (Nick Craig-Wood)</li>
</ul></li>
<li>B2
<ul>
<li>Implement link sharing (yparitcher)</li>
<li>Enable server-side copy to copy between buckets (Nick
Craig-Wood)</li>
<li>Make all operations work from the root (Nick Craig-Wood)</li>
</ul></li>
<li>Drive
<ul>
<li>Fix server-side copy of big files (Nick Craig-Wood)</li>
<li>Update API for teamdrive use (Nick Craig-Wood)</li>
<li>Add error for purge with <code>--drive-trashed-only</code>
(ginvine)</li>
</ul></li>
<li>Fichier
<ul>
<li>Make FolderID int and adjust related code (buengese)</li>
</ul></li>
<li>Google Cloud Storage
<ul>
<li>Reduce oauth scope requested as suggested by Google (Nick
Craig-Wood)</li>
<li>Make all operations work from the root (Nick Craig-Wood)</li>
</ul></li>
<li>HTTP
<ul>
<li>Add <code>--http-headers</code> flag for setting arbitrary headers
(Nick Craig-Wood)</li>
</ul></li>
<li>Jottacloud
<ul>
<li>Use new api for retrieving internal username (buengese)</li>
<li>Refactor configuration and minor cleanup (buengese)</li>
</ul></li>
<li>Koofr
<ul>
<li>Support setting modification times on Koofr backend. (jaKa)</li>
</ul></li>
<li>Opendrive
<ul>
<li>Refactor to use existing lib/rest facilities for uploads (Nick
Craig-Wood)</li>
</ul></li>
<li>Qingstor
<ul>
<li>Upgrade to v3 SDK and fix listing loop (Nick Craig-Wood)</li>
<li>Make all operations work from the root (Nick Craig-Wood)</li>
</ul></li>
<li>S3
<ul>
<li>Add INTELLIGENT_TIERING storage class (Matti Niemenmaa)</li>
<li>Make all operations work from the root (Nick Craig-Wood)</li>
</ul></li>
<li>SFTP
<ul>
<li>Add missing interface check and fix About (Nick Craig-Wood)</li>
<li>Completely ignore all modtime checks if SetModTime=false (Jon
Fautley)</li>
<li>Support md5/sha1 with rsync.net (Nick Craig-Wood)</li>
<li>Save the md5/sha1 command in use to the config file for efficiency
(Nick Craig-Wood)</li>
<li>Opt-in support for diffie-hellman-group-exchange-sha256
diffie-hellman-group-exchange-sha1 (Yi FU)</li>
</ul></li>
<li>Swift
<ul>
<li>Use FixRangeOption to fix 0 length files via the VFS (Nick
Craig-Wood)</li>
<li>Fix upload when using no_chunk to return the correct size (Nick
Craig-Wood)</li>
<li>Make all operations work from the root (Nick Craig-Wood)</li>
<li>Fix segments leak during failed large file uploads.
(nguyenhuuluan434)</li>
</ul></li>
<li>WebDAV
<ul>
<li>Add <code>--webdav-bearer-token-command</code> (Nick
Craig-Wood)</li>
<li>Refresh token when it expires with
<code>--webdav-bearer-token-command</code> (Nick Craig-Wood)</li>
<li>Add docs for using bearer_token_command with oidc-agent (Paul
Millar)</li>
</ul></li>
</ul>
<h2 id="v1.48.0---2019-06-15">v1.48.0 - 2019-06-15</h2>
<ul>
<li>New commands
<ul>
<li>serve sftp: Serve an rclone remote over SFTP (Nick Craig-Wood)</li>
</ul></li>
<li>New Features
<ul>
<li>Multi threaded downloads to local storage (Nick Craig-Wood)
<ul>
<li>controlled with <code>--multi-thread-cutoff</code> and
<code>--multi-thread-streams</code></li>
</ul></li>
<li>Use rclone.conf from rclone executable directory to enable portable
use (albertony)</li>
<li>Allow sync of a file and a directory with the same name (forgems)
<ul>
<li>this is common on bucket-based remotes, e.g. s3, gcs</li>
</ul></li>
<li>Add <code>--ignore-case-sync</code> for forced case insensitivity
(garry415)</li>
<li>Implement <code>--stats-one-line-date</code> and
<code>--stats-one-line-date-format</code> (Peter Berbec)</li>
<li>Log an ERROR for all commands which exit with non-zero status (Nick
Craig-Wood)</li>
<li>Use go-homedir to read the home directory more reliably (Nick
Craig-Wood)</li>
<li>Enable creating encrypted config through external script invocation
(Wojciech Smigielski)</li>
<li>build: Drop support for go1.8 (Nick Craig-Wood)</li>
<li>config: Make config create/update encrypt passwords where necessary
(Nick Craig-Wood)</li>
<li>copyurl: Honor <code>--no-check-certificate</code> (Stefan
Breunig)</li>
<li>install: Linux skip man pages if no mandb (didil)</li>
<li>lsf: Support showing the Tier of the object (Nick Craig-Wood)</li>
<li>lsjson
<ul>
<li>Added EncryptedPath to output (calisro)</li>
<li>Support showing the Tier of the object (Nick Craig-Wood)</li>
<li>Add IsBucket field for bucket-based remote listing of the root (Nick
Craig-Wood)</li>
</ul></li>
<li>rc
<ul>
<li>Add <code>--loopback</code> flag to run commands directly without a
server (Nick Craig-Wood)</li>
<li>Add operations/fsinfo: Return information about the remote (Nick
Craig-Wood)</li>
<li>Skip auth for OPTIONS request (Nick Craig-Wood)</li>
<li>cmd/providers: Add DefaultStr, ValueStr and Type fields (Nick
Craig-Wood)</li>
<li>jobs: Make job expiry timeouts configurable (Aleksandar
Jankovic)</li>
</ul></li>
<li>serve dlna reworked and improved (Dan Walters)</li>
<li>serve ftp: add <code>--ftp-public-ip</code> flag to specify public
IP (calistri)</li>
<li>serve restic: Add support for <code>--private-repos</code> in
<code>serve restic</code> (Florian Apolloner)</li>
<li>serve webdav: Combine serve webdav and serve http (Gary Kim)</li>
<li>size: Ignore negative sizes when calculating total (Garry
McNulty)</li>
</ul></li>
<li>Bug Fixes
<ul>
<li>Make move and copy individual files obey <code>--backup-dir</code>
(Nick Craig-Wood)</li>
<li>If <code>--ignore-checksum</code> is in effect, don’t calculate
checksum (Nick Craig-Wood)</li>
<li>moveto: Fix case-insensitive same remote move (Gary Kim)</li>
<li>rc: Fix serving bucket-based objects with <code>--rc-serve</code>
(Nick Craig-Wood)</li>
<li>serve webdav: Fix serveDir not being updated with changes from
webdav (Gary Kim)</li>
</ul></li>
<li>Mount
<ul>
<li>Fix poll interval documentation (Animosity022)</li>
</ul></li>
<li>VFS
<ul>
<li>Make WriteAt for non cached files work with non-sequential writes
(Nick Craig-Wood)</li>
</ul></li>
<li>Local
<ul>
<li>Only calculate the required hashes for big speedup (Nick
Craig-Wood)</li>
<li>Log errors when listing instead of returning an error (Nick
Craig-Wood)</li>
<li>Fix preallocate warning on Linux with ZFS (Nick Craig-Wood)</li>
</ul></li>
<li>Crypt
<ul>
<li>Make rclone dedupe work through crypt (Nick Craig-Wood)</li>
<li>Fix wrapping of ChangeNotify to decrypt directories properly (Nick
Craig-Wood)</li>
<li>Support PublicLink (rclone link) of underlying backend (Nick
Craig-Wood)</li>
<li>Implement Optional methods SetTier, GetTier (Nick Craig-Wood)</li>
</ul></li>
<li>B2
<ul>
<li>Implement server-side copy (Nick Craig-Wood)</li>
<li>Implement SetModTime (Nick Craig-Wood)</li>
</ul></li>
<li>Drive
<ul>
<li>Fix move and copy from TeamDrive to GDrive (Fionera)</li>
<li>Add notes that cleanup works in the background on drive (Nick
Craig-Wood)</li>
<li>Add <code>--drive-server-side-across-configs</code> to default back
to old server-side copy semantics by default (Nick Craig-Wood)</li>
<li>Add <code>--drive-size-as-quota</code> to show storage quota usage
for file size (Garry McNulty)</li>
</ul></li>
<li>FTP
<ul>
<li>Add FTP List timeout (Jeff Quinn)</li>
<li>Add FTP over TLS support (Gary Kim)</li>
<li>Add <code>--ftp-no-check-certificate</code> option for FTPS (Gary
Kim)</li>
</ul></li>
<li>Google Cloud Storage
<ul>
<li>Fix upload errors when uploading pre 1970 files (Nick
Craig-Wood)</li>
</ul></li>
<li>Jottacloud
<ul>
<li>Add support for selecting device and mountpoint. (buengese)</li>
</ul></li>
<li>Mega
<ul>
<li>Add cleanup support (Gary Kim)</li>
</ul></li>
<li>Onedrive
<ul>
<li>More accurately check if root is found (Cnly)</li>
</ul></li>
<li>S3
<ul>
<li>Support S3 Accelerated endpoints with
<code>--s3-use-accelerate-endpoint</code> (Nick Craig-Wood)</li>
<li>Add config info for Wasabi’s EU Central endpoint (Robert Marko)</li>
<li>Make SetModTime work for GLACIER while syncing (Philip Harvey)</li>
</ul></li>
<li>SFTP
<ul>
<li>Add About support (Gary Kim)</li>
<li>Fix about parsing of <code>df</code> results so it can cope with -ve
results (Nick Craig-Wood)</li>
<li>Send custom client version and debug server version (Nick
Craig-Wood)</li>
</ul></li>
<li>WebDAV
<ul>
<li>Retry on 423 Locked errors (Nick Craig-Wood)</li>
</ul></li>
</ul>
<h2 id="v1.47.0---2019-04-13">v1.47.0 - 2019-04-13</h2>
<ul>
<li>New backends
<ul>
<li>Backend for Koofr cloud storage service. (jaKa)</li>
</ul></li>
<li>New Features
<ul>
<li>Resume downloads if the reader fails in copy (Nick Craig-Wood)
<ul>
<li>this means rclone will restart transfers if the source has an
error</li>
<li>this is most useful for downloads or cloud to cloud copies</li>
</ul></li>
<li>Use <code>--fast-list</code> for listing operations where it won’t
use more memory (Nick Craig-Wood)
<ul>
<li>this should speed up the following operations on remotes which
support <code>ListR</code></li>
<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>
<li>use <code>--disable ListR</code> to get old behaviour if
required</li>
</ul></li>
<li>Make <code>--files-from</code> traverse the destination unless
<code>--no-traverse</code> is set (Nick Craig-Wood)
<ul>
<li>this fixes <code>--files-from</code> with Google drive and excessive
API use in general.</li>
</ul></li>
<li>Make server-side copy account bytes and obey
<code>--max-transfer</code> (Nick Craig-Wood)</li>
<li>Add <code>--create-empty-src-dirs</code> flag and default to not
creating empty dirs (ishuah)</li>
<li>Add client side TLS/SSL flags
<code>--ca-cert</code>/<code>--client-cert</code>/<code>--client-key</code>
(Nick Craig-Wood)</li>
<li>Implement <code>--suffix-keep-extension</code> for use with
<code>--suffix</code> (Nick Craig-Wood)</li>
<li>build:
<ul>
<li>Switch to semver compliant version tags to be go modules compliant
(Nick Craig-Wood)</li>
<li>Update to use go1.12.x for the build (Nick Craig-Wood)</li>
</ul></li>
<li>serve dlna: Add connection manager service description to improve
compatibility (Dan Walters)</li>
<li>lsf: Add ‘e’ format to show encrypted names and ‘o’ for original IDs
(Nick Craig-Wood)</li>
<li>lsjson: Added <code>--files-only</code> and <code>--dirs-only</code>
flags (calistri)</li>
<li>rc: Implement operations/publiclink the equivalent of
<code>rclone link</code> (Nick Craig-Wood)</li>
</ul></li>
<li>Bug Fixes
<ul>
<li>accounting: Fix total ETA when <code>--stats-unit bits</code> is in
effect (Nick Craig-Wood)</li>
<li>Bash TAB completion
<ul>
<li>Use private custom func to fix clash between rclone and kubectl
(Nick Craig-Wood)</li>
<li>Fix for remotes with underscores in their names (Six)</li>
<li>Fix completion of remotes (Florian Gamböck)</li>
<li>Fix autocompletion of remote paths with spaces (Danil
Semelenov)</li>
</ul></li>
<li>serve dlna: Fix root XML service descriptor (Dan Walters)</li>
<li>ncdu: Fix display corruption with Chinese characters (Nick
Craig-Wood)</li>
<li>Add SIGTERM to signals which run the exit handlers on unix (Nick
Craig-Wood)</li>
<li>rc: Reload filter when the options are set via the rc (Nick
Craig-Wood)</li>
</ul></li>
<li>VFS / Mount
<ul>
<li>Fix FreeBSD: Ignore Truncate if called with no readers and already
the correct size (Nick Craig-Wood)</li>
<li>Read directory and check for a file before mkdir (Nick
Craig-Wood)</li>
<li>Shorten the locking window for vfs/refresh (Nick Craig-Wood)</li>
</ul></li>
<li>Azure Blob
<ul>
<li>Enable MD5 checksums when uploading files bigger than the “Cutoff”
(Dr.Rx)</li>
<li>Fix SAS URL support (Nick Craig-Wood)</li>
</ul></li>
<li>B2
<ul>
<li>Allow manual configuration of backblaze downloadUrl (Vince)</li>
<li>Ignore already_hidden error on remove (Nick Craig-Wood)</li>
<li>Ignore malformed <code>src_last_modified_millis</code> (Nick
Craig-Wood)</li>
</ul></li>
<li>Drive
<ul>
<li>Add <code>--skip-checksum-gphotos</code> to ignore incorrect
checksums on Google Photos (Nick Craig-Wood)</li>
<li>Allow server-side move/copy between different remotes.
(Fionera)</li>
<li>Add docs on team drives and <code>--fast-list</code> eventual
consistency (Nestar47)</li>
<li>Fix imports of text files (Nick Craig-Wood)</li>
<li>Fix range requests on 0 length files (Nick Craig-Wood)</li>
<li>Fix creation of duplicates with server-side copy (Nick
Craig-Wood)</li>
</ul></li>
<li>Dropbox
<ul>
<li>Retry blank errors to fix long listings (Nick Craig-Wood)</li>
</ul></li>
<li>FTP
<ul>
<li>Add <code>--ftp-concurrency</code> to limit maximum number of
connections (Nick Craig-Wood)</li>
</ul></li>
<li>Google Cloud Storage
<ul>
<li>Fall back to default application credentials (marcintustin)</li>
<li>Allow bucket policy only buckets (Nick Craig-Wood)</li>
</ul></li>
<li>HTTP
<ul>
<li>Add <code>--http-no-slash</code> for websites with directories with
no slashes (Nick Craig-Wood)</li>
<li>Remove duplicates from listings (Nick Craig-Wood)</li>
<li>Fix socket leak on 404 errors (Nick Craig-Wood)</li>
</ul></li>
<li>Jottacloud
<ul>
<li>Fix token refresh (Sebastian Bünger)</li>
<li>Add device registration (Oliver Heyme)</li>
</ul></li>
<li>Onedrive
<ul>
<li>Implement graceful cancel of multipart uploads if rclone is
interrupted (Cnly)</li>
<li>Always add trailing colon to path when addressing items, (Cnly)</li>
<li>Return errors instead of panic for invalid uploads (Fabian
Möller)</li>
</ul></li>
<li>S3
<ul>
<li>Add support for “Glacier Deep Archive” storage class (Manu)</li>
<li>Update Dreamhost endpoint (Nick Craig-Wood)</li>
<li>Note incompatibility with CEPH Jewel (Nick Craig-Wood)</li>
</ul></li>
<li>SFTP
<ul>
<li>Allow custom ssh client config (Alexandru Bumbacea)</li>
</ul></li>
<li>Swift
<ul>
<li>Obey Retry-After to enable OVH restore from cold storage (Nick
Craig-Wood)</li>
<li>Work around token expiry on CEPH (Nick Craig-Wood)</li>
</ul></li>
<li>WebDAV
<ul>
<li>Allow IsCollection property to be integer or boolean (Nick
Craig-Wood)</li>
<li>Fix race when creating directories (Nick Craig-Wood)</li>
<li>Fix About/df when reading the available/total returns 0 (Nick
Craig-Wood)</li>
</ul></li>
</ul>
<h2 id="v1.46---2019-02-09">v1.46 - 2019-02-09</h2>
<ul>
<li>New backends
<ul>
<li>Support Alibaba Cloud (Aliyun) OSS via the s3 backend (Nick
Craig-Wood)</li>
</ul></li>
<li>New commands
<ul>
<li>serve dlna: serves a remove via DLNA for the local network
(nicolov)</li>
</ul></li>
<li>New Features
<ul>
<li>copy, move: Restore deprecated <code>--no-traverse</code> flag (Nick
Craig-Wood)
<ul>
<li>This is useful for when transferring a small number of files into a
large destination</li>
</ul></li>
<li>genautocomplete: Add remote path completion for bash completion
(Christopher Peterson &amp; Danil Semelenov)</li>
<li>Buffer memory handling reworked to return memory to the OS better
(Nick Craig-Wood)
<ul>
<li>Buffer recycling library to replace sync.Pool</li>
<li>Optionally use memory mapped memory for better memory shrinking</li>
<li>Enable with <code>--use-mmap</code> if having memory problems - not
default yet</li>
</ul></li>
<li>Parallelise reading of files specified by <code>--files-from</code>
(Nick Craig-Wood)</li>
<li>check: Add stats showing total files matched. (Dario Guzik)</li>
<li>Allow rename/delete open files under Windows (Nick Craig-Wood)</li>
<li>lsjson: Use exactly the correct number of decimal places in the
seconds (Nick Craig-Wood)</li>
<li>Add cookie support with cmdline switch <code>--use-cookies</code>
for all HTTP based remotes (qip)</li>
<li>Warn if <code>--checksum</code> is set but there are no hashes
available (Nick Craig-Wood)</li>
<li>Rework rate limiting (pacer) to be more accurate and allow bursting
(Nick Craig-Wood)</li>
<li>Improve error reporting for too many/few arguments in commands (Nick
Craig-Wood)</li>
<li>listremotes: Remove <code>-l</code> short flag as it conflicts with
the new global flag (weetmuts)</li>
<li>Make http serving with auth generate INFO messages on auth fail
(Nick Craig-Wood)</li>
</ul></li>
<li>Bug Fixes
<ul>
<li>Fix layout of stats (Nick Craig-Wood)</li>
<li>Fix <code>--progress</code> crash under Windows Jenkins (Nick
Craig-Wood)</li>
<li>Fix transfer of google/onedrive docs by calling Rcat in Copy when
size is -1 (Cnly)</li>
<li>copyurl: Fix checking of <code>--dry-run</code> (Denis Skovpen)</li>
</ul></li>
<li>Mount
<ul>
<li>Check that mountpoint and local directory to mount don’t overlap
(Nick Craig-Wood)</li>
<li>Fix mount size under 32 bit Windows (Nick Craig-Wood)</li>
</ul></li>
<li>VFS
<ul>
<li>Implement renaming of directories for backends without DirMove (Nick
Craig-Wood)
<ul>
<li>now all backends except b2 support renaming directories</li>
</ul></li>
<li>Implement <code>--vfs-cache-max-size</code> to limit the total size
of the cache (Nick Craig-Wood)</li>
<li>Add <code>--dir-perms</code> and <code>--file-perms</code> flags to
set default permissions (Nick Craig-Wood)</li>
<li>Fix deadlock on concurrent operations on a directory (Nick
Craig-Wood)</li>
<li>Fix deadlock between RWFileHandle.close and File.Remove (Nick
Craig-Wood)</li>
<li>Fix renaming/deleting open files with cache mode “writes” under
Windows (Nick Craig-Wood)</li>
<li>Fix panic on rename with <code>--dry-run</code> set (Nick
Craig-Wood)</li>
<li>Fix vfs/refresh with recurse=true needing the
<code>--fast-list</code> flag</li>
</ul></li>
<li>Local
<ul>
<li>Add support for <code>-l</code>/<code>--links</code> (symbolic link
translation) (yair@unicorn)
<ul>
<li>this works by showing links as <code>link.rclonelink</code> - see
local backend docs for more info</li>
<li>this errors if used with
<code>-L</code>/<code>--copy-links</code></li>
</ul></li>
<li>Fix renaming/deleting open files on Windows (Nick Craig-Wood)</li>
</ul></li>
<li>Crypt
<ul>
<li>Check for maximum length before decrypting filename to fix panic
(Garry McNulty)</li>
</ul></li>
<li>Azure Blob
<ul>
<li>Allow building azureblob backend on *BSD (themylogin)</li>
<li>Use the rclone HTTP client to support <code>--dump headers</code>,
<code>--tpslimit</code>, etc. (Nick Craig-Wood)</li>
<li>Use the s3 pacer for 0 delay in non error conditions (Nick
Craig-Wood)</li>
<li>Ignore directory markers (Nick Craig-Wood)</li>
<li>Stop Mkdir attempting to create existing containers (Nick
Craig-Wood)</li>
</ul></li>
<li>B2
<ul>
<li>cleanup: will remove unfinished large files &gt;24hrs old (Garry
McNulty)</li>
<li>For a bucket limited application key check the bucket name (Nick
Craig-Wood)
<ul>
<li>before this, rclone would use the authorised bucket regardless of
what you put on the command line</li>
</ul></li>
<li>Added <code>--b2-disable-checksum</code> flag (Wojciech Smigielski)
<ul>
<li>this enables large files to be uploaded without a SHA-1 hash for
speed reasons</li>
</ul></li>
</ul></li>
<li>Drive
<ul>
<li>Set default pacer to 100ms for 10 tps (Nick Craig-Wood)
<ul>
<li>This fits the Google defaults much better and reduces the 403 errors
massively</li>
<li>Add <code>--drive-pacer-min-sleep</code> and
<code>--drive-pacer-burst</code> to control the pacer</li>
</ul></li>
<li>Improve ChangeNotify support for items with multiple parents (Fabian
Möller)</li>
<li>Fix ListR for items with multiple parents - this fixes oddities with
<code>vfs/refresh</code> (Fabian Möller)</li>
<li>Fix using <code>--drive-impersonate</code> and appfolders (Nick
Craig-Wood)</li>
<li>Fix google docs in rclone mount for some (not all) applications
(Nick Craig-Wood)</li>
</ul></li>
<li>Dropbox
<ul>
<li>Retry-After support for Dropbox backend (Mathieu Carbou)</li>
</ul></li>
<li>FTP
<ul>
<li>Wait for 60 seconds for a connection to Close then declare it dead
(Nick Craig-Wood)
<ul>
<li>helps with indefinite hangs on some FTP servers</li>
</ul></li>
</ul></li>
<li>Google Cloud Storage
<ul>
<li>Update google cloud storage endpoints (weetmuts)</li>
</ul></li>
<li>HTTP
<ul>
<li>Add an example with username and password which is supported but
wasn’t documented (Nick Craig-Wood)</li>
<li>Fix backend with <code>--files-from</code> and nonexistent files
(Nick Craig-Wood)</li>
</ul></li>
<li>Hubic
<ul>
<li>Make error message more informative if authentication fails (Nick
Craig-Wood)</li>
</ul></li>
<li>Jottacloud
<ul>
<li>Resume and deduplication support (Oliver Heyme)</li>
<li>Use token auth for all API requests Don’t store password anymore
(Sebastian Bünger)</li>
<li>Add support for 2-factor authentication (Sebastian Bünger)</li>
</ul></li>
<li>Mega
<ul>
<li>Implement v2 account login which fixes logins for newer Mega
accounts (Nick Craig-Wood)</li>
<li>Return error if an unknown length file is attempted to be uploaded
(Nick Craig-Wood)</li>
<li>Add new error codes for better error reporting (Nick
Craig-Wood)</li>
</ul></li>
<li>Onedrive
<ul>
<li>Fix broken support for “shared with me” folders (Alex Chen)</li>
<li>Fix root ID not normalised (Cnly)</li>
<li>Return err instead of panic on unknown-sized uploads (Cnly)</li>
</ul></li>
<li>Qingstor
<ul>
<li>Fix go routine leak on multipart upload errors (Nick
Craig-Wood)</li>
<li>Add upload chunk size/concurrency/cutoff control (Nick
Craig-Wood)</li>
<li>Default <code>--qingstor-upload-concurrency</code> to 1 to work
around bug (Nick Craig-Wood)</li>
</ul></li>
<li>S3
<ul>
<li>Implement <code>--s3-upload-cutoff</code> for single part uploads
below this (Nick Craig-Wood)</li>
<li>Change <code>--s3-upload-concurrency</code> default to 4 to increase
performance (Nick Craig-Wood)</li>
<li>Add <code>--s3-bucket-acl</code> to control bucket ACL (Nick
Craig-Wood)</li>
<li>Auto detect region for buckets on operation failure (Nick
Craig-Wood)</li>
<li>Add GLACIER storage class (William Cocker)</li>
<li>Add Scaleway to s3 documentation (Rémy Léone)</li>
<li>Add AWS endpoint eu-north-1 (weetmuts)</li>
</ul></li>
<li>SFTP
<ul>
<li>Add support for PEM encrypted private keys (Fabian Möller)</li>
<li>Add option to force the usage of an ssh-agent (Fabian Möller)</li>
<li>Perform environment variable expansion on key-file (Fabian
Möller)</li>
<li>Fix rmdir on Windows based servers (e.g. CrushFTP) (Nick
Craig-Wood)</li>
<li>Fix rmdir deleting directory contents on some SFTP servers (Nick
Craig-Wood)</li>
<li>Fix error on dangling symlinks (Nick Craig-Wood)</li>
</ul></li>
<li>Swift
<ul>
<li>Add <code>--swift-no-chunk</code> to disable segmented uploads in
rcat/mount (Nick Craig-Wood)</li>
<li>Introduce application credential auth support (kayrus)</li>
<li>Fix memory usage by slimming Object (Nick Craig-Wood)</li>
<li>Fix extra requests on upload (Nick Craig-Wood)</li>
<li>Fix reauth on big files (Nick Craig-Wood)</li>
</ul></li>
<li>Union
<ul>
<li>Fix poll-interval not working (Nick Craig-Wood)</li>
</ul></li>
<li>WebDAV
<ul>
<li>Support About which means rclone mount will show the correct disk
size (Nick Craig-Wood)</li>
<li>Support MD5 and SHA1 hashes with Owncloud and Nextcloud (Nick
Craig-Wood)</li>
<li>Fail soft on time parsing errors (Nick Craig-Wood)</li>
<li>Fix infinite loop on failed directory creation (Nick
Craig-Wood)</li>
<li>Fix identification of directories for Bitrix Site Manager (Nick
Craig-Wood)</li>
<li>Fix upload of 0 length files on some servers (Nick Craig-Wood)</li>
<li>Fix if MKCOL fails with 423 Locked assume the directory exists (Nick
Craig-Wood)</li>
</ul></li>
</ul>
<h2 id="v1.45---2018-11-24">v1.45 - 2018-11-24</h2>
<ul>
<li>New backends
<ul>
<li>The Yandex backend was re-written - see below for details (Sebastian
Bünger)</li>
</ul></li>
<li>New commands
<ul>
<li>rcd: New command just to serve the remote control API (Nick
Craig-Wood)</li>
</ul></li>
<li>New Features
<ul>
<li>The remote control API (rc) was greatly expanded to allow full
control over rclone (Nick Craig-Wood)
<ul>
<li>sensitive operations require authorization or the
<code>--rc-no-auth</code> flag</li>
<li>config/* operations to configure rclone</li>
<li>options/* for reading/setting command line flags</li>
<li>operations/* for all low level operations, e.g. copy file, list
directory</li>
<li>sync/* for sync, copy and move</li>
<li><code>--rc-files</code> flag to serve files on the rc http server
<ul>
<li>this is for building web native GUIs for rclone</li>
</ul></li>
<li>Optionally serving objects on the rc http server</li>
<li>Ensure rclone fails to start up if the <code>--rc</code> port is in
use already</li>
<li>See <a href="https://rclone.org/rc/">the rc docs</a> for more
info</li>
</ul></li>
<li>sync/copy/move
<ul>
<li>Make <code>--files-from</code> only read the objects specified and
don’t scan directories (Nick Craig-Wood)
<ul>
<li>This is a huge speed improvement for destinations with lots of
files</li>
</ul></li>
</ul></li>
<li>filter: Add <code>--ignore-case</code> flag (Nick Craig-Wood)</li>
<li>ncdu: Add remove function (‘d’ key) (Henning Surmeier)</li>
<li>rc command
<ul>
<li>Add <code>--json</code> flag for structured JSON input (Nick
Craig-Wood)</li>
<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>
</ul></li>
<li>build
<ul>
<li>Require go1.8 or later for compilation (Nick Craig-Wood)</li>
<li>Enable softfloat on MIPS arch (Scott Edlund)</li>
<li>Integration test framework revamped with a better report and better
retries (Nick Craig-Wood)</li>
</ul></li>
</ul></li>
<li>Bug Fixes
<ul>
<li>cmd: Make <code>--progress</code> update the stats correctly at the
end (Nick Craig-Wood)</li>
<li>config: Create config directory on save if it is missing (Nick
Craig-Wood)</li>
<li>dedupe: Check for existing filename before renaming a dupe file
(ssaqua)</li>
<li>move: Don’t create directories with <code>--dry-run</code> (Nick
Craig-Wood)</li>
<li>operations: Fix Purge and Rmdirs when dir is not the root (Nick
Craig-Wood)</li>
<li>serve http/webdav/restic: Ensure rclone exits if the port is in use
(Nick Craig-Wood)</li>
</ul></li>
<li>Mount
<ul>
<li>Make <code>--volname</code> work for Windows and macOS (Nick
Craig-Wood)</li>
</ul></li>
<li>Azure Blob
<ul>
<li>Avoid context deadline exceeded error by setting a large TryTimeout
value (brused27)</li>
<li>Fix erroneous Rmdir error “directory not empty” (Nick
Craig-Wood)</li>
<li>Wait for up to 60s to create a just deleted container (Nick
Craig-Wood)</li>
</ul></li>
<li>Dropbox
<ul>
<li>Add dropbox impersonate support (Jake Coggiano)</li>
</ul></li>
<li>Jottacloud
<ul>
<li>Fix bug in <code>--fast-list</code> handing of empty folders
(albertony)</li>
</ul></li>
<li>Opendrive
<ul>
<li>Fix transfer of files with <code>+</code> and <code>&amp;</code> in
(Nick Craig-Wood)</li>
<li>Fix retries of upload chunks (Nick Craig-Wood)</li>
</ul></li>
<li>S3
<ul>
<li>Set ACL for server-side copies to that provided by the user (Nick
Craig-Wood)</li>
<li>Fix role_arn, credential_source, … (Erik Swanson)</li>
<li>Add config info for Wasabi’s US-West endpoint (Henry Ptasinski)</li>
</ul></li>
<li>SFTP
<ul>
<li>Ensure file hash checking is really disabled (Jon Fautley)</li>
</ul></li>
<li>Swift
<ul>
<li>Add pacer for retries to make swift more reliable (Nick
Craig-Wood)</li>
</ul></li>
<li>WebDAV
<ul>
<li>Add Content-Type to PUT requests (Nick Craig-Wood)</li>
<li>Fix config parsing so <code>--webdav-user</code> and
<code>--webdav-pass</code> flags work (Nick Craig-Wood)</li>
<li>Add RFC3339 date format (Ralf Hemberger)</li>
</ul></li>
<li>Yandex
<ul>
<li>The yandex backend was re-written (Sebastian Bünger)
<ul>
<li>This implements low level retries (Sebastian Bünger)</li>
<li>Copy, Move, DirMove, PublicLink and About optional interfaces
(Sebastian Bünger)</li>
<li>Improved general error handling (Sebastian Bünger)</li>
<li>Removed ListR for now due to inconsistent behaviour (Sebastian
Bünger)</li>
</ul></li>
</ul></li>
</ul>
<h2 id="v1.44---2018-10-15">v1.44 - 2018-10-15</h2>
<ul>
<li>New commands
<ul>
<li>serve ftp: Add ftp server (Antoine GIRARD)</li>
<li>settier: perform storage tier changes on supported remotes
(sandeepkru)</li>
</ul></li>
<li>New Features
<ul>
<li>Reworked command line help
<ul>
<li>Make default help less verbose (Nick Craig-Wood)</li>
<li>Split flags up into global and backend flags (Nick Craig-Wood)</li>
<li>Implement specialised help for flags and backends (Nick
Craig-Wood)</li>
<li>Show URL of backend help page when starting config (Nick
Craig-Wood)</li>
</ul></li>
<li>stats: Long names now split in center (Joanna Marek)</li>
<li>Add <code>--log-format</code> flag for more control over log output
(dcpu)</li>
<li>rc: Add support for OPTIONS and basic CORS (frenos)</li>
<li>stats: show FatalErrors and NoRetryErrors in stats (Cédric
Connes)</li>
</ul></li>
<li>Bug Fixes
<ul>
<li>Fix -P not ending with a new line (Nick Craig-Wood)</li>
<li>config: don’t create default config dir when user supplies
<code>--config</code> (albertony)</li>
<li>Don’t print non-ASCII characters with <code>--progress</code> on
windows (Nick Craig-Wood)</li>
<li>Correct logs for excluded items (ssaqua)</li>
</ul></li>
<li>Mount
<ul>
<li>Remove EXPERIMENTAL tags (Nick Craig-Wood)</li>
</ul></li>
<li>VFS
<ul>
<li>Fix race condition detected by serve ftp tests (Nick
Craig-Wood)</li>
<li>Add vfs/poll-interval rc command (Fabian Möller)</li>
<li>Enable rename for nearly all remotes using server-side Move or Copy
(Nick Craig-Wood)</li>
<li>Reduce directory cache cleared by poll-interval (Fabian Möller)</li>
<li>Remove EXPERIMENTAL tags (Nick Craig-Wood)</li>
</ul></li>
<li>Local
<ul>
<li>Skip bad symlinks in dir listing with -L enabled (Cédric
Connes)</li>
<li>Preallocate files on Windows to reduce fragmentation (Nick
Craig-Wood)</li>
<li>Preallocate files on linux with fallocate(2) (Nick Craig-Wood)</li>
</ul></li>
<li>Cache
<ul>
<li>Add cache/fetch rc function (Fabian Möller)</li>
<li>Fix worker scale down (Fabian Möller)</li>
<li>Improve performance by not sending info requests for cached chunks
(dcpu)</li>
<li>Fix error return value of cache/fetch rc method (Fabian Möller)</li>
<li>Documentation fix for cache-chunk-total-size (Anagh Kumar
Baranwal)</li>
<li>Preserve leading / in wrapped remote path (Fabian Möller)</li>
<li>Add plex_insecure option to skip certificate validation (Fabian
Möller)</li>
<li>Remove entries that no longer exist in the source (dcpu)</li>
</ul></li>
<li>Crypt
<ul>
<li>Preserve leading / in wrapped remote path (Fabian Möller)</li>
</ul></li>
<li>Alias
<ul>
<li>Fix handling of Windows network paths (Nick Craig-Wood)</li>
</ul></li>
<li>Azure Blob
<ul>
<li>Add <code>--azureblob-list-chunk</code> parameter (Santiago
Rodríguez)</li>
<li>Implemented settier command support on azureblob remote.
(sandeepkru)</li>
<li>Work around SDK bug which causes errors for chunk-sized files (Nick
Craig-Wood)</li>
</ul></li>
<li>Box
<ul>
<li>Implement link sharing. (Sebastian Bünger)</li>
</ul></li>
<li>Drive
<ul>
<li>Add <code>--drive-import-formats</code> - google docs can now be
imported (Fabian Möller)
<ul>
<li>Rewrite mime type and extension handling (Fabian Möller)</li>
<li>Add document links (Fabian Möller)</li>
<li>Add support for multipart document extensions (Fabian Möller)</li>
<li>Add support for apps-script to json export (Fabian Möller)</li>
<li>Fix escaped chars in documents during list (Fabian Möller)</li>
</ul></li>
<li>Add <code>--drive-v2-download-min-size</code> a workaround for slow
downloads (Fabian Möller)</li>
<li>Improve directory notifications in ChangeNotify (Fabian Möller)</li>
<li>When listing team drives in config, continue on failure (Nick
Craig-Wood)</li>
</ul></li>
<li>FTP
<ul>
<li>Add a small pause after failed upload before deleting file (Nick
Craig-Wood)</li>
</ul></li>
<li>Google Cloud Storage
<ul>
<li>Fix service_account_file being ignored (Fabian Möller)</li>
</ul></li>
<li>Jottacloud
<ul>
<li>Minor improvement in quota info (omit if unlimited) (albertony)</li>
<li>Add <code>--fast-list</code> support (albertony)</li>
<li>Add permanent delete support: <code>--jottacloud-hard-delete</code>
(albertony)</li>
<li>Add link sharing support (albertony)</li>
<li>Fix handling of reserved characters. (Sebastian Bünger)</li>
<li>Fix socket leak on Object.Remove (Nick Craig-Wood)</li>
</ul></li>
<li>Onedrive
<ul>
<li>Rework to support Microsoft Graph (Cnly)
<ul>
<li><strong>NB</strong> this will require re-authenticating the
remote</li>
</ul></li>
<li>Removed upload cutoff and always do session uploads (Oliver
Heyme)</li>
<li>Use single-part upload for empty files (Cnly)</li>
<li>Fix new fields not saved when editing old config (Alex Chen)</li>
<li>Fix sometimes special chars in filenames not replaced (Alex
Chen)</li>
<li>Ignore OneNote files by default (Alex Chen)</li>
<li>Add link sharing support (jackyzy823)</li>
</ul></li>
<li>S3
<ul>
<li>Use custom pacer, to retry operations when reasonable (Craig
Miskell)</li>
<li>Use configured server-side-encryption and storage class options when
calling CopyObject() (Paul Kohout)</li>
<li>Make <code>--s3-v2-auth</code> flag (Nick Craig-Wood)</li>
<li>Fix v2 auth on files with spaces (Nick Craig-Wood)</li>
</ul></li>
<li>Union
<ul>
<li>Implement union backend which reads from multiple backends (Felix
Brucker)</li>
<li>Implement optional interfaces (Move, DirMove, Copy, etc.) (Nick
Craig-Wood)</li>
<li>Fix ChangeNotify to support multiple remotes (Fabian Möller)</li>
<li>Fix <code>--backup-dir</code> on union backend (Nick
Craig-Wood)</li>
</ul></li>
<li>WebDAV
<ul>
<li>Add another time format (Nick Craig-Wood)</li>
<li>Add a small pause after failed upload before deleting file (Nick
Craig-Wood)</li>
<li>Add workaround for missing mtime (buergi)</li>
<li>Sharepoint: Renew cookies after 12hrs (Henning Surmeier)</li>
</ul></li>
<li>Yandex
<ul>
<li>Remove redundant nil checks (teresy)</li>
</ul></li>
</ul>
<h2 id="v1.43.1---2018-09-07">v1.43.1 - 2018-09-07</h2>
<p>Point release to fix hubic and azureblob backends.</p>
<ul>
<li>Bug Fixes
<ul>
<li>ncdu: Return error instead of log.Fatal in Show (Fabian Möller)</li>
<li>cmd: Fix crash with <code>--progress</code> and
<code>--stats 0</code> (Nick Craig-Wood)</li>
<li>docs: Tidy website display (Anagh Kumar Baranwal)</li>
</ul></li>
<li>Azure Blob:
<ul>
<li>Fix multi-part uploads. (sandeepkru)</li>
</ul></li>
<li>Hubic
<ul>
<li>Fix uploads (Nick Craig-Wood)</li>
<li>Retry auth fetching if it fails to make hubic more reliable (Nick
Craig-Wood)</li>
</ul></li>
</ul>
<h2 id="v1.43---2018-09-01">v1.43 - 2018-09-01</h2>
<ul>
<li>New backends
<ul>
<li>Jottacloud (Sebastian Bünger)</li>
</ul></li>
<li>New commands
<ul>
<li>copyurl: copies a URL to a remote (Denis)</li>
</ul></li>
<li>New Features
<ul>
<li>Reworked config for backends (Nick Craig-Wood)
<ul>
<li>All backend config can now be supplied by command line, env var or
config file</li>
<li>Advanced section in the config wizard for the optional items</li>
<li>A large step towards rclone backends being usable in other go
software</li>
<li>Allow on the fly remotes with :backend: syntax</li>
</ul></li>
<li>Stats revamp
<ul>
<li>Add <code>--progress</code>/<code>-P</code> flag to show interactive
progress (Nick Craig-Wood)</li>
<li>Show the total progress of the sync in the stats (Nick
Craig-Wood)</li>
<li>Add <code>--stats-one-line</code> flag for single line stats (Nick
Craig-Wood)</li>
</ul></li>
<li>Added weekday schedule into <code>--bwlimit</code> (Mateusz)</li>
<li>lsjson: Add option to show the original object IDs (Fabian
Möller)</li>
<li>serve webdav: Make Content-Type without reading the file and add
<code>--etag-hash</code> (Nick Craig-Wood)</li>
<li>build
<ul>
<li>Build macOS with native compiler (Nick Craig-Wood)</li>
<li>Update to use go1.11 for the build (Nick Craig-Wood)</li>
</ul></li>
<li>rc
<ul>
<li>Added core/stats to return the stats (reddi1)</li>
</ul></li>
<li><code>version --check</code>: Prints the current release and beta
versions (Nick Craig-Wood)</li>
</ul></li>
<li>Bug Fixes
<ul>
<li>accounting
<ul>
<li>Fix time to completion estimates (Nick Craig-Wood)</li>
<li>Fix moving average speed for file stats (Nick Craig-Wood)</li>
</ul></li>
<li>config: Fix error reading password from piped input (Nick
Craig-Wood)</li>
<li>move: Fix <code>--delete-empty-src-dirs</code> flag to delete all
empty dirs on move (ishuah)</li>
</ul></li>
<li>Mount
<ul>
<li>Implement <code>--daemon-timeout</code> flag for OSXFUSE (Nick
Craig-Wood)</li>
<li>Fix mount <code>--daemon</code> not working with encrypted config
(Alex Chen)</li>
<li>Clip the number of blocks to 2^32-1 on macOS - fixes borg backup
(Nick Craig-Wood)</li>
</ul></li>
<li>VFS
<ul>
<li>Enable vfs-read-chunk-size by default (Fabian Möller)</li>
<li>Add the vfs/refresh rc command (Fabian Möller)</li>
<li>Add non recursive mode to vfs/refresh rc command (Fabian
Möller)</li>
<li>Try to seek buffer on read only files (Fabian Möller)</li>
</ul></li>
<li>Local
<ul>
<li>Fix crash when deprecated
<code>--local-no-unicode-normalization</code> is supplied (Nick
Craig-Wood)</li>
<li>Fix mkdir error when trying to copy files to the root of a drive on
windows (Nick Craig-Wood)</li>
</ul></li>
<li>Cache
<ul>
<li>Fix nil pointer deref when using lsjson on cached directory (Nick
Craig-Wood)</li>
<li>Fix nil pointer deref for occasional crash on playback (Nick
Craig-Wood)</li>
</ul></li>
<li>Crypt
<ul>
<li>Fix accounting when checking hashes on upload (Nick Craig-Wood)</li>
</ul></li>
<li>Amazon Cloud Drive
<ul>
<li>Make very clear in the docs that rclone has no ACD keys (Nick
Craig-Wood)</li>
</ul></li>
<li>Azure Blob
<ul>
<li>Add connection string and SAS URL auth (Nick Craig-Wood)</li>
<li>List the container to see if it exists (Nick Craig-Wood)</li>
<li>Port new Azure Blob Storage SDK (sandeepkru)</li>
<li>Added blob tier, tier between Hot, Cool and Archive.
(sandeepkru)</li>
<li>Remove leading / from paths (Nick Craig-Wood)</li>
</ul></li>
<li>B2
<ul>
<li>Support Application Keys (Nick Craig-Wood)</li>
<li>Remove leading / from paths (Nick Craig-Wood)</li>
</ul></li>
<li>Box
<ul>
<li>Fix upload of &gt; 2GB files on 32 bit platforms (Nick
Craig-Wood)</li>
<li>Make <code>--box-commit-retries</code> flag defaulting to 100 to fix
large uploads (Nick Craig-Wood)</li>
</ul></li>
<li>Drive
<ul>
<li>Add <code>--drive-keep-revision-forever</code> flag (lewapm)</li>
<li>Handle gdocs when filtering file names in list (Fabian Möller)</li>
<li>Support using <code>--fast-list</code> for large speedups (Fabian
Möller)</li>
</ul></li>
<li>FTP
<ul>
<li>Fix Put mkParentDir failed: 521 for BunnyCDN (Nick Craig-Wood)</li>
</ul></li>
<li>Google Cloud Storage
<ul>
<li>Fix index out of range error with <code>--fast-list</code> (Nick
Craig-Wood)</li>
</ul></li>
<li>Jottacloud
<ul>
<li>Fix MD5 error check (Oliver Heyme)</li>
<li>Handle empty time values (Martin Polden)</li>
<li>Calculate missing MD5s (Oliver Heyme)</li>
<li>Docs, fixes and tests for MD5 calculation (Nick Craig-Wood)</li>
<li>Add optional MimeTyper interface. (Sebastian Bünger)</li>
<li>Implement optional About interface (for <code>df</code> support).
(Sebastian Bünger)</li>
</ul></li>
<li>Mega
<ul>
<li>Wait for events instead of arbitrary sleeping (Nick Craig-Wood)</li>
<li>Add <code>--mega-hard-delete</code> flag (Nick Craig-Wood)</li>
<li>Fix failed logins with upper case chars in email (Nick
Craig-Wood)</li>
</ul></li>
<li>Onedrive
<ul>
<li>Shared folder support (Yoni Jah)</li>
<li>Implement DirMove (Cnly)</li>
<li>Fix rmdir sometimes deleting directories with contents (Nick
Craig-Wood)</li>
</ul></li>
<li>Pcloud
<ul>
<li>Delete half uploaded files on upload error (Nick Craig-Wood)</li>
</ul></li>
<li>Qingstor
<ul>
<li>Remove leading / from paths (Nick Craig-Wood)</li>
</ul></li>
<li>S3
<ul>
<li>Fix index out of range error with <code>--fast-list</code> (Nick
Craig-Wood)</li>
<li>Add <code>--s3-force-path-style</code> (Nick Craig-Wood)</li>
<li>Add support for KMS Key ID (bsteiss)</li>
<li>Remove leading / from paths (Nick Craig-Wood)</li>
</ul></li>
<li>Swift
<ul>
<li>Add <code>storage_policy</code> (Ruben Vandamme)</li>
<li>Make it so just <code>storage_url</code> or <code>auth_token</code>
can be overridden (Nick Craig-Wood)</li>
<li>Fix server-side copy bug for unusual file names (Nick
Craig-Wood)</li>
<li>Remove leading / from paths (Nick Craig-Wood)</li>
</ul></li>
<li>WebDAV
<ul>
<li>Ensure we call MKCOL with a URL with a trailing / for QNAP interop
(Nick Craig-Wood)</li>
<li>If root ends with / then don’t check if it is a file (Nick
Craig-Wood)</li>
<li>Don’t accept redirects when reading metadata (Nick Craig-Wood)</li>
<li>Add bearer token (Macaroon) support for dCache (Nick
Craig-Wood)</li>
<li>Document dCache and Macaroons (Onno Zweers)</li>
<li>Sharepoint recursion with different depth (Henning)</li>
<li>Attempt to remove failed uploads (Nick Craig-Wood)</li>
</ul></li>
<li>Yandex
<ul>
<li>Fix listing/deleting files in the root (Nick Craig-Wood)</li>
</ul></li>
</ul>
<h2 id="v1.42---2018-06-16">v1.42 - 2018-06-16</h2>
<ul>
<li>New backends
<ul>
<li>OpenDrive (Oliver Heyme, Jakub Karlicek, ncw)</li>
</ul></li>
<li>New commands
<ul>
<li>deletefile command (Filip Bartodziej)</li>
</ul></li>
<li>New Features
<ul>
<li>copy, move: Copy single files directly, don’t use
<code>--files-from</code> work-around
<ul>
<li>this makes them much more efficient</li>
</ul></li>
<li>Implement <code>--max-transfer</code> flag to quit transferring at a
limit
<ul>
<li>make exit code 8 for <code>--max-transfer</code> exceeded</li>
</ul></li>
<li>copy: copy empty source directories to destination (Ishuah
Kariuki)</li>
<li>check: Add <code>--one-way</code> flag (Kasper Byrdal Nielsen)</li>
<li>Add siginfo handler for macOS for ctrl-T stats (kubatasiemski)</li>
<li>rc
<ul>
<li>add core/gc to run a garbage collection on demand</li>
<li>enable go profiling by default on the <code>--rc</code> port</li>
<li>return error from remote on failure</li>
</ul></li>
<li>lsf
<ul>
<li>Add <code>--absolute</code> flag to add a leading / onto path
names</li>
<li>Add <code>--csv</code> flag for compliant CSV output</li>
<li>Add ‘m’ format specifier to show the MimeType</li>
<li>Implement ‘i’ format for showing object ID</li>
</ul></li>
<li>lsjson
<ul>
<li>Add MimeType to the output</li>
<li>Add ID field to output to show Object ID</li>
</ul></li>
<li>Add <code>--retries-sleep</code> flag (Benjamin Joseph Dag)</li>
<li>Oauth tidy up web page and error handling (Henning Surmeier)</li>
</ul></li>
<li>Bug Fixes
<ul>
<li>Password prompt output with <code>--log-file</code> fixed for unix
(Filip Bartodziej)</li>
<li>Calculate ModifyWindow each time on the fly to fix various problems
(Stefan Breunig)</li>
</ul></li>
<li>Mount
<ul>
<li>Only print “File.rename error” if there actually is an error (Stefan
Breunig)</li>
<li>Delay rename if file has open writers instead of failing outright
(Stefan Breunig)</li>
<li>Ensure atexit gets run on interrupt</li>
<li>macOS enhancements
<ul>
<li>Make <code>--noappledouble</code> <code>--noapplexattr</code></li>
<li>Add <code>--volname</code> flag and remove special chars from
it</li>
<li>Make Get/List/Set/Remove xattr return ENOSYS for efficiency</li>
<li>Make <code>--daemon</code> work for macOS without CGO</li>
</ul></li>
</ul></li>
<li>VFS
<ul>
<li>Add <code>--vfs-read-chunk-size</code> and
<code>--vfs-read-chunk-size-limit</code> (Fabian Möller)</li>
<li>Fix ChangeNotify for new or changed folders (Fabian Möller)</li>
</ul></li>
<li>Local
<ul>
<li>Fix symlink/junction point directory handling under Windows
<ul>
<li><strong>NB</strong> you will need to add <code>-L</code> to your
command line to copy files with reparse points</li>
</ul></li>
</ul></li>
<li>Cache
<ul>
<li>Add non cached dirs on notifications (Remus Bunduc)</li>
<li>Allow root to be expired from rc (Remus Bunduc)</li>
<li>Clean remaining empty folders from temp upload path (Remus
Bunduc)</li>
<li>Cache lists using batch writes (Remus Bunduc)</li>
<li>Use secure websockets for HTTPS Plex addresses (John Clayton)</li>
<li>Reconnect plex websocket on failures (Remus Bunduc)</li>
<li>Fix panic when running without plex configs (Remus Bunduc)</li>
<li>Fix root folder caching (Remus Bunduc)</li>
</ul></li>
<li>Crypt
<ul>
<li>Check the crypted hash of files when uploading for extra data
security</li>
</ul></li>
<li>Dropbox
<ul>
<li>Make Dropbox for business folders accessible using an initial
<code>/</code> in the path</li>
</ul></li>
<li>Google Cloud Storage
<ul>
<li>Low level retry all operations if necessary</li>
</ul></li>
<li>Google Drive
<ul>
<li>Add <code>--drive-acknowledge-abuse</code> to download flagged
files</li>
<li>Add <code>--drive-alternate-export</code> to fix large doc
export</li>
<li>Don’t attempt to choose Team Drives when using rclone config
create</li>
<li>Fix change list polling with team drives</li>
<li>Fix ChangeNotify for folders (Fabian Möller)</li>
<li>Fix about (and df on a mount) for team drives</li>
</ul></li>
<li>Onedrive
<ul>
<li>Errorhandler for onedrive for business requests (Henning
Surmeier)</li>
</ul></li>
<li>S3
<ul>
<li>Adjust upload concurrency with <code>--s3-upload-concurrency</code>
(themylogin)</li>
<li>Fix <code>--s3-chunk-size</code> which was always using the
minimum</li>
</ul></li>
<li>SFTP
<ul>
<li>Add <code>--ssh-path-override</code> flag (Piotr Oleszczyk)</li>
<li>Fix slow downloads for long latency connections</li>
</ul></li>
<li>Webdav
<ul>
<li>Add workarounds for biz.mail.ru</li>
<li>Ignore Reason-Phrase in status line to fix 4shared (Rodrigo)</li>
<li>Better error message generation</li>
</ul></li>
</ul>
<h2 id="v1.41---2018-04-28">v1.41 - 2018-04-28</h2>
<ul>
<li>New backends
<ul>
<li>Mega support added</li>
<li>Webdav now supports SharePoint cookie authentication (hensur)</li>
</ul></li>
<li>New commands
<ul>
<li>link: create public link to files and folders (Stefan Breunig)</li>
<li>about: gets quota info from a remote (a-roussos, ncw)</li>
<li>hashsum: a generic tool for any hash to produce md5sum like
output</li>
</ul></li>
<li>New Features
<ul>
<li>lsd: Add -R flag and fix and update docs for all ls commands</li>
<li>ncdu: added a “refresh” key - CTRL-L (Keith Goldfarb)</li>
<li>serve restic: Add append-only mode (Steve Kriss)</li>
<li>serve restic: Disallow overwriting files in append-only mode
(Alexander Neumann)</li>
<li>serve restic: Print actual listener address (Matt Holt)</li>
<li>size: Add –json flag (Matthew Holt)</li>
<li>sync: implement –ignore-errors (Mateusz Pabian)</li>
<li>dedupe: Add dedupe largest functionality (Richard Yang)</li>
<li>fs: Extend SizeSuffix to include TB and PB for rclone about</li>
<li>fs: add –dump goroutines and –dump openfiles for debugging</li>
<li>rc: implement core/memstats to print internal memory usage info</li>
<li>rc: new call rc/pid (Michael P. Dubner)</li>
</ul></li>
<li>Compile
<ul>
<li>Drop support for go1.6</li>
</ul></li>
<li>Release
<ul>
<li>Fix <code>make tarball</code> (Chih-Hsuan Yen)</li>
</ul></li>
<li>Bug Fixes
<ul>
<li>filter: fix –min-age and –max-age together check</li>
<li>fs: limit MaxIdleConns and MaxIdleConnsPerHost in transport</li>
<li>lsd,lsf: make sure all times we output are in local time</li>
<li>rc: fix setting bwlimit to unlimited</li>
<li>rc: take note of the –rc-addr flag too as per the docs</li>
</ul></li>
<li>Mount
<ul>
<li>Use About to return the correct disk total/used/free (e.g. in
<code>df</code>)</li>
<li>Set <code>--attr-timeout default</code> to <code>1s</code> - fixes:
<ul>
<li>rclone using too much memory</li>
<li>rclone not serving files to samba</li>
<li>excessive time listing directories</li>
</ul></li>
<li>Fix <code>df -i</code> (upstream fix)</li>
</ul></li>
<li>VFS
<ul>
<li>Filter files <code>.</code> and <code>..</code> from directory
listing</li>
<li>Only make the VFS cache if –vfs-cache-mode &gt; Off</li>
</ul></li>
<li>Local
<ul>
<li>Add –local-no-check-updated to disable updated file checks</li>
<li>Retry remove on Windows sharing violation error</li>
</ul></li>
<li>Cache
<ul>
<li>Flush the memory cache after close</li>
<li>Purge file data on notification</li>
<li>Always forget parent dir for notifications</li>
<li>Integrate with Plex websocket</li>
<li>Add rc cache/stats (seuffert)</li>
<li>Add info log on notification</li>
</ul></li>
<li>Box
<ul>
<li>Fix failure reading large directories - parse file/directory size as
float</li>
</ul></li>
<li>Dropbox
<ul>
<li>Fix crypt+obfuscate on dropbox</li>
<li>Fix repeatedly uploading the same files</li>
</ul></li>
<li>FTP
<ul>
<li>Work around strange response from box FTP server</li>
<li>More workarounds for FTP servers to fix mkParentDir error</li>
<li>Fix no error on listing nonexistent directory</li>
</ul></li>
<li>Google Cloud Storage
<ul>
<li>Add service_account_credentials (Matt Holt)</li>
<li>Detect bucket presence by listing it - minimises permissions
needed</li>
<li>Ignore zero length directory markers</li>
</ul></li>
<li>Google Drive
<ul>
<li>Add service_account_credentials (Matt Holt)</li>
<li>Fix directory move leaving a hardlinked directory behind</li>
<li>Return proper google errors when Opening files</li>
<li>When initialized with a filepath, optional features used incorrect
root path (Stefan Breunig)</li>
</ul></li>
<li>HTTP
<ul>
<li>Fix sync for servers which don’t return Content-Length in HEAD</li>
</ul></li>
<li>Onedrive
<ul>
<li>Add QuickXorHash support for OneDrive for business</li>
<li>Fix socket leak in multipart session upload</li>
</ul></li>
<li>S3
<ul>
<li>Look in S3 named profile files for credentials</li>
<li>Add <code>--s3-disable-checksum</code> to disable checksum uploading
(Chris Redekop)</li>
<li>Hierarchical configuration support (Giri Badanahatti)</li>
<li>Add in config for all the supported S3 providers</li>
<li>Add One Zone Infrequent Access storage class (Craig Rachel)</li>
<li>Add –use-server-modtime support (Peter Baumgartner)</li>
<li>Add –s3-chunk-size option to control multipart uploads</li>
<li>Ignore zero length directory markers</li>
</ul></li>
<li>SFTP
<ul>
<li>Update docs to match code, fix typos and clarify disable_hashcheck
prompt (Michael G. Noll)</li>
<li>Update docs with Synology quirks</li>
<li>Fail soft with a debug on hash failure</li>
</ul></li>
<li>Swift
<ul>
<li>Add –use-server-modtime support (Peter Baumgartner)</li>
</ul></li>
<li>Webdav
<ul>
<li>Support SharePoint cookie authentication (hensur)</li>
<li>Strip leading and trailing / off root</li>
</ul></li>
</ul>
<h2 id="v1.40---2018-03-19">v1.40 - 2018-03-19</h2>
<ul>
<li>New backends
<ul>
<li>Alias backend to create aliases for existing remote names (Fabian
Möller)</li>
</ul></li>
<li>New commands
<ul>
<li><code>lsf</code>: list for parsing purposes (Jakub Tasiemski)
<ul>
<li>by default this is a simple non recursive list of files and
directories</li>
<li>it can be configured to add more info in an easy to parse way</li>
</ul></li>
<li><code>serve restic</code>: for serving a remote as a Restic REST
endpoint
<ul>
<li>This enables restic to use any backends that rclone can access</li>
<li>Thanks Alexander Neumann for help, patches and review</li>
</ul></li>
<li><code>rc</code>: enable the remote control of a running rclone
<ul>
<li>The running rclone must be started with –rc and related flags.</li>
<li>Currently there is support for bwlimit, and flushing for mount and
cache.</li>
</ul></li>
</ul></li>
<li>New Features
<ul>
<li><code>--max-delete</code> flag to add a delete threshold (Bjørn Erik
Pedersen)</li>
<li>All backends now support RangeOption for ranged Open
<ul>
<li><code>cat</code>: Use RangeOption for limited fetches to make more
efficient</li>
<li><code>cryptcheck</code>: make reading of nonce more efficient with
RangeOption</li>
</ul></li>
<li>serve http/webdav/restic
<ul>
<li>support SSL/TLS</li>
<li>add <code>--user</code> <code>--pass</code> and
<code>--htpasswd</code> for authentication</li>
</ul></li>
<li><code>copy</code>/<code>move</code>: detect file size change during
copy/move and abort transfer (ishuah)</li>
<li><code>cryptdecode</code>: added option to return encrypted file
names. (ishuah)</li>
<li><code>lsjson</code>: add <code>--encrypted</code> to show encrypted
name (Jakub Tasiemski)</li>
<li>Add <code>--stats-file-name-length</code> to specify the printed
file name length for stats (Will Gunn)</li>
</ul></li>
<li>Compile
<ul>
<li>Code base was shuffled and factored
<ul>
<li>backends moved into a backend directory</li>
<li>large packages split up</li>
<li>See the CONTRIBUTING.md doc for info as to what lives where now</li>
</ul></li>
<li>Update to using go1.10 as the default go version</li>
<li>Implement daily <a
href="https://pub.rclone.org/integration-tests/">full integration
tests</a></li>
</ul></li>
<li>Release
<ul>
<li>Include a source tarball and sign it and the binaries</li>
<li>Sign the git tags as part of the release process</li>
<li>Add .deb and .rpm packages as part of the build</li>
<li>Make a beta release for all branches on the main repo (but not pull
requests)</li>
</ul></li>
<li>Bug Fixes
<ul>
<li>config: fixes errors on nonexistent config by loading config file
only on first access</li>
<li>config: retry saving the config after failure (Mateusz)</li>
<li>sync: when using <code>--backup-dir</code> don’t delete files if we
can’t set their modtime
<ul>
<li>this fixes odd behaviour with Dropbox and
<code>--backup-dir</code></li>
</ul></li>
<li>fshttp: fix idle timeouts for HTTP connections</li>
<li><code>serve http</code>: fix serving files with : in - fixes</li>
<li>Fix <code>--exclude-if-present</code> to ignore directories which it
doesn’t have permission for (Iakov Davydov)</li>
<li>Make accounting work properly with crypt and b2</li>
<li>remove <code>--no-traverse</code> flag because it is obsolete</li>
</ul></li>
<li>Mount
<ul>
<li>Add <code>--attr-timeout</code> flag to control attribute caching in
kernel
<ul>
<li>this now defaults to 0 which is correct but less efficient</li>
<li>see <a
href="https://rclone.org/commands/rclone_mount/#attribute-caching">the
mount docs</a> for more info</li>
</ul></li>
<li>Add <code>--daemon</code> flag to allow mount to run in the
background (ishuah)</li>
<li>Fix: Return ENOSYS rather than EIO on attempted link
<ul>
<li>This fixes FileZilla accessing an rclone mount served over
sftp.</li>
</ul></li>
<li>Fix setting modtime twice</li>
<li>Mount tests now run on CI for Linux (mount &amp;
cmount)/Mac/Windows</li>
<li>Many bugs fixed in the VFS layer - see below</li>
</ul></li>
<li>VFS
<ul>
<li>Many fixes for <code>--vfs-cache-mode</code> writes and above
<ul>
<li>Update cached copy if we know it has changed (fixes stale data)</li>
<li>Clean path names before using them in the cache</li>
<li>Disable cache cleaner if
<code>--vfs-cache-poll-interval=0</code></li>
<li>Fill and clean the cache immediately on startup</li>
</ul></li>
<li>Fix Windows opening every file when it stats the file</li>
<li>Fix applying modtime for an open Write Handle</li>
<li>Fix creation of files when truncating</li>
<li>Write 0 bytes when flushing unwritten handles to avoid race
conditions in FUSE</li>
<li>Downgrade “poll-interval is not supported” message to Info</li>
<li>Make OpenFile and friends return EINVAL if O_RDONLY and O_TRUNC</li>
</ul></li>
<li>Local
<ul>
<li>Downgrade “invalid cross-device link: trying copy” to debug</li>
<li>Make DirMove return fs.ErrorCantDirMove to allow fallback to Copy
for cross device</li>
<li>Fix race conditions updating the hashes</li>
</ul></li>
<li>Cache
<ul>
<li>Add support for polling - cache will update when remote changes on
supported backends</li>
<li>Reduce log level for Plex api</li>
<li>Fix dir cache issue</li>
<li>Implement <code>--cache-db-wait-time</code> flag</li>
<li>Improve efficiency with RangeOption and RangeSeek</li>
<li>Fix dirmove with temp fs enabled</li>
<li>Notify vfs when using temp fs</li>
<li>Offline uploading</li>
<li>Remote control support for path flushing</li>
</ul></li>
<li>Amazon cloud drive
<ul>
<li>Rclone no longer has any working keys - disable integration
tests</li>
<li>Implement DirChangeNotify to notify cache/vfs/mount of changes</li>
</ul></li>
<li>Azureblob
<ul>
<li>Don’t check for bucket/container presence if listing was OK
<ul>
<li>this makes rclone do one less request per invocation</li>
</ul></li>
<li>Improve accounting for chunked uploads</li>
</ul></li>
<li>Backblaze B2
<ul>
<li>Don’t check for bucket/container presence if listing was OK
<ul>
<li>this makes rclone do one less request per invocation</li>
</ul></li>
</ul></li>
<li>Box
<ul>
<li>Improve accounting for chunked uploads</li>
</ul></li>
<li>Dropbox
<ul>
<li>Fix custom oauth client parameters</li>
</ul></li>
<li>Google Cloud Storage
<ul>
<li>Don’t check for bucket/container presence if listing was OK
<ul>
<li>this makes rclone do one less request per invocation</li>
</ul></li>
</ul></li>
<li>Google Drive
<ul>
<li>Migrate to api v3 (Fabian Möller)</li>
<li>Add scope configuration and root folder selection</li>
<li>Add <code>--drive-impersonate</code> for service accounts
<ul>
<li>thanks to everyone who tested, explored and contributed docs</li>
</ul></li>
<li>Add <code>--drive-use-created-date</code> to use created date as
modified date (nbuchanan)</li>
<li>Request the export formats only when required
<ul>
<li>This makes rclone quicker when there are no google docs</li>
</ul></li>
<li>Fix finding paths with latin1 chars (a workaround for a drive
bug)</li>
<li>Fix copying of a single Google doc file</li>
<li>Fix <code>--drive-auth-owner-only</code> to look in all
directories</li>
</ul></li>
<li>HTTP
<ul>
<li>Fix handling of directories with &amp; in</li>
</ul></li>
<li>Onedrive
<ul>
<li>Removed upload cutoff and always do session uploads
<ul>
<li>this stops the creation of multiple versions on business
onedrive</li>
</ul></li>
<li>Overwrite object size value with real size when reading file.
(Victor)
<ul>
<li>this fixes oddities when onedrive misreports the size of images</li>
</ul></li>
</ul></li>
<li>Pcloud
<ul>
<li>Remove unused chunked upload flag and code</li>
</ul></li>
<li>Qingstor
<ul>
<li>Don’t check for bucket/container presence if listing was OK
<ul>
<li>this makes rclone do one less request per invocation</li>
</ul></li>
</ul></li>
<li>S3
<ul>
<li>Support hashes for multipart files (Chris Redekop)</li>
<li>Initial support for IBM COS (S3) (Giri Badanahatti)</li>
<li>Update docs to discourage use of v2 auth with CEPH and others</li>
<li>Don’t check for bucket/container presence if listing was OK
<ul>
<li>this makes rclone do one less request per invocation</li>
</ul></li>
<li>Fix server-side copy and set modtime on files with + in</li>
</ul></li>
<li>SFTP
<ul>
<li>Add option to disable remote hash check command execution (Jon
Fautley)</li>
<li>Add <code>--sftp-ask-password</code> flag to prompt for password
when needed (Leo R. Lundgren)</li>
<li>Add <code>set_modtime</code> configuration option</li>
<li>Fix following of symlinks</li>
<li>Fix reading config file outside of Fs setup</li>
<li>Fix reading $USER in username fallback not $HOME</li>
<li>Fix running under crontab - Use correct OS way of reading
username</li>
</ul></li>
<li>Swift
<ul>
<li>Fix refresh of authentication token
<ul>
<li>in v1.39 a bug was introduced which ignored new tokens - this fixes
it</li>
</ul></li>
<li>Fix extra HEAD transaction when uploading a new file</li>
<li>Don’t check for bucket/container presence if listing was OK
<ul>
<li>this makes rclone do one less request per invocation</li>
</ul></li>
</ul></li>
<li>Webdav
<ul>
<li>Add new time formats to support mydrive.ch and others</li>
</ul></li>
</ul>
<h2 id="v1.39---2017-12-23">v1.39 - 2017-12-23</h2>
<ul>
<li>New backends
<ul>
<li>WebDAV
<ul>
<li>tested with nextcloud, owncloud, put.io and others!</li>
</ul></li>
<li>Pcloud</li>
<li>cache - wraps a cache around other backends (Remus Bunduc)
<ul>
<li>useful in combination with mount</li>
<li>NB this feature is in beta so use with care</li>
</ul></li>
</ul></li>
<li>New commands
<ul>
<li>serve command with subcommands:
<ul>
<li>serve webdav: this implements a webdav server for any rclone
remote.</li>
<li>serve http: command to serve a remote over HTTP</li>
</ul></li>
<li>config: add sub commands for full config file management
<ul>
<li>create/delete/dump/edit/file/password/providers/show/update</li>
</ul></li>
<li>touch: to create or update the timestamp of a file (Jakub
Tasiemski)</li>
</ul></li>
<li>New Features
<ul>
<li>curl install for rclone (Filip Bartodziej)</li>
<li>–stats now shows percentage, size, rate and ETA in condensed form
(Ishuah Kariuki)</li>
<li>–exclude-if-present to exclude a directory if a file is present
(Iakov Davydov)</li>
<li>rmdirs: add –leave-root flag (lewapm)</li>
<li>move: add –delete-empty-src-dirs flag to remove dirs after move
(Ishuah Kariuki)</li>
<li>Add –dump flag, introduce –dump requests, responses and remove
–dump-auth, –dump-filters
<ul>
<li>Obscure X-Auth-Token: from headers when dumping too</li>
</ul></li>
<li>Document and implement exit codes for different failure modes
(Ishuah Kariuki)</li>
</ul></li>
<li>Compile</li>
<li>Bug Fixes
<ul>
<li>Retry lots more different types of errors to make multipart
transfers more reliable</li>
<li>Save the config before asking for a token, fixes disappearing oauth
config</li>
<li>Warn the user if –include and –exclude are used together (Ernest
Borowski)</li>
<li>Fix duplicate files (e.g. on Google drive) causing spurious
copies</li>
<li>Allow trailing and leading whitespace for passwords (Jason
Rose)</li>
<li>ncdu: fix crashes on empty directories</li>
<li>rcat: fix goroutine leak</li>
<li>moveto/copyto: Fix to allow copying to the same name</li>
</ul></li>
<li>Mount
<ul>
<li>–vfs-cache mode to make writes into mounts more reliable.
<ul>
<li>this requires caching files on the disk (see –cache-dir)</li>
<li>As this is a new feature, use with care</li>
</ul></li>
<li>Use sdnotify to signal systemd the mount is ready (Fabian
Möller)</li>
<li>Check if directory is not empty before mounting (Ernest
Borowski)</li>
</ul></li>
<li>Local
<ul>
<li>Add error message for cross file system moves</li>
<li>Fix equality check for times</li>
</ul></li>
<li>Dropbox
<ul>
<li>Rework multipart upload
<ul>
<li>buffer the chunks when uploading large files so they can be
retried</li>
<li>change default chunk size to 48MB now we are buffering them in
memory</li>
<li>retry every error after the first chunk is done successfully</li>
</ul></li>
<li>Fix error when renaming directories</li>
</ul></li>
<li>Swift
<ul>
<li>Fix crash on bad authentication</li>
</ul></li>
<li>Google Drive
<ul>
<li>Add service account support (Tim Cooijmans)</li>
</ul></li>
<li>S3
<ul>
<li>Make it work properly with Digital Ocean Spaces (Andrew
Starr-Bochicchio)</li>
<li>Fix crash if a bad listing is received</li>
<li>Add support for ECS task IAM roles (David Minor)</li>
</ul></li>
<li>Backblaze B2
<ul>
<li>Fix multipart upload retries</li>
<li>Fix –hard-delete to make it work 100% of the time</li>
</ul></li>
<li>Swift
<ul>
<li>Allow authentication with storage URL and auth key (Giovanni
Pizzi)</li>
<li>Add new fields for swift configuration to support IBM Bluemix Swift
(Pierre Carlson)</li>
<li>Add OS_TENANT_ID and OS_USER_ID to config</li>
<li>Allow configs with user id instead of user name</li>
<li>Check if swift segments container exists before creating (John
Leach)</li>
<li>Fix memory leak in swift transfers (upstream fix)</li>
</ul></li>
<li>SFTP
<ul>
<li>Add option to enable the use of aes128-cbc cipher (Jon Fautley)</li>
</ul></li>
<li>Amazon cloud drive
<ul>
<li>Fix download of large files failing with “Only one auth mechanism
allowed”</li>
</ul></li>
<li>crypt
<ul>
<li>Option to encrypt directory names or leave them intact</li>
<li>Implement DirChangeNotify (Fabian Möller)</li>
</ul></li>
<li>onedrive
<ul>
<li>Add option to choose resourceURL during setup of OneDrive Business
account if more than one is available for user</li>
</ul></li>
</ul>
<h2 id="v1.38---2017-09-30">v1.38 - 2017-09-30</h2>
<ul>
<li>New backends
<ul>
<li>Azure Blob Storage (thanks Andrei Dragomir)</li>
<li>Box</li>
<li>Onedrive for Business (thanks Oliver Heyme)</li>
<li>QingStor from QingCloud (thanks wuyu)</li>
</ul></li>
<li>New commands
<ul>
<li><code>rcat</code> - read from standard input and stream upload</li>
<li><code>tree</code> - shows a nicely formatted recursive listing</li>
<li><code>cryptdecode</code> - decode crypted file names (thanks
ishuah)</li>
<li><code>config show</code> - print the config file</li>
<li><code>config file</code> - print the config file location</li>
</ul></li>
<li>New Features
<ul>
<li>Empty directories are deleted on <code>sync</code></li>
<li><code>dedupe</code> - implement merging of duplicate
directories</li>
<li><code>check</code> and <code>cryptcheck</code> made more consistent
and use less memory</li>
<li><code>cleanup</code> for remaining remotes (thanks ishuah)</li>
<li><code>--immutable</code> for ensuring that files don’t change
(thanks Jacob McNamee)</li>
<li><code>--user-agent</code> option (thanks Alex McGrath Kraak)</li>
<li><code>--disable</code> flag to disable optional features</li>
<li><code>--bind</code> flag for choosing the local addr on outgoing
connections</li>
<li>Support for zsh auto-completion (thanks bpicode)</li>
<li>Stop normalizing file names but do a normalized compare in
<code>sync</code></li>
</ul></li>
<li>Compile
<ul>
<li>Update to using go1.9 as the default go version</li>
<li>Remove snapd build due to maintenance problems</li>
</ul></li>
<li>Bug Fixes
<ul>
<li>Improve retriable error detection which makes multipart uploads
better</li>
<li>Make <code>check</code> obey <code>--ignore-size</code></li>
<li>Fix bwlimit toggle in conjunction with schedules (thanks
cbruegg)</li>
<li><code>config</code> ensures newly written config is on the same
mount</li>
</ul></li>
<li>Local
<ul>
<li>Revert to copy when moving file across file system boundaries</li>
<li><code>--skip-links</code> to suppress symlink warnings (thanks
Zhiming Wang)</li>
</ul></li>
<li>Mount
<ul>
<li>Re-use <code>rcat</code> internals to support uploads from all
remotes</li>
</ul></li>
<li>Dropbox
<ul>
<li>Fix “entry doesn’t belong in directory” error</li>
<li>Stop using deprecated API methods</li>
</ul></li>
<li>Swift
<ul>
<li>Fix server-side copy to empty container with
<code>--fast-list</code></li>
</ul></li>
<li>Google Drive
<ul>
<li>Change the default for <code>--drive-use-trash</code> to
<code>true</code></li>
</ul></li>
<li>S3
<ul>
<li>Set session token when using STS (thanks Girish Ramakrishnan)</li>
<li>Glacier docs and error messages (thanks Jan Varho)</li>
<li>Read 1000 (not 1024) items in dir listings to fix Wasabi</li>
</ul></li>
<li>Backblaze B2
<ul>
<li>Fix SHA1 mismatch when downloading files with no SHA1</li>
<li>Calculate missing hashes on the fly instead of spooling</li>
<li><code>--b2-hard-delete</code> to permanently delete (not hide) files
(thanks John Papandriopoulos)</li>
</ul></li>
<li>Hubic
<ul>
<li>Fix creating containers - no longer have to use the
<code>default</code> container</li>
</ul></li>
<li>Swift
<ul>
<li>Optionally configure from a standard set of OpenStack environment
vars</li>
<li>Add <code>endpoint_type</code> config</li>
</ul></li>
<li>Google Cloud Storage
<ul>
<li>Fix bucket creation to work with limited permission users</li>
</ul></li>
<li>SFTP
<ul>
<li>Implement connection pooling for multiple ssh connections</li>
<li>Limit new connections per second</li>
<li>Add support for MD5 and SHA1 hashes where available (thanks
Christian Brüggemann)</li>
</ul></li>
<li>HTTP
<ul>
<li>Fix URL encoding issues</li>
<li>Fix directories with <code>:</code> in</li>
<li>Fix panic with URL encoded content</li>
</ul></li>
</ul>
<h2 id="v1.37---2017-07-22">v1.37 - 2017-07-22</h2>
<ul>
<li>New backends
<ul>
<li>FTP - thanks to Antonio Messina</li>
<li>HTTP - thanks to Vasiliy Tolstov</li>
</ul></li>
<li>New commands
<ul>
<li>rclone ncdu - for exploring a remote with a text based user
interface.</li>
<li>rclone lsjson - for listing with a machine-readable output</li>
<li>rclone dbhashsum - to show Dropbox style hashes of files (local or
Dropbox)</li>
</ul></li>
<li>New Features
<ul>
<li>Implement –fast-list flag
<ul>
<li>This allows remotes to list recursively if they can</li>
<li>This uses less transactions (important if you pay for them)</li>
<li>This may or may not be quicker</li>
<li>This will use more memory as it has to hold the listing in
memory</li>
<li>–old-sync-method deprecated - the remaining uses are covered by
–fast-list</li>
<li>This involved a major re-write of all the listing code</li>
</ul></li>
<li>Add –tpslimit and –tpslimit-burst to limit transactions per second
<ul>
<li>this is useful in conjunction with <code>rclone mount</code> to
limit external apps</li>
</ul></li>
<li>Add –stats-log-level so can see –stats without -v</li>
<li>Print password prompts to stderr - Hraban Luyat</li>
<li>Warn about duplicate files when syncing</li>
<li>Oauth improvements
<ul>
<li>allow auth_url and token_url to be set in the config file</li>
<li>Print redirection URI if using own credentials.</li>
</ul></li>
<li>Don’t Mkdir at the start of sync to save transactions</li>
</ul></li>
<li>Compile
<ul>
<li>Update build to go1.8.3</li>
<li>Require go1.6 for building rclone</li>
<li>Compile 386 builds with “GO386=387” for maximum compatibility</li>
</ul></li>
<li>Bug Fixes
<ul>
<li>Fix menu selection when no remotes</li>
<li>Config saving reworked to not kill the file if disk gets full</li>
<li>Don’t delete remote if name does not change while renaming</li>
<li>moveto, copyto: report transfers and checks as per move and
copy</li>
</ul></li>
<li>Local
<ul>
<li>Add –local-no-unicode-normalization flag - Bob Potter</li>
</ul></li>
<li>Mount
<ul>
<li>Now supported on Windows using cgofuse and WinFsp - thanks to Bill
Zissimopoulos for much help</li>
<li>Compare checksums on upload/download via FUSE</li>
<li>Unmount when program ends with SIGINT (Ctrl+C) or SIGTERM - Jérôme
Vizcaino</li>
<li>On read only open of file, make open pending until first read</li>
<li>Make –read-only reject modify operations</li>
<li>Implement ModTime via FUSE for remotes that support it</li>
<li>Allow modTime to be changed even before all writers are closed</li>
<li>Fix panic on renames</li>
<li>Fix hang on errored upload</li>
</ul></li>
<li>Crypt
<ul>
<li>Report the name:root as specified by the user</li>
<li>Add an “obfuscate” option for filename encryption - Stephen
Harris</li>
</ul></li>
<li>Amazon Drive
<ul>
<li>Fix initialization order for token renewer</li>
<li>Remove revoked credentials, allow oauth proxy config and update
docs</li>
</ul></li>
<li>B2
<ul>
<li>Reduce minimum chunk size to 5MB</li>
</ul></li>
<li>Drive
<ul>
<li>Add team drive support</li>
<li>Reduce bandwidth by adding fields for partial responses - Martin
Kristensen</li>
<li>Implement –drive-shared-with-me flag to view shared with me files -
Danny Tsai</li>
<li>Add –drive-trashed-only to read only the files in the trash</li>
<li>Remove obsolete –drive-full-list</li>
<li>Add missing seek to start on retries of chunked uploads</li>
<li>Fix stats accounting for upload</li>
<li>Convert / in names to a unicode equivalent (／)</li>
<li>Poll for Google Drive changes when mounted</li>
</ul></li>
<li>OneDrive
<ul>
<li>Fix the uploading of files with spaces</li>
<li>Fix initialization order for token renewer</li>
<li>Display speeds accurately when uploading - Yoni Jah</li>
<li>Swap to using http://localhost:53682/ as redirect URL - Michael
Ledin</li>
<li>Retry on token expired error, reset upload body on retry - Yoni
Jah</li>
</ul></li>
<li>Google Cloud Storage
<ul>
<li>Add ability to specify location and storage class via config and
command line - thanks gdm85</li>
<li>Create container if necessary on server-side copy</li>
<li>Increase directory listing chunk to 1000 to increase
performance</li>
<li>Obtain a refresh token for GCS - Steven Lu</li>
</ul></li>
<li>Yandex
<ul>
<li>Fix the name reported in log messages (was empty)</li>
<li>Correct error return for listing empty directory</li>
</ul></li>
<li>Dropbox
<ul>
<li>Rewritten to use the v2 API
<ul>
<li>Now supports ModTime
<ul>
<li>Can only set by uploading the file again</li>
<li>If you uploaded with an old rclone, rclone may upload everything
again</li>
<li>Use <code>--size-only</code> or <code>--checksum</code> to avoid
this</li>
</ul></li>
<li>Now supports the Dropbox content hashing scheme</li>
<li>Now supports low level retries</li>
</ul></li>
</ul></li>
<li>S3
<ul>
<li>Work around eventual consistency in bucket creation</li>
<li>Create container if necessary on server-side copy</li>
<li>Add us-east-2 (Ohio) and eu-west-2 (London) S3 regions - Zahiar
Ahmed</li>
</ul></li>
<li>Swift, Hubic
<ul>
<li>Fix zero length directory markers showing in the subdirectory
listing
<ul>
<li>this caused lots of duplicate transfers</li>
</ul></li>
<li>Fix paged directory listings
<ul>
<li>this caused duplicate directory errors</li>
</ul></li>
<li>Create container if necessary on server-side copy</li>
<li>Increase directory listing chunk to 1000 to increase
performance</li>
<li>Make sensible error if the user forgets the container</li>
</ul></li>
<li>SFTP
<ul>
<li>Add support for using ssh key files</li>
<li>Fix under Windows</li>
<li>Fix ssh agent on Windows</li>
<li>Adapt to latest version of library - Igor Kharin</li>
</ul></li>
</ul>
<h2 id="v1.36---2017-03-18">v1.36 - 2017-03-18</h2>
<ul>
<li>New Features
<ul>
<li>SFTP remote (Jack Schmidt)</li>
<li>Re-implement sync routine to work a directory at a time reducing
memory usage</li>
<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>
<li>Implement –backup-dir and –suffix</li>
<li>Implement –track-renames (initial implementation by Bjørn Erik
Pedersen)</li>
<li>Add time-based bandwidth limits (Lukas Loesche)</li>
<li>rclone cryptcheck: checks integrity of crypt remotes</li>
<li>Allow all config file variables and options to be set from
environment variables</li>
<li>Add –buffer-size parameter to control buffer size for copy</li>
<li>Make –delete-after the default</li>
<li>Add –ignore-checksum flag (fixed by Hisham Zarka)</li>
<li>rclone check: Add –download flag to check all the data, not just
hashes</li>
<li>rclone cat: add –head, –tail, –offset, –count and –discard</li>
<li>rclone config: when choosing from a list, allow the value to be
entered too</li>
<li>rclone config: allow rename and copy of remotes</li>
<li>rclone obscure: for generating encrypted passwords for rclone’s
config (T.C. Ferguson)</li>
<li>Comply with XDG Base Directory specification (Dario Giovannetti)
<ul>
<li>this moves the default location of the config file in a backwards
compatible way</li>
</ul></li>
<li>Release changes
<ul>
<li>Ubuntu snap support (Dedsec1)</li>
<li>Compile with go 1.8</li>
<li>MIPS/Linux big and little endian support</li>
</ul></li>
</ul></li>
<li>Bug Fixes
<ul>
<li>Fix copyto copying things to the wrong place if the destination dir
didn’t exist</li>
<li>Fix parsing of remotes in moveto and copyto</li>
<li>Fix –delete-before deleting files on copy</li>
<li>Fix –files-from with an empty file copying everything</li>
<li>Fix sync: don’t update mod times if –dry-run set</li>
<li>Fix MimeType propagation</li>
<li>Fix filters to add ** rules to directory rules</li>
</ul></li>
<li>Local
<ul>
<li>Implement -L, –copy-links flag to allow rclone to follow
symlinks</li>
<li>Open files in write only mode so rclone can write to an rclone
mount</li>
<li>Fix unnormalised unicode causing problems reading directories</li>
<li>Fix interaction between -x flag and –max-depth</li>
</ul></li>
<li>Mount
<ul>
<li>Implement proper directory handling (mkdir, rmdir, renaming)</li>
<li>Make include and exclude filters apply to mount</li>
<li>Implement read and write async buffers - control with
–buffer-size</li>
<li>Fix fsync on for directories</li>
<li>Fix retry on network failure when reading off crypt</li>
</ul></li>
<li>Crypt
<ul>
<li>Add –crypt-show-mapping to show encrypted file mapping</li>
<li>Fix crypt writer getting stuck in a loop
<ul>
<li><strong>IMPORTANT</strong> this bug had the potential to cause data
corruption when
<ul>
<li>reading data from a network based remote and</li>
<li>writing to a crypt on Google Drive</li>
</ul></li>
<li>Use the cryptcheck command to validate your data if you are
concerned</li>
<li>If syncing two crypt remotes, sync the unencrypted remote</li>
</ul></li>
</ul></li>
<li>Amazon Drive
<ul>
<li>Fix panics on Move (rename)</li>
<li>Fix panic on token expiry</li>
</ul></li>
<li>B2
<ul>
<li>Fix inconsistent listings and rclone check</li>
<li>Fix uploading empty files with go1.8</li>
<li>Constrain memory usage when doing multipart uploads</li>
<li>Fix upload url not being refreshed properly</li>
</ul></li>
<li>Drive
<ul>
<li>Fix Rmdir on directories with trashed files</li>
<li>Fix “Ignoring unknown object” when downloading</li>
<li>Add –drive-list-chunk</li>
<li>Add –drive-skip-gdocs (Károly Oláh)</li>
</ul></li>
<li>OneDrive
<ul>
<li>Implement Move</li>
<li>Fix Copy
<ul>
<li>Fix overwrite detection in Copy</li>
<li>Fix waitForJob to parse errors correctly</li>
</ul></li>
<li>Use token renewer to stop auth errors on long uploads</li>
<li>Fix uploading empty files with go1.8</li>
</ul></li>
<li>Google Cloud Storage
<ul>
<li>Fix depth 1 directory listings</li>
</ul></li>
<li>Yandex
<ul>
<li>Fix single level directory listing</li>
</ul></li>
<li>Dropbox
<ul>
<li>Normalise the case for single level directory listings</li>
<li>Fix depth 1 listing</li>
</ul></li>
<li>S3
<ul>
<li>Added ca-central-1 region (Jon Yergatian)</li>
</ul></li>
</ul>
<h2 id="v1.35---2017-01-02">v1.35 - 2017-01-02</h2>
<ul>
<li>New Features
<ul>
<li>moveto and copyto commands for choosing a destination name on
copy/move</li>
<li>rmdirs command to recursively delete empty directories</li>
<li>Allow repeated –include/–exclude/–filter options</li>
<li>Only show transfer stats on commands which transfer stuff
<ul>
<li>show stats on any command using the <code>--stats</code> flag</li>
</ul></li>
<li>Allow overlapping directories in move when server-side dir move is
supported</li>
<li>Add –stats-unit option - thanks Scott McGillivray</li>
</ul></li>
<li>Bug Fixes
<ul>
<li>Fix the config file being overwritten when two rclone instances are
running</li>
<li>Make rclone lsd obey the filters properly</li>
<li>Fix compilation on mips</li>
<li>Fix not transferring files that don’t differ in size</li>
<li>Fix panic on nil retry/fatal error</li>
</ul></li>
<li>Mount
<ul>
<li>Retry reads on error - should help with reliability a lot</li>
<li>Report the modification times for directories from the remote</li>
<li>Add bandwidth accounting and limiting (fixes –bwlimit)</li>
<li>If –stats provided will show stats and which files are
transferring</li>
<li>Support R/W files if truncate is set.</li>
<li>Implement statfs interface so df works</li>
<li>Note that write is now supported on Amazon Drive</li>
<li>Report number of blocks in a file - thanks Stefan Breunig</li>
</ul></li>
<li>Crypt
<ul>
<li>Prevent the user pointing crypt at itself</li>
<li>Fix failed to authenticate decrypted block errors
<ul>
<li>these will now return the underlying unexpected EOF instead</li>
</ul></li>
</ul></li>
<li>Amazon Drive
<ul>
<li>Add support for server-side move and directory move - thanks Stefan
Breunig</li>
<li>Fix nil pointer deref on size attribute</li>
</ul></li>
<li>B2
<ul>
<li>Use new prefix and delimiter parameters in directory listings
<ul>
<li>This makes –max-depth 1 dir listings as used in mount much
faster</li>
</ul></li>
<li>Reauth the account while doing uploads too - should help with token
expiry</li>
</ul></li>
<li>Drive
<ul>
<li>Make DirMove more efficient and complain about moving the root</li>
<li>Create destination directory on Move()</li>
</ul></li>
</ul>
<h2 id="v1.34---2016-11-06">v1.34 - 2016-11-06</h2>
<ul>
<li>New Features
<ul>
<li>Stop single file and <code>--files-from</code> operations iterating
through the source bucket.</li>
<li>Stop removing failed upload to cloud storage remotes</li>
<li>Make ContentType be preserved for cloud to cloud copies</li>
<li>Add support to toggle bandwidth limits via SIGUSR2 - thanks Marco
Paganini</li>
<li><code>rclone check</code> shows count of hashes that couldn’t be
checked</li>
<li><code>rclone listremotes</code> command</li>
<li>Support linux/arm64 build - thanks Fredrik Fornwall</li>
<li>Remove <code>Authorization:</code> lines from
<code>--dump-headers</code> output</li>
</ul></li>
<li>Bug Fixes
<ul>
<li>Ignore files with control characters in the names</li>
<li>Fix <code>rclone move</code> command
<ul>
<li>Delete src files which already existed in dst</li>
<li>Fix deletion of src file when dst file older</li>
</ul></li>
<li>Fix <code>rclone check</code> on crypted file systems</li>
<li>Make failed uploads not count as “Transferred”</li>
<li>Make sure high level retries show with <code>-q</code></li>
<li>Use a vendor directory with godep for repeatable builds</li>
</ul></li>
<li><code>rclone mount</code> - FUSE
<ul>
<li>Implement FUSE mount options
<ul>
<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>
<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>
</ul></li>
<li>Add <code>--dir-cache-time</code> to control caching of directory
entries</li>
<li>Implement seek for files opened for read (useful for video players)
<ul>
<li>with <code>-no-seek</code> flag to disable</li>
</ul></li>
<li>Fix crash on 32 bit ARM (alignment of 64 bit counter)</li>
<li>…and many more internal fixes and improvements!</li>
</ul></li>
<li>Crypt
<ul>
<li>Don’t show encrypted password in configurator to stop confusion</li>
</ul></li>
<li>Amazon Drive
<ul>
<li>New wait for upload option <code>--acd-upload-wait-per-gb</code>
<ul>
<li>upload timeouts scale by file size and can be disabled</li>
</ul></li>
<li>Add 502 Bad Gateway to list of errors we retry</li>
<li>Fix overwriting a file with a zero length file</li>
<li>Fix ACD file size warning limit - thanks Felix Bünemann</li>
</ul></li>
<li>Local
<ul>
<li>Unix: implement <code>-x</code>/<code>--one-file-system</code> to
stay on a single file system
<ul>
<li>thanks Durval Menezes and Luiz Carlos Rumbelsperger Viana</li>
</ul></li>
<li>Windows: ignore the symlink bit on files</li>
<li>Windows: Ignore directory-based junction points</li>
</ul></li>
<li>B2
<ul>
<li>Make sure each upload has at least one upload slot - fixes strange
upload stats</li>
<li>Fix uploads when using crypt</li>
<li>Fix download of large files (sha1 mismatch)</li>
<li>Return error when we try to create a bucket which someone else
owns</li>
<li>Update B2 docs with Data usage, and Crypt section - thanks Tomasz
Mazur</li>
</ul></li>
<li>S3
<ul>
<li>Command line and config file support for
<ul>
<li>Setting/overriding ACL - thanks Radek Šenfeld</li>
<li>Setting storage class - thanks Asko Tamm</li>
</ul></li>
</ul></li>
<li>Drive
<ul>
<li>Make exponential backoff work exactly as per Google
specification</li>
<li>add <code>.epub</code>, <code>.odp</code> and <code>.tsv</code> as
export formats.</li>
</ul></li>
<li>Swift
<ul>
<li>Don’t read metadata for directory marker objects</li>
</ul></li>
</ul>
<h2 id="v1.33---2016-08-24">v1.33 - 2016-08-24</h2>
<ul>
<li>New Features
<ul>
<li>Implement encryption
<ul>
<li>data encrypted in NACL secretbox format</li>
<li>with optional file name encryption</li>
</ul></li>
<li>New commands
<ul>
<li>rclone mount - implements FUSE mounting of remotes (EXPERIMENTAL)
<ul>
<li>works on Linux, FreeBSD and OS X (need testers for the last 2!)</li>
</ul></li>
<li>rclone cat - outputs remote file or files to the terminal</li>
<li>rclone genautocomplete - command to make a bash completion script
for rclone</li>
</ul></li>
<li>Editing a remote using <code>rclone config</code> now goes through
the wizard</li>
<li>Compile with go 1.7 - this fixes rclone on macOS Sierra and on 386
processors</li>
<li>Use cobra for sub commands and docs generation</li>
</ul></li>
<li>drive
<ul>
<li>Document how to make your own client_id</li>
</ul></li>
<li>s3
<ul>
<li>User-configurable Amazon S3 ACL (thanks Radek Šenfeld)</li>
</ul></li>
<li>b2
<ul>
<li>Fix stats accounting for upload - no more jumping to 100% done</li>
<li>On cleanup delete hide marker if it is the current file</li>
<li>New B2 API endpoint (thanks Per Cederberg)</li>
<li>Set maximum backoff to 5 Minutes</li>
</ul></li>
<li>onedrive
<ul>
<li>Fix URL escaping in file names - e.g. uploading files with
<code>+</code> in them.</li>
</ul></li>
<li>amazon cloud drive
<ul>
<li>Fix token expiry during large uploads</li>
<li>Work around 408 REQUEST_TIMEOUT and 504 GATEWAY_TIMEOUT errors</li>
</ul></li>
<li>local
<ul>
<li>Fix filenames with invalid UTF-8 not being uploaded</li>
<li>Fix problem with some UTF-8 characters on OS X</li>
</ul></li>
</ul>
<h2 id="v1.32---2016-07-13">v1.32 - 2016-07-13</h2>
<ul>
<li>Backblaze B2
<ul>
<li>Fix upload of files large files not in root</li>
</ul></li>
</ul>
<h2 id="v1.31---2016-07-13">v1.31 - 2016-07-13</h2>
<ul>
<li>New Features
<ul>
<li>Reduce memory on sync by about 50%</li>
<li>Implement –no-traverse flag to stop copy traversing the destination
remote.
<ul>
<li>This can be used to reduce memory usage down to the smallest
possible.</li>
<li>Useful to copy a small number of files into a large destination
folder.</li>
</ul></li>
<li>Implement cleanup command for emptying trash / removing old versions
of files
<ul>
<li>Currently B2 only</li>
</ul></li>
<li>Single file handling improved
<ul>
<li>Now copied with –files-from</li>
<li>Automatically sets –no-traverse when copying a single file</li>
</ul></li>
<li>Info on using installing with ansible - thanks Stefan
Weichinger</li>
<li>Implement –no-update-modtime flag to stop rclone fixing the remote
modified times.</li>
</ul></li>
<li>Bug Fixes
<ul>
<li>Fix move command - stop it running for overlapping Fses - this was
causing data loss.</li>
</ul></li>
<li>Local
<ul>
<li>Fix incomplete hashes - this was causing problems for B2.</li>
</ul></li>
<li>Amazon Drive
<ul>
<li>Rename Amazon Cloud Drive to Amazon Drive - no changes to config
file needed.</li>
</ul></li>
<li>Swift
<ul>
<li>Add support for non-default project domain - thanks Antonio
Messina.</li>
</ul></li>
<li>S3
<ul>
<li>Add instructions on how to use rclone with minio.</li>
<li>Add ap-northeast-2 (Seoul) and ap-south-1 (Mumbai) regions.</li>
<li>Skip setting the modified time for objects &gt; 5GB as it isn’t
possible.</li>
</ul></li>
<li>Backblaze B2
<ul>
<li>Add –b2-versions flag so old versions can be listed and
retrieved.</li>
<li>Treat 403 errors (e.g. cap exceeded) as fatal.</li>
<li>Implement cleanup command for deleting old file versions.</li>
<li>Make error handling compliant with B2 integrations notes.</li>
<li>Fix handling of token expiry.</li>
<li>Implement –b2-test-mode to set <code>X-Bz-Test-Mode</code>
header.</li>
<li>Set cutoff for chunked upload to 200MB as per B2 guidelines.</li>
<li>Make upload multi-threaded.</li>
</ul></li>
<li>Dropbox
<ul>
<li>Don’t retry 461 errors.</li>
</ul></li>
</ul>
<h2 id="v1.30---2016-06-18">v1.30 - 2016-06-18</h2>
<ul>
<li>New Features
<ul>
<li>Directory listing code reworked for more features and better error
reporting (thanks to Klaus Post for help). This enables
<ul>
<li>Directory include filtering for efficiency</li>
<li>–max-depth parameter</li>
<li>Better error reporting</li>
<li>More to come</li>
</ul></li>
<li>Retry more errors</li>
<li>Add –ignore-size flag - for uploading images to onedrive</li>
<li>Log -v output to stdout by default</li>
<li>Display the transfer stats in more human-readable form</li>
<li>Make 0 size files specifiable with <code>--max-size 0b</code></li>
<li>Add <code>b</code> suffix so we can specify bytes in –bwlimit,
–min-size, etc.</li>
<li>Use “password:” instead of “password&gt;” prompt - thanks Klaus Post
and Leigh Klotz</li>
</ul></li>
<li>Bug Fixes
<ul>
<li>Fix retry doing one too many retries</li>
</ul></li>
<li>Local
<ul>
<li>Fix problems with OS X and UTF-8 characters</li>
</ul></li>
<li>Amazon Drive
<ul>
<li>Check a file exists before uploading to help with 408 Conflict
errors</li>
<li>Reauth on 401 errors - this has been causing a lot of problems</li>
<li>Work around spurious 403 errors</li>
<li>Restart directory listings on error</li>
</ul></li>
<li>Google Drive
<ul>
<li>Check a file exists before uploading to help with duplicates</li>
<li>Fix retry of multipart uploads</li>
</ul></li>
<li>Backblaze B2
<ul>
<li>Implement large file uploading</li>
</ul></li>
<li>S3
<ul>
<li>Add AES256 server-side encryption for - thanks Justin R. Wilson</li>
</ul></li>
<li>Google Cloud Storage
<ul>
<li>Make sure we don’t use conflicting content types on upload</li>
<li>Add service account support - thanks Michal Witkowski</li>
</ul></li>
<li>Swift
<ul>
<li>Add auth version parameter</li>
<li>Add domain option for openstack (v3 auth) - thanks Fabian Ruff</li>
</ul></li>
</ul>
<h2 id="v1.29---2016-04-18">v1.29 - 2016-04-18</h2>
<ul>
<li>New Features
<ul>
<li>Implement <code>-I, --ignore-times</code> for unconditional
upload</li>
<li>Improve <code>dedupe</code>command
<ul>
<li>Now removes identical copies without asking</li>
<li>Now obeys <code>--dry-run</code></li>
<li>Implement <code>--dedupe-mode</code> for non interactive running
<ul>
<li><code>--dedupe-mode interactive</code> - interactive the
default.</li>
<li><code>--dedupe-mode skip</code> - removes identical files then skips
anything left.</li>
<li><code>--dedupe-mode first</code> - removes identical files then
keeps the first one.</li>
<li><code>--dedupe-mode newest</code> - removes identical files then
keeps the newest one.</li>
<li><code>--dedupe-mode oldest</code> - removes identical files then
keeps the oldest one.</li>
<li><code>--dedupe-mode rename</code> - removes identical files then
renames the rest to be different.</li>
</ul></li>
</ul></li>
</ul></li>
<li>Bug fixes
<ul>
<li>Make rclone check obey the <code>--size-only</code> flag.</li>
<li>Use “application/octet-stream” if discovered mime type is
invalid.</li>
<li>Fix missing “quit” option when there are no remotes.</li>
</ul></li>
<li>Google Drive
<ul>
<li>Increase default chunk size to 8 MB - increases upload speed of big
files</li>
<li>Speed up directory listings and make more reliable</li>
<li>Add missing retries for Move and DirMove - increases
reliability</li>
<li>Preserve mime type on file update</li>
</ul></li>
<li>Backblaze B2
<ul>
<li>Enable mod time syncing
<ul>
<li>This means that B2 will now check modification times</li>
<li>It will upload new files to update the modification times</li>
<li>(there isn’t an API to just set the mod time.)</li>
<li>If you want the old behaviour use <code>--size-only</code>.</li>
</ul></li>
<li>Update API to new version</li>
<li>Fix parsing of mod time when not in metadata</li>
</ul></li>
<li>Swift/Hubic
<ul>
<li>Don’t return an MD5SUM for static large objects</li>
</ul></li>
<li>S3
<ul>
<li>Fix uploading files bigger than 50GB</li>
</ul></li>
</ul>
<h2 id="v1.28---2016-03-01">v1.28 - 2016-03-01</h2>
<ul>
<li>New Features
<ul>
<li>Configuration file encryption - thanks Klaus Post</li>
<li>Improve <code>rclone config</code> adding more help and making it
easier to understand</li>
<li>Implement <code>-u</code>/<code>--update</code> so creation times
can be used on all remotes</li>
<li>Implement <code>--low-level-retries</code> flag</li>
<li>Optionally disable gzip compression on downloads with
<code>--no-gzip-encoding</code></li>
</ul></li>
<li>Bug fixes
<ul>
<li>Don’t make directories if <code>--dry-run</code> set</li>
<li>Fix and document the <code>move</code> command</li>
<li>Fix redirecting stderr on unix-like OSes when using
<code>--log-file</code></li>
<li>Fix <code>delete</code> command to wait until all finished - fixes
missing deletes.</li>
</ul></li>
<li>Backblaze B2
<ul>
<li>Use one upload URL per go routine fixes
<code>more than one upload using auth token</code></li>
<li>Add pacing, retries and reauthentication - fixes token expiry
problems</li>
<li>Upload without using a temporary file from local (and remotes which
support SHA1)</li>
<li>Fix reading metadata for all files when it shouldn’t have been</li>
</ul></li>
<li>Drive
<ul>
<li>Fix listing drive documents at root</li>
<li>Disable copy and move for Google docs</li>
</ul></li>
<li>Swift
<ul>
<li>Fix uploading of chunked files with non ASCII characters</li>
<li>Allow setting of <code>storage_url</code> in the config - thanks
Xavier Lucas</li>
</ul></li>
<li>S3
<ul>
<li>Allow IAM role and credentials from environment variables - thanks
Brian Stengaard</li>
<li>Allow low privilege users to use S3 (check if directory exists
during Mkdir) - thanks Jakub Gedeon</li>
</ul></li>
<li>Amazon Drive
<ul>
<li>Retry on more things to make directory listings more reliable</li>
</ul></li>
</ul>
<h2 id="v1.27---2016-01-31">v1.27 - 2016-01-31</h2>
<ul>
<li>New Features
<ul>
<li>Easier headless configuration with
<code>rclone authorize</code></li>
<li>Add support for multiple hash types - we now check SHA1 as well as
MD5 hashes.</li>
<li><code>delete</code> command which does obey the filters (unlike
<code>purge</code>)</li>
<li><code>dedupe</code> command to deduplicate a remote. Useful with
Google Drive.</li>
<li>Add <code>--ignore-existing</code> flag to skip all files that exist
on destination.</li>
<li>Add <code>--delete-before</code>, <code>--delete-during</code>,
<code>--delete-after</code> flags.</li>
<li>Add <code>--memprofile</code> flag to debug memory use.</li>
<li>Warn the user about files with same name but different case</li>
<li>Make <code>--include</code> rules add their implicit exclude * at
the end of the filter list</li>
<li>Deprecate compiling with go1.3</li>
</ul></li>
<li>Amazon Drive
<ul>
<li>Fix download of files &gt; 10 GB</li>
<li>Fix directory traversal (“Next token is expired”) for large
directory listings</li>
<li>Remove 409 conflict from error codes we will retry - stops very long
pauses</li>
</ul></li>
<li>Backblaze B2
<ul>
<li>SHA1 hashes now checked by rclone core</li>
</ul></li>
<li>Drive
<ul>
<li>Add <code>--drive-auth-owner-only</code> to only consider files
owned by the user - thanks Björn Harrtell</li>
<li>Export Google documents</li>
</ul></li>
<li>Dropbox
<ul>
<li>Make file exclusion error controllable with -q</li>
</ul></li>
<li>Swift
<ul>
<li>Fix upload from unprivileged user.</li>
</ul></li>
<li>S3
<ul>
<li>Fix updating of mod times of files with <code>+</code> in.</li>
</ul></li>
<li>Local
<ul>
<li>Add local file system option to disable UNC on Windows.</li>
</ul></li>
</ul>
<h2 id="v1.26---2016-01-02">v1.26 - 2016-01-02</h2>
<ul>
<li>New Features
<ul>
<li>Yandex storage backend - thank you Dmitry Burdeev (“dibu”)</li>
<li>Implement Backblaze B2 storage backend</li>
<li>Add –min-age and –max-age flags - thank you Adriano Aurélio
Meirelles</li>
<li>Make ls/lsl/md5sum/size/check obey includes and excludes</li>
</ul></li>
<li>Fixes
<ul>
<li>Fix crash in http logging</li>
<li>Upload releases to github too</li>
</ul></li>
<li>Swift
<ul>
<li>Fix sync for chunked files</li>
</ul></li>
<li>OneDrive
<ul>
<li>Re-enable server-side copy</li>
<li>Don’t mask HTTP error codes with JSON decode error</li>
</ul></li>
<li>S3
<ul>
<li>Fix corrupting Content-Type on mod time update (thanks Joseph
Spurrier)</li>
</ul></li>
</ul>
<h2 id="v1.25---2015-11-14">v1.25 - 2015-11-14</h2>
<ul>
<li>New features
<ul>
<li>Implement Hubic storage system</li>
</ul></li>
<li>Fixes
<ul>
<li>Fix deletion of some excluded files without –delete-excluded
<ul>
<li>This could have deleted files unexpectedly on sync</li>
<li>Always check first with <code>--dry-run</code>!</li>
</ul></li>
</ul></li>
<li>Swift
<ul>
<li>Stop SetModTime losing metadata (e.g. X-Object-Manifest)
<ul>
<li>This could have caused data loss for files &gt; 5GB in size</li>
</ul></li>
<li>Use ContentType from Object to avoid lookups in listings</li>
</ul></li>
<li>OneDrive
<ul>
<li>disable server-side copy as it seems to be broken at Microsoft</li>
</ul></li>
</ul>
<h2 id="v1.24---2015-11-07">v1.24 - 2015-11-07</h2>
<ul>
<li>New features
<ul>
<li>Add support for Microsoft OneDrive</li>
<li>Add <code>--no-check-certificate</code> option to disable server
certificate verification</li>
<li>Add async readahead buffer for faster transfer of big files</li>
</ul></li>
<li>Fixes
<ul>
<li>Allow spaces in remotes and check remote names for validity at
creation time</li>
<li>Allow ‘&amp;’ and disallow ‘:’ in Windows filenames.</li>
</ul></li>
<li>Swift
<ul>
<li>Ignore directory marker objects where appropriate - allows working
with Hubic</li>
<li>Don’t delete the container if fs wasn’t at root</li>
</ul></li>
<li>S3
<ul>
<li>Don’t delete the bucket if fs wasn’t at root</li>
</ul></li>
<li>Google Cloud Storage
<ul>
<li>Don’t delete the bucket if fs wasn’t at root</li>
</ul></li>
</ul>
<h2 id="v1.23---2015-10-03">v1.23 - 2015-10-03</h2>
<ul>
<li>New features
<ul>
<li>Implement <code>rclone size</code> for measuring remotes</li>
</ul></li>
<li>Fixes
<ul>
<li>Fix headless config for drive and gcs</li>
<li>Tell the user they should try again if the webserver method
failed</li>
<li>Improve output of <code>--dump-headers</code></li>
</ul></li>
<li>S3
<ul>
<li>Allow anonymous access to public buckets</li>
</ul></li>
<li>Swift
<ul>
<li>Stop chunked operations logging “Failed to read info: Object Not
Found”</li>
<li>Use Content-Length on uploads for extra reliability</li>
</ul></li>
</ul>
<h2 id="v1.22---2015-09-28">v1.22 - 2015-09-28</h2>
<ul>
<li>Implement rsync like include and exclude flags</li>
<li>swift
<ul>
<li>Support files &gt; 5GB - thanks Sergey Tolmachev</li>
</ul></li>
</ul>
<h2 id="v1.21---2015-09-22">v1.21 - 2015-09-22</h2>
<ul>
<li>New features
<ul>
<li>Display individual transfer progress</li>
<li>Make lsl output times in localtime</li>
</ul></li>
<li>Fixes
<ul>
<li>Fix allowing user to override credentials again in Drive, GCS and
ACD</li>
</ul></li>
<li>Amazon Drive
<ul>
<li>Implement compliant pacing scheme</li>
</ul></li>
<li>Google Drive
<ul>
<li>Make directory reads concurrent for increased speed.</li>
</ul></li>
</ul>
<h2 id="v1.20---2015-09-15">v1.20 - 2015-09-15</h2>
<ul>
<li>New features
<ul>
<li>Amazon Drive support</li>
<li>Oauth support redone - fix many bugs and improve usability
<ul>
<li>Use “golang.org/x/oauth2” as oauth library of choice</li>
<li>Improve oauth usability for smoother initial signup</li>
<li>drive, googlecloudstorage: optionally use auto config for the oauth
token</li>
</ul></li>
<li>Implement –dump-headers and –dump-bodies debug flags</li>
<li>Show multiple matched commands if abbreviation too short</li>
<li>Implement server-side move where possible</li>
</ul></li>
<li>local
<ul>
<li>Always use UNC paths internally on Windows - fixes a lot of
bugs</li>
</ul></li>
<li>dropbox
<ul>
<li>force use of our custom transport which makes timeouts work</li>
</ul></li>
<li>Thanks to Klaus Post for lots of help with this release</li>
</ul>
<h2 id="v1.19---2015-08-28">v1.19 - 2015-08-28</h2>
<ul>
<li>New features
<ul>
<li>Server side copies for s3/swift/drive/dropbox/gcs</li>
<li>Move command - uses server-side copies if it can</li>
<li>Implement –retries flag - tries 3 times by default</li>
<li>Build for plan9/amd64 and solaris/amd64 too</li>
</ul></li>
<li>Fixes
<ul>
<li>Make a current version download with a fixed URL for scripting</li>
<li>Ignore rmdir in limited fs rather than throwing error</li>
</ul></li>
<li>dropbox
<ul>
<li>Increase chunk size to improve upload speeds massively</li>
<li>Issue an error message when trying to upload bad file name</li>
</ul></li>
</ul>
<h2 id="v1.18---2015-08-17">v1.18 - 2015-08-17</h2>
<ul>
<li>drive
<ul>
<li>Add <code>--drive-use-trash</code> flag so rclone trashes instead of
deletes</li>
<li>Add “Forbidden to download” message for files with no
downloadURL</li>
</ul></li>
<li>dropbox
<ul>
<li>Remove datastore
<ul>
<li>This was deprecated and it caused a lot of problems</li>
<li>Modification times and MD5SUMs no longer stored</li>
</ul></li>
<li>Fix uploading files &gt; 2GB</li>
</ul></li>
<li>s3
<ul>
<li>use official AWS SDK from github.com/aws/aws-sdk-go</li>
<li><strong>NB</strong> will most likely require you to delete and
recreate remote</li>
<li>enable multipart upload which enables files &gt; 5GB</li>
<li>tested with Ceph / RadosGW / S3 emulation</li>
<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>
</ul></li>
<li>misc
<ul>
<li>Show errors when reading the config file</li>
<li>Do not print stats in quiet mode - thanks Leonid Shalupov</li>
<li>Add FAQ</li>
<li>Fix created directories not obeying umask</li>
<li>Linux installation instructions - thanks Shimon Doodkin</li>
</ul></li>
</ul>
<h2 id="v1.17---2015-06-14">v1.17 - 2015-06-14</h2>
<ul>
<li>dropbox: fix case insensitivity issues - thanks Leonid Shalupov</li>
</ul>
<h2 id="v1.16---2015-06-09">v1.16 - 2015-06-09</h2>
<ul>
<li>Fix uploading big files which was causing timeouts or panics</li>
<li>Don’t check md5sum after download with –size-only</li>
</ul>
<h2 id="v1.15---2015-06-06">v1.15 - 2015-06-06</h2>
<ul>
<li>Add –checksum flag to only discard transfers by MD5SUM - thanks Alex
Couper</li>
<li>Implement –size-only flag to sync on size not checksum &amp;
modtime</li>
<li>Expand docs and remove duplicated information</li>
<li>Document rclone’s limitations with directories</li>
<li>dropbox: update docs about case insensitivity</li>
</ul>
<h2 id="v1.14---2015-05-21">v1.14 - 2015-05-21</h2>
<ul>
<li>local: fix encoding of non utf-8 file names - fixes a duplicate file
problem</li>
<li>drive: docs about rate limiting</li>
<li>google cloud storage: Fix compile after API change in
“google.golang.org/api/storage/v1”</li>
</ul>
<h2 id="v1.13---2015-05-10">v1.13 - 2015-05-10</h2>
<ul>
<li>Revise documentation (especially sync)</li>
<li>Implement –timeout and –conntimeout</li>
<li>s3: ignore etags from multipart uploads which aren’t md5sums</li>
</ul>
<h2 id="v1.12---2015-03-15">v1.12 - 2015-03-15</h2>
<ul>
<li>drive: Use chunked upload for files above a certain size</li>
<li>drive: add –drive-chunk-size and –drive-upload-cutoff
parameters</li>
<li>drive: switch to insert from update when a failed copy deletes the
upload</li>
<li>core: Log duplicate files if they are detected</li>
</ul>
<h2 id="v1.11---2015-03-04">v1.11 - 2015-03-04</h2>
<ul>
<li>swift: add region parameter</li>
<li>drive: fix crash on failed to update remote mtime</li>
<li>In remote paths, change native directory separators to /</li>
<li>Add synchronization to ls/lsl/lsd output to stop corruptions</li>
<li>Ensure all stats/log messages to go stderr</li>
<li>Add –log-file flag to log everything (including panics) to file</li>
<li>Make it possible to disable stats printing with –stats=0</li>
<li>Implement –bwlimit to limit data transfer bandwidth</li>
</ul>
<h2 id="v1.10---2015-02-12">v1.10 - 2015-02-12</h2>
<ul>
<li>s3: list an unlimited number of items</li>
<li>Fix getting stuck in the configurator</li>
</ul>
<h2 id="v1.09---2015-02-07">v1.09 - 2015-02-07</h2>
<ul>
<li>windows: Stop drive letters (e.g. C:) getting mixed up with remotes
(e.g. drive:)</li>
<li>local: Fix directory separators on Windows</li>
<li>drive: fix rate limit exceeded errors</li>
</ul>
<h2 id="v1.08---2015-02-04">v1.08 - 2015-02-04</h2>
<ul>
<li>drive: fix subdirectory listing to not list entire drive</li>
<li>drive: Fix SetModTime</li>
<li>dropbox: adapt code to recent library changes</li>
</ul>
<h2 id="v1.07---2014-12-23">v1.07 - 2014-12-23</h2>
<ul>
<li>google cloud storage: fix memory leak</li>
</ul>
<h2 id="v1.06---2014-12-12">v1.06 - 2014-12-12</h2>
<ul>
<li>Fix “Couldn’t find home directory” on OSX</li>
<li>swift: Add tenant parameter</li>
<li>Use new location of Google API packages</li>
</ul>
<h2 id="v1.05---2014-08-09">v1.05 - 2014-08-09</h2>
<ul>
<li>Improved tests and consequently lots of minor fixes</li>
<li>core: Fix race detected by go race detector</li>
<li>core: Fixes after running errcheck</li>
<li>drive: reset root directory on Rmdir and Purge</li>
<li>fs: Document that Purger returns error on empty directory, test and
fix</li>
<li>google cloud storage: fix ListDir on subdirectory</li>
<li>google cloud storage: re-read metadata in SetModTime</li>
<li>s3: make reading metadata more reliable to work around eventual
consistency problems</li>
<li>s3: strip trailing / from ListDir()</li>
<li>swift: return directories without / in ListDir</li>
</ul>
<h2 id="v1.04---2014-07-21">v1.04 - 2014-07-21</h2>
<ul>
<li>google cloud storage: Fix crash on Update</li>
</ul>
<h2 id="v1.03---2014-07-20">v1.03 - 2014-07-20</h2>
<ul>
<li>swift, s3, dropbox: fix updated files being marked as corrupted</li>
<li>Make compile with go 1.1 again</li>
</ul>
<h2 id="v1.02---2014-07-19">v1.02 - 2014-07-19</h2>
<ul>
<li>Implement Dropbox remote</li>
<li>Implement Google Cloud Storage remote</li>
<li>Verify Md5sums and Sizes after copies</li>
<li>Remove times from “ls” command - lists sizes only</li>
<li>Add add “lsl” - lists times and sizes</li>
<li>Add “md5sum” command</li>
</ul>
<h2 id="v1.01---2014-07-04">v1.01 - 2014-07-04</h2>
<ul>
<li>drive: fix transfer of big files using up lots of memory</li>
</ul>
<h2 id="v1.00---2014-07-03">v1.00 - 2014-07-03</h2>
<ul>
<li>drive: fix whole second dates</li>
</ul>
<h2 id="v0.99---2014-06-26">v0.99 - 2014-06-26</h2>
<ul>
<li>Fix –dry-run not working</li>
<li>Make compatible with go 1.1</li>
</ul>
<h2 id="v0.98---2014-05-30">v0.98 - 2014-05-30</h2>
<ul>
<li>s3: Treat missing Content-Length as 0 for some ceph
installations</li>
<li>rclonetest: add file with a space in</li>
</ul>
<h2 id="v0.97---2014-05-05">v0.97 - 2014-05-05</h2>
<ul>
<li>Implement copying of single files</li>
<li>s3 &amp; swift: support paths inside containers/buckets</li>
</ul>
<h2 id="v0.96---2014-04-24">v0.96 - 2014-04-24</h2>
<ul>
<li>drive: Fix multiple files of same name being created</li>
<li>drive: Use o.Update and fs.Put to optimise transfers</li>
<li>Add version number, -V and –version</li>
</ul>
<h2 id="v0.95---2014-03-28">v0.95 - 2014-03-28</h2>
<ul>
<li>rclone.org: website, docs and graphics</li>
<li>drive: fix path parsing</li>
</ul>
<h2 id="v0.94---2014-03-27">v0.94 - 2014-03-27</h2>
<ul>
<li>Change remote format one last time</li>
<li>GNU style flags</li>
</ul>
<h2 id="v0.93---2014-03-16">v0.93 - 2014-03-16</h2>
<ul>
<li>drive: store token in config file</li>
<li>cross compile other versions</li>
<li>set strict permissions on config file</li>
</ul>
<h2 id="v0.92---2014-03-15">v0.92 - 2014-03-15</h2>
<ul>
<li>Config fixes and –config option</li>
</ul>
<h2 id="v0.91---2014-03-15">v0.91 - 2014-03-15</h2>
<ul>
<li>Make config file</li>
</ul>
<h2 id="v0.90---2013-06-27">v0.90 - 2013-06-27</h2>
<ul>
<li>Project named rclone</li>
</ul>
<h2 id="v0.00---2012-11-18">v0.00 - 2012-11-18</h2>
<ul>
<li>Project started</li>
</ul>
<h1 id="bugs-and-limitations">Bugs and Limitations</h1>
<h2 id="limitations-34">Limitations</h2>
<h3 id="directory-timestamps-arent-preserved">Directory timestamps
aren’t preserved</h3>
<p>Rclone doesn’t currently preserve the timestamps of directories. This
is because rclone only really considers objects when syncing.</p>
<h3
id="rclone-struggles-with-millions-of-files-in-a-directorybucket">Rclone
struggles with millions of files in a directory/bucket</h3>
<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>
<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>
<h3 id="bucket-based-remotes-and-folders">Bucket-based remotes and
folders</h3>
<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>
<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>
<h2 id="bugs">Bugs</h2>
<p>Bugs are stored in rclone’s GitHub project:</p>
<ul>
<li><a
href="https://github.com/rclone/rclone/issues?q=is%3Aopen+is%3Aissue+label%3Abug">Reported
bugs</a></li>
<li><a
href="https://github.com/rclone/rclone/issues?q=is%3Aopen+is%3Aissue+milestone%3A%22Known+Problem%22">Known
issues</a></li>
</ul>
<h1 id="frequently-asked-questions">Frequently Asked Questions</h1>
<h3 id="do-all-cloud-storage-systems-support-all-rclone-commands">Do all
cloud storage systems support all rclone commands</h3>
<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>
<h3 id="can-i-copy-the-config-from-one-machine-to-another">Can I copy
the config from one machine to another</h3>
<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>
<p>See the <a href="https://rclone.org/remote_setup/">remote setup
docs</a> for more info.</p>
<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>
<p>This has now been documented in its own <a
href="https://rclone.org/remote_setup/">remote setup page</a>.</p>
<h3 id="can-rclone-sync-directly-from-drive-to-s3">Can rclone sync
directly from drive to s3</h3>
<p>Rclone can sync between two remote cloud storage systems just
fine.</p>
<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>
<p>The syncs would be incremental (on a file by file basis).</p>
<p>e.g.</p>
<pre><code>rclone sync -i drive:Folder s3:bucket</code></pre>
<h3 id="using-rclone-from-multiple-locations-at-the-same-time">Using
rclone from multiple locations at the same time</h3>
<p>You can use rclone from multiple places at the same time if you
choose different subdirectory for the output, e.g.</p>
<pre><code>Server A&gt; rclone sync -i /tmp/whatever remote:ServerA
Server B&gt; rclone sync -i /tmp/whatever remote:ServerB</code></pre>
<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>
<pre><code>Server A&gt; rclone copy /tmp/whatever remote:Backup
Server B&gt; rclone copy /tmp/whatever remote:Backup</code></pre>
<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>
<h3
id="why-doesnt-rclone-support-partial-transfers-binary-diffs-like-rsync">Why
doesn’t rclone support partial transfers / binary diffs like rsync?</h3>
<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>
<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>
<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>
<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>
<h3 id="can-rclone-do-bi-directional-sync">Can rclone do bi-directional
sync?</h3>
<p>Yes, since rclone v1.58.0, <a
href="https://rclone.org/bisync/">bidirectional cloud sync</a> is
available.</p>
<h3 id="can-i-use-rclone-with-an-http-proxy">Can I use rclone with an
HTTP proxy?</h3>
<p>Yes. rclone will follow the standard environment variables for
proxies, similar to cURL and other programs.</p>
<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>
<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>
<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>
<pre><code>export http_proxy=http://proxyserver:12345
export https_proxy=$http_proxy
export HTTP_PROXY=$http_proxy
export HTTPS_PROXY=$http_proxy</code></pre>
<p>Note: If the proxy server requires a username and password, then
use</p>
<pre><code>export http_proxy=http://username:password@proxyserver:12345
export https_proxy=$http_proxy
export HTTP_PROXY=$http_proxy
export HTTPS_PROXY=$http_proxy</code></pre>
<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>
<p>e.g.</p>
<pre><code>export no_proxy=localhost,127.0.0.0/8,my.host.name
export NO_PROXY=$no_proxy</code></pre>
<p>Note that the FTP backend does not support <code>ftp_proxy</code>
yet.</p>
<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>
<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>
<p>Rclone (via the Go runtime) tries to load the root certificates from
these places on Linux.</p>
<pre><code>&quot;/etc/ssl/certs/ca-certificates.crt&quot;, // Debian/Ubuntu/Gentoo etc.
&quot;/etc/pki/tls/certs/ca-bundle.crt&quot;,   // Fedora/RHEL
&quot;/etc/ssl/ca-bundle.pem&quot;,             // OpenSUSE
&quot;/etc/pki/tls/cacert.pem&quot;,            // OpenELEC</code></pre>
<p>So doing something like this should fix the problem. It also sets the
time which is important for SSL to work properly.</p>
<pre><code>mkdir -p /etc/ssl/certs/
curl -o /etc/ssl/certs/ca-certificates.crt https://raw.githubusercontent.com/bagder/ca-bundle/master/ca-bundle.crt
ntpclient -s -h pool.ntp.org</code></pre>
<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>
<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>
<pre><code>curl --insecure -o /etc/ssl/certs/ca-certificates.crt https://raw.githubusercontent.com/bagder/ca-bundle/master/ca-bundle.crt</code></pre>
<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>
<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>
<p>See the <a href="https://golang.org/doc/install">system requirements
section in the go install docs</a> for full details.</p>
<h3 id="all-my-uploaded-docxxlsxpptx-files-appear-as-archivezip">All my
uploaded docx/xlsx/pptx files appear as archive/zip</h3>
<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>
<h3 id="tcp-lookup-some.domain.com-no-such-host">tcp lookup
some.domain.com no such host</h3>
<p>This happens when rclone cannot resolve a domain. Please check that
your DNS setup is generally working, e.g.</p>
<pre><code># both should print a long list of possible IP addresses
dig www.googleapis.com          # resolve using your default DNS
dig www.googleapis.com @8.8.8.8 # resolve with Google&#39;s DNS server</code></pre>
<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>
<p>Additionally with the <code>GODEBUG=netdns=</code> environment
variable the Go resolver decision can be influenced. This also allows to
resolve certain issues with DNS resolution. See the <a
href="https://golang.org/pkg/net/#hdr-Name_Resolution">name resolution
section in the go docs</a>.</p>
<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>
<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>
<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>
<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>
<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>
<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>
<h3
id="rclone-changes-fullwidth-unicode-punctuation-marks-in-file-names">Rclone
changes fullwidth Unicode punctuation marks in file names</h3>
<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>
<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>
<h1 id="license">License</h1>
<p>This is free software under the terms of the MIT license (check the
COPYING file included with the source code).</p>
<pre><code>Copyright (C) 2019 by Nick Craig-Wood https://www.craig-wood.com/nick/

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the &quot;Software&quot;), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.</code></pre>
<h1 id="authors-and-contributors">Authors and contributors</h1>
<h2 id="authors">Authors</h2>
<ul>
<li>Nick Craig-Wood <a href="mailto:nick@craig-wood.com"
class="email">nick@craig-wood.com</a></li>
</ul>
<h2 id="contributors">Contributors</h2>
<p>{{&lt; rem
<code>email addresses removed from here need to be addeed to bin/.ignore-emails to make sure update-authors.py doesn't immediately put them back in again.</code>
&gt;}}</p>
<ul>
<li>Alex Couper <a href="mailto:amcouper@gmail.com"
class="email">amcouper@gmail.com</a></li>
<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>
<li>Shimon Doodkin <a href="mailto:helpmepro1@gmail.com"
class="email">helpmepro1@gmail.com</a></li>
<li>Colin Nicholson <a href="mailto:colin@colinn.com"
class="email">colin@colinn.com</a></li>
<li>Klaus Post <a href="mailto:klauspost@gmail.com"
class="email">klauspost@gmail.com</a></li>
<li>Sergey Tolmachev <a href="mailto:tolsi.ru@gmail.com"
class="email">tolsi.ru@gmail.com</a></li>
<li>Adriano Aurélio Meirelles <a href="mailto:adriano@atinge.com"
class="email">adriano@atinge.com</a></li>
<li>C. Bess <a href="mailto:cbess@users.noreply.github.com"
class="email">cbess@users.noreply.github.com</a></li>
<li>Dmitry Burdeev <a href="mailto:dibu28@gmail.com"
class="email">dibu28@gmail.com</a></li>
<li>Joseph Spurrier <a href="mailto:github@josephspurrier.com"
class="email">github@josephspurrier.com</a></li>
<li>Björn Harrtell <a href="mailto:bjorn@wololo.org"
class="email">bjorn@wololo.org</a></li>
<li>Xavier Lucas <a href="mailto:xavier.lucas@corp.ovh.com"
class="email">xavier.lucas@corp.ovh.com</a></li>
<li>Werner Beroux <a href="mailto:werner@beroux.com"
class="email">werner@beroux.com</a></li>
<li>Brian Stengaard <a href="mailto:brian@stengaard.eu"
class="email">brian@stengaard.eu</a></li>
<li>Jakub Gedeon <a href="mailto:jgedeon@sofi.com"
class="email">jgedeon@sofi.com</a></li>
<li>Jim Tittsler <a href="mailto:jwt@onjapan.net"
class="email">jwt@onjapan.net</a></li>
<li>Michal Witkowski <a href="mailto:michal@improbable.io"
class="email">michal@improbable.io</a></li>
<li>Fabian Ruff <a href="mailto:fabian.ruff@sap.com"
class="email">fabian.ruff@sap.com</a></li>
<li>Leigh Klotz <a href="mailto:klotz@quixey.com"
class="email">klotz@quixey.com</a></li>
<li>Romain Lapray <a href="mailto:lapray.romain@gmail.com"
class="email">lapray.romain@gmail.com</a></li>
<li>Justin R. Wilson <a href="mailto:jrw972@gmail.com"
class="email">jrw972@gmail.com</a></li>
<li>Antonio Messina <a href="mailto:antonio.s.messina@gmail.com"
class="email">antonio.s.messina@gmail.com</a></li>
<li>Stefan G. Weichinger <a href="mailto:office@oops.co.at"
class="email">office@oops.co.at</a></li>
<li>Per Cederberg <a href="mailto:cederberg@gmail.com"
class="email">cederberg@gmail.com</a></li>
<li>Radek Šenfeld <a href="mailto:rush@logic.cz"
class="email">rush@logic.cz</a></li>
<li>Fredrik Fornwall <a href="mailto:fredrik@fornwall.net"
class="email">fredrik@fornwall.net</a></li>
<li>Asko Tamm <a href="mailto:asko@deekit.net"
class="email">asko@deekit.net</a></li>
<li>xor-zz <a href="mailto:xor@gstocco.com"
class="email">xor@gstocco.com</a></li>
<li>Tomasz Mazur <a href="mailto:tmazur90@gmail.com"
class="email">tmazur90@gmail.com</a></li>
<li>Marco Paganini <a href="mailto:paganini@paganini.net"
class="email">paganini@paganini.net</a></li>
<li>Felix Bünemann <a href="mailto:buenemann@louis.info"
class="email">buenemann@louis.info</a></li>
<li>Durval Menezes <a href="mailto:jmrclone@durval.com"
class="email">jmrclone@durval.com</a></li>
<li>Luiz Carlos Rumbelsperger Viana <a
href="mailto:maxd13_luiz_carlos@hotmail.com"
class="email">maxd13_luiz_carlos@hotmail.com</a></li>
<li>Stefan Breunig <a href="mailto:stefan-github@yrden.de"
class="email">stefan-github@yrden.de</a></li>
<li>Alishan Ladhani <a href="mailto:ali-l@users.noreply.github.com"
class="email">ali-l@users.noreply.github.com</a></li>
<li>0xJAKE <a href="mailto:0xJAKE@users.noreply.github.com"
class="email">0xJAKE@users.noreply.github.com</a></li>
<li>Thibault Molleman <a
href="mailto:thibaultmol@users.noreply.github.com"
class="email">thibaultmol@users.noreply.github.com</a></li>
<li>Scott McGillivray <a href="mailto:scott.mcgillivray@gmail.com"
class="email">scott.mcgillivray@gmail.com</a></li>
<li>Bjørn Erik Pedersen <a href="mailto:bjorn.erik.pedersen@gmail.com"
class="email">bjorn.erik.pedersen@gmail.com</a></li>
<li>Lukas Loesche <a href="mailto:lukas@mesosphere.io"
class="email">lukas@mesosphere.io</a></li>
<li>emyarod <a href="mailto:allllaboutyou@gmail.com"
class="email">allllaboutyou@gmail.com</a></li>
<li>T.C. Ferguson <a href="mailto:tcf909@gmail.com"
class="email">tcf909@gmail.com</a></li>
<li>Brandur <a href="mailto:brandur@mutelight.org"
class="email">brandur@mutelight.org</a></li>
<li>Dario Giovannetti <a href="mailto:dev@dariogiovannetti.net"
class="email">dev@dariogiovannetti.net</a></li>
<li>Károly Oláh <a href="mailto:okaresz@aol.com"
class="email">okaresz@aol.com</a></li>
<li>Jon Yergatian <a href="mailto:jon@macfanatic.ca"
class="email">jon@macfanatic.ca</a></li>
<li>Jack Schmidt <a href="mailto:github@mowsey.org"
class="email">github@mowsey.org</a></li>
<li>Dedsec1 <a href="mailto:Dedsec1@users.noreply.github.com"
class="email">Dedsec1@users.noreply.github.com</a></li>
<li>Hisham Zarka <a href="mailto:hzarka@gmail.com"
class="email">hzarka@gmail.com</a></li>
<li>Jérôme Vizcaino <a href="mailto:jerome.vizcaino@gmail.com"
class="email">jerome.vizcaino@gmail.com</a></li>
<li>Mike Tesch <a href="mailto:mjt6129@rit.edu"
class="email">mjt6129@rit.edu</a></li>
<li>Marvin Watson <a href="mailto:marvwatson@users.noreply.github.com"
class="email">marvwatson@users.noreply.github.com</a></li>
<li>Danny Tsai <a href="mailto:danny8376@gmail.com"
class="email">danny8376@gmail.com</a></li>
<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>
<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>
<li>Ihor Dvoretskyi <a href="mailto:ihor.dvoretskyi@gmail.com"
class="email">ihor.dvoretskyi@gmail.com</a></li>
<li>Jon Craton <a href="mailto:jncraton@gmail.com"
class="email">jncraton@gmail.com</a></li>
<li>Hraban Luyat <a href="mailto:hraban@0brg.net"
class="email">hraban@0brg.net</a></li>
<li>Michael Ledin <a href="mailto:mledin89@gmail.com"
class="email">mledin89@gmail.com</a></li>
<li>Martin Kristensen <a href="mailto:me@azgul.com"
class="email">me@azgul.com</a></li>
<li>Too Much IO <a href="mailto:toomuchio@users.noreply.github.com"
class="email">toomuchio@users.noreply.github.com</a></li>
<li>Anisse Astier <a href="mailto:anisse@astier.eu"
class="email">anisse@astier.eu</a></li>
<li>Zahiar Ahmed <a href="mailto:zahiar@live.com"
class="email">zahiar@live.com</a></li>
<li>Igor Kharin <a href="mailto:igorkharin@gmail.com"
class="email">igorkharin@gmail.com</a></li>
<li>Bill Zissimopoulos <a href="mailto:billziss@navimatics.com"
class="email">billziss@navimatics.com</a></li>
<li>Bob Potter <a href="mailto:bobby.potter@gmail.com"
class="email">bobby.potter@gmail.com</a></li>
<li>Steven Lu <a href="mailto:tacticalazn@gmail.com"
class="email">tacticalazn@gmail.com</a></li>
<li>Sjur Fredriksen <a href="mailto:sjurtf@ifi.uio.no"
class="email">sjurtf@ifi.uio.no</a></li>
<li>Ruwbin <a href="mailto:hubus12345@gmail.com"
class="email">hubus12345@gmail.com</a></li>
<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>
<li>Edward Q. Bridges <a href="mailto:github@eqbridges.com"
class="email">github@eqbridges.com</a></li>
<li>Vasiliy Tolstov <a href="mailto:v.tolstov@selfip.ru"
class="email">v.tolstov@selfip.ru</a></li>
<li>Harshavardhana <a href="mailto:harsha@minio.io"
class="email">harsha@minio.io</a></li>
<li>sainaen <a href="mailto:sainaen@gmail.com"
class="email">sainaen@gmail.com</a></li>
<li>gdm85 <a href="mailto:gdm85@users.noreply.github.com"
class="email">gdm85@users.noreply.github.com</a></li>
<li>Yaroslav Halchenko <a href="mailto:debian@onerussian.com"
class="email">debian@onerussian.com</a></li>
<li>John Papandriopoulos <a href="mailto:jpap@users.noreply.github.com"
class="email">jpap@users.noreply.github.com</a></li>
<li>Zhiming Wang <a href="mailto:zmwangx@gmail.com"
class="email">zmwangx@gmail.com</a></li>
<li>Andy Pilate <a href="mailto:cubox@cubox.me"
class="email">cubox@cubox.me</a></li>
<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>
<li>wuyu <a href="mailto:wuyu@yunify.com"
class="email">wuyu@yunify.com</a></li>
<li>Andrei Dragomir <a href="mailto:adragomi@adobe.com"
class="email">adragomi@adobe.com</a></li>
<li>Christian Brüggemann <a href="mailto:mail@cbruegg.com"
class="email">mail@cbruegg.com</a></li>
<li>Alex McGrath Kraak <a href="mailto:amkdude@gmail.com"
class="email">amkdude@gmail.com</a></li>
<li>bpicode <a href="mailto:bjoern.pirnay@googlemail.com"
class="email">bjoern.pirnay@googlemail.com</a></li>
<li>Daniel Jagszent <a href="mailto:daniel@jagszent.de"
class="email">daniel@jagszent.de</a></li>
<li>Josiah White <a href="mailto:thegenius2009@gmail.com"
class="email">thegenius2009@gmail.com</a></li>
<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>
<li>Jan Varho <a href="mailto:jan@varho.org"
class="email">jan@varho.org</a></li>
<li>Girish Ramakrishnan <a href="mailto:girish@cloudron.io"
class="email">girish@cloudron.io</a></li>
<li>LingMan <a href="mailto:LingMan@users.noreply.github.com"
class="email">LingMan@users.noreply.github.com</a></li>
<li>Jacob McNamee <a href="mailto:jacobmcnamee@gmail.com"
class="email">jacobmcnamee@gmail.com</a></li>
<li>jersou <a href="mailto:jertux@gmail.com"
class="email">jertux@gmail.com</a></li>
<li>thierry <a href="mailto:thierry@substantiel.fr"
class="email">thierry@substantiel.fr</a></li>
<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>
<li>Dan Dascalescu <a href="mailto:ddascalescu+github@gmail.com"
class="email">ddascalescu+github@gmail.com</a></li>
<li>Jason Rose <a href="mailto:jason@jro.io"
class="email">jason@jro.io</a></li>
<li>Andrew Starr-Bochicchio <a href="mailto:a.starr.b@gmail.com"
class="email">a.starr.b@gmail.com</a></li>
<li>John Leach <a href="mailto:john@johnleach.co.uk"
class="email">john@johnleach.co.uk</a></li>
<li>Corban Raun <a href="mailto:craun@instructure.com"
class="email">craun@instructure.com</a></li>
<li>Pierre Carlson <a href="mailto:mpcarl@us.ibm.com"
class="email">mpcarl@us.ibm.com</a></li>
<li>Ernest Borowski <a href="mailto:er.borowski@gmail.com"
class="email">er.borowski@gmail.com</a></li>
<li>Remus Bunduc <a href="mailto:remus.bunduc@gmail.com"
class="email">remus.bunduc@gmail.com</a></li>
<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>
<li>Jakub Tasiemski <a href="mailto:tasiemski@gmail.com"
class="email">tasiemski@gmail.com</a></li>
<li>David Minor <a href="mailto:dminor@saymedia.com"
class="email">dminor@saymedia.com</a></li>
<li>Tim Cooijmans <a href="mailto:cooijmans.tim@gmail.com"
class="email">cooijmans.tim@gmail.com</a></li>
<li>Laurence <a href="mailto:liuxy6@gmail.com"
class="email">liuxy6@gmail.com</a></li>
<li>Giovanni Pizzi <a href="mailto:gio.piz@gmail.com"
class="email">gio.piz@gmail.com</a></li>
<li>Filip Bartodziej <a href="mailto:filipbartodziej@gmail.com"
class="email">filipbartodziej@gmail.com</a></li>
<li>Jon Fautley <a href="mailto:jon@dead.li"
class="email">jon@dead.li</a></li>
<li>lewapm <a href="mailto:32110057+lewapm@users.noreply.github.com"
class="email">32110057+lewapm@users.noreply.github.com</a></li>
<li>Yassine Imounachen <a href="mailto:yassine256@gmail.com"
class="email">yassine256@gmail.com</a></li>
<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>
<li>Jon Fautley <a href="mailto:jon@adenoid.appstal.co.uk"
class="email">jon@adenoid.appstal.co.uk</a></li>
<li>Will Gunn <a href="mailto:WillGunn@users.noreply.github.com"
class="email">WillGunn@users.noreply.github.com</a></li>
<li>Lucas Bremgartner <a href="mailto:lucas@bremis.ch"
class="email">lucas@bremis.ch</a></li>
<li>Jody Frankowski <a href="mailto:jody.frankowski@gmail.com"
class="email">jody.frankowski@gmail.com</a></li>
<li>Andreas Roussos <a href="mailto:arouss1980@gmail.com"
class="email">arouss1980@gmail.com</a></li>
<li>nbuchanan <a href="mailto:nbuchanan@utah.gov"
class="email">nbuchanan@utah.gov</a></li>
<li>Durval Menezes <a href="mailto:rclone@durval.com"
class="email">rclone@durval.com</a></li>
<li>Victor <a href="mailto:vb-github@viblo.se"
class="email">vb-github@viblo.se</a></li>
<li>Mateusz <a href="mailto:pabian.mateusz@gmail.com"
class="email">pabian.mateusz@gmail.com</a></li>
<li>Daniel Loader <a href="mailto:spicypixel@gmail.com"
class="email">spicypixel@gmail.com</a></li>
<li>David0rk <a href="mailto:davidork@gmail.com"
class="email">davidork@gmail.com</a></li>
<li>Alexander Neumann <a href="mailto:alexander@bumpern.de"
class="email">alexander@bumpern.de</a></li>
<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>
<li>Leo R. Lundgren <a href="mailto:leo@finalresort.org"
class="email">leo@finalresort.org</a></li>
<li>wolfv <a href="mailto:wolfv6@users.noreply.github.com"
class="email">wolfv6@users.noreply.github.com</a></li>
<li>Dave Pedu <a href="mailto:dave@davepedu.com"
class="email">dave@davepedu.com</a></li>
<li>Stefan Lindblom <a href="mailto:lindblom@spotify.com"
class="email">lindblom@spotify.com</a></li>
<li>seuffert <a href="mailto:oliver@seuffert.biz"
class="email">oliver@seuffert.biz</a></li>
<li>gbadanahatti <a
href="mailto:37121690+gbadanahatti@users.noreply.github.com"
class="email">37121690+gbadanahatti@users.noreply.github.com</a></li>
<li>Keith Goldfarb <a href="mailto:barkofdelight@gmail.com"
class="email">barkofdelight@gmail.com</a></li>
<li>Steve Kriss <a href="mailto:steve@heptio.com"
class="email">steve@heptio.com</a></li>
<li>Chih-Hsuan Yen <a href="mailto:yan12125@gmail.com"
class="email">yan12125@gmail.com</a></li>
<li>Alexander Neumann <a href="mailto:fd0@users.noreply.github.com"
class="email">fd0@users.noreply.github.com</a></li>
<li>Matt Holt <a href="mailto:mholt@users.noreply.github.com"
class="email">mholt@users.noreply.github.com</a></li>
<li>Eri Bastos <a href="mailto:bastos.eri@gmail.com"
class="email">bastos.eri@gmail.com</a></li>
<li>Michael P. Dubner <a href="mailto:pywebmail@list.ru"
class="email">pywebmail@list.ru</a></li>
<li>Antoine GIRARD <a href="mailto:sapk@users.noreply.github.com"
class="email">sapk@users.noreply.github.com</a></li>
<li>Mateusz Piotrowski <a href="mailto:mpp302@gmail.com"
class="email">mpp302@gmail.com</a></li>
<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>
<li>Peter Baumgartner <a href="mailto:pete@lincolnloop.com"
class="email">pete@lincolnloop.com</a></li>
<li>Craig Rachel <a href="mailto:craig@craigrachel.com"
class="email">craig@craigrachel.com</a></li>
<li>Michael G. Noll <a href="mailto:miguno@users.noreply.github.com"
class="email">miguno@users.noreply.github.com</a></li>
<li>hensur <a href="mailto:me@hensur.de"
class="email">me@hensur.de</a></li>
<li>Oliver Heyme <a href="mailto:de8olihe@lego.com"
class="email">de8olihe@lego.com</a></li>
<li>Richard Yang <a href="mailto:richard@yenforyang.com"
class="email">richard@yenforyang.com</a></li>
<li>Piotr Oleszczyk <a href="mailto:piotr.oleszczyk@gmail.com"
class="email">piotr.oleszczyk@gmail.com</a></li>
<li>Rodrigo <a href="mailto:rodarima@gmail.com"
class="email">rodarima@gmail.com</a></li>
<li>NoLooseEnds <a href="mailto:NoLooseEnds@users.noreply.github.com"
class="email">NoLooseEnds@users.noreply.github.com</a></li>
<li>Jakub Karlicek <a href="mailto:jakub@karlicek.me"
class="email">jakub@karlicek.me</a></li>
<li>John Clayton <a href="mailto:john@codemonkeylabs.com"
class="email">john@codemonkeylabs.com</a></li>
<li>Kasper Byrdal Nielsen <a href="mailto:byrdal76@gmail.com"
class="email">byrdal76@gmail.com</a></li>
<li>Benjamin Joseph Dag <a
href="mailto:bjdag1234@users.noreply.github.com"
class="email">bjdag1234@users.noreply.github.com</a></li>
<li>themylogin <a href="mailto:themylogin@gmail.com"
class="email">themylogin@gmail.com</a></li>
<li>Onno Zweers <a href="mailto:onno.zweers@surfsara.nl"
class="email">onno.zweers@surfsara.nl</a></li>
<li>Jasper Lievisse Adriaanse <a href="mailto:jasper@humppa.nl"
class="email">jasper@humppa.nl</a></li>
<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>
<li>HerrH <a href="mailto:atomtigerzoo@users.noreply.github.com"
class="email">atomtigerzoo@users.noreply.github.com</a></li>
<li>Andrew <a
href="mailto:4030760+sparkyman215@users.noreply.github.com"
class="email">4030760+sparkyman215@users.noreply.github.com</a></li>
<li>dan smith <a href="mailto:XX1011@gmail.com"
class="email">XX1011@gmail.com</a></li>
<li>Oleg Kovalov <a href="mailto:iamolegkovalov@gmail.com"
class="email">iamolegkovalov@gmail.com</a></li>
<li>Ruben Vandamme <a href="mailto:github-com-00ff86@vandamme.email"
class="email">github-com-00ff86@vandamme.email</a></li>
<li>Cnly <a href="mailto:minecnly@gmail.com"
class="email">minecnly@gmail.com</a></li>
<li>Andres Alvarez <a
href="mailto:1671935+kir4h@users.noreply.github.com"
class="email">1671935+kir4h@users.noreply.github.com</a></li>
<li>reddi1 <a href="mailto:xreddi@gmail.com"
class="email">xreddi@gmail.com</a></li>
<li>Matt Tucker <a href="mailto:matthewtckr@gmail.com"
class="email">matthewtckr@gmail.com</a></li>
<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>
<li>Martin Polden <a href="mailto:mpolden@mpolden.no"
class="email">mpolden@mpolden.no</a></li>
<li>Alex Chen <a href="mailto:Cnly@users.noreply.github.com"
class="email">Cnly@users.noreply.github.com</a></li>
<li>Denis <a href="mailto:deniskovpen@gmail.com"
class="email">deniskovpen@gmail.com</a></li>
<li>bsteiss <a href="mailto:35940619+bsteiss@users.noreply.github.com"
class="email">35940619+bsteiss@users.noreply.github.com</a></li>
<li>Cédric Connes <a href="mailto:cedric.connes@gmail.com"
class="email">cedric.connes@gmail.com</a></li>
<li>Dr. Tobias Quathamer <a
href="mailto:toddy15@users.noreply.github.com"
class="email">toddy15@users.noreply.github.com</a></li>
<li>dcpu <a href="mailto:42736967+dcpu@users.noreply.github.com"
class="email">42736967+dcpu@users.noreply.github.com</a></li>
<li>Sheldon Rupp <a href="mailto:me@shel.io"
class="email">me@shel.io</a></li>
<li>albertony <a
href="mailto:12441419+albertony@users.noreply.github.com"
class="email">12441419+albertony@users.noreply.github.com</a></li>
<li>cron410 <a href="mailto:cron410@gmail.com"
class="email">cron410@gmail.com</a></li>
<li>Anagh Kumar Baranwal <a
href="mailto:6824881+darthShadow@users.noreply.github.com"
class="email">6824881+darthShadow@users.noreply.github.com</a></li>
<li>Felix Brucker <a href="mailto:felix@felixbrucker.com"
class="email">felix@felixbrucker.com</a></li>
<li>Santiago Rodríguez <a
href="mailto:scollazo@users.noreply.github.com"
class="email">scollazo@users.noreply.github.com</a></li>
<li>Craig Miskell <a href="mailto:craig.miskell@fluxfederation.com"
class="email">craig.miskell@fluxfederation.com</a></li>
<li>Antoine GIRARD <a href="mailto:sapk@sapk.fr"
class="email">sapk@sapk.fr</a></li>
<li>Joanna Marek <a href="mailto:joanna.marek@u2i.com"
class="email">joanna.marek@u2i.com</a></li>
<li>frenos <a href="mailto:frenos@users.noreply.github.com"
class="email">frenos@users.noreply.github.com</a></li>
<li>ssaqua <a href="mailto:ssaqua@users.noreply.github.com"
class="email">ssaqua@users.noreply.github.com</a></li>
<li>xnaas <a href="mailto:me@xnaas.info"
class="email">me@xnaas.info</a></li>
<li>Frantisek Fuka <a href="mailto:fuka@fuxoft.cz"
class="email">fuka@fuxoft.cz</a></li>
<li>Paul Kohout <a href="mailto:pauljkohout@yahoo.com"
class="email">pauljkohout@yahoo.com</a></li>
<li>dcpu <a href="mailto:43330287+dcpu@users.noreply.github.com"
class="email">43330287+dcpu@users.noreply.github.com</a></li>
<li>jackyzy823 <a href="mailto:jackyzy823@gmail.com"
class="email">jackyzy823@gmail.com</a></li>
<li>David Haguenauer <a href="mailto:ml@kurokatta.org"
class="email">ml@kurokatta.org</a></li>
<li>teresy <a href="mailto:hi.teresy@gmail.com"
class="email">hi.teresy@gmail.com</a></li>
<li>buergi <a href="mailto:patbuergi@gmx.de"
class="email">patbuergi@gmx.de</a></li>
<li>Florian Gamboeck <a href="mailto:mail@floga.de"
class="email">mail@floga.de</a></li>
<li>Ralf Hemberger <a
href="mailto:10364191+rhemberger@users.noreply.github.com"
class="email">10364191+rhemberger@users.noreply.github.com</a></li>
<li>Scott Edlund <a href="mailto:sedlund@users.noreply.github.com"
class="email">sedlund@users.noreply.github.com</a></li>
<li>Erik Swanson <a href="mailto:erik@retailnext.net"
class="email">erik@retailnext.net</a></li>
<li>Jake Coggiano <a href="mailto:jake@stripe.com"
class="email">jake@stripe.com</a></li>
<li>brused27 <a href="mailto:brused27@noemailaddress"
class="email">brused27@noemailaddress</a></li>
<li>Peter Kaminski <a href="mailto:kaminski@istori.com"
class="email">kaminski@istori.com</a></li>
<li>Henry Ptasinski <a href="mailto:henry@logout.com"
class="email">henry@logout.com</a></li>
<li>Alexander <a href="mailto:kharkovalexander@gmail.com"
class="email">kharkovalexander@gmail.com</a></li>
<li>Garry McNulty <a href="mailto:garrmcnu@gmail.com"
class="email">garrmcnu@gmail.com</a></li>
<li>Mathieu Carbou <a href="mailto:mathieu.carbou@gmail.com"
class="email">mathieu.carbou@gmail.com</a></li>
<li>Mark Otway <a href="mailto:mark@otway.com"
class="email">mark@otway.com</a></li>
<li>William Cocker <a
href="mailto:37018962+WilliamCocker@users.noreply.github.com"
class="email">37018962+WilliamCocker@users.noreply.github.com</a></li>
<li>François Leurent <a href="mailto:131.js@cloudyks.org"
class="email">131.js@cloudyks.org</a></li>
<li>Arkadius Stefanski <a href="mailto:arkste@gmail.com"
class="email">arkste@gmail.com</a></li>
<li>Jay <a href="mailto:dev@jaygoel.com"
class="email">dev@jaygoel.com</a></li>
<li>andrea rota <a href="mailto:a@xelera.eu"
class="email">a@xelera.eu</a></li>
<li>nicolov <a href="mailto:nicolov@users.noreply.github.com"
class="email">nicolov@users.noreply.github.com</a></li>
<li>Dario Guzik <a href="mailto:dario@guzik.com.ar"
class="email">dario@guzik.com.ar</a></li>
<li>qip <a href="mailto:qip@users.noreply.github.com"
class="email">qip@users.noreply.github.com</a></li>
<li>yair@unicorn <a href="mailto:yair@unicorn"
class="email">yair@unicorn</a></li>
<li>Matt Robinson <a href="mailto:brimstone@the.narro.ws"
class="email">brimstone@the.narro.ws</a></li>
<li>kayrus <a href="mailto:kay.diam@gmail.com"
class="email">kay.diam@gmail.com</a></li>
<li>Rémy Léone <a href="mailto:remy.leone@gmail.com"
class="email">remy.leone@gmail.com</a></li>
<li>Wojciech Smigielski <a
href="mailto:wojciech.hieronim.smigielski@gmail.com"
class="email">wojciech.hieronim.smigielski@gmail.com</a></li>
<li>weetmuts <a href="mailto:oehrstroem@gmail.com"
class="email">oehrstroem@gmail.com</a></li>
<li>Jonathan <a href="mailto:vanillajonathan@users.noreply.github.com"
class="email">vanillajonathan@users.noreply.github.com</a></li>
<li>James Carpenter <a href="mailto:orbsmiv@users.noreply.github.com"
class="email">orbsmiv@users.noreply.github.com</a></li>
<li>Vince <a href="mailto:vince0villamora@gmail.com"
class="email">vince0villamora@gmail.com</a></li>
<li>Nestar47 <a href="mailto:47841759+Nestar47@users.noreply.github.com"
class="email">47841759+Nestar47@users.noreply.github.com</a></li>
<li>Six <a href="mailto:brbsix@gmail.com"
class="email">brbsix@gmail.com</a></li>
<li>Alexandru Bumbacea <a href="mailto:alexandru.bumbacea@booking.com"
class="email">alexandru.bumbacea@booking.com</a></li>
<li>calisro <a href="mailto:robert.calistri@gmail.com"
class="email">robert.calistri@gmail.com</a></li>
<li>Dr.Rx <a href="mailto:david.rey@nventive.com"
class="email">david.rey@nventive.com</a></li>
<li>marcintustin <a href="mailto:marcintustin@users.noreply.github.com"
class="email">marcintustin@users.noreply.github.com</a></li>
<li>jaKa Močnik <a href="mailto:jaka@koofr.net"
class="email">jaka@koofr.net</a></li>
<li>Fionera <a href="mailto:fionera@fionera.de"
class="email">fionera@fionera.de</a></li>
<li>Dan Walters <a href="mailto:dan@walters.io"
class="email">dan@walters.io</a></li>
<li>Danil Semelenov <a href="mailto:sgtpep@users.noreply.github.com"
class="email">sgtpep@users.noreply.github.com</a></li>
<li>xopez <a href="mailto:28950736+xopez@users.noreply.github.com"
class="email">28950736+xopez@users.noreply.github.com</a></li>
<li>Ben Boeckel <a href="mailto:mathstuf@gmail.com"
class="email">mathstuf@gmail.com</a></li>
<li>Manu <a href="mailto:manu@snapdragon.cc"
class="email">manu@snapdragon.cc</a></li>
<li>Kyle E. Mitchell <a href="mailto:kyle@kemitchell.com"
class="email">kyle@kemitchell.com</a></li>
<li>Gary Kim <a href="mailto:gary@garykim.dev"
class="email">gary@garykim.dev</a></li>
<li>Jon <a href="mailto:jonathn@github.com"
class="email">jonathn@github.com</a></li>
<li>Jeff Quinn <a href="mailto:jeffrey.quinn@bluevoyant.com"
class="email">jeffrey.quinn@bluevoyant.com</a></li>
<li>Peter Berbec <a href="mailto:peter@berbec.com"
class="email">peter@berbec.com</a></li>
<li>didil <a href="mailto:1284255+didil@users.noreply.github.com"
class="email">1284255+didil@users.noreply.github.com</a></li>
<li>id01 <a href="mailto:gaviniboom@gmail.com"
class="email">gaviniboom@gmail.com</a></li>
<li>Robert Marko <a href="mailto:robimarko@gmail.com"
class="email">robimarko@gmail.com</a></li>
<li>Philip Harvey <a
href="mailto:32467456+pharveybattelle@users.noreply.github.com"
class="email">32467456+pharveybattelle@users.noreply.github.com</a></li>
<li>JorisE <a href="mailto:JorisE@users.noreply.github.com"
class="email">JorisE@users.noreply.github.com</a></li>
<li>garry415 <a href="mailto:garry.415@gmail.com"
class="email">garry.415@gmail.com</a></li>
<li>forgems <a href="mailto:forgems@gmail.com"
class="email">forgems@gmail.com</a></li>
<li>Florian Apolloner <a href="mailto:florian@apolloner.eu"
class="email">florian@apolloner.eu</a></li>
<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>
<li>Maran <a href="mailto:maran@protonmail.com"
class="email">maran@protonmail.com</a></li>
<li>nguyenhuuluan434 <a href="mailto:nguyenhuuluan434@gmail.com"
class="email">nguyenhuuluan434@gmail.com</a></li>
<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>
<li>yparitcher <a href="mailto:y@paritcher.com"
class="email">y@paritcher.com</a></li>
<li>AbelThar <a href="mailto:abela.tharen@gmail.com"
class="email">abela.tharen@gmail.com</a></li>
<li>Matti Niemenmaa <a href="mailto:matti.niemenmaa+git@iki.fi"
class="email">matti.niemenmaa+git@iki.fi</a></li>
<li>Russell Davis <a href="mailto:russelldavis@users.noreply.github.com"
class="email">russelldavis@users.noreply.github.com</a></li>
<li>Yi FU <a href="mailto:yi.fu@tink.se"
class="email">yi.fu@tink.se</a></li>
<li>Paul Millar <a href="mailto:paul.millar@desy.de"
class="email">paul.millar@desy.de</a></li>
<li>justinalin <a href="mailto:justinalin@qnap.com"
class="email">justinalin@qnap.com</a></li>
<li>EliEron <a href="mailto:subanimehd@gmail.com"
class="email">subanimehd@gmail.com</a></li>
<li>justina777 <a href="mailto:chiahuei.lin@gmail.com"
class="email">chiahuei.lin@gmail.com</a></li>
<li>Chaitanya Bankanhal <a href="mailto:bchaitanya15@gmail.com"
class="email">bchaitanya15@gmail.com</a></li>
<li>Michał Matczuk <a href="mailto:michal@scylladb.com"
class="email">michal@scylladb.com</a></li>
<li>Macavirus <a href="mailto:macavirus@zoho.com"
class="email">macavirus@zoho.com</a></li>
<li>Abhinav Sharma <a href="mailto:abhi18av@outlook.com"
class="email">abhi18av@outlook.com</a></li>
<li>ginvine <a href="mailto:34869051+ginvine@users.noreply.github.com"
class="email">34869051+ginvine@users.noreply.github.com</a></li>
<li>Patrick Wang <a href="mailto:mail6543210@yahoo.com.tw"
class="email">mail6543210@yahoo.com.tw</a></li>
<li>Cenk Alti <a href="mailto:cenkalti@gmail.com"
class="email">cenkalti@gmail.com</a></li>
<li>Andreas Chlupka <a href="mailto:andy@chlupka.com"
class="email">andy@chlupka.com</a></li>
<li>Alfonso Montero <a href="mailto:amontero@tinet.org"
class="email">amontero@tinet.org</a></li>
<li>Ivan Andreev <a href="mailto:ivandeex@gmail.com"
class="email">ivandeex@gmail.com</a></li>
<li>David Baumgold <a href="mailto:david@davidbaumgold.com"
class="email">david@davidbaumgold.com</a></li>
<li>Lars Lehtonen <a href="mailto:lars.lehtonen@gmail.com"
class="email">lars.lehtonen@gmail.com</a></li>
<li>Matei David <a href="mailto:matei.david@gmail.com"
class="email">matei.david@gmail.com</a></li>
<li>David <a href="mailto:david.bramwell@endemolshine.com"
class="email">david.bramwell@endemolshine.com</a></li>
<li>Anthony Rusdi <a
href="mailto:33247310+antrusd@users.noreply.github.com"
class="email">33247310+antrusd@users.noreply.github.com</a></li>
<li>Richard Patel <a href="mailto:me@terorie.dev"
class="email">me@terorie.dev</a></li>
<li>庄天翼 <a href="mailto:zty0826@gmail.com"
class="email">zty0826@gmail.com</a></li>
<li>SwitchJS <a href="mailto:dev@switchjs.com"
class="email">dev@switchjs.com</a></li>
<li>Raphael <a href="mailto:PowershellNinja@users.noreply.github.com"
class="email">PowershellNinja@users.noreply.github.com</a></li>
<li>Sezal Agrawal <a href="mailto:sezalagrawal@gmail.com"
class="email">sezalagrawal@gmail.com</a></li>
<li>Tyler <a href="mailto:TylerNakamura@users.noreply.github.com"
class="email">TylerNakamura@users.noreply.github.com</a></li>
<li>Brett Dutro <a href="mailto:brett.dutro@gmail.com"
class="email">brett.dutro@gmail.com</a></li>
<li>Vighnesh SK <a href="mailto:booterror99@gmail.com"
class="email">booterror99@gmail.com</a></li>
<li>Arijit Biswas <a href="mailto:dibbyo456@gmail.com"
class="email">dibbyo456@gmail.com</a></li>
<li>Michele Caci <a href="mailto:michele.caci@gmail.com"
class="email">michele.caci@gmail.com</a></li>
<li>AlexandrBoltris <a href="mailto:ua2fgb@gmail.com"
class="email">ua2fgb@gmail.com</a></li>
<li>Bryce Larson <a href="mailto:blarson@saltstack.com"
class="email">blarson@saltstack.com</a></li>
<li>Carlos Ferreyra <a href="mailto:crypticmind@gmail.com"
class="email">crypticmind@gmail.com</a></li>
<li>Saksham Khanna <a href="mailto:sakshamkhanna@outlook.com"
class="email">sakshamkhanna@outlook.com</a></li>
<li>dausruddin <a
href="mailto:5763466+dausruddin@users.noreply.github.com"
class="email">5763466+dausruddin@users.noreply.github.com</a></li>
<li>zero-24 <a href="mailto:zero-24@users.noreply.github.com"
class="email">zero-24@users.noreply.github.com</a></li>
<li>Xiaoxing Ye <a href="mailto:ye@xiaoxing.us"
class="email">ye@xiaoxing.us</a></li>
<li>Barry Muldrey <a href="mailto:barry@muldrey.net"
class="email">barry@muldrey.net</a></li>
<li>Sebastian Brandt <a href="mailto:sebastian.brandt@friday.de"
class="email">sebastian.brandt@friday.de</a></li>
<li>Marco Molteni <a href="mailto:marco.molteni@mailbox.org"
class="email">marco.molteni@mailbox.org</a></li>
<li>Ankur Gupta <a
href="mailto:7876747+ankur0493@users.noreply.github.com"
class="email">7876747+ankur0493@users.noreply.github.com</a></li>
<li>Maciej Zimnoch <a href="mailto:maciej@scylladb.com"
class="email">maciej@scylladb.com</a></li>
<li>anuar45 <a href="mailto:serdaliyev.anuar@gmail.com"
class="email">serdaliyev.anuar@gmail.com</a></li>
<li>Fernando <a href="mailto:ferferga@users.noreply.github.com"
class="email">ferferga@users.noreply.github.com</a></li>
<li>David Cole <a href="mailto:david.cole@sohonet.com"
class="email">david.cole@sohonet.com</a></li>
<li>Wei He <a href="mailto:git@weispot.com"
class="email">git@weispot.com</a></li>
<li>Outvi V <a href="mailto:19144373+outloudvi@users.noreply.github.com"
class="email">19144373+outloudvi@users.noreply.github.com</a></li>
<li>Thomas Kriechbaumer <a href="mailto:thomas@kriechbaumer.name"
class="email">thomas@kriechbaumer.name</a></li>
<li>Tennix <a href="mailto:tennix@users.noreply.github.com"
class="email">tennix@users.noreply.github.com</a></li>
<li>Ole Schütt <a href="mailto:ole@schuett.name"
class="email">ole@schuett.name</a></li>
<li>Kuang-che Wu <a href="mailto:kcwu@csie.org"
class="email">kcwu@csie.org</a></li>
<li>Thomas Eales <a href="mailto:wingsuit@users.noreply.github.com"
class="email">wingsuit@users.noreply.github.com</a></li>
<li>Paul Tinsley <a href="mailto:paul.tinsley@vitalsource.com"
class="email">paul.tinsley@vitalsource.com</a></li>
<li>Felix Hungenberg <a href="mailto:git@shiftgeist.com"
class="email">git@shiftgeist.com</a></li>
<li>Benjamin Richter <a href="mailto:github@dev.telepath.de"
class="email">github@dev.telepath.de</a></li>
<li>landall <a href="mailto:cst_zf@qq.com"
class="email">cst_zf@qq.com</a></li>
<li>thestigma <a href="mailto:thestigma@gmail.com"
class="email">thestigma@gmail.com</a></li>
<li>jtagcat <a href="mailto:38327267+jtagcat@users.noreply.github.com"
class="email">38327267+jtagcat@users.noreply.github.com</a></li>
<li>Damon Permezel <a href="mailto:permezel@me.com"
class="email">permezel@me.com</a></li>
<li>boosh <a href="mailto:boosh@users.noreply.github.com"
class="email">boosh@users.noreply.github.com</a></li>
<li>unbelauscht <a
href="mailto:58393353+unbelauscht@users.noreply.github.com"
class="email">58393353+unbelauscht@users.noreply.github.com</a></li>
<li>Motonori IWAMURO <a href="mailto:vmi@nifty.com"
class="email">vmi@nifty.com</a></li>
<li>Benjapol Worakan <a href="mailto:benwrk@live.com"
class="email">benwrk@live.com</a></li>
<li>Dave Koston <a href="mailto:dave.koston@stackpath.com"
class="email">dave.koston@stackpath.com</a></li>
<li>Durval Menezes <a
href="mailto:DurvalMenezes@users.noreply.github.com"
class="email">DurvalMenezes@users.noreply.github.com</a></li>
<li>Tim Gallant <a href="mailto:me@timgallant.us"
class="email">me@timgallant.us</a></li>
<li>Frederick Zhang <a href="mailto:frederick888@tsundere.moe"
class="email">frederick888@tsundere.moe</a></li>
<li>valery1707 <a href="mailto:valery1707@gmail.com"
class="email">valery1707@gmail.com</a></li>
<li>Yves G <a href="mailto:theYinYeti@yalis.fr"
class="email">theYinYeti@yalis.fr</a></li>
<li>Shing Kit Chan <a href="mailto:chanshingkit@gmail.com"
class="email">chanshingkit@gmail.com</a></li>
<li>Franklyn Tackitt <a href="mailto:franklyn@tackitt.net"
class="email">franklyn@tackitt.net</a></li>
<li>Robert-André Mauchin <a href="mailto:zebob.m@gmail.com"
class="email">zebob.m@gmail.com</a></li>
<li>evileye <a href="mailto:48332831+ibiruai@users.noreply.github.com"
class="email">48332831+ibiruai@users.noreply.github.com</a></li>
<li>Joachim Brandon LeBlanc <a href="mailto:brandon@leblanc.codes"
class="email">brandon@leblanc.codes</a></li>
<li>Patryk Jakuszew <a href="mailto:patryk.jakuszew@gmail.com"
class="email">patryk.jakuszew@gmail.com</a></li>
<li>fishbullet <a href="mailto:shindu666@gmail.com"
class="email">shindu666@gmail.com</a></li>
<li>greatroar &lt;@&gt;</li>
<li>Bernd Schoolmann <a href="mailto:mail@quexten.com"
class="email">mail@quexten.com</a></li>
<li>Elan Ruusamäe <a href="mailto:glen@pld-linux.org"
class="email">glen@pld-linux.org</a></li>
<li>Max Sum <a href="mailto:max@lolyculture.com"
class="email">max@lolyculture.com</a></li>
<li>Mark Spieth <a href="mailto:mspieth@users.noreply.github.com"
class="email">mspieth@users.noreply.github.com</a></li>
<li>harry <a href="mailto:me@harry.plus"
class="email">me@harry.plus</a></li>
<li>Samantha McVey <a href="mailto:samantham@posteo.net"
class="email">samantham@posteo.net</a></li>
<li>Jack Anderson <a href="mailto:jack.anderson@metaswitch.com"
class="email">jack.anderson@metaswitch.com</a></li>
<li>Michael G <a href="mailto:draget@speciesm.net"
class="email">draget@speciesm.net</a></li>
<li>Brandon Philips <a href="mailto:brandon@ifup.org"
class="email">brandon@ifup.org</a></li>
<li>Daven <a href="mailto:dooven@users.noreply.github.com"
class="email">dooven@users.noreply.github.com</a></li>
<li>Martin Stone <a href="mailto:martin@d7415.co.uk"
class="email">martin@d7415.co.uk</a></li>
<li>David Bramwell <a
href="mailto:13053834+dbramwell@users.noreply.github.com"
class="email">13053834+dbramwell@users.noreply.github.com</a></li>
<li>Sunil Patra <a href="mailto:snl_su@live.com"
class="email">snl_su@live.com</a></li>
<li>Adam Stroud <a href="mailto:adam.stroud@gmail.com"
class="email">adam.stroud@gmail.com</a></li>
<li>Kush <a href="mailto:kushsharma@users.noreply.github.com"
class="email">kushsharma@users.noreply.github.com</a></li>
<li>Matan Rosenberg <a href="mailto:matan129@gmail.com"
class="email">matan129@gmail.com</a></li>
<li>gitch1 <a href="mailto:63495046+gitch1@users.noreply.github.com"
class="email">63495046+gitch1@users.noreply.github.com</a></li>
<li>ElonH <a href="mailto:elonhhuang@gmail.com"
class="email">elonhhuang@gmail.com</a></li>
<li>Fred <a href="mailto:fred@creativeprojects.tech"
class="email">fred@creativeprojects.tech</a></li>
<li>Sébastien Gross <a href="mailto:renard@users.noreply.github.com"
class="email">renard@users.noreply.github.com</a></li>
<li>Maxime Suret <a
href="mailto:11944422+msuret@users.noreply.github.com"
class="email">11944422+msuret@users.noreply.github.com</a></li>
<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>
<li>Ben Zenker <a href="mailto:imbenzenker@gmail.com"
class="email">imbenzenker@gmail.com</a></li>
<li>Martin Michlmayr <a href="mailto:tbm@cyrius.com"
class="email">tbm@cyrius.com</a></li>
<li>Brandon McNama <a href="mailto:bmcnama@pagerduty.com"
class="email">bmcnama@pagerduty.com</a></li>
<li>Daniel Slyman <a href="mailto:github@skylayer.eu"
class="email">github@skylayer.eu</a></li>
<li>Alex Guerrero <a href="mailto:guerrero@users.noreply.github.com"
class="email">guerrero@users.noreply.github.com</a></li>
<li>Matteo Pietro Dazzi <a href="mailto:matteopietro.dazzi@gft.com"
class="email">matteopietro.dazzi@gft.com</a></li>
<li>edwardxml <a
href="mailto:56691903+edwardxml@users.noreply.github.com"
class="email">56691903+edwardxml@users.noreply.github.com</a></li>
<li>Roman Kredentser <a href="mailto:shareed2k@gmail.com"
class="email">shareed2k@gmail.com</a></li>
<li>Kamil Trzciński <a href="mailto:ayufan@ayufan.eu"
class="email">ayufan@ayufan.eu</a></li>
<li>Zac Rubin <a href="mailto:z-0@users.noreply.github.com"
class="email">z-0@users.noreply.github.com</a></li>
<li>Vincent Feltz <a href="mailto:psycho@feltzv.fr"
class="email">psycho@feltzv.fr</a></li>
<li>Heiko Bornholdt <a href="mailto:bornholdt@informatik.uni-hamburg.de"
class="email">bornholdt@informatik.uni-hamburg.de</a></li>
<li>Matteo Pietro Dazzi <a href="mailto:matteopietro.dazzi@gmail.com"
class="email">matteopietro.dazzi@gmail.com</a></li>
<li>jtagcat <a href="mailto:gitlab@c7.ee"
class="email">gitlab@c7.ee</a></li>
<li>Petri Salminen <a href="mailto:petri@salminen.dev"
class="email">petri@salminen.dev</a></li>
<li>Tim Burke <a href="mailto:tim.burke@gmail.com"
class="email">tim.burke@gmail.com</a></li>
<li>Kai Lüke <a href="mailto:kai@kinvolk.io"
class="email">kai@kinvolk.io</a></li>
<li>Garrett Squire <a href="mailto:github@garrettsquire.com"
class="email">github@garrettsquire.com</a></li>
<li>Evan Harris <a href="mailto:eharris@puremagic.com"
class="email">eharris@puremagic.com</a></li>
<li>Kevin <a href="mailto:keyam@microsoft.com"
class="email">keyam@microsoft.com</a></li>
<li>Morten Linderud <a href="mailto:morten@linderud.pw"
class="email">morten@linderud.pw</a></li>
<li>Dmitry Ustalov <a href="mailto:dmitry.ustalov@gmail.com"
class="email">dmitry.ustalov@gmail.com</a></li>
<li>Jack <a href="mailto:196648+jdeng@users.noreply.github.com"
class="email">196648+jdeng@users.noreply.github.com</a></li>
<li>kcris <a href="mailto:cristian.tarsoaga@gmail.com"
class="email">cristian.tarsoaga@gmail.com</a></li>
<li>tyhuber1 <a href="mailto:68970760+tyhuber1@users.noreply.github.com"
class="email">68970760+tyhuber1@users.noreply.github.com</a></li>
<li>David Ibarra <a href="mailto:david.ibarra@realty.com"
class="email">david.ibarra@realty.com</a></li>
<li>Tim Gallant <a href="mailto:tim@lilt.com"
class="email">tim@lilt.com</a></li>
<li>Kaloyan Raev <a href="mailto:kaloyan@storj.io"
class="email">kaloyan@storj.io</a></li>
<li>Jay McEntire <a href="mailto:jay.mcentire@gmail.com"
class="email">jay.mcentire@gmail.com</a></li>
<li>Leo Luan <a href="mailto:leoluan@us.ibm.com"
class="email">leoluan@us.ibm.com</a></li>
<li>aus <a href="mailto:549081+aus@users.noreply.github.com"
class="email">549081+aus@users.noreply.github.com</a></li>
<li>Aaron Gokaslan <a href="mailto:agokaslan@fb.com"
class="email">agokaslan@fb.com</a></li>
<li>Egor Margineanu <a href="mailto:egmar@users.noreply.github.com"
class="email">egmar@users.noreply.github.com</a></li>
<li>Lucas Kanashiro <a href="mailto:lucas.kanashiro@canonical.com"
class="email">lucas.kanashiro@canonical.com</a></li>
<li>WarpedPixel <a href="mailto:WarpedPixel@users.noreply.github.com"
class="email">WarpedPixel@users.noreply.github.com</a></li>
<li>Sam Edwards <a href="mailto:sam@samedwards.ca"
class="email">sam@samedwards.ca</a></li>
<li>wjielai <a href="mailto:gouki0123@gmail.com"
class="email">gouki0123@gmail.com</a></li>
<li>Muffin King <a href="mailto:jinxz_k@live.com"
class="email">jinxz_k@live.com</a></li>
<li>Christopher Stewart <a
href="mailto:6573710+1f47a@users.noreply.github.com"
class="email">6573710+1f47a@users.noreply.github.com</a></li>
<li>Russell Cattelan <a href="mailto:cattelan@digitalelves.com"
class="email">cattelan@digitalelves.com</a></li>
<li>gyutw <a href="mailto:30371241+gyutw@users.noreply.github.com"
class="email">30371241+gyutw@users.noreply.github.com</a></li>
<li>Hekmon <a href="mailto:edouardhur@gmail.com"
class="email">edouardhur@gmail.com</a></li>
<li>LaSombra <a href="mailto:lasombra@users.noreply.github.com"
class="email">lasombra@users.noreply.github.com</a></li>
<li>Dov Murik <a href="mailto:dov.murik@gmail.com"
class="email">dov.murik@gmail.com</a></li>
<li>Ameer Dawood <a href="mailto:ameer1234567890@gmail.com"
class="email">ameer1234567890@gmail.com</a></li>
<li>Dan Hipschman <a href="mailto:dan.hipschman@opendoor.com"
class="email">dan.hipschman@opendoor.com</a></li>
<li>Josh Soref <a href="mailto:jsoref@users.noreply.github.com"
class="email">jsoref@users.noreply.github.com</a></li>
<li>David <a href="mailto:david@staron.nl"
class="email">david@staron.nl</a></li>
<li>Ingo <a href="mailto:ingo@hoffmann.cx"
class="email">ingo@hoffmann.cx</a></li>
<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>
<li>Manish Gupta <a href="mailto:manishgupta.ait@gmail.com"
class="email">manishgupta.ait@gmail.com</a></li>
<li>Deepak Sah <a href="mailto:sah.sslpu@gmail.com"
class="email">sah.sslpu@gmail.com</a></li>
<li>Marcin Zelent <a href="mailto:marcin@zelent.net"
class="email">marcin@zelent.net</a></li>
<li>zhucan <a href="mailto:zhucan.k8s@gmail.com"
class="email">zhucan.k8s@gmail.com</a></li>
<li>James Lim <a href="mailto:james.lim@samsara.com"
class="email">james.lim@samsara.com</a></li>
<li>Laurens Janssen <a href="mailto:BD69BM@insim.biz"
class="email">BD69BM@insim.biz</a></li>
<li>Bob Bagwill <a href="mailto:bobbagwill@gmail.com"
class="email">bobbagwill@gmail.com</a></li>
<li>Nathan Collins <a href="mailto:colli372@msu.edu"
class="email">colli372@msu.edu</a></li>
<li>lostheli</li>
<li>kelv <a href="mailto:kelvin@acks.org"
class="email">kelvin@acks.org</a></li>
<li>Milly <a href="mailto:milly.ca@gmail.com"
class="email">milly.ca@gmail.com</a></li>
<li>gtorelly <a href="mailto:gtorelly@gmail.com"
class="email">gtorelly@gmail.com</a></li>
<li>Brad Ackerman <a href="mailto:brad@facefault.org"
class="email">brad@facefault.org</a></li>
<li>Mitsuo Heijo <a href="mailto:mitsuo.heijo@gmail.com"
class="email">mitsuo.heijo@gmail.com</a></li>
<li>Claudio Bantaloukas <a href="mailto:rockdreamer@gmail.com"
class="email">rockdreamer@gmail.com</a></li>
<li>Benjamin Gustin <a href="mailto:gustin.ben@gmail.com"
class="email">gustin.ben@gmail.com</a></li>
<li>Ingo Weiss <a href="mailto:ingo@redhat.com"
class="email">ingo@redhat.com</a></li>
<li>Kerry Su <a href="mailto:me@sshockwave.net"
class="email">me@sshockwave.net</a></li>
<li>Ilyess Bachiri <a href="mailto:ilyess.bachiri@sonder.com"
class="email">ilyess.bachiri@sonder.com</a></li>
<li>Yury Stankevich <a href="mailto:urykhy@gmail.com"
class="email">urykhy@gmail.com</a></li>
<li>kice <a href="mailto:wslikerqs@gmail.com"
class="email">wslikerqs@gmail.com</a></li>
<li>Denis Neuling <a href="mailto:denisneuling@gmail.com"
class="email">denisneuling@gmail.com</a></li>
<li>Janne Johansson <a href="mailto:icepic.dz@gmail.com"
class="email">icepic.dz@gmail.com</a></li>
<li>Patrik Nordlén <a href="mailto:patriki@gmail.com"
class="email">patriki@gmail.com</a></li>
<li>CokeMine <a href="mailto:aptx4561@gmail.com"
class="email">aptx4561@gmail.com</a></li>
<li>Sơn Trần-Nguyễn <a href="mailto:github@sntran.com"
class="email">github@sntran.com</a></li>
<li>lluuaapp <a href="mailto:266615+lluuaapp@users.noreply.github.com"
class="email">266615+lluuaapp@users.noreply.github.com</a></li>
<li>Zach Kipp <a href="mailto:kipp.zach@gmail.com"
class="email">kipp.zach@gmail.com</a></li>
<li>Riccardo Iaconelli <a href="mailto:riccardo@kde.org"
class="email">riccardo@kde.org</a></li>
<li>Sakuragawa Misty <a href="mailto:gyc990326@gmail.com"
class="email">gyc990326@gmail.com</a></li>
<li>Nicolas Rueff <a href="mailto:nicolas@rueff.fr"
class="email">nicolas@rueff.fr</a></li>
<li>Pau Rodriguez-Estivill <a href="mailto:prodrigestivill@gmail.com"
class="email">prodrigestivill@gmail.com</a></li>
<li>Bob Pusateri <a href="mailto:BobPusateri@users.noreply.github.com"
class="email">BobPusateri@users.noreply.github.com</a></li>
<li>Alex JOST <a href="mailto:25005220+dimejo@users.noreply.github.com"
class="email">25005220+dimejo@users.noreply.github.com</a></li>
<li>Alexey Tabakman <a href="mailto:samosad.ru@gmail.com"
class="email">samosad.ru@gmail.com</a></li>
<li>David Sze <a href="mailto:sze.david@gmail.com"
class="email">sze.david@gmail.com</a></li>
<li>cynthia kwok <a href="mailto:cynthia.m.kwok@gmail.com"
class="email">cynthia.m.kwok@gmail.com</a></li>
<li>Miron Veryanskiy <a href="mailto:MironVeryanskiy@gmail.com"
class="email">MironVeryanskiy@gmail.com</a></li>
<li>K265 <a href="mailto:k.265@qq.com"
class="email">k.265@qq.com</a></li>
<li>Vesnyx <a href="mailto:Vesnyx@users.noreply.github.com"
class="email">Vesnyx@users.noreply.github.com</a></li>
<li>Dmitry Chepurovskiy <a href="mailto:me@dm3ch.net"
class="email">me@dm3ch.net</a></li>
<li>Rauno Ots <a href="mailto:rauno.ots@cgi.com"
class="email">rauno.ots@cgi.com</a></li>
<li>Georg Neugschwandtner <a href="mailto:georg.neugschwandtner@gmx.net"
class="email">georg.neugschwandtner@gmx.net</a></li>
<li>pvalls <a href="mailto:polvallsrue@gmail.com"
class="email">polvallsrue@gmail.com</a></li>
<li>Robert Thomas <a
href="mailto:31854736+wolveix@users.noreply.github.com"
class="email">31854736+wolveix@users.noreply.github.com</a></li>
<li>Romeo Kienzler <a href="mailto:romeo.kienzler@gmail.com"
class="email">romeo.kienzler@gmail.com</a></li>
<li>tYYGH <a href="mailto:tYYGH@users.noreply.github.com"
class="email">tYYGH@users.noreply.github.com</a></li>
<li>georne <a href="mailto:77802995+georne@users.noreply.github.com"
class="email">77802995+georne@users.noreply.github.com</a></li>
<li>Maxwell Calman <a href="mailto:mcalman@MacBook-Pro.local"
class="email">mcalman@MacBook-Pro.local</a></li>
<li>Naveen Honest Raj <a href="mailto:naveendurai19@gmail.com"
class="email">naveendurai19@gmail.com</a></li>
<li>Lucas Messenger <a href="mailto:lmesseng@cisco.com"
class="email">lmesseng@cisco.com</a></li>
<li>Manish Kumar <a href="mailto:krmanish260@gmail.com"
class="email">krmanish260@gmail.com</a></li>
<li>x0b <a href="mailto:x0bdev@gmail.com"
class="email">x0bdev@gmail.com</a></li>
<li>CERN through the CS3MESH4EOSC Project</li>
<li>Nick Gaya <a href="mailto:nicholasgaya+github@gmail.com"
class="email">nicholasgaya+github@gmail.com</a></li>
<li>Ashok Gelal <a
href="mailto:401055+ashokgelal@users.noreply.github.com"
class="email">401055+ashokgelal@users.noreply.github.com</a></li>
<li>Dominik Mydlil <a href="mailto:dominik.mydlil@outlook.com"
class="email">dominik.mydlil@outlook.com</a></li>
<li>Nazar Mishturak <a href="mailto:nazarmx@gmail.com"
class="email">nazarmx@gmail.com</a></li>
<li>Ansh Mittal <a href="mailto:iamAnshMittal@gmail.com"
class="email">iamAnshMittal@gmail.com</a></li>
<li>noabody <a href="mailto:noabody@yahoo.com"
class="email">noabody@yahoo.com</a></li>
<li>OleFrost <a href="mailto:82263101+olefrost@users.noreply.github.com"
class="email">82263101+olefrost@users.noreply.github.com</a></li>
<li>Kenny Parsons <a href="mailto:kennyparsons93@gmail.com"
class="email">kennyparsons93@gmail.com</a></li>
<li>Jeffrey Tolar <a href="mailto:tolar.jeffrey@gmail.com"
class="email">tolar.jeffrey@gmail.com</a></li>
<li>jtagcat <a href="mailto:git-514635f7@jtag.cat"
class="email">git-514635f7@jtag.cat</a></li>
<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>
<li>lewisxy <a href="mailto:lewisxy@users.noreply.github.com"
class="email">lewisxy@users.noreply.github.com</a></li>
<li>Nolan Woods <a href="mailto:nolan_w@sfu.ca"
class="email">nolan_w@sfu.ca</a></li>
<li>Gautam Kumar <a
href="mailto:25435568+gautamajay52@users.noreply.github.com"
class="email">25435568+gautamajay52@users.noreply.github.com</a></li>
<li>Chris Macklin <a href="mailto:chris.macklin@10xgenomics.com"
class="email">chris.macklin@10xgenomics.com</a></li>
<li>Antoon Prins <a href="mailto:antoon.prins@surfsara.nl"
class="email">antoon.prins@surfsara.nl</a></li>
<li>Alexey Ivanov <a href="mailto:rbtz@dropbox.com"
class="email">rbtz@dropbox.com</a></li>
<li>Serge Pouliquen <a href="mailto:sp31415@free.fr"
class="email">sp31415@free.fr</a></li>
<li>acsfer <a href="mailto:carlos@reendex.com"
class="email">carlos@reendex.com</a></li>
<li>Tom <a href="mailto:tom@tom-fitzhenry.me.uk"
class="email">tom@tom-fitzhenry.me.uk</a></li>
<li>Tyson Moore <a href="mailto:tyson@tyson.me"
class="email">tyson@tyson.me</a></li>
<li>database64128 <a href="mailto:free122448@hotmail.com"
class="email">free122448@hotmail.com</a></li>
<li>Chris Lu <a href="mailto:chrislusf@users.noreply.github.com"
class="email">chrislusf@users.noreply.github.com</a></li>
<li>Reid Buzby <a href="mailto:reid@rethink.software"
class="email">reid@rethink.software</a></li>
<li>darrenrhs <a href="mailto:darrenrhs@gmail.com"
class="email">darrenrhs@gmail.com</a></li>
<li>Florian Penzkofer <a href="mailto:fp@nullptr.de"
class="email">fp@nullptr.de</a></li>
<li>Xuanchen Wu <a href="mailto:117010292@link.cuhk.edu.cn"
class="email">117010292@link.cuhk.edu.cn</a></li>
<li>partev <a href="mailto:petrosyan@gmail.com"
class="email">petrosyan@gmail.com</a></li>
<li>Dmitry Sitnikov <a href="mailto:fo2@inbox.ru"
class="email">fo2@inbox.ru</a></li>
<li>Haochen Tong <a href="mailto:i@hexchain.org"
class="email">i@hexchain.org</a></li>
<li>Michael Hanselmann <a href="mailto:public@hansmi.ch"
class="email">public@hansmi.ch</a></li>
<li>Chuan Zh <a href="mailto:zhchuan7@gmail.com"
class="email">zhchuan7@gmail.com</a></li>
<li>Antoine GIRARD <a href="mailto:antoine.girard@sapk.fr"
class="email">antoine.girard@sapk.fr</a></li>
<li>Justin Winokur (Jwink3101) <a
href="mailto:Jwink3101@users.noreply.github.com"
class="email">Jwink3101@users.noreply.github.com</a></li>
<li>Mariano Absatz (git) <a href="mailto:scm@baby.com.ar"
class="email">scm@baby.com.ar</a></li>
<li>Greg Sadetsky <a href="mailto:lepetitg@gmail.com"
class="email">lepetitg@gmail.com</a></li>
<li>yedamo <a href="mailto:logindaveye@gmail.com"
class="email">logindaveye@gmail.com</a></li>
<li>hota <a href="mailto:lindwurm.q@gmail.com"
class="email">lindwurm.q@gmail.com</a></li>
<li>vinibali <a href="mailto:vinibali1@gmail.com"
class="email">vinibali1@gmail.com</a></li>
<li>Ken Enrique Morel <a href="mailto:ken.morel.santana@gmail.com"
class="email">ken.morel.santana@gmail.com</a></li>
<li>Justin Hellings <a href="mailto:justin.hellings@gmail.com"
class="email">justin.hellings@gmail.com</a></li>
<li>Parth Shukla <a href="mailto:pparth@pparth.net"
class="email">pparth@pparth.net</a></li>
<li>wzl <a href="mailto:wangzl31@outlook.com"
class="email">wangzl31@outlook.com</a></li>
<li>HNGamingUK <a href="mailto:connor@earnshawhome.co.uk"
class="email">connor@earnshawhome.co.uk</a></li>
<li>Jonta <a href="mailto:359397+Jonta@users.noreply.github.com"
class="email">359397+Jonta@users.noreply.github.com</a></li>
<li>YenForYang <a href="mailto:YenForYang@users.noreply.github.com"
class="email">YenForYang@users.noreply.github.com</a></li>
<li>Joda Stößer <a href="mailto:stoesser@yay-digital.de"
class="email">stoesser@yay-digital.de</a> <a
href="mailto:services+github@simjo.st"
class="email">services+github@simjo.st</a></li>
<li>Logeshwaran <a href="mailto:waranlogesh@gmail.com"
class="email">waranlogesh@gmail.com</a></li>
<li>Rajat Goel <a href="mailto:rajat@dropbox.com"
class="email">rajat@dropbox.com</a></li>
<li>r0kk3rz <a href="mailto:r0kk3rz@gmail.com"
class="email">r0kk3rz@gmail.com</a></li>
<li>Matthew Sevey <a href="mailto:mjsevey@gmail.com"
class="email">mjsevey@gmail.com</a></li>
<li>Filip Rysavy <a href="mailto:fil@siasky.net"
class="email">fil@siasky.net</a></li>
<li>Ian Levesque <a href="mailto:ian@ianlevesque.org"
class="email">ian@ianlevesque.org</a></li>
<li>Thomas Stachl <a href="mailto:thomas@stachl.me"
class="email">thomas@stachl.me</a></li>
<li>Dmitry Bogatov <a href="mailto:git#v1@kaction.cc"
class="email">git#v1@kaction.cc</a></li>
<li>thomae <a href="mailto:4493560+thomae@users.noreply.github.com"
class="email">4493560+thomae@users.noreply.github.com</a></li>
<li>trevyn <a href="mailto:trevyn-git@protonmail.com"
class="email">trevyn-git@protonmail.com</a></li>
<li>David Liu <a href="mailto:david.yx.liu@oracle.com"
class="email">david.yx.liu@oracle.com</a></li>
<li>Chris Nelson <a href="mailto:stuff@cjnaz.com"
class="email">stuff@cjnaz.com</a></li>
<li>Felix Bünemann <a href="mailto:felix.buenemann@gmail.com"
class="email">felix.buenemann@gmail.com</a></li>
<li>Atílio Antônio <a href="mailto:atiliodadalto@hotmail.com"
class="email">atiliodadalto@hotmail.com</a></li>
<li>Roberto Ricci <a href="mailto:ricci@disroot.org"
class="email">ricci@disroot.org</a></li>
<li>Carlo Mion <a href="mailto:mion00@gmail.com"
class="email">mion00@gmail.com</a></li>
<li>Chris Lu <a href="mailto:chris.lu@gmail.com"
class="email">chris.lu@gmail.com</a></li>
<li>Vitor Arruda <a href="mailto:vitor.pimenta.arruda@gmail.com"
class="email">vitor.pimenta.arruda@gmail.com</a></li>
<li>bbabich <a href="mailto:bbabich@datamossa.com"
class="email">bbabich@datamossa.com</a></li>
<li>David <a href="mailto:dp.davide.palma@gmail.com"
class="email">dp.davide.palma@gmail.com</a></li>
<li>Borna Butkovic <a href="mailto:borna@favicode.net"
class="email">borna@favicode.net</a></li>
<li>Fredric Arklid <a href="mailto:fredric.arklid@consid.se"
class="email">fredric.arklid@consid.se</a></li>
<li>Andy Jackson <a href="mailto:Andrew.Jackson@bl.uk"
class="email">Andrew.Jackson@bl.uk</a></li>
<li>Sinan Tan <a href="mailto:i@tinytangent.com"
class="email">i@tinytangent.com</a></li>
<li>deinferno <a
href="mailto:14363193+deinferno@users.noreply.github.com"
class="email">14363193+deinferno@users.noreply.github.com</a></li>
<li>rsapkf <a href="mailto:rsapkfff@pm.me"
class="email">rsapkfff@pm.me</a></li>
<li>Will Holtz <a href="mailto:wholtz@gmail.com"
class="email">wholtz@gmail.com</a></li>
<li>GGG KILLER <a href="mailto:gggkiller2@gmail.com"
class="email">gggkiller2@gmail.com</a></li>
<li>Logeshwaran Murugesan <a href="mailto:logeshwaran@testpress.in"
class="email">logeshwaran@testpress.in</a></li>
<li>Lu Wang <a href="mailto:coolwanglu@gmail.com"
class="email">coolwanglu@gmail.com</a></li>
<li>Bumsu Hyeon <a href="mailto:ksitht@gmail.com"
class="email">ksitht@gmail.com</a></li>
<li>Shmz Ozggrn <a
href="mailto:98463324+ShmzOzggrn@users.noreply.github.com"
class="email">98463324+ShmzOzggrn@users.noreply.github.com</a></li>
<li>Kim <a href="mailto:kim@jotta.no"
class="email">kim@jotta.no</a></li>
<li>Niels van de Weem <a href="mailto:n.van.de.weem@smile.nl"
class="email">n.van.de.weem@smile.nl</a></li>
<li>Koopa <a href="mailto:codingkoopa@gmail.com"
class="email">codingkoopa@gmail.com</a></li>
<li>Yunhai Luo <a href="mailto:yunhai-luo@hotmail.com"
class="email">yunhai-luo@hotmail.com</a></li>
<li>Charlie Jiang <a href="mailto:w@chariri.moe"
class="email">w@chariri.moe</a></li>
<li>Alain Nussbaumer <a href="mailto:alain.nussbaumer@alleluia.ch"
class="email">alain.nussbaumer@alleluia.ch</a></li>
<li>Vanessasaurus <a href="mailto:814322+vsoch@users.noreply.github.com"
class="email">814322+vsoch@users.noreply.github.com</a></li>
<li>Isaac Levy <a href="mailto:isaac.r.levy@gmail.com"
class="email">isaac.r.levy@gmail.com</a></li>
<li>Gourav T <a href="mailto:workflowautomation@protonmail.com"
class="email">workflowautomation@protonmail.com</a></li>
<li>Paulo Martins <a href="mailto:paulo.pontes.m@gmail.com"
class="email">paulo.pontes.m@gmail.com</a></li>
<li>viveknathani <a href="mailto:viveknathani2402@gmail.com"
class="email">viveknathani2402@gmail.com</a></li>
<li>Eng Zer Jun <a href="mailto:engzerjun@gmail.com"
class="email">engzerjun@gmail.com</a></li>
<li>Abhiraj <a href="mailto:abhiraj.official15@gmail.com"
class="email">abhiraj.official15@gmail.com</a></li>
<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>
<li>Vincent Murphy <a href="mailto:vdm@vdm.ie"
class="email">vdm@vdm.ie</a></li>
<li>ctrl-q <a href="mailto:34975747+ctrl-q@users.noreply.github.com"
class="email">34975747+ctrl-q@users.noreply.github.com</a></li>
<li>Nil Alexandrov <a href="mailto:nalexand@akamai.com"
class="email">nalexand@akamai.com</a></li>
<li>GuoXingbin <a
href="mailto:101376330+guoxingbin@users.noreply.github.com"
class="email">101376330+guoxingbin@users.noreply.github.com</a></li>
<li>Berkan Teber <a href="mailto:berkan@berkanteber.com"
class="email">berkan@berkanteber.com</a></li>
<li>Tobias Klauser <a href="mailto:tklauser@distanz.ch"
class="email">tklauser@distanz.ch</a></li>
<li>KARBOWSKI Piotr <a href="mailto:piotr.karbowski@gmail.com"
class="email">piotr.karbowski@gmail.com</a></li>
<li>GH <a href="mailto:geeklihui@foxmail.com"
class="email">geeklihui@foxmail.com</a></li>
<li>rafma0 <a href="mailto:int.main@gmail.com"
class="email">int.main@gmail.com</a></li>
<li>Adrien Rey-Jarthon <a href="mailto:jobs@adrienjarthon.com"
class="email">jobs@adrienjarthon.com</a></li>
<li>Nick Gooding <a
href="mailto:73336146+nickgooding@users.noreply.github.com"
class="email">73336146+nickgooding@users.noreply.github.com</a></li>
<li>Leroy van Logchem <a href="mailto:lr.vanlogchem@gmail.com"
class="email">lr.vanlogchem@gmail.com</a></li>
<li>Zsolt Ero <a href="mailto:zsolt.ero@gmail.com"
class="email">zsolt.ero@gmail.com</a></li>
<li>Lesmiscore <a href="mailto:nao20010128@gmail.com"
class="email">nao20010128@gmail.com</a></li>
<li>ehsantdy <a href="mailto:ehsan.tadayon@arvancloud.com"
class="email">ehsan.tadayon@arvancloud.com</a></li>
<li>SwazRGB <a href="mailto:65694696+swazrgb@users.noreply.github.com"
class="email">65694696+swazrgb@users.noreply.github.com</a></li>
<li>Mateusz Puczyński <a href="mailto:mati6095@gmail.com"
class="email">mati6095@gmail.com</a></li>
<li>Michael C Tiernan - MIT-Research Computing Project <a
href="mailto:mtiernan@mit.edu" class="email">mtiernan@mit.edu</a></li>
<li>Kaspian <a
href="mailto:34658474+KaspianDev@users.noreply.github.com"
class="email">34658474+KaspianDev@users.noreply.github.com</a></li>
<li>Werner <a href="mailto:EvilOlaf@users.noreply.github.com"
class="email">EvilOlaf@users.noreply.github.com</a></li>
<li>Hugal31 <a href="mailto:hugo.laloge@gmail.com"
class="email">hugo.laloge@gmail.com</a></li>
<li>Christian Galo <a
href="mailto:36752715+cgalo5758@users.noreply.github.com"
class="email">36752715+cgalo5758@users.noreply.github.com</a></li>
<li>Erik van Velzen <a href="mailto:erik@evanv.nl"
class="email">erik@evanv.nl</a></li>
<li>Derek Battams <a href="mailto:derek@battams.ca"
class="email">derek@battams.ca</a></li>
<li>SimonLiu <a href="mailto:simonliu009@users.noreply.github.com"
class="email">simonliu009@users.noreply.github.com</a></li>
<li>Hugo Laloge <a href="mailto:hla@lescompanions.com"
class="email">hla@lescompanions.com</a></li>
<li>Mr-Kanister <a
href="mailto:68117355+Mr-Kanister@users.noreply.github.com"
class="email">68117355+Mr-Kanister@users.noreply.github.com</a></li>
<li>Rob Pickerill <a href="mailto:r.pickerill@gmail.com"
class="email">r.pickerill@gmail.com</a></li>
<li>Andrey <a href="mailto:to.merge@gmail.com"
class="email">to.merge@gmail.com</a></li>
<li>Eric Wolf <a href="mailto:19wolf@gmail.com"
class="email">19wolf@gmail.com</a></li>
<li>Nick <a href="mailto:nick.naumann@mailbox.tu-dresden.de"
class="email">nick.naumann@mailbox.tu-dresden.de</a></li>
<li>Jason Zheng <a href="mailto:jszheng17@gmail.com"
class="email">jszheng17@gmail.com</a></li>
<li>Matthew Vernon <a href="mailto:mvernon@wikimedia.org"
class="email">mvernon@wikimedia.org</a></li>
<li>Noah Hsu <a href="mailto:i@nn.ci" class="email">i@nn.ci</a></li>
<li>m00594701 <a href="mailto:mengpengbo@huawei.com"
class="email">mengpengbo@huawei.com</a></li>
<li>Art M. Gallagher <a href="mailto:artmg50@gmail.com"
class="email">artmg50@gmail.com</a></li>
<li>Sven Gerber <a
href="mailto:49589423+svengerber@users.noreply.github.com"
class="email">49589423+svengerber@users.noreply.github.com</a></li>
<li>CrossR <a href="mailto:r.cross@lancaster.ac.uk"
class="email">r.cross@lancaster.ac.uk</a></li>
<li>Maciej Radzikowski <a href="mailto:maciej@radzikowski.com.pl"
class="email">maciej@radzikowski.com.pl</a></li>
<li>Scott Grimes <a href="mailto:scott.grimes@spaciq.com"
class="email">scott.grimes@spaciq.com</a></li>
<li>Phil Shackleton <a
href="mailto:71221528+philshacks@users.noreply.github.com"
class="email">71221528+philshacks@users.noreply.github.com</a></li>
<li>eNV25 <a href="mailto:env252525@gmail.com"
class="email">env252525@gmail.com</a></li>
<li>Caleb <a href="mailto:inventor96@users.noreply.github.com"
class="email">inventor96@users.noreply.github.com</a></li>
<li>J-P Treen <a href="mailto:jp@wraptious.com"
class="email">jp@wraptious.com</a></li>
<li>Martin Czygan <a href="mailto:53705+miku@users.noreply.github.com"
class="email">53705+miku@users.noreply.github.com</a></li>
<li>buda <a href="mailto:sandrojijavadze@protonmail.com"
class="email">sandrojijavadze@protonmail.com</a></li>
<li>mirekphd <a href="mailto:36706320+mirekphd@users.noreply.github.com"
class="email">36706320+mirekphd@users.noreply.github.com</a></li>
<li>vyloy <a href="mailto:vyloy@qq.com"
class="email">vyloy@qq.com</a></li>
<li>Anthrazz <a href="mailto:25553648+Anthrazz@users.noreply.github.com"
class="email">25553648+Anthrazz@users.noreply.github.com</a></li>
<li>zzr93 <a href="mailto:34027824+zzr93@users.noreply.github.com"
class="email">34027824+zzr93@users.noreply.github.com</a></li>
<li>Paul Norman <a href="mailto:penorman@mac.com"
class="email">penorman@mac.com</a></li>
<li>Lorenzo Maiorfi <a href="mailto:maiorfi@gmail.com"
class="email">maiorfi@gmail.com</a></li>
<li>Claudio Maradonna <a href="mailto:penguyman@stronzi.org"
class="email">penguyman@stronzi.org</a></li>
<li>Ovidiu Victor Tatar <a href="mailto:ovi.tatar@googlemail.com"
class="email">ovi.tatar@googlemail.com</a></li>
<li>Evan Spensley <a href="mailto:epspensley@gmail.com"
class="email">epspensley@gmail.com</a></li>
<li>Yen Hu <a href="mailto:61753151+0x59656e@users.noreply.github.com"
class="email">61753151+0x59656e@users.noreply.github.com</a></li>
<li>Steve Kowalik <a href="mailto:steven@wedontsleep.org"
class="email">steven@wedontsleep.org</a></li>
<li>Jordi Gonzalez Muñoz <a href="mailto:jordigonzm@gmail.com"
class="email">jordigonzm@gmail.com</a></li>
<li>Joram Schrijver <a href="mailto:i@joram.io"
class="email">i@joram.io</a></li>
<li>Mark Trolley <a href="mailto:marktrolley@gmail.com"
class="email">marktrolley@gmail.com</a></li>
<li>João Henrique Franco <a href="mailto:joaohenrique.franco@gmail.com"
class="email">joaohenrique.franco@gmail.com</a></li>
<li>anonion <a href="mailto:aman207@users.noreply.github.com"
class="email">aman207@users.noreply.github.com</a></li>
<li>Ryan Morey <a href="mailto:4590343+rmorey@users.noreply.github.com"
class="email">4590343+rmorey@users.noreply.github.com</a></li>
<li>Simon Bos <a href="mailto:simonbos9@gmail.com"
class="email">simonbos9@gmail.com</a></li>
<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>
<li>Øyvind Heddeland Instefjord <a href="mailto:instefjord@outlook.com"
class="email">instefjord@outlook.com</a></li>
<li>Dmitry Deniskin <a
href="mailto:110819396+ddeniskin@users.noreply.github.com"
class="email">110819396+ddeniskin@users.noreply.github.com</a></li>
<li>Alexander Knorr <a
href="mailto:106825+opexxx@users.noreply.github.com"
class="email">106825+opexxx@users.noreply.github.com</a></li>
<li>Richard Bateman <a href="mailto:richard@batemansr.us"
class="email">richard@batemansr.us</a></li>
<li>Dimitri Papadopoulos Orfanos <a
href="mailto:3234522+DimitriPapadopoulos@users.noreply.github.com"
class="email">3234522+DimitriPapadopoulos@users.noreply.github.com</a></li>
<li>Lorenzo Milesi <a href="mailto:lorenzo.milesi@yetopen.com"
class="email">lorenzo.milesi@yetopen.com</a></li>
<li>Isaac Aymerich <a href="mailto:isaac.aymerich@gmail.com"
class="email">isaac.aymerich@gmail.com</a></li>
<li>YanceyChiew <a
href="mailto:35898533+YanceyChiew@users.noreply.github.com"
class="email">35898533+YanceyChiew@users.noreply.github.com</a></li>
<li>Manoj Ghosh <a href="mailto:msays2000@gmail.com"
class="email">msays2000@gmail.com</a></li>
<li>Bachue Zhou <a href="mailto:bachue.shu@gmail.com"
class="email">bachue.shu@gmail.com</a></li>
<li>Manoj Ghosh <a href="mailto:manoj.ghosh@oracle.com"
class="email">manoj.ghosh@oracle.com</a></li>
<li>Tom Mombourquette <a href="mailto:tom@devnode.com"
class="email">tom@devnode.com</a></li>
<li>Robert Newson <a href="mailto:rnewson@apache.org"
class="email">rnewson@apache.org</a></li>
</ul>
<h1 id="contact-the-rclone-project">Contact the rclone project</h1>
<h2 id="forum">Forum</h2>
<p>Forum for questions and general discussion:</p>
<ul>
<li>https://forum.rclone.org</li>
</ul>
<h2 id="github-repository">GitHub repository</h2>
<p>The project’s repository is located at:</p>
<ul>
<li>https://github.com/rclone/rclone</li>
</ul>
<p>There you can file bug reports or contribute with pull requests.</p>
<h2 id="twitter">Twitter</h2>
<p>You can also follow me on twitter for rclone announcements:</p>
<ul>
<li><a href="https://twitter.com/njcw"><span class="citation"
data-cites="njcw">@njcw</span></a></li>
</ul>
<h2 id="email">Email</h2>
<p>Or if all else fails or you want to ask something private or
confidential email <a href="mailto:nick@craig-wood.com">Nick
Craig-Wood</a>. Please don’t email me requests for help - those are
better directed to the forum. Thanks!</p>
</body>
</html>

❌ Cancel

🗂️ Enhanced PHP File Manager

📊 Server Information

🔧 Quick Actions

✏️ Editing: MANUAL.html

📤 Upload File

📁 Create Folder

📄 Create File

✏️ Rename Item

🗑️ Delete Confirmation