Skip to content

"rsync for cloud storage" - Google Drive, S3, Dropbox, Backblaze B2, One Drive, Swift, Hubic, Wasabi, Google Cloud Storage, Azure Blob, Azure Files, Yandex Files

Version v1.74.0

Nick Craig-Woodaa031c51cccd
diff --git a/MANUAL.html b/MANUAL.html
index 1caf83cca..5160b75ec 100644
--- a/MANUAL.html
+++ b/MANUAL.html
@@ -5,6 +5,7 @@
<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" />
+ <meta name="dcterms.date" content="2026-05-01" />
<title>rclone(1) User Manual</title>
<style>
html {
@@ -233,7 +234,7 @@
<header id="title-block-header">
<h1 class="title">rclone(1) User Manual</h1>
<p class="author">Nick Craig-Wood</p>
-<p class="date">Jan 30, 2026</p>
+<p class="date">May 01, 2026</p>
</header>
<h1 id="name">NAME</h1>
<p>rclone - manage files on cloud storage</p>
@@ -265,6 +266,7 @@ Available commands:
deletefile Remove a single file from remote.
gendocs Output markdown docs for rclone to the directory supplied.
gitannex Speaks with git-annex over stdin/stdout.
+ gui Open the web based GUI.
hashsum Produces a hashsum file for all the objects in the path.
help Show help for rclone commands, flags and backends.
link Generate public link to file/folder.
@@ -306,7 +308,7 @@ Use &quot;rclone help backends&quot; for a list of supported services.
<h1 id="rclone-syncs-your-files-to-cloud-storage">Rclone syncs your
files to cloud storage</h1>
<!-- markdownlint-disable-next-line line-length -->
-<p><img width="50%" src="https://rclone.org/img/logo_on_light__horizontal_color.svg" alt="rclone logo" style="float:right; padding: 5px;" ></p>
+<p><img width="50%" src="https://rclone.org/img/logo_on_light__horizontal_color.svg" dark-src="/img/logo_on_dark__horizontal_color.svg" alt="rclone logo" style="float:right; padding: 5px;" class="hide-mobile" ></p>
<ul>
<li><a href="#about">About rclone</a></li>
<li><a href="#what">What can rclone do for you?</a></li>
@@ -438,6 +440,7 @@ S3, that work out of the box.)</p>
<li>Dropbox</li>
<li>Enterprise File Fabric</li>
<li>Exaba</li>
+<li>Fastly Object Storage</li>
<li>Fastmail Files</li>
<li>FileLu Cloud Storage</li>
<li>FileLu S5 (S3-Compatible Object Storage)</li>
@@ -453,7 +456,9 @@ S3, that work out of the box.)</p>
<li>Hetzner Object Storage</li>
<li>Hetzner Storage Box</li>
<li>HiDrive</li>
+<li>Hitachi Content Platform (HCP)</li>
<li>HTTP</li>
+<li>Huawei Drive</li>
<li>Huawei OBS</li>
<li>iCloud Drive</li>
<li>ImageKit</li>
@@ -462,6 +467,7 @@ S3, that work out of the box.)</p>
<li>Jottacloud</li>
<li>IBM COS S3</li>
<li>IDrive e2</li>
+<li>Impossible Cloud</li>
<li>Intercolo Object Storage</li>
<li>IONOS Cloud</li>
<li>Koofr</li>
@@ -515,15 +521,16 @@ S3, that work out of the box.)</p>
<li>Sia</li>
<li>SMB / CIFS</li>
<li>Spectra Logic</li>
-<li>StackPath</li>
<li>Storj</li>
<li>Synology</li>
<li>SugarSync</li>
<li>Tencent Cloud Object Storage (COS)</li>
<li>Uloz.to</li>
+<li>US3</li>
<li>Wasabi</li>
<li>WebDAV</li>
<li>Yandex Disk</li>
+<li>Zadara Object Storage</li>
<li>Zoho WorkDrive</li>
<li>Zata</li>
<li>The local filesystem</li>
@@ -860,7 +867,7 @@ current version is as below.</p>
src="https://snapcraft.io/rclone/badge.svg" alt="rclone" /></a></p>
<h2 id="source">Source installation</h2>
<p>Make sure you have git and <a href="https://golang.org/">Go</a>
-installed. Go version 1.24 or newer is required, the latest release is
+installed. Go version 1.25 or newer is required, the latest release is
recommended. You can get it from your package manager, or download it
from <a href="https://golang.org/dl/">golang.org/dl</a>. Then you can
run the following:</p>
@@ -1194,6 +1201,7 @@ checksums for other remotes</li>
Storage Box</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/huaweidrive/">Huawei Drive</a></li>
<li><a href="https://rclone.org/iclouddrive/">iCloud Drive</a></li>
<li><a href="https://rclone.org/internetarchive/">Internet
Archive</a></li>
@@ -3279,7 +3287,7 @@ for details.</p>
-1, --resync Performs the resync run. Equivalent to --resync-mode path1. Consider using --verbose or --dry-run first.
--resync-mode string During resync, prefer the version that is: path1, path2, newer, older, larger, smaller (default: path1 if --resync, otherwise none for no resync.) (default &quot;none&quot;)
--slow-hash-sync-only Ignore slow checksums for listings and deltas, but still consider them during sync calls.
- --workdir string Use custom working dir - useful for testing. (default: {WORKDIR})</code></pre>
+ --workdir string Use custom working dir - useful for testing. (default: $HOME/.cache/rclone/bisync)</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
@@ -3319,6 +3327,21 @@ options not listed here.</p>
--size-only Skip based on size only, not modtime or checksum
--streaming-upload-cutoff SizeSuffix Cutoff for switching to chunked upload if file size is unknown, upload starts after reaching cutoff or when file ends (default 100Ki)
-u, --update Skip files that are newer on the destination</code></pre>
+<h3 id="sync-options-1">Sync Options</h3>
+<p>Flags used for sync commands</p>
+<pre class="text"><code> --backup-dir string Make backups into hierarchy based in DIR
+ --delete-after When synchronizing, delete files on destination after transferring (default)
+ --delete-before When synchronizing, delete files on destination before transferring
+ --delete-during When synchronizing, delete files during transfer
+ --fix-case Force rename of case insensitive dest to match source
+ --ignore-errors Delete even if there are I/O errors
+ --list-cutoff int To save memory, sort directory listings on disk above this threshold (default 1000000)
+ --max-delete int When synchronizing, limit the number of deletes (default -1)
+ --max-delete-size SizeSuffix When synchronizing, limit the total size of deletes (default off)
+ --suffix string Suffix to add to changed files
+ --suffix-keep-extension Preserve the extension when using --suffix
+ --track-renames When synchronizing, track file renames and do a server-side move if possible
+ --track-renames-strategy string Strategies to use when synchronizing using track-renames hash|modtime|leaf (default &quot;hash&quot;)</code></pre>
<h3 id="important-options-10">Important Options</h3>
<p>Important flags useful for most commands</p>
<pre class="text"><code> -n, --dry-run Do a trial run with no permanent changes
@@ -3362,15 +3385,15 @@ for rclone commands, flags and backends.</li>
<h2 id="synopsis-26">Synopsis</h2>
<p>Sends any files to standard output.</p>
<p>You can use it like this to output a single file</p>
-<div class="sourceCode" id="cb175"><pre
-class="sourceCode sh"><code class="sourceCode bash"><span id="cb175-1"><a href="#cb175-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> cat remote:path/to/file</span></code></pre></div>
-<p>Or like this to output any file in dir or its subdirectories.</p>
<div class="sourceCode" id="cb176"><pre
-class="sourceCode sh"><code class="sourceCode bash"><span id="cb176-1"><a href="#cb176-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> cat remote:path/to/dir</span></code></pre></div>
+class="sourceCode sh"><code class="sourceCode bash"><span id="cb176-1"><a href="#cb176-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> cat remote:path/to/file</span></code></pre></div>
+<p>Or like this to output any file in dir or its subdirectories.</p>
+<div class="sourceCode" id="cb177"><pre
+class="sourceCode sh"><code class="sourceCode bash"><span id="cb177-1"><a href="#cb177-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> cat remote:path/to/dir</span></code></pre></div>
<p>Or like this to output any .txt files in dir or its
subdirectories.</p>
-<div class="sourceCode" id="cb177"><pre
-class="sourceCode sh"><code class="sourceCode bash"><span id="cb177-1"><a href="#cb177-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> <span class="at">--include</span> <span class="st">&quot;*.txt&quot;</span> cat remote:path/to/dir</span></code></pre></div>
+<div class="sourceCode" id="cb178"><pre
+class="sourceCode sh"><code class="sourceCode bash"><span id="cb178-1"><a href="#cb178-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> <span class="at">--include</span> <span class="st">&quot;*.txt&quot;</span> cat remote:path/to/dir</span></code></pre></div>
<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
@@ -3382,11 +3405,11 @@ between files. Be sure to shell-escape special characters. For example,
to print a newline between files, use:</p>
<ul>
<li><p>bash:</p>
-<div class="sourceCode" id="cb178"><pre
-class="sourceCode sh"><code class="sourceCode bash"><span id="cb178-1"><a href="#cb178-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> <span class="at">--include</span> <span class="st">&quot;*.txt&quot;</span> <span class="at">--separator</span> <span class="st">$&#39;</span><span class="dt">\n</span><span class="st">&#39;</span> cat remote:path/to/dir</span></code></pre></div></li>
-<li><p>powershell:</p>
<div class="sourceCode" id="cb179"><pre
-class="sourceCode powershell"><code class="sourceCode powershell"><span id="cb179-1"><a href="#cb179-1" aria-hidden="true" tabindex="-1"></a>rclone <span class="op">--</span>include <span class="st">&quot;*.txt&quot;</span> <span class="op">--</span>separator <span class="st">&quot;</span><span class="ch">`n</span><span class="st">&quot;</span> <span class="fu">cat</span> remote<span class="op">:</span>path<span class="op">/</span>to<span class="op">/</span><span class="fu">dir</span></span></code></pre></div></li>
+class="sourceCode sh"><code class="sourceCode bash"><span id="cb179-1"><a href="#cb179-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> <span class="at">--include</span> <span class="st">&quot;*.txt&quot;</span> <span class="at">--separator</span> <span class="st">$&#39;</span><span class="dt">\n</span><span class="st">&#39;</span> cat remote:path/to/dir</span></code></pre></div></li>
+<li><p>powershell:</p>
+<div class="sourceCode" id="cb180"><pre
+class="sourceCode powershell"><code class="sourceCode powershell"><span id="cb180-1"><a href="#cb180-1" aria-hidden="true" tabindex="-1"></a>rclone <span class="op">--</span>include <span class="st">&quot;*.txt&quot;</span> <span class="op">--</span>separator <span class="st">&quot;</span><span class="ch">`n</span><span class="st">&quot;</span> <span class="fu">cat</span> remote<span class="op">:</span>path<span class="op">/</span>to<span class="op">/</span><span class="fu">dir</span></span></code></pre></div></li>
</ul>
<pre><code>rclone cat remote:path [flags]</code></pre>
<h2 id="options-26">Options</h2>
@@ -3674,13 +3697,13 @@ 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>
-<div class="sourceCode" id="cb205"><pre
-class="sourceCode sh"><code class="sourceCode bash"><span id="cb205-1"><a href="#cb205-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config create myremote swift env_auth true</span>
-<span id="cb205-2"><a href="#cb205-2" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config create myremote swift env_auth=true</span></code></pre></div>
+<div class="sourceCode" id="cb206"><pre
+class="sourceCode sh"><code class="sourceCode bash"><span id="cb206-1"><a href="#cb206-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config create myremote swift env_auth true</span>
+<span id="cb206-2"><a href="#cb206-2" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config create myremote swift env_auth=true</span></code></pre></div>
<p>So for example if you wanted to configure a Google Drive remote but
using remote authorization you would do this:</p>
-<div class="sourceCode" id="cb206"><pre
-class="sourceCode sh"><code class="sourceCode bash"><span id="cb206-1"><a href="#cb206-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config create mydrive drive config_is_local=false</span></code></pre></div>
+<div class="sourceCode" id="cb207"><pre
+class="sourceCode sh"><code class="sourceCode bash"><span id="cb207-1"><a href="#cb207-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config create mydrive drive config_is_local=false</span></code></pre></div>
<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
@@ -3703,30 +3726,30 @@ 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>
-<div class="sourceCode" id="cb207"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb207-1"><a href="#cb207-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
-<span id="cb207-2"><a href="#cb207-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;State&quot;</span><span class="fu">:</span> <span class="st">&quot;*oauth-islocal,teamdrive,,&quot;</span><span class="fu">,</span></span>
-<span id="cb207-3"><a href="#cb207-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Option&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
-<span id="cb207-4"><a href="#cb207-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Name&quot;</span><span class="fu">:</span> <span class="st">&quot;config_is_local&quot;</span><span class="fu">,</span></span>
-<span id="cb207-5"><a href="#cb207-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Help&quot;</span><span class="fu">:</span> <span class="st">&quot;Use web browser to automatically authenticate rclone with remote?</span><span class="ch">\n</span><span class="st"> * Say Y if the machine running rclone has a web browser you can use</span><span class="ch">\n</span><span class="st"> * Say N if running rclone on a (remote) machine without web browser access</span><span class="ch">\n</span><span class="st">If not sure try Y. If Y failed, try N.</span><span class="ch">\n</span><span class="st">&quot;</span><span class="fu">,</span></span>
-<span id="cb207-6"><a href="#cb207-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Default&quot;</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span></span>
-<span id="cb207-7"><a href="#cb207-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Examples&quot;</span><span class="fu">:</span> <span class="ot">[</span></span>
-<span id="cb207-8"><a href="#cb207-8" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
-<span id="cb207-9"><a href="#cb207-9" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Value&quot;</span><span class="fu">:</span> <span class="st">&quot;true&quot;</span><span class="fu">,</span></span>
-<span id="cb207-10"><a href="#cb207-10" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Help&quot;</span><span class="fu">:</span> <span class="st">&quot;Yes&quot;</span></span>
-<span id="cb207-11"><a href="#cb207-11" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span><span class="ot">,</span></span>
-<span id="cb207-12"><a href="#cb207-12" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
-<span id="cb207-13"><a href="#cb207-13" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Value&quot;</span><span class="fu">:</span> <span class="st">&quot;false&quot;</span><span class="fu">,</span></span>
-<span id="cb207-14"><a href="#cb207-14" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Help&quot;</span><span class="fu">:</span> <span class="st">&quot;No&quot;</span></span>
-<span id="cb207-15"><a href="#cb207-15" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
-<span id="cb207-16"><a href="#cb207-16" aria-hidden="true" tabindex="-1"></a> <span class="ot">]</span><span class="fu">,</span></span>
-<span id="cb207-17"><a href="#cb207-17" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Required&quot;</span><span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span></span>
-<span id="cb207-18"><a href="#cb207-18" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;IsPassword&quot;</span><span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span></span>
-<span id="cb207-19"><a href="#cb207-19" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Type&quot;</span><span class="fu">:</span> <span class="st">&quot;bool&quot;</span><span class="fu">,</span></span>
-<span id="cb207-20"><a href="#cb207-20" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Exclusive&quot;</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span></span>
-<span id="cb207-21"><a href="#cb207-21" aria-hidden="true" tabindex="-1"></a> <span class="fu">},</span></span>
-<span id="cb207-22"><a href="#cb207-22" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Error&quot;</span><span class="fu">:</span> <span class="st">&quot;&quot;</span><span class="fu">,</span></span>
-<span id="cb207-23"><a href="#cb207-23" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
+<div class="sourceCode" id="cb208"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb208-1"><a href="#cb208-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
+<span id="cb208-2"><a href="#cb208-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;State&quot;</span><span class="fu">:</span> <span class="st">&quot;*oauth-islocal,teamdrive,,&quot;</span><span class="fu">,</span></span>
+<span id="cb208-3"><a href="#cb208-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Option&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
+<span id="cb208-4"><a href="#cb208-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Name&quot;</span><span class="fu">:</span> <span class="st">&quot;config_is_local&quot;</span><span class="fu">,</span></span>
+<span id="cb208-5"><a href="#cb208-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Help&quot;</span><span class="fu">:</span> <span class="st">&quot;Use web browser to automatically authenticate rclone with remote?</span><span class="ch">\n</span><span class="st"> * Say Y if the machine running rclone has a web browser you can use</span><span class="ch">\n</span><span class="st"> * Say N if running rclone on a (remote) machine without web browser access</span><span class="ch">\n</span><span class="st">If not sure try Y. If Y failed, try N.</span><span class="ch">\n</span><span class="st">&quot;</span><span class="fu">,</span></span>
+<span id="cb208-6"><a href="#cb208-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Default&quot;</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span></span>
+<span id="cb208-7"><a href="#cb208-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Examples&quot;</span><span class="fu">:</span> <span class="ot">[</span></span>
+<span id="cb208-8"><a href="#cb208-8" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
+<span id="cb208-9"><a href="#cb208-9" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Value&quot;</span><span class="fu">:</span> <span class="st">&quot;true&quot;</span><span class="fu">,</span></span>
+<span id="cb208-10"><a href="#cb208-10" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Help&quot;</span><span class="fu">:</span> <span class="st">&quot;Yes&quot;</span></span>
+<span id="cb208-11"><a href="#cb208-11" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span><span class="ot">,</span></span>
+<span id="cb208-12"><a href="#cb208-12" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
+<span id="cb208-13"><a href="#cb208-13" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Value&quot;</span><span class="fu">:</span> <span class="st">&quot;false&quot;</span><span class="fu">,</span></span>
+<span id="cb208-14"><a href="#cb208-14" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Help&quot;</span><span class="fu">:</span> <span class="st">&quot;No&quot;</span></span>
+<span id="cb208-15"><a href="#cb208-15" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
+<span id="cb208-16"><a href="#cb208-16" aria-hidden="true" tabindex="-1"></a> <span class="ot">]</span><span class="fu">,</span></span>
+<span id="cb208-17"><a href="#cb208-17" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Required&quot;</span><span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span></span>
+<span id="cb208-18"><a href="#cb208-18" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;IsPassword&quot;</span><span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span></span>
+<span id="cb208-19"><a href="#cb208-19" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Type&quot;</span><span class="fu">:</span> <span class="st">&quot;bool&quot;</span><span class="fu">,</span></span>
+<span id="cb208-20"><a href="#cb208-20" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Exclusive&quot;</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span></span>
+<span id="cb208-21"><a href="#cb208-21" aria-hidden="true" tabindex="-1"></a> <span class="fu">},</span></span>
+<span id="cb208-22"><a href="#cb208-22" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Error&quot;</span><span class="fu">:</span> <span class="st">&quot;&quot;</span><span class="fu">,</span></span>
+<span id="cb208-23"><a href="#cb208-23" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<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
@@ -3752,8 +3775,8 @@ edited as such</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>
-<div class="sourceCode" id="cb208"><pre
-class="sourceCode sh"><code class="sourceCode bash"><span id="cb208-1"><a href="#cb208-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config update name <span class="at">--continue</span> <span class="at">--state</span> <span class="st">&quot;*oauth-islocal,teamdrive,,&quot;</span> <span class="at">--result</span> <span class="st">&quot;true&quot;</span></span></code></pre></div>
+<div class="sourceCode" id="cb209"><pre
+class="sourceCode sh"><code class="sourceCode bash"><span id="cb209-1"><a href="#cb209-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config update name <span class="at">--continue</span> <span class="at">--state</span> <span class="st">&quot;*oauth-islocal,teamdrive,,&quot;</span> <span class="at">--result</span> <span class="st">&quot;true&quot;</span></span></code></pre></div>
<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>
@@ -3994,9 +4017,9 @@ in pairs of <code>key</code> <code>password</code> or as
in clear (unobscured).</p>
<p>For example, to set password of a remote of name myremote you would
do:</p>
-<div class="sourceCode" id="cb228"><pre
-class="sourceCode sh"><code class="sourceCode bash"><span id="cb228-1"><a href="#cb228-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config password myremote fieldname mypassword</span>
-<span id="cb228-2"><a href="#cb228-2" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config password myremote fieldname=mypassword</span></code></pre></div>
+<div class="sourceCode" id="cb229"><pre
+class="sourceCode sh"><code class="sourceCode bash"><span id="cb229-1"><a href="#cb229-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config password myremote fieldname mypassword</span>
+<span id="cb229-2"><a href="#cb229-2" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config password myremote fieldname=mypassword</span></code></pre></div>
<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>
@@ -4112,9 +4135,9 @@ convenient than using the config file, especially if using the RC
API.</p>
<p>Backend parameters may be provided to the command also.</p>
<p>Example:</p>
-<div class="sourceCode" id="cb241"><pre
-class="sourceCode sh"><code class="sourceCode bash"><span id="cb241-1"><a href="#cb241-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone config string s3:rclone <span class="at">--s3-no-check-bucket</span></span>
-<span id="cb241-2"><a href="#cb241-2" aria-hidden="true" tabindex="-1"></a><span class="ex">:s3,access_key_id=XXX,no_check_bucket,provider=AWS,region=eu-west-2,secret_access_key=YYY:rclone</span></span></code></pre></div>
+<div class="sourceCode" id="cb242"><pre
+class="sourceCode sh"><code class="sourceCode bash"><span id="cb242-1"><a href="#cb242-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone config string s3:rclone <span class="at">--s3-no-check-bucket</span></span>
+<span id="cb242-2"><a href="#cb242-2" aria-hidden="true" tabindex="-1"></a><span class="ex">:s3,access_key_id=XXX,no_check_bucket,provider=AWS,region=eu-west-2,secret_access_key=YYY:rclone</span></span></code></pre></div>
<p><strong>NB</strong> the strings are not quoted for use in shells (eg
bash, powershell, windows cmd). Most will work if enclosed in "double
quotes", however connection strings that contain double quotes will
@@ -4155,13 +4178,13 @@ 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>
-<div class="sourceCode" id="cb246"><pre
-class="sourceCode sh"><code class="sourceCode bash"><span id="cb246-1"><a href="#cb246-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config update myremote env_auth true</span>
-<span id="cb246-2"><a href="#cb246-2" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config update myremote env_auth=true</span></code></pre></div>
+<div class="sourceCode" id="cb247"><pre
+class="sourceCode sh"><code class="sourceCode bash"><span id="cb247-1"><a href="#cb247-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config update myremote env_auth true</span>
+<span id="cb247-2"><a href="#cb247-2" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config update myremote env_auth=true</span></code></pre></div>
<p>If the remote uses OAuth the token will be updated, if you don't
require this add an extra parameter thus:</p>
-<div class="sourceCode" id="cb247"><pre
-class="sourceCode sh"><code class="sourceCode bash"><span id="cb247-1"><a href="#cb247-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config update myremote env_auth=true config_refresh_token=false</span></code></pre></div>
+<div class="sourceCode" id="cb248"><pre
+class="sourceCode sh"><code class="sourceCode bash"><span id="cb248-1"><a href="#cb248-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config update myremote env_auth=true config_refresh_token=false</span></code></pre></div>
<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
@@ -4184,30 +4207,30 @@ 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>
-<div class="sourceCode" id="cb248"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb248-1"><a href="#cb248-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
-<span id="cb248-2"><a href="#cb248-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;State&quot;</span><span class="fu">:</span> <span class="st">&quot;*oauth-islocal,teamdrive,,&quot;</span><span class="fu">,</span></span>
-<span id="cb248-3"><a href="#cb248-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Option&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
-<span id="cb248-4"><a href="#cb248-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Name&quot;</span><span class="fu">:</span> <span class="st">&quot;config_is_local&quot;</span><span class="fu">,</span></span>
-<span id="cb248-5"><a href="#cb248-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Help&quot;</span><span class="fu">:</span> <span class="st">&quot;Use web browser to automatically authenticate rclone with remote?</span><span class="ch">\n</span><span class="st"> * Say Y if the machine running rclone has a web browser you can use</span><span class="ch">\n</span><span class="st"> * Say N if running rclone on a (remote) machine without web browser access</span><span class="ch">\n</span><span class="st">If not sure try Y. If Y failed, try N.</span><span class="ch">\n</span><span class="st">&quot;</span><span class="fu">,</span></span>
-<span id="cb248-6"><a href="#cb248-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Default&quot;</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span></span>
-<span id="cb248-7"><a href="#cb248-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Examples&quot;</span><span class="fu">:</span> <span class="ot">[</span></span>
-<span id="cb248-8"><a href="#cb248-8" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
-<span id="cb248-9"><a href="#cb248-9" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Value&quot;</span><span class="fu">:</span> <span class="st">&quot;true&quot;</span><span class="fu">,</span></span>
-<span id="cb248-10"><a href="#cb248-10" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Help&quot;</span><span class="fu">:</span> <span class="st">&quot;Yes&quot;</span></span>
-<span id="cb248-11"><a href="#cb248-11" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span><span class="ot">,</span></span>
-<span id="cb248-12"><a href="#cb248-12" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
-<span id="cb248-13"><a href="#cb248-13" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Value&quot;</span><span class="fu">:</span> <span class="st">&quot;false&quot;</span><span class="fu">,</span></span>
-<span id="cb248-14"><a href="#cb248-14" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Help&quot;</span><span class="fu">:</span> <span class="st">&quot;No&quot;</span></span>
-<span id="cb248-15"><a href="#cb248-15" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
-<span id="cb248-16"><a href="#cb248-16" aria-hidden="true" tabindex="-1"></a> <span class="ot">]</span><span class="fu">,</span></span>
-<span id="cb248-17"><a href="#cb248-17" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Required&quot;</span><span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span></span>
-<span id="cb248-18"><a href="#cb248-18" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;IsPassword&quot;</span><span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span></span>
-<span id="cb248-19"><a href="#cb248-19" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Type&quot;</span><span class="fu">:</span> <span class="st">&quot;bool&quot;</span><span class="fu">,</span></span>
-<span id="cb248-20"><a href="#cb248-20" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Exclusive&quot;</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span></span>
-<span id="cb248-21"><a href="#cb248-21" aria-hidden="true" tabindex="-1"></a> <span class="fu">},</span></span>
-<span id="cb248-22"><a href="#cb248-22" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Error&quot;</span><span class="fu">:</span> <span class="st">&quot;&quot;</span><span class="fu">,</span></span>
-<span id="cb248-23"><a href="#cb248-23" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
+<div class="sourceCode" id="cb249"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb249-1"><a href="#cb249-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
+<span id="cb249-2"><a href="#cb249-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;State&quot;</span><span class="fu">:</span> <span class="st">&quot;*oauth-islocal,teamdrive,,&quot;</span><span class="fu">,</span></span>
+<span id="cb249-3"><a href="#cb249-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Option&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
+<span id="cb249-4"><a href="#cb249-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Name&quot;</span><span class="fu">:</span> <span class="st">&quot;config_is_local&quot;</span><span class="fu">,</span></span>
+<span id="cb249-5"><a href="#cb249-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Help&quot;</span><span class="fu">:</span> <span class="st">&quot;Use web browser to automatically authenticate rclone with remote?</span><span class="ch">\n</span><span class="st"> * Say Y if the machine running rclone has a web browser you can use</span><span class="ch">\n</span><span class="st"> * Say N if running rclone on a (remote) machine without web browser access</span><span class="ch">\n</span><span class="st">If not sure try Y. If Y failed, try N.</span><span class="ch">\n</span><span class="st">&quot;</span><span class="fu">,</span></span>
+<span id="cb249-6"><a href="#cb249-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Default&quot;</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span></span>
+<span id="cb249-7"><a href="#cb249-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Examples&quot;</span><span class="fu">:</span> <span class="ot">[</span></span>
+<span id="cb249-8"><a href="#cb249-8" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
+<span id="cb249-9"><a href="#cb249-9" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Value&quot;</span><span class="fu">:</span> <span class="st">&quot;true&quot;</span><span class="fu">,</span></span>
+<span id="cb249-10"><a href="#cb249-10" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Help&quot;</span><span class="fu">:</span> <span class="st">&quot;Yes&quot;</span></span>
+<span id="cb249-11"><a href="#cb249-11" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span><span class="ot">,</span></span>
+<span id="cb249-12"><a href="#cb249-12" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
+<span id="cb249-13"><a href="#cb249-13" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Value&quot;</span><span class="fu">:</span> <span class="st">&quot;false&quot;</span><span class="fu">,</span></span>
+<span id="cb249-14"><a href="#cb249-14" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Help&quot;</span><span class="fu">:</span> <span class="st">&quot;No&quot;</span></span>
+<span id="cb249-15"><a href="#cb249-15" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
+<span id="cb249-16"><a href="#cb249-16" aria-hidden="true" tabindex="-1"></a> <span class="ot">]</span><span class="fu">,</span></span>
+<span id="cb249-17"><a href="#cb249-17" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Required&quot;</span><span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span></span>
+<span id="cb249-18"><a href="#cb249-18" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;IsPassword&quot;</span><span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span></span>
+<span id="cb249-19"><a href="#cb249-19" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Type&quot;</span><span class="fu">:</span> <span class="st">&quot;bool&quot;</span><span class="fu">,</span></span>
+<span id="cb249-20"><a href="#cb249-20" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Exclusive&quot;</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span></span>
+<span id="cb249-21"><a href="#cb249-21" aria-hidden="true" tabindex="-1"></a> <span class="fu">},</span></span>
+<span id="cb249-22"><a href="#cb249-22" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Error&quot;</span><span class="fu">:</span> <span class="st">&quot;&quot;</span><span class="fu">,</span></span>
+<span id="cb249-23"><a href="#cb249-23" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<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
@@ -4233,8 +4256,8 @@ edited as such</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>
-<div class="sourceCode" id="cb249"><pre
-class="sourceCode sh"><code class="sourceCode bash"><span id="cb249-1"><a href="#cb249-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config update name <span class="at">--continue</span> <span class="at">--state</span> <span class="st">&quot;*oauth-islocal,teamdrive,,&quot;</span> <span class="at">--result</span> <span class="st">&quot;true&quot;</span></span></code></pre></div>
+<div class="sourceCode" id="cb250"><pre
+class="sourceCode sh"><code class="sourceCode bash"><span id="cb250-1"><a href="#cb250-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config update name <span class="at">--continue</span> <span class="at">--state</span> <span class="st">&quot;*oauth-islocal,teamdrive,,&quot;</span> <span class="at">--result</span> <span class="st">&quot;true&quot;</span></span></code></pre></div>
<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>
@@ -4553,9 +4576,9 @@ SquareBracket</code></pre>
<pre class="console"><code>rclone convmv &quot;stories/The Quick Brown Fox!.txt&quot; --name-transform &quot;all,command=echo&quot;
// Output: stories/The Quick Brown Fox!.txt</code></pre>
<pre class="console"><code>rclone convmv &quot;stories/The Quick Brown Fox!&quot; --name-transform &quot;date=-{YYYYMMDD}&quot;
-// Output: stories/The Quick Brown Fox!-20260130</code></pre>
+// Output: stories/The Quick Brown Fox!-20260501</code></pre>
<pre class="console"><code>rclone convmv &quot;stories/The Quick Brown Fox!&quot; --name-transform &quot;date=-{macfriendlytime}&quot;
-// Output: stories/The Quick Brown Fox!-2026-01-30 0825PM</code></pre>
+// Output: stories/The Quick Brown Fox!-2026-05-01 0208PM</code></pre>
<pre class="console"><code>rclone convmv &quot;stories/The Quick Brown Fox!.txt&quot; --name-transform &quot;all,regex=[\\.\\w]/ab&quot;
// Output: ababababababab/ababab ababababab ababababab ababab!abababab</code></pre>
<p>The regex command generally accepts Perl-style regular expressions,
@@ -4946,14 +4969,22 @@ output.</p>
<p>Setting <code>--urls</code> allows you to input a CSV file of URLs in
format: URL, FILENAME. If <code>--urls</code> is in use then replace the
URL in the arguments with the file containing the URLs, e.g.:</p>
-<div class="sourceCode" id="cb287"><pre
-class="sourceCode sh"><code class="sourceCode bash"><span id="cb287-1"><a href="#cb287-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> copyurl <span class="at">--urls</span> myurls.csv remote:dir</span></code></pre></div>
+<div class="sourceCode" id="cb288"><pre
+class="sourceCode sh"><code class="sourceCode bash"><span id="cb288-1"><a href="#cb288-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> copyurl <span class="at">--urls</span> myurls.csv remote:dir</span></code></pre></div>
<p>Missing filenames will be autogenerated equivalent to using
<code>--auto-filename</code>. Note that <code>--stdout</code> and
<code>--print-filename</code> are incompatible with <code>--urls</code>.
This will do <code>--transfers</code> copies in parallel. Note that if
<code>--auto-filename</code> is desired for all URLs then a file with
only URLs and no filename can be used.</p>
+<p>Each FILENAME in the CSV file can start with a relative path which
+will be appended to the destination path provided at the command line.
+For example, running the command shown above with the following CSV file
+will write two files to the destination:
+<code>remote:dir/local/path/bar.json</code> and
+<code>remote:dir/another/local/directory/qux.json</code></p>
+<pre class="csv"><code>https://example.org/foo/bar.json,local/path/bar.json
+https://example.org/qux/baz.json,another/local/directory/qux.json</code></pre>
<h2 id="troubleshooting">Troubleshooting</h2>
<p>If you can't get <code>rclone copyurl</code> to work then here are
some things you can try:</p>
@@ -5234,9 +5265,91 @@ global options not listed here.</p>
for rclone commands, flags and backends.</li>
</ul>
<!-- markdownlint-restore -->
+<h1 id="rclone-gui">rclone gui</h1>
+<p>Open the web based GUI.</p>
+<h2 id="synopsis-54">Synopsis</h2>
+<p>This command starts an embedded web GUI for rclone and opens it in
+your default browser.</p>
+<p>This starts an RC API server and a GUI server on separate localhost
+ports, generates login credentials automatically unless --no-auth is
+specified, and opens the browser already authenticated.</p>
+<pre><code>rclone gui</code></pre>
+<p>By default rclone gui serves the web GUI that was embedded into the
+rclone binary at build time from https://github.com/rclone/rclone-web/
+You can override this by passing a path to either an unpacked GUI
+directory or a dist.zip archive (e.g. one downloaded from the rclone-web
+releases page):</p>
+<pre><code>rclone gui ./my-dist/
+rclone gui ./dist.zip</code></pre>
+<p>This is useful for iterating on the GUI locally without rebuilding
+rclone, or for serving a different GUI release than the one
+embedded.</p>
+<p>Use --no-open-browser to skip opening the browser automatically:</p>
+<pre><code>rclone gui --no-open-browser</code></pre>
+<p>Use --addr to bind the GUI to a specific address:</p>
+<pre><code>rclone gui --addr localhost:5580</code></pre>
+<p>Use --user and --pass to set specific credentials:</p>
+<pre><code>rclone gui --user admin --pass secret</code></pre>
+<p>Use --no-auth to disable authentication entirely:</p>
+<pre><code>rclone gui --no-auth</code></pre>
+<p>For more help see <a href="https://rclone.org/gui/">the GUI
+docs</a>.</p>
+<pre><code>rclone gui [path] [flags]</code></pre>
+<h2 id="options-61">Options</h2>
+<pre><code> --addr stringArray IPaddress:Port for the GUI server (default auto-chosen localhost port)
+ --api-addr stringArray IPaddress:Port for the RC API server (default auto-chosen localhost port)
+ --enable-metrics Enable OpenMetrics/Prometheus compatible endpoint at /metrics
+ -h, --help help for gui
+ --no-auth Don&#39;t require auth for the RC API
+ --no-open-browser Skip opening the browser automatically
+ --pass string Password for RC authentication
+ --user string User name for RC authentication</code></pre>
+<p>Options shared with other commands are described next. See the <a
+href="https://rclone.org/flags/">global flags page</a> for global
+options not listed here.</p>
+<h3 id="rc-options">RC Options</h3>
+<p>Flags to control the Remote Control API</p>
+<pre class="text"><code> --rc Enable the remote control server
+ --rc-addr stringArray IPaddress:Port or :Port to bind server to (default localhost:5572)
+ --rc-allow-origin string Origin which cross-domain request (CORS) can be executed from
+ --rc-baseurl string Prefix for URLs - leave blank for root
+ --rc-cert string TLS PEM key (concatenation of certificate and CA certificate)
+ --rc-client-ca string Client certificate authority to verify clients with
+ --rc-enable-metrics Enable the Prometheus metrics path at the remote control server
+ --rc-files string Path to local files to serve on the HTTP server
+ --rc-htpasswd string A htpasswd file - if not provided no authentication is done
+ --rc-job-expire-duration Duration Expire finished async jobs older than this value (default 1m0s)
+ --rc-job-expire-interval Duration Interval to check for expired async jobs (default 10s)
+ --rc-key string TLS PEM Private key
+ --rc-max-header-bytes int Maximum size of request header (default 4096)
+ --rc-min-tls-version string Minimum TLS version that is acceptable (default &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
+ --rc-salt string Password hashing salt (default &quot;dlPL2MqE&quot;)
+ --rc-serve Enable the serving of remote objects
+ --rc-serve-no-modtime Don&#39;t read the modification time (can speed things up)
+ --rc-server-read-timeout Duration Timeout for server reading data (default 1h0m0s)
+ --rc-server-write-timeout Duration Timeout for server writing data (default 1h0m0s)
+ --rc-template string User-specified template
+ --rc-user string User name for authentication
+ --rc-user-from-header string User name from a defined HTTP header
+ --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</code></pre>
+<h2 id="see-also-61">See Also</h2>
+<!-- markdownlint-capture -->
+<!-- markdownlint-disable ul-style line-length -->
+<ul>
+<li><a href="https://rclone.org/commands/rclone/">rclone</a> - Show help
+for rclone commands, flags and backends.</li>
+</ul>
+<!-- markdownlint-restore -->
<h1 id="rclone-hashsum">rclone hashsum</h1>
<p>Produces a hashsum file for all the objects in the path.</p>
-<h2 id="synopsis-54">Synopsis</h2>
+<h2 id="synopsis-55">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>
@@ -5268,7 +5381,7 @@ Supported hashes are:
<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-61">Options</h2>
+<h2 id="options-62">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
@@ -5306,7 +5419,7 @@ options not listed here.</p>
<p>Flags for listing directories</p>
<pre class="text"><code> --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
--fast-list Use recursive list if available; uses more memory but fewer transactions</code></pre>
-<h2 id="see-also-61">See Also</h2>
+<h2 id="see-also-62">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
@@ -5316,7 +5429,7 @@ for rclone commands, flags and backends.</li>
<!-- markdownlint-restore -->
<h1 id="rclone-link">rclone link</h1>
<p>Generate public link to file/folder.</p>
-<h2 id="synopsis-55">Synopsis</h2>
+<h2 id="synopsis-56">Synopsis</h2>
<p>Create, retrieve or remove a public link to the given file or
folder.</p>
<pre class="console"><code>rclone link remote:path/to/file
@@ -5335,13 +5448,13 @@ 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-62">Options</h2>
+<h2 id="options-63">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-62">See Also</h2>
+<h2 id="see-also-63">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
@@ -5352,7 +5465,7 @@ for rclone commands, flags and backends.</li>
<h1 id="rclone-listremotes">rclone listremotes</h1>
<p>List all the remotes in the config file and defined in environment
variables.</p>
-<h2 id="synopsis-56">Synopsis</h2>
+<h2 id="synopsis-57">Synopsis</h2>
<p>Lists all the available remotes from the config file, or the remotes
matching an optional filter.</p>
<p>Prints the result in human-readable format by default, and as a
@@ -5365,9 +5478,13 @@ environment).</p>
attributes, and/or filter flags specific for each attribute. The values
must be specified according to regular rclone filtering pattern
syntax.</p>
+<p>By default filtering uses non-anchored matching, so
+<code>--type box</code> also matches <code>dropbox</code>. Use
+<code>--exact</code> to match complete values only.</p>
<pre><code>rclone listremotes [&lt;filter&gt;] [flags]</code></pre>
-<h2 id="options-63">Options</h2>
+<h2 id="options-64">Options</h2>
<pre><code> --description string Filter remotes by description
+ --exact Match filter strings exactly instead of using non-anchored glob matching
-h, --help help for listremotes
--json Format output as JSON
--long Show type and description in addition to name
@@ -5377,7 +5494,7 @@ syntax.</p>
--type string Filter remotes by type</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>
+<h2 id="see-also-64">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
@@ -5388,7 +5505,7 @@ for rclone commands, flags and backends.</li>
<h1 id="rclone-lsf">rclone lsf</h1>
<p>List directories and objects in remote:path formatted for
parsing.</p>
-<h2 id="synopsis-57">Synopsis</h2>
+<h2 id="synopsis-58">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
@@ -5507,7 +5624,7 @@ for more details.</p>
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-64">Options</h2>
+<h2 id="options-65">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)
@@ -5551,7 +5668,7 @@ options not listed here.</p>
<p>Flags for listing directories</p>
<pre class="text"><code> --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
--fast-list Use recursive list if available; uses more memory but fewer transactions</code></pre>
-<h2 id="see-also-64">See Also</h2>
+<h2 id="see-also-65">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
@@ -5561,29 +5678,29 @@ for rclone commands, flags and backends.</li>
<!-- markdownlint-restore -->
<h1 id="rclone-lsjson">rclone lsjson</h1>
<p>List directories and objects in the path in JSON format.</p>
-<h2 id="synopsis-58">Synopsis</h2>
+<h2 id="synopsis-59">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>
-<div class="sourceCode" id="cb337"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb337-1"><a href="#cb337-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
-<span id="cb337-2"><a href="#cb337-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Hashes&quot;</span> <span class="fu">:</span> <span class="fu">{</span></span>
-<span id="cb337-3"><a href="#cb337-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;SHA-1&quot;</span> <span class="fu">:</span> <span class="st">&quot;f572d396fae9206628714fb2ce00f72e94f2258f&quot;</span><span class="fu">,</span></span>
-<span id="cb337-4"><a href="#cb337-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;MD5&quot;</span> <span class="fu">:</span> <span class="st">&quot;b1946ac92492d2347c6235b4d2611184&quot;</span><span class="fu">,</span></span>
-<span id="cb337-5"><a href="#cb337-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;DropboxHash&quot;</span> <span class="fu">:</span> <span class="st">&quot;ecb65bb98f9d905b70458986c39fcbad7715e5f2fcc3b1f07767d7c83e2438cc&quot;</span></span>
-<span id="cb337-6"><a href="#cb337-6" aria-hidden="true" tabindex="-1"></a> <span class="fu">},</span></span>
-<span id="cb337-7"><a href="#cb337-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;ID&quot;</span><span class="fu">:</span> <span class="st">&quot;y2djkhiujf83u33&quot;</span><span class="fu">,</span></span>
-<span id="cb337-8"><a href="#cb337-8" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;OrigID&quot;</span><span class="fu">:</span> <span class="st">&quot;UYOJVTUW00Q1RzTDA&quot;</span><span class="fu">,</span></span>
-<span id="cb337-9"><a href="#cb337-9" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;IsBucket&quot;</span> <span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span></span>
-<span id="cb337-10"><a href="#cb337-10" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;IsDir&quot;</span> <span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span></span>
-<span id="cb337-11"><a href="#cb337-11" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;MimeType&quot;</span> <span class="fu">:</span> <span class="st">&quot;application/octet-stream&quot;</span><span class="fu">,</span></span>
-<span id="cb337-12"><a href="#cb337-12" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;ModTime&quot;</span> <span class="fu">:</span> <span class="st">&quot;2017-05-31T16:15:57.034468261+01:00&quot;</span><span class="fu">,</span></span>
-<span id="cb337-13"><a href="#cb337-13" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Name&quot;</span> <span class="fu">:</span> <span class="st">&quot;file.txt&quot;</span><span class="fu">,</span></span>
-<span id="cb337-14"><a href="#cb337-14" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Encrypted&quot;</span> <span class="fu">:</span> <span class="st">&quot;v0qpsdq8anpci8n929v3uu9338&quot;</span><span class="fu">,</span></span>
-<span id="cb337-15"><a href="#cb337-15" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;EncryptedPath&quot;</span> <span class="fu">:</span> <span class="st">&quot;kja9098349023498/v0qpsdq8anpci8n929v3uu9338&quot;</span><span class="fu">,</span></span>
-<span id="cb337-16"><a href="#cb337-16" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Path&quot;</span> <span class="fu">:</span> <span class="st">&quot;full/path/goes/here/file.txt&quot;</span><span class="fu">,</span></span>
-<span id="cb337-17"><a href="#cb337-17" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Size&quot;</span> <span class="fu">:</span> <span class="dv">6</span><span class="fu">,</span></span>
-<span id="cb337-18"><a href="#cb337-18" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Tier&quot;</span> <span class="fu">:</span> <span class="st">&quot;hot&quot;</span><span class="fu">,</span></span>
-<span id="cb337-19"><a href="#cb337-19" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
+<div class="sourceCode" id="cb348"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb348-1"><a href="#cb348-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
+<span id="cb348-2"><a href="#cb348-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Hashes&quot;</span> <span class="fu">:</span> <span class="fu">{</span></span>
+<span id="cb348-3"><a href="#cb348-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;SHA-1&quot;</span> <span class="fu">:</span> <span class="st">&quot;f572d396fae9206628714fb2ce00f72e94f2258f&quot;</span><span class="fu">,</span></span>
+<span id="cb348-4"><a href="#cb348-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;MD5&quot;</span> <span class="fu">:</span> <span class="st">&quot;b1946ac92492d2347c6235b4d2611184&quot;</span><span class="fu">,</span></span>
+<span id="cb348-5"><a href="#cb348-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;DropboxHash&quot;</span> <span class="fu">:</span> <span class="st">&quot;ecb65bb98f9d905b70458986c39fcbad7715e5f2fcc3b1f07767d7c83e2438cc&quot;</span></span>
+<span id="cb348-6"><a href="#cb348-6" aria-hidden="true" tabindex="-1"></a> <span class="fu">},</span></span>
+<span id="cb348-7"><a href="#cb348-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;ID&quot;</span><span class="fu">:</span> <span class="st">&quot;y2djkhiujf83u33&quot;</span><span class="fu">,</span></span>
+<span id="cb348-8"><a href="#cb348-8" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;OrigID&quot;</span><span class="fu">:</span> <span class="st">&quot;UYOJVTUW00Q1RzTDA&quot;</span><span class="fu">,</span></span>
+<span id="cb348-9"><a href="#cb348-9" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;IsBucket&quot;</span> <span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span></span>
+<span id="cb348-10"><a href="#cb348-10" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;IsDir&quot;</span> <span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span></span>
+<span id="cb348-11"><a href="#cb348-11" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;MimeType&quot;</span> <span class="fu">:</span> <span class="st">&quot;application/octet-stream&quot;</span><span class="fu">,</span></span>
+<span id="cb348-12"><a href="#cb348-12" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;ModTime&quot;</span> <span class="fu">:</span> <span class="st">&quot;2017-05-31T16:15:57.034468261+01:00&quot;</span><span class="fu">,</span></span>
+<span id="cb348-13"><a href="#cb348-13" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Name&quot;</span> <span class="fu">:</span> <span class="st">&quot;file.txt&quot;</span><span class="fu">,</span></span>
+<span id="cb348-14"><a href="#cb348-14" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Encrypted&quot;</span> <span class="fu">:</span> <span class="st">&quot;v0qpsdq8anpci8n929v3uu9338&quot;</span><span class="fu">,</span></span>
+<span id="cb348-15"><a href="#cb348-15" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;EncryptedPath&quot;</span> <span class="fu">:</span> <span class="st">&quot;kja9098349023498/v0qpsdq8anpci8n929v3uu9338&quot;</span><span class="fu">,</span></span>
+<span id="cb348-16"><a href="#cb348-16" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Path&quot;</span> <span class="fu">:</span> <span class="st">&quot;full/path/goes/here/file.txt&quot;</span><span class="fu">,</span></span>
+<span id="cb348-17"><a href="#cb348-17" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Size&quot;</span> <span class="fu">:</span> <span class="dv">6</span><span class="fu">,</span></span>
+<span id="cb348-18"><a href="#cb348-18" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Tier&quot;</span> <span class="fu">:</span> <span class="st">&quot;hot&quot;</span><span class="fu">,</span></span>
+<span id="cb348-19"><a href="#cb348-19" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>The exact set of properties included depends on the backend:</p>
<ul>
<li>The property IsBucket will only be included for bucket-based
@@ -5673,7 +5790,7 @@ for more details.</p>
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-65">Options</h2>
+<h2 id="options-66">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
@@ -5718,7 +5835,7 @@ options not listed here.</p>
<p>Flags for listing directories</p>
<pre class="text"><code> --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
--fast-list Use recursive list if available; uses more memory but fewer transactions</code></pre>
-<h2 id="see-also-65">See Also</h2>
+<h2 id="see-also-66">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
@@ -5728,7 +5845,7 @@ for rclone commands, flags and backends.</li>
<!-- markdownlint-restore -->
<h1 id="rclone-mount">rclone mount</h1>
<p>Mount the remote as file system on a mountpoint.</p>
-<h2 id="synopsis-59">Synopsis</h2>
+<h2 id="synopsis-60">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
@@ -5976,8 +6093,8 @@ does not suffer from the same limitations.</p>
<p>Mounting on macOS can be done either via <a
href="https://rclone.org/commands/rclone_serve_nfs/">built-in NFS
server</a>, <a href="https://osxfuse.github.io/">macFUSE</a> (also known
-as osxfuse) or <a href="https://www.fuse-t.org/">FUSE-T</a>.macFUSE is a
-traditional FUSE driver utilizing a macOS kernel extension (kext).
+as osxfuse) or <a href="https://www.fuse-t.org/">FUSE-T</a>. macFUSE is
+a traditional FUSE driver utilizing a macOS kernel extension (kext).
FUSE-T is an alternative FUSE system which "mounts" via an NFSv4 local
server.</p>
<h3 id="unicode-normalization">Unicode Normalization</h3>
@@ -6018,7 +6135,8 @@ wiki</a>:</p>
<blockquote>
<p>File access and modification times cannot be set separately as it
seems to be an issue with the NFS client which always modifies both. Can
-be reproduced with 'touch -m' and 'touch -a' commands</p>
+be reproduced with <code>touch -m</code> and <code>touch -a</code>
+commands</p>
</blockquote>
<p>This means that viewing files with various tools, notably macOS
Finder, will cause rlcone to update the modification time of the file.
@@ -6027,18 +6145,19 @@ This may make rclone upload a full new copy of the file.</p>
<p>When mounting with <code>--read-only</code>, attempts to write to
files will fail <em>silently</em> as opposed to with a clear warning as
in macFUSE.</p>
-<h1 id="mounting-on-linux">Mounting on Linux</h1>
+<h2 id="mounting-on-linux">Mounting on Linux</h2>
<p>On newer versions of Ubuntu, you may encounter the following error
when running <code>rclone mount</code>:</p>
<blockquote>
<p>NOTICE: mount helper error: fusermount3: mount failed: Permission
denied CRITICAL: Fatal error: failed to mount FUSE fs: fusermount: exit
-status 1 This may be due to newer <a
+status 1</p>
+</blockquote>
+<p>This may be due to newer <a
href="https://wiki.ubuntu.com/AppArmor">Apparmor</a> restrictions, which
can be disabled with <code>sudo aa-disable /usr/bin/fusermount3</code>
(you may need to <code>sudo apt install apparmor-utils</code>
beforehand).</p>
-</blockquote>
<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
@@ -6133,25 +6252,25 @@ detect it and translate command-line arguments appropriately.</p>
<p>Now you can run classic mounts like this:</p>
<pre class="console"><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>
-<div class="sourceCode" id="cb351"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb351-1"><a href="#cb351-1" aria-hidden="true" tabindex="-1"></a><span class="co"># /etc/systemd/system/mnt-data.mount</span></span>
-<span id="cb351-2"><a href="#cb351-2" aria-hidden="true" tabindex="-1"></a><span class="kw">[Unit]</span></span>
-<span id="cb351-3"><a href="#cb351-3" aria-hidden="true" tabindex="-1"></a><span class="dt">Description</span><span class="ot">=</span><span class="st">Mount for /mnt/data</span></span>
-<span id="cb351-4"><a href="#cb351-4" aria-hidden="true" tabindex="-1"></a><span class="kw">[Mount]</span></span>
-<span id="cb351-5"><a href="#cb351-5" aria-hidden="true" tabindex="-1"></a><span class="dt">Type</span><span class="ot">=</span><span class="st">rclone</span></span>
-<span id="cb351-6"><a href="#cb351-6" aria-hidden="true" tabindex="-1"></a><span class="dt">What</span><span class="ot">=</span><span class="st">sftp1:subdir</span></span>
-<span id="cb351-7"><a href="#cb351-7" aria-hidden="true" tabindex="-1"></a><span class="dt">Where</span><span class="ot">=</span><span class="st">/mnt/data</span></span>
-<span id="cb351-8"><a href="#cb351-8" aria-hidden="true" tabindex="-1"></a><span class="dt">Options</span><span class="ot">=</span><span class="st">rw,_netdev,allow_other,args2env,vfs-cache-mode=writes,config=/etc/rclone.conf,cache-dir=/var/rclone</span></span></code></pre></div>
+<div class="sourceCode" id="cb362"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb362-1"><a href="#cb362-1" aria-hidden="true" tabindex="-1"></a><span class="co"># /etc/systemd/system/mnt-data.mount</span></span>
+<span id="cb362-2"><a href="#cb362-2" aria-hidden="true" tabindex="-1"></a><span class="kw">[Unit]</span></span>
+<span id="cb362-3"><a href="#cb362-3" aria-hidden="true" tabindex="-1"></a><span class="dt">Description</span><span class="ot">=</span><span class="st">Mount for /mnt/data</span></span>
+<span id="cb362-4"><a href="#cb362-4" aria-hidden="true" tabindex="-1"></a><span class="kw">[Mount]</span></span>
+<span id="cb362-5"><a href="#cb362-5" aria-hidden="true" tabindex="-1"></a><span class="dt">Type</span><span class="ot">=</span><span class="st">rclone</span></span>
+<span id="cb362-6"><a href="#cb362-6" aria-hidden="true" tabindex="-1"></a><span class="dt">What</span><span class="ot">=</span><span class="st">sftp1:subdir</span></span>
+<span id="cb362-7"><a href="#cb362-7" aria-hidden="true" tabindex="-1"></a><span class="dt">Where</span><span class="ot">=</span><span class="st">/mnt/data</span></span>
+<span id="cb362-8"><a href="#cb362-8" aria-hidden="true" tabindex="-1"></a><span class="dt">Options</span><span class="ot">=</span><span class="st">rw,_netdev,allow_other,args2env,vfs-cache-mode=writes,config=/etc/rclone.conf,cache-dir=/var/rclone</span></span></code></pre></div>
<p>optionally accompanied by systemd automount unit</p>
-<div class="sourceCode" id="cb352"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb352-1"><a href="#cb352-1" aria-hidden="true" tabindex="-1"></a><span class="co"># /etc/systemd/system/mnt-data.automount</span></span>
-<span id="cb352-2"><a href="#cb352-2" aria-hidden="true" tabindex="-1"></a><span class="kw">[Unit]</span></span>
-<span id="cb352-3"><a href="#cb352-3" aria-hidden="true" tabindex="-1"></a><span class="dt">Description</span><span class="ot">=</span><span class="st">AutoMount for /mnt/data</span></span>
-<span id="cb352-4"><a href="#cb352-4" aria-hidden="true" tabindex="-1"></a><span class="kw">[Automount]</span></span>
-<span id="cb352-5"><a href="#cb352-5" aria-hidden="true" tabindex="-1"></a><span class="dt">Where</span><span class="ot">=</span><span class="st">/mnt/data</span></span>
-<span id="cb352-6"><a href="#cb352-6" aria-hidden="true" tabindex="-1"></a><span class="dt">TimeoutIdleSec</span><span class="ot">=</span><span class="dv">600</span></span>
-<span id="cb352-7"><a href="#cb352-7" aria-hidden="true" tabindex="-1"></a><span class="kw">[Install]</span></span>
-<span id="cb352-8"><a href="#cb352-8" aria-hidden="true" tabindex="-1"></a><span class="dt">WantedBy</span><span class="ot">=</span><span class="st">multi-user.target</span></span></code></pre></div>
+<div class="sourceCode" id="cb363"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb363-1"><a href="#cb363-1" aria-hidden="true" tabindex="-1"></a><span class="co"># /etc/systemd/system/mnt-data.automount</span></span>
+<span id="cb363-2"><a href="#cb363-2" aria-hidden="true" tabindex="-1"></a><span class="kw">[Unit]</span></span>
+<span id="cb363-3"><a href="#cb363-3" aria-hidden="true" tabindex="-1"></a><span class="dt">Description</span><span class="ot">=</span><span class="st">AutoMount for /mnt/data</span></span>
+<span id="cb363-4"><a href="#cb363-4" aria-hidden="true" tabindex="-1"></a><span class="kw">[Automount]</span></span>
+<span id="cb363-5"><a href="#cb363-5" aria-hidden="true" tabindex="-1"></a><span class="dt">Where</span><span class="ot">=</span><span class="st">/mnt/data</span></span>
+<span id="cb363-6"><a href="#cb363-6" aria-hidden="true" tabindex="-1"></a><span class="dt">TimeoutIdleSec</span><span class="ot">=</span><span class="dv">600</span></span>
+<span id="cb363-7"><a href="#cb363-7" aria-hidden="true" tabindex="-1"></a><span class="kw">[Install]</span></span>
+<span id="cb363-8"><a href="#cb363-8" aria-hidden="true" tabindex="-1"></a><span class="dt">WantedBy</span><span class="ot">=</span><span class="st">multi-user.target</span></span></code></pre></div>
<p>or add in <code>/etc/fstab</code> a line like</p>
<pre class="console"><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
@@ -6575,7 +6694,7 @@ total 1048578
and if there is an error reading the metadata the error will be returned
as <code>{"error":"error string"}</code>.</p>
<pre><code>rclone mount remote:path /path/to/mountpoint [flags]</code></pre>
-<h2 id="options-66">Options</h2>
+<h2 id="options-67">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)
@@ -6617,6 +6736,7 @@ as <code>{"error":"error string"}</code>.</p>
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
@@ -6658,7 +6778,7 @@ options not listed here.</p>
--metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin)
--min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
--min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre>
-<h2 id="see-also-66">See Also</h2>
+<h2 id="see-also-67">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
@@ -6668,7 +6788,7 @@ for rclone commands, flags and backends.</li>
<!-- markdownlint-restore -->
<h1 id="rclone-moveto">rclone moveto</h1>
<p>Move file or directory from source to dest.</p>
-<h2 id="synopsis-60">Synopsis</h2>
+<h2 id="synopsis-61">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
@@ -6744,7 +6864,7 @@ scenarios are not currently supported:</p>
after, so it is most useful as a predictor of what SHOULD happen to each
file (which may or may not match what actually DID).</p>
<pre><code>rclone moveto source:path dest:path [flags]</code></pre>
-<h2 id="options-67">Options</h2>
+<h2 id="options-68">Options</h2>
<pre><code> --absolute Put a leading / in front of path names
--combined string Make a combined report of changes to this file
--csv Output in CSV format
@@ -6835,7 +6955,7 @@ options not listed here.</p>
<p>Flags for listing directories</p>
<pre class="text"><code> --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
--fast-list Use recursive list if available; uses more memory but fewer transactions</code></pre>
-<h2 id="see-also-67">See Also</h2>
+<h2 id="see-also-68">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
@@ -6845,7 +6965,7 @@ for rclone commands, flags and backends.</li>
<!-- markdownlint-restore -->
<h1 id="rclone-ncdu">rclone ncdu</h1>
<p>Explore a remote with a text based user interface.</p>
-<h2 id="synopsis-61">Synopsis</h2>
+<h2 id="synopsis-62">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>
@@ -6900,7 +7020,7 @@ 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-68">Options</h2>
+<h2 id="options-69">Options</h2>
<pre><code> -h, --help help for ncdu</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
@@ -6934,7 +7054,7 @@ options not listed here.</p>
<p>Flags for listing directories</p>
<pre class="text"><code> --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
--fast-list Use recursive list if available; uses more memory but fewer transactions</code></pre>
-<h2 id="see-also-68">See Also</h2>
+<h2 id="see-also-69">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
@@ -6944,7 +7064,7 @@ for rclone commands, flags and backends.</li>
<!-- markdownlint-restore -->
<h1 id="rclone-nfsmount">rclone nfsmount</h1>
<p>Mount the remote as file system on a mountpoint.</p>
-<h2 id="synopsis-62">Synopsis</h2>
+<h2 id="synopsis-63">Synopsis</h2>
<p>Rclone nfsmount allows Linux, FreeBSD, macOS and Windows to mount any
of Rclone's cloud storage systems as a file system with FUSE.</p>
<p>First set up your remote using <code>rclone config</code>. Check it
@@ -7192,8 +7312,8 @@ does not suffer from the same limitations.</p>
<p>Mounting on macOS can be done either via <a
href="https://rclone.org/commands/rclone_serve_nfs/">built-in NFS
server</a>, <a href="https://osxfuse.github.io/">macFUSE</a> (also known
-as osxfuse) or <a href="https://www.fuse-t.org/">FUSE-T</a>.macFUSE is a
-traditional FUSE driver utilizing a macOS kernel extension (kext).
+as osxfuse) or <a href="https://www.fuse-t.org/">FUSE-T</a>. macFUSE is
+a traditional FUSE driver utilizing a macOS kernel extension (kext).
FUSE-T is an alternative FUSE system which "mounts" via an NFSv4 local
server.</p>
<h3 id="unicode-normalization-1">Unicode Normalization</h3>
@@ -7234,7 +7354,8 @@ wiki</a>:</p>
<blockquote>
<p>File access and modification times cannot be set separately as it
seems to be an issue with the NFS client which always modifies both. Can
-be reproduced with 'touch -m' and 'touch -a' commands</p>
+be reproduced with <code>touch -m</code> and <code>touch -a</code>
+commands</p>
</blockquote>
<p>This means that viewing files with various tools, notably macOS
Finder, will cause rlcone to update the modification time of the file.
@@ -7243,18 +7364,19 @@ This may make rclone upload a full new copy of the file.</p>
<p>When mounting with <code>--read-only</code>, attempts to write to
files will fail <em>silently</em> as opposed to with a clear warning as
in macFUSE.</p>
-<h1 id="mounting-on-linux-1">Mounting on Linux</h1>
+<h2 id="mounting-on-linux-1">Mounting on Linux</h2>
<p>On newer versions of Ubuntu, you may encounter the following error
when running <code>rclone mount</code>:</p>
<blockquote>
<p>NOTICE: mount helper error: fusermount3: mount failed: Permission
denied CRITICAL: Fatal error: failed to mount FUSE fs: fusermount: exit
-status 1 This may be due to newer <a
+status 1</p>
+</blockquote>
+<p>This may be due to newer <a
href="https://wiki.ubuntu.com/AppArmor">Apparmor</a> restrictions, which
can be disabled with <code>sudo aa-disable /usr/bin/fusermount3</code>
(you may need to <code>sudo apt install apparmor-utils</code>
beforehand).</p>
-</blockquote>
<h2 id="limitations-1">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
@@ -7349,25 +7471,25 @@ detect it and translate command-line arguments appropriately.</p>
<p>Now you can run classic mounts like this:</p>
<pre class="console"><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>
-<div class="sourceCode" id="cb393"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb393-1"><a href="#cb393-1" aria-hidden="true" tabindex="-1"></a><span class="co"># /etc/systemd/system/mnt-data.mount</span></span>
-<span id="cb393-2"><a href="#cb393-2" aria-hidden="true" tabindex="-1"></a><span class="kw">[Unit]</span></span>
-<span id="cb393-3"><a href="#cb393-3" aria-hidden="true" tabindex="-1"></a><span class="dt">Description</span><span class="ot">=</span><span class="st">Mount for /mnt/data</span></span>
-<span id="cb393-4"><a href="#cb393-4" aria-hidden="true" tabindex="-1"></a><span class="kw">[Mount]</span></span>
-<span id="cb393-5"><a href="#cb393-5" aria-hidden="true" tabindex="-1"></a><span class="dt">Type</span><span class="ot">=</span><span class="st">rclone</span></span>
-<span id="cb393-6"><a href="#cb393-6" aria-hidden="true" tabindex="-1"></a><span class="dt">What</span><span class="ot">=</span><span class="st">sftp1:subdir</span></span>
-<span id="cb393-7"><a href="#cb393-7" aria-hidden="true" tabindex="-1"></a><span class="dt">Where</span><span class="ot">=</span><span class="st">/mnt/data</span></span>
-<span id="cb393-8"><a href="#cb393-8" aria-hidden="true" tabindex="-1"></a><span class="dt">Options</span><span class="ot">=</span><span class="st">rw,_netdev,allow_other,args2env,vfs-cache-mode=writes,config=/etc/rclone.conf,cache-dir=/var/rclone</span></span></code></pre></div>
+<div class="sourceCode" id="cb404"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb404-1"><a href="#cb404-1" aria-hidden="true" tabindex="-1"></a><span class="co"># /etc/systemd/system/mnt-data.mount</span></span>
+<span id="cb404-2"><a href="#cb404-2" aria-hidden="true" tabindex="-1"></a><span class="kw">[Unit]</span></span>
+<span id="cb404-3"><a href="#cb404-3" aria-hidden="true" tabindex="-1"></a><span class="dt">Description</span><span class="ot">=</span><span class="st">Mount for /mnt/data</span></span>
+<span id="cb404-4"><a href="#cb404-4" aria-hidden="true" tabindex="-1"></a><span class="kw">[Mount]</span></span>
+<span id="cb404-5"><a href="#cb404-5" aria-hidden="true" tabindex="-1"></a><span class="dt">Type</span><span class="ot">=</span><span class="st">rclone</span></span>
+<span id="cb404-6"><a href="#cb404-6" aria-hidden="true" tabindex="-1"></a><span class="dt">What</span><span class="ot">=</span><span class="st">sftp1:subdir</span></span>
+<span id="cb404-7"><a href="#cb404-7" aria-hidden="true" tabindex="-1"></a><span class="dt">Where</span><span class="ot">=</span><span class="st">/mnt/data</span></span>
+<span id="cb404-8"><a href="#cb404-8" aria-hidden="true" tabindex="-1"></a><span class="dt">Options</span><span class="ot">=</span><span class="st">rw,_netdev,allow_other,args2env,vfs-cache-mode=writes,config=/etc/rclone.conf,cache-dir=/var/rclone</span></span></code></pre></div>
<p>optionally accompanied by systemd automount unit</p>
-<div class="sourceCode" id="cb394"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb394-1"><a href="#cb394-1" aria-hidden="true" tabindex="-1"></a><span class="co"># /etc/systemd/system/mnt-data.automount</span></span>
-<span id="cb394-2"><a href="#cb394-2" aria-hidden="true" tabindex="-1"></a><span class="kw">[Unit]</span></span>
-<span id="cb394-3"><a href="#cb394-3" aria-hidden="true" tabindex="-1"></a><span class="dt">Description</span><span class="ot">=</span><span class="st">AutoMount for /mnt/data</span></span>
-<span id="cb394-4"><a href="#cb394-4" aria-hidden="true" tabindex="-1"></a><span class="kw">[Automount]</span></span>
-<span id="cb394-5"><a href="#cb394-5" aria-hidden="true" tabindex="-1"></a><span class="dt">Where</span><span class="ot">=</span><span class="st">/mnt/data</span></span>
-<span id="cb394-6"><a href="#cb394-6" aria-hidden="true" tabindex="-1"></a><span class="dt">TimeoutIdleSec</span><span class="ot">=</span><span class="dv">600</span></span>
-<span id="cb394-7"><a href="#cb394-7" aria-hidden="true" tabindex="-1"></a><span class="kw">[Install]</span></span>
-<span id="cb394-8"><a href="#cb394-8" aria-hidden="true" tabindex="-1"></a><span class="dt">WantedBy</span><span class="ot">=</span><span class="st">multi-user.target</span></span></code></pre></div>
+<div class="sourceCode" id="cb405"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb405-1"><a href="#cb405-1" aria-hidden="true" tabindex="-1"></a><span class="co"># /etc/systemd/system/mnt-data.automount</span></span>
+<span id="cb405-2"><a href="#cb405-2" aria-hidden="true" tabindex="-1"></a><span class="kw">[Unit]</span></span>
+<span id="cb405-3"><a href="#cb405-3" aria-hidden="true" tabindex="-1"></a><span class="dt">Description</span><span class="ot">=</span><span class="st">AutoMount for /mnt/data</span></span>
+<span id="cb405-4"><a href="#cb405-4" aria-hidden="true" tabindex="-1"></a><span class="kw">[Automount]</span></span>
+<span id="cb405-5"><a href="#cb405-5" aria-hidden="true" tabindex="-1"></a><span class="dt">Where</span><span class="ot">=</span><span class="st">/mnt/data</span></span>
+<span id="cb405-6"><a href="#cb405-6" aria-hidden="true" tabindex="-1"></a><span class="dt">TimeoutIdleSec</span><span class="ot">=</span><span class="dv">600</span></span>
+<span id="cb405-7"><a href="#cb405-7" aria-hidden="true" tabindex="-1"></a><span class="kw">[Install]</span></span>
+<span id="cb405-8"><a href="#cb405-8" aria-hidden="true" tabindex="-1"></a><span class="dt">WantedBy</span><span class="ot">=</span><span class="st">multi-user.target</span></span></code></pre></div>
<p>or add in <code>/etc/fstab</code> a line like</p>
<pre class="console"><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
@@ -7792,7 +7914,7 @@ total 1048578
and if there is an error reading the metadata the error will be returned
as <code>{"error":"error string"}</code>.</p>
<pre><code>rclone nfsmount remote:path /path/to/mountpoint [flags]</code></pre>
-<h2 id="options-69">Options</h2>
+<h2 id="options-70">Options</h2>
<pre><code> --addr string IPaddress:Port or :Port to bind server to
--allow-non-empty Allow mounting over a non-empty directory (not supported on Windows)
--allow-other Allow access to other users (not supported on Windows)
@@ -7839,6 +7961,7 @@ as <code>{"error":"error string"}</code>.</p>
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
@@ -7880,7 +8003,7 @@ options not listed here.</p>
--metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin)
--min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
--min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre>
-<h2 id="see-also-69">See Also</h2>
+<h2 id="see-also-70">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
@@ -7890,7 +8013,7 @@ for rclone commands, flags and backends.</li>
<!-- markdownlint-restore -->
<h1 id="rclone-obscure">rclone obscure</h1>
<p>Obscure password for use in the rclone config file.</p>
-<h2 id="synopsis-63">Synopsis</h2>
+<h2 id="synopsis-64">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
@@ -7911,11 +8034,11 @@ 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-70">Options</h2>
+<h2 id="options-71">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-70">See Also</h2>
+<h2 id="see-also-71">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
@@ -7925,7 +8048,7 @@ for rclone commands, flags and backends.</li>
<!-- markdownlint-restore -->
<h1 id="rclone-rc">rclone rc</h1>
<p>Run a command against a running rclone.</p>
-<h2 id="synopsis-64">Synopsis</h2>
+<h2 id="synopsis-65">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 <a
@@ -7939,11 +8062,11 @@ class="uri">http://host:port</a>.</p>
<code>--user</code>, <code>--pass</code>.</p>
<p>The <code>--unix-socket</code> flag can be used to connect over a
unix socket like this</p>
-<div class="sourceCode" id="cb415"><pre
-class="sourceCode sh"><code class="sourceCode bash"><span id="cb415-1"><a href="#cb415-1" aria-hidden="true" tabindex="-1"></a><span class="co"># start server on /tmp/my.socket</span></span>
-<span id="cb415-2"><a href="#cb415-2" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rcd <span class="at">--rc-addr</span> unix:///tmp/my.socket</span>
-<span id="cb415-3"><a href="#cb415-3" aria-hidden="true" tabindex="-1"></a><span class="co"># Connect to it</span></span>
-<span id="cb415-4"><a href="#cb415-4" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rc <span class="at">--unix-socket</span> /tmp/my.socket core/stats</span></code></pre></div>
+<div class="sourceCode" id="cb426"><pre
+class="sourceCode sh"><code class="sourceCode bash"><span id="cb426-1"><a href="#cb426-1" aria-hidden="true" tabindex="-1"></a><span class="co"># start server on /tmp/my.socket</span></span>
+<span id="cb426-2"><a href="#cb426-2" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rcd <span class="at">--rc-addr</span> unix:///tmp/my.socket</span>
+<span id="cb426-3"><a href="#cb426-3" aria-hidden="true" tabindex="-1"></a><span class="co"># Connect to it</span></span>
+<span id="cb426-4"><a href="#cb426-4" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rc <span class="at">--unix-socket</span> /tmp/my.socket core/stats</span></code></pre></div>
<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
@@ -7956,25 +8079,25 @@ This is useful for rc commands which take the "opt" parameter which by
convention is a dictionary of strings.</p>
<pre class="text"><code>-o key=value -o key2</code></pre>
<p>Will place this in the "opt" value</p>
-<div class="sourceCode" id="cb417"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb417-1"><a href="#cb417-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span><span class="dt">&quot;key&quot;</span><span class="fu">:</span><span class="st">&quot;value&quot;</span><span class="fu">,</span> <span class="dt">&quot;key2&quot;</span><span class="fu">,</span><span class="dt">&quot;&quot;</span><span class="er">)</span></span></code></pre></div>
+<div class="sourceCode" id="cb428"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb428-1"><a href="#cb428-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span><span class="dt">&quot;key&quot;</span><span class="fu">:</span><span class="st">&quot;value&quot;</span><span class="fu">,</span> <span class="dt">&quot;key2&quot;</span><span class="fu">,</span><span class="dt">&quot;&quot;</span><span class="er">)</span></span></code></pre></div>
<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 class="text"><code>-a value -a value2</code></pre>
<p>Will place this in the "arg" value</p>
-<div class="sourceCode" id="cb419"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb419-1"><a href="#cb419-1" aria-hidden="true" tabindex="-1"></a><span class="ot">[</span><span class="st">&quot;value&quot;</span><span class="ot">,</span> <span class="st">&quot;value2&quot;</span><span class="ot">]</span></span></code></pre></div>
+<div class="sourceCode" id="cb430"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb430-1"><a href="#cb430-1" aria-hidden="true" tabindex="-1"></a><span class="ot">[</span><span class="st">&quot;value&quot;</span><span class="ot">,</span> <span class="st">&quot;value2&quot;</span><span class="ot">]</span></span></code></pre></div>
<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>
-<div class="sourceCode" id="cb420"><pre
-class="sourceCode sh"><code class="sourceCode bash"><span id="cb420-1"><a href="#cb420-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rc <span class="at">--loopback</span> operations/about fs=/</span></code></pre></div>
+<div class="sourceCode" id="cb431"><pre
+class="sourceCode sh"><code class="sourceCode bash"><span id="cb431-1"><a href="#cb431-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rc <span class="at">--loopback</span> operations/about fs=/</span></code></pre></div>
<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-71">Options</h2>
+<h2 id="options-72">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
@@ -7987,7 +8110,7 @@ commands.</p>
--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-71">See Also</h2>
+<h2 id="see-also-72">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
@@ -7997,7 +8120,7 @@ for rclone commands, flags and backends.</li>
<!-- markdownlint-restore -->
<h1 id="rclone-rcat">rclone rcat</h1>
<p>Copies standard input to file on remote.</p>
-<h2 id="synopsis-65">Synopsis</h2>
+<h2 id="synopsis-66">Synopsis</h2>
<p>Reads from standard input (stdin) and copies it to a single remote
file.</p>
<pre class="console"><code>echo &quot;hello world&quot; | rclone rcat remote:path/to/file
@@ -8024,7 +8147,7 @@ chunks can be retried. If you need to transfer a lot of data, you may be
better off caching it locally and then <code>rclone move</code> it to
the destination which can use retries.</p>
<pre><code>rclone rcat remote:path [flags]</code></pre>
-<h2 id="options-72">Options</h2>
+<h2 id="options-73">Options</h2>
<pre><code> -h, --help help for rcat
--size int File size hint to preallocate (default -1)</code></pre>
<p>Options shared with other commands are described next. See the <a
@@ -8035,7 +8158,7 @@ options not listed here.</p>
<pre class="text"><code> -n, --dry-run Do a trial run with no permanent changes
-i, --interactive Enable interactive mode
-v, --verbose count Print lots more stuff (repeat for more)</code></pre>
-<h2 id="see-also-72">See Also</h2>
+<h2 id="see-also-73">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
@@ -8045,7 +8168,7 @@ for rclone commands, flags and backends.</li>
<!-- markdownlint-restore -->
<h1 id="rclone-rcd">rclone rcd</h1>
<p>Run rclone listening to remote control commands only.</p>
-<h2 id="synopsis-66">Synopsis</h2>
+<h2 id="synopsis-67">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>
@@ -8085,6 +8208,10 @@ serve. Rclone automatically inserts leading and trailing "/" on
<code>--rc-baseurl "/rclone/"</code> are all treated identically.</p>
<p><code>--rc-disable-zip</code> may be set to disable the zipping
download option.</p>
+<h3 id="protocol">Protocol</h3>
+<p>The server supports HTTP/1.1 and HTTP/2. HTTP/2 is used automatically
+for TLS connections. For non-TLS connections, HTTP/2 cleartext (h2c) is
+supported, allowing HTTP/2 without encryption.</p>
<h3 id="tls-ssl">TLS (SSL)</h3>
<p>By default this will serve over http. If you want you can serve over
https. You will need to supply the <code>--rc-cert</code> and
@@ -8277,12 +8404,12 @@ htpasswd -B htpasswd anotherUser</code></pre>
<p>Use <code>--rc-salt</code> to change the password hashing salt from
the default.</p>
<pre><code>rclone rcd &lt;path to files to serve&gt;* [flags]</code></pre>
-<h2 id="options-73">Options</h2>
+<h2 id="options-74">Options</h2>
<pre><code> -h, --help help for rcd</code></pre>
<p>Options shared with other commands are described next. See the <a
href="https://rclone.org/flags/">global flags page</a> for global
options not listed here.</p>
-<h3 id="rc-options">RC Options</h3>
+<h3 id="rc-options-1">RC Options</h3>
<p>Flags to control the Remote Control API</p>
<pre class="text"><code> --rc Enable the remote control server
--rc-addr stringArray IPaddress:Port or :Port to bind server to (default localhost:5572)
@@ -8314,7 +8441,7 @@ options not listed here.</p>
--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</code></pre>
-<h2 id="see-also-73">See Also</h2>
+<h2 id="see-also-74">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
@@ -8324,7 +8451,7 @@ for rclone commands, flags and backends.</li>
<!-- markdownlint-restore -->
<h1 id="rclone-rmdirs">rclone rmdirs</h1>
<p>Remove empty directories under the path.</p>
-<h2 id="synopsis-67">Synopsis</h2>
+<h2 id="synopsis-68">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
@@ -8343,7 +8470,7 @@ number.</p>
<p>To delete a path and any objects in it, use the <a
href="https://rclone.org/commands/rclone_purge/">purge</a> command.</p>
<pre><code>rclone rmdirs remote:path [flags]</code></pre>
-<h2 id="options-74">Options</h2>
+<h2 id="options-75">Options</h2>
<pre><code> -h, --help help for rmdirs
--leave-root Do not remove root directory if empty</code></pre>
<p>Options shared with other commands are described next. See the <a
@@ -8354,7 +8481,7 @@ options not listed here.</p>
<pre class="text"><code> -n, --dry-run Do a trial run with no permanent changes
-i, --interactive Enable interactive mode
-v, --verbose count Print lots more stuff (repeat for more)</code></pre>
-<h2 id="see-also-74">See Also</h2>
+<h2 id="see-also-75">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
@@ -8364,7 +8491,7 @@ for rclone commands, flags and backends.</li>
<!-- markdownlint-restore -->
<h1 id="rclone-selfupdate">rclone selfupdate</h1>
<p>Update the rclone binary.</p>
-<h2 id="synopsis-68">Synopsis</h2>
+<h2 id="synopsis-69">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; see <a
@@ -8416,7 +8543,7 @@ success.</p>
manually following the <a href="https://rclone.org/install/">install
documentation</a>.</p>
<pre><code>rclone selfupdate [flags]</code></pre>
-<h2 id="options-75">Options</h2>
+<h2 id="options-76">Options</h2>
<pre><code> --beta Install beta release
--check Check for latest release, do not download
-h, --help help for selfupdate
@@ -8426,7 +8553,7 @@ documentation</a>.</p>
--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-75">See Also</h2>
+<h2 id="see-also-76">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
@@ -8436,7 +8563,7 @@ for rclone commands, flags and backends.</li>
<!-- markdownlint-restore -->
<h1 id="rclone-serve">rclone serve</h1>
<p>Serve a remote over a protocol.</p>
-<h2 id="synopsis-69">Synopsis</h2>
+<h2 id="synopsis-70">Synopsis</h2>
<p>Serve a remote over a given protocol. Requires the use of a
subcommand to specify the protocol, e.g.</p>
<pre class="console"><code>rclone serve http remote:</code></pre>
@@ -8447,11 +8574,11 @@ fields depends on whether the remote supports metadata.</p>
<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-76">Options</h2>
+<h2 id="options-77">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-76">See Also</h2>
+<h2 id="see-also-77">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
@@ -8479,7 +8606,7 @@ serve webdav</a> - Serve remote:path over WebDAV.</li>
<!-- markdownlint-restore -->
<h1 id="rclone-serve-dlna">rclone serve dlna</h1>
<p>Serve remote:path over DLNA</p>
-<h2 id="synopsis-70">Synopsis</h2>
+<h2 id="synopsis-71">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
@@ -8893,7 +9020,7 @@ total 1048578
and if there is an error reading the metadata the error will be returned
as <code>{"error":"error string"}</code>.</p>
<pre><code>rclone serve dlna remote:path [flags]</code></pre>
-<h2 id="options-77">Options</h2>
+<h2 id="options-78">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)
@@ -8921,6 +9048,7 @@ as <code>{"error":"error string"}</code>.</p>
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
@@ -8960,7 +9088,7 @@ options not listed here.</p>
--metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin)
--min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
--min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre>
-<h2 id="see-also-77">See Also</h2>
+<h2 id="see-also-78">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
@@ -8970,7 +9098,7 @@ options not listed here.</p>
<!-- markdownlint-restore -->
<h1 id="rclone-serve-docker">rclone serve docker</h1>
<p>Serve any remote on docker's volume plugin API.</p>
-<h2 id="synopsis-71">Synopsis</h2>
+<h2 id="synopsis-72">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
@@ -9402,7 +9530,7 @@ total 1048578
and if there is an error reading the metadata the error will be returned
as <code>{"error":"error string"}</code>.</p>
<pre><code>rclone serve docker [flags]</code></pre>
-<h2 id="options-78">Options</h2>
+<h2 id="options-79">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)
@@ -9449,6 +9577,7 @@ as <code>{"error":"error string"}</code>.</p>
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
@@ -9490,7 +9619,7 @@ options not listed here.</p>
--metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin)
--min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
--min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre>
-<h2 id="see-also-78">See Also</h2>
+<h2 id="see-also-79">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
@@ -9500,7 +9629,7 @@ options not listed here.</p>
<!-- markdownlint-restore -->
<h1 id="rclone-serve-ftp">rclone serve ftp</h1>
<p>Serve remote:path over FTP.</p>
-<h2 id="synopsis-72">Synopsis</h2>
+<h2 id="synopsis-73">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>
@@ -9937,28 +10066,28 @@ obscure</li>
</ul>
<p>If password authentication was used by the client, input to the proxy
process (on STDIN) would look similar to this:</p>
-<div class="sourceCode" id="cb486"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb486-1"><a href="#cb486-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
-<span id="cb486-2"><a href="#cb486-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;user&quot;</span><span class="fu">:</span> <span class="st">&quot;me&quot;</span><span class="fu">,</span></span>
-<span id="cb486-3"><a href="#cb486-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;pass&quot;</span><span class="fu">:</span> <span class="st">&quot;mypassword&quot;</span></span>
-<span id="cb486-4"><a href="#cb486-4" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
+<div class="sourceCode" id="cb497"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb497-1"><a href="#cb497-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
+<span id="cb497-2"><a href="#cb497-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;user&quot;</span><span class="fu">:</span> <span class="st">&quot;me&quot;</span><span class="fu">,</span></span>
+<span id="cb497-3"><a href="#cb497-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;pass&quot;</span><span class="fu">:</span> <span class="st">&quot;mypassword&quot;</span></span>
+<span id="cb497-4"><a href="#cb497-4" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>If public-key authentication was used by the client, input to the
proxy process (on STDIN) would look similar to this:</p>
-<div class="sourceCode" id="cb487"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb487-1"><a href="#cb487-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
-<span id="cb487-2"><a href="#cb487-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;user&quot;</span><span class="fu">:</span> <span class="st">&quot;me&quot;</span><span class="fu">,</span></span>
-<span id="cb487-3"><a href="#cb487-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;public_key&quot;</span><span class="fu">:</span> <span class="st">&quot;AAAAB3NzaC1yc2EAAAADAQABAAABAQDuwESFdAe14hVS6omeyX7edc...JQdf&quot;</span></span>
-<span id="cb487-4"><a href="#cb487-4" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
+<div class="sourceCode" id="cb498"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb498-1"><a href="#cb498-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
+<span id="cb498-2"><a href="#cb498-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;user&quot;</span><span class="fu">:</span> <span class="st">&quot;me&quot;</span><span class="fu">,</span></span>
+<span id="cb498-3"><a href="#cb498-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;public_key&quot;</span><span class="fu">:</span> <span class="st">&quot;AAAAB3NzaC1yc2EAAAADAQABAAABAQDuwESFdAe14hVS6omeyX7edc...JQdf&quot;</span></span>
+<span id="cb498-4"><a href="#cb498-4" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>And as an example return this on STDOUT</p>
-<div class="sourceCode" id="cb488"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb488-1"><a href="#cb488-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
-<span id="cb488-2"><a href="#cb488-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;type&quot;</span><span class="fu">:</span> <span class="st">&quot;sftp&quot;</span><span class="fu">,</span></span>
-<span id="cb488-3"><a href="#cb488-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;_root&quot;</span><span class="fu">:</span> <span class="st">&quot;&quot;</span><span class="fu">,</span></span>
-<span id="cb488-4"><a href="#cb488-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;_obscure&quot;</span><span class="fu">:</span> <span class="st">&quot;pass&quot;</span><span class="fu">,</span></span>
-<span id="cb488-5"><a href="#cb488-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;user&quot;</span><span class="fu">:</span> <span class="st">&quot;me&quot;</span><span class="fu">,</span></span>
-<span id="cb488-6"><a href="#cb488-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;pass&quot;</span><span class="fu">:</span> <span class="st">&quot;mypassword&quot;</span><span class="fu">,</span></span>
-<span id="cb488-7"><a href="#cb488-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;host&quot;</span><span class="fu">:</span> <span class="st">&quot;sftp.example.com&quot;</span></span>
-<span id="cb488-8"><a href="#cb488-8" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
+<div class="sourceCode" id="cb499"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb499-1"><a href="#cb499-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
+<span id="cb499-2"><a href="#cb499-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;type&quot;</span><span class="fu">:</span> <span class="st">&quot;sftp&quot;</span><span class="fu">,</span></span>
+<span id="cb499-3"><a href="#cb499-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;_root&quot;</span><span class="fu">:</span> <span class="st">&quot;&quot;</span><span class="fu">,</span></span>
+<span id="cb499-4"><a href="#cb499-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;_obscure&quot;</span><span class="fu">:</span> <span class="st">&quot;pass&quot;</span><span class="fu">,</span></span>
+<span id="cb499-5"><a href="#cb499-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;user&quot;</span><span class="fu">:</span> <span class="st">&quot;me&quot;</span><span class="fu">,</span></span>
+<span id="cb499-6"><a href="#cb499-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;pass&quot;</span><span class="fu">:</span> <span class="st">&quot;mypassword&quot;</span><span class="fu">,</span></span>
+<span id="cb499-7"><a href="#cb499-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;host&quot;</span><span class="fu">:</span> <span class="st">&quot;sftp.example.com&quot;</span></span>
+<span id="cb499-8"><a href="#cb499-8" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<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
@@ -9979,7 +10108,7 @@ 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-79">Options</h2>
+<h2 id="options-80">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)
@@ -10010,6 +10139,7 @@ backend that rclone supports.</p>
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
@@ -10049,7 +10179,7 @@ options not listed here.</p>
--metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin)
--min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
--min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre>
-<h2 id="see-also-79">See Also</h2>
+<h2 id="see-also-80">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
@@ -10059,7 +10189,7 @@ options not listed here.</p>
<!-- markdownlint-restore -->
<h1 id="rclone-serve-http">rclone serve http</h1>
<p>Serve the remote over HTTP.</p>
-<h2 id="synopsis-73">Synopsis</h2>
+<h2 id="synopsis-74">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>
@@ -10099,6 +10229,10 @@ serve. Rclone automatically inserts leading and trailing "/" on
are all treated identically.</p>
<p><code>--disable-zip</code> may be set to disable the zipping download
option.</p>
+<h3 id="protocol-1">Protocol</h3>
+<p>The server supports HTTP/1.1 and HTTP/2. HTTP/2 is used automatically
+for TLS connections. For non-TLS connections, HTTP/2 cleartext (h2c) is
+supported, allowing HTTP/2 without encryption.</p>
<h3 id="tls-ssl-1">TLS (SSL)</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
@@ -10711,28 +10845,28 @@ obscure</li>
</ul>
<p>If password authentication was used by the client, input to the proxy
process (on STDIN) would look similar to this:</p>
-<div class="sourceCode" id="cb507"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb507-1"><a href="#cb507-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
-<span id="cb507-2"><a href="#cb507-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;user&quot;</span><span class="fu">:</span> <span class="st">&quot;me&quot;</span><span class="fu">,</span></span>
-<span id="cb507-3"><a href="#cb507-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;pass&quot;</span><span class="fu">:</span> <span class="st">&quot;mypassword&quot;</span></span>
-<span id="cb507-4"><a href="#cb507-4" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
+<div class="sourceCode" id="cb518"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb518-1"><a href="#cb518-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
+<span id="cb518-2"><a href="#cb518-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;user&quot;</span><span class="fu">:</span> <span class="st">&quot;me&quot;</span><span class="fu">,</span></span>
+<span id="cb518-3"><a href="#cb518-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;pass&quot;</span><span class="fu">:</span> <span class="st">&quot;mypassword&quot;</span></span>
+<span id="cb518-4"><a href="#cb518-4" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>If public-key authentication was used by the client, input to the
proxy process (on STDIN) would look similar to this:</p>
-<div class="sourceCode" id="cb508"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb508-1"><a href="#cb508-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
-<span id="cb508-2"><a href="#cb508-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;user&quot;</span><span class="fu">:</span> <span class="st">&quot;me&quot;</span><span class="fu">,</span></span>
-<span id="cb508-3"><a href="#cb508-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;public_key&quot;</span><span class="fu">:</span> <span class="st">&quot;AAAAB3NzaC1yc2EAAAADAQABAAABAQDuwESFdAe14hVS6omeyX7edc...JQdf&quot;</span></span>
-<span id="cb508-4"><a href="#cb508-4" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
+<div class="sourceCode" id="cb519"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb519-1"><a href="#cb519-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
+<span id="cb519-2"><a href="#cb519-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;user&quot;</span><span class="fu">:</span> <span class="st">&quot;me&quot;</span><span class="fu">,</span></span>
+<span id="cb519-3"><a href="#cb519-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;public_key&quot;</span><span class="fu">:</span> <span class="st">&quot;AAAAB3NzaC1yc2EAAAADAQABAAABAQDuwESFdAe14hVS6omeyX7edc...JQdf&quot;</span></span>
+<span id="cb519-4"><a href="#cb519-4" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>And as an example return this on STDOUT</p>
-<div class="sourceCode" id="cb509"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb509-1"><a href="#cb509-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
-<span id="cb509-2"><a href="#cb509-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;type&quot;</span><span class="fu">:</span> <span class="st">&quot;sftp&quot;</span><span class="fu">,</span></span>
-<span id="cb509-3"><a href="#cb509-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;_root&quot;</span><span class="fu">:</span> <span class="st">&quot;&quot;</span><span class="fu">,</span></span>
-<span id="cb509-4"><a href="#cb509-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;_obscure&quot;</span><span class="fu">:</span> <span class="st">&quot;pass&quot;</span><span class="fu">,</span></span>
-<span id="cb509-5"><a href="#cb509-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;user&quot;</span><span class="fu">:</span> <span class="st">&quot;me&quot;</span><span class="fu">,</span></span>
-<span id="cb509-6"><a href="#cb509-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;pass&quot;</span><span class="fu">:</span> <span class="st">&quot;mypassword&quot;</span><span class="fu">,</span></span>
-<span id="cb509-7"><a href="#cb509-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;host&quot;</span><span class="fu">:</span> <span class="st">&quot;sftp.example.com&quot;</span></span>
-<span id="cb509-8"><a href="#cb509-8" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
+<div class="sourceCode" id="cb520"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb520-1"><a href="#cb520-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
+<span id="cb520-2"><a href="#cb520-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;type&quot;</span><span class="fu">:</span> <span class="st">&quot;sftp&quot;</span><span class="fu">,</span></span>
+<span id="cb520-3"><a href="#cb520-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;_root&quot;</span><span class="fu">:</span> <span class="st">&quot;&quot;</span><span class="fu">,</span></span>
+<span id="cb520-4"><a href="#cb520-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;_obscure&quot;</span><span class="fu">:</span> <span class="st">&quot;pass&quot;</span><span class="fu">,</span></span>
+<span id="cb520-5"><a href="#cb520-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;user&quot;</span><span class="fu">:</span> <span class="st">&quot;me&quot;</span><span class="fu">,</span></span>
+<span id="cb520-6"><a href="#cb520-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;pass&quot;</span><span class="fu">:</span> <span class="st">&quot;mypassword&quot;</span><span class="fu">,</span></span>
+<span id="cb520-7"><a href="#cb520-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;host&quot;</span><span class="fu">:</span> <span class="st">&quot;sftp.example.com&quot;</span></span>
+<span id="cb520-8"><a href="#cb520-8" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<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
@@ -10753,7 +10887,7 @@ 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 http remote:path [flags]</code></pre>
-<h2 id="options-80">Options</h2>
+<h2 id="options-81">Options</h2>
<pre><code> --addr stringArray IPaddress:Port or :Port to bind server to (default 127.0.0.1:8080)
--allow-origin string Origin which cross-domain request (CORS) can be executed from
--auth-proxy string A program to use to create the backend from the auth
@@ -10795,6 +10929,7 @@ backend that rclone supports.</p>
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
@@ -10834,7 +10969,7 @@ options not listed here.</p>
--metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin)
--min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
--min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre>
-<h2 id="see-also-80">See Also</h2>
+<h2 id="see-also-81">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
@@ -10844,7 +10979,7 @@ options not listed here.</p>
<!-- markdownlint-restore -->
<h1 id="rclone-serve-nfs">rclone serve nfs</h1>
<p>Serve the remote as an NFS mount</p>
-<h2 id="synopsis-74">Synopsis</h2>
+<h2 id="synopsis-75">Synopsis</h2>
<p>Create an NFS server that serves the given remote over the
network.</p>
<p>This implements an NFSv3 server to serve any rclone remote via
@@ -10893,12 +11028,12 @@ default is <code>1000000</code>, but consider lowering this limit if the
server's system resource usage causes problems. This is only used by the
<code>memory</code> type cache.</p>
<p>To serve NFS over the network use following command:</p>
-<div class="sourceCode" id="cb513"><pre
-class="sourceCode sh"><code class="sourceCode bash"><span id="cb513-1"><a href="#cb513-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> serve nfs remote: <span class="at">--addr</span> 0.0.0.0:<span class="va">$PORT</span> <span class="at">--vfs-cache-mode</span><span class="op">=</span>full</span></code></pre></div>
+<div class="sourceCode" id="cb524"><pre
+class="sourceCode sh"><code class="sourceCode bash"><span id="cb524-1"><a href="#cb524-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> serve nfs remote: <span class="at">--addr</span> 0.0.0.0:<span class="va">$PORT</span> <span class="at">--vfs-cache-mode</span><span class="op">=</span>full</span></code></pre></div>
<p>This specifies a port that can be used in the mount command. To mount
the server under Linux/macOS, use the following command:</p>
-<div class="sourceCode" id="cb514"><pre
-class="sourceCode sh"><code class="sourceCode bash"><span id="cb514-1"><a href="#cb514-1" aria-hidden="true" tabindex="-1"></a><span class="fu">mount</span> <span class="at">-t</span> nfs <span class="at">-o</span> port=<span class="va">$PORT</span>,mountport=<span class="va">$PORT</span>,tcp <span class="va">$HOSTNAME</span>:/ path/to/mountpoint</span></code></pre></div>
+<div class="sourceCode" id="cb525"><pre
+class="sourceCode sh"><code class="sourceCode bash"><span id="cb525-1"><a href="#cb525-1" aria-hidden="true" tabindex="-1"></a><span class="fu">mount</span> <span class="at">-t</span> nfs <span class="at">-o</span> port=<span class="va">$PORT</span>,mountport=<span class="va">$PORT</span>,tcp <span class="va">$HOSTNAME</span>:/ path/to/mountpoint</span></code></pre></div>
<p>Where <code>$PORT</code> is the same port number used in the
<code>serve nfs</code> command and <code>$HOSTNAME</code> is the network
address of the machine that <code>serve nfs</code> was run on.</p>
@@ -11301,7 +11436,7 @@ total 1048578
and if there is an error reading the metadata the error will be returned
as <code>{"error":"error string"}</code>.</p>
<pre><code>rclone serve nfs remote:path [flags]</code></pre>
-<h2 id="options-81">Options</h2>
+<h2 id="options-82">Options</h2>
<pre><code> --addr string IPaddress:Port or :Port to bind server to
--dir-cache-time Duration Time to cache directory entries for (default 5m0s)
--dir-perms FileMode Directory permissions (default 777)
@@ -11328,6 +11463,7 @@ as <code>{"error":"error string"}</code>.</p>
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
@@ -11367,7 +11503,7 @@ options not listed here.</p>
--metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin)
--min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
--min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre>
-<h2 id="see-also-81">See Also</h2>
+<h2 id="see-also-82">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
@@ -11377,7 +11513,7 @@ options not listed here.</p>
<!-- markdownlint-restore -->
<h1 id="rclone-serve-restic">rclone serve restic</h1>
<p>Serve the remote for restic's REST API.</p>
-<h2 id="synopsis-75">Synopsis</h2>
+<h2 id="synopsis-76">Synopsis</h2>
<p>Run a basic web server to serve a remote over restic's REST backend
API over HTTP. This allows restic to use rclone as a data storage
mechanism for cloud providers that restic does not support directly.</p>
@@ -11472,6 +11608,10 @@ serve. Rclone automatically inserts leading and trailing "/" on
are all treated identically.</p>
<p><code>--disable-zip</code> may be set to disable the zipping download
option.</p>
+<h3 id="protocol-2">Protocol</h3>
+<p>The server supports HTTP/1.1 and HTTP/2. HTTP/2 is used automatically
+for TLS connections. For non-TLS connections, HTTP/2 cleartext (h2c) is
+supported, allowing HTTP/2 without encryption.</p>
<h3 id="tls-ssl-2">TLS (SSL)</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
@@ -11527,7 +11667,7 @@ htpasswd -B htpasswd anotherUser</code></pre>
<p>Use <code>--salt</code> to change the password hashing salt from the
default.</p>
<pre><code>rclone serve restic remote:path [flags]</code></pre>
-<h2 id="options-82">Options</h2>
+<h2 id="options-83">Options</h2>
<pre><code> --addr stringArray IPaddress:Port or :Port to bind server to (default 127.0.0.1:8080)
--allow-origin string Origin which cross-domain request (CORS) can be executed from
--append-only Disallow deletion of repository data
@@ -11551,7 +11691,7 @@ default.</p>
--user-from-header string User name from a defined HTTP header</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>
+<h2 id="see-also-83">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
@@ -11561,7 +11701,7 @@ global options not listed here.</p>
<!-- markdownlint-restore -->
<h1 id="rclone-serve-s3">rclone serve s3</h1>
<p>Serve remote:path over s3.</p>
-<h2 id="synopsis-76">Synopsis</h2>
+<h2 id="synopsis-77">Synopsis</h2>
<p><code>serve s3</code> implements a basic s3 server that serves a
remote via s3. This can be viewed with an s3 client, or you can make an
<a href="https://rclone.org/s3/">s3 type remote</a> to read and write to
@@ -11608,9 +11748,9 @@ the server like this:</p>
with a command like this:</p>
<pre class="console"><code>rclone serve s3 --auth-key ACCESS_KEY_ID,SECRET_ACCESS_KEY local:/path/to/folder</code></pre>
<p>The <code>rclone.conf</code> for the server could look like this:</p>
-<div class="sourceCode" id="cb542"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb542-1"><a href="#cb542-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[local]</span></span>
-<span id="cb542-2"><a href="#cb542-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> local</span></span></code></pre></div>
+<div class="sourceCode" id="cb553"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb553-1"><a href="#cb553-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[local]</span></span>
+<span id="cb553-2"><a href="#cb553-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> local</span></span></code></pre></div>
<p>The <code>local</code> configuration is optional though. If you run
the server with a <code>remote:path</code> like
<code>/path/to/folder</code> (without the <code>local:</code> prefix and
@@ -11619,14 +11759,14 @@ default configuration, which will be visible as a warning in the logs.
But it will run nonetheless.</p>
<p>This will be compatible with an rclone (client) remote configuration
which is defined like this:</p>
-<div class="sourceCode" id="cb543"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb543-1"><a href="#cb543-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[serves3]</span></span>
-<span id="cb543-2"><a href="#cb543-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
-<span id="cb543-3"><a href="#cb543-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> Rclone</span></span>
-<span id="cb543-4"><a href="#cb543-4" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> http://127.0.0.1:8080/</span></span>
-<span id="cb543-5"><a href="#cb543-5" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> ACCESS_KEY_ID</span></span>
-<span id="cb543-6"><a href="#cb543-6" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> SECRET_ACCESS_KEY</span></span>
-<span id="cb543-7"><a href="#cb543-7" aria-hidden="true" tabindex="-1"></a><span class="dt">use_multipart_uploads </span><span class="ot">=</span><span class="st"> </span><span class="kw">false</span></span></code></pre></div>
+<div class="sourceCode" id="cb554"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb554-1"><a href="#cb554-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[serves3]</span></span>
+<span id="cb554-2"><a href="#cb554-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
+<span id="cb554-3"><a href="#cb554-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> Rclone</span></span>
+<span id="cb554-4"><a href="#cb554-4" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> http://127.0.0.1:8080/</span></span>
+<span id="cb554-5"><a href="#cb554-5" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> ACCESS_KEY_ID</span></span>
+<span id="cb554-6"><a href="#cb554-6" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> SECRET_ACCESS_KEY</span></span>
+<span id="cb554-7"><a href="#cb554-7" aria-hidden="true" tabindex="-1"></a><span class="dt">use_multipart_uploads </span><span class="ot">=</span><span class="st"> </span><span class="kw">false</span></span></code></pre></div>
<p>Note that setting <code>use_multipart_uploads = false</code> is to
work around <a href="#bugs">a bug</a> which will be fixed in due
course.</p>
@@ -11744,6 +11884,10 @@ serve. Rclone automatically inserts leading and trailing "/" on
are all treated identically.</p>
<p><code>--disable-zip</code> may be set to disable the zipping download
option.</p>
+<h3 id="protocol-3">Protocol</h3>
+<p>The server supports HTTP/1.1 and HTTP/2. HTTP/2 is used automatically
+for TLS connections. For non-TLS connections, HTTP/2 cleartext (h2c) is
+supported, allowing HTTP/2 without encryption.</p>
<h3 id="tls-ssl-3">TLS (SSL)</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
@@ -12164,7 +12308,7 @@ total 1048578
and if there is an error reading the metadata the error will be returned
as <code>{"error":"error string"}</code>.</p>
<pre><code>rclone serve s3 remote:path [flags]</code></pre>
-<h2 id="options-83">Options</h2>
+<h2 id="options-84">Options</h2>
<pre><code> --addr stringArray IPaddress:Port or :Port to bind server to (default 127.0.0.1:8080)
--allow-origin string Origin which cross-domain request (CORS) can be executed from
--auth-key stringArray Set key pair for v4 authorization: access_key_id,secret_access_key
@@ -12208,6 +12352,7 @@ as <code>{"error":"error string"}</code>.</p>
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
@@ -12247,7 +12392,7 @@ options not listed here.</p>
--metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin)
--min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
--min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre>
-<h2 id="see-also-83">See Also</h2>
+<h2 id="see-also-84">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
@@ -12257,7 +12402,7 @@ options not listed here.</p>
<!-- markdownlint-restore -->
<h1 id="rclone-serve-sftp">rclone serve sftp</h1>
<p>Serve the remote over SFTP.</p>
-<h2 id="synopsis-77">Synopsis</h2>
+<h2 id="synopsis-78">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>
@@ -12738,28 +12883,28 @@ obscure</li>
</ul>
<p>If password authentication was used by the client, input to the proxy
process (on STDIN) would look similar to this:</p>
-<div class="sourceCode" id="cb577"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb577-1"><a href="#cb577-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
-<span id="cb577-2"><a href="#cb577-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;user&quot;</span><span class="fu">:</span> <span class="st">&quot;me&quot;</span><span class="fu">,</span></span>
-<span id="cb577-3"><a href="#cb577-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;pass&quot;</span><span class="fu">:</span> <span class="st">&quot;mypassword&quot;</span></span>
-<span id="cb577-4"><a href="#cb577-4" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
+<div class="sourceCode" id="cb588"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb588-1"><a href="#cb588-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
+<span id="cb588-2"><a href="#cb588-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;user&quot;</span><span class="fu">:</span> <span class="st">&quot;me&quot;</span><span class="fu">,</span></span>
+<span id="cb588-3"><a href="#cb588-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;pass&quot;</span><span class="fu">:</span> <span class="st">&quot;mypassword&quot;</span></span>
+<span id="cb588-4"><a href="#cb588-4" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>If public-key authentication was used by the client, input to the
proxy process (on STDIN) would look similar to this:</p>
-<div class="sourceCode" id="cb578"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb578-1"><a href="#cb578-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
-<span id="cb578-2"><a href="#cb578-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;user&quot;</span><span class="fu">:</span> <span class="st">&quot;me&quot;</span><span class="fu">,</span></span>
-<span id="cb578-3"><a href="#cb578-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;public_key&quot;</span><span class="fu">:</span> <span class="st">&quot;AAAAB3NzaC1yc2EAAAADAQABAAABAQDuwESFdAe14hVS6omeyX7edc...JQdf&quot;</span></span>
-<span id="cb578-4"><a href="#cb578-4" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
+<div class="sourceCode" id="cb589"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb589-1"><a href="#cb589-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
+<span id="cb589-2"><a href="#cb589-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;user&quot;</span><span class="fu">:</span> <span class="st">&quot;me&quot;</span><span class="fu">,</span></span>
+<span id="cb589-3"><a href="#cb589-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;public_key&quot;</span><span class="fu">:</span> <span class="st">&quot;AAAAB3NzaC1yc2EAAAADAQABAAABAQDuwESFdAe14hVS6omeyX7edc...JQdf&quot;</span></span>
+<span id="cb589-4"><a href="#cb589-4" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>And as an example return this on STDOUT</p>
-<div class="sourceCode" id="cb579"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb579-1"><a href="#cb579-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
-<span id="cb579-2"><a href="#cb579-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;type&quot;</span><span class="fu">:</span> <span class="st">&quot;sftp&quot;</span><span class="fu">,</span></span>
-<span id="cb579-3"><a href="#cb579-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;_root&quot;</span><span class="fu">:</span> <span class="st">&quot;&quot;</span><span class="fu">,</span></span>
-<span id="cb579-4"><a href="#cb579-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;_obscure&quot;</span><span class="fu">:</span> <span class="st">&quot;pass&quot;</span><span class="fu">,</span></span>
-<span id="cb579-5"><a href="#cb579-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;user&quot;</span><span class="fu">:</span> <span class="st">&quot;me&quot;</span><span class="fu">,</span></span>
-<span id="cb579-6"><a href="#cb579-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;pass&quot;</span><span class="fu">:</span> <span class="st">&quot;mypassword&quot;</span><span class="fu">,</span></span>
-<span id="cb579-7"><a href="#cb579-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;host&quot;</span><span class="fu">:</span> <span class="st">&quot;sftp.example.com&quot;</span></span>
-<span id="cb579-8"><a href="#cb579-8" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
+<div class="sourceCode" id="cb590"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb590-1"><a href="#cb590-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
+<span id="cb590-2"><a href="#cb590-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;type&quot;</span><span class="fu">:</span> <span class="st">&quot;sftp&quot;</span><span class="fu">,</span></span>
+<span id="cb590-3"><a href="#cb590-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;_root&quot;</span><span class="fu">:</span> <span class="st">&quot;&quot;</span><span class="fu">,</span></span>
+<span id="cb590-4"><a href="#cb590-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;_obscure&quot;</span><span class="fu">:</span> <span class="st">&quot;pass&quot;</span><span class="fu">,</span></span>
+<span id="cb590-5"><a href="#cb590-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;user&quot;</span><span class="fu">:</span> <span class="st">&quot;me&quot;</span><span class="fu">,</span></span>
+<span id="cb590-6"><a href="#cb590-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;pass&quot;</span><span class="fu">:</span> <span class="st">&quot;mypassword&quot;</span><span class="fu">,</span></span>
+<span id="cb590-7"><a href="#cb590-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;host&quot;</span><span class="fu">:</span> <span class="st">&quot;sftp.example.com&quot;</span></span>
+<span id="cb590-8"><a href="#cb590-8" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<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
@@ -12780,7 +12925,7 @@ 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-84">Options</h2>
+<h2 id="options-85">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;)
@@ -12811,6 +12956,7 @@ backend that rclone supports.</p>
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
@@ -12850,7 +12996,7 @@ options not listed here.</p>
--metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin)
--min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
--min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre>
-<h2 id="see-also-84">See Also</h2>
+<h2 id="see-also-85">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
@@ -12860,7 +13006,7 @@ options not listed here.</p>
<!-- markdownlint-restore -->
<h1 id="rclone-serve-webdav">rclone serve webdav</h1>
<p>Serve remote:path over WebDAV.</p>
-<h2 id="synopsis-78">Synopsis</h2>
+<h2 id="synopsis-79">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
@@ -12909,6 +13055,15 @@ class="uri">https://learn.microsoft.com/en-us/office/troubleshoot/powerpoint/off
<pre class="console"><code>rclone --webdav-unix-socket /tmp/my.socket --webdav-url http://localhost lsf :webdav:</code></pre>
<p>Note that there is no authentication on http protocol - this is
expected to be done by the permissions on the socket.</p>
+<h2 id="symlinks-junction-points">Symlinks / Junction points</h2>
+<p>The webdav protocol does not support symlinks or junction points and
+by default rclone will skip them completely.</p>
+<p>You can use <code>-L</code> to get rclone to follow symlinks or you
+can use <code>--local-links</code> to make rclone show
+<code>.rclonelink</code> files in place of the symlinks.</p>
+<p><strong>NB</strong> Do not use <code>--links</code> as since v1.69
+this applies to the VFS layer too, use <code>--local-links</code> which
+only applies to the local backend only.</p>
<h2 id="server-options-6">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
@@ -12939,6 +13094,10 @@ serve. Rclone automatically inserts leading and trailing "/" on
are all treated identically.</p>
<p><code>--disable-zip</code> may be set to disable the zipping download
option.</p>
+<h3 id="protocol-4">Protocol</h3>
+<p>The server supports HTTP/1.1 and HTTP/2. HTTP/2 is used automatically
+for TLS connections. For non-TLS connections, HTTP/2 cleartext (h2c) is
+supported, allowing HTTP/2 without encryption.</p>
<h3 id="tls-ssl-4">TLS (SSL)</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
@@ -13551,28 +13710,28 @@ obscure</li>
</ul>
<p>If password authentication was used by the client, input to the proxy
process (on STDIN) would look similar to this:</p>
-<div class="sourceCode" id="cb602"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb602-1"><a href="#cb602-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
-<span id="cb602-2"><a href="#cb602-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;user&quot;</span><span class="fu">:</span> <span class="st">&quot;me&quot;</span><span class="fu">,</span></span>
-<span id="cb602-3"><a href="#cb602-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;pass&quot;</span><span class="fu">:</span> <span class="st">&quot;mypassword&quot;</span></span>
-<span id="cb602-4"><a href="#cb602-4" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
+<div class="sourceCode" id="cb613"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb613-1"><a href="#cb613-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
+<span id="cb613-2"><a href="#cb613-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;user&quot;</span><span class="fu">:</span> <span class="st">&quot;me&quot;</span><span class="fu">,</span></span>
+<span id="cb613-3"><a href="#cb613-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;pass&quot;</span><span class="fu">:</span> <span class="st">&quot;mypassword&quot;</span></span>
+<span id="cb613-4"><a href="#cb613-4" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>If public-key authentication was used by the client, input to the
proxy process (on STDIN) would look similar to this:</p>
-<div class="sourceCode" id="cb603"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb603-1"><a href="#cb603-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
-<span id="cb603-2"><a href="#cb603-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;user&quot;</span><span class="fu">:</span> <span class="st">&quot;me&quot;</span><span class="fu">,</span></span>
-<span id="cb603-3"><a href="#cb603-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;public_key&quot;</span><span class="fu">:</span> <span class="st">&quot;AAAAB3NzaC1yc2EAAAADAQABAAABAQDuwESFdAe14hVS6omeyX7edc...JQdf&quot;</span></span>
-<span id="cb603-4"><a href="#cb603-4" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
+<div class="sourceCode" id="cb614"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb614-1"><a href="#cb614-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
+<span id="cb614-2"><a href="#cb614-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;user&quot;</span><span class="fu">:</span> <span class="st">&quot;me&quot;</span><span class="fu">,</span></span>
+<span id="cb614-3"><a href="#cb614-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;public_key&quot;</span><span class="fu">:</span> <span class="st">&quot;AAAAB3NzaC1yc2EAAAADAQABAAABAQDuwESFdAe14hVS6omeyX7edc...JQdf&quot;</span></span>
+<span id="cb614-4"><a href="#cb614-4" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>And as an example return this on STDOUT</p>
-<div class="sourceCode" id="cb604"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb604-1"><a href="#cb604-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
-<span id="cb604-2"><a href="#cb604-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;type&quot;</span><span class="fu">:</span> <span class="st">&quot;sftp&quot;</span><span class="fu">,</span></span>
-<span id="cb604-3"><a href="#cb604-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;_root&quot;</span><span class="fu">:</span> <span class="st">&quot;&quot;</span><span class="fu">,</span></span>
-<span id="cb604-4"><a href="#cb604-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;_obscure&quot;</span><span class="fu">:</span> <span class="st">&quot;pass&quot;</span><span class="fu">,</span></span>
-<span id="cb604-5"><a href="#cb604-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;user&quot;</span><span class="fu">:</span> <span class="st">&quot;me&quot;</span><span class="fu">,</span></span>
-<span id="cb604-6"><a href="#cb604-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;pass&quot;</span><span class="fu">:</span> <span class="st">&quot;mypassword&quot;</span><span class="fu">,</span></span>
-<span id="cb604-7"><a href="#cb604-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;host&quot;</span><span class="fu">:</span> <span class="st">&quot;sftp.example.com&quot;</span></span>
-<span id="cb604-8"><a href="#cb604-8" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
+<div class="sourceCode" id="cb615"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb615-1"><a href="#cb615-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
+<span id="cb615-2"><a href="#cb615-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;type&quot;</span><span class="fu">:</span> <span class="st">&quot;sftp&quot;</span><span class="fu">,</span></span>
+<span id="cb615-3"><a href="#cb615-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;_root&quot;</span><span class="fu">:</span> <span class="st">&quot;&quot;</span><span class="fu">,</span></span>
+<span id="cb615-4"><a href="#cb615-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;_obscure&quot;</span><span class="fu">:</span> <span class="st">&quot;pass&quot;</span><span class="fu">,</span></span>
+<span id="cb615-5"><a href="#cb615-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;user&quot;</span><span class="fu">:</span> <span class="st">&quot;me&quot;</span><span class="fu">,</span></span>
+<span id="cb615-6"><a href="#cb615-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;pass&quot;</span><span class="fu">:</span> <span class="st">&quot;mypassword&quot;</span><span class="fu">,</span></span>
+<span id="cb615-7"><a href="#cb615-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;host&quot;</span><span class="fu">:</span> <span class="st">&quot;sftp.example.com&quot;</span></span>
+<span id="cb615-8"><a href="#cb615-8" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<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
@@ -13593,7 +13752,7 @@ 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-85">Options</h2>
+<h2 id="options-86">Options</h2>
<pre><code> --addr stringArray IPaddress:Port or :Port to bind server to (default 127.0.0.1:8080)
--allow-origin string Origin which cross-domain request (CORS) can be executed from
--auth-proxy string A program to use to create the backend from the auth
@@ -13637,6 +13796,7 @@ backend that rclone supports.</p>
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a &#39;.rclonelink&#39; extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
@@ -13676,7 +13836,7 @@ options not listed here.</p>
--metadata-include-from stringArray Read metadata include patterns from file (use - to read from stdin)
--min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
--min-size SizeSuffix Only transfer files bigger than this in KiB or suffix B|K|M|G|T|P (default off)</code></pre>
-<h2 id="see-also-85">See Also</h2>
+<h2 id="see-also-86">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
@@ -13686,7 +13846,7 @@ options not listed here.</p>
<!-- markdownlint-restore -->
<h1 id="rclone-settier">rclone settier</h1>
<p>Changes storage class/tier of objects in remote.</p>
-<h2 id="synopsis-79">Synopsis</h2>
+<h2 id="synopsis-80">Synopsis</h2>
<p>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,
@@ -13703,11 +13863,11 @@ similarly S3 to Glacier makes object inaccessible.true</p>
tiered</p>
<pre class="console"><code>rclone settier tier remote:path/dir</code></pre>
<pre><code>rclone settier tier remote:path [flags]</code></pre>
-<h2 id="options-86">Options</h2>
+<h2 id="options-87">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-86">See Also</h2>
+<h2 id="see-also-87">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
@@ -13717,7 +13877,7 @@ for rclone commands, flags and backends.</li>
<!-- markdownlint-restore -->
<h1 id="rclone-test">rclone test</h1>
<p>Run a test command</p>
-<h2 id="synopsis-80">Synopsis</h2>
+<h2 id="synopsis-81">Synopsis</h2>
<p>Rclone test is used to run test commands.</p>
<p>Select which test command you want with the subcommand, eg</p>
<pre class="console"><code>rclone test memory remote:</code></pre>
@@ -13725,11 +13885,11 @@ for rclone commands, flags and backends.</li>
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-87">Options</h2>
+<h2 id="options-88">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-87">See Also</h2>
+<h2 id="see-also-88">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
@@ -13758,12 +13918,12 @@ speed</a> - Run a speed test to the remote</li>
<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-88">Options</h2>
+<h2 id="options-89">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-88">See Also</h2>
+<h2 id="see-also-89">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
@@ -13773,17 +13933,17 @@ Run a test command</li>
<!-- markdownlint-restore -->
<h1 id="rclone-test-histogram">rclone test histogram</h1>
<p>Makes a histogram of file name characters.</p>
-<h2 id="synopsis-81">Synopsis</h2>
+<h2 id="synopsis-82">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-89">Options</h2>
+<h2 id="options-90">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-89">See Also</h2>
+<h2 id="see-also-90">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
@@ -13793,7 +13953,7 @@ Run a test command</li>
<!-- markdownlint-restore -->
<h1 id="rclone-test-info">rclone test info</h1>
<p>Discovers file name or other limitations for paths.</p>
-<h2 id="synopsis-82">Synopsis</h2>
+<h2 id="synopsis-83">Synopsis</h2>
<p>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
@@ -13801,7 +13961,7 @@ 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-90">Options</h2>
+<h2 id="options-91">Options</h2>
<pre><code> --all Run all tests
--check-base32768 Check can store all possible base32768 characters
--check-control Check control characters
@@ -13814,7 +13974,7 @@ hazards - use with care!</p>
--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-90">See Also</h2>
+<h2 id="see-also-91">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
@@ -13825,7 +13985,7 @@ Run a test command</li>
<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-91">Options</h2>
+<h2 id="options-92">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
@@ -13835,7 +13995,7 @@ Run a test command</li>
--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-91">See Also</h2>
+<h2 id="see-also-92">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
@@ -13846,7 +14006,7 @@ Run a test command</li>
<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-92">Options</h2>
+<h2 id="options-93">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)
@@ -13864,7 +14024,7 @@ Run a test command</li>
--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-92">See Also</h2>
+<h2 id="see-also-93">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
@@ -13876,11 +14036,11 @@ Run a test command</li>
<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-93">Options</h2>
+<h2 id="options-94">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-93">See Also</h2>
+<h2 id="see-also-94">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
@@ -13890,7 +14050,7 @@ Run a test command</li>
<!-- markdownlint-restore -->
<h1 id="rclone-test-speed">rclone test speed</h1>
<p>Run a speed test to the remote</p>
-<h2 id="synopsis-83">Synopsis</h2>
+<h2 id="synopsis-84">Synopsis</h2>
<p>Run a speed test to the remote.</p>
<p>This command runs a series of uploads and downloads to the remote,
measuring and printing the speed of each test using varying file sizes
@@ -13906,7 +14066,7 @@ on a clean exit.</p>
<p>You can use the --json flag to only print the results in JSON
format.</p>
<pre><code>rclone test speed &lt;remote&gt; [flags]</code></pre>
-<h2 id="options-94">Options</h2>
+<h2 id="options-95">Options</h2>
<pre><code> --ascii Fill files with random ASCII printable bytes only
--chargen Fill files with a ASCII chargen pattern
--file-cap int Maximum number of files to use in each test (default 100)
@@ -13922,7 +14082,7 @@ format.</p>
--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-94">See Also</h2>
+<h2 id="see-also-95">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
@@ -13932,7 +14092,7 @@ Run a test command</li>
<!-- markdownlint-restore -->
<h1 id="rclone-touch">rclone touch</h1>
<p>Create new file or change file modification time.</p>
-<h2 id="synopsis-84">Synopsis</h2>
+<h2 id="synopsis-85">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,
@@ -13953,8 +14113,11 @@ of:</p>
</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>
+<p>Metadata can be added when creating a new file with
+<code>--metadata-set</code>. For example: rclone touch remote:path -M
+--metadata-set key=value</p>
<pre><code>rclone touch remote:path [flags]</code></pre>
-<h2 id="options-95">Options</h2>
+<h2 id="options-96">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)
@@ -13997,7 +14160,7 @@ options not listed here.</p>
<p>Flags for listing directories</p>
<pre class="text"><code> --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
--fast-list Use recursive list if available; uses more memory but fewer transactions</code></pre>
-<h2 id="see-also-95">See Also</h2>
+<h2 id="see-also-96">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
@@ -14007,7 +14170,7 @@ for rclone commands, flags and backends.</li>
<!-- markdownlint-restore -->
<h1 id="rclone-tree">rclone tree</h1>
<p>List the contents of the remote in a tree like fashion.</p>
-<h2 id="synopsis-85">Synopsis</h2>
+<h2 id="synopsis-86">Synopsis</h2>
<p>Lists the contents of a remote in a similar way to the unix tree
command.</p>
<p>For example</p>
@@ -14031,7 +14194,7 @@ 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-96">Options</h2>
+<h2 id="options-97">Options</h2>
<pre><code> -a, --all All files are listed (list . files too)
-d, --dirs-only List directories only
--dirsfirst List directories before files (-U disables)
@@ -14083,7 +14246,7 @@ options not listed here.</p>
<p>Flags for listing directories</p>
<pre class="text"><code> --default-time Time Time to show if modtime is unknown for files and directories (default 2000-01-01T00:00:00Z)
--fast-list Use recursive list if available; uses more memory but fewer transactions</code></pre>
-<h2 id="see-also-96">See Also</h2>
+<h2 id="see-also-97">See Also</h2>
<!-- markdownlint-capture -->
<!-- markdownlint-disable ul-style line-length -->
<ul>
@@ -14276,11 +14439,11 @@ infrastructure without a proper certificate. You could supply the
<code>--no-check-certificate</code> flag to rclone, but this will affect
<strong>all</strong> the remotes. To make it just affect this remote you
use an override. You could put this in the config file:</p>
-<div class="sourceCode" id="cb663"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb663-1"><a href="#cb663-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[remote]</span></span>
-<span id="cb663-2"><a href="#cb663-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> XXX</span></span>
-<span id="cb663-3"><a href="#cb663-3" aria-hidden="true" tabindex="-1"></a><span class="dt">...</span></span>
-<span id="cb663-4"><a href="#cb663-4" aria-hidden="true" tabindex="-1"></a><span class="dt">override.no_check_certificate </span><span class="ot">=</span><span class="st"> </span><span class="kw">true</span></span></code></pre></div>
+<div class="sourceCode" id="cb674"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb674-1"><a href="#cb674-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[remote]</span></span>
+<span id="cb674-2"><a href="#cb674-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> XXX</span></span>
+<span id="cb674-3"><a href="#cb674-3" aria-hidden="true" tabindex="-1"></a><span class="dt">...</span></span>
+<span id="cb674-4"><a href="#cb674-4" aria-hidden="true" tabindex="-1"></a><span class="dt">override.no_check_certificate </span><span class="ot">=</span><span class="st"> </span><span class="kw">true</span></span></code></pre></div>
<p>or use it in the connection string
<code>remote,override.no_check_certificate=true:</code> (or just
<code>remote,override.no_check_certificate:</code>).</p>
@@ -14324,11 +14487,11 @@ as an <code>override</code>. For example, say you have a remote where
you would always like to use the <code>--checksum</code> flag. You could
supply the <code>--checksum</code> flag to rclone on every command line,
but instead you could put this in the config file:</p>
-<div class="sourceCode" id="cb664"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb664-1"><a href="#cb664-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[remote]</span></span>
-<span id="cb664-2"><a href="#cb664-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> XXX</span></span>
-<span id="cb664-3"><a href="#cb664-3" aria-hidden="true" tabindex="-1"></a><span class="dt">...</span></span>
-<span id="cb664-4"><a href="#cb664-4" aria-hidden="true" tabindex="-1"></a><span class="dt">global.checksum </span><span class="ot">=</span><span class="st"> </span><span class="kw">true</span></span></code></pre></div>
+<div class="sourceCode" id="cb675"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb675-1"><a href="#cb675-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[remote]</span></span>
+<span id="cb675-2"><a href="#cb675-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> XXX</span></span>
+<span id="cb675-3"><a href="#cb675-3" aria-hidden="true" tabindex="-1"></a><span class="dt">...</span></span>
+<span id="cb675-4"><a href="#cb675-4" aria-hidden="true" tabindex="-1"></a><span class="dt">global.checksum </span><span class="ot">=</span><span class="st"> </span><span class="kw">true</span></span></code></pre></div>
<p>or use it in the connection string
<code>remote,global.checksum=true:</code> (or just
<code>remote,global.checksum:</code>). This is equivalent to using the
@@ -14364,13 +14527,13 @@ shell.</p>
<h3 id="windows-1">Windows</h3>
<p>If your names have spaces in you need to put them in <code>"</code>,
e.g.</p>
-<div class="sourceCode" id="cb667"><pre
-class="sourceCode bat"><code class="sourceCode dosbat"><span id="cb667-1"><a href="#cb667-1" aria-hidden="true" tabindex="-1"></a>rclone copy <span class="st">&quot;E:\folder name\folder name\folder name&quot;</span> remote:backup</span></code></pre></div>
+<div class="sourceCode" id="cb678"><pre
+class="sourceCode bat"><code class="sourceCode dosbat"><span id="cb678-1"><a href="#cb678-1" aria-hidden="true" tabindex="-1"></a>rclone copy <span class="st">&quot;E:\folder name\folder name\folder name&quot;</span> remote:backup</span></code></pre></div>
<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>
-<div class="sourceCode" id="cb668"><pre
-class="sourceCode bat"><code class="sourceCode dosbat"><span id="cb668-1"><a href="#cb668-1" aria-hidden="true" tabindex="-1"></a>rclone copy E:\ remote:backup</span></code></pre></div>
+<div class="sourceCode" id="cb679"><pre
+class="sourceCode bat"><code class="sourceCode dosbat"><span id="cb679-1"><a href="#cb679-1" aria-hidden="true" tabindex="-1"></a>rclone copy E:\ remote:backup</span></code></pre></div>
<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
@@ -14590,7 +14753,7 @@ 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-97">Options</h2>
+<h2 id="options-98">Options</h2>
<p>Rclone has a number of options to control its behaviour. These are
documented below, and in the <a href="/flags">flags</a> page.</p>
<p>Options that take parameters can have the values passed in two ways,
@@ -14983,11 +15146,11 @@ 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>
-<div class="sourceCode" id="cb682"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb682-1"><a href="#cb682-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[megaremote]</span></span>
-<span id="cb682-2"><a href="#cb682-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> mega</span></span>
-<span id="cb682-3"><a href="#cb682-3" aria-hidden="true" tabindex="-1"></a><span class="dt">user </span><span class="ot">=</span><span class="st"> [email protected]</span></span>
-<span id="cb682-4"><a href="#cb682-4" aria-hidden="true" tabindex="-1"></a><span class="dt">pass </span><span class="ot">=</span><span class="st"> PDPcQVVjVtzFY-GTdDFozqBhTdsPg3qH</span></span></code></pre></div>
+<div class="sourceCode" id="cb693"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb693-1"><a href="#cb693-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[megaremote]</span></span>
+<span id="cb693-2"><a href="#cb693-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> mega</span></span>
+<span id="cb693-3"><a href="#cb693-3" aria-hidden="true" tabindex="-1"></a><span class="dt">user </span><span class="ot">=</span><span class="st"> [email protected]</span></span>
+<span id="cb693-4"><a href="#cb693-4" aria-hidden="true" tabindex="-1"></a><span class="dt">pass </span><span class="ot">=</span><span class="st"> PDPcQVVjVtzFY-GTdDFozqBhTdsPg3qH</span></span></code></pre></div>
<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
@@ -15507,49 +15670,49 @@ complete log file is not strictly valid JSON and needs a parser that can
handle it.</p>
<p>The JSON logs will be printed on a single line, but are shown
expanded here for clarity.</p>
-<div class="sourceCode" id="cb695"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb695-1"><a href="#cb695-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
-<span id="cb695-2"><a href="#cb695-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;time&quot;</span><span class="fu">:</span> <span class="st">&quot;2025-05-13T17:30:51.036237518+01:00&quot;</span><span class="fu">,</span></span>
-<span id="cb695-3"><a href="#cb695-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;level&quot;</span><span class="fu">:</span> <span class="st">&quot;debug&quot;</span><span class="fu">,</span></span>
-<span id="cb695-4"><a href="#cb695-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;msg&quot;</span><span class="fu">:</span> <span class="st">&quot;4 go routines active</span><span class="ch">\n</span><span class="st">&quot;</span><span class="fu">,</span></span>
-<span id="cb695-5"><a href="#cb695-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;source&quot;</span><span class="fu">:</span> <span class="st">&quot;cmd/cmd.go:298&quot;</span></span>
-<span id="cb695-6"><a href="#cb695-6" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
+<div class="sourceCode" id="cb706"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb706-1"><a href="#cb706-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
+<span id="cb706-2"><a href="#cb706-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;time&quot;</span><span class="fu">:</span> <span class="st">&quot;2025-05-13T17:30:51.036237518+01:00&quot;</span><span class="fu">,</span></span>
+<span id="cb706-3"><a href="#cb706-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;level&quot;</span><span class="fu">:</span> <span class="st">&quot;debug&quot;</span><span class="fu">,</span></span>
+<span id="cb706-4"><a href="#cb706-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;msg&quot;</span><span class="fu">:</span> <span class="st">&quot;4 go routines active</span><span class="ch">\n</span><span class="st">&quot;</span><span class="fu">,</span></span>
+<span id="cb706-5"><a href="#cb706-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;source&quot;</span><span class="fu">:</span> <span class="st">&quot;cmd/cmd.go:298&quot;</span></span>
+<span id="cb706-6"><a href="#cb706-6" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>Completed data transfer logs will have extra <code>size</code>
information. Logs which are about a particular object will have
<code>object</code> and <code>objectType</code> fields also.</p>
-<div class="sourceCode" id="cb696"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb696-1"><a href="#cb696-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
-<span id="cb696-2"><a href="#cb696-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;time&quot;</span><span class="fu">:</span> <span class="st">&quot;2025-05-13T17:38:05.540846352+01:00&quot;</span><span class="fu">,</span></span>
-<span id="cb696-3"><a href="#cb696-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;level&quot;</span><span class="fu">:</span> <span class="st">&quot;info&quot;</span><span class="fu">,</span></span>
-<span id="cb696-4"><a href="#cb696-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;msg&quot;</span><span class="fu">:</span> <span class="st">&quot;Copied (new) to: file2.txt&quot;</span><span class="fu">,</span></span>
-<span id="cb696-5"><a href="#cb696-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;size&quot;</span><span class="fu">:</span> <span class="dv">6</span><span class="fu">,</span></span>
-<span id="cb696-6"><a href="#cb696-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;object&quot;</span><span class="fu">:</span> <span class="st">&quot;file.txt&quot;</span><span class="fu">,</span></span>
-<span id="cb696-7"><a href="#cb696-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;objectType&quot;</span><span class="fu">:</span> <span class="st">&quot;*local.Object&quot;</span><span class="fu">,</span></span>
-<span id="cb696-8"><a href="#cb696-8" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;source&quot;</span><span class="fu">:</span> <span class="st">&quot;operations/copy.go:368&quot;</span></span>
-<span id="cb696-9"><a href="#cb696-9" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
+<div class="sourceCode" id="cb707"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb707-1"><a href="#cb707-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
+<span id="cb707-2"><a href="#cb707-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;time&quot;</span><span class="fu">:</span> <span class="st">&quot;2025-05-13T17:38:05.540846352+01:00&quot;</span><span class="fu">,</span></span>
+<span id="cb707-3"><a href="#cb707-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;level&quot;</span><span class="fu">:</span> <span class="st">&quot;info&quot;</span><span class="fu">,</span></span>
+<span id="cb707-4"><a href="#cb707-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;msg&quot;</span><span class="fu">:</span> <span class="st">&quot;Copied (new) to: file2.txt&quot;</span><span class="fu">,</span></span>
+<span id="cb707-5"><a href="#cb707-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;size&quot;</span><span class="fu">:</span> <span class="dv">6</span><span class="fu">,</span></span>
+<span id="cb707-6"><a href="#cb707-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;object&quot;</span><span class="fu">:</span> <span class="st">&quot;file.txt&quot;</span><span class="fu">,</span></span>
+<span id="cb707-7"><a href="#cb707-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;objectType&quot;</span><span class="fu">:</span> <span class="st">&quot;*local.Object&quot;</span><span class="fu">,</span></span>
+<span id="cb707-8"><a href="#cb707-8" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;source&quot;</span><span class="fu">:</span> <span class="st">&quot;operations/copy.go:368&quot;</span></span>
+<span id="cb707-9"><a href="#cb707-9" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>Stats logs will contain a <code>stats</code> field which is the same
as returned from the rc call <a
href="https://rclone.org/rc/#core-stats">core/stats</a>.</p>
-<div class="sourceCode" id="cb697"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb697-1"><a href="#cb697-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
-<span id="cb697-2"><a href="#cb697-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;time&quot;</span><span class="fu">:</span> <span class="st">&quot;2025-05-13T17:38:05.540912847+01:00&quot;</span><span class="fu">,</span></span>
-<span id="cb697-3"><a href="#cb697-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;level&quot;</span><span class="fu">:</span> <span class="st">&quot;info&quot;</span><span class="fu">,</span></span>
-<span id="cb697-4"><a href="#cb697-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;msg&quot;</span><span class="fu">:</span> <span class="st">&quot;...text version of the stats...&quot;</span><span class="fu">,</span></span>
-<span id="cb697-5"><a href="#cb697-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;stats&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
-<span id="cb697-6"><a href="#cb697-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;bytes&quot;</span><span class="fu">:</span> <span class="dv">6</span><span class="fu">,</span></span>
-<span id="cb697-7"><a href="#cb697-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;checks&quot;</span><span class="fu">:</span> <span class="dv">0</span><span class="fu">,</span></span>
-<span id="cb697-8"><a href="#cb697-8" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;deletedDirs&quot;</span><span class="fu">:</span> <span class="dv">0</span><span class="fu">,</span></span>
-<span id="cb697-9"><a href="#cb697-9" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;deletes&quot;</span><span class="fu">:</span> <span class="dv">0</span><span class="fu">,</span></span>
-<span id="cb697-10"><a href="#cb697-10" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;elapsedTime&quot;</span><span class="fu">:</span> <span class="fl">0.000904825</span><span class="fu">,</span></span>
-<span id="cb697-11"><a href="#cb697-11" aria-hidden="true" tabindex="-1"></a> <span class="er">...truncated</span> <span class="er">for</span> <span class="er">clarity...</span></span>
-<span id="cb697-12"><a href="#cb697-12" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;totalBytes&quot;</span><span class="fu">:</span> <span class="dv">6</span><span class="fu">,</span></span>
-<span id="cb697-13"><a href="#cb697-13" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;totalChecks&quot;</span><span class="fu">:</span> <span class="dv">0</span><span class="fu">,</span></span>
-<span id="cb697-14"><a href="#cb697-14" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;totalTransfers&quot;</span><span class="fu">:</span> <span class="dv">1</span><span class="fu">,</span></span>
-<span id="cb697-15"><a href="#cb697-15" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;transferTime&quot;</span><span class="fu">:</span> <span class="fl">0.000882794</span><span class="fu">,</span></span>
-<span id="cb697-16"><a href="#cb697-16" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;transfers&quot;</span><span class="fu">:</span> <span class="dv">1</span></span>
-<span id="cb697-17"><a href="#cb697-17" aria-hidden="true" tabindex="-1"></a> <span class="fu">},</span></span>
-<span id="cb697-18"><a href="#cb697-18" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;source&quot;</span><span class="fu">:</span> <span class="st">&quot;accounting/stats.go:569&quot;</span></span>
-<span id="cb697-19"><a href="#cb697-19" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
+<div class="sourceCode" id="cb708"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb708-1"><a href="#cb708-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
+<span id="cb708-2"><a href="#cb708-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;time&quot;</span><span class="fu">:</span> <span class="st">&quot;2025-05-13T17:38:05.540912847+01:00&quot;</span><span class="fu">,</span></span>
+<span id="cb708-3"><a href="#cb708-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;level&quot;</span><span class="fu">:</span> <span class="st">&quot;info&quot;</span><span class="fu">,</span></span>
+<span id="cb708-4"><a href="#cb708-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;msg&quot;</span><span class="fu">:</span> <span class="st">&quot;...text version of the stats...&quot;</span><span class="fu">,</span></span>
+<span id="cb708-5"><a href="#cb708-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;stats&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
+<span id="cb708-6"><a href="#cb708-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;bytes&quot;</span><span class="fu">:</span> <span class="dv">6</span><span class="fu">,</span></span>
+<span id="cb708-7"><a href="#cb708-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;checks&quot;</span><span class="fu">:</span> <span class="dv">0</span><span class="fu">,</span></span>
+<span id="cb708-8"><a href="#cb708-8" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;deletedDirs&quot;</span><span class="fu">:</span> <span class="dv">0</span><span class="fu">,</span></span>
+<span id="cb708-9"><a href="#cb708-9" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;deletes&quot;</span><span class="fu">:</span> <span class="dv">0</span><span class="fu">,</span></span>
+<span id="cb708-10"><a href="#cb708-10" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;elapsedTime&quot;</span><span class="fu">:</span> <span class="fl">0.000904825</span><span class="fu">,</span></span>
+<span id="cb708-11"><a href="#cb708-11" aria-hidden="true" tabindex="-1"></a> <span class="er">...truncated</span> <span class="er">for</span> <span class="er">clarity...</span></span>
+<span id="cb708-12"><a href="#cb708-12" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;totalBytes&quot;</span><span class="fu">:</span> <span class="dv">6</span><span class="fu">,</span></span>
+<span id="cb708-13"><a href="#cb708-13" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;totalChecks&quot;</span><span class="fu">:</span> <span class="dv">0</span><span class="fu">,</span></span>
+<span id="cb708-14"><a href="#cb708-14" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;totalTransfers&quot;</span><span class="fu">:</span> <span class="dv">1</span><span class="fu">,</span></span>
+<span id="cb708-15"><a href="#cb708-15" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;transferTime&quot;</span><span class="fu">:</span> <span class="fl">0.000882794</span><span class="fu">,</span></span>
+<span id="cb708-16"><a href="#cb708-16" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;transfers&quot;</span><span class="fu">:</span> <span class="dv">1</span></span>
+<span id="cb708-17"><a href="#cb708-17" aria-hidden="true" tabindex="-1"></a> <span class="fu">},</span></span>
+<span id="cb708-18"><a href="#cb708-18" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;source&quot;</span><span class="fu">:</span> <span class="st">&quot;accounting/stats.go:569&quot;</span></span>
+<span id="cb708-19"><a href="#cb708-19" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<h3 id="low-level-retries-int">--low-level-retries int</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
@@ -15659,7 +15822,7 @@ reaches the limit. This is the default.</p>
reaches the limit.</p>
<p><code>CAUTIOUS</code> will try to prevent rclone from reaching the
limit. Only applicable for <code>--max-transfer</code>.</p>
-<h2 id="m---metadata">-M, --metadata</h2>
+<h3 id="m---metadata">-M, --metadata</h3>
<p>Setting this flag enables rclone to copy the metadata from the source
to the destination. For local backends this is ownership, permissions,
xattr etc. See the <a href="#metadata">metadata section</a> for more
@@ -15704,63 +15867,63 @@ known.</li>
<li><code>Metadata</code> is the backend specific metadata as described
in the backend docs.</li>
</ul>
-<div class="sourceCode" id="cb699"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb699-1"><a href="#cb699-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
-<span id="cb699-2"><a href="#cb699-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;SrcFs&quot;</span><span class="fu">:</span> <span class="st">&quot;gdrive:&quot;</span><span class="fu">,</span></span>
-<span id="cb699-3"><a href="#cb699-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;SrcFsType&quot;</span><span class="fu">:</span> <span class="st">&quot;drive&quot;</span><span class="fu">,</span></span>
-<span id="cb699-4"><a href="#cb699-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;DstFs&quot;</span><span class="fu">:</span> <span class="st">&quot;newdrive:user&quot;</span><span class="fu">,</span></span>
-<span id="cb699-5"><a href="#cb699-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;DstFsType&quot;</span><span class="fu">:</span> <span class="st">&quot;onedrive&quot;</span><span class="fu">,</span></span>
-<span id="cb699-6"><a href="#cb699-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Remote&quot;</span><span class="fu">:</span> <span class="st">&quot;test.txt&quot;</span><span class="fu">,</span></span>
-<span id="cb699-7"><a href="#cb699-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Size&quot;</span><span class="fu">:</span> <span class="dv">6</span><span class="fu">,</span></span>
-<span id="cb699-8"><a href="#cb699-8" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;MimeType&quot;</span><span class="fu">:</span> <span class="st">&quot;text/plain; charset=utf-8&quot;</span><span class="fu">,</span></span>
-<span id="cb699-9"><a href="#cb699-9" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;ModTime&quot;</span><span class="fu">:</span> <span class="st">&quot;2022-10-11T17:53:10.286745272+01:00&quot;</span><span class="fu">,</span></span>
-<span id="cb699-10"><a href="#cb699-10" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;IsDir&quot;</span><span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span></span>
-<span id="cb699-11"><a href="#cb699-11" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;ID&quot;</span><span class="fu">:</span> <span class="st">&quot;xyz&quot;</span><span class="fu">,</span></span>
-<span id="cb699-12"><a href="#cb699-12" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Metadata&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
-<span id="cb699-13"><a href="#cb699-13" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;btime&quot;</span><span class="fu">:</span> <span class="st">&quot;2022-10-11T16:53:11Z&quot;</span><span class="fu">,</span></span>
-<span id="cb699-14"><a href="#cb699-14" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;content-type&quot;</span><span class="fu">:</span> <span class="st">&quot;text/plain; charset=utf-8&quot;</span><span class="fu">,</span></span>
-<span id="cb699-15"><a href="#cb699-15" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;mtime&quot;</span><span class="fu">:</span> <span class="st">&quot;2022-10-11T17:53:10.286745272+01:00&quot;</span><span class="fu">,</span></span>
-<span id="cb699-16"><a href="#cb699-16" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;owner&quot;</span><span class="fu">:</span> <span class="st">&quot;[email protected]&quot;</span><span class="fu">,</span></span>
-<span id="cb699-17"><a href="#cb699-17" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;permissions&quot;</span><span class="fu">:</span> <span class="st">&quot;...&quot;</span><span class="fu">,</span></span>
-<span id="cb699-18"><a href="#cb699-18" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;description&quot;</span><span class="fu">:</span> <span class="st">&quot;my nice file&quot;</span><span class="fu">,</span></span>
-<span id="cb699-19"><a href="#cb699-19" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;starred&quot;</span><span class="fu">:</span> <span class="st">&quot;false&quot;</span></span>
-<span id="cb699-20"><a href="#cb699-20" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
-<span id="cb699-21"><a href="#cb699-21" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
+<div class="sourceCode" id="cb710"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb710-1"><a href="#cb710-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
+<span id="cb710-2"><a href="#cb710-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;SrcFs&quot;</span><span class="fu">:</span> <span class="st">&quot;gdrive:&quot;</span><span class="fu">,</span></span>
+<span id="cb710-3"><a href="#cb710-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;SrcFsType&quot;</span><span class="fu">:</span> <span class="st">&quot;drive&quot;</span><span class="fu">,</span></span>
+<span id="cb710-4"><a href="#cb710-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;DstFs&quot;</span><span class="fu">:</span> <span class="st">&quot;newdrive:user&quot;</span><span class="fu">,</span></span>
+<span id="cb710-5"><a href="#cb710-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;DstFsType&quot;</span><span class="fu">:</span> <span class="st">&quot;onedrive&quot;</span><span class="fu">,</span></span>
+<span id="cb710-6"><a href="#cb710-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Remote&quot;</span><span class="fu">:</span> <span class="st">&quot;test.txt&quot;</span><span class="fu">,</span></span>
+<span id="cb710-7"><a href="#cb710-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Size&quot;</span><span class="fu">:</span> <span class="dv">6</span><span class="fu">,</span></span>
+<span id="cb710-8"><a href="#cb710-8" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;MimeType&quot;</span><span class="fu">:</span> <span class="st">&quot;text/plain; charset=utf-8&quot;</span><span class="fu">,</span></span>
+<span id="cb710-9"><a href="#cb710-9" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;ModTime&quot;</span><span class="fu">:</span> <span class="st">&quot;2022-10-11T17:53:10.286745272+01:00&quot;</span><span class="fu">,</span></span>
+<span id="cb710-10"><a href="#cb710-10" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;IsDir&quot;</span><span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span></span>
+<span id="cb710-11"><a href="#cb710-11" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;ID&quot;</span><span class="fu">:</span> <span class="st">&quot;xyz&quot;</span><span class="fu">,</span></span>
+<span id="cb710-12"><a href="#cb710-12" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Metadata&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
+<span id="cb710-13"><a href="#cb710-13" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;btime&quot;</span><span class="fu">:</span> <span class="st">&quot;2022-10-11T16:53:11Z&quot;</span><span class="fu">,</span></span>
+<span id="cb710-14"><a href="#cb710-14" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;content-type&quot;</span><span class="fu">:</span> <span class="st">&quot;text/plain; charset=utf-8&quot;</span><span class="fu">,</span></span>
+<span id="cb710-15"><a href="#cb710-15" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;mtime&quot;</span><span class="fu">:</span> <span class="st">&quot;2022-10-11T17:53:10.286745272+01:00&quot;</span><span class="fu">,</span></span>
+<span id="cb710-16"><a href="#cb710-16" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;owner&quot;</span><span class="fu">:</span> <span class="st">&quot;[email protected]&quot;</span><span class="fu">,</span></span>
+<span id="cb710-17"><a href="#cb710-17" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;permissions&quot;</span><span class="fu">:</span> <span class="st">&quot;...&quot;</span><span class="fu">,</span></span>
+<span id="cb710-18"><a href="#cb710-18" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;description&quot;</span><span class="fu">:</span> <span class="st">&quot;my nice file&quot;</span><span class="fu">,</span></span>
+<span id="cb710-19"><a href="#cb710-19" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;starred&quot;</span><span class="fu">:</span> <span class="st">&quot;false&quot;</span></span>
+<span id="cb710-20"><a href="#cb710-20" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
+<span id="cb710-21"><a href="#cb710-21" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>The program should then modify the input as desired and send it to
STDOUT. The returned <code>Metadata</code> field will be used in its
entirety for the destination object. Any other fields will be ignored.
Note in this example we translate user names and permissions and add
something to the description:</p>
-<div class="sourceCode" id="cb700"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb700-1"><a href="#cb700-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
-<span id="cb700-2"><a href="#cb700-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Metadata&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
-<span id="cb700-3"><a href="#cb700-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;btime&quot;</span><span class="fu">:</span> <span class="st">&quot;2022-10-11T16:53:11Z&quot;</span><span class="fu">,</span></span>
-<span id="cb700-4"><a href="#cb700-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;content-type&quot;</span><span class="fu">:</span> <span class="st">&quot;text/plain; charset=utf-8&quot;</span><span class="fu">,</span></span>
-<span id="cb700-5"><a href="#cb700-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;mtime&quot;</span><span class="fu">:</span> <span class="st">&quot;2022-10-11T17:53:10.286745272+01:00&quot;</span><span class="fu">,</span></span>
-<span id="cb700-6"><a href="#cb700-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;owner&quot;</span><span class="fu">:</span> <span class="st">&quot;[email protected]&quot;</span><span class="fu">,</span></span>
-<span id="cb700-7"><a href="#cb700-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;permissions&quot;</span><span class="fu">:</span> <span class="st">&quot;...&quot;</span><span class="fu">,</span></span>
-<span id="cb700-8"><a href="#cb700-8" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;description&quot;</span><span class="fu">:</span> <span class="st">&quot;my nice file [migrated from domain1]&quot;</span><span class="fu">,</span></span>
-<span id="cb700-9"><a href="#cb700-9" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;starred&quot;</span><span class="fu">:</span> <span class="st">&quot;false&quot;</span></span>
-<span id="cb700-10"><a href="#cb700-10" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
-<span id="cb700-11"><a href="#cb700-11" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
+<div class="sourceCode" id="cb711"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb711-1"><a href="#cb711-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
+<span id="cb711-2"><a href="#cb711-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Metadata&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
+<span id="cb711-3"><a href="#cb711-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;btime&quot;</span><span class="fu">:</span> <span class="st">&quot;2022-10-11T16:53:11Z&quot;</span><span class="fu">,</span></span>
+<span id="cb711-4"><a href="#cb711-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;content-type&quot;</span><span class="fu">:</span> <span class="st">&quot;text/plain; charset=utf-8&quot;</span><span class="fu">,</span></span>
+<span id="cb711-5"><a href="#cb711-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;mtime&quot;</span><span class="fu">:</span> <span class="st">&quot;2022-10-11T17:53:10.286745272+01:00&quot;</span><span class="fu">,</span></span>
+<span id="cb711-6"><a href="#cb711-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;owner&quot;</span><span class="fu">:</span> <span class="st">&quot;[email protected]&quot;</span><span class="fu">,</span></span>
+<span id="cb711-7"><a href="#cb711-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;permissions&quot;</span><span class="fu">:</span> <span class="st">&quot;...&quot;</span><span class="fu">,</span></span>
+<span id="cb711-8"><a href="#cb711-8" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;description&quot;</span><span class="fu">:</span> <span class="st">&quot;my nice file [migrated from domain1]&quot;</span><span class="fu">,</span></span>
+<span id="cb711-9"><a href="#cb711-9" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;starred&quot;</span><span class="fu">:</span> <span class="st">&quot;false&quot;</span></span>
+<span id="cb711-10"><a href="#cb711-10" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
+<span id="cb711-11"><a href="#cb711-11" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>Metadata can be removed here too.</p>
<p>An example python program might look something like this to implement
the above transformations.</p>
-<div class="sourceCode" id="cb701"><pre
-class="sourceCode python"><code class="sourceCode python"><span id="cb701-1"><a href="#cb701-1" aria-hidden="true" tabindex="-1"></a><span class="im">import</span> sys, json</span>
-<span id="cb701-2"><a href="#cb701-2" aria-hidden="true" tabindex="-1"></a></span>
-<span id="cb701-3"><a href="#cb701-3" aria-hidden="true" tabindex="-1"></a>i <span class="op">=</span> json.load(sys.stdin)</span>
-<span id="cb701-4"><a href="#cb701-4" aria-hidden="true" tabindex="-1"></a>metadata <span class="op">=</span> i[<span class="st">&quot;Metadata&quot;</span>]</span>
-<span id="cb701-5"><a href="#cb701-5" aria-hidden="true" tabindex="-1"></a><span class="co"># Add tag to description</span></span>
-<span id="cb701-6"><a href="#cb701-6" aria-hidden="true" tabindex="-1"></a><span class="cf">if</span> <span class="st">&quot;description&quot;</span> <span class="kw">in</span> metadata:</span>
-<span id="cb701-7"><a href="#cb701-7" aria-hidden="true" tabindex="-1"></a> metadata[<span class="st">&quot;description&quot;</span>] <span class="op">+=</span> <span class="st">&quot; [migrated from domain1]&quot;</span></span>
-<span id="cb701-8"><a href="#cb701-8" aria-hidden="true" tabindex="-1"></a><span class="cf">else</span>:</span>
-<span id="cb701-9"><a href="#cb701-9" aria-hidden="true" tabindex="-1"></a> metadata[<span class="st">&quot;description&quot;</span>] <span class="op">=</span> <span class="st">&quot;[migrated from domain1]&quot;</span></span>
-<span id="cb701-10"><a href="#cb701-10" aria-hidden="true" tabindex="-1"></a><span class="co"># Modify owner</span></span>
-<span id="cb701-11"><a href="#cb701-11" aria-hidden="true" tabindex="-1"></a><span class="cf">if</span> <span class="st">&quot;owner&quot;</span> <span class="kw">in</span> metadata:</span>
-<span id="cb701-12"><a href="#cb701-12" aria-hidden="true" tabindex="-1"></a> metadata[<span class="st">&quot;owner&quot;</span>] <span class="op">=</span> metadata[<span class="st">&quot;owner&quot;</span>].replace(<span class="st">&quot;domain1.com&quot;</span>, <span class="st">&quot;domain2.com&quot;</span>)</span>
-<span id="cb701-13"><a href="#cb701-13" aria-hidden="true" tabindex="-1"></a>o <span class="op">=</span> { <span class="st">&quot;Metadata&quot;</span>: metadata }</span>
-<span id="cb701-14"><a href="#cb701-14" aria-hidden="true" tabindex="-1"></a>json.dump(o, sys.stdout, indent<span class="op">=</span><span class="st">&quot;</span><span class="ch">\t</span><span class="st">&quot;</span>)</span></code></pre></div>
+<div class="sourceCode" id="cb712"><pre
+class="sourceCode python"><code class="sourceCode python"><span id="cb712-1"><a href="#cb712-1" aria-hidden="true" tabindex="-1"></a><span class="im">import</span> sys, json</span>
+<span id="cb712-2"><a href="#cb712-2" aria-hidden="true" tabindex="-1"></a></span>
+<span id="cb712-3"><a href="#cb712-3" aria-hidden="true" tabindex="-1"></a>i <span class="op">=</span> json.load(sys.stdin)</span>
+<span id="cb712-4"><a href="#cb712-4" aria-hidden="true" tabindex="-1"></a>metadata <span class="op">=</span> i[<span class="st">&quot;Metadata&quot;</span>]</span>
+<span id="cb712-5"><a href="#cb712-5" aria-hidden="true" tabindex="-1"></a><span class="co"># Add tag to description</span></span>
+<span id="cb712-6"><a href="#cb712-6" aria-hidden="true" tabindex="-1"></a><span class="cf">if</span> <span class="st">&quot;description&quot;</span> <span class="kw">in</span> metadata:</span>
+<span id="cb712-7"><a href="#cb712-7" aria-hidden="true" tabindex="-1"></a> metadata[<span class="st">&quot;description&quot;</span>] <span class="op">+=</span> <span class="st">&quot; [migrated from domain1]&quot;</span></span>
+<span id="cb712-8"><a href="#cb712-8" aria-hidden="true" tabindex="-1"></a><span class="cf">else</span>:</span>
+<span id="cb712-9"><a href="#cb712-9" aria-hidden="true" tabindex="-1"></a> metadata[<span class="st">&quot;description&quot;</span>] <span class="op">=</span> <span class="st">&quot;[migrated from domain1]&quot;</span></span>
+<span id="cb712-10"><a href="#cb712-10" aria-hidden="true" tabindex="-1"></a><span class="co"># Modify owner</span></span>
+<span id="cb712-11"><a href="#cb712-11" aria-hidden="true" tabindex="-1"></a><span class="cf">if</span> <span class="st">&quot;owner&quot;</span> <span class="kw">in</span> metadata:</span>
+<span id="cb712-12"><a href="#cb712-12" aria-hidden="true" tabindex="-1"></a> metadata[<span class="st">&quot;owner&quot;</span>] <span class="op">=</span> metadata[<span class="st">&quot;owner&quot;</span>].replace(<span class="st">&quot;domain1.com&quot;</span>, <span class="st">&quot;domain2.com&quot;</span>)</span>
+<span id="cb712-13"><a href="#cb712-13" aria-hidden="true" tabindex="-1"></a>o <span class="op">=</span> { <span class="st">&quot;Metadata&quot;</span>: metadata }</span>
+<span id="cb712-14"><a href="#cb712-14" aria-hidden="true" tabindex="-1"></a>json.dump(o, sys.stdout, indent<span class="op">=</span><span class="st">&quot;</span><span class="ch">\t</span><span class="st">&quot;</span>)</span></code></pre></div>
<p>You can find this example (slightly expanded) in the rclone source
code at <a
href="https://github.com/rclone/rclone/blob/master/bin/test_metadata_mapper.py">bin/test_metadata_mapper.py</a>.</p>
@@ -16445,6 +16608,10 @@ server's modified time. In cases such as a local to remote sync using
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>This flag is only supported on certain backends and will be silently
+ignored on unsupported backends. Supported backends include
+<code>azureblob</code>, <code>oracleobjectstorage</code>,
+<code>s3</code>, <code>swift</code>.</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
@@ -16571,11 +16738,11 @@ 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>
-<div class="sourceCode" id="cb707"><pre
-class="sourceCode sh"><code class="sourceCode bash"><span id="cb707-1"><a href="#cb707-1" aria-hidden="true" tabindex="-1"></a><span class="co">#!/bin/echo Source this file don&#39;t run it</span></span>
-<span id="cb707-2"><a href="#cb707-2" aria-hidden="true" tabindex="-1"></a></span>
-<span id="cb707-3"><a href="#cb707-3" aria-hidden="true" tabindex="-1"></a><span class="bu">read</span> <span class="at">-s</span> <span class="va">RCLONE_CONFIG_PASS</span></span>
-<span id="cb707-4"><a href="#cb707-4" aria-hidden="true" tabindex="-1"></a><span class="bu">export</span> <span class="va">RCLONE_CONFIG_PASS</span></span></code></pre></div>
+<div class="sourceCode" id="cb718"><pre
+class="sourceCode sh"><code class="sourceCode bash"><span id="cb718-1"><a href="#cb718-1" aria-hidden="true" tabindex="-1"></a><span class="co">#!/bin/echo Source this file don&#39;t run it</span></span>
+<span id="cb718-2"><a href="#cb718-2" aria-hidden="true" tabindex="-1"></a></span>
+<span id="cb718-3"><a href="#cb718-3" aria-hidden="true" tabindex="-1"></a><span class="bu">read</span> <span class="at">-s</span> <span class="va">RCLONE_CONFIG_PASS</span></span>
+<span id="cb718-4"><a href="#cb718-4" aria-hidden="true" tabindex="-1"></a><span class="bu">export</span> <span class="va">RCLONE_CONFIG_PASS</span></span></code></pre></div>
<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>
@@ -16647,11 +16814,11 @@ a password store: <code>pass init rclone</code>.</p></li>
<h4 id="windows-2">Windows</h4>
<ul>
<li><p>Generate and store a password</p>
-<div class="sourceCode" id="cb713"><pre
-class="sourceCode powershell"><code class="sourceCode powershell"><span id="cb713-1"><a href="#cb713-1" aria-hidden="true" tabindex="-1"></a><span class="fu">New-Object</span> <span class="op">-</span>TypeName PSCredential <span class="op">-</span>ArgumentList <span class="st">&quot;rclone&quot;</span><span class="op">,</span> <span class="op">(</span><span class="fu">ConvertTo-SecureString</span> <span class="op">-</span>String <span class="op">([</span>System<span class="op">.</span><span class="fu">Web</span><span class="op">.</span><span class="fu">Security</span><span class="op">.</span><span class="fu">Membership</span><span class="op">]::</span>GeneratePassword<span class="op">(</span>40<span class="op">,</span> 10<span class="op">))</span> <span class="op">-</span>AsPlainText <span class="op">-</span>Force<span class="op">)</span> <span class="op">|</span> <span class="fu">Export-Clixml</span> <span class="op">-</span>Path <span class="st">&quot;rclone-credential.xml&quot;</span></span></code></pre></div></li>
+<div class="sourceCode" id="cb724"><pre
+class="sourceCode powershell"><code class="sourceCode powershell"><span id="cb724-1"><a href="#cb724-1" aria-hidden="true" tabindex="-1"></a><span class="fu">New-Object</span> <span class="op">-</span>TypeName PSCredential <span class="op">-</span>ArgumentList <span class="st">&quot;rclone&quot;</span><span class="op">,</span> <span class="op">(</span><span class="fu">ConvertTo-SecureString</span> <span class="op">-</span>String <span class="op">([</span>System<span class="op">.</span><span class="fu">Web</span><span class="op">.</span><span class="fu">Security</span><span class="op">.</span><span class="fu">Membership</span><span class="op">]::</span>GeneratePassword<span class="op">(</span>40<span class="op">,</span> 10<span class="op">))</span> <span class="op">-</span>AsPlainText <span class="op">-</span>Force<span class="op">)</span> <span class="op">|</span> <span class="fu">Export-Clixml</span> <span class="op">-</span>Path <span class="st">&quot;rclone-credential.xml&quot;</span></span></code></pre></div></li>
<li><p>Add the password retrieval instruction</p>
-<div class="sourceCode" id="cb714"><pre
-class="sourceCode powershell"><code class="sourceCode powershell"><span id="cb714-1"><a href="#cb714-1" aria-hidden="true" tabindex="-1"></a><span class="op">[</span>Environment<span class="op">]::</span>SetEnvironmentVariable<span class="op">(</span><span class="st">&quot;RCLONE_PASSWORD_COMMAND&quot;</span><span class="op">,</span> <span class="st">&quot;[System.Runtime.InteropServices.Marshal]::PtrToStringAuto([System.Runtime.InteropServices.Marshal]::SecureStringToBSTR((Import-Clixml -Path &quot;</span>rclone<span class="op">-</span>credential<span class="op">.</span><span class="fu">xml</span><span class="st">&quot;).Password))&quot;</span><span class="op">)</span></span></code></pre></div></li>
+<div class="sourceCode" id="cb725"><pre
+class="sourceCode powershell"><code class="sourceCode powershell"><span id="cb725-1"><a href="#cb725-1" aria-hidden="true" tabindex="-1"></a><span class="op">[</span>Environment<span class="op">]::</span>SetEnvironmentVariable<span class="op">(</span><span class="st">&quot;RCLONE_PASSWORD_COMMAND&quot;</span><span class="op">,</span> <span class="st">&quot;[System.Runtime.InteropServices.Marshal]::PtrToStringAuto([System.Runtime.InteropServices.Marshal]::SecureStringToBSTR((Import-Clixml -Path &quot;</span>rclone<span class="op">-</span>credential<span class="op">.</span><span class="fu">xml</span><span class="st">&quot;).Password))&quot;</span><span class="op">)</span></span></code></pre></div></li>
</ul>
<h4 id="encrypt-the-config-file-all-systems">Encrypt the config file
(all systems)</h4>
@@ -16712,6 +16879,11 @@ you'll need that installed to use it.</li>
<li><code>mapper</code> dumps the JSON blobs being sent to the program
supplied with <code>--metadata-mapper</code> and received from it. It
can be useful for debugging the metadata mapper interface.</li>
+<li><code>curl</code> dumps the HTTP request as a <code>curl</code>
+command. Can be used with the other HTTP debugging flags (e.g.
+<code>requests</code>, <code>bodies</code>). By default the auth will be
+masked - use with <code>auth</code> to have the curl commands with
+authentication too.</li>
</ul>
<h2 id="filtering">Filtering</h2>
<p>For the filtering options</p>
@@ -16829,7 +17001,7 @@ reached</li>
<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-98">Options</h3>
+<h3 id="options-99">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
@@ -17982,101 +18154,93 @@ href="https://forum.rclone.org/">rclone forum</a> are:</p>
<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 class="console"><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 class="text"><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>
+<h1 id="rclone-gui-1">rclone gui</h1>
+<p>The <code>rclone gui</code> command starts the official Web GUI that
+comes bundled with rclone.</p>
+<p>With this command, rclone can serve a web-based GUI (graphical user
+interface) that is accessible from a normal web browser.</p>
+<p>Run it in a terminal and rclone will initialize and then start the
+GUI.</p>
+<pre class="console"><code>rclone gui</code></pre>
+<p>This will produce logs like this. The terminal window needs to stay
+open to continue to run the GUI:</p>
+<pre class="console"><code>2026/04/14 11:36:04 NOTICE: Serving remote control on http://127.0.0.1:50803/
+2026/04/14 11:36:04 NOTICE: Serving GUI on http://127.0.0.1:50802/
+2026/04/14 11:36:04 NOTICE: GUI available at http://127.0.0.1:50802/login?pass=XXX&amp;url=http%3A%2F%2F127.0.0.1%3A50803%2F&amp;user=gui</code></pre>
+<p>You can also add debugging flags when running the GUI, such as
+<code>-v</code>, which will show more logging output from the rc
+server.</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>
+<p>Once the browser opens, you will be presented with the Dashboard, the
+main screen where you can see the status of your remotes and system.</p>
+<p>At the top, starting from the left, you will see a series of tabs you
+can click on. On the right side you will have the logout button and
+potentially an "Update available" message if a new rclone version has
+been released.</p>
+<h3 id="dashboard">Dashboard</h3>
+<p>See live metrics, learn if your remotes are near capacity, and read
+the changelog for the current version.</p>
+<h3 id="explorer">Explorer</h3>
+<p>Explore and manage both local disks and remotes, download files and
+directories and start transfers.</p>
+<h3 id="remotes">Remotes</h3>
+<p>Scroll the list of remotes and tap on it to navigate to the explorer.
+There you can navigate the contents of your remotes, transfer, download,
+and even upload files.</p>
+<h3 id="mounts">Mounts</h3>
+<p>Mount remotes as local drives on your computer and check on your
+existing mounts.</p>
+<h3 id="serves">Serves</h3>
+<p>Get quick info about your active serve instances, and start new
+ones.</p>
+<h3 id="settings">Settings</h3>
+<p>Edit your <code>rclone.conf</code> file directly, set logging flags,
+and performance parameters.</p>
<h2 id="how-it-works-1">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>
+<p>When you run <code>rclone gui</code> this is what happens</p>
+<ul>
+<li>Rclone starts the remote control API ("rc").</li>
+<li>Rclone starts a second server to serve the Web GUI.</li>
+<li>If a port, username or password is not specified, then missing
+values will be auto-generated.</li>
+<li>Unless <code>--no-open-browser</code> is passed, a browser window
+will open.</li>
+<li>The URL already contains the username &amp; password, in which case
+the GUI will use those values and log you in automatically.</li>
+</ul>
+<h2 id="security">Security</h2>
+<p>It's important to think first about what rclone has access to and
+what you might be sharing.</p>
+<p>A few good measures:</p>
+<ul>
+<li>Don't use <code>--no-auth</code> (this is for testing only).</li>
+<li>Do not expose to the local network (eg with
+<code>--api-addr :5572 --addr :8080</code>) unless you trust all
+devices on your local network. Prefer <code>127.0.0.1</code> or
+<code>localhost</code> (the default).</li>
+<li>Use a strong password and non-obvious usernames like "admin" or
+"rclone" if you are using <code>--user</code> and
+<code>--pass</code>.</li>
+<li>If you want to host it on a server and access it remotely, make sure
+you're only exposing the GUI and not the RC API. They listen on
+different ports.</li>
+</ul>
+<p>If you want to access it remotely but want to avoid running a proxy
+and exposing ports, you can use Cloudflare Tunnels or localhost.run or
+Tailscale (all free).</p>
+<h2 id="options-100">Options</h2>
+<pre class="console"><code> --addr stringArray IPaddress:Port for the GUI server (default auto-chosen localhost port)
+ --api-addr stringArray IPaddress:Port for the RC API server (default auto-chosen localhost port)
+ --enable-metrics Enable OpenMetrics/Prometheus compatible endpoint at /metrics
+ -h, --help help for gui
+ --no-auth Don&#39;t require auth for the RC API
+ --no-open-browser Skip opening the browser automatically
+ --pass string Password for RC authentication
+ --user string User name for RC authentication</code></pre>
+<h2 id="history">History</h2>
+<p>In v1.74 the GUI was redone and embedded within rclone for ease of
+use. The GUI bundle ships as a compressed zip embedded in the rclone
+binary and is served from the zip at runtime.</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
@@ -18325,8 +18489,8 @@ href="#option-blocks">the options blocks section</a> for more info).</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>
-<div class="sourceCode" id="cb781"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb781-1"><a href="#cb781-1" aria-hidden="true" tabindex="-1"></a><span class="er">&quot;_config&quot;:</span><span class="fu">{</span><span class="dt">&quot;CheckSum&quot;</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">}</span></span></code></pre></div>
+<div class="sourceCode" id="cb793"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb793-1"><a href="#cb793-1" aria-hidden="true" tabindex="-1"></a><span class="er">&quot;_config&quot;:</span><span class="fu">{</span><span class="dt">&quot;CheckSum&quot;</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">}</span></span></code></pre></div>
<p>If using <code>rclone rc</code> this could be passed as</p>
<pre class="console"><code>rclone rc sync/sync ... _config=&#39;{&quot;CheckSum&quot;: true}&#39;</code></pre>
<p>Any config parameters you don't set will inherit the global defaults
@@ -18335,9 +18499,9 @@ which were set with command line flags or environment variables.</p>
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>
-<div class="sourceCode" id="cb783"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb783-1"><a href="#cb783-1" aria-hidden="true" tabindex="-1"></a><span class="er">&quot;_config&quot;:</span><span class="fu">{</span><span class="dt">&quot;BufferSize&quot;</span><span class="fu">:</span> <span class="st">&quot;42M&quot;</span><span class="fu">}</span></span>
-<span id="cb783-2"><a href="#cb783-2" aria-hidden="true" tabindex="-1"></a><span class="er">&quot;_config&quot;:</span><span class="fu">{</span><span class="dt">&quot;BufferSize&quot;</span><span class="fu">:</span> <span class="dv">44040192</span><span class="fu">}</span></span></code></pre></div>
+<div class="sourceCode" id="cb795"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb795-1"><a href="#cb795-1" aria-hidden="true" tabindex="-1"></a><span class="er">&quot;_config&quot;:</span><span class="fu">{</span><span class="dt">&quot;BufferSize&quot;</span><span class="fu">:</span> <span class="st">&quot;42M&quot;</span><span class="fu">}</span></span>
+<span id="cb795-2"><a href="#cb795-2" aria-hidden="true" tabindex="-1"></a><span class="er">&quot;_config&quot;:</span><span class="fu">{</span><span class="dt">&quot;BufferSize&quot;</span><span class="fu">:</span> <span class="dv">44040192</span><span class="fu">}</span></span></code></pre></div>
<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>
@@ -18354,8 +18518,8 @@ href="#option-blocks">the options blocks section</a> for more info).</p>
<p>For example, if you wished to run a sync with these flags</p>
<pre class="text"><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>
-<div class="sourceCode" id="cb787"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb787-1"><a href="#cb787-1" aria-hidden="true" tabindex="-1"></a><span class="er">&quot;_filter&quot;:</span><span class="fu">{</span><span class="dt">&quot;MaxSize&quot;</span><span class="fu">:</span><span class="st">&quot;1M&quot;</span><span class="fu">,</span> <span class="dt">&quot;IncludeRule&quot;</span><span class="fu">:</span><span class="ot">[</span><span class="st">&quot;a&quot;</span><span class="ot">,</span><span class="st">&quot;b&quot;</span><span class="ot">]</span><span class="fu">,</span> <span class="dt">&quot;MaxAge&quot;</span><span class="fu">:</span><span class="st">&quot;42s&quot;</span><span class="fu">}</span></span></code></pre></div>
+<div class="sourceCode" id="cb799"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb799-1"><a href="#cb799-1" aria-hidden="true" tabindex="-1"></a><span class="er">&quot;_filter&quot;:</span><span class="fu">{</span><span class="dt">&quot;MaxSize&quot;</span><span class="fu">:</span><span class="st">&quot;1M&quot;</span><span class="fu">,</span> <span class="dt">&quot;IncludeRule&quot;</span><span class="fu">:</span><span class="ot">[</span><span class="st">&quot;a&quot;</span><span class="ot">,</span><span class="st">&quot;b&quot;</span><span class="ot">]</span><span class="fu">,</span> <span class="dt">&quot;MaxAge&quot;</span><span class="fu">:</span><span class="st">&quot;42s&quot;</span><span class="fu">}</span></span></code></pre></div>
<p>If using <code>rclone rc</code> this could be passed as</p>
<pre class="console"><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
@@ -18364,9 +18528,9 @@ which were set with command line flags or environment variables.</p>
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>
-<div class="sourceCode" id="cb789"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb789-1"><a href="#cb789-1" aria-hidden="true" tabindex="-1"></a><span class="er">&quot;_filter&quot;:</span><span class="fu">{</span><span class="dt">&quot;MinSize&quot;</span><span class="fu">:</span> <span class="st">&quot;42M&quot;</span><span class="fu">}</span></span>
-<span id="cb789-2"><a href="#cb789-2" aria-hidden="true" tabindex="-1"></a><span class="er">&quot;_filter&quot;:</span><span class="fu">{</span><span class="dt">&quot;MinSize&quot;</span><span class="fu">:</span> <span class="dv">44040192</span><span class="fu">}</span></span></code></pre></div>
+<div class="sourceCode" id="cb801"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb801-1"><a href="#cb801-1" aria-hidden="true" tabindex="-1"></a><span class="er">&quot;_filter&quot;:</span><span class="fu">{</span><span class="dt">&quot;MinSize&quot;</span><span class="fu">:</span> <span class="st">&quot;42M&quot;</span><span class="fu">}</span></span>
+<span id="cb801-2"><a href="#cb801-2" aria-hidden="true" tabindex="-1"></a><span class="er">&quot;_filter&quot;:</span><span class="fu">{</span><span class="dt">&quot;MinSize&quot;</span><span class="fu">:</span> <span class="dv">44040192</span><span class="fu">}</span></span></code></pre></div>
<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>
@@ -18546,36 +18710,36 @@ allowed unless Required or Default is set)</td>
<p>An example of this might be the <code>--log-level</code> flag. Note
that the <code>Name</code> of the option becomes the command line flag
with <code>_</code> replaced with <code>-</code>.</p>
-<div class="sourceCode" id="cb791"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb791-1"><a href="#cb791-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
-<span id="cb791-2"><a href="#cb791-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Advanced&quot;</span><span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span></span>
-<span id="cb791-3"><a href="#cb791-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Default&quot;</span><span class="fu">:</span> <span class="dv">5</span><span class="fu">,</span></span>
-<span id="cb791-4"><a href="#cb791-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;DefaultStr&quot;</span><span class="fu">:</span> <span class="st">&quot;NOTICE&quot;</span><span class="fu">,</span></span>
-<span id="cb791-5"><a href="#cb791-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Examples&quot;</span><span class="fu">:</span> <span class="ot">[</span></span>
-<span id="cb791-6"><a href="#cb791-6" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
-<span id="cb791-7"><a href="#cb791-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Help&quot;</span><span class="fu">:</span> <span class="st">&quot;&quot;</span><span class="fu">,</span></span>
-<span id="cb791-8"><a href="#cb791-8" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Value&quot;</span><span class="fu">:</span> <span class="st">&quot;EMERGENCY&quot;</span></span>
-<span id="cb791-9"><a href="#cb791-9" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span><span class="ot">,</span></span>
-<span id="cb791-10"><a href="#cb791-10" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
-<span id="cb791-11"><a href="#cb791-11" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Help&quot;</span><span class="fu">:</span> <span class="st">&quot;&quot;</span><span class="fu">,</span></span>
-<span id="cb791-12"><a href="#cb791-12" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Value&quot;</span><span class="fu">:</span> <span class="st">&quot;ALERT&quot;</span></span>
-<span id="cb791-13"><a href="#cb791-13" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span><span class="ot">,</span></span>
-<span id="cb791-14"><a href="#cb791-14" aria-hidden="true" tabindex="-1"></a> <span class="er">...</span></span>
-<span id="cb791-15"><a href="#cb791-15" aria-hidden="true" tabindex="-1"></a> <span class="ot">]</span><span class="fu">,</span></span>
-<span id="cb791-16"><a href="#cb791-16" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Exclusive&quot;</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span></span>
-<span id="cb791-17"><a href="#cb791-17" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;FieldName&quot;</span><span class="fu">:</span> <span class="st">&quot;LogLevel&quot;</span><span class="fu">,</span></span>
-<span id="cb791-18"><a href="#cb791-18" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Groups&quot;</span><span class="fu">:</span> <span class="st">&quot;Logging&quot;</span><span class="fu">,</span></span>
-<span id="cb791-19"><a href="#cb791-19" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Help&quot;</span><span class="fu">:</span> <span class="st">&quot;Log level DEBUG|INFO|NOTICE|ERROR&quot;</span><span class="fu">,</span></span>
-<span id="cb791-20"><a href="#cb791-20" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Hide&quot;</span><span class="fu">:</span> <span class="dv">0</span><span class="fu">,</span></span>
-<span id="cb791-21"><a href="#cb791-21" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;IsPassword&quot;</span><span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span></span>
-<span id="cb791-22"><a href="#cb791-22" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Name&quot;</span><span class="fu">:</span> <span class="st">&quot;log_level&quot;</span><span class="fu">,</span></span>
-<span id="cb791-23"><a href="#cb791-23" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;NoPrefix&quot;</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span></span>
-<span id="cb791-24"><a href="#cb791-24" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Required&quot;</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span></span>
-<span id="cb791-25"><a href="#cb791-25" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Sensitive&quot;</span><span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span></span>
-<span id="cb791-26"><a href="#cb791-26" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Type&quot;</span><span class="fu">:</span> <span class="st">&quot;LogLevel&quot;</span><span class="fu">,</span></span>
-<span id="cb791-27"><a href="#cb791-27" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Value&quot;</span><span class="fu">:</span> <span class="kw">null</span><span class="fu">,</span></span>
-<span id="cb791-28"><a href="#cb791-28" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;ValueStr&quot;</span><span class="fu">:</span> <span class="st">&quot;NOTICE&quot;</span></span>
-<span id="cb791-29"><a href="#cb791-29" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span><span class="er">,</span></span></code></pre></div>
+<div class="sourceCode" id="cb803"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb803-1"><a href="#cb803-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
+<span id="cb803-2"><a href="#cb803-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Advanced&quot;</span><span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span></span>
+<span id="cb803-3"><a href="#cb803-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Default&quot;</span><span class="fu">:</span> <span class="dv">5</span><span class="fu">,</span></span>
+<span id="cb803-4"><a href="#cb803-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;DefaultStr&quot;</span><span class="fu">:</span> <span class="st">&quot;NOTICE&quot;</span><span class="fu">,</span></span>
+<span id="cb803-5"><a href="#cb803-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Examples&quot;</span><span class="fu">:</span> <span class="ot">[</span></span>
+<span id="cb803-6"><a href="#cb803-6" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
+<span id="cb803-7"><a href="#cb803-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Help&quot;</span><span class="fu">:</span> <span class="st">&quot;&quot;</span><span class="fu">,</span></span>
+<span id="cb803-8"><a href="#cb803-8" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Value&quot;</span><span class="fu">:</span> <span class="st">&quot;EMERGENCY&quot;</span></span>
+<span id="cb803-9"><a href="#cb803-9" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span><span class="ot">,</span></span>
+<span id="cb803-10"><a href="#cb803-10" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
+<span id="cb803-11"><a href="#cb803-11" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Help&quot;</span><span class="fu">:</span> <span class="st">&quot;&quot;</span><span class="fu">,</span></span>
+<span id="cb803-12"><a href="#cb803-12" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Value&quot;</span><span class="fu">:</span> <span class="st">&quot;ALERT&quot;</span></span>
+<span id="cb803-13"><a href="#cb803-13" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span><span class="ot">,</span></span>
+<span id="cb803-14"><a href="#cb803-14" aria-hidden="true" tabindex="-1"></a> <span class="er">...</span></span>
+<span id="cb803-15"><a href="#cb803-15" aria-hidden="true" tabindex="-1"></a> <span class="ot">]</span><span class="fu">,</span></span>
+<span id="cb803-16"><a href="#cb803-16" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Exclusive&quot;</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span></span>
+<span id="cb803-17"><a href="#cb803-17" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;FieldName&quot;</span><span class="fu">:</span> <span class="st">&quot;LogLevel&quot;</span><span class="fu">,</span></span>
+<span id="cb803-18"><a href="#cb803-18" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Groups&quot;</span><span class="fu">:</span> <span class="st">&quot;Logging&quot;</span><span class="fu">,</span></span>
+<span id="cb803-19"><a href="#cb803-19" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Help&quot;</span><span class="fu">:</span> <span class="st">&quot;Log level DEBUG|INFO|NOTICE|ERROR&quot;</span><span class="fu">,</span></span>
+<span id="cb803-20"><a href="#cb803-20" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Hide&quot;</span><span class="fu">:</span> <span class="dv">0</span><span class="fu">,</span></span>
+<span id="cb803-21"><a href="#cb803-21" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;IsPassword&quot;</span><span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span></span>
+<span id="cb803-22"><a href="#cb803-22" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Name&quot;</span><span class="fu">:</span> <span class="st">&quot;log_level&quot;</span><span class="fu">,</span></span>
+<span id="cb803-23"><a href="#cb803-23" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;NoPrefix&quot;</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span></span>
+<span id="cb803-24"><a href="#cb803-24" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Required&quot;</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span></span>
+<span id="cb803-25"><a href="#cb803-25" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Sensitive&quot;</span><span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span></span>
+<span id="cb803-26"><a href="#cb803-26" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Type&quot;</span><span class="fu">:</span> <span class="st">&quot;LogLevel&quot;</span><span class="fu">,</span></span>
+<span id="cb803-27"><a href="#cb803-27" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Value&quot;</span><span class="fu">:</span> <span class="kw">null</span><span class="fu">,</span></span>
+<span id="cb803-28"><a href="#cb803-28" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;ValueStr&quot;</span><span class="fu">:</span> <span class="st">&quot;NOTICE&quot;</span></span>
+<span id="cb803-29"><a href="#cb803-29" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span><span class="er">,</span></span></code></pre></div>
<p>Note that the <code>Help</code> may be multiple lines separated by
<code>\n</code>. The first line will always be a short sentence and this
is the sentence shown when running <code>rclone help flags</code>.</p>
@@ -18601,25 +18765,25 @@ 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>
-<div class="sourceCode" id="cb792"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb792-1"><a href="#cb792-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
-<span id="cb792-2"><a href="#cb792-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;_name&quot;</span><span class="fu">:</span> <span class="st">&quot;remote&quot;</span><span class="fu">,</span></span>
-<span id="cb792-3"><a href="#cb792-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;_root&quot;</span><span class="fu">:</span> <span class="st">&quot;/tmp&quot;</span></span>
-<span id="cb792-4"><a href="#cb792-4" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
+<div class="sourceCode" id="cb804"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb804-1"><a href="#cb804-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
+<span id="cb804-2"><a href="#cb804-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;_name&quot;</span><span class="fu">:</span> <span class="st">&quot;remote&quot;</span><span class="fu">,</span></span>
+<span id="cb804-3"><a href="#cb804-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;_root&quot;</span><span class="fu">:</span> <span class="st">&quot;/tmp&quot;</span></span>
+<span id="cb804-4"><a href="#cb804-4" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>And this is equivalent to
<code>:sftp,host='example.com':/tmp</code></p>
-<div class="sourceCode" id="cb793"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb793-1"><a href="#cb793-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
-<span id="cb793-2"><a href="#cb793-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;type&quot;</span><span class="fu">:</span> <span class="st">&quot;sftp&quot;</span><span class="fu">,</span></span>
-<span id="cb793-3"><a href="#cb793-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;host&quot;</span><span class="fu">:</span> <span class="st">&quot;example.com&quot;</span><span class="fu">,</span></span>
-<span id="cb793-4"><a href="#cb793-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;_root&quot;</span><span class="fu">:</span> <span class="st">&quot;/tmp&quot;</span></span>
-<span id="cb793-5"><a href="#cb793-5" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
+<div class="sourceCode" id="cb805"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb805-1"><a href="#cb805-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
+<span id="cb805-2"><a href="#cb805-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;type&quot;</span><span class="fu">:</span> <span class="st">&quot;sftp&quot;</span><span class="fu">,</span></span>
+<span id="cb805-3"><a href="#cb805-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;host&quot;</span><span class="fu">:</span> <span class="st">&quot;example.com&quot;</span><span class="fu">,</span></span>
+<span id="cb805-4"><a href="#cb805-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;_root&quot;</span><span class="fu">:</span> <span class="st">&quot;/tmp&quot;</span></span>
+<span id="cb805-5"><a href="#cb805-5" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>And this is equivalent to <code>/tmp/dir</code></p>
-<div class="sourceCode" id="cb794"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb794-1"><a href="#cb794-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
-<span id="cb794-2"><a href="#cb794-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;type&quot;</span><span class="fu">:</span> <span class="st">&quot;local&quot;</span><span class="fu">,</span></span>
-<span id="cb794-3"><a href="#cb794-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;_root&quot;</span><span class="fu">:</span> <span class="st">&quot;/tmp/dir&quot;</span></span>
-<span id="cb794-4"><a href="#cb794-4" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
+<div class="sourceCode" id="cb806"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb806-1"><a href="#cb806-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
+<span id="cb806-2"><a href="#cb806-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;type&quot;</span><span class="fu">:</span> <span class="st">&quot;local&quot;</span><span class="fu">,</span></span>
+<span id="cb806-3"><a href="#cb806-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;_root&quot;</span><span class="fu">:</span> <span class="st">&quot;/tmp/dir&quot;</span></span>
+<span id="cb806-4"><a href="#cb806-4" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<h2 id="supported-commands">Supported commands</h2>
<!-- autogenerated start "- run make rcdocs - don't edit here" -->
<h3 id="backend-command">backend/command: Runs a backend command.</h3>
@@ -18657,7 +18821,6 @@ command:</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 =
@@ -18685,6 +18848,7 @@ specify files to fetch, e.g.</p>
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>
+<p><strong>Authentication is not required for this call.</strong></p>
<h3 id="config-create">config/create: create the config for a
remote.</h3>
<p>This takes the following parameters:</p>
@@ -18709,7 +18873,6 @@ ones</li>
<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>
@@ -18719,14 +18882,12 @@ file.</h3>
<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>
@@ -18735,14 +18896,12 @@ command for more information on the above.</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-listremotes">config/listremotes: Lists the remotes in the
config file and defined in environment variables.</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>
@@ -18753,7 +18912,6 @@ remote.</h3>
<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-paths">config/paths: Reads the config file path and other
important paths.</h3>
<p>Returns a JSON object with the following keys:</p>
@@ -18771,7 +18929,6 @@ important paths.</h3>
<p>See the <a
href="https://rclone.org/commands/rclone_config_paths/">config paths</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>
@@ -18781,14 +18938,12 @@ providers</a> command for more information on the above.</p>
<p>Note that the Options blocks are in the same format as returned by
"options/info". They are described in the <a
href="#option-blocks">option blocks</a> section.</p>
-<p><strong>Authentication is required for this call.</strong></p>
<h3 id="config-setpath">config/setpath: Set the path of the config
file</h3>
<p>Parameters:</p>
<ul>
<li>path - path to the config file to use</li>
</ul>
-<p><strong>Authentication is required for this call.</strong></p>
<h3 id="config-unlock">config/unlock: Unlock the config file.</h3>
<p>Unlocks the config file if it is locked.</p>
<p>Parameters:</p>
@@ -18796,7 +18951,6 @@ file</h3>
<li>'configPassword' - password to unlock the config file</li>
</ul>
<p>A good idea is to disable AskPassword before making this call</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>
@@ -18820,7 +18974,6 @@ ones</li>
<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
@@ -18902,7 +19055,20 @@ OR
&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-disks">core/disks: List the local disks</h3>
+<p>This does not take any parameters</p>
+<p>This call is for rclone GUI programs to enumerate local disks and
+important directories for doing transfers to and from. The list returned
+will include the root directory and the user's home directory and any
+mounted disks. The returned items should be usable directly as
+remotes.</p>
+<p>Returns:</p>
+<ul>
+<li>disks
+<ul>
+<li>This is an array of strings of local disk names</li>
+</ul></li>
+</ul>
<h3 id="core-du">core/du: Returns disk usage of a locally attached
disk.</h3>
<p>This returns the disk usage for the local directory passed in as
@@ -18921,6 +19087,7 @@ pointed to by --cache-dir.</p>
&quot;Total&quot;: 982141468672
}
}</code></pre>
+<p><strong>Authentication is not 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
@@ -18936,6 +19103,7 @@ memory problems.</p>
...
]
}</code></pre>
+<p><strong>Authentication is not required for this call.</strong></p>
<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:
@@ -18977,6 +19145,7 @@ returned.</p>
<pre><code>{
&quot;bytes&quot;: total transferred bytes since the start of the group,
&quot;checks&quot;: number of files checked,
+ &quot;deletedDirs&quot;: number of directories deleted,
&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,
@@ -19014,6 +19183,7 @@ returned.</p>
<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>
+<p><strong>Authentication is not required for this call.</strong></p>
<h3 id="core-stats-delete">core/stats-delete: Delete stats group.</h3>
<p>This deletes entire stats group.</p>
<p>Parameters</p>
@@ -19054,6 +19224,7 @@ be returned.</p>
}
]
}</code></pre>
+<p><strong>Authentication is not required for this call.</strong></p>
<h3 id="core-version">core/version: Shows the current version of rclone,
Go and the OS.</h3>
<p>This shows the current versions of rclone, Go and the OS:</p>
@@ -19074,6 +19245,7 @@ compatible)")</li>
<li>linking - type of rclone executable (static or dynamic)</li>
<li>goTags - space separated build tags or "none"</li>
</ul>
+<p><strong>Authentication is not required for this call.</strong></p>
<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
@@ -19168,12 +19340,10 @@ 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-batch">job/batch: Run a batch of rclone rc commands
concurrently.</h3>
<p>This takes the following parameters:</p>
@@ -19183,12 +19353,12 @@ concurrently.</h3>
<li>inputs - an list of inputs to the commands with an extra
<code>_path</code> parameter</li>
</ul>
-<div class="sourceCode" id="cb813"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb813-1"><a href="#cb813-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
-<span id="cb813-2"><a href="#cb813-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;_path&quot;</span><span class="fu">:</span> <span class="st">&quot;rc/path&quot;</span><span class="fu">,</span></span>
-<span id="cb813-3"><a href="#cb813-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;param1&quot;</span><span class="fu">:</span> <span class="st">&quot;parameter for the path as documented&quot;</span><span class="fu">,</span></span>
-<span id="cb813-4"><a href="#cb813-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;param2&quot;</span><span class="fu">:</span> <span class="st">&quot;parameter for the path as documented, etc&quot;</span><span class="fu">,</span></span>
-<span id="cb813-5"><a href="#cb813-5" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
+<div class="sourceCode" id="cb825"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb825-1"><a href="#cb825-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
+<span id="cb825-2"><a href="#cb825-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;_path&quot;</span><span class="fu">:</span> <span class="st">&quot;rc/path&quot;</span><span class="fu">,</span></span>
+<span id="cb825-3"><a href="#cb825-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;param1&quot;</span><span class="fu">:</span> <span class="st">&quot;parameter for the path as documented&quot;</span><span class="fu">,</span></span>
+<span id="cb825-4"><a href="#cb825-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;param2&quot;</span><span class="fu">:</span> <span class="st">&quot;parameter for the path as documented, etc&quot;</span><span class="fu">,</span></span>
+<span id="cb825-5"><a href="#cb825-5" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>The inputs may use <code>_async</code>, <code>_group</code>,
<code>_config</code> and <code>_filter</code> as normal when using the
rc.</p>
@@ -19198,38 +19368,37 @@ rc.</p>
each in inputs.</li>
</ul>
<p>For example:</p>
-<div class="sourceCode" id="cb814"><pre
-class="sourceCode sh"><code class="sourceCode bash"><span id="cb814-1"><a href="#cb814-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rc job/batch <span class="at">--json</span> <span class="st">&#39;{</span></span>
-<span id="cb814-2"><a href="#cb814-2" aria-hidden="true" tabindex="-1"></a><span class="st"> &quot;inputs&quot;: [</span></span>
-<span id="cb814-3"><a href="#cb814-3" aria-hidden="true" tabindex="-1"></a><span class="st"> {</span></span>
-<span id="cb814-4"><a href="#cb814-4" aria-hidden="true" tabindex="-1"></a><span class="st"> &quot;_path&quot;: &quot;rc/noop&quot;,</span></span>
-<span id="cb814-5"><a href="#cb814-5" aria-hidden="true" tabindex="-1"></a><span class="st"> &quot;parameter&quot;: &quot;OK&quot;</span></span>
-<span id="cb814-6"><a href="#cb814-6" aria-hidden="true" tabindex="-1"></a><span class="st"> },</span></span>
-<span id="cb814-7"><a href="#cb814-7" aria-hidden="true" tabindex="-1"></a><span class="st"> {</span></span>
-<span id="cb814-8"><a href="#cb814-8" aria-hidden="true" tabindex="-1"></a><span class="st"> &quot;_path&quot;: &quot;rc/error&quot;,</span></span>
-<span id="cb814-9"><a href="#cb814-9" aria-hidden="true" tabindex="-1"></a><span class="st"> &quot;parameter&quot;: &quot;BAD&quot;</span></span>
-<span id="cb814-10"><a href="#cb814-10" aria-hidden="true" tabindex="-1"></a><span class="st"> }</span></span>
-<span id="cb814-11"><a href="#cb814-11" aria-hidden="true" tabindex="-1"></a><span class="st"> ]</span></span>
-<span id="cb814-12"><a href="#cb814-12" aria-hidden="true" tabindex="-1"></a><span class="st">}</span></span>
-<span id="cb814-13"><a href="#cb814-13" aria-hidden="true" tabindex="-1"></a><span class="st">&#39;</span></span></code></pre></div>
+<div class="sourceCode" id="cb826"><pre
+class="sourceCode sh"><code class="sourceCode bash"><span id="cb826-1"><a href="#cb826-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> rc job/batch <span class="at">--json</span> <span class="st">&#39;{</span></span>
+<span id="cb826-2"><a href="#cb826-2" aria-hidden="true" tabindex="-1"></a><span class="st"> &quot;inputs&quot;: [</span></span>
+<span id="cb826-3"><a href="#cb826-3" aria-hidden="true" tabindex="-1"></a><span class="st"> {</span></span>
+<span id="cb826-4"><a href="#cb826-4" aria-hidden="true" tabindex="-1"></a><span class="st"> &quot;_path&quot;: &quot;rc/noop&quot;,</span></span>
+<span id="cb826-5"><a href="#cb826-5" aria-hidden="true" tabindex="-1"></a><span class="st"> &quot;parameter&quot;: &quot;OK&quot;</span></span>
+<span id="cb826-6"><a href="#cb826-6" aria-hidden="true" tabindex="-1"></a><span class="st"> },</span></span>
+<span id="cb826-7"><a href="#cb826-7" aria-hidden="true" tabindex="-1"></a><span class="st"> {</span></span>
+<span id="cb826-8"><a href="#cb826-8" aria-hidden="true" tabindex="-1"></a><span class="st"> &quot;_path&quot;: &quot;rc/error&quot;,</span></span>
+<span id="cb826-9"><a href="#cb826-9" aria-hidden="true" tabindex="-1"></a><span class="st"> &quot;parameter&quot;: &quot;BAD&quot;</span></span>
+<span id="cb826-10"><a href="#cb826-10" aria-hidden="true" tabindex="-1"></a><span class="st"> }</span></span>
+<span id="cb826-11"><a href="#cb826-11" aria-hidden="true" tabindex="-1"></a><span class="st"> ]</span></span>
+<span id="cb826-12"><a href="#cb826-12" aria-hidden="true" tabindex="-1"></a><span class="st">}</span></span>
+<span id="cb826-13"><a href="#cb826-13" aria-hidden="true" tabindex="-1"></a><span class="st">&#39;</span></span></code></pre></div>
<p>Gives the result:</p>
-<div class="sourceCode" id="cb815"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb815-1"><a href="#cb815-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
-<span id="cb815-2"><a href="#cb815-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;results&quot;</span><span class="fu">:</span> <span class="ot">[</span></span>
-<span id="cb815-3"><a href="#cb815-3" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
-<span id="cb815-4"><a href="#cb815-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;parameter&quot;</span><span class="fu">:</span> <span class="st">&quot;OK&quot;</span></span>
-<span id="cb815-5"><a href="#cb815-5" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span><span class="ot">,</span></span>
-<span id="cb815-6"><a href="#cb815-6" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
-<span id="cb815-7"><a href="#cb815-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;error&quot;</span><span class="fu">:</span> <span class="st">&quot;arbitrary error on input map[parameter:BAD]&quot;</span><span class="fu">,</span></span>
-<span id="cb815-8"><a href="#cb815-8" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;input&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
-<span id="cb815-9"><a href="#cb815-9" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;parameter&quot;</span><span class="fu">:</span> <span class="st">&quot;BAD&quot;</span></span>
-<span id="cb815-10"><a href="#cb815-10" aria-hidden="true" tabindex="-1"></a> <span class="fu">},</span></span>
-<span id="cb815-11"><a href="#cb815-11" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;path&quot;</span><span class="fu">:</span> <span class="st">&quot;rc/error&quot;</span><span class="fu">,</span></span>
-<span id="cb815-12"><a href="#cb815-12" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;status&quot;</span><span class="fu">:</span> <span class="dv">500</span></span>
-<span id="cb815-13"><a href="#cb815-13" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
-<span id="cb815-14"><a href="#cb815-14" aria-hidden="true" tabindex="-1"></a> <span class="ot">]</span></span>
-<span id="cb815-15"><a href="#cb815-15" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
-<p><strong>Authentication is required for this call.</strong></p>
+<div class="sourceCode" id="cb827"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb827-1"><a href="#cb827-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
+<span id="cb827-2"><a href="#cb827-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;results&quot;</span><span class="fu">:</span> <span class="ot">[</span></span>
+<span id="cb827-3"><a href="#cb827-3" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
+<span id="cb827-4"><a href="#cb827-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;parameter&quot;</span><span class="fu">:</span> <span class="st">&quot;OK&quot;</span></span>
+<span id="cb827-5"><a href="#cb827-5" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span><span class="ot">,</span></span>
+<span id="cb827-6"><a href="#cb827-6" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
+<span id="cb827-7"><a href="#cb827-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;error&quot;</span><span class="fu">:</span> <span class="st">&quot;arbitrary error on input map[parameter:BAD]&quot;</span><span class="fu">,</span></span>
+<span id="cb827-8"><a href="#cb827-8" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;input&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
+<span id="cb827-9"><a href="#cb827-9" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;parameter&quot;</span><span class="fu">:</span> <span class="st">&quot;BAD&quot;</span></span>
+<span id="cb827-10"><a href="#cb827-10" aria-hidden="true" tabindex="-1"></a> <span class="fu">},</span></span>
+<span id="cb827-11"><a href="#cb827-11" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;path&quot;</span><span class="fu">:</span> <span class="st">&quot;rc/error&quot;</span><span class="fu">,</span></span>
+<span id="cb827-12"><a href="#cb827-12" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;status&quot;</span><span class="fu">:</span> <span class="dv">500</span></span>
+<span id="cb827-13"><a href="#cb827-13" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
+<span id="cb827-14"><a href="#cb827-14" aria-hidden="true" tabindex="-1"></a> <span class="ot">]</span></span>
+<span id="cb827-15"><a href="#cb827-15" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<h3 id="job-list">job/list: Lists the IDs of the running jobs</h3>
<p>Parameters: None.</p>
<p>Results:</p>
@@ -19241,6 +19410,7 @@ restart)</li>
<li>runningIds - array of integer job ids that are running</li>
<li>finishedIds - array of integer job ids that are finished</li>
</ul>
+<p><strong>Authentication is not required for this call.</strong></p>
<h3 id="job-status">job/status: Reads the status of the job ID</h3>
<p>Parameters:</p>
<ul>
@@ -19264,6 +19434,7 @@ with id uniquely identifies a job</li>
synchronously</li>
<li>progress - output of the progress related to the underlying job</li>
</ul>
+<p><strong>Authentication is not required for this call.</strong></p>
<h3 id="job-stop">job/stop: Stop the running job</h3>
<p>Parameters:</p>
<ul>
@@ -19285,7 +19456,6 @@ an unmount.</p>
</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>
@@ -19300,15 +19470,25 @@ 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>On Windows mountPoint may be set to "*" to assign the next available
+drive letter automatically, or a network share UNC path (e.g. "\server")
+to mount as a network drive. In these cases the actual drive letter is
+chosen at mount time.</p>
+<p>This returns the following values:</p>
+<ul>
+<li>mountPoint: the actual mount point that was used (this may differ
+from the input, e.g. on Windows when "*" is passed the allocated drive
+letter is returned)</li>
+</ul>
<p>Example:</p>
<pre class="console"><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>
+rclone rc mount/mount fs=TestDrive: mountPoint=/mnt/tmp vfsOpt=&#39;{&quot;CacheMode&quot;: 2}&#39; mountOpt=&#39;{&quot;AllowOther&quot;: true}&#39;
+rclone rc mount/mount fs=mydrive: mountPoint=* mountType=cmount</code></pre>
<p>The vfsOpt are as described in options/get and can be seen in the
"vfs" section when running and the mountOpt can be seen in the "mount"
section:</p>
<pre class="console"><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>
@@ -19319,7 +19499,6 @@ section:</p>
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>
@@ -19330,7 +19509,6 @@ 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
@@ -19339,7 +19517,6 @@ Rclone's cloud storage systems as a file system with FUSE.</p>
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>
@@ -19349,7 +19526,6 @@ remote</h3>
<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-check">operations/check: check the source and
destination are the same</h3>
<p>Checks the files in the source and destination match. It compares
@@ -19405,7 +19581,6 @@ destination</li>
<li>error - array of strings of all files with errors (hashing or
reading)</li>
</ul>
-<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>
@@ -19415,7 +19590,6 @@ the remote or path</h3>
<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>
@@ -19429,7 +19603,6 @@ for local filesystem</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>
@@ -19443,7 +19616,6 @@ name from url</li>
<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>
@@ -19453,7 +19625,6 @@ path</h3>
<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>
@@ -19464,7 +19635,6 @@ file pointed to</h3>
<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>
@@ -19616,7 +19786,6 @@ operations/hashsum.</p>
<p>See the <a
href="https://rclone.org/commands/rclone_hashsum/">hashsum</a> command
for more information on the above.</p>
-<p><strong>Authentication is required for this call.</strong></p>
<h3 id="operations-hashsumfile">operations/hashsumfile: Produces a hash
for a single file.</h3>
<p>Produces a hash for a single file using the hash named.</p>
@@ -19646,7 +19815,6 @@ data.</p>
<p>See the <a
href="https://rclone.org/commands/rclone_hashsum/">hashsum</a> command
for more information on the above.</p>
-<p><strong>Authentication is required for this call.</strong></p>
<h3 id="operations-list">operations/list: List the given remote and path
in JSON format</h3>
<p>This takes the following parameters:</p>
@@ -19678,7 +19846,6 @@ set</li>
<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>
@@ -19688,7 +19855,6 @@ or container</h3>
</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>
@@ -19702,7 +19868,6 @@ for local filesystem</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>
@@ -19720,7 +19885,6 @@ a public link to the given file or folder.</h3>
</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>
@@ -19730,7 +19894,6 @@ container and all of its contents</h3>
</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>
@@ -19740,7 +19903,6 @@ container</h3>
</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>
@@ -19752,7 +19914,6 @@ directories in the path</h3>
<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-settier">operations/settier: Changes storage tier or
class on all files in the path</h3>
<p>This takes the following parameters:</p>
@@ -19762,7 +19923,6 @@ class on all files in the path</h3>
<p>See the <a
href="https://rclone.org/commands/rclone_settier/">settier</a> command
for more information on the above.</p>
-<p><strong>Authentication is required for this call.</strong></p>
<h3 id="operations-settierfile">operations/settierfile: Changes storage
tier or class on the single file pointed to</h3>
<p>This takes the following parameters:</p>
@@ -19770,7 +19930,6 @@ tier or class on the single file pointed to</h3>
<li>fs - a remote name string e.g. "drive:"</li>
<li>remote - a path within that remote e.g. "dir"</li>
</ul>
-<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>
@@ -19784,7 +19943,6 @@ files in remote</h3>
</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>
@@ -19806,7 +19964,6 @@ 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>
@@ -19815,7 +19972,6 @@ multiform/form-data</h3>
<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><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>
@@ -19892,7 +20048,6 @@ url</h3>
</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>
@@ -19911,7 +20066,6 @@ 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
@@ -19924,7 +20078,6 @@ 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
@@ -19935,7 +20088,6 @@ package.json of the plugin.</p>
</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>
@@ -19946,7 +20098,6 @@ loaded plugin</h3>
</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>
@@ -19957,10 +20108,10 @@ a test plugin</h3>
</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>
+<p><strong>Authentication is not required for this call.</strong></p>
<h3 id="rc-fatal">rc/fatal: This returns an fatal error</h3>
<p>This returns an error with the input as part of its error string.
Useful for testing error handling.</p>
@@ -19968,16 +20119,17 @@ Useful for testing error handling.</p>
commands</h3>
<p>This lists all the registered remote control commands as a JSON map
in the commands response.</p>
+<p><strong>Authentication is not required for this call.</strong></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>
+<p><strong>Authentication is not required for this call.</strong></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="rc-panic">rc/panic: This returns an error by panicking</h3>
<p>This returns an error with the input as part of its error string.
Useful for testing error handling.</p>
@@ -19996,26 +20148,25 @@ Useful for testing error handling.</p>
<p>Eg</p>
<pre><code>rclone rc serve/list</code></pre>
<p>Returns</p>
-<div class="sourceCode" id="cb832"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb832-1"><a href="#cb832-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
-<span id="cb832-2"><a href="#cb832-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;list&quot;</span><span class="fu">:</span> <span class="ot">[</span></span>
-<span id="cb832-3"><a href="#cb832-3" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
-<span id="cb832-4"><a href="#cb832-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;addr&quot;</span><span class="fu">:</span> <span class="st">&quot;[::]:4321&quot;</span><span class="fu">,</span></span>
-<span id="cb832-5"><a href="#cb832-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;id&quot;</span><span class="fu">:</span> <span class="st">&quot;nfs-ffc2a4e5&quot;</span><span class="fu">,</span></span>
-<span id="cb832-6"><a href="#cb832-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;params&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
-<span id="cb832-7"><a href="#cb832-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;fs&quot;</span><span class="fu">:</span> <span class="st">&quot;remote:&quot;</span><span class="fu">,</span></span>
-<span id="cb832-8"><a href="#cb832-8" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;opt&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
-<span id="cb832-9"><a href="#cb832-9" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;ListenAddr&quot;</span><span class="fu">:</span> <span class="st">&quot;:4321&quot;</span></span>
-<span id="cb832-10"><a href="#cb832-10" aria-hidden="true" tabindex="-1"></a> <span class="fu">},</span></span>
-<span id="cb832-11"><a href="#cb832-11" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;type&quot;</span><span class="fu">:</span> <span class="st">&quot;nfs&quot;</span><span class="fu">,</span></span>
-<span id="cb832-12"><a href="#cb832-12" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;vfsOpt&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
-<span id="cb832-13"><a href="#cb832-13" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;CacheMode&quot;</span><span class="fu">:</span> <span class="st">&quot;full&quot;</span></span>
-<span id="cb832-14"><a href="#cb832-14" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
-<span id="cb832-15"><a href="#cb832-15" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
-<span id="cb832-16"><a href="#cb832-16" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
-<span id="cb832-17"><a href="#cb832-17" aria-hidden="true" tabindex="-1"></a> <span class="ot">]</span></span>
-<span id="cb832-18"><a href="#cb832-18" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
-<p><strong>Authentication is required for this call.</strong></p>
+<div class="sourceCode" id="cb844"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb844-1"><a href="#cb844-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
+<span id="cb844-2"><a href="#cb844-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;list&quot;</span><span class="fu">:</span> <span class="ot">[</span></span>
+<span id="cb844-3"><a href="#cb844-3" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
+<span id="cb844-4"><a href="#cb844-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;addr&quot;</span><span class="fu">:</span> <span class="st">&quot;[::]:4321&quot;</span><span class="fu">,</span></span>
+<span id="cb844-5"><a href="#cb844-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;id&quot;</span><span class="fu">:</span> <span class="st">&quot;nfs-ffc2a4e5&quot;</span><span class="fu">,</span></span>
+<span id="cb844-6"><a href="#cb844-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;params&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
+<span id="cb844-7"><a href="#cb844-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;fs&quot;</span><span class="fu">:</span> <span class="st">&quot;remote:&quot;</span><span class="fu">,</span></span>
+<span id="cb844-8"><a href="#cb844-8" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;opt&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
+<span id="cb844-9"><a href="#cb844-9" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;ListenAddr&quot;</span><span class="fu">:</span> <span class="st">&quot;:4321&quot;</span></span>
+<span id="cb844-10"><a href="#cb844-10" aria-hidden="true" tabindex="-1"></a> <span class="fu">},</span></span>
+<span id="cb844-11"><a href="#cb844-11" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;type&quot;</span><span class="fu">:</span> <span class="st">&quot;nfs&quot;</span><span class="fu">,</span></span>
+<span id="cb844-12"><a href="#cb844-12" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;vfsOpt&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
+<span id="cb844-13"><a href="#cb844-13" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;CacheMode&quot;</span><span class="fu">:</span> <span class="st">&quot;full&quot;</span></span>
+<span id="cb844-14"><a href="#cb844-14" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
+<span id="cb844-15"><a href="#cb844-15" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
+<span id="cb844-16"><a href="#cb844-16" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
+<span id="cb844-17"><a href="#cb844-17" aria-hidden="true" tabindex="-1"></a> <span class="ot">]</span></span>
+<span id="cb844-18"><a href="#cb844-18" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<h3 id="serve-start">serve/start: Create a new server</h3>
<p>Create a new server with the specified parameters.</p>
<p>This takes the following parameters:</p>
@@ -20039,15 +20190,14 @@ above.</p>
<pre><code>rclone rc serve/start type=nfs fs=remote: addr=:4321 vfs_cache_mode=full
rclone rc serve/start --json &#39;{&quot;type&quot;:&quot;nfs&quot;,&quot;fs&quot;:&quot;remote:&quot;,&quot;addr&quot;:&quot;:1234&quot;,&quot;vfs_cache_mode&quot;:&quot;full&quot;}&#39;</code></pre>
<p>This will give the reply</p>
-<div class="sourceCode" id="cb834"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb834-1"><a href="#cb834-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
-<span id="cb834-2"><a href="#cb834-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;addr&quot;</span><span class="fu">:</span> <span class="st">&quot;[::]:4321&quot;</span><span class="fu">,</span> <span class="er">//</span> <span class="er">Address</span> <span class="er">the</span> <span class="er">server</span> <span class="er">was</span> <span class="er">started</span> <span class="er">on</span></span>
-<span id="cb834-3"><a href="#cb834-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;id&quot;</span><span class="fu">:</span> <span class="st">&quot;nfs-ecfc6852&quot;</span> <span class="er">//</span> <span class="er">Unique</span> <span class="er">identifier</span> <span class="er">for</span> <span class="er">the</span> <span class="er">server</span> <span class="er">instance</span></span>
-<span id="cb834-4"><a href="#cb834-4" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
+<div class="sourceCode" id="cb846"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb846-1"><a href="#cb846-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
+<span id="cb846-2"><a href="#cb846-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;addr&quot;</span><span class="fu">:</span> <span class="st">&quot;[::]:4321&quot;</span><span class="fu">,</span> <span class="er">//</span> <span class="er">Address</span> <span class="er">the</span> <span class="er">server</span> <span class="er">was</span> <span class="er">started</span> <span class="er">on</span></span>
+<span id="cb846-3"><a href="#cb846-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;id&quot;</span><span class="fu">:</span> <span class="st">&quot;nfs-ecfc6852&quot;</span> <span class="er">//</span> <span class="er">Unique</span> <span class="er">identifier</span> <span class="er">for</span> <span class="er">the</span> <span class="er">server</span> <span class="er">instance</span></span>
+<span id="cb846-4"><a href="#cb846-4" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>Or an error if it failed to start.</p>
<p>Stop the server with <code>serve/stop</code> and list the running
servers with <code>serve/list</code>.</p>
-<p><strong>Authentication is required for this call.</strong></p>
<h3 id="serve-stop">serve/stop: Unserve selected active serve</h3>
<p>Stops a running <code>serve</code> instance by ID.</p>
<p>This takes the following parameters:</p>
@@ -20058,12 +20208,10 @@ servers with <code>serve/list</code>.</p>
not.</p>
<p>Example:</p>
<pre><code>rclone rc serve/stop id=12345</code></pre>
-<p><strong>Authentication is required for this call.</strong></p>
<h3 id="serve-stopall">serve/stopall: Stop all active servers</h3>
<p>Stop all active servers.</p>
<p>This will stop all active servers.</p>
<pre><code>rclone rc serve/stopall</code></pre>
-<p><strong>Authentication is required for this call.</strong></p>
<h3 id="serve-types">serve/types: Show all possible serve types</h3>
<p>This shows all possible serve types and returns them as a list.</p>
<p>This takes no parameters and returns</p>
@@ -20075,53 +20223,104 @@ be passed to serve/start as the serveType parameter.</p>
<p>Eg</p>
<pre><code>rclone rc serve/types</code></pre>
<p>Returns</p>
-<div class="sourceCode" id="cb838"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb838-1"><a href="#cb838-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
-<span id="cb838-2"><a href="#cb838-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;types&quot;</span><span class="fu">:</span> <span class="ot">[</span></span>
-<span id="cb838-3"><a href="#cb838-3" aria-hidden="true" tabindex="-1"></a> <span class="st">&quot;http&quot;</span><span class="ot">,</span></span>
-<span id="cb838-4"><a href="#cb838-4" aria-hidden="true" tabindex="-1"></a> <span class="st">&quot;sftp&quot;</span><span class="ot">,</span></span>
-<span id="cb838-5"><a href="#cb838-5" aria-hidden="true" tabindex="-1"></a> <span class="st">&quot;nfs&quot;</span></span>
-<span id="cb838-6"><a href="#cb838-6" aria-hidden="true" tabindex="-1"></a> <span class="ot">]</span></span>
-<span id="cb838-7"><a href="#cb838-7" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
-<p><strong>Authentication is required for this call.</strong></p>
+<div class="sourceCode" id="cb850"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb850-1"><a href="#cb850-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
+<span id="cb850-2"><a href="#cb850-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;types&quot;</span><span class="fu">:</span> <span class="ot">[</span></span>
+<span id="cb850-3"><a href="#cb850-3" aria-hidden="true" tabindex="-1"></a> <span class="st">&quot;http&quot;</span><span class="ot">,</span></span>
+<span id="cb850-4"><a href="#cb850-4" aria-hidden="true" tabindex="-1"></a> <span class="st">&quot;sftp&quot;</span><span class="ot">,</span></span>
+<span id="cb850-5"><a href="#cb850-5" aria-hidden="true" tabindex="-1"></a> <span class="st">&quot;nfs&quot;</span></span>
+<span id="cb850-6"><a href="#cb850-6" aria-hidden="true" tabindex="-1"></a> <span class="ot">]</span></span>
+<span id="cb850-7"><a href="#cb850-7" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<h3 id="sync-bisync">sync/bisync: Perform bidirectional synchronization
between two paths.</h3>
-<p>This takes the following parameters</p>
+<!--- Docs generated by help.go - use go generate to rebuild - DO NOT EDIT --->
+<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 - Bypass 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>createEmptySrcDirs - Sync creation and deletion of empty
-directories. (Not compatible with --remove-empty-dirs)</li>
-<li>removeEmptyDirs - remove empty directories at the final cleanup
-step</li>
-<li>filtersFile - read filtering patterns from a file</li>
-<li>ignoreListingChecksum - Do not use checksums for listings</li>
-<li>resilient - Allow future runs to retry after certain less-serious
-errors, instead of requiring resync.</li>
-<li>workdir - server directory for history files (default:
-<code>~/.cache/rclone/bisync</code>)</li>
-<li>backupdir1 - --backup-dir for Path1. Must be a non-overlapping path
-on the same remote.</li>
-<li>backupdir2 - --backup-dir for Path2. Must be a non-overlapping path
-on the same remote.</li>
-<li>noCleanup - retain working files</li>
+<li>path1 (required) - (string) a remote directory string e.g.
+<code>drive:path1</code></li>
+<li>path2 (required) - (string) a remote directory string e.g.
+<code>drive:path2</code></li>
+<li>dryRun - (bool) dry-run mode</li>
+<li>backupDir1 - (string) --backup-dir for Path1. Must be a
+non-overlapping path on the same remote.<br />
+</li>
+<li>backupDir2 - (string) --backup-dir for Path2. Must be a
+non-overlapping path on the same remote.<br />
+</li>
+<li>checkAccess - (bool) Ensure expected RCLONE_TEST files are found on
+both Path1 and Path2 filesystems, else abort.<br />
+</li>
+<li>checkFilename - (string) Filename for --check-access (default:
+RCLONE_TEST)<br />
+</li>
+<li>checkSync - (string) Controls comparison of final listings:
+true|false|only (default: true)<br />
+</li>
+<li>compare - (string) Comma-separated list of bisync-specific compare
+options ex. 'size,modtime,checksum' (default: 'size,modtime')<br />
+</li>
+<li>conflictLoser - (ConflictLoserAction) Action to take on the loser of
+a sync conflict (when there is a winner) or on both files (when there is
+no winner): , num, pathname, delete (default: num)<br />
+</li>
+<li>conflictResolve - (string) Automatically resolve conflicts by
+preferring the version that is: none, path1, path2, newer, older,
+larger, smaller (default: none)<br />
+</li>
+<li>conflictSuffix - (string) Suffix to use when renaming a
+--conflict-loser. Can be either one string or two comma-separated
+strings to assign different suffixes to Path1/Path2. (default:
+'conflict')<br />
+</li>
+<li>createEmptySrcDirs - (bool) Sync creation and deletion of empty
+directories. (Not compatible with --remove-empty-dirs)<br />
+</li>
+<li>downloadHash - (bool) Compute hash by downloading when otherwise
+unavailable. (warning: may be slow and use lots of data!)<br />
+</li>
+<li>filtersFile - (string) Read filtering patterns from a file<br />
+</li>
+<li>force - (bool) Bypass --max-delete safety check and run the sync.
+Consider using with --verbose<br />
+</li>
+<li>ignoreListingChecksum - (bool) Do not use checksums for listings
+(add --ignore- checksum to additionally skip post-copy checksum
+checks)<br />
+</li>
+<li>maxLock - (Duration) Consider lock files older than this to be
+expired (default: 0 (never expire)) (minimum: 2m)<br />
+</li>
+<li>noCleanup - (bool) Retain working files (useful for troubleshooting
+and testing).<br />
+</li>
+<li>noSlowHash - (bool) Ignore listing checksums only on backends where
+they are slow<br />
+</li>
+<li>recover - (bool) Automatically recover from interruptions without
+requiring -- resync.<br />
+</li>
+<li>removeEmptyDirs - (bool) Remove ALL empty directories at the final
+cleanup step.<br />
+</li>
+<li>resilient - (bool) Allow future runs to retry after certain
+less-serious errors, instead of requiring --resync.<br />
+</li>
+<li>resync - (bool) Performs the resync run. Equivalent to --resync-mode
+path1. Consider using --verbose or --dry-run first.<br />
+</li>
+<li>resyncMode - (string) During resync, prefer the version that is:
+path1, path2, newer, older, larger, smaller (default: path1 if --resync,
+otherwise none for no resync.)<br />
+</li>
+<li>slowHashSyncOnly - (bool) Ignore slow checksums for listings and
+deltas, but still consider them during sync calls.<br />
+</li>
+<li>workdir - (string) Use custom working dir - useful for testing.
+(default: /home/ncw/.cache/rclone/bisync)</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>
@@ -20134,7 +20333,6 @@ 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>
@@ -20148,7 +20346,6 @@ 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>
@@ -20161,7 +20358,6 @@ 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
@@ -20182,6 +20378,7 @@ supplied.</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>
+<p><strong>Authentication is not required for this call.</strong></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
@@ -20232,6 +20429,7 @@ negative expiry times for which <code>uploading</code> is
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>
+<p><strong>Authentication is not required for this call.</strong></p>
<h3 id="vfs-queue-set-expiry">vfs/queue-set-expiry: Set the expiry time
for an item queued for upload.</h3>
<p>Use this to adjust the <code>expiry</code> time for an item in the
@@ -20311,6 +20509,7 @@ supplied.</p>
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>
+<p><strong>Authentication is not required for this call.</strong></p>
<!-- autogenerated stop -->
<h2 id="api-http">Accessing the remote control via HTTP</h2>
<p>Rclone implements a simple HTTP based protocol.</p>
@@ -20328,16 +20527,16 @@ formatted to be reasonably human-readable.</p>
<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>
-<div class="sourceCode" id="cb846"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb846-1"><a href="#cb846-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
-<span id="cb846-2"><a href="#cb846-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;error&quot;</span><span class="fu">:</span> <span class="st">&quot;Expecting string value for key </span><span class="ch">\&quot;</span><span class="st">remote</span><span class="ch">\&quot;</span><span class="st"> (was float64)&quot;</span><span class="fu">,</span></span>
-<span id="cb846-3"><a href="#cb846-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;input&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
-<span id="cb846-4"><a href="#cb846-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;fs&quot;</span><span class="fu">:</span> <span class="st">&quot;/tmp&quot;</span><span class="fu">,</span></span>
-<span id="cb846-5"><a href="#cb846-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;remote&quot;</span><span class="fu">:</span> <span class="dv">3</span></span>
-<span id="cb846-6"><a href="#cb846-6" aria-hidden="true" tabindex="-1"></a> <span class="fu">},</span></span>
-<span id="cb846-7"><a href="#cb846-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;status&quot;</span><span class="fu">:</span> <span class="dv">400</span><span class="fu">,</span></span>
-<span id="cb846-8"><a href="#cb846-8" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;path&quot;</span><span class="fu">:</span> <span class="st">&quot;operations/rmdir&quot;</span></span>
-<span id="cb846-9"><a href="#cb846-9" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
+<div class="sourceCode" id="cb858"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb858-1"><a href="#cb858-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
+<span id="cb858-2"><a href="#cb858-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;error&quot;</span><span class="fu">:</span> <span class="st">&quot;Expecting string value for key </span><span class="ch">\&quot;</span><span class="st">remote</span><span class="ch">\&quot;</span><span class="st"> (was float64)&quot;</span><span class="fu">,</span></span>
+<span id="cb858-3"><a href="#cb858-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;input&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
+<span id="cb858-4"><a href="#cb858-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;fs&quot;</span><span class="fu">:</span> <span class="st">&quot;/tmp&quot;</span><span class="fu">,</span></span>
+<span id="cb858-5"><a href="#cb858-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;remote&quot;</span><span class="fu">:</span> <span class="dv">3</span></span>
+<span id="cb858-6"><a href="#cb858-6" aria-hidden="true" tabindex="-1"></a> <span class="fu">},</span></span>
+<span id="cb858-7"><a href="#cb858-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;status&quot;</span><span class="fu">:</span> <span class="dv">400</span><span class="fu">,</span></span>
+<span id="cb858-8"><a href="#cb858-8" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;path&quot;</span><span class="fu">:</span> <span class="st">&quot;operations/rmdir&quot;</span></span>
+<span id="cb858-9"><a href="#cb858-9" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>The keys in the error response are:</p>
<ul>
<li>error - error string</li>
@@ -20353,21 +20552,21 @@ requested "Access-Control-Request-Headers" back.</p>
parameters only</h3>
<pre class="console"><code>curl -X POST &#39;http://localhost:5572/rc/noop?potato=1&amp;sausage=2&#39;</code></pre>
<p>Response</p>
-<div class="sourceCode" id="cb848"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb848-1"><a href="#cb848-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
-<span id="cb848-2"><a href="#cb848-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;potato&quot;</span><span class="fu">:</span> <span class="st">&quot;1&quot;</span><span class="fu">,</span></span>
-<span id="cb848-3"><a href="#cb848-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;sausage&quot;</span><span class="fu">:</span> <span class="st">&quot;2&quot;</span></span>
-<span id="cb848-4"><a href="#cb848-4" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
+<div class="sourceCode" id="cb860"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb860-1"><a href="#cb860-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
+<span id="cb860-2"><a href="#cb860-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;potato&quot;</span><span class="fu">:</span> <span class="st">&quot;1&quot;</span><span class="fu">,</span></span>
+<span id="cb860-3"><a href="#cb860-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;sausage&quot;</span><span class="fu">:</span> <span class="st">&quot;2&quot;</span></span>
+<span id="cb860-4"><a href="#cb860-4" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>Here is what an error response looks like:</p>
<pre class="console"><code>curl -X POST &#39;http://localhost:5572/rc/error?potato=1&amp;sausage=2&#39;</code></pre>
-<div class="sourceCode" id="cb850"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb850-1"><a href="#cb850-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
-<span id="cb850-2"><a href="#cb850-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;error&quot;</span><span class="fu">:</span> <span class="st">&quot;arbitrary error on input map[potato:1 sausage:2]&quot;</span><span class="fu">,</span></span>
-<span id="cb850-3"><a href="#cb850-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;input&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
-<span id="cb850-4"><a href="#cb850-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;potato&quot;</span><span class="fu">:</span> <span class="st">&quot;1&quot;</span><span class="fu">,</span></span>
-<span id="cb850-5"><a href="#cb850-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;sausage&quot;</span><span class="fu">:</span> <span class="st">&quot;2&quot;</span></span>
-<span id="cb850-6"><a href="#cb850-6" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
-<span id="cb850-7"><a href="#cb850-7" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
+<div class="sourceCode" id="cb862"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb862-1"><a href="#cb862-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
+<span id="cb862-2"><a href="#cb862-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;error&quot;</span><span class="fu">:</span> <span class="st">&quot;arbitrary error on input map[potato:1 sausage:2]&quot;</span><span class="fu">,</span></span>
+<span id="cb862-3"><a href="#cb862-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;input&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
+<span id="cb862-4"><a href="#cb862-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;potato&quot;</span><span class="fu">:</span> <span class="st">&quot;1&quot;</span><span class="fu">,</span></span>
+<span id="cb862-5"><a href="#cb862-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;sausage&quot;</span><span class="fu">:</span> <span class="st">&quot;2&quot;</span></span>
+<span id="cb862-6"><a href="#cb862-6" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
+<span id="cb862-7"><a href="#cb862-7" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>Note that curl doesn't return errors to the shell unless you use the
<code>-f</code> option</p>
<pre class="console"><code>$ curl -f -X POST &#39;http://localhost:5572/rc/error?potato=1&amp;sausage=2&#39;
@@ -20377,38 +20576,38 @@ $ echo $?
<h3 id="using-post-with-a-form">Using POST with a form</h3>
<pre class="console"><code>curl --data &quot;potato=1&quot; --data &quot;sausage=2&quot; http://localhost:5572/rc/noop</code></pre>
<p>Response</p>
-<div class="sourceCode" id="cb853"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb853-1"><a href="#cb853-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
-<span id="cb853-2"><a href="#cb853-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;potato&quot;</span><span class="fu">:</span> <span class="st">&quot;1&quot;</span><span class="fu">,</span></span>
-<span id="cb853-3"><a href="#cb853-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;sausage&quot;</span><span class="fu">:</span> <span class="st">&quot;2&quot;</span></span>
-<span id="cb853-4"><a href="#cb853-4" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
+<div class="sourceCode" id="cb865"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb865-1"><a href="#cb865-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
+<span id="cb865-2"><a href="#cb865-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;potato&quot;</span><span class="fu">:</span> <span class="st">&quot;1&quot;</span><span class="fu">,</span></span>
+<span id="cb865-3"><a href="#cb865-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;sausage&quot;</span><span class="fu">:</span> <span class="st">&quot;2&quot;</span></span>
+<span id="cb865-4"><a href="#cb865-4" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>Note that you can combine these with URL parameters too with the POST
parameters taking precedence.</p>
<pre class="console"><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>
-<div class="sourceCode" id="cb855"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb855-1"><a href="#cb855-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
-<span id="cb855-2"><a href="#cb855-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;potato&quot;</span><span class="fu">:</span> <span class="st">&quot;1&quot;</span><span class="fu">,</span></span>
-<span id="cb855-3"><a href="#cb855-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;rutabaga&quot;</span><span class="fu">:</span> <span class="st">&quot;3&quot;</span><span class="fu">,</span></span>
-<span id="cb855-4"><a href="#cb855-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;sausage&quot;</span><span class="fu">:</span> <span class="st">&quot;4&quot;</span></span>
-<span id="cb855-5"><a href="#cb855-5" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
+<div class="sourceCode" id="cb867"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb867-1"><a href="#cb867-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
+<span id="cb867-2"><a href="#cb867-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;potato&quot;</span><span class="fu">:</span> <span class="st">&quot;1&quot;</span><span class="fu">,</span></span>
+<span id="cb867-3"><a href="#cb867-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;rutabaga&quot;</span><span class="fu">:</span> <span class="st">&quot;3&quot;</span><span class="fu">,</span></span>
+<span id="cb867-4"><a href="#cb867-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;sausage&quot;</span><span class="fu">:</span> <span class="st">&quot;4&quot;</span></span>
+<span id="cb867-5"><a href="#cb867-5" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<h3 id="using-post-with-a-json-blob">Using POST with a JSON blob</h3>
<pre class="console"><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>
-<div class="sourceCode" id="cb857"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb857-1"><a href="#cb857-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
-<span id="cb857-2"><a href="#cb857-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;password&quot;</span><span class="fu">:</span> <span class="st">&quot;xyz&quot;</span><span class="fu">,</span></span>
-<span id="cb857-3"><a href="#cb857-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;username&quot;</span><span class="fu">:</span> <span class="st">&quot;xyz&quot;</span></span>
-<span id="cb857-4"><a href="#cb857-4" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
+<div class="sourceCode" id="cb869"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb869-1"><a href="#cb869-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
+<span id="cb869-2"><a href="#cb869-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;password&quot;</span><span class="fu">:</span> <span class="st">&quot;xyz&quot;</span><span class="fu">,</span></span>
+<span id="cb869-3"><a href="#cb869-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;username&quot;</span><span class="fu">:</span> <span class="st">&quot;xyz&quot;</span></span>
+<span id="cb869-4"><a href="#cb869-4" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>This can be combined with URL parameters too if required. The JSON
blob takes precedence.</p>
<pre class="console"><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>
-<div class="sourceCode" id="cb859"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb859-1"><a href="#cb859-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
-<span id="cb859-2"><a href="#cb859-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;potato&quot;</span><span class="fu">:</span> <span class="dv">2</span><span class="fu">,</span></span>
-<span id="cb859-3"><a href="#cb859-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;rutabaga&quot;</span><span class="fu">:</span> <span class="st">&quot;3&quot;</span><span class="fu">,</span></span>
-<span id="cb859-4"><a href="#cb859-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;sausage&quot;</span><span class="fu">:</span> <span class="dv">1</span></span>
-<span id="cb859-5"><a href="#cb859-5" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
+<div class="sourceCode" id="cb871"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb871-1"><a href="#cb871-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
+<span id="cb871-2"><a href="#cb871-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;potato&quot;</span><span class="fu">:</span> <span class="dv">2</span><span class="fu">,</span></span>
+<span id="cb871-3"><a href="#cb871-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;rutabaga&quot;</span><span class="fu">:</span> <span class="st">&quot;3&quot;</span><span class="fu">,</span></span>
+<span id="cb871-4"><a href="#cb871-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;sausage&quot;</span><span class="fu">:</span> <span class="dv">1</span></span>
+<span id="cb871-5"><a href="#cb871-5" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<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>
@@ -21088,7 +21287,7 @@ characters in file names. So you would add the Windows set which are</p>
<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
+<p>As another 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
@@ -21496,7 +21695,7 @@ split into groups.</p>
--tpslimit float Limit HTTP transactions per second to this
--tpslimit-burst int Max burst of transactions for --tpslimit (default 1)
--use-cookies Enable session cookiejar
- --user-agent string Set the user-agent to a specified string (default &quot;rclone/v1.73.0&quot;)</code></pre>
+ --user-agent string Set the user-agent to a specified string (default &quot;rclone/v1.74.0&quot;)</code></pre>
<h2 id="performance">Performance</h2>
<p>Flags helpful for increasing performance.</p>
<pre><code> --buffer-size SizeSuffix In memory buffer size when reading files for each --transfer (default 16Mi)
@@ -21531,7 +21730,7 @@ split into groups.</p>
<h2 id="debugging">Debugging</h2>
<p>Flags for developers.</p>
<pre><code> --cpuprofile string Write cpu profile to file
- --dump DumpFlags List of items to dump from: headers, bodies, requests, responses, auth, filters, goroutines, openfiles, mapper
+ --dump DumpFlags List of items to dump from: headers, bodies, requests, responses, auth, filters, goroutines, openfiles, mapper, curl
--dump-bodies Dump HTTP headers and bodies - may contain sensitive info
--dump-headers Dump HTTP headers - may contain sensitive info
--memprofile string Write memory profile to file</code></pre>
@@ -21670,6 +21869,8 @@ split into groups.</p>
--azureblob-connection-string string Storage Connection String
--azureblob-copy-concurrency int Concurrency for multipart copy (default 512)
--azureblob-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 8Mi)
+ --azureblob-copy-total-concurrency int Global concurrency limit for multipart copy chunks
+ --azureblob-decompress If set this will decompress gzip encoded objects
--azureblob-delete-snapshots string Set to specify how to deal with snapshots on blob deletion
--azureblob-description string Description of the remote
--azureblob-directory-markers Upload an empty object with a trailing slash when a new directory is created
@@ -21920,9 +22121,11 @@ split into groups.</p>
--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
+ --filelu-chunk-size SizeSuffix Chunk size to use for uploading. Used for multipart uploads (default 64Mi)
--filelu-description string Description of the remote
--filelu-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,Colon,Question,Asterisk,Pipe,Hash,Percent,BackSlash,CrLf,Del,Ctl,LeftSpace,LeftPeriod,LeftTilde,LeftCrLfHtVt,RightSpace,RightPeriod,RightCrLfHtVt,InvalidUtf8,Dot,SquareBracket,Semicolon,Exclamation)
--filelu-key string Your FileLu Rclone key from My Account
+ --filelu-upload-cutoff SizeSuffix Cutoff for switching to chunked upload. Any files larger than this will be uploaded in chunks of chunk_size (default 500Mi)
--filen-api-key string API Key for your Filen account (obscured)
--filen-auth-version string Authentication Version (internal use only)
--filen-base-folder-uuid string UUID of Account Root Directory (internal use only)
@@ -22043,11 +22246,24 @@ split into groups.</p>
--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
+ --huaweidrive-auth-url string Auth server URL
+ --huaweidrive-chunk-size SizeSuffix Upload chunk size (default 8Mi)
+ --huaweidrive-client-credentials Use client credentials OAuth flow
+ --huaweidrive-client-id string OAuth Client Id
+ --huaweidrive-client-secret string OAuth Client Secret
+ --huaweidrive-description string Description of the remote
+ --huaweidrive-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftSpace,LeftPeriod,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot)
+ --huaweidrive-list-chunk int Size of listing chunk 1-1000 (default 1000)
+ --huaweidrive-root-folder-id string ID of the root folder
+ --huaweidrive-token string OAuth Access Token as a JSON blob
+ --huaweidrive-token-url string Token server url
+ --huaweidrive-upload-cutoff SizeSuffix Cutoff for switching to resumable upload (default 20Mi)
--iclouddrive-apple-id string Apple ID
- --iclouddrive-client-id string Client id (default &quot;d39ba9916b7251055b22c7f910e2ea796ee65e98b2ddecea8f5dde8d9d1a815d&quot;)
+ --iclouddrive-client-id string Client ID for iCloud API access (default &quot;d39ba9916b7251055b22c7f910e2ea796ee65e98b2ddecea8f5dde8d9d1a815d&quot;)
--iclouddrive-description string Description of the remote
--iclouddrive-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
--iclouddrive-password string Password (obscured)
+ --iclouddrive-service string iCloud service to use (default &quot;drive&quot;)
--imagekit-description string Description of the remote
--imagekit-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Dollar,Question,Hash,Percent,BackSlash,Del,Ctl,InvalidUtf8,Dot,SquareBracket)
--imagekit-endpoint string You can find your ImageKit.io URL endpoint in your [dashboard](https://imagekit.io/dashboard/developer/api-keys)
@@ -22066,17 +22282,20 @@ split into groups.</p>
--internetarchive-item-metadata stringArray Metadata to be set on the IA item, this is different from file-level metadata that can be set using --metadata-set
--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)
+ --internxt-chunk-size SizeSuffix Chunk size for multipart uploads (default 30Mi)
--internxt-description string Description of the remote
--internxt-email string Email of your Internxt account
--internxt-encoding Encoding The encoding for the backend (default Slash,BackSlash,CrLf,RightPeriod,InvalidUtf8,Dot)
--internxt-pass string Password (obscured)
--internxt-skip-hash-validation Skip hash validation when downloading files (default true)
+ --internxt-upload-concurrency int Concurrency for multipart uploads (default 4)
+ --internxt-upload-cutoff SizeSuffix Cutoff for switching to multipart upload (default 100Mi)
--jottacloud-auth-url string Auth server URL
--jottacloud-client-credentials Use client credentials OAuth flow
--jottacloud-client-id string OAuth Client Id
--jottacloud-client-secret string OAuth Client Secret
--jottacloud-description string Description of the remote
- --jottacloud-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot)
+ --jottacloud-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Percent,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
@@ -22093,6 +22312,8 @@ split into groups.</p>
--koofr-setmtime Does the backend support setting modification time (default true)
--koofr-user string Your user name
--linkbox-description string Description of the remote
+ --linkbox-email string Email for login
+ --linkbox-password string Password for login (obscured)
--linkbox-token string Token from https://www.linkbox.to/admin/account
--local-case-insensitive Force the filesystem to report itself as case insensitive
--local-case-sensitive Force the filesystem to report itself as case sensitive
@@ -22238,7 +22459,7 @@ split into groups.</p>
--premiumizeme-token string OAuth Access Token as a JSON blob
--premiumizeme-token-url string Token server url
--protondrive-2fa string The 2FA code
- --protondrive-app-version string The app version string (default &quot;[email protected]+rclone&quot;)
+ --protondrive-app-version string The app version string
--protondrive-description string Description of the remote
--protondrive-enable-caching Caches the files and folders metadata to reduce API calls (default true)
--protondrive-encoding Encoding The encoding for the backend (default Slash,LeftSpace,RightSpace,InvalidUtf8,Dot)
@@ -22279,6 +22500,8 @@ split into groups.</p>
--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-bucket-object-lock-enabled Enable Object Lock when creating new buckets
+ --s3-bypass-governance-retention Allow deleting or modifying objects locked with GOVERNANCE mode
--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
@@ -22293,11 +22516,13 @@ split into groups.</p>
--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-ibm-api-key string IBM API Key to be used to obtain IAM token
+ --s3-ibm-iam-endpoint string IBM IAM Endpoint to use for authentication
--s3-ibm-resource-instance-id string IBM service instance id
--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-list-versions-oldest-first Tristate Set if the backend returns object versions oldest first (default unset)
--s3-location-constraint string Location constraint - must be set to match the Region
--s3-max-upload-parts int Maximum number of parts in a multipart upload (default 10000)
--s3-might-gzip Tristate Set this if the backend might gzip objects (default unset)
@@ -22305,6 +22530,11 @@ split into groups.</p>
--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-object-lock-legal-hold-status string Object Lock legal hold status to apply when uploading or copying objects
+ --s3-object-lock-mode string Object Lock mode to apply when uploading or copying objects
+ --s3-object-lock-retain-until-date string Object Lock retention until date to apply when uploading or copying objects
+ --s3-object-lock-set-after-upload Set Object Lock via separate API calls after upload
+ --s3-object-lock-supported Tristate Whether the provider supports S3 Object Lock (default unset)
--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
@@ -22623,30 +22853,30 @@ to the Swarm cluster and save as
<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>
-<div class="sourceCode" id="cb889"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb889-1"><a href="#cb889-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[gdrive]</span></span>
-<span id="cb889-2"><a href="#cb889-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> drive</span></span>
-<span id="cb889-3"><a href="#cb889-3" aria-hidden="true" tabindex="-1"></a><span class="dt">scope </span><span class="ot">=</span><span class="st"> drive</span></span>
-<span id="cb889-4"><a href="#cb889-4" aria-hidden="true" tabindex="-1"></a><span class="dt">drive_id </span><span class="ot">=</span><span class="st"> 1234567...</span></span>
-<span id="cb889-5"><a href="#cb889-5" aria-hidden="true" tabindex="-1"></a><span class="dt">root_folder_id </span><span class="ot">=</span><span class="st"> 0Abcd...</span></span>
-<span id="cb889-6"><a href="#cb889-6" aria-hidden="true" tabindex="-1"></a><span class="dt">token </span><span class="ot">=</span><span class="st"> {&quot;access_token&quot;:...}</span></span></code></pre></div>
+<div class="sourceCode" id="cb901"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb901-1"><a href="#cb901-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[gdrive]</span></span>
+<span id="cb901-2"><a href="#cb901-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> drive</span></span>
+<span id="cb901-3"><a href="#cb901-3" aria-hidden="true" tabindex="-1"></a><span class="dt">scope </span><span class="ot">=</span><span class="st"> drive</span></span>
+<span id="cb901-4"><a href="#cb901-4" aria-hidden="true" tabindex="-1"></a><span class="dt">drive_id </span><span class="ot">=</span><span class="st"> 1234567...</span></span>
+<span id="cb901-5"><a href="#cb901-5" aria-hidden="true" tabindex="-1"></a><span class="dt">root_folder_id </span><span class="ot">=</span><span class="st"> 0Abcd...</span></span>
+<span id="cb901-6"><a href="#cb901-6" aria-hidden="true" tabindex="-1"></a><span class="dt">token </span><span class="ot">=</span><span class="st"> {&quot;access_token&quot;:...}</span></span></code></pre></div>
<p>Now create the file named <code>example.yml</code> with a swarm stack
description like this:</p>
-<div class="sourceCode" id="cb890"><pre
-class="sourceCode yaml"><code class="sourceCode yaml"><span id="cb890-1"><a href="#cb890-1" aria-hidden="true" tabindex="-1"></a><span class="fu">version</span><span class="kw">:</span><span class="at"> </span><span class="st">&#39;3&#39;</span></span>
-<span id="cb890-2"><a href="#cb890-2" aria-hidden="true" tabindex="-1"></a><span class="fu">services</span><span class="kw">:</span></span>
-<span id="cb890-3"><a href="#cb890-3" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">heimdall</span><span class="kw">:</span></span>
-<span id="cb890-4"><a href="#cb890-4" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">image</span><span class="kw">:</span><span class="at"> linuxserver/heimdall:latest</span></span>
-<span id="cb890-5"><a href="#cb890-5" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">ports</span><span class="kw">:</span><span class="at"> </span><span class="kw">[</span><span class="dv">8080</span><span class="at">:</span><span class="dv">80</span><span class="kw">]</span></span>
-<span id="cb890-6"><a href="#cb890-6" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">volumes</span><span class="kw">:</span><span class="at"> </span><span class="kw">[</span><span class="at">configdata:/config</span><span class="kw">]</span></span>
-<span id="cb890-7"><a href="#cb890-7" aria-hidden="true" tabindex="-1"></a><span class="fu">volumes</span><span class="kw">:</span></span>
-<span id="cb890-8"><a href="#cb890-8" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">configdata</span><span class="kw">:</span></span>
-<span id="cb890-9"><a href="#cb890-9" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">driver</span><span class="kw">:</span><span class="at"> rclone</span></span>
-<span id="cb890-10"><a href="#cb890-10" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">driver_opts</span><span class="kw">:</span></span>
-<span id="cb890-11"><a href="#cb890-11" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">remote</span><span class="kw">:</span><span class="at"> </span><span class="st">&#39;gdrive:heimdall&#39;</span></span>
-<span id="cb890-12"><a href="#cb890-12" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">allow_other</span><span class="kw">:</span><span class="at"> </span><span class="st">&#39;true&#39;</span></span>
-<span id="cb890-13"><a href="#cb890-13" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">vfs_cache_mode</span><span class="kw">:</span><span class="at"> full</span></span>
-<span id="cb890-14"><a href="#cb890-14" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">poll_interval</span><span class="kw">:</span><span class="at"> </span><span class="dv">0</span></span></code></pre></div>
+<div class="sourceCode" id="cb902"><pre
+class="sourceCode yaml"><code class="sourceCode yaml"><span id="cb902-1"><a href="#cb902-1" aria-hidden="true" tabindex="-1"></a><span class="fu">version</span><span class="kw">:</span><span class="at"> </span><span class="st">&#39;3&#39;</span></span>
+<span id="cb902-2"><a href="#cb902-2" aria-hidden="true" tabindex="-1"></a><span class="fu">services</span><span class="kw">:</span></span>
+<span id="cb902-3"><a href="#cb902-3" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">heimdall</span><span class="kw">:</span></span>
+<span id="cb902-4"><a href="#cb902-4" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">image</span><span class="kw">:</span><span class="at"> linuxserver/heimdall:latest</span></span>
+<span id="cb902-5"><a href="#cb902-5" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">ports</span><span class="kw">:</span><span class="at"> </span><span class="kw">[</span><span class="dv">8080</span><span class="at">:</span><span class="dv">80</span><span class="kw">]</span></span>
+<span id="cb902-6"><a href="#cb902-6" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">volumes</span><span class="kw">:</span><span class="at"> </span><span class="kw">[</span><span class="at">configdata:/config</span><span class="kw">]</span></span>
+<span id="cb902-7"><a href="#cb902-7" aria-hidden="true" tabindex="-1"></a><span class="fu">volumes</span><span class="kw">:</span></span>
+<span id="cb902-8"><a href="#cb902-8" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">configdata</span><span class="kw">:</span></span>
+<span id="cb902-9"><a href="#cb902-9" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">driver</span><span class="kw">:</span><span class="at"> rclone</span></span>
+<span id="cb902-10"><a href="#cb902-10" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">driver_opts</span><span class="kw">:</span></span>
+<span id="cb902-11"><a href="#cb902-11" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">remote</span><span class="kw">:</span><span class="at"> </span><span class="st">&#39;gdrive:heimdall&#39;</span></span>
+<span id="cb902-12"><a href="#cb902-12" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">allow_other</span><span class="kw">:</span><span class="at"> </span><span class="st">&#39;true&#39;</span></span>
+<span id="cb902-13"><a href="#cb902-13" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">vfs_cache_mode</span><span class="kw">:</span><span class="at"> full</span></span>
+<span id="cb902-14"><a href="#cb902-14" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">poll_interval</span><span class="kw">:</span><span class="at"> </span><span class="dv">0</span></span></code></pre></div>
<p>and run the stack:</p>
<pre class="console"><code>docker stack deploy example -c ./example.yml</code></pre>
<p>After a few seconds docker will spread the parsed stack description
@@ -22770,16 +23000,16 @@ 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>
-<div class="sourceCode" id="cb899"><pre
-class="sourceCode yaml"><code class="sourceCode yaml"><span id="cb899-1"><a href="#cb899-1" aria-hidden="true" tabindex="-1"></a><span class="fu">volumes</span><span class="kw">:</span></span>
-<span id="cb899-2"><a href="#cb899-2" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">volume_name_1</span><span class="kw">:</span></span>
-<span id="cb899-3"><a href="#cb899-3" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">driver</span><span class="kw">:</span><span class="at"> rclone</span></span>
-<span id="cb899-4"><a href="#cb899-4" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">driver_opts</span><span class="kw">:</span></span>
-<span id="cb899-5"><a href="#cb899-5" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">remote</span><span class="kw">:</span><span class="at"> </span><span class="st">&#39;gdrive:&#39;</span></span>
-<span id="cb899-6"><a href="#cb899-6" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">allow_other</span><span class="kw">:</span><span class="at"> </span><span class="st">&#39;true&#39;</span></span>
-<span id="cb899-7"><a href="#cb899-7" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">vfs_cache_mode</span><span class="kw">:</span><span class="at"> full</span></span>
-<span id="cb899-8"><a href="#cb899-8" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">token</span><span class="kw">:</span><span class="at"> </span><span class="st">&#39;{&quot;type&quot;: &quot;borrower&quot;, &quot;expires&quot;: &quot;2021-12-31&quot;}&#39;</span></span>
-<span id="cb899-9"><a href="#cb899-9" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">poll_interval</span><span class="kw">:</span><span class="at"> </span><span class="dv">0</span></span></code></pre></div>
+<div class="sourceCode" id="cb911"><pre
+class="sourceCode yaml"><code class="sourceCode yaml"><span id="cb911-1"><a href="#cb911-1" aria-hidden="true" tabindex="-1"></a><span class="fu">volumes</span><span class="kw">:</span></span>
+<span id="cb911-2"><a href="#cb911-2" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">volume_name_1</span><span class="kw">:</span></span>
+<span id="cb911-3"><a href="#cb911-3" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">driver</span><span class="kw">:</span><span class="at"> rclone</span></span>
+<span id="cb911-4"><a href="#cb911-4" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">driver_opts</span><span class="kw">:</span></span>
+<span id="cb911-5"><a href="#cb911-5" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">remote</span><span class="kw">:</span><span class="at"> </span><span class="st">&#39;gdrive:&#39;</span></span>
+<span id="cb911-6"><a href="#cb911-6" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">allow_other</span><span class="kw">:</span><span class="at"> </span><span class="st">&#39;true&#39;</span></span>
+<span id="cb911-7"><a href="#cb911-7" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">vfs_cache_mode</span><span class="kw">:</span><span class="at"> full</span></span>
+<span id="cb911-8"><a href="#cb911-8" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">token</span><span class="kw">:</span><span class="at"> </span><span class="st">&#39;{&quot;type&quot;: &quot;borrower&quot;, &quot;expires&quot;: &quot;2021-12-31&quot;}&#39;</span></span>
+<span id="cb911-9"><a href="#cb911-9" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">poll_interval</span><span class="kw">:</span><span class="at"> </span><span class="dv">0</span></span></code></pre></div>
<p>Notice a few important details:</p>
<ul>
<li>YAML prefers <code>_</code> in option names instead of
@@ -22931,16 +23161,16 @@ docker plugin inspect rclone</code></pre>
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>
-<div class="sourceCode" id="cb903"><pre
-class="sourceCode yaml"><code class="sourceCode yaml"><span id="cb903-1"><a href="#cb903-1" aria-hidden="true" tabindex="-1"></a><span class="fu">services</span><span class="kw">:</span></span>
-<span id="cb903-2"><a href="#cb903-2" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">my_service</span><span class="kw">:</span></span>
-<span id="cb903-3"><a href="#cb903-3" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">image</span><span class="kw">:</span><span class="at"> my_image</span></span>
-<span id="cb903-4"><a href="#cb903-4" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">healthcheck</span><span class="kw">:</span></span>
-<span id="cb903-5"><a href="#cb903-5" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">test</span><span class="kw">:</span><span class="at"> ls /path/to/rclone/mount || exit 1</span></span>
-<span id="cb903-6"><a href="#cb903-6" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">interval</span><span class="kw">:</span><span class="at"> 1m</span></span>
-<span id="cb903-7"><a href="#cb903-7" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">timeout</span><span class="kw">:</span><span class="at"> 15s</span></span>
-<span id="cb903-8"><a href="#cb903-8" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">retries</span><span class="kw">:</span><span class="at"> </span><span class="dv">3</span></span>
-<span id="cb903-9"><a href="#cb903-9" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">start_period</span><span class="kw">:</span><span class="at"> 15s</span></span></code></pre></div>
+<div class="sourceCode" id="cb915"><pre
+class="sourceCode yaml"><code class="sourceCode yaml"><span id="cb915-1"><a href="#cb915-1" aria-hidden="true" tabindex="-1"></a><span class="fu">services</span><span class="kw">:</span></span>
+<span id="cb915-2"><a href="#cb915-2" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">my_service</span><span class="kw">:</span></span>
+<span id="cb915-3"><a href="#cb915-3" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">image</span><span class="kw">:</span><span class="at"> my_image</span></span>
+<span id="cb915-4"><a href="#cb915-4" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">healthcheck</span><span class="kw">:</span></span>
+<span id="cb915-5"><a href="#cb915-5" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">test</span><span class="kw">:</span><span class="at"> ls /path/to/rclone/mount || exit 1</span></span>
+<span id="cb915-6"><a href="#cb915-6" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">interval</span><span class="kw">:</span><span class="at"> 1m</span></span>
+<span id="cb915-7"><a href="#cb915-7" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">timeout</span><span class="kw">:</span><span class="at"> 15s</span></span>
+<span id="cb915-8"><a href="#cb915-8" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">retries</span><span class="kw">:</span><span class="at"> </span><span class="dv">3</span></span>
+<span id="cb915-9"><a href="#cb915-9" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">start_period</span><span class="kw">:</span><span class="at"> 15s</span></span></code></pre></div>
<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
@@ -23855,6 +24085,12 @@ file to pass its expiration time while the process that created it is
still running -- and you can therefore be reasonably sure that any
<em>expired</em> lock file you may find was left there by an interrupted
run, not one that is still running and just taking awhile.</p>
+<p>If a lock file exists but its contents are unreadable (for example,
+due to an incomplete write or disk error), it is treated as expired when
+<code>--max-lock</code> is set to a value greater than <code>0</code>.
+If <code>--max-lock</code> is <code>0</code> or not set, an unreadable
+lock file will produce an error and block future runs until removed
+manually.</p>
<p>If <code>--max-lock</code> is <code>0</code> or not set, the default
is that lock files will never expire, and will block future runs (of
these same two bisync paths) indefinitely.</p>
@@ -24203,17 +24439,7 @@ investigation:</p>
<li><a
href="https://pub.rclone.org/integration-tests/current/dropbox-cmd.bisync-TestDropbox-1.txt"><code>TestBisyncRemoteRemote/normalization</code></a></li>
</ul></li>
-<li><code>TestSeafile</code> (<code>seafile</code>)
-<ul>
-<li><a
-href="https://pub.rclone.org/integration-tests/current/seafile-cmd.bisync-TestSeafile-1.txt"><code>TestBisyncLocalRemote/volatile</code></a></li>
-</ul></li>
-<li><code>TestSeafileV6</code> (<code>seafile</code>)
-<ul>
-<li><a
-href="https://pub.rclone.org/integration-tests/current/seafile-cmd.bisync-TestSeafileV6-1.txt"><code>TestBisyncLocalRemote/volatile</code></a></li>
-</ul></li>
-<li>Updated: 2026-01-30-010015
+<li>Updated: 2026-05-01-010013
<!--- end list_failures - DO NOT EDIT THIS SECTION - use make commanddocs ---></li>
</ul>
<p>The following backends either have not been tested recently or have
@@ -24767,19 +24993,19 @@ versions I manually run the following command:
<li>The Dropbox client then syncs the changes with Dropbox.</li>
</ul>
<h3 id="rclone-conf-snippet">rclone.conf snippet</h3>
-<div class="sourceCode" id="cb936"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb936-1"><a href="#cb936-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[Dropbox]</span></span>
-<span id="cb936-2"><a href="#cb936-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> dropbox</span></span>
-<span id="cb936-3"><a href="#cb936-3" aria-hidden="true" tabindex="-1"></a><span class="dt">...</span></span>
-<span id="cb936-4"><a href="#cb936-4" aria-hidden="true" tabindex="-1"></a></span>
-<span id="cb936-5"><a href="#cb936-5" aria-hidden="true" tabindex="-1"></a><span class="kw">[Dropcrypt]</span></span>
-<span id="cb936-6"><a href="#cb936-6" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> crypt</span></span>
-<span id="cb936-7"><a href="#cb936-7" aria-hidden="true" tabindex="-1"></a><span class="dt">remote </span><span class="ot">=</span><span class="st"> /path/to/DBoxroot/crypt # on the Linux server</span></span>
-<span id="cb936-8"><a href="#cb936-8" aria-hidden="true" tabindex="-1"></a><span class="dt">remote </span><span class="ot">=</span><span class="st"> C:\Users\MyLogin\Dropbox\crypt # on the Windows notebook</span></span>
-<span id="cb936-9"><a href="#cb936-9" aria-hidden="true" tabindex="-1"></a><span class="dt">filename_encryption </span><span class="ot">=</span><span class="st"> standard</span></span>
-<span id="cb936-10"><a href="#cb936-10" aria-hidden="true" tabindex="-1"></a><span class="dt">directory_name_encryption </span><span class="ot">=</span><span class="st"> </span><span class="kw">true</span></span>
-<span id="cb936-11"><a href="#cb936-11" aria-hidden="true" tabindex="-1"></a><span class="dt">password </span><span class="ot">=</span><span class="st"> ...</span></span>
-<span id="cb936-12"><a href="#cb936-12" aria-hidden="true" tabindex="-1"></a><span class="dt">...</span></span></code></pre></div>
+<div class="sourceCode" id="cb948"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb948-1"><a href="#cb948-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[Dropbox]</span></span>
+<span id="cb948-2"><a href="#cb948-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> dropbox</span></span>
+<span id="cb948-3"><a href="#cb948-3" aria-hidden="true" tabindex="-1"></a><span class="dt">...</span></span>
+<span id="cb948-4"><a href="#cb948-4" aria-hidden="true" tabindex="-1"></a></span>
+<span id="cb948-5"><a href="#cb948-5" aria-hidden="true" tabindex="-1"></a><span class="kw">[Dropcrypt]</span></span>
+<span id="cb948-6"><a href="#cb948-6" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> crypt</span></span>
+<span id="cb948-7"><a href="#cb948-7" aria-hidden="true" tabindex="-1"></a><span class="dt">remote </span><span class="ot">=</span><span class="st"> /path/to/DBoxroot/crypt # on the Linux server</span></span>
+<span id="cb948-8"><a href="#cb948-8" aria-hidden="true" tabindex="-1"></a><span class="dt">remote </span><span class="ot">=</span><span class="st"> C:\Users\MyLogin\Dropbox\crypt # on the Windows notebook</span></span>
+<span id="cb948-9"><a href="#cb948-9" aria-hidden="true" tabindex="-1"></a><span class="dt">filename_encryption </span><span class="ot">=</span><span class="st"> standard</span></span>
+<span id="cb948-10"><a href="#cb948-10" aria-hidden="true" tabindex="-1"></a><span class="dt">directory_name_encryption </span><span class="ot">=</span><span class="st"> </span><span class="kw">true</span></span>
+<span id="cb948-11"><a href="#cb948-11" aria-hidden="true" tabindex="-1"></a><span class="dt">password </span><span class="ot">=</span><span class="st"> ...</span></span>
+<span id="cb948-12"><a href="#cb948-12" aria-hidden="true" tabindex="-1"></a><span class="dt">...</span></span></code></pre></div>
<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
@@ -25117,6 +25343,13 @@ article</a>.</p>
href="http://www.cis.upenn.edu/%7Ebcpierce/papers/index.shtml#File%20Synchronization">Benjamin
Pierce</a> about <em>Unison</em> and synchronization in general.</p>
<h2 id="changelog">Changelog</h2>
+<h3 id="v1.74"><code>v1.74</code></h3>
+<ul>
+<li>Added several missing <code>rc</code> parameters.</li>
+<li>Optional <code>rc</code> parameters are now truly optional.</li>
+<li><code>rc</code> output now provides more structured
+information.</li>
+</ul>
<h3 id="v1.71"><code>v1.71</code></h3>
<ul>
<li><p><code>bisync</code> is now officially released from
@@ -25718,12 +25951,15 @@ existing remote).</p>
<li>DigitalOcean Spaces</li>
<li>Dreamhost</li>
<li>Exaba</li>
+<li>Fastly Object Storage</li>
<li>FileLu S5 (S3-Compatible Object Storage)</li>
<li>GCS</li>
<li>Hetzner</li>
+<li>Hitachi Content Platform (HCP)</li>
<li>Huawei OBS</li>
<li>IBM COS S3</li>
<li>IDrive e2</li>
+<li>Impossible Cloud</li>
<li>Intercolo Object Storage</li>
<li>IONOS Cloud</li>
<li>Leviia Object Storage</li>
@@ -25746,11 +25982,12 @@ existing remote).</p>
<li>Selectel</li>
<li>Servercore Object Storage</li>
<li>Spectra Logic</li>
-<li>StackPath</li>
<li>Storj</li>
<li>Synology C2 Object Storage</li>
<li>Tencent Cloud Object Storage (COS)</li>
+<li>US3</li>
<li>Wasabi</li>
+<li>Zadara Object Storage</li>
<li>Zata</li>
</ul>
<!-- markdownlint-restore -->
@@ -26300,6 +26537,24 @@ work with the SDK properly:</p>
</tr>
</tbody>
</table>
+<h4 id="important-note-about-double-slashes">Important note about double
+slashes (<code>//</code>)</h4>
+<p>Object keys containing consecutive forward slashes (<code>//</code>)
+are <strong>not supported</strong> by rclone.</p>
+<p>When rclone encounters an object key with <code>//</code> (e.g.,
+<code>a//b</code>), it will normalize the path to use a single slash
+(e.g., <code>a/b</code>). This normalization can cause "object not
+found" errors when trying to access the original object, as rclone will
+look for the normalized path instead of the actual object key.</p>
+<p><strong>Example:</strong> - Original S3 object key:
+<code>folder//file.txt</code> - rclone interprets it as:
+<code>folder/file.txt</code> - Result: "object not found" error when
+trying to access <code>folder//file.txt</code></p>
+<p><strong>Workaround:</strong> Avoid using consecutive forward slashes
+(<code>//</code>) in S3 object keys when using rclone. If you have
+existing objects with <code>//</code> in their keys, you will need to
+rename them to use single slashes or access them through other
+means.</p>
<h3 id="multipart-uploads-1">Multipart uploads</h3>
<p>rclone supports multipart uploads with S3 which means that it can
upload files bigger than 5 GiB.</p>
@@ -26435,24 +26690,24 @@ An external ID is provided for additional security as required by the
role's trust policy</p>
<p>The target role's trust policy in the destination account must allow
the source account or user to assume it. Example trust policy:</p>
-<div class="sourceCode" id="cb972"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb972-1"><a href="#cb972-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
-<span id="cb972-2"><a href="#cb972-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Version&quot;</span><span class="fu">:</span> <span class="st">&quot;2012-10-17&quot;</span><span class="fu">,</span></span>
-<span id="cb972-3"><a href="#cb972-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Statement&quot;</span><span class="fu">:</span> <span class="ot">[</span></span>
-<span id="cb972-4"><a href="#cb972-4" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
-<span id="cb972-5"><a href="#cb972-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Effect&quot;</span><span class="fu">:</span> <span class="st">&quot;Allow&quot;</span><span class="fu">,</span></span>
-<span id="cb972-6"><a href="#cb972-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Principal&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
-<span id="cb972-7"><a href="#cb972-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;AWS&quot;</span><span class="fu">:</span> <span class="st">&quot;arn:aws:iam::SOURCE-ACCOUNT-ID:root&quot;</span></span>
-<span id="cb972-8"><a href="#cb972-8" aria-hidden="true" tabindex="-1"></a> <span class="fu">},</span></span>
-<span id="cb972-9"><a href="#cb972-9" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Action&quot;</span><span class="fu">:</span> <span class="st">&quot;sts:AssumeRole&quot;</span><span class="fu">,</span></span>
-<span id="cb972-10"><a href="#cb972-10" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Condition&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
-<span id="cb972-11"><a href="#cb972-11" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;StringEquals&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
-<span id="cb972-12"><a href="#cb972-12" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;sts:ExternalID&quot;</span><span class="fu">:</span> <span class="st">&quot;unique-role-external-id-12345&quot;</span></span>
-<span id="cb972-13"><a href="#cb972-13" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
-<span id="cb972-14"><a href="#cb972-14" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
-<span id="cb972-15"><a href="#cb972-15" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
-<span id="cb972-16"><a href="#cb972-16" aria-hidden="true" tabindex="-1"></a> <span class="ot">]</span></span>
-<span id="cb972-17"><a href="#cb972-17" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
+<div class="sourceCode" id="cb984"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb984-1"><a href="#cb984-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
+<span id="cb984-2"><a href="#cb984-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Version&quot;</span><span class="fu">:</span> <span class="st">&quot;2012-10-17&quot;</span><span class="fu">,</span></span>
+<span id="cb984-3"><a href="#cb984-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Statement&quot;</span><span class="fu">:</span> <span class="ot">[</span></span>
+<span id="cb984-4"><a href="#cb984-4" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
+<span id="cb984-5"><a href="#cb984-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Effect&quot;</span><span class="fu">:</span> <span class="st">&quot;Allow&quot;</span><span class="fu">,</span></span>
+<span id="cb984-6"><a href="#cb984-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Principal&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
+<span id="cb984-7"><a href="#cb984-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;AWS&quot;</span><span class="fu">:</span> <span class="st">&quot;arn:aws:iam::SOURCE-ACCOUNT-ID:root&quot;</span></span>
+<span id="cb984-8"><a href="#cb984-8" aria-hidden="true" tabindex="-1"></a> <span class="fu">},</span></span>
+<span id="cb984-9"><a href="#cb984-9" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Action&quot;</span><span class="fu">:</span> <span class="st">&quot;sts:AssumeRole&quot;</span><span class="fu">,</span></span>
+<span id="cb984-10"><a href="#cb984-10" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Condition&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
+<span id="cb984-11"><a href="#cb984-11" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;StringEquals&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
+<span id="cb984-12"><a href="#cb984-12" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;sts:ExternalID&quot;</span><span class="fu">:</span> <span class="st">&quot;unique-role-external-id-12345&quot;</span></span>
+<span id="cb984-13"><a href="#cb984-13" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
+<span id="cb984-14"><a href="#cb984-14" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
+<span id="cb984-15"><a href="#cb984-15" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
+<span id="cb984-16"><a href="#cb984-16" aria-hidden="true" tabindex="-1"></a> <span class="ot">]</span></span>
+<span id="cb984-17"><a href="#cb984-17" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<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
@@ -26469,34 +26724,34 @@ href="#s3-no-check-bucket">s3-no-check-bucket</a>)</li>
<p>When using the <code>lsd</code> subcommand, the
<code>ListAllMyBuckets</code> permission is required.</p>
<p>Example policy:</p>
-<div class="sourceCode" id="cb973"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb973-1"><a href="#cb973-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
-<span id="cb973-2"><a href="#cb973-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Version&quot;</span><span class="fu">:</span> <span class="st">&quot;2012-10-17&quot;</span><span class="fu">,</span></span>
-<span id="cb973-3"><a href="#cb973-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Statement&quot;</span><span class="fu">:</span> <span class="ot">[</span></span>
-<span id="cb973-4"><a href="#cb973-4" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
-<span id="cb973-5"><a href="#cb973-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Effect&quot;</span><span class="fu">:</span> <span class="st">&quot;Allow&quot;</span><span class="fu">,</span></span>
-<span id="cb973-6"><a href="#cb973-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Principal&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
-<span id="cb973-7"><a href="#cb973-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;AWS&quot;</span><span class="fu">:</span> <span class="st">&quot;arn:aws:iam::USER_SID:user/USER_NAME&quot;</span></span>
-<span id="cb973-8"><a href="#cb973-8" aria-hidden="true" tabindex="-1"></a> <span class="fu">},</span></span>
-<span id="cb973-9"><a href="#cb973-9" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Action&quot;</span><span class="fu">:</span> <span class="ot">[</span></span>
-<span id="cb973-10"><a href="#cb973-10" aria-hidden="true" tabindex="-1"></a> <span class="st">&quot;s3:ListBucket&quot;</span><span class="ot">,</span></span>
-<span id="cb973-11"><a href="#cb973-11" aria-hidden="true" tabindex="-1"></a> <span class="st">&quot;s3:DeleteObject&quot;</span><span class="ot">,</span></span>
-<span id="cb973-12"><a href="#cb973-12" aria-hidden="true" tabindex="-1"></a> <span class="st">&quot;s3:GetObject&quot;</span><span class="ot">,</span></span>
-<span id="cb973-13"><a href="#cb973-13" aria-hidden="true" tabindex="-1"></a> <span class="st">&quot;s3:PutObject&quot;</span><span class="ot">,</span></span>
-<span id="cb973-14"><a href="#cb973-14" aria-hidden="true" tabindex="-1"></a> <span class="st">&quot;s3:PutObjectAcl&quot;</span></span>
-<span id="cb973-15"><a href="#cb973-15" aria-hidden="true" tabindex="-1"></a> <span class="ot">]</span><span class="fu">,</span></span>
-<span id="cb973-16"><a href="#cb973-16" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Resource&quot;</span><span class="fu">:</span> <span class="ot">[</span></span>
-<span id="cb973-17"><a href="#cb973-17" aria-hidden="true" tabindex="-1"></a> <span class="st">&quot;arn:aws:s3:::BUCKET_NAME/*&quot;</span><span class="ot">,</span></span>
-<span id="cb973-18"><a href="#cb973-18" aria-hidden="true" tabindex="-1"></a> <span class="st">&quot;arn:aws:s3:::BUCKET_NAME&quot;</span></span>
-<span id="cb973-19"><a href="#cb973-19" aria-hidden="true" tabindex="-1"></a> <span class="ot">]</span></span>
-<span id="cb973-20"><a href="#cb973-20" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span><span class="ot">,</span></span>
-<span id="cb973-21"><a href="#cb973-21" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
-<span id="cb973-22"><a href="#cb973-22" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Effect&quot;</span><span class="fu">:</span> <span class="st">&quot;Allow&quot;</span><span class="fu">,</span></span>
-<span id="cb973-23"><a href="#cb973-23" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Action&quot;</span><span class="fu">:</span> <span class="st">&quot;s3:ListAllMyBuckets&quot;</span><span class="fu">,</span></span>
-<span id="cb973-24"><a href="#cb973-24" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Resource&quot;</span><span class="fu">:</span> <span class="st">&quot;arn:aws:s3:::*&quot;</span></span>
-<span id="cb973-25"><a href="#cb973-25" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
-<span id="cb973-26"><a href="#cb973-26" aria-hidden="true" tabindex="-1"></a> <span class="ot">]</span></span>
-<span id="cb973-27"><a href="#cb973-27" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
+<div class="sourceCode" id="cb985"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb985-1"><a href="#cb985-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
+<span id="cb985-2"><a href="#cb985-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Version&quot;</span><span class="fu">:</span> <span class="st">&quot;2012-10-17&quot;</span><span class="fu">,</span></span>
+<span id="cb985-3"><a href="#cb985-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Statement&quot;</span><span class="fu">:</span> <span class="ot">[</span></span>
+<span id="cb985-4"><a href="#cb985-4" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
+<span id="cb985-5"><a href="#cb985-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Effect&quot;</span><span class="fu">:</span> <span class="st">&quot;Allow&quot;</span><span class="fu">,</span></span>
+<span id="cb985-6"><a href="#cb985-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Principal&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
+<span id="cb985-7"><a href="#cb985-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;AWS&quot;</span><span class="fu">:</span> <span class="st">&quot;arn:aws:iam::USER_SID:user/USER_NAME&quot;</span></span>
+<span id="cb985-8"><a href="#cb985-8" aria-hidden="true" tabindex="-1"></a> <span class="fu">},</span></span>
+<span id="cb985-9"><a href="#cb985-9" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Action&quot;</span><span class="fu">:</span> <span class="ot">[</span></span>
+<span id="cb985-10"><a href="#cb985-10" aria-hidden="true" tabindex="-1"></a> <span class="st">&quot;s3:ListBucket&quot;</span><span class="ot">,</span></span>
+<span id="cb985-11"><a href="#cb985-11" aria-hidden="true" tabindex="-1"></a> <span class="st">&quot;s3:DeleteObject&quot;</span><span class="ot">,</span></span>
+<span id="cb985-12"><a href="#cb985-12" aria-hidden="true" tabindex="-1"></a> <span class="st">&quot;s3:GetObject&quot;</span><span class="ot">,</span></span>
+<span id="cb985-13"><a href="#cb985-13" aria-hidden="true" tabindex="-1"></a> <span class="st">&quot;s3:PutObject&quot;</span><span class="ot">,</span></span>
+<span id="cb985-14"><a href="#cb985-14" aria-hidden="true" tabindex="-1"></a> <span class="st">&quot;s3:PutObjectAcl&quot;</span></span>
+<span id="cb985-15"><a href="#cb985-15" aria-hidden="true" tabindex="-1"></a> <span class="ot">]</span><span class="fu">,</span></span>
+<span id="cb985-16"><a href="#cb985-16" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Resource&quot;</span><span class="fu">:</span> <span class="ot">[</span></span>
+<span id="cb985-17"><a href="#cb985-17" aria-hidden="true" tabindex="-1"></a> <span class="st">&quot;arn:aws:s3:::BUCKET_NAME/*&quot;</span><span class="ot">,</span></span>
+<span id="cb985-18"><a href="#cb985-18" aria-hidden="true" tabindex="-1"></a> <span class="st">&quot;arn:aws:s3:::BUCKET_NAME&quot;</span></span>
+<span id="cb985-19"><a href="#cb985-19" aria-hidden="true" tabindex="-1"></a> <span class="ot">]</span></span>
+<span id="cb985-20"><a href="#cb985-20" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span><span class="ot">,</span></span>
+<span id="cb985-21"><a href="#cb985-21" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
+<span id="cb985-22"><a href="#cb985-22" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Effect&quot;</span><span class="fu">:</span> <span class="st">&quot;Allow&quot;</span><span class="fu">,</span></span>
+<span id="cb985-23"><a href="#cb985-23" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Action&quot;</span><span class="fu">:</span> <span class="st">&quot;s3:ListAllMyBuckets&quot;</span><span class="fu">,</span></span>
+<span id="cb985-24"><a href="#cb985-24" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Resource&quot;</span><span class="fu">:</span> <span class="st">&quot;arn:aws:s3:::*&quot;</span></span>
+<span id="cb985-25"><a href="#cb985-25" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
+<span id="cb985-26"><a href="#cb985-26" aria-hidden="true" tabindex="-1"></a> <span class="ot">]</span></span>
+<span id="cb985-27"><a href="#cb985-27" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>Notes on above:</p>
<ol type="1">
<li>This is a policy that can be used when creating bucket. It assumes
@@ -26542,23 +26797,66 @@ on S3 Object Lock</a>:</p>
<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="#modification-times-and-hashes">Modification times and hashes</a>
-section, small files that are not uploaded as multipart, use a different
-tag, causing the upload to fail. A simple solution is to set the
-<code>--s3-upload-cutoff 0</code> and force all the files to be uploaded
-as multipart.</p>
+<p>Rclone automatically computes and includes the Content-MD5 header
+when uploading objects with Object Lock parameters set. No special
+configuration is needed.</p>
+<h4 id="setting-object-lock-retention">Setting Object Lock
+retention</h4>
+<p>Rclone supports setting Object Lock retention on uploaded objects
+with the following options:</p>
+<ul>
+<li><code>--s3-object-lock-mode</code> - Set the Object Lock mode
+(GOVERNANCE or COMPLIANCE)</li>
+<li><code>--s3-object-lock-retain-until-date</code> - Set the retention
+date (RFC3339 format or duration like <code>365d</code>,
+<code>24h</code>)</li>
+<li><code>--s3-object-lock-legal-hold-status</code> - Set legal hold (ON
+or OFF)</li>
+</ul>
+<p>Example - upload files with 1 year GOVERNANCE retention:</p>
+<pre><code>rclone copy local:/data remote:bucket \
+ --s3-object-lock-mode GOVERNANCE \
+ --s3-object-lock-retain-until-date 365d</code></pre>
+<h4 id="copying-object-lock-settings-from-source">Copying Object Lock
+settings from source</h4>
+<p>When using <code>--metadata</code>, you can use the special value
+<code>copy</code> to preserve the source object's Object Lock
+settings:</p>
+<pre><code>rclone copy source:bucket dest:bucket \
+ --metadata \
+ --s3-object-lock-mode copy \
+ --s3-object-lock-retain-until-date copy</code></pre>
+<p>You can also mix copied and explicit values. For example, to change
+the mode from COMPLIANCE to GOVERNANCE while preserving the original
+retention date:</p>
+<pre><code>rclone copy source:bucket dest:bucket \
+ --metadata \
+ --s3-object-lock-mode GOVERNANCE \
+ --s3-object-lock-retain-until-date copy</code></pre>
+<h4 id="additional-object-lock-options">Additional Object Lock
+options</h4>
+<ul>
+<li><code>--s3-bypass-governance-retention</code> - Required to delete
+or overwrite objects with GOVERNANCE mode retention before the retention
+date expires</li>
+<li><code>--s3-bucket-object-lock-enabled</code> - Enable Object Lock
+when creating a new bucket with <code>rclone mkdir</code></li>
+<li><code>--s3-object-lock-set-after-upload</code> - Set Object Lock via
+separate API calls after upload (for providers that don't support Object
+Lock headers during PUT)</li>
+</ul>
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/s3/s3.go and run make backenddocs to verify -->
<!-- markdownlint-disable-line line-length -->
<h3 id="standard-options-2">Standard options</h3>
<p>Here are the Standard options specific to s3 (Amazon S3 Compliant
Storage Providers including AWS, Alibaba, ArvanCloud, BizflyCloud, Ceph,
-ChinaMobile, Cloudflare, Cubbit, DigitalOcean, Dreamhost, Exaba, FileLu,
-FlashBlade, GCS, Hetzner, HuaweiOBS, IBMCOS, IDrive, Intercolo, IONOS,
-Leviia, Liara, Linode, LyveCloud, Magalu, Mega, Minio, Netease,
-Outscale, OVHcloud, Petabox, Qiniu, Rabata, RackCorp, Rclone, Scaleway,
-SeaweedFS, Selectel, Servercore, SpectraLogic, StackPath, Storj,
-Synology, TencentCOS, Wasabi, Zata, Other).</p>
+ChinaMobile, Cloudflare, Cubbit, DigitalOcean, Dreamhost, Exaba, Fastly,
+FileLu, FlashBlade, GCS, HCP, Hetzner, HuaweiOBS, IBMCOS, IDrive,
+ImpossibleCloud, Intercolo, IONOS, Leviia, Liara, Linode, LyveCloud,
+Magalu, Mega, Minio, Netease, Outscale, OVHcloud, Petabox, Qiniu,
+Rabata, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Servercore,
+SpectraLogic, Storj, Synology, TencentCOS, US3, Wasabi, Zadara, Zata,
+Other).</p>
<h4 id="s3-provider">--s3-provider</h4>
<p>Choose your S3 provider.</p>
<p>Properties:</p>
@@ -26613,6 +26911,10 @@ Synology, TencentCOS, Wasabi, Zata, Other).</p>
<ul>
<li>Exaba Object Storage</li>
</ul></li>
+<li>"Fastly"
+<ul>
+<li>Fastly Object Storage</li>
+</ul></li>
<li>"FileLu"
<ul>
<li>FileLu S5 (S3-Compatible Object Storage)</li>
@@ -26625,6 +26927,10 @@ Synology, TencentCOS, Wasabi, Zata, Other).</p>
<ul>
<li>Google Cloud Storage</li>
</ul></li>
+<li>"HCP"
+<ul>
+<li>Hitachi Content Platform (HCP)</li>
+</ul></li>
<li>"Hetzner"
<ul>
<li>Hetzner Object Storage</li>
@@ -26641,6 +26947,10 @@ Synology, TencentCOS, Wasabi, Zata, Other).</p>
<ul>
<li>IDrive e2</li>
</ul></li>
+<li>"ImpossibleCloud"
+<ul>
+<li>Impossible Cloud Object Storage</li>
+</ul></li>
<li>"Intercolo"
<ul>
<li>Intercolo Object Storage</li>
@@ -26729,10 +27039,6 @@ Synology, TencentCOS, Wasabi, Zata, Other).</p>
<ul>
<li>Spectra Logic Black Pearl</li>
</ul></li>
-<li>"StackPath"
-<ul>
-<li>StackPath Object Storage</li>
-</ul></li>
<li>"Storj"
<ul>
<li>Storj (S3 Compatible Gateway)</li>
@@ -26745,10 +27051,18 @@ Synology, TencentCOS, Wasabi, Zata, Other).</p>
<ul>
<li>Tencent Cloud Object Storage (COS)</li>
</ul></li>
+<li>"US3"
+<ul>
+<li>US3 Object Storage</li>
+</ul></li>
<li>"Wasabi"
<ul>
<li>Wasabi Object Storage</li>
</ul></li>
+<li>"Zadara"
+<ul>
+<li>Zadara Object Storage</li>
+</ul></li>
<li>"Zata"
<ul>
<li>Zata (S3 compatible Gateway)</li>
@@ -26810,7 +27124,7 @@ region.</p>
<li>Config: region</li>
<li>Env Var: RCLONE_S3_REGION</li>
<li>Provider:
-AWS,BizflyCloud,Ceph,Cloudflare,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,Hetzner,HuaweiOBS,IBMCOS,Intercolo,IONOS,Leviia,LyveCloud,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,Rabata,RackCorp,Scaleway,SeaweedFS,Selectel,Servercore,StackPath,Synology,Wasabi,Zata,Other</li>
+AWS,BizflyCloud,Ceph,Cloudflare,Cubbit,DigitalOcean,Dreamhost,Exaba,Fastly,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IBMCOS,ImpossibleCloud,Intercolo,IONOS,Leviia,LyveCloud,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,Rabata,RackCorp,Scaleway,SeaweedFS,Selectel,Servercore,Synology,Wasabi,Zadara,Zata,Other</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
@@ -26987,14 +27301,14 @@ AWS,BizflyCloud,Ceph,Cloudflare,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,H
<li>Use this if unsure.</li>
<li>Will use v4 signatures and an empty region.</li>
<li>Provider:
-Ceph,DigitalOcean,Dreamhost,Exaba,GCS,IBMCOS,Leviia,LyveCloud,Minio,Netease,SeaweedFS,StackPath,Wasabi,Other</li>
+Ceph,DigitalOcean,Dreamhost,Exaba,GCS,HCP,IBMCOS,Leviia,LyveCloud,Minio,Netease,SeaweedFS,Wasabi,Other</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>
<li>Provider:
-Ceph,DigitalOcean,Dreamhost,Exaba,GCS,IBMCOS,Leviia,LyveCloud,Minio,Netease,SeaweedFS,StackPath,Wasabi,Other</li>
+Ceph,DigitalOcean,Dreamhost,Exaba,GCS,HCP,IBMCOS,Leviia,LyveCloud,Minio,Netease,SeaweedFS,Wasabi,Other</li>
</ul></li>
<li>"auto"
<ul>
@@ -27007,6 +27321,46 @@ centers for low latency.</li>
<li>Europe West</li>
<li>Provider: Cubbit</li>
</ul></li>
+<li>"au-east-1"
+<ul>
+<li>AU East 1</li>
+<li>Provider: Fastly</li>
+</ul></li>
+<li>"eu-central"
+<ul>
+<li>EU Central</li>
+<li>Provider: Fastly</li>
+</ul></li>
+<li>"eu-south-1"
+<ul>
+<li>EU South 1</li>
+<li>Provider: Fastly</li>
+</ul></li>
+<li>"jp-central-1"
+<ul>
+<li>JP Central 1</li>
+<li>Provider: Fastly</li>
+</ul></li>
+<li>"uk-east-1"
+<ul>
+<li>UK East 1</li>
+<li>Provider: Fastly</li>
+</ul></li>
+<li>"us-central-1"
+<ul>
+<li>US Central 1</li>
+<li>Provider: Fastly</li>
+</ul></li>
+<li>"us-east"
+<ul>
+<li>US East</li>
+<li>Provider: Fastly</li>
+</ul></li>
+<li>"us-west"
+<ul>
+<li>US West</li>
+<li>Provider: Fastly</li>
+</ul></li>
<li>"global"
<ul>
<li>Global</li>
@@ -27122,6 +27476,41 @@ centers for low latency.</li>
<li>RU-Moscow2</li>
<li>Provider: HuaweiOBS</li>
</ul></li>
+<li>"eu-central-2"
+<ul>
+<li>Frankfurt, Germany</li>
+<li>Provider: ImpossibleCloud</li>
+</ul></li>
+<li>"eu-west-1"
+<ul>
+<li>Amsterdam, Netherlands</li>
+<li>Provider: ImpossibleCloud</li>
+</ul></li>
+<li>"eu-west-2"
+<ul>
+<li>London, UK</li>
+<li>Provider: ImpossibleCloud</li>
+</ul></li>
+<li>"eu-west-3"
+<ul>
+<li>Paris, France</li>
+<li>Provider: ImpossibleCloud</li>
+</ul></li>
+<li>"eu-east-1"
+<ul>
+<li>Poznań, Poland</li>
+<li>Provider: ImpossibleCloud</li>
+</ul></li>
+<li>"eu-north-1"
+<ul>
+<li>Copenhagen, Denmark</li>
+<li>Provider: ImpossibleCloud</li>
+</ul></li>
+<li>"us-east-1"
+<ul>
+<li>New York, USA</li>
+<li>Provider: ImpossibleCloud</li>
+</ul></li>
<li>"de-fra"
<ul>
<li>Frankfurt, Germany</li>
@@ -27137,11 +27526,26 @@ centers for low latency.</li>
<li>Berlin, Germany</li>
<li>Provider: IONOS</li>
</ul></li>
+<li>"eu-central-3"
+<ul>
+<li>Berlin, Germany</li>
+<li>Provider: IONOS</li>
+</ul></li>
+<li>"eu-central-4"
+<ul>
+<li>Frankfurt, Germany</li>
+<li>Provider: IONOS</li>
+</ul></li>
<li>"eu-south-2"
<ul>
<li>Logrono, Spain</li>
<li>Provider: IONOS</li>
</ul></li>
+<li>"us-central-1"
+<ul>
+<li>Lenexa, USA</li>
+<li>Provider: IONOS</li>
+</ul></li>
<li>"eu-west-2"
<ul>
<li>Paris, France</li>
@@ -27492,6 +27896,12 @@ centers for low latency.</li>
</ul></li>
<li>"us-east-1"
<ul>
+<li>The default region.</li>
+<li>Leave location constraint empty.</li>
+<li>Provider: Zadara</li>
+</ul></li>
+<li>"us-east-1"
+<ul>
<li>Indore, Madhya Pradesh, India</li>
<li>Provider: Zata</li>
</ul></li>
@@ -27505,7 +27915,7 @@ centers for low latency.</li>
<li>Config: endpoint</li>
<li>Env Var: RCLONE_S3_ENDPOINT</li>
<li>Provider:
-AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cloudflare,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,FlashBlade,GCS,Hetzner,HuaweiOBS,IBMCOS,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Mega,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,Rabata,RackCorp,Rclone,Scaleway,SeaweedFS,Selectel,Servercore,SpectraLogic,StackPath,Storj,Synology,TencentCOS,Wasabi,Zata,Other</li>
+AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cloudflare,Cubbit,DigitalOcean,Dreamhost,Exaba,Fastly,FileLu,FlashBlade,GCS,HCP,Hetzner,HuaweiOBS,IBMCOS,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Mega,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,Rabata,RackCorp,Rclone,Scaleway,SeaweedFS,Selectel,Servercore,SpectraLogic,Storj,Synology,TencentCOS,US3,Wasabi,Zadara,Zata,Other</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
@@ -27812,6 +28222,12 @@ AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cloudflare,Cubbit,DigitalOce
<li>Cubbit DS3 Object Storage endpoint</li>
<li>Provider: Cubbit</li>
</ul></li>
+<li>"s3.{tenant_name}.cubbit.eu"
+<ul>
+<li>Multi-tenant endpoint - replace {tenant_name} with your actual
+tenant name. Do not select this directly</li>
+<li>Provider: Cubbit</li>
+</ul></li>
<li>"syd1.digitaloceanspaces.com"
<ul>
<li>DigitalOcean Spaces Sydney 1</li>
@@ -27867,6 +28283,46 @@ AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cloudflare,Cubbit,DigitalOce
<li>Dream Objects endpoint</li>
<li>Provider: Dreamhost</li>
</ul></li>
+<li>"au-east-1.object.fastlystorage.app"
+<ul>
+<li>AU East 1</li>
+<li>Provider: Fastly</li>
+</ul></li>
+<li>"eu-central.object.fastlystorage.app"
+<ul>
+<li>EU Central</li>
+<li>Provider: Fastly</li>
+</ul></li>
+<li>"eu-south-1.object.fastlystorage.app"
+<ul>
+<li>EU South 1</li>
+<li>Provider: Fastly</li>
+</ul></li>
+<li>"jp-central-1.object.fastlystorage.app"
+<ul>
+<li>JP Central 1</li>
+<li>Provider: Fastly</li>
+</ul></li>
+<li>"uk-east-1.object.fastlystorage.app"
+<ul>
+<li>UK East 1</li>
+<li>Provider: Fastly</li>
+</ul></li>
+<li>"us-central-1.object.fastlystorage.app"
+<ul>
+<li>US Central 1</li>
+<li>Provider: Fastly</li>
+</ul></li>
+<li>"us-east.object.fastlystorage.app"
+<ul>
+<li>US East</li>
+<li>Provider: Fastly</li>
+</ul></li>
+<li>"us-west.object.fastlystorage.app"
+<ul>
+<li>US West</li>
+<li>Provider: Fastly</li>
+</ul></li>
<li>"s5lu.com"
<ul>
<li>Global FileLu S5 endpoint</li>
@@ -28297,26 +28753,76 @@ AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cloudflare,Cubbit,DigitalOce
<li>Singapore Single Site Private Endpoint</li>
<li>Provider: IBMCOS</li>
</ul></li>
+<li>"eu-central-2.storage.impossibleapi.net"
+<ul>
+<li>Frankfurt, Germany</li>
+<li>Provider: ImpossibleCloud</li>
+</ul></li>
+<li>"eu-west-1.storage.impossibleapi.net"
+<ul>
+<li>Amsterdam, Netherlands</li>
+<li>Provider: ImpossibleCloud</li>
+</ul></li>
+<li>"eu-west-2.storage.impossibleapi.net"
+<ul>
+<li>London, UK</li>
+<li>Provider: ImpossibleCloud</li>
+</ul></li>
+<li>"eu-west-3.storage.impossibleapi.net"
+<ul>
+<li>Paris, France</li>
+<li>Provider: ImpossibleCloud</li>
+</ul></li>
+<li>"eu-east-1.storage.impossibleapi.net"
+<ul>
+<li>Poznań, Poland</li>
+<li>Provider: ImpossibleCloud</li>
+</ul></li>
+<li>"eu-north-1.storage.impossibleapi.net"
+<ul>
+<li>Copenhagen, Denmark</li>
+<li>Provider: ImpossibleCloud</li>
+</ul></li>
+<li>"us-east-1.storage.impossibleapi.net"
+<ul>
+<li>New York, USA</li>
+<li>Provider: ImpossibleCloud</li>
+</ul></li>
<li>"de-fra.i3storage.com"
<ul>
<li>Frankfurt, Germany</li>
<li>Provider: Intercolo</li>
</ul></li>
-<li>"s3-eu-central-1.ionoscloud.com"
+<li>"s3.eu-central-1.ionoscloud.com"
<ul>
<li>Frankfurt, Germany</li>
<li>Provider: IONOS</li>
</ul></li>
-<li>"s3-eu-central-2.ionoscloud.com"
+<li>"s3.eu-central-2.ionoscloud.com"
<ul>
<li>Berlin, Germany</li>
<li>Provider: IONOS</li>
</ul></li>
-<li>"s3-eu-south-2.ionoscloud.com"
+<li>"s3.eu-central-3.ionoscloud.com"
+<ul>
+<li>Berlin, Germany</li>
+<li>Provider: IONOS</li>
+</ul></li>
+<li>"s3.eu-central-4.ionoscloud.com"
+<ul>
+<li>Frankfurt, Germany</li>
+<li>Provider: IONOS</li>
+</ul></li>
+<li>"s3.eu-south-2.ionoscloud.com"
<ul>
<li>Logrono, Spain</li>
<li>Provider: IONOS</li>
</ul></li>
+<li>"s3.us-central-1.ionoscloud.com"
+<ul>
+<li>Lenexa, USA</li>
+<li>Provider: IONOS</li>
+</ul></li>
<li>"s3.leviia.com"
<ul>
<li>The default endpoint</li>
@@ -28814,21 +29320,6 @@ AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cloudflare,Cubbit,DigitalOce
<li>Almaty, Kazakhstan</li>
<li>Provider: Servercore</li>
</ul></li>
-<li>"s3.us-east-2.stackpathstorage.com"
-<ul>
-<li>US East Endpoint</li>
-<li>Provider: StackPath</li>
-</ul></li>
-<li>"s3.us-west-1.stackpathstorage.com"
-<ul>
-<li>US West Endpoint</li>
-<li>Provider: StackPath</li>
-</ul></li>
-<li>"s3.eu-central-1.stackpathstorage.com"
-<ul>
-<li>EU Endpoint</li>
-<li>Provider: StackPath</li>
-</ul></li>
<li>"gateway.storjshare.io"
<ul>
<li>Global Hosted Gateway</li>
@@ -28949,6 +29440,121 @@ AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cloudflare,Cubbit,DigitalOce
<li>Use Tencent COS Accelerate Endpoint</li>
<li>Provider: TencentCOS</li>
</ul></li>
+<li>"s3-cn-bj.ufileos.com"
+<ul>
+<li>North China (Beijing 2)</li>
+<li>Provider: US3</li>
+</ul></li>
+<li>"s3-cn-wlcb.ufileos.com"
+<ul>
+<li>North China (Ulanqab)</li>
+<li>Provider: US3</li>
+</ul></li>
+<li>"s3-cn-sh2.ufileos.com"
+<ul>
+<li>Shanghai</li>
+<li>Provider: US3</li>
+</ul></li>
+<li>"s3-cn-gd.ufileos.com"
+<ul>
+<li>South China (Guangzhou)</li>
+<li>Provider: US3</li>
+</ul></li>
+<li>"s3-hk.ufileos.com"
+<ul>
+<li>Hongkong</li>
+<li>Provider: US3</li>
+</ul></li>
+<li>"s3-us-ca.ufileos.com"
+<ul>
+<li>United States (Los Angeles)</li>
+<li>Provider: US3</li>
+</ul></li>
+<li>"s3-sg.ufileos.com"
+<ul>
+<li>Singapore</li>
+<li>Provider: US3</li>
+</ul></li>
+<li>"s3-idn-jakarta.ufileos.com"
+<ul>
+<li>Indonesia (Jakarta)</li>
+<li>Provider: US3</li>
+</ul></li>
+<li>"s3-tw-tp.ufileos.com"
+<ul>
+<li>Taiwan (Taipei)</li>
+<li>Provider: US3</li>
+</ul></li>
+<li>"s3-afr-nigeria.ufileos.com"
+<ul>
+<li>Nigeria (Lagos)</li>
+<li>Provider: US3</li>
+</ul></li>
+<li>"s3-bra-saopaulo.ufileos.com"
+<ul>
+<li>Brazil (São Paulo)</li>
+<li>Provider: US3</li>
+</ul></li>
+<li>"s3-uae-dubai.ufileos.com"
+<ul>
+<li>United Arab Emirates (Dubai)</li>
+<li>Provider: US3</li>
+</ul></li>
+<li>"s3-ge-fra.ufileos.com"
+<ul>
+<li>Germany (Frankfurt)</li>
+<li>Provider: US3</li>
+</ul></li>
+<li>"s3-vn-sng.ufileos.com"
+<ul>
+<li>Vietnam (Ho Chi Minh City)</li>
+<li>Provider: US3</li>
+</ul></li>
+<li>"s3-us-ws.ufileos.com"
+<ul>
+<li>United States (Washington)</li>
+<li>Provider: US3</li>
+</ul></li>
+<li>"s3-ind-mumbai.ufileos.com"
+<ul>
+<li>India (Mumbai)</li>
+<li>Provider: US3</li>
+</ul></li>
+<li>"s3-kr-seoul.ufileos.com"
+<ul>
+<li>Seoul (South Korea)</li>
+<li>Provider: US3</li>
+</ul></li>
+<li>"s3-jpn-tky.ufileos.com"
+<ul>
+<li>Japan (Tokyo)</li>
+<li>Provider: US3</li>
+</ul></li>
+<li>"s3-th-bkk.ufileos.com"
+<ul>
+<li>Bangkok (Thailand)</li>
+<li>Provider: US3</li>
+</ul></li>
+<li>"s3-uk-london.ufileos.com"
+<ul>
+<li>United Kingdom (London)</li>
+<li>Provider: US3</li>
+</ul></li>
+<li>"s3-rus-mosc.ufileos.com"
+<ul>
+<li>Russia (Moscow)</li>
+<li>Provider: US3</li>
+</ul></li>
+<li>"s3-cn-guiyang1.ufileos.com"
+<ul>
+<li>Guiyang 1</li>
+<li>Provider: US3</li>
+</ul></li>
+<li>"s3-pk-khi.ufileos.com"
+<ul>
+<li>Pakistan</li>
+<li>Provider: US3</li>
+</ul></li>
<li>"s3.wasabisys.com"
<ul>
<li>Wasabi US East 1 (N. Virginia)</li>
@@ -29034,7 +29640,7 @@ AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cloudflare,Cubbit,DigitalOce
<li>Config: location_constraint</li>
<li>Env Var: RCLONE_S3_LOCATION_CONSTRAINT</li>
<li>Provider:
-AWS,ArvanCloud,Ceph,ChinaMobile,DigitalOcean,Dreamhost,Exaba,GCS,Hetzner,IBMCOS,LyveCloud,Minio,Netease,Qiniu,Rabata,RackCorp,SeaweedFS,Synology,Wasabi,Zata,Other</li>
+AWS,ArvanCloud,Ceph,ChinaMobile,DigitalOcean,Dreamhost,Exaba,GCS,HCP,Hetzner,IBMCOS,ImpossibleCloud,LyveCloud,Minio,Netease,Qiniu,Rabata,RackCorp,SeaweedFS,Synology,Wasabi,Zata,Other</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
@@ -29652,7 +30258,7 @@ the default (private) will be used.</p>
<li>Config: acl</li>
<li>Env Var: RCLONE_S3_ACL</li>
<li>Provider:
-AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,Hetzner,HuaweiOBS,IBMCOS,IDrive,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,StackPath,TencentCOS,Wasabi,Zata,Other</li>
+AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IBMCOS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,US3,Wasabi,Zata,Other</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
@@ -29662,14 +30268,14 @@ AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhos
<li>Owner gets FULL_CONTROL.</li>
<li>No one else has access rights (default).</li>
<li>Provider:
-AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,Hetzner,HuaweiOBS,IDrive,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,StackPath,Wasabi,Zata,Other</li>
+AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,US3,Wasabi,Zata,Other</li>
</ul></li>
<li>"public-read"
<ul>
<li>Owner gets FULL_CONTROL.</li>
<li>The AllUsers group gets READ access.</li>
<li>Provider:
-AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,Hetzner,HuaweiOBS,IDrive,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,StackPath,TencentCOS,Wasabi,Zata,Other</li>
+AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,US3,Wasabi,Zata,Other</li>
</ul></li>
<li>"public-read-write"
<ul>
@@ -29677,14 +30283,14 @@ AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhos
<li>The AllUsers group gets READ and WRITE access.</li>
<li>Granting this on a bucket is generally not recommended.</li>
<li>Provider:
-AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,Hetzner,HuaweiOBS,IDrive,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,StackPath,TencentCOS,Wasabi,Zata,Other</li>
+AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,Wasabi,Zata,Other</li>
</ul></li>
<li>"authenticated-read"
<ul>
<li>Owner gets FULL_CONTROL.</li>
<li>The AuthenticatedUsers group gets READ access.</li>
<li>Provider:
-AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,Hetzner,HuaweiOBS,IDrive,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,StackPath,TencentCOS,Wasabi,Zata,Other</li>
+AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,Wasabi,Zata,Other</li>
</ul></li>
<li>"bucket-owner-read"
<ul>
@@ -29693,7 +30299,7 @@ AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhos
<li>If you specify this canned ACL when creating a bucket, Amazon S3
ignores it.</li>
<li>Provider:
-AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,Hetzner,HuaweiOBS,IDrive,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,StackPath,TencentCOS,Wasabi,Zata,Other</li>
+AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,Wasabi,Zata,Other</li>
</ul></li>
<li>"bucket-owner-full-control"
<ul>
@@ -29702,7 +30308,7 @@ object.</li>
<li>If you specify this canned ACL when creating a bucket, Amazon S3
ignores it.</li>
<li>Provider:
-AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,Hetzner,HuaweiOBS,IDrive,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,StackPath,TencentCOS,Wasabi,Zata,Other</li>
+AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,Wasabi,Zata,Other</li>
</ul></li>
<li>"private"
<ul>
@@ -29801,7 +30407,7 @@ S3.</p>
<li>Config: storage_class</li>
<li>Env Var: RCLONE_S3_STORAGE_CLASS</li>
<li>Provider:
-AWS,Alibaba,ArvanCloud,ChinaMobile,Liara,Magalu,Qiniu,Scaleway,TencentCOS</li>
+AWS,Alibaba,ArvanCloud,ChinaMobile,Liara,Magalu,OVHcloud,Qiniu,Scaleway,TencentCOS,US3</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
@@ -29809,13 +30415,13 @@ AWS,Alibaba,ArvanCloud,ChinaMobile,Liara,Magalu,Qiniu,Scaleway,TencentCOS</li>
<li>""
<ul>
<li>Default</li>
-<li>Provider: AWS,Alibaba,ChinaMobile,TencentCOS</li>
+<li>Provider: AWS,Alibaba,ChinaMobile,OVHcloud,TencentCOS,US3</li>
</ul></li>
<li>"STANDARD"
<ul>
<li>Standard storage class</li>
<li>Provider:
-AWS,Alibaba,ArvanCloud,ChinaMobile,Liara,Magalu,Qiniu,TencentCOS</li>
+AWS,Alibaba,ArvanCloud,ChinaMobile,Liara,Magalu,OVHcloud,Qiniu,TencentCOS,US3</li>
</ul></li>
<li>"REDUCED_REDUNDANCY"
<ul>
@@ -29825,7 +30431,7 @@ AWS,Alibaba,ArvanCloud,ChinaMobile,Liara,Magalu,Qiniu,TencentCOS</li>
<li>"STANDARD_IA"
<ul>
<li>Standard Infrequent Access storage class</li>
-<li>Provider: AWS</li>
+<li>Provider: AWS,OVHcloud</li>
</ul></li>
<li>"ONEZONE_IA"
<ul>
@@ -29860,7 +30466,37 @@ AWS,Alibaba,ArvanCloud,ChinaMobile,Liara,Magalu,Qiniu,TencentCOS</li>
<li>"STANDARD_IA"
<ul>
<li>Infrequent access storage mode</li>
-<li>Provider: Alibaba,ChinaMobile,TencentCOS</li>
+<li>Provider: Alibaba,ChinaMobile,TencentCOS,US3</li>
+</ul></li>
+<li>"EXPRESS_ONEZONE"
+<ul>
+<li>High Performance storage class</li>
+<li>Provider: OVHcloud</li>
+</ul></li>
+<li>"ONEZONE_IA"
+<ul>
+<li>Standard Infrequent Access storage class</li>
+<li>Provider: OVHcloud</li>
+</ul></li>
+<li>"GLACIER"
+<ul>
+<li>Active Archive storage class</li>
+<li>Provider: OVHcloud</li>
+</ul></li>
+<li>"GLACIER_IR"
+<ul>
+<li>Active Archive storage class</li>
+<li>Provider: OVHcloud</li>
+</ul></li>
+<li>"DEEP_ARCHIVE"
+<ul>
+<li>Cold Archive storage class</li>
+<li>Provider: OVHcloud</li>
+</ul></li>
+<li>"INTELLIGENT_TIERING"
+<ul>
+<li>Standard storage class</li>
+<li>Provider: OVHcloud</li>
</ul></li>
<li>"LINE"
<ul>
@@ -29889,7 +30525,7 @@ AWS,Alibaba,ArvanCloud,ChinaMobile,Liara,Magalu,Qiniu,TencentCOS</li>
<li>Archived storage.</li>
<li>Prices are lower, but it needs to be restored first to be
accessed.</li>
-<li>Available in FR-PAR and NL-AMS regions.</li>
+<li>Available in the FR-PAR region only.</li>
<li>Provider: Scaleway</li>
</ul></li>
<li>"ONEZONE_IA"
@@ -29897,13 +30533,13 @@ accessed.</li>
<li>One Zone - Infrequent Access.</li>
<li>A good choice for storing secondary backup copies or easily
re-creatable data.</li>
-<li>Available in the FR-PAR region only.</li>
+<li>Available in all regions.</li>
<li>Provider: Scaleway</li>
</ul></li>
<li>"ARCHIVE"
<ul>
<li>Archive storage mode</li>
-<li>Provider: TencentCOS</li>
+<li>Provider: TencentCOS,US3</li>
</ul></li>
</ul></li>
</ul>
@@ -29927,15 +30563,26 @@ re-creatable data.</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
+<h4
+id="s3-bucket-object-lock-enabled">--s3-bucket-object-lock-enabled</h4>
+<p>Enable Object Lock when creating new buckets.</p>
+<p>Properties:</p>
+<ul>
+<li>Config: bucket_object_lock_enabled</li>
+<li>Env Var: RCLONE_S3_BUCKET_OBJECT_LOCK_ENABLED</li>
+<li>Type: bool</li>
+<li>Default: false</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, ArvanCloud, BizflyCloud, Ceph,
-ChinaMobile, Cloudflare, Cubbit, DigitalOcean, Dreamhost, Exaba, FileLu,
-FlashBlade, GCS, Hetzner, HuaweiOBS, IBMCOS, IDrive, Intercolo, IONOS,
-Leviia, Liara, Linode, LyveCloud, Magalu, Mega, Minio, Netease,
-Outscale, OVHcloud, Petabox, Qiniu, Rabata, RackCorp, Rclone, Scaleway,
-SeaweedFS, Selectel, Servercore, SpectraLogic, StackPath, Storj,
-Synology, TencentCOS, Wasabi, Zata, Other).</p>
+ChinaMobile, Cloudflare, Cubbit, DigitalOcean, Dreamhost, Exaba, Fastly,
+FileLu, FlashBlade, GCS, HCP, Hetzner, HuaweiOBS, IBMCOS, IDrive,
+ImpossibleCloud, Intercolo, IONOS, Leviia, Liara, Linode, LyveCloud,
+Magalu, Mega, Minio, Netease, Outscale, OVHcloud, Petabox, Qiniu,
+Rabata, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Servercore,
+SpectraLogic, Storj, Synology, TencentCOS, US3, Wasabi, Zadara, Zata,
+Other).</p>
<h4 id="s3-bucket-acl">--s3-bucket-acl</h4>
<p>Canned ACL used when creating buckets.</p>
<p>For more info visit
@@ -29949,7 +30596,7 @@ header is added and the default (private) will be used.</p>
<li>Config: bucket_acl</li>
<li>Env Var: RCLONE_S3_BUCKET_ACL</li>
<li>Provider:
-AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,Hetzner,HuaweiOBS,IBMCOS,IDrive,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Mega,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,Servercore,StackPath,TencentCOS,Wasabi,Zata,Other</li>
+AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IBMCOS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Mega,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,Servercore,TencentCOS,US3,Wasabi,Zata,Other</li>
<li>Type: string</li>
<li>Required: false</li>
<li>Examples:
@@ -30701,6 +31348,22 @@ knows about - please make a bug report if not.</p>
<li>Type: Tristate</li>
<li>Default: unset</li>
</ul>
+<h4
+id="s3-list-versions-oldest-first">--s3-list-versions-oldest-first</h4>
+<p>Set if the backend returns object versions oldest first.</p>
+<p>The S3 standard returns object versions newest first. Some backends
+(e.g. Hitachi HCP) return them oldest first instead.</p>
+<p>Set this quirk if --s3-version-at or --s3-versions produce incorrect
+results with your backend.</p>
+<p>This should be automatically set correctly for all providers rclone
+knows about - please make a bug report if not.</p>
+<p>Properties:</p>
+<ul>
+<li>Config: list_versions_oldest_first</li>
+<li>Env Var: RCLONE_S3_LIST_VERSIONS_OLDEST_FIRST</li>
+<li>Type: Tristate</li>
+<li>Default: unset</li>
+</ul>
<h4 id="s3-use-x-id">--s3-use-x-id</h4>
<p>Set if rclone should add x-id URL parameters.</p>
<p>You can change this if you want to disable the AWS SDK from adding
@@ -30788,6 +31451,172 @@ logs.</p>
<li>Type: Bits</li>
<li>Default: Off</li>
</ul>
+<h4 id="s3-ibm-iam-endpoint">--s3-ibm-iam-endpoint</h4>
+<p>IBM IAM Endpoint to use for authentication.</p>
+<p>Leave blank to use the default public endpoint.</p>
+<p>Properties:</p>
+<ul>
+<li>Config: ibm_iam_endpoint</li>
+<li>Env Var: RCLONE_S3_IBM_IAM_ENDPOINT</li>
+<li>Provider: IBMCOS</li>
+<li>Type: string</li>
+<li>Required: false</li>
+</ul>
+<h4 id="s3-object-lock-mode">--s3-object-lock-mode</h4>
+<p>Object Lock mode to apply when uploading or copying objects.</p>
+<p>Set this to apply Object Lock retention mode to objects. If not set,
+no Object Lock mode is applied (even with --metadata).</p>
+<p>Note: To enable Object Lock retention, you must set BOTH
+object_lock_mode AND object_lock_retain_until_date. Setting only one has
+no effect.</p>
+<ul>
+<li>GOVERNANCE: Set Object Lock mode to GOVERNANCE</li>
+<li>COMPLIANCE: Set Object Lock mode to COMPLIANCE</li>
+<li>copy: Copy the mode from the source object (requires
+--metadata)</li>
+</ul>
+<p>See:
+https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html</p>
+<p>Properties:</p>
+<ul>
+<li>Config: object_lock_mode</li>
+<li>Env Var: RCLONE_S3_OBJECT_LOCK_MODE</li>
+<li>Type: string</li>
+<li>Required: false</li>
+<li>Examples:
+<ul>
+<li>"GOVERNANCE"
+<ul>
+<li>Set Object Lock mode to GOVERNANCE</li>
+</ul></li>
+<li>"COMPLIANCE"
+<ul>
+<li>Set Object Lock mode to COMPLIANCE</li>
+</ul></li>
+<li>"copy"
+<ul>
+<li>Copy from source object (requires --metadata)</li>
+</ul></li>
+</ul></li>
+</ul>
+<h4
+id="s3-object-lock-retain-until-date">--s3-object-lock-retain-until-date</h4>
+<p>Object Lock retention until date to apply when uploading or copying
+objects.</p>
+<p>Set this to apply Object Lock retention date to objects. If not set,
+no retention date is applied (even with --metadata).</p>
+<p>Note: To enable Object Lock retention, you must set BOTH
+object_lock_mode AND object_lock_retain_until_date. Setting only one has
+no effect.</p>
+<p>Accepts: - RFC 3339 format: 2030-01-02T15:04:05Z - Duration from now:
+365d, 1y, 6M (days, years, months) - copy: Copy the date from the source
+object (requires --metadata)</p>
+<p>See:
+https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html</p>
+<p>Properties:</p>
+<ul>
+<li>Config: object_lock_retain_until_date</li>
+<li>Env Var: RCLONE_S3_OBJECT_LOCK_RETAIN_UNTIL_DATE</li>
+<li>Type: string</li>
+<li>Required: false</li>
+<li>Examples:
+<ul>
+<li>"copy"
+<ul>
+<li>Copy from source object (requires --metadata)</li>
+</ul></li>
+<li>"2030-01-01T00:00:00Z"
+<ul>
+<li>Set specific date (RFC 3339 format)</li>
+</ul></li>
+<li>"365d"
+<ul>
+<li>Set retention for 365 days from now</li>
+</ul></li>
+<li>"1y"
+<ul>
+<li>Set retention for 1 year from now</li>
+</ul></li>
+</ul></li>
+</ul>
+<h4
+id="s3-object-lock-legal-hold-status">--s3-object-lock-legal-hold-status</h4>
+<p>Object Lock legal hold status to apply when uploading or copying
+objects.</p>
+<p>Set this to apply Object Lock legal hold to objects. If not set, no
+legal hold is applied (even with --metadata).</p>
+<p>Note: Legal hold is independent of retention and can be set
+separately.</p>
+<ul>
+<li>ON: Enable legal hold</li>
+<li>OFF: Disable legal hold</li>
+<li>copy: Copy the legal hold status from the source object (requires
+--metadata)</li>
+</ul>
+<p>See:
+https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html</p>
+<p>Properties:</p>
+<ul>
+<li>Config: object_lock_legal_hold_status</li>
+<li>Env Var: RCLONE_S3_OBJECT_LOCK_LEGAL_HOLD_STATUS</li>
+<li>Type: string</li>
+<li>Required: false</li>
+<li>Examples:
+<ul>
+<li>"ON"
+<ul>
+<li>Enable legal hold</li>
+</ul></li>
+<li>"OFF"
+<ul>
+<li>Disable legal hold</li>
+</ul></li>
+<li>"copy"
+<ul>
+<li>Copy from source object (requires --metadata)</li>
+</ul></li>
+</ul></li>
+</ul>
+<h4
+id="s3-bypass-governance-retention">--s3-bypass-governance-retention</h4>
+<p>Allow deleting or modifying objects locked with GOVERNANCE mode.</p>
+<p>Properties:</p>
+<ul>
+<li>Config: bypass_governance_retention</li>
+<li>Env Var: RCLONE_S3_BYPASS_GOVERNANCE_RETENTION</li>
+<li>Type: bool</li>
+<li>Default: false</li>
+</ul>
+<h4
+id="s3-object-lock-set-after-upload">--s3-object-lock-set-after-upload</h4>
+<p>Set Object Lock via separate API calls after upload.</p>
+<p>Use this for S3-compatible providers that don't support setting
+Object Lock headers during PUT operations. When enabled, Object Lock is
+set via separate PutObjectRetention and PutObjectLegalHold API calls
+after the upload completes.</p>
+<p>This adds extra API calls per object, so only enable if your provider
+requires it.</p>
+<p>Properties:</p>
+<ul>
+<li>Config: object_lock_set_after_upload</li>
+<li>Env Var: RCLONE_S3_OBJECT_LOCK_SET_AFTER_UPLOAD</li>
+<li>Type: bool</li>
+<li>Default: false</li>
+</ul>
+<h4 id="s3-object-lock-supported">--s3-object-lock-supported</h4>
+<p>Whether the provider supports S3 Object Lock.</p>
+<p>This should be true, false or left unset to use the default for the
+provider.</p>
+<p>Set to false for providers that don't fully support the S3 Object
+Lock API (e.g. GCS which uses non-standard headers for bypass governance
+retention and doesn't implement Legal Hold via the S3 API).</p>
+<p>Properties:</p>
+<ul>
+<li>Config: object_lock_supported</li>
+<li>Env Var: RCLONE_S3_OBJECT_LOCK_SUPPORTED</li>
+<li>Type: Tristate</li>
+<li>Default: unset</li>
+</ul>
<h4 id="s3-description">--s3-description</h4>
<p>Description of the remote.</p>
<p>Properties:</p>
@@ -30869,6 +31698,27 @@ case insensitive and are always returned in lower case.</p>
<td>N</td>
</tr>
<tr class="even">
+<td>object-lock-legal-hold-status</td>
+<td>Object Lock legal hold status: ON or OFF</td>
+<td>string</td>
+<td>OFF</td>
+<td>N</td>
+</tr>
+<tr class="odd">
+<td>object-lock-mode</td>
+<td>Object Lock mode: GOVERNANCE or COMPLIANCE</td>
+<td>string</td>
+<td>GOVERNANCE</td>
+<td>N</td>
+</tr>
+<tr class="even">
+<td>object-lock-retain-until-date</td>
+<td>Object Lock retention until date</td>
+<td>RFC 3339</td>
+<td>2030-01-02T15:04:05Z</td>
+<td>N</td>
+</tr>
+<tr class="odd">
<td>tier</td>
<td>Tier of the object</td>
<td>string</td>
@@ -30908,17 +31758,17 @@ rclone backend restore s3:bucket/path/to/directory -o priority=PRIORITY</code></
<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>
-<div class="sourceCode" id="cb983"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb983-1"><a href="#cb983-1" aria-hidden="true" tabindex="-1"></a><span class="ot">[</span></span>
-<span id="cb983-2"><a href="#cb983-2" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
-<span id="cb983-3"><a href="#cb983-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Status&quot;</span><span class="fu">:</span> <span class="st">&quot;OK&quot;</span><span class="fu">,</span></span>
-<span id="cb983-4"><a href="#cb983-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Remote&quot;</span><span class="fu">:</span> <span class="st">&quot;test.txt&quot;</span></span>
-<span id="cb983-5"><a href="#cb983-5" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span><span class="ot">,</span></span>
-<span id="cb983-6"><a href="#cb983-6" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
-<span id="cb983-7"><a href="#cb983-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Status&quot;</span><span class="fu">:</span> <span class="st">&quot;OK&quot;</span><span class="fu">,</span></span>
-<span id="cb983-8"><a href="#cb983-8" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Remote&quot;</span><span class="fu">:</span> <span class="st">&quot;test/file4.txt&quot;</span></span>
-<span id="cb983-9"><a href="#cb983-9" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
-<span id="cb983-10"><a href="#cb983-10" aria-hidden="true" tabindex="-1"></a><span class="ot">]</span></span></code></pre></div>
+<div class="sourceCode" id="cb998"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb998-1"><a href="#cb998-1" aria-hidden="true" tabindex="-1"></a><span class="ot">[</span></span>
+<span id="cb998-2"><a href="#cb998-2" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
+<span id="cb998-3"><a href="#cb998-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Status&quot;</span><span class="fu">:</span> <span class="st">&quot;OK&quot;</span><span class="fu">,</span></span>
+<span id="cb998-4"><a href="#cb998-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Remote&quot;</span><span class="fu">:</span> <span class="st">&quot;test.txt&quot;</span></span>
+<span id="cb998-5"><a href="#cb998-5" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span><span class="ot">,</span></span>
+<span id="cb998-6"><a href="#cb998-6" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
+<span id="cb998-7"><a href="#cb998-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Status&quot;</span><span class="fu">:</span> <span class="st">&quot;OK&quot;</span><span class="fu">,</span></span>
+<span id="cb998-8"><a href="#cb998-8" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Remote&quot;</span><span class="fu">:</span> <span class="st">&quot;test/file4.txt&quot;</span></span>
+<span id="cb998-9"><a href="#cb998-9" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
+<span id="cb998-10"><a href="#cb998-10" aria-hidden="true" tabindex="-1"></a><span class="ot">]</span></span></code></pre></div>
<p>Options:</p>
<ul>
<li>"description": The optional description for the job.</li>
@@ -30940,36 +31790,36 @@ rclone backend restore-status s3:bucket/path/to/directory
rclone backend restore-status -o all s3:bucket/path/to/directory</code></pre>
<p>This command does not obey the filters.</p>
<p>It returns a list of status dictionaries:</p>
-<div class="sourceCode" id="cb986"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb986-1"><a href="#cb986-1" aria-hidden="true" tabindex="-1"></a><span class="ot">[</span></span>
-<span id="cb986-2"><a href="#cb986-2" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
-<span id="cb986-3"><a href="#cb986-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Remote&quot;</span><span class="fu">:</span> <span class="st">&quot;file.txt&quot;</span><span class="fu">,</span></span>
-<span id="cb986-4"><a href="#cb986-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;VersionID&quot;</span><span class="fu">:</span> <span class="kw">null</span><span class="fu">,</span></span>
-<span id="cb986-5"><a href="#cb986-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;RestoreStatus&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
-<span id="cb986-6"><a href="#cb986-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;IsRestoreInProgress&quot;</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span></span>
-<span id="cb986-7"><a href="#cb986-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;RestoreExpiryDate&quot;</span><span class="fu">:</span> <span class="st">&quot;2023-09-06T12:29:19+01:00&quot;</span></span>
-<span id="cb986-8"><a href="#cb986-8" aria-hidden="true" tabindex="-1"></a> <span class="fu">},</span></span>
-<span id="cb986-9"><a href="#cb986-9" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;StorageClass&quot;</span><span class="fu">:</span> <span class="st">&quot;GLACIER&quot;</span></span>
-<span id="cb986-10"><a href="#cb986-10" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span><span class="ot">,</span></span>
-<span id="cb986-11"><a href="#cb986-11" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
-<span id="cb986-12"><a href="#cb986-12" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Remote&quot;</span><span class="fu">:</span> <span class="st">&quot;test.pdf&quot;</span><span class="fu">,</span></span>
-<span id="cb986-13"><a href="#cb986-13" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;VersionID&quot;</span><span class="fu">:</span> <span class="kw">null</span><span class="fu">,</span></span>
-<span id="cb986-14"><a href="#cb986-14" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;RestoreStatus&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
-<span id="cb986-15"><a href="#cb986-15" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;IsRestoreInProgress&quot;</span><span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span></span>
-<span id="cb986-16"><a href="#cb986-16" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;RestoreExpiryDate&quot;</span><span class="fu">:</span> <span class="st">&quot;2023-09-06T12:29:19+01:00&quot;</span></span>
-<span id="cb986-17"><a href="#cb986-17" aria-hidden="true" tabindex="-1"></a> <span class="fu">},</span></span>
-<span id="cb986-18"><a href="#cb986-18" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;StorageClass&quot;</span><span class="fu">:</span> <span class="st">&quot;DEEP_ARCHIVE&quot;</span></span>
-<span id="cb986-19"><a href="#cb986-19" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span><span class="ot">,</span></span>
-<span id="cb986-20"><a href="#cb986-20" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
-<span id="cb986-21"><a href="#cb986-21" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Remote&quot;</span><span class="fu">:</span> <span class="st">&quot;test.gz&quot;</span><span class="fu">,</span></span>
-<span id="cb986-22"><a href="#cb986-22" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;VersionID&quot;</span><span class="fu">:</span> <span class="kw">null</span><span class="fu">,</span></span>
-<span id="cb986-23"><a href="#cb986-23" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;RestoreStatus&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
-<span id="cb986-24"><a href="#cb986-24" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;IsRestoreInProgress&quot;</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span></span>
-<span id="cb986-25"><a href="#cb986-25" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;RestoreExpiryDate&quot;</span><span class="fu">:</span> <span class="st">&quot;null&quot;</span></span>
-<span id="cb986-26"><a href="#cb986-26" aria-hidden="true" tabindex="-1"></a> <span class="fu">},</span></span>
-<span id="cb986-27"><a href="#cb986-27" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;StorageClass&quot;</span><span class="fu">:</span> <span class="st">&quot;INTELLIGENT_TIERING&quot;</span></span>
-<span id="cb986-28"><a href="#cb986-28" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
-<span id="cb986-29"><a href="#cb986-29" aria-hidden="true" tabindex="-1"></a><span class="ot">]</span></span></code></pre></div>
+<div class="sourceCode" id="cb1001"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb1001-1"><a href="#cb1001-1" aria-hidden="true" tabindex="-1"></a><span class="ot">[</span></span>
+<span id="cb1001-2"><a href="#cb1001-2" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
+<span id="cb1001-3"><a href="#cb1001-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Remote&quot;</span><span class="fu">:</span> <span class="st">&quot;file.txt&quot;</span><span class="fu">,</span></span>
+<span id="cb1001-4"><a href="#cb1001-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;VersionID&quot;</span><span class="fu">:</span> <span class="kw">null</span><span class="fu">,</span></span>
+<span id="cb1001-5"><a href="#cb1001-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;RestoreStatus&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
+<span id="cb1001-6"><a href="#cb1001-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;IsRestoreInProgress&quot;</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span></span>
+<span id="cb1001-7"><a href="#cb1001-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;RestoreExpiryDate&quot;</span><span class="fu">:</span> <span class="st">&quot;2023-09-06T12:29:19+01:00&quot;</span></span>
+<span id="cb1001-8"><a href="#cb1001-8" aria-hidden="true" tabindex="-1"></a> <span class="fu">},</span></span>
+<span id="cb1001-9"><a href="#cb1001-9" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;StorageClass&quot;</span><span class="fu">:</span> <span class="st">&quot;GLACIER&quot;</span></span>
+<span id="cb1001-10"><a href="#cb1001-10" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span><span class="ot">,</span></span>
+<span id="cb1001-11"><a href="#cb1001-11" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
+<span id="cb1001-12"><a href="#cb1001-12" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Remote&quot;</span><span class="fu">:</span> <span class="st">&quot;test.pdf&quot;</span><span class="fu">,</span></span>
+<span id="cb1001-13"><a href="#cb1001-13" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;VersionID&quot;</span><span class="fu">:</span> <span class="kw">null</span><span class="fu">,</span></span>
+<span id="cb1001-14"><a href="#cb1001-14" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;RestoreStatus&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
+<span id="cb1001-15"><a href="#cb1001-15" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;IsRestoreInProgress&quot;</span><span class="fu">:</span> <span class="kw">false</span><span class="fu">,</span></span>
+<span id="cb1001-16"><a href="#cb1001-16" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;RestoreExpiryDate&quot;</span><span class="fu">:</span> <span class="st">&quot;2023-09-06T12:29:19+01:00&quot;</span></span>
+<span id="cb1001-17"><a href="#cb1001-17" aria-hidden="true" tabindex="-1"></a> <span class="fu">},</span></span>
+<span id="cb1001-18"><a href="#cb1001-18" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;StorageClass&quot;</span><span class="fu">:</span> <span class="st">&quot;DEEP_ARCHIVE&quot;</span></span>
+<span id="cb1001-19"><a href="#cb1001-19" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span><span class="ot">,</span></span>
+<span id="cb1001-20"><a href="#cb1001-20" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
+<span id="cb1001-21"><a href="#cb1001-21" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Remote&quot;</span><span class="fu">:</span> <span class="st">&quot;test.gz&quot;</span><span class="fu">,</span></span>
+<span id="cb1001-22"><a href="#cb1001-22" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;VersionID&quot;</span><span class="fu">:</span> <span class="kw">null</span><span class="fu">,</span></span>
+<span id="cb1001-23"><a href="#cb1001-23" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;RestoreStatus&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
+<span id="cb1001-24"><a href="#cb1001-24" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;IsRestoreInProgress&quot;</span><span class="fu">:</span> <span class="kw">true</span><span class="fu">,</span></span>
+<span id="cb1001-25"><a href="#cb1001-25" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;RestoreExpiryDate&quot;</span><span class="fu">:</span> <span class="st">&quot;null&quot;</span></span>
+<span id="cb1001-26"><a href="#cb1001-26" aria-hidden="true" tabindex="-1"></a> <span class="fu">},</span></span>
+<span id="cb1001-27"><a href="#cb1001-27" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;StorageClass&quot;</span><span class="fu">:</span> <span class="st">&quot;INTELLIGENT_TIERING&quot;</span></span>
+<span id="cb1001-28"><a href="#cb1001-28" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
+<span id="cb1001-29"><a href="#cb1001-29" aria-hidden="true" tabindex="-1"></a><span class="ot">]</span></span></code></pre></div>
<p>Options:</p>
<ul>
<li>"all": If set then show all objects, not just ones with restore
@@ -30986,27 +31836,27 @@ format.</p>
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>
-<div class="sourceCode" id="cb989"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb989-1"><a href="#cb989-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
-<span id="cb989-2"><a href="#cb989-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;rclone&quot;</span><span class="fu">:</span> <span class="ot">[</span></span>
-<span id="cb989-3"><a href="#cb989-3" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
-<span id="cb989-4"><a href="#cb989-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Initiated&quot;</span><span class="fu">:</span> <span class="st">&quot;2020-06-26T14:20:36Z&quot;</span><span class="fu">,</span></span>
-<span id="cb989-5"><a href="#cb989-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Initiator&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
-<span id="cb989-6"><a href="#cb989-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;DisplayName&quot;</span><span class="fu">:</span> <span class="st">&quot;XXX&quot;</span><span class="fu">,</span></span>
-<span id="cb989-7"><a href="#cb989-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;ID&quot;</span><span class="fu">:</span> <span class="st">&quot;arn:aws:iam::XXX:user/XXX&quot;</span></span>
-<span id="cb989-8"><a href="#cb989-8" aria-hidden="true" tabindex="-1"></a> <span class="fu">},</span></span>
-<span id="cb989-9"><a href="#cb989-9" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Key&quot;</span><span class="fu">:</span> <span class="st">&quot;KEY&quot;</span><span class="fu">,</span></span>
-<span id="cb989-10"><a href="#cb989-10" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Owner&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
-<span id="cb989-11"><a href="#cb989-11" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;DisplayName&quot;</span><span class="fu">:</span> <span class="kw">null</span><span class="fu">,</span></span>
-<span id="cb989-12"><a href="#cb989-12" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;ID&quot;</span><span class="fu">:</span> <span class="st">&quot;XXX&quot;</span></span>
-<span id="cb989-13"><a href="#cb989-13" aria-hidden="true" tabindex="-1"></a> <span class="fu">},</span></span>
-<span id="cb989-14"><a href="#cb989-14" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;StorageClass&quot;</span><span class="fu">:</span> <span class="st">&quot;STANDARD&quot;</span><span class="fu">,</span></span>
-<span id="cb989-15"><a href="#cb989-15" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;UploadId&quot;</span><span class="fu">:</span> <span class="st">&quot;XXX&quot;</span></span>
-<span id="cb989-16"><a href="#cb989-16" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
-<span id="cb989-17"><a href="#cb989-17" aria-hidden="true" tabindex="-1"></a> <span class="ot">]</span><span class="fu">,</span></span>
-<span id="cb989-18"><a href="#cb989-18" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;rclone-1000files&quot;</span><span class="fu">:</span> <span class="ot">[]</span><span class="fu">,</span></span>
-<span id="cb989-19"><a href="#cb989-19" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;rclone-dst&quot;</span><span class="fu">:</span> <span class="ot">[]</span></span>
-<span id="cb989-20"><a href="#cb989-20" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
+<div class="sourceCode" id="cb1004"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb1004-1"><a href="#cb1004-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
+<span id="cb1004-2"><a href="#cb1004-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;rclone&quot;</span><span class="fu">:</span> <span class="ot">[</span></span>
+<span id="cb1004-3"><a href="#cb1004-3" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
+<span id="cb1004-4"><a href="#cb1004-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Initiated&quot;</span><span class="fu">:</span> <span class="st">&quot;2020-06-26T14:20:36Z&quot;</span><span class="fu">,</span></span>
+<span id="cb1004-5"><a href="#cb1004-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Initiator&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
+<span id="cb1004-6"><a href="#cb1004-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;DisplayName&quot;</span><span class="fu">:</span> <span class="st">&quot;XXX&quot;</span><span class="fu">,</span></span>
+<span id="cb1004-7"><a href="#cb1004-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;ID&quot;</span><span class="fu">:</span> <span class="st">&quot;arn:aws:iam::XXX:user/XXX&quot;</span></span>
+<span id="cb1004-8"><a href="#cb1004-8" aria-hidden="true" tabindex="-1"></a> <span class="fu">},</span></span>
+<span id="cb1004-9"><a href="#cb1004-9" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Key&quot;</span><span class="fu">:</span> <span class="st">&quot;KEY&quot;</span><span class="fu">,</span></span>
+<span id="cb1004-10"><a href="#cb1004-10" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Owner&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
+<span id="cb1004-11"><a href="#cb1004-11" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;DisplayName&quot;</span><span class="fu">:</span> <span class="kw">null</span><span class="fu">,</span></span>
+<span id="cb1004-12"><a href="#cb1004-12" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;ID&quot;</span><span class="fu">:</span> <span class="st">&quot;XXX&quot;</span></span>
+<span id="cb1004-13"><a href="#cb1004-13" aria-hidden="true" tabindex="-1"></a> <span class="fu">},</span></span>
+<span id="cb1004-14"><a href="#cb1004-14" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;StorageClass&quot;</span><span class="fu">:</span> <span class="st">&quot;STANDARD&quot;</span><span class="fu">,</span></span>
+<span id="cb1004-15"><a href="#cb1004-15" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;UploadId&quot;</span><span class="fu">:</span> <span class="st">&quot;XXX&quot;</span></span>
+<span id="cb1004-16"><a href="#cb1004-16" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
+<span id="cb1004-17"><a href="#cb1004-17" aria-hidden="true" tabindex="-1"></a> <span class="ot">]</span><span class="fu">,</span></span>
+<span id="cb1004-18"><a href="#cb1004-18" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;rclone-1000files&quot;</span><span class="fu">:</span> <span class="ot">[]</span><span class="fu">,</span></span>
+<span id="cb1004-19"><a href="#cb1004-19" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;rclone-dst&quot;</span><span class="fu">:</span> <span class="ot">[]</span></span>
+<span id="cb1004-20"><a href="#cb1004-20" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<h3 id="cleanup-2">cleanup</h3>
<p>Remove unfinished multipart uploads.</p>
<pre class="console"><code>rclone backend cleanup remote: [options] [&lt;arguments&gt;+]</code></pre>
@@ -31062,10 +31912,10 @@ will default to those currently in use.</p>
<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>
-<div class="sourceCode" id="cb998"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb998-1"><a href="#cb998-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[anons3]</span></span>
-<span id="cb998-2"><a href="#cb998-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
-<span id="cb998-3"><a href="#cb998-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> AWS</span></span></code></pre></div>
+<div class="sourceCode" id="cb1013"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1013-1"><a href="#cb1013-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[anons3]</span></span>
+<span id="cb1013-2"><a href="#cb1013-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
+<span id="cb1013-3"><a href="#cb1013-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> AWS</span></span></code></pre></div>
<p>Then use it as normal with the name of the public bucket, e.g.</p>
<pre class="console"><code>rclone lsd anons3:1000genomes</code></pre>
<p>You will be able to list and copy data but not upload it.</p>
@@ -31101,14 +31951,14 @@ 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>
-<div class="sourceCode" id="cb1001"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1001-1"><a href="#cb1001-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[snowball]</span></span>
-<span id="cb1001-2"><a href="#cb1001-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
-<span id="cb1001-3"><a href="#cb1001-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> Other</span></span>
-<span id="cb1001-4"><a href="#cb1001-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> YOUR_ACCESS_KEY</span></span>
-<span id="cb1001-5"><a href="#cb1001-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> YOUR_SECRET_KEY</span></span>
-<span id="cb1001-6"><a href="#cb1001-6" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> http://[IP of Snowball]:8080</span></span>
-<span id="cb1001-7"><a href="#cb1001-7" aria-hidden="true" tabindex="-1"></a><span class="dt">upload_cutoff </span><span class="ot">=</span><span class="st"> </span><span class="dv">0</span></span></code></pre></div>
+<div class="sourceCode" id="cb1016"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1016-1"><a href="#cb1016-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[snowball]</span></span>
+<span id="cb1016-2"><a href="#cb1016-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
+<span id="cb1016-3"><a href="#cb1016-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> Other</span></span>
+<span id="cb1016-4"><a href="#cb1016-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> YOUR_ACCESS_KEY</span></span>
+<span id="cb1016-5"><a href="#cb1016-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> YOUR_SECRET_KEY</span></span>
+<span id="cb1016-6"><a href="#cb1016-6" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> http://[IP of Snowball]:8080</span></span>
+<span id="cb1016-7"><a href="#cb1016-7" aria-hidden="true" tabindex="-1"></a><span class="dt">upload_cutoff </span><span class="ot">=</span><span class="st"> </span><span class="dv">0</span></span></code></pre></div>
<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)
@@ -31303,19 +32153,19 @@ 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>
-<div class="sourceCode" id="cb1005"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1005-1"><a href="#cb1005-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[ArvanCloud]</span></span>
-<span id="cb1005-2"><a href="#cb1005-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
-<span id="cb1005-3"><a href="#cb1005-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> ArvanCloud</span></span>
-<span id="cb1005-4"><a href="#cb1005-4" aria-hidden="true" tabindex="-1"></a><span class="dt">env_auth </span><span class="ot">=</span><span class="st"> </span><span class="kw">false</span></span>
-<span id="cb1005-5"><a href="#cb1005-5" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> YOURACCESSKEY</span></span>
-<span id="cb1005-6"><a href="#cb1005-6" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> YOURSECRETACCESSKEY</span></span>
-<span id="cb1005-7"><a href="#cb1005-7" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span></span>
-<span id="cb1005-8"><a href="#cb1005-8" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> s3.arvanstorage.com</span></span>
-<span id="cb1005-9"><a href="#cb1005-9" aria-hidden="true" tabindex="-1"></a><span class="dt">location_constraint </span><span class="ot">=</span></span>
-<span id="cb1005-10"><a href="#cb1005-10" aria-hidden="true" tabindex="-1"></a><span class="dt">acl </span><span class="ot">=</span></span>
-<span id="cb1005-11"><a href="#cb1005-11" aria-hidden="true" tabindex="-1"></a><span class="dt">server_side_encryption </span><span class="ot">=</span></span>
-<span id="cb1005-12"><a href="#cb1005-12" aria-hidden="true" tabindex="-1"></a><span class="dt">storage_class </span><span class="ot">=</span></span></code></pre></div>
+<div class="sourceCode" id="cb1020"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1020-1"><a href="#cb1020-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[ArvanCloud]</span></span>
+<span id="cb1020-2"><a href="#cb1020-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
+<span id="cb1020-3"><a href="#cb1020-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> ArvanCloud</span></span>
+<span id="cb1020-4"><a href="#cb1020-4" aria-hidden="true" tabindex="-1"></a><span class="dt">env_auth </span><span class="ot">=</span><span class="st"> </span><span class="kw">false</span></span>
+<span id="cb1020-5"><a href="#cb1020-5" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> YOURACCESSKEY</span></span>
+<span id="cb1020-6"><a href="#cb1020-6" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> YOURSECRETACCESSKEY</span></span>
+<span id="cb1020-7"><a href="#cb1020-7" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span></span>
+<span id="cb1020-8"><a href="#cb1020-8" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> s3.arvanstorage.com</span></span>
+<span id="cb1020-9"><a href="#cb1020-9" aria-hidden="true" tabindex="-1"></a><span class="dt">location_constraint </span><span class="ot">=</span></span>
+<span id="cb1020-10"><a href="#cb1020-10" aria-hidden="true" tabindex="-1"></a><span class="dt">acl </span><span class="ot">=</span></span>
+<span id="cb1020-11"><a href="#cb1020-11" aria-hidden="true" tabindex="-1"></a><span class="dt">server_side_encryption </span><span class="ot">=</span></span>
+<span id="cb1020-12"><a href="#cb1020-12" aria-hidden="true" tabindex="-1"></a><span class="dt">storage_class </span><span class="ot">=</span></span></code></pre></div>
<h3 id="bizflycloud">BizflyCloud</h3>
<p><a href="https://bizflycloud.vn/simple-storage">Bizfly Cloud Simple
Storage</a> is an S3-compatible service with regions in Hanoi (HN) and
@@ -31326,19 +32176,19 @@ Ho Chi Minh City (HCM).</p>
<li>HCM: <code>hcm.ss.bfcplatform.vn</code></li>
</ul>
<p>A minimal configuration looks like this.</p>
-<div class="sourceCode" id="cb1006"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1006-1"><a href="#cb1006-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[bizfly]</span></span>
-<span id="cb1006-2"><a href="#cb1006-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
-<span id="cb1006-3"><a href="#cb1006-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> BizflyCloud</span></span>
-<span id="cb1006-4"><a href="#cb1006-4" aria-hidden="true" tabindex="-1"></a><span class="dt">env_auth </span><span class="ot">=</span><span class="st"> </span><span class="kw">false</span></span>
-<span id="cb1006-5"><a href="#cb1006-5" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> YOUR_ACCESS_KEY</span></span>
-<span id="cb1006-6"><a href="#cb1006-6" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> YOUR_SECRET_KEY</span></span>
-<span id="cb1006-7"><a href="#cb1006-7" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span><span class="st"> HN</span></span>
-<span id="cb1006-8"><a href="#cb1006-8" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> hn.ss.bfcplatform.vn</span></span>
-<span id="cb1006-9"><a href="#cb1006-9" aria-hidden="true" tabindex="-1"></a><span class="dt">location_constraint </span><span class="ot">=</span></span>
-<span id="cb1006-10"><a href="#cb1006-10" aria-hidden="true" tabindex="-1"></a><span class="dt">acl </span><span class="ot">=</span></span>
-<span id="cb1006-11"><a href="#cb1006-11" aria-hidden="true" tabindex="-1"></a><span class="dt">server_side_encryption </span><span class="ot">=</span></span>
-<span id="cb1006-12"><a href="#cb1006-12" aria-hidden="true" tabindex="-1"></a><span class="dt">storage_class </span><span class="ot">=</span></span></code></pre></div>
+<div class="sourceCode" id="cb1021"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1021-1"><a href="#cb1021-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[bizfly]</span></span>
+<span id="cb1021-2"><a href="#cb1021-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
+<span id="cb1021-3"><a href="#cb1021-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> BizflyCloud</span></span>
+<span id="cb1021-4"><a href="#cb1021-4" aria-hidden="true" tabindex="-1"></a><span class="dt">env_auth </span><span class="ot">=</span><span class="st"> </span><span class="kw">false</span></span>
+<span id="cb1021-5"><a href="#cb1021-5" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> YOUR_ACCESS_KEY</span></span>
+<span id="cb1021-6"><a href="#cb1021-6" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> YOUR_SECRET_KEY</span></span>
+<span id="cb1021-7"><a href="#cb1021-7" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span><span class="st"> HN</span></span>
+<span id="cb1021-8"><a href="#cb1021-8" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> hn.ss.bfcplatform.vn</span></span>
+<span id="cb1021-9"><a href="#cb1021-9" aria-hidden="true" tabindex="-1"></a><span class="dt">location_constraint </span><span class="ot">=</span></span>
+<span id="cb1021-10"><a href="#cb1021-10" aria-hidden="true" tabindex="-1"></a><span class="dt">acl </span><span class="ot">=</span></span>
+<span id="cb1021-11"><a href="#cb1021-11" aria-hidden="true" tabindex="-1"></a><span class="dt">server_side_encryption </span><span class="ot">=</span></span>
+<span id="cb1021-12"><a href="#cb1021-12" aria-hidden="true" tabindex="-1"></a><span class="dt">storage_class </span><span class="ot">=</span></span></code></pre></div>
<p>Switch <code>region</code> and <code>endpoint</code> to
<code>HCM</code> and <code>hcm.ss.bfcplatform.vn</code> for Ho Chi Minh
City.</p>
@@ -31350,19 +32200,19 @@ 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>
-<div class="sourceCode" id="cb1007"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1007-1"><a href="#cb1007-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[ceph]</span></span>
-<span id="cb1007-2"><a href="#cb1007-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
-<span id="cb1007-3"><a href="#cb1007-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> Ceph</span></span>
-<span id="cb1007-4"><a href="#cb1007-4" aria-hidden="true" tabindex="-1"></a><span class="dt">env_auth </span><span class="ot">=</span><span class="st"> </span><span class="kw">false</span></span>
-<span id="cb1007-5"><a href="#cb1007-5" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> XXX</span></span>
-<span id="cb1007-6"><a href="#cb1007-6" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> YYY</span></span>
-<span id="cb1007-7"><a href="#cb1007-7" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span></span>
-<span id="cb1007-8"><a href="#cb1007-8" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> https://ceph.endpoint.example.com</span></span>
-<span id="cb1007-9"><a href="#cb1007-9" aria-hidden="true" tabindex="-1"></a><span class="dt">location_constraint </span><span class="ot">=</span></span>
-<span id="cb1007-10"><a href="#cb1007-10" aria-hidden="true" tabindex="-1"></a><span class="dt">acl </span><span class="ot">=</span></span>
-<span id="cb1007-11"><a href="#cb1007-11" aria-hidden="true" tabindex="-1"></a><span class="dt">server_side_encryption </span><span class="ot">=</span></span>
-<span id="cb1007-12"><a href="#cb1007-12" aria-hidden="true" tabindex="-1"></a><span class="dt">storage_class </span><span class="ot">=</span></span></code></pre></div>
+<div class="sourceCode" id="cb1022"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1022-1"><a href="#cb1022-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[ceph]</span></span>
+<span id="cb1022-2"><a href="#cb1022-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
+<span id="cb1022-3"><a href="#cb1022-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> Ceph</span></span>
+<span id="cb1022-4"><a href="#cb1022-4" aria-hidden="true" tabindex="-1"></a><span class="dt">env_auth </span><span class="ot">=</span><span class="st"> </span><span class="kw">false</span></span>
+<span id="cb1022-5"><a href="#cb1022-5" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> XXX</span></span>
+<span id="cb1022-6"><a href="#cb1022-6" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> YYY</span></span>
+<span id="cb1022-7"><a href="#cb1022-7" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span></span>
+<span id="cb1022-8"><a href="#cb1022-8" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> https://ceph.endpoint.example.com</span></span>
+<span id="cb1022-9"><a href="#cb1022-9" aria-hidden="true" tabindex="-1"></a><span class="dt">location_constraint </span><span class="ot">=</span></span>
+<span id="cb1022-10"><a href="#cb1022-10" aria-hidden="true" tabindex="-1"></a><span class="dt">acl </span><span class="ot">=</span></span>
+<span id="cb1022-11"><a href="#cb1022-11" aria-hidden="true" tabindex="-1"></a><span class="dt">server_side_encryption </span><span class="ot">=</span></span>
+<span id="cb1022-12"><a href="#cb1022-12" aria-hidden="true" tabindex="-1"></a><span class="dt">storage_class </span><span class="ot">=</span></span></code></pre></div>
<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
@@ -31375,18 +32225,18 @@ tools you will get a JSON blob with the <code>/</code> escaped as
access key.</p>
<p>Eg the dump from Ceph looks something like this (irrelevant keys
removed).</p>
-<div class="sourceCode" id="cb1008"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb1008-1"><a href="#cb1008-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
-<span id="cb1008-2"><a href="#cb1008-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;user_id&quot;</span><span class="fu">:</span> <span class="st">&quot;xxx&quot;</span><span class="fu">,</span></span>
-<span id="cb1008-3"><a href="#cb1008-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;display_name&quot;</span><span class="fu">:</span> <span class="st">&quot;xxxx&quot;</span><span class="fu">,</span></span>
-<span id="cb1008-4"><a href="#cb1008-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;keys&quot;</span><span class="fu">:</span> <span class="ot">[</span></span>
-<span id="cb1008-5"><a href="#cb1008-5" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
-<span id="cb1008-6"><a href="#cb1008-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;user&quot;</span><span class="fu">:</span> <span class="st">&quot;xxx&quot;</span><span class="fu">,</span></span>
-<span id="cb1008-7"><a href="#cb1008-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;access_key&quot;</span><span class="fu">:</span> <span class="st">&quot;xxxxxx&quot;</span><span class="fu">,</span></span>
-<span id="cb1008-8"><a href="#cb1008-8" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;secret_key&quot;</span><span class="fu">:</span> <span class="st">&quot;xxxxxx</span><span class="ch">\/</span><span class="st">xxxx&quot;</span></span>
-<span id="cb1008-9"><a href="#cb1008-9" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
-<span id="cb1008-10"><a href="#cb1008-10" aria-hidden="true" tabindex="-1"></a> <span class="ot">]</span><span class="fu">,</span></span>
-<span id="cb1008-11"><a href="#cb1008-11" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
+<div class="sourceCode" id="cb1023"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb1023-1"><a href="#cb1023-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
+<span id="cb1023-2"><a href="#cb1023-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;user_id&quot;</span><span class="fu">:</span> <span class="st">&quot;xxx&quot;</span><span class="fu">,</span></span>
+<span id="cb1023-3"><a href="#cb1023-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;display_name&quot;</span><span class="fu">:</span> <span class="st">&quot;xxxx&quot;</span><span class="fu">,</span></span>
+<span id="cb1023-4"><a href="#cb1023-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;keys&quot;</span><span class="fu">:</span> <span class="ot">[</span></span>
+<span id="cb1023-5"><a href="#cb1023-5" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
+<span id="cb1023-6"><a href="#cb1023-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;user&quot;</span><span class="fu">:</span> <span class="st">&quot;xxx&quot;</span><span class="fu">,</span></span>
+<span id="cb1023-7"><a href="#cb1023-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;access_key&quot;</span><span class="fu">:</span> <span class="st">&quot;xxxxxx&quot;</span><span class="fu">,</span></span>
+<span id="cb1023-8"><a href="#cb1023-8" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;secret_key&quot;</span><span class="fu">:</span> <span class="st">&quot;xxxxxx</span><span class="ch">\/</span><span class="st">xxxx&quot;</span></span>
+<span id="cb1023-9"><a href="#cb1023-9" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
+<span id="cb1023-10"><a href="#cb1023-10" aria-hidden="true" tabindex="-1"></a> <span class="ot">]</span><span class="fu">,</span></span>
+<span id="cb1023-11"><a href="#cb1023-11" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<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>
@@ -31658,7 +32508,7 @@ Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
...
-XX / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, China Mobile, Cloudflare, ArvanCloud, DigitalOcean, Dreamhost, Huawei OBS, IBM COS, Lyve Cloud, Minio, Magalu, Netease, RackCorp, Scaleway, SeaweedFS, StackPath, Storj, Synology, Tencent COS and Wasabi
+XX / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, China Mobile, Cloudflare, ArvanCloud, DigitalOcean, Dreamhost, Huawei OBS, IBM COS, Lyve Cloud, Minio, Magalu, Netease, RackCorp, Scaleway, SeaweedFS, Storj, Synology, Tencent COS and Wasabi
\ (s3)
...
Storage&gt; s3
@@ -31713,15 +32563,15 @@ 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>
-<div class="sourceCode" id="cb1013"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1013-1"><a href="#cb1013-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[r2]</span></span>
-<span id="cb1013-2"><a href="#cb1013-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
-<span id="cb1013-3"><a href="#cb1013-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> Cloudflare</span></span>
-<span id="cb1013-4"><a href="#cb1013-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> ACCESS_KEY</span></span>
-<span id="cb1013-5"><a href="#cb1013-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> SECRET_ACCESS_KEY</span></span>
-<span id="cb1013-6"><a href="#cb1013-6" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span><span class="st"> auto</span></span>
-<span id="cb1013-7"><a href="#cb1013-7" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> https://ACCOUNT_ID.r2.cloudflarestorage.com</span></span>
-<span id="cb1013-8"><a href="#cb1013-8" aria-hidden="true" tabindex="-1"></a><span class="dt">acl </span><span class="ot">=</span><span class="st"> private</span></span></code></pre></div>
+<div class="sourceCode" id="cb1028"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1028-1"><a href="#cb1028-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[r2]</span></span>
+<span id="cb1028-2"><a href="#cb1028-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
+<span id="cb1028-3"><a href="#cb1028-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> Cloudflare</span></span>
+<span id="cb1028-4"><a href="#cb1028-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> ACCESS_KEY</span></span>
+<span id="cb1028-5"><a href="#cb1028-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> SECRET_ACCESS_KEY</span></span>
+<span id="cb1028-6"><a href="#cb1028-6" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span><span class="st"> auto</span></span>
+<span id="cb1028-7"><a href="#cb1028-7" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> https://ACCOUNT_ID.r2.cloudflarestorage.com</span></span>
+<span id="cb1028-8"><a href="#cb1028-8" aria-hidden="true" tabindex="-1"></a><span class="dt">acl </span><span class="ot">=</span><span class="st"> private</span></span></code></pre></div>
<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>
<p>For R2 tokens with the "Object Read &amp; Write" permission, you may
@@ -31742,7 +32592,10 @@ href="https://docs.cubbit.io/getting-started/quickstart#api-keys">guide</a>
to retrieve these keys. They will be needed when prompted by
<code>rclone config</code>.</p>
<p>Default region will correspond to <code>eu-west-1</code> and the
-endpoint has to be specified as <code>s3.cubbit.eu</code>.</p>
+endpoint has to be specified as <code>s3.cubbit.eu</code>. If you set a
+custom tenant endpoint, you must use
+<code>s3.{tenant_name}.cubbit.eu</code>, because the generic
+<code>s3.cubbit.eu</code> endpoint will not work in this case.</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>
@@ -31753,17 +32606,17 @@ env_auth&gt; false
access_key_id&gt; YOUR_ACCESS_KEY
secret_access_key&gt; YOUR_SECRET_KEY
region&gt; eu-west-1 (or leave empty)
-endpoint&gt; s3.cubbit.eu
+endpoint&gt; s3.cubbit.eu (or s3.{tenant_name}.cubbit.eu)
acl&gt;</code></pre>
<p>The resulting configuration file should look like:</p>
-<div class="sourceCode" id="cb1015"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1015-1"><a href="#cb1015-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[cubbit-ds3]</span></span>
-<span id="cb1015-2"><a href="#cb1015-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
-<span id="cb1015-3"><a href="#cb1015-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> Cubbit</span></span>
-<span id="cb1015-4"><a href="#cb1015-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> ACCESS_KEY</span></span>
-<span id="cb1015-5"><a href="#cb1015-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> SECRET_KEY</span></span>
-<span id="cb1015-6"><a href="#cb1015-6" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span><span class="st"> eu-west-1</span></span>
-<span id="cb1015-7"><a href="#cb1015-7" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> s3.cubbit.eu</span></span></code></pre></div>
+<div class="sourceCode" id="cb1030"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1030-1"><a href="#cb1030-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[cubbit-ds3]</span></span>
+<span id="cb1030-2"><a href="#cb1030-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
+<span id="cb1030-3"><a href="#cb1030-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> Cubbit</span></span>
+<span id="cb1030-4"><a href="#cb1030-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> ACCESS_KEY</span></span>
+<span id="cb1030-5"><a href="#cb1030-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> SECRET_KEY</span></span>
+<span id="cb1030-6"><a href="#cb1030-6" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span><span class="st"> eu-west-1</span></span>
+<span id="cb1030-7"><a href="#cb1030-7" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> s3.cubbit.eu</span></span></code></pre></div>
<p>You can then start using Cubbit DS3 with rclone. For example, to
create a new bucket and copy files into it, you can run:</p>
<pre class="console"><code>rclone mkdir cubbit-ds3:my-bucket
@@ -31798,19 +32651,19 @@ location_constraint&gt;
acl&gt;
storage_class&gt;</code></pre>
<p>The resulting configuration file should look like:</p>
-<div class="sourceCode" id="cb1018"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1018-1"><a href="#cb1018-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[spaces]</span></span>
-<span id="cb1018-2"><a href="#cb1018-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
-<span id="cb1018-3"><a href="#cb1018-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> DigitalOcean</span></span>
-<span id="cb1018-4"><a href="#cb1018-4" aria-hidden="true" tabindex="-1"></a><span class="dt">env_auth </span><span class="ot">=</span><span class="st"> </span><span class="kw">false</span></span>
-<span id="cb1018-5"><a href="#cb1018-5" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> YOUR_ACCESS_KEY</span></span>
-<span id="cb1018-6"><a href="#cb1018-6" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> YOUR_SECRET_KEY</span></span>
-<span id="cb1018-7"><a href="#cb1018-7" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span></span>
-<span id="cb1018-8"><a href="#cb1018-8" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> nyc3.digitaloceanspaces.com</span></span>
-<span id="cb1018-9"><a href="#cb1018-9" aria-hidden="true" tabindex="-1"></a><span class="dt">location_constraint </span><span class="ot">=</span></span>
-<span id="cb1018-10"><a href="#cb1018-10" aria-hidden="true" tabindex="-1"></a><span class="dt">acl </span><span class="ot">=</span></span>
-<span id="cb1018-11"><a href="#cb1018-11" aria-hidden="true" tabindex="-1"></a><span class="dt">server_side_encryption </span><span class="ot">=</span></span>
-<span id="cb1018-12"><a href="#cb1018-12" aria-hidden="true" tabindex="-1"></a><span class="dt">storage_class </span><span class="ot">=</span></span></code></pre></div>
+<div class="sourceCode" id="cb1033"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1033-1"><a href="#cb1033-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[spaces]</span></span>
+<span id="cb1033-2"><a href="#cb1033-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
+<span id="cb1033-3"><a href="#cb1033-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> DigitalOcean</span></span>
+<span id="cb1033-4"><a href="#cb1033-4" aria-hidden="true" tabindex="-1"></a><span class="dt">env_auth </span><span class="ot">=</span><span class="st"> </span><span class="kw">false</span></span>
+<span id="cb1033-5"><a href="#cb1033-5" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> YOUR_ACCESS_KEY</span></span>
+<span id="cb1033-6"><a href="#cb1033-6" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> YOUR_SECRET_KEY</span></span>
+<span id="cb1033-7"><a href="#cb1033-7" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span></span>
+<span id="cb1033-8"><a href="#cb1033-8" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> nyc3.digitaloceanspaces.com</span></span>
+<span id="cb1033-9"><a href="#cb1033-9" aria-hidden="true" tabindex="-1"></a><span class="dt">location_constraint </span><span class="ot">=</span></span>
+<span id="cb1033-10"><a href="#cb1033-10" aria-hidden="true" tabindex="-1"></a><span class="dt">acl </span><span class="ot">=</span></span>
+<span id="cb1033-11"><a href="#cb1033-11" aria-hidden="true" tabindex="-1"></a><span class="dt">server_side_encryption </span><span class="ot">=</span></span>
+<span id="cb1033-12"><a href="#cb1033-12" aria-hidden="true" tabindex="-1"></a><span class="dt">storage_class </span><span class="ot">=</span></span></code></pre></div>
<p>Once configured, you can create a new Space and begin copying files.
For example:</p>
<pre class="console"><code>rclone mkdir spaces:my-new-space
@@ -31822,19 +32675,19 @@ 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>
-<div class="sourceCode" id="cb1020"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1020-1"><a href="#cb1020-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[dreamobjects]</span></span>
-<span id="cb1020-2"><a href="#cb1020-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
-<span id="cb1020-3"><a href="#cb1020-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> DreamHost</span></span>
-<span id="cb1020-4"><a href="#cb1020-4" aria-hidden="true" tabindex="-1"></a><span class="dt">env_auth </span><span class="ot">=</span><span class="st"> </span><span class="kw">false</span></span>
-<span id="cb1020-5"><a href="#cb1020-5" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> your_access_key</span></span>
-<span id="cb1020-6"><a href="#cb1020-6" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> your_secret_key</span></span>
-<span id="cb1020-7"><a href="#cb1020-7" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span></span>
-<span id="cb1020-8"><a href="#cb1020-8" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> objects-us-west-1.dream.io</span></span>
-<span id="cb1020-9"><a href="#cb1020-9" aria-hidden="true" tabindex="-1"></a><span class="dt">location_constraint </span><span class="ot">=</span></span>
-<span id="cb1020-10"><a href="#cb1020-10" aria-hidden="true" tabindex="-1"></a><span class="dt">acl </span><span class="ot">=</span><span class="st"> private</span></span>
-<span id="cb1020-11"><a href="#cb1020-11" aria-hidden="true" tabindex="-1"></a><span class="dt">server_side_encryption </span><span class="ot">=</span></span>
-<span id="cb1020-12"><a href="#cb1020-12" aria-hidden="true" tabindex="-1"></a><span class="dt">storage_class </span><span class="ot">=</span></span></code></pre></div>
+<div class="sourceCode" id="cb1035"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1035-1"><a href="#cb1035-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[dreamobjects]</span></span>
+<span id="cb1035-2"><a href="#cb1035-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
+<span id="cb1035-3"><a href="#cb1035-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> DreamHost</span></span>
+<span id="cb1035-4"><a href="#cb1035-4" aria-hidden="true" tabindex="-1"></a><span class="dt">env_auth </span><span class="ot">=</span><span class="st"> </span><span class="kw">false</span></span>
+<span id="cb1035-5"><a href="#cb1035-5" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> your_access_key</span></span>
+<span id="cb1035-6"><a href="#cb1035-6" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> your_secret_key</span></span>
+<span id="cb1035-7"><a href="#cb1035-7" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span></span>
+<span id="cb1035-8"><a href="#cb1035-8" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> objects-us-west-1.dream.io</span></span>
+<span id="cb1035-9"><a href="#cb1035-9" aria-hidden="true" tabindex="-1"></a><span class="dt">location_constraint </span><span class="ot">=</span></span>
+<span id="cb1035-10"><a href="#cb1035-10" aria-hidden="true" tabindex="-1"></a><span class="dt">acl </span><span class="ot">=</span><span class="st"> private</span></span>
+<span id="cb1035-11"><a href="#cb1035-11" aria-hidden="true" tabindex="-1"></a><span class="dt">server_side_encryption </span><span class="ot">=</span></span>
+<span id="cb1035-12"><a href="#cb1035-12" aria-hidden="true" tabindex="-1"></a><span class="dt">storage_class </span><span class="ot">=</span></span></code></pre></div>
<h3 id="exaba">Exaba</h3>
<p><a href="https://exaba.com/">Exaba</a> is an on-premises,
S3-compatible storage for service providers and large enterprises. It is
@@ -31895,13 +32748,86 @@ y) Yes
n) No (default)
y/n&gt; n</code></pre>
<p>And the config generated will end up looking like this:</p>
-<div class="sourceCode" id="cb1022"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1022-1"><a href="#cb1022-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[exaba]</span></span>
-<span id="cb1022-2"><a href="#cb1022-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
-<span id="cb1022-3"><a href="#cb1022-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> Exaba</span></span>
-<span id="cb1022-4"><a href="#cb1022-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> XXX</span></span>
-<span id="cb1022-5"><a href="#cb1022-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> XXX</span></span>
-<span id="cb1022-6"><a href="#cb1022-6" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> http://127.0.0.1:9000/</span></span></code></pre></div>
+<div class="sourceCode" id="cb1037"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1037-1"><a href="#cb1037-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[exaba]</span></span>
+<span id="cb1037-2"><a href="#cb1037-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
+<span id="cb1037-3"><a href="#cb1037-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> Exaba</span></span>
+<span id="cb1037-4"><a href="#cb1037-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> XXX</span></span>
+<span id="cb1037-5"><a href="#cb1037-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> XXX</span></span>
+<span id="cb1037-6"><a href="#cb1037-6" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> http://127.0.0.1:9000/</span></span></code></pre></div>
+<h3 id="fastly">Fastly Object Storage</h3>
+<p><a href="https://www.fastly.com/products/storage">Fastly Object
+Storage</a> is an S3-compatible object storage service from Fastly. It
+provides three regions (US East, US West, and EU Central) with mandatory
+server-side encryption.</p>
+<p>Here is an example of making a configuration. First run:</p>
+<pre class="console"><code>rclone config</code></pre>
+<p>This will guide you through an interactive setup process.</p>
+<pre class="text"><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; fastly
+
+Option Storage.
+Type of storage to configure.
+Storage&gt; s3
+
+Option provider.
+Choose your S3 provider.
+provider&gt; Fastly
+
+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.
+env_auth&gt; false
+
+Option access_key_id.
+AWS Access Key ID.
+access_key_id&gt; YOUR_ACCESS_KEY
+
+Option secret_access_key.
+AWS Secret Access Key (password).
+secret_access_key&gt; YOUR_SECRET_KEY
+
+Option region.
+Region where your bucket will be created and your data stored.
+region&gt; us-east
+
+Option endpoint.
+Endpoint for S3 API.
+endpoint&gt; us-east.object.fastlystorage.app
+
+Edit advanced config?
+y) Yes
+n) No (default)
+y/n&gt; n
+
+Configuration complete.
+Options:
+- type: s3
+- provider: Fastly
+- access_key_id: YOUR_ACCESS_KEY
+- secret_access_key: YOUR_SECRET_KEY
+- region: us-east
+- endpoint: us-east.object.fastlystorage.app
+Keep this &quot;fastly&quot; remote?
+y) Yes this is OK (default)
+e) Edit this remote
+d) Delete this remote
+y/e/d&gt; y</code></pre>
+<p>The resulting configuration file should look like:</p>
+<div class="sourceCode" id="cb1040"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1040-1"><a href="#cb1040-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[fastly]</span></span>
+<span id="cb1040-2"><a href="#cb1040-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
+<span id="cb1040-3"><a href="#cb1040-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> Fastly</span></span>
+<span id="cb1040-4"><a href="#cb1040-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> YOUR_ACCESS_KEY</span></span>
+<span id="cb1040-5"><a href="#cb1040-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> YOUR_SECRET_KEY</span></span>
+<span id="cb1040-6"><a href="#cb1040-6" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span><span class="st"> us-east</span></span>
+<span id="cb1040-7"><a href="#cb1040-7" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> us-east.object.fastlystorage.app</span></span></code></pre></div>
<h3 id="google-cloud-storage">Google Cloud Storage</h3>
<p><a
href="https://cloud.google.com/storage/docs">GoogleCloudStorage</a> is
@@ -31912,13 +32838,13 @@ object storage service from Google Cloud Platform.</p>
secret key. These can be retrieved by creating an <a
href="https://cloud.google.com/storage/docs/authentication/managing-hmackeys">HMAC
key</a>.</p>
-<div class="sourceCode" id="cb1023"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1023-1"><a href="#cb1023-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[gs]</span></span>
-<span id="cb1023-2"><a href="#cb1023-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
-<span id="cb1023-3"><a href="#cb1023-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> GCS</span></span>
-<span id="cb1023-4"><a href="#cb1023-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> your_access_key</span></span>
-<span id="cb1023-5"><a href="#cb1023-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> your_secret_key</span></span>
-<span id="cb1023-6"><a href="#cb1023-6" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> https://storage.googleapis.com</span></span></code></pre></div>
+<div class="sourceCode" id="cb1041"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1041-1"><a href="#cb1041-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[gs]</span></span>
+<span id="cb1041-2"><a href="#cb1041-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
+<span id="cb1041-3"><a href="#cb1041-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> GCS</span></span>
+<span id="cb1041-4"><a href="#cb1041-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> your_access_key</span></span>
+<span id="cb1041-5"><a href="#cb1041-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> your_secret_key</span></span>
+<span id="cb1041-6"><a href="#cb1041-6" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> https://storage.googleapis.com</span></span></code></pre></div>
<p><strong>Note</strong> that <code>--s3-versions</code> does not work
with GCS when it needs to do directory paging. Rclone will return the
error:</p>
@@ -31943,7 +32869,7 @@ 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, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, GCS, Hetzner, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, StackPath, Storj, Synology, TencentCOS, Wasabi, Qiniu and others
+ XX / Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, GCS, Hetzner, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Storj, Synology, TencentCOS, Wasabi, Qiniu and others
\ (s3)
[snip]
Storage&gt; s3
@@ -32050,30 +32976,144 @@ s) Set configuration password
q) Quit config
e/n/d/r/c/s/q&gt; </code></pre>
<p>This will leave the config file looking like this.</p>
-<div class="sourceCode" id="cb1027"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1027-1"><a href="#cb1027-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[my-hetzner]</span></span>
-<span id="cb1027-2"><a href="#cb1027-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
-<span id="cb1027-3"><a href="#cb1027-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> Hetzner</span></span>
-<span id="cb1027-4"><a href="#cb1027-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> ACCESS_KEY</span></span>
-<span id="cb1027-5"><a href="#cb1027-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> SECRET_KEY</span></span>
-<span id="cb1027-6"><a href="#cb1027-6" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span><span class="st"> hel1</span></span>
-<span id="cb1027-7"><a href="#cb1027-7" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> hel1.your-objectstorage.com</span></span>
-<span id="cb1027-8"><a href="#cb1027-8" aria-hidden="true" tabindex="-1"></a><span class="dt">acl </span><span class="ot">=</span><span class="st"> private</span></span></code></pre></div>
+<div class="sourceCode" id="cb1045"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1045-1"><a href="#cb1045-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[my-hetzner]</span></span>
+<span id="cb1045-2"><a href="#cb1045-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
+<span id="cb1045-3"><a href="#cb1045-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> Hetzner</span></span>
+<span id="cb1045-4"><a href="#cb1045-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> ACCESS_KEY</span></span>
+<span id="cb1045-5"><a href="#cb1045-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> SECRET_KEY</span></span>
+<span id="cb1045-6"><a href="#cb1045-6" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span><span class="st"> hel1</span></span>
+<span id="cb1045-7"><a href="#cb1045-7" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> hel1.your-objectstorage.com</span></span>
+<span id="cb1045-8"><a href="#cb1045-8" aria-hidden="true" tabindex="-1"></a><span class="dt">acl </span><span class="ot">=</span><span class="st"> private</span></span></code></pre></div>
+<h3 id="hcp">Hitachi Content Platform (HCP)</h3>
+<p>Here is an example of making a <a
+href="https://www.hitachivantara.com/en-us/products/storage/content-platform.html">Hitachi
+Content Platform (HCP)</a> configuration. First run:</p>
+<pre class="console"><code>rclone config</code></pre>
+<p>This will guide you through an interactive setup process.</p>
+<pre class="text"><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; my-hcp
+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, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, GCS, HCP, Hetzner, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Storj, Synology, TencentCOS, Wasabi, Qiniu and others
+ \ (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 / Hitachi Content Platform (HCP)
+ \ (HCP)
+[snip]
+provider&gt; HCP
+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; 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_KEY
+Option endpoint.
+Endpoint for HCP S3 compatible API.
+Enter a value. Press Enter to leave empty.
+endpoint&gt; https://hcp.example.com
+Edit advanced config?
+y) Yes
+n) No (default)
+y/n&gt;
+Configuration complete.
+Options:
+- type: s3
+- provider: HCP
+- access_key_id: ACCESS_KEY
+- secret_access_key: SECRET_KEY
+- endpoint: https://hcp.example.com
+Keep this &quot;my-hcp&quot; remote?
+y) Yes this is OK (default)
+e) Edit this remote
+d) Delete this remote
+y/e/d&gt;
+Current remotes:
+
+Name Type
+==== ====
+my-hcp 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; </code></pre>
+<p>This will leave the config file looking like this.</p>
+<div class="sourceCode" id="cb1048"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1048-1"><a href="#cb1048-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[my-hcp]</span></span>
+<span id="cb1048-2"><a href="#cb1048-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
+<span id="cb1048-3"><a href="#cb1048-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> HCP</span></span>
+<span id="cb1048-4"><a href="#cb1048-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> ACCESS_KEY</span></span>
+<span id="cb1048-5"><a href="#cb1048-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> SECRET_KEY</span></span>
+<span id="cb1048-6"><a href="#cb1048-6" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> https://hcp.example.com</span></span></code></pre></div>
+<h4 id="known-limitations">Known limitations</h4>
+<p>These limitations have been observed with HCP version 9.7.x.</p>
+<p><strong>Automatic directory objects</strong></p>
+<p>HCP automatically creates zero-byte directory objects (keys ending in
+<code>/</code>) for every path component when an object is stored. These
+directory objects are managed by HCP internally: deleting one via the S3
+API does not remove it but instead creates a delete marker with a
+special version ID (<code>-3</code>) that cannot itself be deleted. As a
+result, rclone cannot fully purge a bucket on HCP — leftover directory
+objects will remain after a <code>purge</code> or <code>delete</code>
+operation.</p>
+<p><strong>Transparent gzip decompression</strong></p>
+<p>HCP <a
+href="https://docs.hitachivantara.com/r/en-us/content-platform/9.6.x/mk-95hcph002/using-the-hitachi-api-for-amazon-s3/working-with-objects/creating-an-object">transparently
+decompresses</a> objects uploaded with
+<code>Content-Encoding: gzip</code> before storing them. This means the
+stored object contains the raw (uncompressed) data, while the
+<code>Content-MD5</code> sent by rclone was computed over the compressed
+bytes. HCP will reject such uploads with a <code>BadDigest</code> error.
+To avoid this, do not set <code>content-encoding: gzip</code> in object
+metadata when using HCP.</p>
<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>
-<div class="sourceCode" id="cb1028"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1028-1"><a href="#cb1028-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[obs]</span></span>
-<span id="cb1028-2"><a href="#cb1028-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
-<span id="cb1028-3"><a href="#cb1028-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> HuaweiOBS</span></span>
-<span id="cb1028-4"><a href="#cb1028-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> your-access-key-id</span></span>
-<span id="cb1028-5"><a href="#cb1028-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> your-secret-access-key</span></span>
-<span id="cb1028-6"><a href="#cb1028-6" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span><span class="st"> af-south-1</span></span>
-<span id="cb1028-7"><a href="#cb1028-7" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> obs.af-south-1.myhuaweicloud.com</span></span>
-<span id="cb1028-8"><a href="#cb1028-8" aria-hidden="true" tabindex="-1"></a><span class="dt">acl </span><span class="ot">=</span><span class="st"> private</span></span></code></pre></div>
+<div class="sourceCode" id="cb1049"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1049-1"><a href="#cb1049-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[obs]</span></span>
+<span id="cb1049-2"><a href="#cb1049-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
+<span id="cb1049-3"><a href="#cb1049-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> HuaweiOBS</span></span>
+<span id="cb1049-4"><a href="#cb1049-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> your-access-key-id</span></span>
+<span id="cb1049-5"><a href="#cb1049-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> your-secret-access-key</span></span>
+<span id="cb1049-6"><a href="#cb1049-6" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span><span class="st"> af-south-1</span></span>
+<span id="cb1049-7"><a href="#cb1049-7" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> obs.af-south-1.myhuaweicloud.com</span></span>
+<span id="cb1049-8"><a href="#cb1049-8" aria-hidden="true" tabindex="-1"></a><span class="dt">acl </span><span class="ot">=</span><span class="st"> private</span></span></code></pre></div>
<p>Or you can also configure via the interactive command line:</p>
<pre class="text"><code>No remotes found, make a new one\?
n) New remote
@@ -32302,15 +33342,15 @@ Choose a number from below, or type in your own value
acl&gt; 1</code></pre></li>
<li><p>Review the displayed configuration and accept to save the
"remote" then quit. The config file should look like this</p>
-<div class="sourceCode" id="cb1038"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1038-1"><a href="#cb1038-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[xxx]</span></span>
-<span id="cb1038-2"><a href="#cb1038-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
-<span id="cb1038-3"><a href="#cb1038-3" aria-hidden="true" tabindex="-1"></a><span class="dt">Provider </span><span class="ot">=</span><span class="st"> IBMCOS</span></span>
-<span id="cb1038-4"><a href="#cb1038-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> xxx</span></span>
-<span id="cb1038-5"><a href="#cb1038-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> yyy</span></span>
-<span id="cb1038-6"><a href="#cb1038-6" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> s3-api.us-geo.objectstorage.softlayer.net</span></span>
-<span id="cb1038-7"><a href="#cb1038-7" aria-hidden="true" tabindex="-1"></a><span class="dt">location_constraint </span><span class="ot">=</span><span class="st"> us-standard</span></span>
-<span id="cb1038-8"><a href="#cb1038-8" aria-hidden="true" tabindex="-1"></a><span class="dt">acl </span><span class="ot">=</span><span class="st"> private</span></span></code></pre></div></li>
+<div class="sourceCode" id="cb1059"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1059-1"><a href="#cb1059-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[xxx]</span></span>
+<span id="cb1059-2"><a href="#cb1059-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
+<span id="cb1059-3"><a href="#cb1059-3" aria-hidden="true" tabindex="-1"></a><span class="dt">Provider </span><span class="ot">=</span><span class="st"> IBMCOS</span></span>
+<span id="cb1059-4"><a href="#cb1059-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> xxx</span></span>
+<span id="cb1059-5"><a href="#cb1059-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> yyy</span></span>
+<span id="cb1059-6"><a href="#cb1059-6" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> s3-api.us-geo.objectstorage.softlayer.net</span></span>
+<span id="cb1059-7"><a href="#cb1059-7" aria-hidden="true" tabindex="-1"></a><span class="dt">location_constraint </span><span class="ot">=</span><span class="st"> us-standard</span></span>
+<span id="cb1059-8"><a href="#cb1059-8" aria-hidden="true" tabindex="-1"></a><span class="dt">acl </span><span class="ot">=</span><span class="st"> private</span></span></code></pre></div></li>
<li><p>Execute rclone commands</p></li>
</ol>
<pre class="text"><code>1) Create a bucket.
@@ -32458,6 +33498,168 @@ y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
+<h3 id="impossible-cloud">Impossible Cloud</h3>
+<p><a href="https://www.impossiblecloud.com/">Impossible Cloud</a> is a
+European S3-compatible object storage provider with regions in Europe
+and the US.</p>
+<p>Note: Impossible Cloud does not preserve the
+<code>Cache-Control</code>, <code>Content-Disposition</code>,
+<code>Content-Encoding</code> or <code>Content-Language</code> system
+metadata fields on retrieval, even when they were set at upload time.
+Because the <code>Content-Encoding</code> response header is also
+dropped, the <code>--s3-decompress</code> flag has no effect on objects
+stored there. Other metadata such as <code>Content-Type</code> and the
+modification time round-trip normally.</p>
+<p>Here is an example of making an Impossible Cloud configuration. First
+run:</p>
+<pre class="console"><code>rclone config</code></pre>
+<p>This will guide you through an interactive setup process.</p>
+<pre class="text"><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; my-impossible-cloud
+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, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, GCS, Hetzner, HuaweiOBS, IBMCOS, IDrive, ImpossibleCloud, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Storj, Synology, TencentCOS, Wasabi, Qiniu and others
+ \ (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 / Impossible Cloud Object Storage
+ \ (ImpossibleCloud)
+[snip]
+provider&gt; ImpossibleCloud
+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; 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_KEY
+Option region.
+Region to connect to.
+Choose a number from below, or type in your own value.
+Press Enter to leave empty.
+ 1 / Frankfurt, Germany
+ \ (eu-central-2)
+ 2 / Amsterdam, Netherlands
+ \ (eu-west-1)
+ 3 / London, UK
+ \ (eu-west-2)
+ 4 / Paris, France
+ \ (eu-west-3)
+ 5 / Poznań, Poland
+ \ (eu-east-1)
+ 6 / Copenhagen, Denmark
+ \ (eu-north-1)
+ 7 / New York, USA
+ \ (us-east-1)
+region&gt; 1
+Option endpoint.
+Endpoint for Impossible Cloud Object Storage
+Choose a number from below, or type in your own value.
+Press Enter to leave empty.
+ 1 / Frankfurt, Germany
+ \ (eu-central-2.storage.impossibleapi.net)
+ 2 / Amsterdam, Netherlands
+ \ (eu-west-1.storage.impossibleapi.net)
+ 3 / London, UK
+ \ (eu-west-2.storage.impossibleapi.net)
+ 4 / Paris, France
+ \ (eu-west-3.storage.impossibleapi.net)
+ 5 / Poznań, Poland
+ \ (eu-east-1.storage.impossibleapi.net)
+ 6 / Copenhagen, Denmark
+ \ (eu-north-1.storage.impossibleapi.net)
+ 7 / New York, USA
+ \ (us-east-1.storage.impossibleapi.net)
+endpoint&gt; 1
+Option location_constraint.
+Location constraint - must be set to match the Region.
+Leave blank if not sure. Used when creating buckets only.
+Enter a value. Press Enter to leave empty.
+location_constraint&gt;
+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.
+If the acl is an empty string then no X-Amz-Acl: header is added and
+the default (private) will be used.
+Choose a number from below, or type in your own value.
+Press Enter to leave empty.
+ / Owner gets FULL_CONTROL.
+ 1 | No one else has access rights (default).
+ \ (private)
+ / Owner gets FULL_CONTROL.
+ 2 | The AllUsers group gets READ access.
+ \ (public-read)
+acl&gt;
+Edit advanced config?
+y) Yes
+n) No (default)
+y/n&gt;
+Configuration complete.
+Options:
+- type: s3
+- provider: ImpossibleCloud
+- access_key_id: ACCESS_KEY
+- secret_access_key: SECRET_KEY
+- region: eu-central-2
+- endpoint: eu-central-2.storage.impossibleapi.net
+Keep this &quot;my-impossible-cloud&quot; remote?
+y) Yes this is OK (default)
+e) Edit this remote
+d) Delete this remote
+y/e/d&gt;
+Current remotes:
+
+Name Type
+==== ====
+my-impossible-cloud 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; </code></pre>
+<p>This will leave the config file looking like this.</p>
+<div class="sourceCode" id="cb1068"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1068-1"><a href="#cb1068-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[my-impossible-cloud]</span></span>
+<span id="cb1068-2"><a href="#cb1068-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
+<span id="cb1068-3"><a href="#cb1068-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> ImpossibleCloud</span></span>
+<span id="cb1068-4"><a href="#cb1068-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> ACCESS_KEY</span></span>
+<span id="cb1068-5"><a href="#cb1068-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> SECRET_KEY</span></span>
+<span id="cb1068-6"><a href="#cb1068-6" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span><span class="st"> eu-central-2</span></span>
+<span id="cb1068-7"><a href="#cb1068-7" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> eu-central-2.storage.impossibleapi.net</span></span>
+<span id="cb1068-8"><a href="#cb1068-8" aria-hidden="true" tabindex="-1"></a><span class="dt">acl </span><span class="ot">=</span><span class="st"> private</span></span></code></pre></div>
<h3 id="intercolo">Intercolo Object Storage</h3>
<p><a href="https://intercolo.de/object-storage">Intercolo Object
Storage</a> offers GDPR-compliant, transparently priced, S3-compatible
@@ -32568,14 +33770,14 @@ 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>
-<div class="sourceCode" id="cb1047"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1047-1"><a href="#cb1047-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[intercolo]</span></span>
-<span id="cb1047-2"><a href="#cb1047-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
-<span id="cb1047-3"><a href="#cb1047-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> Intercolo</span></span>
-<span id="cb1047-4"><a href="#cb1047-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> ACCESS_KEY</span></span>
-<span id="cb1047-5"><a href="#cb1047-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> SECRET_KEY</span></span>
-<span id="cb1047-6"><a href="#cb1047-6" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span><span class="st"> de-fra</span></span>
-<span id="cb1047-7"><a href="#cb1047-7" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> de-fra.i3storage.com</span></span></code></pre></div>
+<div class="sourceCode" id="cb1071"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1071-1"><a href="#cb1071-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[intercolo]</span></span>
+<span id="cb1071-2"><a href="#cb1071-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
+<span id="cb1071-3"><a href="#cb1071-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> Intercolo</span></span>
+<span id="cb1071-4"><a href="#cb1071-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> ACCESS_KEY</span></span>
+<span id="cb1071-5"><a href="#cb1071-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> SECRET_KEY</span></span>
+<span id="cb1071-6"><a href="#cb1071-6" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span><span class="st"> de-fra</span></span>
+<span id="cb1071-7"><a href="#cb1071-7" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> de-fra.i3storage.com</span></span></code></pre></div>
<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
@@ -32883,19 +34085,19 @@ 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>
-<div class="sourceCode" id="cb1072"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1072-1"><a href="#cb1072-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[Liara]</span></span>
-<span id="cb1072-2"><a href="#cb1072-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
-<span id="cb1072-3"><a href="#cb1072-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> Liara</span></span>
-<span id="cb1072-4"><a href="#cb1072-4" aria-hidden="true" tabindex="-1"></a><span class="dt">env_auth </span><span class="ot">=</span><span class="st"> </span><span class="kw">false</span></span>
-<span id="cb1072-5"><a href="#cb1072-5" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> YOURACCESSKEY</span></span>
-<span id="cb1072-6"><a href="#cb1072-6" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> YOURSECRETACCESSKEY</span></span>
-<span id="cb1072-7"><a href="#cb1072-7" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span></span>
-<span id="cb1072-8"><a href="#cb1072-8" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> storage.iran.liara.space</span></span>
-<span id="cb1072-9"><a href="#cb1072-9" aria-hidden="true" tabindex="-1"></a><span class="dt">location_constraint </span><span class="ot">=</span></span>
-<span id="cb1072-10"><a href="#cb1072-10" aria-hidden="true" tabindex="-1"></a><span class="dt">acl </span><span class="ot">=</span></span>
-<span id="cb1072-11"><a href="#cb1072-11" aria-hidden="true" tabindex="-1"></a><span class="dt">server_side_encryption </span><span class="ot">=</span></span>
-<span id="cb1072-12"><a href="#cb1072-12" aria-hidden="true" tabindex="-1"></a><span class="dt">storage_class </span><span class="ot">=</span></span></code></pre></div>
+<div class="sourceCode" id="cb1096"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1096-1"><a href="#cb1096-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[Liara]</span></span>
+<span id="cb1096-2"><a href="#cb1096-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
+<span id="cb1096-3"><a href="#cb1096-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> Liara</span></span>
+<span id="cb1096-4"><a href="#cb1096-4" aria-hidden="true" tabindex="-1"></a><span class="dt">env_auth </span><span class="ot">=</span><span class="st"> </span><span class="kw">false</span></span>
+<span id="cb1096-5"><a href="#cb1096-5" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> YOURACCESSKEY</span></span>
+<span id="cb1096-6"><a href="#cb1096-6" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> YOURSECRETACCESSKEY</span></span>
+<span id="cb1096-7"><a href="#cb1096-7" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span></span>
+<span id="cb1096-8"><a href="#cb1096-8" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> storage.iran.liara.space</span></span>
+<span id="cb1096-9"><a href="#cb1096-9" aria-hidden="true" tabindex="-1"></a><span class="dt">location_constraint </span><span class="ot">=</span></span>
+<span id="cb1096-10"><a href="#cb1096-10" aria-hidden="true" tabindex="-1"></a><span class="dt">acl </span><span class="ot">=</span></span>
+<span id="cb1096-11"><a href="#cb1096-11" aria-hidden="true" tabindex="-1"></a><span class="dt">server_side_encryption </span><span class="ot">=</span></span>
+<span id="cb1096-12"><a href="#cb1096-12" aria-hidden="true" tabindex="-1"></a><span class="dt">storage_class </span><span class="ot">=</span></span></code></pre></div>
<h3 id="linode">Linode</h3>
<p>Here is an example of making a <a
href="https://www.linode.com/products/object-storage/">Linode Object
@@ -33035,13 +34237,13 @@ 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>
-<div class="sourceCode" id="cb1075"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1075-1"><a href="#cb1075-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[linode]</span></span>
-<span id="cb1075-2"><a href="#cb1075-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
-<span id="cb1075-3"><a href="#cb1075-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> Linode</span></span>
-<span id="cb1075-4"><a href="#cb1075-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> ACCESS_KEY</span></span>
-<span id="cb1075-5"><a href="#cb1075-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> SECRET_ACCESS_KEY</span></span>
-<span id="cb1075-6"><a href="#cb1075-6" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> eu-central-1.linodeobjects.com</span></span></code></pre></div>
+<div class="sourceCode" id="cb1099"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1099-1"><a href="#cb1099-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[linode]</span></span>
+<span id="cb1099-2"><a href="#cb1099-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
+<span id="cb1099-3"><a href="#cb1099-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> Linode</span></span>
+<span id="cb1099-4"><a href="#cb1099-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> ACCESS_KEY</span></span>
+<span id="cb1099-5"><a href="#cb1099-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> SECRET_ACCESS_KEY</span></span>
+<span id="cb1099-6"><a href="#cb1099-6" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> eu-central-1.linodeobjects.com</span></span></code></pre></div>
<h3 id="magalu">Magalu</h3>
<p>Here is an example of making a <a
href="https://magalu.cloud/object-storage/">Magalu Object Storage</a>
@@ -33143,13 +34345,13 @@ 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>
-<div class="sourceCode" id="cb1078"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1078-1"><a href="#cb1078-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[magalu]</span></span>
-<span id="cb1078-2"><a href="#cb1078-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
-<span id="cb1078-3"><a href="#cb1078-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> Magalu</span></span>
-<span id="cb1078-4"><a href="#cb1078-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> ACCESS_KEY</span></span>
-<span id="cb1078-5"><a href="#cb1078-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> SECRET_ACCESS_KEY</span></span>
-<span id="cb1078-6"><a href="#cb1078-6" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> br-ne1.magaluobjects.com</span></span></code></pre></div>
+<div class="sourceCode" id="cb1102"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1102-1"><a href="#cb1102-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[magalu]</span></span>
+<span id="cb1102-2"><a href="#cb1102-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
+<span id="cb1102-3"><a href="#cb1102-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> Magalu</span></span>
+<span id="cb1102-4"><a href="#cb1102-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> ACCESS_KEY</span></span>
+<span id="cb1102-5"><a href="#cb1102-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> SECRET_ACCESS_KEY</span></span>
+<span id="cb1102-6"><a href="#cb1102-6" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> br-ne1.magaluobjects.com</span></span></code></pre></div>
<h3 id="mega">MEGA S4</h3>
<p><a href="https://mega.io/objectstorage">MEGA S4 Object Storage</a> is
an S3 compatible object storage system. It has a single pricing tier
@@ -33242,13 +34444,13 @@ 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>
-<div class="sourceCode" id="cb1081"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1081-1"><a href="#cb1081-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[megas4]</span></span>
-<span id="cb1081-2"><a href="#cb1081-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
-<span id="cb1081-3"><a href="#cb1081-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> Mega</span></span>
-<span id="cb1081-4"><a href="#cb1081-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> XXX</span></span>
-<span id="cb1081-5"><a href="#cb1081-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> XXX</span></span>
-<span id="cb1081-6"><a href="#cb1081-6" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> s3.eu-central-1.s4.mega.io</span></span></code></pre></div>
+<div class="sourceCode" id="cb1105"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1105-1"><a href="#cb1105-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[megas4]</span></span>
+<span id="cb1105-2"><a href="#cb1105-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
+<span id="cb1105-3"><a href="#cb1105-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> Mega</span></span>
+<span id="cb1105-4"><a href="#cb1105-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> XXX</span></span>
+<span id="cb1105-5"><a href="#cb1105-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> XXX</span></span>
+<span id="cb1105-6"><a href="#cb1105-6" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> s3.eu-central-1.s4.mega.io</span></span></code></pre></div>
<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>
@@ -33287,17 +34489,17 @@ 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>
-<div class="sourceCode" id="cb1084"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1084-1"><a href="#cb1084-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[minio]</span></span>
-<span id="cb1084-2"><a href="#cb1084-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
-<span id="cb1084-3"><a href="#cb1084-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> Minio</span></span>
-<span id="cb1084-4"><a href="#cb1084-4" aria-hidden="true" tabindex="-1"></a><span class="dt">env_auth </span><span class="ot">=</span><span class="st"> </span><span class="kw">false</span></span>
-<span id="cb1084-5"><a href="#cb1084-5" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> USWUXHGYZQYFYFFIT3RE</span></span>
-<span id="cb1084-6"><a href="#cb1084-6" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03</span></span>
-<span id="cb1084-7"><a href="#cb1084-7" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span><span class="st"> us-east-1</span></span>
-<span id="cb1084-8"><a href="#cb1084-8" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> http://192.168.1.106:9000</span></span>
-<span id="cb1084-9"><a href="#cb1084-9" aria-hidden="true" tabindex="-1"></a><span class="dt">location_constraint </span><span class="ot">=</span></span>
-<span id="cb1084-10"><a href="#cb1084-10" aria-hidden="true" tabindex="-1"></a><span class="dt">server_side_encryption </span><span class="ot">=</span></span></code></pre></div>
+<div class="sourceCode" id="cb1108"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1108-1"><a href="#cb1108-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[minio]</span></span>
+<span id="cb1108-2"><a href="#cb1108-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
+<span id="cb1108-3"><a href="#cb1108-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> Minio</span></span>
+<span id="cb1108-4"><a href="#cb1108-4" aria-hidden="true" tabindex="-1"></a><span class="dt">env_auth </span><span class="ot">=</span><span class="st"> </span><span class="kw">false</span></span>
+<span id="cb1108-5"><a href="#cb1108-5" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> USWUXHGYZQYFYFFIT3RE</span></span>
+<span id="cb1108-6"><a href="#cb1108-6" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03</span></span>
+<span id="cb1108-7"><a href="#cb1108-7" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span><span class="st"> us-east-1</span></span>
+<span id="cb1108-8"><a href="#cb1108-8" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> http://192.168.1.106:9000</span></span>
+<span id="cb1108-9"><a href="#cb1108-9" aria-hidden="true" tabindex="-1"></a><span class="dt">location_constraint </span><span class="ot">=</span></span>
+<span id="cb1108-10"><a href="#cb1108-10" aria-hidden="true" tabindex="-1"></a><span class="dt">server_side_encryption </span><span class="ot">=</span></span></code></pre></div>
<p>So once set up, for example, to copy files into a bucket</p>
<pre class="console"><code>rclone copy /path/to/files minio:bucket</code></pre>
<h3 id="netease-nos">Netease NOS</h3>
@@ -33315,16 +34517,16 @@ href="https://docs.outscale.com/en/userguide/OUTSCALE-Object-Storage-OOS.html">o
documentation</a>.</p>
<p>Here is an example of an OOS configuration that you can paste into
your rclone configuration file:</p>
-<div class="sourceCode" id="cb1086"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1086-1"><a href="#cb1086-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[outscale]</span></span>
-<span id="cb1086-2"><a href="#cb1086-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
-<span id="cb1086-3"><a href="#cb1086-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> Outscale</span></span>
-<span id="cb1086-4"><a href="#cb1086-4" aria-hidden="true" tabindex="-1"></a><span class="dt">env_auth </span><span class="ot">=</span><span class="st"> </span><span class="kw">false</span></span>
-<span id="cb1086-5"><a href="#cb1086-5" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> ABCDEFGHIJ0123456789</span></span>
-<span id="cb1086-6"><a href="#cb1086-6" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</span></span>
-<span id="cb1086-7"><a href="#cb1086-7" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span><span class="st"> eu-west-2</span></span>
-<span id="cb1086-8"><a href="#cb1086-8" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> oos.eu-west-2.outscale.com</span></span>
-<span id="cb1086-9"><a href="#cb1086-9" aria-hidden="true" tabindex="-1"></a><span class="dt">acl </span><span class="ot">=</span><span class="st"> private</span></span></code></pre></div>
+<div class="sourceCode" id="cb1110"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1110-1"><a href="#cb1110-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[outscale]</span></span>
+<span id="cb1110-2"><a href="#cb1110-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
+<span id="cb1110-3"><a href="#cb1110-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> Outscale</span></span>
+<span id="cb1110-4"><a href="#cb1110-4" aria-hidden="true" tabindex="-1"></a><span class="dt">env_auth </span><span class="ot">=</span><span class="st"> </span><span class="kw">false</span></span>
+<span id="cb1110-5"><a href="#cb1110-5" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> ABCDEFGHIJ0123456789</span></span>
+<span id="cb1110-6"><a href="#cb1110-6" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</span></span>
+<span id="cb1110-7"><a href="#cb1110-7" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span><span class="st"> eu-west-2</span></span>
+<span id="cb1110-8"><a href="#cb1110-8" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> oos.eu-west-2.outscale.com</span></span>
+<span id="cb1110-9"><a href="#cb1110-9" aria-hidden="true" tabindex="-1"></a><span class="dt">acl </span><span class="ot">=</span><span class="st"> private</span></span></code></pre></div>
<p>You can also run <code>rclone config</code> to go through the
interactive setup process:</p>
<pre class="text"><code>No remotes found, make a new one\?
@@ -33456,7 +34658,7 @@ 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, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, GCS, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, OVHcloud, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, StackPath, Storj, Synology, TencentCOS, Wasabi, Qiniu and others
+ XX / Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, GCS, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, OVHcloud, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Storj, Synology, TencentCOS, Wasabi, Qiniu and others
\ (s3)
[...]
Storage&gt; s3
@@ -33618,15 +34820,15 @@ e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<p>Your configuration file should now look like this:</p>
-<div class="sourceCode" id="cb1100"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1100-1"><a href="#cb1100-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[ovhcloud-rbx]</span></span>
-<span id="cb1100-2"><a href="#cb1100-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
-<span id="cb1100-3"><a href="#cb1100-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> OVHcloud</span></span>
-<span id="cb1100-4"><a href="#cb1100-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> my_access</span></span>
-<span id="cb1100-5"><a href="#cb1100-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> my_secret</span></span>
-<span id="cb1100-6"><a href="#cb1100-6" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span><span class="st"> rbx</span></span>
-<span id="cb1100-7"><a href="#cb1100-7" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> s3.rbx.io.cloud.ovh.net</span></span>
-<span id="cb1100-8"><a href="#cb1100-8" aria-hidden="true" tabindex="-1"></a><span class="dt">acl </span><span class="ot">=</span><span class="st"> private</span></span></code></pre></div>
+<div class="sourceCode" id="cb1124"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1124-1"><a href="#cb1124-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[ovhcloud-rbx]</span></span>
+<span id="cb1124-2"><a href="#cb1124-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
+<span id="cb1124-3"><a href="#cb1124-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> OVHcloud</span></span>
+<span id="cb1124-4"><a href="#cb1124-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> my_access</span></span>
+<span id="cb1124-5"><a href="#cb1124-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> my_secret</span></span>
+<span id="cb1124-6"><a href="#cb1124-6" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span><span class="st"> rbx</span></span>
+<span id="cb1124-7"><a href="#cb1124-7" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> s3.rbx.io.cloud.ovh.net</span></span>
+<span id="cb1124-8"><a href="#cb1124-8" aria-hidden="true" tabindex="-1"></a><span class="dt">acl </span><span class="ot">=</span><span class="st"> private</span></span></code></pre></div>
<h3 id="petabox">Petabox</h3>
<p>Here is an example of making a <a
href="https://petabox.io/">Petabox</a> configuration. First run:</p>
@@ -33767,14 +34969,14 @@ 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>
-<div class="sourceCode" id="cb1103"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1103-1"><a href="#cb1103-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[My Petabox Storage]</span></span>
-<span id="cb1103-2"><a href="#cb1103-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
-<span id="cb1103-3"><a href="#cb1103-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> Petabox</span></span>
-<span id="cb1103-4"><a href="#cb1103-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> YOUR_ACCESS_KEY_ID</span></span>
-<span id="cb1103-5"><a href="#cb1103-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> YOUR_SECRET_ACCESS_KEY</span></span>
-<span id="cb1103-6"><a href="#cb1103-6" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span><span class="st"> us-east-1</span></span>
-<span id="cb1103-7"><a href="#cb1103-7" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> s3.petabox.io</span></span></code></pre></div>
+<div class="sourceCode" id="cb1127"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1127-1"><a href="#cb1127-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[My Petabox Storage]</span></span>
+<span id="cb1127-2"><a href="#cb1127-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
+<span id="cb1127-3"><a href="#cb1127-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> Petabox</span></span>
+<span id="cb1127-4"><a href="#cb1127-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> YOUR_ACCESS_KEY_ID</span></span>
+<span id="cb1127-5"><a href="#cb1127-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> YOUR_SECRET_ACCESS_KEY</span></span>
+<span id="cb1127-6"><a href="#cb1127-6" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span><span class="st"> us-east-1</span></span>
+<span id="cb1127-7"><a href="#cb1127-7" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> s3.petabox.io</span></span></code></pre></div>
<h3 id="pure-storage-flashblade">Pure Storage FlashBlade</h3>
<p><a
href="https://www.purestorage.com/products/unstructured-data-storage.html">Pure
@@ -33806,7 +35008,7 @@ Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
[snip]
- 4 / Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, FlashBlade, GCS, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, StackPath, Storj, Synology, TencentCOS, Wasabi, Qiniu and others
+ 4 / Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, FlashBlade, GCS, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Storj, Synology, TencentCOS, Wasabi, Qiniu and others
\ (s3)
[snip]
Storage&gt; s3
@@ -33869,13 +35071,13 @@ d) Delete this remote
y/e/d&gt; y</code></pre>
<p>This results in the following configuration being stored in
<code>~/.config/rclone/rclone.conf</code>:</p>
-<div class="sourceCode" id="cb1106"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1106-1"><a href="#cb1106-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[flashblade]</span></span>
-<span id="cb1106-2"><a href="#cb1106-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
-<span id="cb1106-3"><a href="#cb1106-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> FlashBlade</span></span>
-<span id="cb1106-4"><a href="#cb1106-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> ACCESS_KEY_ID</span></span>
-<span id="cb1106-5"><a href="#cb1106-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> SECRET_ACCESS_KEY</span></span>
-<span id="cb1106-6"><a href="#cb1106-6" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> https://s3.flashblade.example.com</span></span></code></pre></div>
+<div class="sourceCode" id="cb1130"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1130-1"><a href="#cb1130-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[flashblade]</span></span>
+<span id="cb1130-2"><a href="#cb1130-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
+<span id="cb1130-3"><a href="#cb1130-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> FlashBlade</span></span>
+<span id="cb1130-4"><a href="#cb1130-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> ACCESS_KEY_ID</span></span>
+<span id="cb1130-5"><a href="#cb1130-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> SECRET_ACCESS_KEY</span></span>
+<span id="cb1130-6"><a href="#cb1130-6" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> https://s3.flashblade.example.com</span></span></code></pre></div>
<p>Note: The FlashBlade endpoint should be the S3 data VIP. For
virtual-hosted style requests, ensure proper DNS configuration:
subdomains of the endpoint hostname should resolve to a FlashBlade data
@@ -34152,13 +35354,13 @@ 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>
-<div class="sourceCode" id="cb1116"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1116-1"><a href="#cb1116-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[s5lu]</span></span>
-<span id="cb1116-2"><a href="#cb1116-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
-<span id="cb1116-3"><a href="#cb1116-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> FileLu</span></span>
-<span id="cb1116-4"><a href="#cb1116-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> XXX</span></span>
-<span id="cb1116-5"><a href="#cb1116-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> XXX</span></span>
-<span id="cb1116-6"><a href="#cb1116-6" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> s5lu.com</span></span></code></pre></div>
+<div class="sourceCode" id="cb1140"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1140-1"><a href="#cb1140-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[s5lu]</span></span>
+<span id="cb1140-2"><a href="#cb1140-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
+<span id="cb1140-3"><a href="#cb1140-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> FileLu</span></span>
+<span id="cb1140-4"><a href="#cb1140-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> XXX</span></span>
+<span id="cb1140-5"><a href="#cb1140-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> XXX</span></span>
+<span id="cb1140-6"><a href="#cb1140-6" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> s5lu.com</span></span></code></pre></div>
<h3 id="Rabata">Rabata</h3>
<p><a href="https://rabata.io">Rabata</a> is an S3-compatible secure
cloud storage service that offers flat, transparent pricing (no API
@@ -34295,16 +35497,16 @@ 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>
-<div class="sourceCode" id="cb1118"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1118-1"><a href="#cb1118-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[RCS3-demo-config]</span></span>
-<span id="cb1118-2"><a href="#cb1118-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
-<span id="cb1118-3"><a href="#cb1118-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> RackCorp</span></span>
-<span id="cb1118-4"><a href="#cb1118-4" aria-hidden="true" tabindex="-1"></a><span class="dt">env_auth </span><span class="ot">=</span><span class="st"> </span><span class="kw">true</span></span>
-<span id="cb1118-5"><a href="#cb1118-5" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> YOURACCESSKEY</span></span>
-<span id="cb1118-6"><a href="#cb1118-6" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> YOURSECRETACCESSKEY</span></span>
-<span id="cb1118-7"><a href="#cb1118-7" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span><span class="st"> au-nsw</span></span>
-<span id="cb1118-8"><a href="#cb1118-8" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> s3.rackcorp.com</span></span>
-<span id="cb1118-9"><a href="#cb1118-9" aria-hidden="true" tabindex="-1"></a><span class="dt">location_constraint </span><span class="ot">=</span><span class="st"> au-nsw</span></span></code></pre></div>
+<div class="sourceCode" id="cb1142"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1142-1"><a href="#cb1142-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[RCS3-demo-config]</span></span>
+<span id="cb1142-2"><a href="#cb1142-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
+<span id="cb1142-3"><a href="#cb1142-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> RackCorp</span></span>
+<span id="cb1142-4"><a href="#cb1142-4" aria-hidden="true" tabindex="-1"></a><span class="dt">env_auth </span><span class="ot">=</span><span class="st"> </span><span class="kw">true</span></span>
+<span id="cb1142-5"><a href="#cb1142-5" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> YOURACCESSKEY</span></span>
+<span id="cb1142-6"><a href="#cb1142-6" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> YOURSECRETACCESSKEY</span></span>
+<span id="cb1142-7"><a href="#cb1142-7" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span><span class="st"> au-nsw</span></span>
+<span id="cb1142-8"><a href="#cb1142-8" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> s3.rackcorp.com</span></span>
+<span id="cb1142-9"><a href="#cb1142-9" aria-hidden="true" tabindex="-1"></a><span class="dt">location_constraint </span><span class="ot">=</span><span class="st"> au-nsw</span></span></code></pre></div>
<h3 id="rclone">Rclone Serve S3</h3>
<p>Rclone can serve any remote over the S3 protocol. For details see the
<a href="https://rclone.org/commands/rclone_serve_s3/">rclone serve
@@ -34314,14 +35516,14 @@ server like this:</p>
<pre class="console"><code>rclone serve s3 --auth-key ACCESS_KEY_ID,SECRET_ACCESS_KEY remote:path</code></pre>
<p>This will be compatible with an rclone remote which is defined like
this:</p>
-<div class="sourceCode" id="cb1120"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1120-1"><a href="#cb1120-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[serves3]</span></span>
-<span id="cb1120-2"><a href="#cb1120-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
-<span id="cb1120-3"><a href="#cb1120-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> Rclone</span></span>
-<span id="cb1120-4"><a href="#cb1120-4" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> http://127.0.0.1:8080/</span></span>
-<span id="cb1120-5"><a href="#cb1120-5" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> ACCESS_KEY_ID</span></span>
-<span id="cb1120-6"><a href="#cb1120-6" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> SECRET_ACCESS_KEY</span></span>
-<span id="cb1120-7"><a href="#cb1120-7" aria-hidden="true" tabindex="-1"></a><span class="dt">use_multipart_uploads </span><span class="ot">=</span><span class="st"> </span><span class="kw">false</span></span></code></pre></div>
+<div class="sourceCode" id="cb1144"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1144-1"><a href="#cb1144-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[serves3]</span></span>
+<span id="cb1144-2"><a href="#cb1144-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
+<span id="cb1144-3"><a href="#cb1144-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> Rclone</span></span>
+<span id="cb1144-4"><a href="#cb1144-4" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> http://127.0.0.1:8080/</span></span>
+<span id="cb1144-5"><a href="#cb1144-5" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> ACCESS_KEY_ID</span></span>
+<span id="cb1144-6"><a href="#cb1144-6" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> SECRET_ACCESS_KEY</span></span>
+<span id="cb1144-7"><a href="#cb1144-7" aria-hidden="true" tabindex="-1"></a><span class="dt">use_multipart_uploads </span><span class="ot">=</span><span class="st"> </span><span class="kw">false</span></span></code></pre></div>
<p>Note that setting <code>use_multipart_uploads = false</code> is to
work around <a
href="https://rclone.org/commands/rclone_serve_s3/#bugs">a bug</a> which
@@ -34334,20 +35536,20 @@ 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>
-<div class="sourceCode" id="cb1121"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1121-1"><a href="#cb1121-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[scaleway]</span></span>
-<span id="cb1121-2"><a href="#cb1121-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
-<span id="cb1121-3"><a href="#cb1121-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> Scaleway</span></span>
-<span id="cb1121-4"><a href="#cb1121-4" aria-hidden="true" tabindex="-1"></a><span class="dt">env_auth </span><span class="ot">=</span><span class="st"> </span><span class="kw">false</span></span>
-<span id="cb1121-5"><a href="#cb1121-5" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> s3.nl-ams.scw.cloud</span></span>
-<span id="cb1121-6"><a href="#cb1121-6" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> SCWXXXXXXXXXXXXXX</span></span>
-<span id="cb1121-7"><a href="#cb1121-7" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> 1111111-2222-3333-44444-55555555555555</span></span>
-<span id="cb1121-8"><a href="#cb1121-8" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span><span class="st"> nl-ams</span></span>
-<span id="cb1121-9"><a href="#cb1121-9" aria-hidden="true" tabindex="-1"></a><span class="dt">location_constraint </span><span class="ot">=</span><span class="st"> nl-ams</span></span>
-<span id="cb1121-10"><a href="#cb1121-10" aria-hidden="true" tabindex="-1"></a><span class="dt">acl </span><span class="ot">=</span><span class="st"> private</span></span>
-<span id="cb1121-11"><a href="#cb1121-11" aria-hidden="true" tabindex="-1"></a><span class="dt">upload_cutoff </span><span class="ot">=</span><span class="st"> 5M</span></span>
-<span id="cb1121-12"><a href="#cb1121-12" aria-hidden="true" tabindex="-1"></a><span class="dt">chunk_size </span><span class="ot">=</span><span class="st"> 5M</span></span>
-<span id="cb1121-13"><a href="#cb1121-13" aria-hidden="true" tabindex="-1"></a><span class="dt">copy_cutoff </span><span class="ot">=</span><span class="st"> 5M</span></span></code></pre></div>
+<div class="sourceCode" id="cb1145"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1145-1"><a href="#cb1145-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[scaleway]</span></span>
+<span id="cb1145-2"><a href="#cb1145-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
+<span id="cb1145-3"><a href="#cb1145-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> Scaleway</span></span>
+<span id="cb1145-4"><a href="#cb1145-4" aria-hidden="true" tabindex="-1"></a><span class="dt">env_auth </span><span class="ot">=</span><span class="st"> </span><span class="kw">false</span></span>
+<span id="cb1145-5"><a href="#cb1145-5" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> s3.nl-ams.scw.cloud</span></span>
+<span id="cb1145-6"><a href="#cb1145-6" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> SCWXXXXXXXXXXXXXX</span></span>
+<span id="cb1145-7"><a href="#cb1145-7" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> 1111111-2222-3333-44444-55555555555555</span></span>
+<span id="cb1145-8"><a href="#cb1145-8" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span><span class="st"> nl-ams</span></span>
+<span id="cb1145-9"><a href="#cb1145-9" aria-hidden="true" tabindex="-1"></a><span class="dt">location_constraint </span><span class="ot">=</span><span class="st"> nl-ams</span></span>
+<span id="cb1145-10"><a href="#cb1145-10" aria-hidden="true" tabindex="-1"></a><span class="dt">acl </span><span class="ot">=</span><span class="st"> private</span></span>
+<span id="cb1145-11"><a href="#cb1145-11" aria-hidden="true" tabindex="-1"></a><span class="dt">upload_cutoff </span><span class="ot">=</span><span class="st"> 5M</span></span>
+<span id="cb1145-12"><a href="#cb1145-12" aria-hidden="true" tabindex="-1"></a><span class="dt">chunk_size </span><span class="ot">=</span><span class="st"> 5M</span></span>
+<span id="cb1145-13"><a href="#cb1145-13" aria-hidden="true" tabindex="-1"></a><span class="dt">copy_cutoff </span><span class="ot">=</span><span class="st"> 5M</span></span></code></pre></div>
<p><a href="https://www.scaleway.com/en/glacier-cold-storage/">Scaleway
Glacier</a> is the low-cost S3 Glacier alternative from Scaleway and it
works the same way as on S3 by accepting the "GLACIER"
@@ -34448,13 +35650,13 @@ Press Enter to leave empty.
[snip]
acl&gt;</code></pre>
<p>And the config file should end up looking like this:</p>
-<div class="sourceCode" id="cb1132"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1132-1"><a href="#cb1132-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[remote]</span></span>
-<span id="cb1132-2"><a href="#cb1132-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
-<span id="cb1132-3"><a href="#cb1132-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> LyveCloud</span></span>
-<span id="cb1132-4"><a href="#cb1132-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> XXX</span></span>
-<span id="cb1132-5"><a href="#cb1132-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> YYY</span></span>
-<span id="cb1132-6"><a href="#cb1132-6" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> s3.us-east-1.lyvecloud.seagate.com</span></span></code></pre></div>
+<div class="sourceCode" id="cb1156"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1156-1"><a href="#cb1156-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[remote]</span></span>
+<span id="cb1156-2"><a href="#cb1156-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
+<span id="cb1156-3"><a href="#cb1156-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> LyveCloud</span></span>
+<span id="cb1156-4"><a href="#cb1156-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> XXX</span></span>
+<span id="cb1156-5"><a href="#cb1156-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> YYY</span></span>
+<span id="cb1156-6"><a href="#cb1156-6" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> s3.us-east-1.lyvecloud.seagate.com</span></span></code></pre></div>
<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,
@@ -34490,13 +35692,13 @@ such:</p>
}</code></pre>
<p>To use rclone with SeaweedFS, above configuration should end up with
something like this in your config:</p>
-<div class="sourceCode" id="cb1134"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1134-1"><a href="#cb1134-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[seaweedfs_s3]</span></span>
-<span id="cb1134-2"><a href="#cb1134-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
-<span id="cb1134-3"><a href="#cb1134-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> SeaweedFS</span></span>
-<span id="cb1134-4"><a href="#cb1134-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> any</span></span>
-<span id="cb1134-5"><a href="#cb1134-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> any</span></span>
-<span id="cb1134-6"><a href="#cb1134-6" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> localhost:8333</span></span></code></pre></div>
+<div class="sourceCode" id="cb1158"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1158-1"><a href="#cb1158-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[seaweedfs_s3]</span></span>
+<span id="cb1158-2"><a href="#cb1158-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
+<span id="cb1158-3"><a href="#cb1158-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> SeaweedFS</span></span>
+<span id="cb1158-4"><a href="#cb1158-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> any</span></span>
+<span id="cb1158-5"><a href="#cb1158-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> any</span></span>
+<span id="cb1158-6"><a href="#cb1158-6" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> localhost:8333</span></span></code></pre></div>
<p>So once set up, for example to copy files into a bucket</p>
<pre class="console"><code>rclone copy /path/to/files seaweedfs_s3:foo</code></pre>
<h3 id="selectel">Selectel</h3>
@@ -34599,14 +35801,14 @@ e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<p>And your config should end up looking like this:</p>
-<div class="sourceCode" id="cb1137"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1137-1"><a href="#cb1137-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[selectel]</span></span>
-<span id="cb1137-2"><a href="#cb1137-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
-<span id="cb1137-3"><a href="#cb1137-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> Selectel</span></span>
-<span id="cb1137-4"><a href="#cb1137-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> ACCESS_KEY</span></span>
-<span id="cb1137-5"><a href="#cb1137-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> SECRET_ACCESS_KEY</span></span>
-<span id="cb1137-6"><a href="#cb1137-6" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span><span class="st"> ru-1</span></span>
-<span id="cb1137-7"><a href="#cb1137-7" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> s3.ru-1.storage.selcloud.ru</span></span></code></pre></div>
+<div class="sourceCode" id="cb1161"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1161-1"><a href="#cb1161-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[selectel]</span></span>
+<span id="cb1161-2"><a href="#cb1161-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
+<span id="cb1161-3"><a href="#cb1161-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> Selectel</span></span>
+<span id="cb1161-4"><a href="#cb1161-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> ACCESS_KEY</span></span>
+<span id="cb1161-5"><a href="#cb1161-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> SECRET_ACCESS_KEY</span></span>
+<span id="cb1161-6"><a href="#cb1161-6" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span><span class="st"> ru-1</span></span>
+<span id="cb1161-7"><a href="#cb1161-7" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> s3.ru-1.storage.selcloud.ru</span></span></code></pre></div>
<h3 id="servercore">Servercore</h3>
<p><a href="https://servercore.com/services/object-storage/">Servercore
Object Storage</a> is an S3 compatible object storage system that
@@ -34799,13 +36001,13 @@ e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
<p>And your config should end up looking like this:</p>
-<div class="sourceCode" id="cb1140"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1140-1"><a href="#cb1140-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[spectratest]</span></span>
-<span id="cb1140-2"><a href="#cb1140-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
-<span id="cb1140-3"><a href="#cb1140-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> SpectraLogic</span></span>
-<span id="cb1140-4"><a href="#cb1140-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> ACCESS_KEY</span></span>
-<span id="cb1140-5"><a href="#cb1140-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> SECRET_ACCESS_KEY</span></span>
-<span id="cb1140-6"><a href="#cb1140-6" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> https://bp.example.com</span></span></code></pre></div>
+<div class="sourceCode" id="cb1164"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1164-1"><a href="#cb1164-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[spectratest]</span></span>
+<span id="cb1164-2"><a href="#cb1164-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
+<span id="cb1164-3"><a href="#cb1164-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> SpectraLogic</span></span>
+<span id="cb1164-4"><a href="#cb1164-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> ACCESS_KEY</span></span>
+<span id="cb1164-5"><a href="#cb1164-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> SECRET_ACCESS_KEY</span></span>
+<span id="cb1164-6"><a href="#cb1164-6" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> https://bp.example.com</span></span></code></pre></div>
<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>
@@ -35141,6 +36343,127 @@ Name Type
==== ====
cos s3</code></pre></li>
</ol>
+<h4 id="tencent-cos-global-acceleration-endpoint">Tencent COS Global
+Acceleration Endpoint</h4>
+<p>When using the Global Acceleration Endpoint
+(<code>cos.accelerate.myqcloud.com</code>), rclone automatically sets
+<code>no_check_bucket = true</code> because this acceleration endpoint
+does not support the <code>CreateBucket</code> call which is used for
+ensuring a bucket's existence by rclone. Global Acceleration is a
+per-bucket feature, so you should first create the bucket in one
+physical region, then enable it in the Tencent Cloud console.</p>
+<h3 id="us3">US3</h3>
+<p><a href="https://www.ucloud.cn/site/product/ufile.html">US3</a>
+Object Storage is a service that provides cloud storage for unstructured
+files for internet applications.</p>
+<p>To configure access to US3, follow the steps below: 1. First run:
+<code>console 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>
+2. Give the name of the configuration. For example, name it 'US3'.</p>
+<pre class="text"><code>name&gt; US3</code></pre>
+<ol start="3" type="1">
+<li><p>Select <code>s3</code> storage.</p>
+<pre class="text"><code>Choose a number from below, or type in your own value
+[snip]
+XX / Amazon S3 Compliant Storage Providers including AWS, ...
+ \ &quot;s3&quot;
+[snip]
+Storage&gt; s3</code></pre></li>
+<li><p>Select <code>US3</code> provider.</p>
+<pre class="text"><code> Choose a number from below, or type in your own value.
+ XX / Amazon Web Services (AWS) S3
+ \ (AWS)
+ [snip]
+ XX / UCloud Object Storage (US3)
+ \ (US3)
+ [snip]
+ provider&gt; US3</code></pre></li>
+<li><p>Enter your SecretId and SecretKey of US3.</p>
+<pre class="text"><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).
+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
+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; 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></li>
+<li><p>Select endpoint.</p>
+<pre class="text"><code> Option endpoint.
+ Endpoint for S3 API.
+ Required when using an S3 clone.
+ Choose a number from below, or type in your own value.
+ Press Enter to leave empty.
+ 1 / North China (Beijing 2).
+ \ &quot;s3-cn-bj.ufileos.com&quot;
+ 2 / North China (Ulanqab).
+ \ &quot;s3-cn-wlcb.ufileos.com&quot;
+ 3 / Shanghai.
+ \ &quot;s3-cn-sh2.ufileos.com&quot;
+ 4 / South China (Guangzhou).
+ \ &quot;s3-cn-gd.ufileos.com&quot;
+[snip]
+endpoint&gt; 1</code></pre></li>
+<li><p>Choose acl and storage class.</p>
+<pre class="text"><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.
+If the acl is an empty string then no X-Amz-Acl: header is added and
+the default (private) will be used.
+Choose a number from below, or type in your own value.
+Press Enter to leave empty.
+ / Owner gets FULL_CONTROL.
+1 | No one else has access rights (default).
+ \ (private)
+ / Owner gets FULL_CONTROL.
+2 | The AllUsers group gets READ access.
+ \ (public-read)
+acl&gt; 1
+
+The storage class to use when storing new objects in US3.
+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
+
+ Configuration complete.
+ Options:
+ - type: s3
+ - provider: US3
+ - access_key_id: xx
+ - secret_access_key: xx
+ - endpoint: s3-cn-bj.ufileos.com
+ - acl: private
+
+ Keep this &quot;US3&quot; remote?
+ y) Yes this is OK (default)
+ e) Edit this remote
+ d) Delete this remote
+ y/e/d&gt; y
+ Current remotes:
+
+ Name Type
+ ==== ====
+ US3 s3</code></pre></li>
+</ol>
<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
@@ -35233,19 +36556,125 @@ 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>
-<div class="sourceCode" id="cb1152"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1152-1"><a href="#cb1152-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[wasabi]</span></span>
-<span id="cb1152-2"><a href="#cb1152-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
-<span id="cb1152-3"><a href="#cb1152-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> Wasabi</span></span>
-<span id="cb1152-4"><a href="#cb1152-4" aria-hidden="true" tabindex="-1"></a><span class="dt">env_auth </span><span class="ot">=</span><span class="st"> </span><span class="kw">false</span></span>
-<span id="cb1152-5"><a href="#cb1152-5" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> YOURACCESSKEY</span></span>
-<span id="cb1152-6"><a href="#cb1152-6" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> YOURSECRETACCESSKEY</span></span>
-<span id="cb1152-7"><a href="#cb1152-7" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span></span>
-<span id="cb1152-8"><a href="#cb1152-8" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> s3.wasabisys.com</span></span>
-<span id="cb1152-9"><a href="#cb1152-9" aria-hidden="true" tabindex="-1"></a><span class="dt">location_constraint </span><span class="ot">=</span></span>
-<span id="cb1152-10"><a href="#cb1152-10" aria-hidden="true" tabindex="-1"></a><span class="dt">acl </span><span class="ot">=</span></span>
-<span id="cb1152-11"><a href="#cb1152-11" aria-hidden="true" tabindex="-1"></a><span class="dt">server_side_encryption </span><span class="ot">=</span></span>
-<span id="cb1152-12"><a href="#cb1152-12" aria-hidden="true" tabindex="-1"></a><span class="dt">storage_class </span><span class="ot">=</span></span></code></pre></div>
+<div class="sourceCode" id="cb1182"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1182-1"><a href="#cb1182-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[wasabi]</span></span>
+<span id="cb1182-2"><a href="#cb1182-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
+<span id="cb1182-3"><a href="#cb1182-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> Wasabi</span></span>
+<span id="cb1182-4"><a href="#cb1182-4" aria-hidden="true" tabindex="-1"></a><span class="dt">env_auth </span><span class="ot">=</span><span class="st"> </span><span class="kw">false</span></span>
+<span id="cb1182-5"><a href="#cb1182-5" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> YOURACCESSKEY</span></span>
+<span id="cb1182-6"><a href="#cb1182-6" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> YOURSECRETACCESSKEY</span></span>
+<span id="cb1182-7"><a href="#cb1182-7" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span></span>
+<span id="cb1182-8"><a href="#cb1182-8" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> s3.wasabisys.com</span></span>
+<span id="cb1182-9"><a href="#cb1182-9" aria-hidden="true" tabindex="-1"></a><span class="dt">location_constraint </span><span class="ot">=</span></span>
+<span id="cb1182-10"><a href="#cb1182-10" aria-hidden="true" tabindex="-1"></a><span class="dt">acl </span><span class="ot">=</span></span>
+<span id="cb1182-11"><a href="#cb1182-11" aria-hidden="true" tabindex="-1"></a><span class="dt">server_side_encryption </span><span class="ot">=</span></span>
+<span id="cb1182-12"><a href="#cb1182-12" aria-hidden="true" tabindex="-1"></a><span class="dt">storage_class </span><span class="ot">=</span></span></code></pre></div>
+<h3 id="zadara">Zadara Object Storage</h3>
+<p><a href="https://www.zadara.com">Zadara Object Storage</a> is a
+fully-managed, enterprise-grade, S3-compatible storage solution that
+provides scalable, multi-tenant object storage with flexible deployment
+options (on-prem, hybrid, or cloud).</p>
+<p>Zadara Object Storage can be configured using
+<code>rclone config</code> with <code>s3</code> as the type and
+<code>Zadara</code> as the provider name. Here is an example run of the
+configurator.</p>
+<p>Authentication and endpoint information, including the region field,
+should be fetched from Zadara’s Object Storage management interface</p>
+<p>To configure access to Zadara Object Storage, first run:</p>
+<pre class="console"><code>rclone config</code></pre>
+<pre class="text"><code>This will guide you through an interactive setup process:
+
+No remotes found, make a new one\?
+n) New remote
+s) Set configuration password
+n/s&gt; n
+
+Enter name for new remote.
+name&gt; Zadara-Object-Storage
+
+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 ...
+ \ (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 / Zadara Object Storage
+ \ (Zadara)
+
+provider&gt; Zadara
+
+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; S3_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; S3_SECRET_KEY
+
+Option region.
+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.
+ / The default region.
+ 1 | Leave location constraint empty.
+ \ (us-east-1)
+region&gt;
+
+Option endpoint.
+Endpoint for S3 API.
+Required when using an S3 clone.
+Enter a value. Press Enter to leave empty.
+endpoint&gt; https://vsa-00000001-public-zadara-cloud-01.zadarazios.com
+
+Edit advanced config?
+y) Yes
+n) No (default)
+y/n&gt;
+
+Configuration complete.
+Options:
+- type: s3
+- provider: Zadara
+- access_key_id: S3_ACCESS_KEY
+- secret_access_key: S3_SECRET_KEY
+- endpoint: https://vsa-00000001-public-zadara-cloud-01.zadarazios.com
+Keep this &quot;Zadara-Object-Storage&quot; remote?
+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 the config file looking like this.</p>
+<div class="sourceCode" id="cb1185"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1185-1"><a href="#cb1185-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[Zadara-Object-Storage]</span></span>
+<span id="cb1185-2"><a href="#cb1185-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
+<span id="cb1185-3"><a href="#cb1185-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> Zadara</span></span>
+<span id="cb1185-4"><a href="#cb1185-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> S3_ACCESS_KEY</span></span>
+<span id="cb1185-5"><a href="#cb1185-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> S3_SECRET_KEY</span></span>
+<span id="cb1185-6"><a href="#cb1185-6" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> https://vsa-00000001-public-zadara-cloud-01.zadarazios.com</span></span></code></pre></div>
<h3 id="Zata">Zata Object Storage</h3>
<p><a href="https://zata.ai/">Zata Object Storage</a> provides a secure,
S3-compatible cloud storage solution designed for scalability and
@@ -35381,14 +36810,14 @@ e) Edit this remote
d) Delete this remote
y/e/d&gt;</code></pre>
<p>This will leave the config file looking like this.</p>
-<div class="sourceCode" id="cb1155"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1155-1"><a href="#cb1155-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[my zata storage]</span></span>
-<span id="cb1155-2"><a href="#cb1155-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
-<span id="cb1155-3"><a href="#cb1155-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> Zata</span></span>
-<span id="cb1155-4"><a href="#cb1155-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> xxx</span></span>
-<span id="cb1155-5"><a href="#cb1155-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> xxx</span></span>
-<span id="cb1155-6"><a href="#cb1155-6" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span><span class="st"> us-east-1</span></span>
-<span id="cb1155-7"><a href="#cb1155-7" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> idr01.zata.ai</span></span></code></pre></div>
+<div class="sourceCode" id="cb1188"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1188-1"><a href="#cb1188-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[my zata storage]</span></span>
+<span id="cb1188-2"><a href="#cb1188-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> s3</span></span>
+<span id="cb1188-3"><a href="#cb1188-3" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> Zata</span></span>
+<span id="cb1188-4"><a href="#cb1188-4" aria-hidden="true" tabindex="-1"></a><span class="dt">access_key_id </span><span class="ot">=</span><span class="st"> xxx</span></span>
+<span id="cb1188-5"><a href="#cb1188-5" aria-hidden="true" tabindex="-1"></a><span class="dt">secret_access_key </span><span class="ot">=</span><span class="st"> xxx</span></span>
+<span id="cb1188-6"><a href="#cb1188-6" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span><span class="st"> us-east-1</span></span>
+<span id="cb1188-7"><a href="#cb1188-7" aria-hidden="true" tabindex="-1"></a><span class="dt">endpoint </span><span class="ot">=</span><span class="st"> idr01.zata.ai</span></span></code></pre></div>
<h2 id="memory">Memory usage</h2>
<p>The most common cause of rclone using lots of memory is a single
directory with millions of files in. Despite s3 not really having the
@@ -36361,15 +37790,15 @@ bucket.</p>
<p>To show the current lifecycle rules:</p>
<pre class="console"><code>rclone backend lifecycle b2:bucket</code></pre>
<p>This will dump something like this showing the lifecycle rules.</p>
-<div class="sourceCode" id="cb1186"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb1186-1"><a href="#cb1186-1" aria-hidden="true" tabindex="-1"></a><span class="ot">[</span></span>
-<span id="cb1186-2"><a href="#cb1186-2" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
-<span id="cb1186-3"><a href="#cb1186-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;daysFromHidingToDeleting&quot;</span><span class="fu">:</span> <span class="dv">1</span><span class="fu">,</span></span>
-<span id="cb1186-4"><a href="#cb1186-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;daysFromUploadingToHiding&quot;</span><span class="fu">:</span> <span class="kw">null</span><span class="fu">,</span></span>
-<span id="cb1186-5"><a href="#cb1186-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;daysFromStartingToCancelingUnfinishedLargeFiles&quot;</span><span class="fu">:</span> <span class="kw">null</span><span class="fu">,</span></span>
-<span id="cb1186-6"><a href="#cb1186-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;fileNamePrefix&quot;</span><span class="fu">:</span> <span class="st">&quot;&quot;</span></span>
-<span id="cb1186-7"><a href="#cb1186-7" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
-<span id="cb1186-8"><a href="#cb1186-8" aria-hidden="true" tabindex="-1"></a><span class="ot">]</span></span></code></pre></div>
+<div class="sourceCode" id="cb1219"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb1219-1"><a href="#cb1219-1" aria-hidden="true" tabindex="-1"></a><span class="ot">[</span></span>
+<span id="cb1219-2"><a href="#cb1219-2" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
+<span id="cb1219-3"><a href="#cb1219-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;daysFromHidingToDeleting&quot;</span><span class="fu">:</span> <span class="dv">1</span><span class="fu">,</span></span>
+<span id="cb1219-4"><a href="#cb1219-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;daysFromUploadingToHiding&quot;</span><span class="fu">:</span> <span class="kw">null</span><span class="fu">,</span></span>
+<span id="cb1219-5"><a href="#cb1219-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;daysFromStartingToCancelingUnfinishedLargeFiles&quot;</span><span class="fu">:</span> <span class="kw">null</span><span class="fu">,</span></span>
+<span id="cb1219-6"><a href="#cb1219-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;fileNamePrefix&quot;</span><span class="fu">:</span> <span class="st">&quot;&quot;</span></span>
+<span id="cb1219-7"><a href="#cb1219-7" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
+<span id="cb1219-8"><a href="#cb1219-8" aria-hidden="true" tabindex="-1"></a><span class="ot">]</span></span></code></pre></div>
<p>If there are no lifecycle rules (the default) then it will just
return <code>[]</code>.</p>
<p>To reset the current lifecycle rules:</p>
@@ -39327,7 +40756,7 @@ 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-97">See Also</h2>
+<h2 id="see-also-98">See Also</h2>
<ul>
<li><a href="https://rclone.org/commands/rclone_cryptdecode/">rclone
cryptdecode</a> - Show forward/reverse mapping of encrypted
@@ -39608,18 +41037,18 @@ the shared drives you have access to.</p>
<code>drive:</code> you would run</p>
<pre class="console"><code>rclone backend -o config drives drive:</code></pre>
<p>This would produce something like this:</p>
-<div class="sourceCode" id="cb1238"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1238-1"><a href="#cb1238-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[My Drive]</span></span>
-<span id="cb1238-2"><a href="#cb1238-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> alias</span></span>
-<span id="cb1238-3"><a href="#cb1238-3" aria-hidden="true" tabindex="-1"></a><span class="dt">remote </span><span class="ot">=</span><span class="st"> drive,team_drive=0ABCDEF-01234567890,root_folder_id=:</span></span>
-<span id="cb1238-4"><a href="#cb1238-4" aria-hidden="true" tabindex="-1"></a></span>
-<span id="cb1238-5"><a href="#cb1238-5" aria-hidden="true" tabindex="-1"></a><span class="kw">[Test Drive]</span></span>
-<span id="cb1238-6"><a href="#cb1238-6" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> alias</span></span>
-<span id="cb1238-7"><a href="#cb1238-7" aria-hidden="true" tabindex="-1"></a><span class="dt">remote </span><span class="ot">=</span><span class="st"> drive,team_drive=0ABCDEFabcdefghijkl,root_folder_id=:</span></span>
-<span id="cb1238-8"><a href="#cb1238-8" aria-hidden="true" tabindex="-1"></a></span>
-<span id="cb1238-9"><a href="#cb1238-9" aria-hidden="true" tabindex="-1"></a><span class="kw">[AllDrives]</span></span>
-<span id="cb1238-10"><a href="#cb1238-10" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> combine</span></span>
-<span id="cb1238-11"><a href="#cb1238-11" aria-hidden="true" tabindex="-1"></a><span class="dt">upstreams </span><span class="ot">=</span><span class="st"> &quot;My Drive=My Drive:&quot; &quot;Test Drive=Test Drive:&quot;</span></span></code></pre></div>
+<div class="sourceCode" id="cb1271"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1271-1"><a href="#cb1271-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[My Drive]</span></span>
+<span id="cb1271-2"><a href="#cb1271-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> alias</span></span>
+<span id="cb1271-3"><a href="#cb1271-3" aria-hidden="true" tabindex="-1"></a><span class="dt">remote </span><span class="ot">=</span><span class="st"> drive,team_drive=0ABCDEF-01234567890,root_folder_id=:</span></span>
+<span id="cb1271-4"><a href="#cb1271-4" aria-hidden="true" tabindex="-1"></a></span>
+<span id="cb1271-5"><a href="#cb1271-5" aria-hidden="true" tabindex="-1"></a><span class="kw">[Test Drive]</span></span>
+<span id="cb1271-6"><a href="#cb1271-6" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> alias</span></span>
+<span id="cb1271-7"><a href="#cb1271-7" aria-hidden="true" tabindex="-1"></a><span class="dt">remote </span><span class="ot">=</span><span class="st"> drive,team_drive=0ABCDEFabcdefghijkl,root_folder_id=:</span></span>
+<span id="cb1271-8"><a href="#cb1271-8" aria-hidden="true" tabindex="-1"></a></span>
+<span id="cb1271-9"><a href="#cb1271-9" aria-hidden="true" tabindex="-1"></a><span class="kw">[AllDrives]</span></span>
+<span id="cb1271-10"><a href="#cb1271-10" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> combine</span></span>
+<span id="cb1271-11"><a href="#cb1271-11" aria-hidden="true" tabindex="-1"></a><span class="dt">upstreams </span><span class="ot">=</span><span class="st"> &quot;My Drive=My Drive:&quot; &quot;Test Drive=Test Drive:&quot;</span></span></code></pre></div>
<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>
@@ -41049,6 +42478,25 @@ Storage).</p>
<h3 id="advanced-options-17">Advanced options</h3>
<p>Here are the Advanced options specific to filelu (FileLu Cloud
Storage).</p>
+<h4 id="filelu-upload-cutoff">--filelu-upload-cutoff</h4>
+<p>Cutoff for switching to chunked upload. Any files larger than this
+will be uploaded in chunks of chunk_size.</p>
+<p>Properties:</p>
+<ul>
+<li>Config: upload_cutoff</li>
+<li>Env Var: RCLONE_FILELU_UPLOAD_CUTOFF</li>
+<li>Type: SizeSuffix</li>
+<li>Default: 500Mi</li>
+</ul>
+<h4 id="filelu-chunk-size">--filelu-chunk-size</h4>
+<p>Chunk size to use for uploading. Used for multipart uploads.</p>
+<p>Properties:</p>
+<ul>
+<li>Config: chunk_size</li>
+<li>Env Var: RCLONE_FILELU_CHUNK_SIZE</li>
+<li>Type: SizeSuffix</li>
+<li>Default: 64Mi</li>
+</ul>
<h4 id="filelu-encoding">--filelu-encoding</h4>
<p>The encoding for the backend.</p>
<p>See the <a href="https://rclone.org/overview/#encoding">encoding
@@ -41086,6 +42534,9 @@ account, currently this is only possible using the <a
href="https://github.com/FilenCloudDienste/filen-cli">Filen CLI</a>.
This means you must first download the CLI, login, and then run the
<code>export-api-key</code> command.</p>
+<p><strong>Note:</strong> If you change your Filen account password, you
+will need to update your rclone configuration with the new password and
+a re-exported API key (via <code>export-api-key</code>).</p>
<p>Here is an example of how to make a remote called
<code>FilenRemote</code>. First run:</p>
<pre><code> rclone config</code></pre>
@@ -44790,34 +46241,34 @@ account.</p>
<p>Usage example:</p>
<pre class="console"><code>rclone backend [-o config] drives drive:</code></pre>
<p>This will return a JSON list of objects like this:</p>
-<div class="sourceCode" id="cb1342"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb1342-1"><a href="#cb1342-1" aria-hidden="true" tabindex="-1"></a><span class="ot">[</span></span>
-<span id="cb1342-2"><a href="#cb1342-2" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
-<span id="cb1342-3"><a href="#cb1342-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;id&quot;</span><span class="fu">:</span> <span class="st">&quot;0ABCDEF-01234567890&quot;</span><span class="fu">,</span></span>
-<span id="cb1342-4"><a href="#cb1342-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;kind&quot;</span><span class="fu">:</span> <span class="st">&quot;drive#teamDrive&quot;</span><span class="fu">,</span></span>
-<span id="cb1342-5"><a href="#cb1342-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;name&quot;</span><span class="fu">:</span> <span class="st">&quot;My Drive&quot;</span></span>
-<span id="cb1342-6"><a href="#cb1342-6" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span><span class="ot">,</span></span>
-<span id="cb1342-7"><a href="#cb1342-7" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
-<span id="cb1342-8"><a href="#cb1342-8" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;id&quot;</span><span class="fu">:</span> <span class="st">&quot;0ABCDEFabcdefghijkl&quot;</span><span class="fu">,</span></span>
-<span id="cb1342-9"><a href="#cb1342-9" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;kind&quot;</span><span class="fu">:</span> <span class="st">&quot;drive#teamDrive&quot;</span><span class="fu">,</span></span>
-<span id="cb1342-10"><a href="#cb1342-10" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;name&quot;</span><span class="fu">:</span> <span class="st">&quot;Test Drive&quot;</span></span>
-<span id="cb1342-11"><a href="#cb1342-11" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
-<span id="cb1342-12"><a href="#cb1342-12" aria-hidden="true" tabindex="-1"></a><span class="ot">]</span></span></code></pre></div>
+<div class="sourceCode" id="cb1375"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb1375-1"><a href="#cb1375-1" aria-hidden="true" tabindex="-1"></a><span class="ot">[</span></span>
+<span id="cb1375-2"><a href="#cb1375-2" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
+<span id="cb1375-3"><a href="#cb1375-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;id&quot;</span><span class="fu">:</span> <span class="st">&quot;0ABCDEF-01234567890&quot;</span><span class="fu">,</span></span>
+<span id="cb1375-4"><a href="#cb1375-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;kind&quot;</span><span class="fu">:</span> <span class="st">&quot;drive#teamDrive&quot;</span><span class="fu">,</span></span>
+<span id="cb1375-5"><a href="#cb1375-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;name&quot;</span><span class="fu">:</span> <span class="st">&quot;My Drive&quot;</span></span>
+<span id="cb1375-6"><a href="#cb1375-6" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span><span class="ot">,</span></span>
+<span id="cb1375-7"><a href="#cb1375-7" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
+<span id="cb1375-8"><a href="#cb1375-8" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;id&quot;</span><span class="fu">:</span> <span class="st">&quot;0ABCDEFabcdefghijkl&quot;</span><span class="fu">,</span></span>
+<span id="cb1375-9"><a href="#cb1375-9" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;kind&quot;</span><span class="fu">:</span> <span class="st">&quot;drive#teamDrive&quot;</span><span class="fu">,</span></span>
+<span id="cb1375-10"><a href="#cb1375-10" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;name&quot;</span><span class="fu">:</span> <span class="st">&quot;Test Drive&quot;</span></span>
+<span id="cb1375-11"><a href="#cb1375-11" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
+<span id="cb1375-12"><a href="#cb1375-12" aria-hidden="true" tabindex="-1"></a><span class="ot">]</span></span></code></pre></div>
<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>
-<div class="sourceCode" id="cb1343"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1343-1"><a href="#cb1343-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[My Drive]</span></span>
-<span id="cb1343-2"><a href="#cb1343-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> alias</span></span>
-<span id="cb1343-3"><a href="#cb1343-3" aria-hidden="true" tabindex="-1"></a><span class="dt">remote </span><span class="ot">=</span><span class="st"> drive,team_drive=0ABCDEF-01234567890,root_folder_id=:</span></span>
-<span id="cb1343-4"><a href="#cb1343-4" aria-hidden="true" tabindex="-1"></a></span>
-<span id="cb1343-5"><a href="#cb1343-5" aria-hidden="true" tabindex="-1"></a><span class="kw">[Test Drive]</span></span>
-<span id="cb1343-6"><a href="#cb1343-6" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> alias</span></span>
-<span id="cb1343-7"><a href="#cb1343-7" aria-hidden="true" tabindex="-1"></a><span class="dt">remote </span><span class="ot">=</span><span class="st"> drive,team_drive=0ABCDEFabcdefghijkl,root_folder_id=:</span></span>
-<span id="cb1343-8"><a href="#cb1343-8" aria-hidden="true" tabindex="-1"></a></span>
-<span id="cb1343-9"><a href="#cb1343-9" aria-hidden="true" tabindex="-1"></a><span class="kw">[AllDrives]</span></span>
-<span id="cb1343-10"><a href="#cb1343-10" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> combine</span></span>
-<span id="cb1343-11"><a href="#cb1343-11" aria-hidden="true" tabindex="-1"></a><span class="dt">upstreams </span><span class="ot">=</span><span class="st"> &quot;My Drive=My Drive:&quot; &quot;Test Drive=Test Drive:&quot;</span></span></code></pre></div>
+<div class="sourceCode" id="cb1376"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1376-1"><a href="#cb1376-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[My Drive]</span></span>
+<span id="cb1376-2"><a href="#cb1376-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> alias</span></span>
+<span id="cb1376-3"><a href="#cb1376-3" aria-hidden="true" tabindex="-1"></a><span class="dt">remote </span><span class="ot">=</span><span class="st"> drive,team_drive=0ABCDEF-01234567890,root_folder_id=:</span></span>
+<span id="cb1376-4"><a href="#cb1376-4" aria-hidden="true" tabindex="-1"></a></span>
+<span id="cb1376-5"><a href="#cb1376-5" aria-hidden="true" tabindex="-1"></a><span class="kw">[Test Drive]</span></span>
+<span id="cb1376-6"><a href="#cb1376-6" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> alias</span></span>
+<span id="cb1376-7"><a href="#cb1376-7" aria-hidden="true" tabindex="-1"></a><span class="dt">remote </span><span class="ot">=</span><span class="st"> drive,team_drive=0ABCDEFabcdefghijkl,root_folder_id=:</span></span>
+<span id="cb1376-8"><a href="#cb1376-8" aria-hidden="true" tabindex="-1"></a></span>
+<span id="cb1376-9"><a href="#cb1376-9" aria-hidden="true" tabindex="-1"></a><span class="kw">[AllDrives]</span></span>
+<span id="cb1376-10"><a href="#cb1376-10" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> combine</span></span>
+<span id="cb1376-11"><a href="#cb1376-11" aria-hidden="true" tabindex="-1"></a><span class="dt">upstreams </span><span class="ot">=</span><span class="st"> &quot;My Drive=My Drive:&quot; &quot;Test Drive=Test Drive:&quot;</span></span></code></pre></div>
<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
@@ -44836,11 +46287,11 @@ use via the API.</p>
<p>Use the --interactive/-i or --dry-run flag to see what would be
restored before restoring it.</p>
<p>Result:</p>
-<div class="sourceCode" id="cb1346"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb1346-1"><a href="#cb1346-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
-<span id="cb1346-2"><a href="#cb1346-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Untrashed&quot;</span><span class="fu">:</span> <span class="dv">17</span><span class="fu">,</span></span>
-<span id="cb1346-3"><a href="#cb1346-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Errors&quot;</span><span class="fu">:</span> <span class="dv">0</span></span>
-<span id="cb1346-4"><a href="#cb1346-4" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
+<div class="sourceCode" id="cb1379"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb1379-1"><a href="#cb1379-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
+<span id="cb1379-2"><a href="#cb1379-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Untrashed&quot;</span><span class="fu">:</span> <span class="dv">17</span><span class="fu">,</span></span>
+<span id="cb1379-3"><a href="#cb1379-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Errors&quot;</span><span class="fu">:</span> <span class="dv">0</span></span>
+<span id="cb1379-4"><a href="#cb1379-4" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<h3 id="copyid">copyid</h3>
<p>Copy files by ID.</p>
<pre class="console"><code>rclone backend copyid remote: [options] [&lt;arguments&gt;+]</code></pre>
@@ -44896,32 +46347,32 @@ escaped with  characters. "'" becomes "'" and "" becomes "\", for
example to match a file named "foo ' .txt":</p>
<pre class="console"><code>rclone backend query drive: &quot;name = &#39;foo \&#39; \\\.txt&#39;&quot;</code></pre>
<p>The result is a JSON array of matches, for example:</p>
-<div class="sourceCode" id="cb1357"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb1357-1"><a href="#cb1357-1" aria-hidden="true" tabindex="-1"></a><span class="ot">[</span></span>
-<span id="cb1357-2"><a href="#cb1357-2" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
-<span id="cb1357-3"><a href="#cb1357-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;createdTime&quot;</span><span class="fu">:</span> <span class="st">&quot;2017-06-29T19:58:28.537Z&quot;</span><span class="fu">,</span></span>
-<span id="cb1357-4"><a href="#cb1357-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;id&quot;</span><span class="fu">:</span> <span class="st">&quot;0AxBe_CDEF4zkGHI4d0FjYko2QkD&quot;</span><span class="fu">,</span></span>
-<span id="cb1357-5"><a href="#cb1357-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;md5Checksum&quot;</span><span class="fu">:</span> <span class="st">&quot;68518d16be0c6fbfab918be61d658032&quot;</span><span class="fu">,</span></span>
-<span id="cb1357-6"><a href="#cb1357-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;mimeType&quot;</span><span class="fu">:</span> <span class="st">&quot;text/plain&quot;</span><span class="fu">,</span></span>
-<span id="cb1357-7"><a href="#cb1357-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;modifiedTime&quot;</span><span class="fu">:</span> <span class="st">&quot;2024-02-02T10:40:02.874Z&quot;</span><span class="fu">,</span></span>
-<span id="cb1357-8"><a href="#cb1357-8" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;name&quot;</span><span class="fu">:</span> <span class="st">&quot;foo &#39; </span><span class="ch">\\</span><span class="st">.txt&quot;</span><span class="fu">,</span></span>
-<span id="cb1357-9"><a href="#cb1357-9" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;parents&quot;</span><span class="fu">:</span> <span class="ot">[</span></span>
-<span id="cb1357-10"><a href="#cb1357-10" aria-hidden="true" tabindex="-1"></a> <span class="st">&quot;0BxAe_BCDE4zkFGZpcWJGek0xbzC&quot;</span></span>
-<span id="cb1357-11"><a href="#cb1357-11" aria-hidden="true" tabindex="-1"></a> <span class="ot">]</span><span class="fu">,</span></span>
-<span id="cb1357-12"><a href="#cb1357-12" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;resourceKey&quot;</span><span class="fu">:</span> <span class="st">&quot;0-ABCDEFGHIXJQpIGqBJq3MC&quot;</span><span class="fu">,</span></span>
-<span id="cb1357-13"><a href="#cb1357-13" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;sha1Checksum&quot;</span><span class="fu">:</span> <span class="st">&quot;8f284fa768bfb4e45d076a579ab3905ab6bfa893&quot;</span><span class="fu">,</span></span>
-<span id="cb1357-14"><a href="#cb1357-14" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;size&quot;</span><span class="fu">:</span> <span class="st">&quot;311&quot;</span><span class="fu">,</span></span>
-<span id="cb1357-15"><a href="#cb1357-15" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;webViewLink&quot;</span><span class="fu">:</span> <span class="st">&quot;https://drive.google.com/file/d/0AxBe_CDEF4zkGHI4d0FjYko2QkD/view?usp=drivesdk</span><span class="ch">\u0026</span><span class="st">resourcekey=0-ABCDEFGHIXJQpIGqBJq3MC&quot;</span></span>
-<span id="cb1357-16"><a href="#cb1357-16" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
-<span id="cb1357-17"><a href="#cb1357-17" aria-hidden="true" tabindex="-1"></a><span class="ot">]</span></span>
-<span id="cb1357-18"><a href="#cb1357-18" aria-hidden="true" tabindex="-1"></a><span class="er">```console</span></span>
-<span id="cb1357-19"><a href="#cb1357-19" aria-hidden="true" tabindex="-1"></a></span>
-<span id="cb1357-20"><a href="#cb1357-20" aria-hidden="true" tabindex="-1"></a><span class="er">###</span> <span class="er">rescue</span></span>
-<span id="cb1357-21"><a href="#cb1357-21" aria-hidden="true" tabindex="-1"></a></span>
-<span id="cb1357-22"><a href="#cb1357-22" aria-hidden="true" tabindex="-1"></a><span class="er">Rescue</span> <span class="er">or</span> <span class="er">delete</span> <span class="er">any</span> <span class="er">orphaned</span> <span class="er">files.</span></span>
-<span id="cb1357-23"><a href="#cb1357-23" aria-hidden="true" tabindex="-1"></a></span>
-<span id="cb1357-24"><a href="#cb1357-24" aria-hidden="true" tabindex="-1"></a><span class="er">```console</span></span>
-<span id="cb1357-25"><a href="#cb1357-25" aria-hidden="true" tabindex="-1"></a><span class="er">rclone</span> <span class="er">backend</span> <span class="er">rescue</span> <span class="er">remote:</span> <span class="ot">[</span><span class="er">options</span><span class="ot">]</span> <span class="ot">[</span><span class="er">&lt;arguments&gt;+</span><span class="ot">]</span></span></code></pre></div>
+<div class="sourceCode" id="cb1390"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb1390-1"><a href="#cb1390-1" aria-hidden="true" tabindex="-1"></a><span class="ot">[</span></span>
+<span id="cb1390-2"><a href="#cb1390-2" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
+<span id="cb1390-3"><a href="#cb1390-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;createdTime&quot;</span><span class="fu">:</span> <span class="st">&quot;2017-06-29T19:58:28.537Z&quot;</span><span class="fu">,</span></span>
+<span id="cb1390-4"><a href="#cb1390-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;id&quot;</span><span class="fu">:</span> <span class="st">&quot;0AxBe_CDEF4zkGHI4d0FjYko2QkD&quot;</span><span class="fu">,</span></span>
+<span id="cb1390-5"><a href="#cb1390-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;md5Checksum&quot;</span><span class="fu">:</span> <span class="st">&quot;68518d16be0c6fbfab918be61d658032&quot;</span><span class="fu">,</span></span>
+<span id="cb1390-6"><a href="#cb1390-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;mimeType&quot;</span><span class="fu">:</span> <span class="st">&quot;text/plain&quot;</span><span class="fu">,</span></span>
+<span id="cb1390-7"><a href="#cb1390-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;modifiedTime&quot;</span><span class="fu">:</span> <span class="st">&quot;2024-02-02T10:40:02.874Z&quot;</span><span class="fu">,</span></span>
+<span id="cb1390-8"><a href="#cb1390-8" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;name&quot;</span><span class="fu">:</span> <span class="st">&quot;foo &#39; </span><span class="ch">\\</span><span class="st">.txt&quot;</span><span class="fu">,</span></span>
+<span id="cb1390-9"><a href="#cb1390-9" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;parents&quot;</span><span class="fu">:</span> <span class="ot">[</span></span>
+<span id="cb1390-10"><a href="#cb1390-10" aria-hidden="true" tabindex="-1"></a> <span class="st">&quot;0BxAe_BCDE4zkFGZpcWJGek0xbzC&quot;</span></span>
+<span id="cb1390-11"><a href="#cb1390-11" aria-hidden="true" tabindex="-1"></a> <span class="ot">]</span><span class="fu">,</span></span>
+<span id="cb1390-12"><a href="#cb1390-12" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;resourceKey&quot;</span><span class="fu">:</span> <span class="st">&quot;0-ABCDEFGHIXJQpIGqBJq3MC&quot;</span><span class="fu">,</span></span>
+<span id="cb1390-13"><a href="#cb1390-13" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;sha1Checksum&quot;</span><span class="fu">:</span> <span class="st">&quot;8f284fa768bfb4e45d076a579ab3905ab6bfa893&quot;</span><span class="fu">,</span></span>
+<span id="cb1390-14"><a href="#cb1390-14" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;size&quot;</span><span class="fu">:</span> <span class="st">&quot;311&quot;</span><span class="fu">,</span></span>
+<span id="cb1390-15"><a href="#cb1390-15" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;webViewLink&quot;</span><span class="fu">:</span> <span class="st">&quot;https://drive.google.com/file/d/0AxBe_CDEF4zkGHI4d0FjYko2QkD/view?usp=drivesdk</span><span class="ch">\u0026</span><span class="st">resourcekey=0-ABCDEFGHIXJQpIGqBJq3MC&quot;</span></span>
+<span id="cb1390-16"><a href="#cb1390-16" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
+<span id="cb1390-17"><a href="#cb1390-17" aria-hidden="true" tabindex="-1"></a><span class="ot">]</span></span>
+<span id="cb1390-18"><a href="#cb1390-18" aria-hidden="true" tabindex="-1"></a><span class="er">```console</span></span>
+<span id="cb1390-19"><a href="#cb1390-19" aria-hidden="true" tabindex="-1"></a></span>
+<span id="cb1390-20"><a href="#cb1390-20" aria-hidden="true" tabindex="-1"></a><span class="er">###</span> <span class="er">rescue</span></span>
+<span id="cb1390-21"><a href="#cb1390-21" aria-hidden="true" tabindex="-1"></a></span>
+<span id="cb1390-22"><a href="#cb1390-22" aria-hidden="true" tabindex="-1"></a><span class="er">Rescue</span> <span class="er">or</span> <span class="er">delete</span> <span class="er">any</span> <span class="er">orphaned</span> <span class="er">files.</span></span>
+<span id="cb1390-23"><a href="#cb1390-23" aria-hidden="true" tabindex="-1"></a></span>
+<span id="cb1390-24"><a href="#cb1390-24" aria-hidden="true" tabindex="-1"></a><span class="er">```console</span></span>
+<span id="cb1390-25"><a href="#cb1390-25" aria-hidden="true" tabindex="-1"></a><span class="er">rclone</span> <span class="er">backend</span> <span class="er">rescue</span> <span class="er">remote:</span> <span class="ot">[</span><span class="er">options</span><span class="ot">]</span> <span class="ot">[</span><span class="er">&lt;arguments&gt;+</span><span class="ot">]</span></span></code></pre></div>
<p>This command rescues or deletes any orphaned files or
directories.</p>
<p>Sometimes files can get orphaned in Google Drive. This means that
@@ -45057,6 +46508,9 @@ Workspace.)</p></li>
<li><p>Go to "Audience" and then click "PUBLISH APP" button and confirm.
Add yourself as a test user if you haven't already.</p></li>
<li><p>Provide the noted client ID and client secret to rclone.</p></li>
+<li><p>Run the web-based authorization flow from within
+<code>rclone config</code>, by answering "Y" when it asks "Already have
+a token - refresh?".</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
@@ -45703,18 +47157,18 @@ y/e/d&gt; y</code></pre>
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>
-<div class="sourceCode" id="cb1375"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1375-1"><a href="#cb1375-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[Hasher1]</span></span>
-<span id="cb1375-2"><a href="#cb1375-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> hasher</span></span>
-<span id="cb1375-3"><a href="#cb1375-3" aria-hidden="true" tabindex="-1"></a><span class="dt">remote </span><span class="ot">=</span><span class="st"> myRemote:path</span></span>
-<span id="cb1375-4"><a href="#cb1375-4" aria-hidden="true" tabindex="-1"></a><span class="dt">hashes </span><span class="ot">=</span><span class="st"> md5</span></span>
-<span id="cb1375-5"><a href="#cb1375-5" aria-hidden="true" tabindex="-1"></a><span class="dt">max_age </span><span class="ot">=</span><span class="st"> </span><span class="kw">off</span></span>
-<span id="cb1375-6"><a href="#cb1375-6" aria-hidden="true" tabindex="-1"></a></span>
-<span id="cb1375-7"><a href="#cb1375-7" aria-hidden="true" tabindex="-1"></a><span class="kw">[Hasher2]</span></span>
-<span id="cb1375-8"><a href="#cb1375-8" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> hasher</span></span>
-<span id="cb1375-9"><a href="#cb1375-9" aria-hidden="true" tabindex="-1"></a><span class="dt">remote </span><span class="ot">=</span><span class="st"> /local/path</span></span>
-<span id="cb1375-10"><a href="#cb1375-10" aria-hidden="true" tabindex="-1"></a><span class="dt">hashes </span><span class="ot">=</span><span class="st"> dropbox,sha1</span></span>
-<span id="cb1375-11"><a href="#cb1375-11" aria-hidden="true" tabindex="-1"></a><span class="dt">max_age </span><span class="ot">=</span><span class="st"> 24h</span></span></code></pre></div>
+<div class="sourceCode" id="cb1408"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1408-1"><a href="#cb1408-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[Hasher1]</span></span>
+<span id="cb1408-2"><a href="#cb1408-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> hasher</span></span>
+<span id="cb1408-3"><a href="#cb1408-3" aria-hidden="true" tabindex="-1"></a><span class="dt">remote </span><span class="ot">=</span><span class="st"> myRemote:path</span></span>
+<span id="cb1408-4"><a href="#cb1408-4" aria-hidden="true" tabindex="-1"></a><span class="dt">hashes </span><span class="ot">=</span><span class="st"> md5</span></span>
+<span id="cb1408-5"><a href="#cb1408-5" aria-hidden="true" tabindex="-1"></a><span class="dt">max_age </span><span class="ot">=</span><span class="st"> </span><span class="kw">off</span></span>
+<span id="cb1408-6"><a href="#cb1408-6" aria-hidden="true" tabindex="-1"></a></span>
+<span id="cb1408-7"><a href="#cb1408-7" aria-hidden="true" tabindex="-1"></a><span class="kw">[Hasher2]</span></span>
+<span id="cb1408-8"><a href="#cb1408-8" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> hasher</span></span>
+<span id="cb1408-9"><a href="#cb1408-9" aria-hidden="true" tabindex="-1"></a><span class="dt">remote </span><span class="ot">=</span><span class="st"> /local/path</span></span>
+<span id="cb1408-10"><a href="#cb1408-10" aria-hidden="true" tabindex="-1"></a><span class="dt">hashes </span><span class="ot">=</span><span class="st"> dropbox,sha1</span></span>
+<span id="cb1408-11"><a href="#cb1408-11" aria-hidden="true" tabindex="-1"></a><span class="dt">max_age </span><span class="ot">=</span><span class="st"> 24h</span></span></code></pre></div>
<p>Hasher takes basically the following parameters:</p>
<ul>
<li><code>remote</code> is required</li>
@@ -45932,6 +47386,561 @@ single database. All local paths are treated as aliases into the
<code>local</code> backend (unless encrypted or chunked) and stored in
<code>~/.cache/rclone/kv/local~hasher.bolt</code>. Databases can be
shared between multiple rclone processes.</p>
+<h1 id="huawei-drive">Huawei Drive</h1>
+<p>Paths are specified as <code>huaweidrive:path</code></p>
+<p>Huawei Drive paths may be as deep as required, e.g.
+<code>huaweidrive:directory/subdirectory</code>.</p>
+<h2 id="configuration-25">Configuration</h2>
+<p>The initial setup for Huawei Drive involves getting a token from
+Huawei 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>
+<div class="sourceCode" id="cb1423"><pre
+class="sourceCode sh"><code class="sourceCode bash"><span id="cb1423-1"><a href="#cb1423-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config</span></code></pre></div>
+<p>This will guide you through an interactive setup process:</p>
+<pre class="text"><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 / Huawei Drive
+ \ &quot;huaweidrive&quot;
+[snip]
+Storage&gt; huaweidrive
+OAuth Client Id - leave blank to use rclone&#39;s default.
+client_id&gt;
+OAuth Client Secret - leave blank to use rclone&#39;s default.
+client_secret&gt;
+Remote config
+Use web browser to automatically authenticate rclone with remote?
+ * Say Y if the machine running rclone has a web browser you can use
+ * Say N if running rclone on a (remote) machine without web browser access
+If not sure try Y. If Y failed, try N.
+y) Yes
+n) No
+y/n&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
+Configuration complete.
+Options:
+- type: huaweidrive
+- 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;2024-03-16T13:57:58.955387075Z&quot;}
+Keep this &quot;remote&quot; remote?
+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 without an internet-connected
+web browser available.</p>
+<p>Note that rclone runs a webserver on your local machine to collect
+the token as returned from Huawei if using web browser to automatically
+authenticate. This only runs from the moment it opens your browser to
+the moment you get back the verification code. This is on
+<code>http://127.0.0.1:53682/</code> and 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>
+<div class="sourceCode" id="cb1425"><pre
+class="sourceCode sh"><code class="sourceCode bash"><span id="cb1425-1"><a href="#cb1425-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> lsd remote:</span></code></pre></div>
+<p>List all the files in your drive</p>
+<div class="sourceCode" id="cb1426"><pre
+class="sourceCode sh"><code class="sourceCode bash"><span id="cb1426-1"><a href="#cb1426-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> ls remote:</span></code></pre></div>
+<p>To copy a local directory to a drive directory called backup</p>
+<div class="sourceCode" id="cb1427"><pre
+class="sourceCode sh"><code class="sourceCode bash"><span id="cb1427-1"><a href="#cb1427-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> copy /home/source remote:backup</span></code></pre></div>
+<h3 id="getting-your-own-client-id-and-secret">Getting your own Client
+ID and Secret</h3>
+<p>When you use rclone with Huawei 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 Huawei.</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 a separate client ID for each service to avoid rate
+limiting issues.</p>
+<p>Here is how to create your own Huawei Drive client ID for rclone:</p>
+<p>Follow the detailed guides for complete setup instructions:</p>
+<ul>
+<li><a
+href="https://developer.huawei.com/consumer/cn/doc/HMSCore-Guides/web-preparations-0000001050050891">Huawei
+HMS Core Web App Preparations</a></li>
+<li><a
+href="https://developer.huawei.com/consumer/cn/doc/HMSCore-Guides/server-preparations-0000001050185577#section194911701377">Huawei
+HMS Core Server Preparations</a></li>
+</ul>
+<p>Rclone uses the web application access method to connect to Huawei
+Drive. Before starting, you need to implement quick login authorization
+through Huawei Account Open Service. With user authorization
+credentials, rclone can call Huawei Cloud Drive Service APIs.</p>
+<h4 id="create-server-application">Create Server Application</h4>
+<p>Before accessing Drive service, developers need to create a server
+application first. For details, please refer to the WEB Application
+Access Development Preparation section in the "Huawei Account Service
+Development Guide".</p>
+<h4 id="enable-drive-application-switch">Enable Drive Application
+Switch</h4>
+<ol type="1">
+<li>Log in to the AppGallery Connect website and click "My
+Projects".</li>
+<li>Find your project in the project list, select the application that
+needs to access Drive in the project, and click "API Management".</li>
+<li>In the "API Management" area of the "Project Settings" page, click
+the switch on the right side of Drive Kit to ensure the switch is in the
+open state.</li>
+</ol>
+<h4 id="sign-huawei-cloud-drive-privacy-notice-and-user-agreement">Sign
+Huawei Cloud Drive Privacy Notice and User Agreement</h4>
+<p>Guide users to visit <a href="https://cloud.huawei.com/"
+class="uri">https://cloud.huawei.com/</a>. First-time users need to sign
+the agreement before they can use Huawei Cloud Drive Service.</p>
+<h4
+id="application-access-to-obtain-authentication-credential-access-token">Application
+Access to Obtain Authentication Credential Access Token</h4>
+<p>Applications accessing Drive should use authentication credential
+Access Token. For specific acquisition methods, please refer to the WEB
+Application Access Development Guide section in the "Huawei Account
+Service Development Guide".</p>
+<p>Key steps summary:</p>
+<ol type="1">
+<li><p>Log into the <a
+href="https://developer.huawei.com/consumer/en/console">Huawei Developer
+Console</a> with your Huawei account.</p></li>
+<li><p>Create a new project or select an existing project.</p></li>
+<li><p>Go to "Manage APIs" and enable the "Drive Kit" API.</p></li>
+<li><p>Click on "Credentials" in the left side panel.</p></li>
+<li><p>Click "Create Credentials" and choose "OAuth client ID".</p></li>
+<li><p>Choose "Web application" as the application type.</p></li>
+<li><p>Add <code>http://localhost:53682/</code> to the "Authorized
+redirect URIs".</p></li>
+<li><p>Click "Create" and note down the Client ID and Client
+Secret.</p></li>
+<li><p>Provide the noted client ID and client secret to rclone during
+configuration.</p></li>
+</ol>
+<h3 id="scopes-1">Scopes</h3>
+<p>Rclone uses the following OAuth2 scopes when accessing Huawei
+Drive:</p>
+<ul>
+<li><code>https://www.huawei.com/auth/drive</code> - Full access to
+Huawei Drive files (excluding application data folder)</li>
+<li><code>https://www.huawei.com/auth/drive.file</code> - Access to
+files created by the application</li>
+<li><code>openid</code> - OpenID Connect authentication</li>
+<li><code>profile</code> - Access to basic profile information</li>
+</ul>
+<p>The <code>drive.file</code> scope is included in the default set used
+by rclone.</p>
+<p>Alternative scopes available (not used by rclone by default):</p>
+<ul>
+<li><code>https://www.huawei.com/auth/drive.appdata</code> - Access to
+application data folder</li>
+<li><code>https://www.huawei.com/auth/drive.readonly</code> - Read-only
+access to file metadata and content</li>
+<li><code>https://www.huawei.com/auth/drive.metadata</code> - Read/write
+access to file metadata only</li>
+<li><code>https://www.huawei.com/auth/drive.metadata.readonly</code> -
+Read-only access to file metadata only</li>
+</ul>
+<p>The default scopes provide read/write access to all files in your
+Huawei Drive.</p>
+<h3 id="modification-times-and-hashes-12">Modification times and
+hashes</h3>
+<p>Huawei Drive does not support setting modification times. The API
+always uses server-side timestamps, so file modification times from the
+source are not preserved during upload. Modification times are available
+as read-only metadata (<code>mtime</code>, <code>btime</code>).</p>
+<p>Hash algorithm SHA256 is supported for file integrity
+verification.</p>
+<h3 id="restricted-filename-characters-13">Restricted filename
+characters</h3>
+<p>Huawei Drive has strict restrictions on file and directory names:</p>
+<ul>
+<li>Cannot contain: <code>&lt; &gt; | : " * ? / \</code> or emoji
+characters</li>
+<li>Cannot be exactly <code>. ..</code></li>
+<li>Maximum length: 250 bytes</li>
+<li>Single quotes must be escaped with <code>\'</code> in API calls</li>
+</ul>
+<p>These restrictions are handled by rclone's encoding:</p>
+<ul>
+<li>Backslashes <code>\</code> are encoded</li>
+<li>Invalid UTF-8 sequences are encoded<br />
+</li>
+<li>Right-side spaces are encoded</li>
+</ul>
+<p>Invalid characters will be <a
+href="https://rclone.org/overview/#invalid-utf8">replaced</a> according
+to the encoding settings.</p>
+<h3 id="resumable-uploads">Resumable uploads</h3>
+<p>Huawei Drive supports resumable uploads for files larger than the
+upload cutoff (default 20MB). Files are uploaded in chunks which allows
+for recovery from network interruptions.</p>
+<h3 id="file-size-limits">File size limits</h3>
+<p>The maximum file size for Huawei Drive is 50 GiB.</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
+and quota information.</p>
+<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/huaweidrive/huaweidrive.go and run make backenddocs to verify -->
+<!-- markdownlint-disable-line line-length -->
+<h3 id="standard-options-26">Standard options</h3>
+<p>Here are the Standard options specific to huaweidrive (Huawei
+Drive).</p>
+<h4 id="huaweidrive-client-id">--huaweidrive-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_HUAWEIDRIVE_CLIENT_ID</li>
+<li>Type: string</li>
+<li>Required: false</li>
+</ul>
+<h4 id="huaweidrive-client-secret">--huaweidrive-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_HUAWEIDRIVE_CLIENT_SECRET</li>
+<li>Type: string</li>
+<li>Required: false</li>
+</ul>
+<h3 id="advanced-options-26">Advanced options</h3>
+<p>Here are the Advanced options specific to huaweidrive (Huawei
+Drive).</p>
+<h4 id="huaweidrive-token">--huaweidrive-token</h4>
+<p>OAuth Access Token as a JSON blob.</p>
+<p>Properties:</p>
+<ul>
+<li>Config: token</li>
+<li>Env Var: RCLONE_HUAWEIDRIVE_TOKEN</li>
+<li>Type: string</li>
+<li>Required: false</li>
+</ul>
+<h4 id="huaweidrive-auth-url">--huaweidrive-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_HUAWEIDRIVE_AUTH_URL</li>
+<li>Type: string</li>
+<li>Required: false</li>
+</ul>
+<h4 id="huaweidrive-token-url">--huaweidrive-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_HUAWEIDRIVE_TOKEN_URL</li>
+<li>Type: string</li>
+<li>Required: false</li>
+</ul>
+<h4
+id="huaweidrive-client-credentials">--huaweidrive-client-credentials</h4>
+<p>Use client credentials OAuth flow.</p>
+<p>This will use the OAUTH2 client Credentials Flow as described in RFC
+6749.</p>
+<p>Note that this option is NOT supported by all backends.</p>
+<p>Properties:</p>
+<ul>
+<li>Config: client_credentials</li>
+<li>Env Var: RCLONE_HUAWEIDRIVE_CLIENT_CREDENTIALS</li>
+<li>Type: bool</li>
+<li>Default: false</li>
+</ul>
+<h4 id="huaweidrive-root-folder-id">--huaweidrive-root-folder-id</h4>
+<p>ID of the root folder.</p>
+<p>Normally this is auto-detected, but if it fails or you want to speed
+up startup, you can set it manually.</p>
+<p>Leave blank normally.</p>
+<p>Properties:</p>
+<ul>
+<li>Config: root_folder_id</li>
+<li>Env Var: RCLONE_HUAWEIDRIVE_ROOT_FOLDER_ID</li>
+<li>Type: string</li>
+<li>Required: false</li>
+</ul>
+<h4 id="huaweidrive-chunk-size">--huaweidrive-chunk-size</h4>
+<p>Upload chunk size.</p>
+<p>Must be a power of 2 &gt;= 256k and &lt;= 64MB.</p>
+<p>Properties:</p>
+<ul>
+<li>Config: chunk_size</li>
+<li>Env Var: RCLONE_HUAWEIDRIVE_CHUNK_SIZE</li>
+<li>Type: SizeSuffix</li>
+<li>Default: 8Mi</li>
+</ul>
+<h4 id="huaweidrive-list-chunk">--huaweidrive-list-chunk</h4>
+<p>Size of listing chunk 1-1000.</p>
+<p>Properties:</p>
+<ul>
+<li>Config: list_chunk</li>
+<li>Env Var: RCLONE_HUAWEIDRIVE_LIST_CHUNK</li>
+<li>Type: int</li>
+<li>Default: 1000</li>
+</ul>
+<h4 id="huaweidrive-upload-cutoff">--huaweidrive-upload-cutoff</h4>
+<p>Cutoff for switching to resumable upload.</p>
+<p>Any files larger than this will be uploaded using resumable upload.
+The minimum is 0 and the maximum is 20 MiB (Huawei Drive API limit for
+single request uploads).</p>
+<p>Properties:</p>
+<ul>
+<li>Config: upload_cutoff</li>
+<li>Env Var: RCLONE_HUAWEIDRIVE_UPLOAD_CUTOFF</li>
+<li>Type: SizeSuffix</li>
+<li>Default: 20Mi</li>
+</ul>
+<h4 id="huaweidrive-encoding">--huaweidrive-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_HUAWEIDRIVE_ENCODING</li>
+<li>Type: Encoding</li>
+<li>Default:
+Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftSpace,LeftPeriod,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot</li>
+</ul>
+<h4 id="huaweidrive-description">--huaweidrive-description</h4>
+<p>Description of the remote.</p>
+<p>Properties:</p>
+<ul>
+<li>Config: description</li>
+<li>Env Var: RCLONE_HUAWEIDRIVE_DESCRIPTION</li>
+<li>Type: string</li>
+<li>Required: false</li>
+</ul>
+<h3 id="metadata-12">Metadata</h3>
+<p>Huawei Drive supports reading and writing custom metadata.</p>
+<p>User metadata can be set using the "properties" field in the API.
+System metadata includes standard file information such as: -
+content-type: MIME type of the object - description: User-provided
+description - favorite: Whether file is marked as favorite -
+btime/mtime/utime: Various timestamps - sha256: File hash -
+recycled/has-thumbnail: File status flags</p>
+<p>Custom metadata keys can be any string and will be stored in the
+file's properties.</p>
+<p>Here are the possible system metadata items for the huaweidrive
+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 when the file was created (RFC 3339)</td>
+<td>RFC 3339</td>
+<td></td>
+<td><strong>Y</strong></td>
+</tr>
+<tr class="even">
+<td>content-type</td>
+<td>MIME type of the object</td>
+<td>string</td>
+<td></td>
+<td><strong>Y</strong></td>
+</tr>
+<tr class="odd">
+<td>description</td>
+<td>Description of the file</td>
+<td>string</td>
+<td></td>
+<td>N</td>
+</tr>
+<tr class="even">
+<td>favorite</td>
+<td>Whether the file is marked as favorite (true/false)</td>
+<td>string</td>
+<td></td>
+<td>N</td>
+</tr>
+<tr class="odd">
+<td>has-thumbnail</td>
+<td>Whether the file has a thumbnail (true/false)</td>
+<td>string</td>
+<td></td>
+<td><strong>Y</strong></td>
+</tr>
+<tr class="even">
+<td>mtime</td>
+<td>Time when the file content was last modified (RFC 3339)</td>
+<td>RFC 3339</td>
+<td></td>
+<td><strong>Y</strong></td>
+</tr>
+<tr class="odd">
+<td>recycled</td>
+<td>Whether the file is in recycle bin (true/false)</td>
+<td>string</td>
+<td></td>
+<td><strong>Y</strong></td>
+</tr>
+<tr class="even">
+<td>sha256</td>
+<td>SHA256 hash of the file</td>
+<td>string</td>
+<td></td>
+<td><strong>Y</strong></td>
+</tr>
+<tr class="odd">
+<td>utime</td>
+<td>Time when the file was last edited by the current user (RFC
+3339)</td>
+<td>RFC 3339</td>
+<td></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>
+<!-- autogenerated options stop -->
+<h2 id="limitations-19">Limitations</h2>
+<p>Huawei Drive has some rate limiting which may cause rclone to slow
+down transfers to avoid hitting the limits.</p>
+<h3 id="file-name-restrictions">File name restrictions</h3>
+<ul>
+<li>File names cannot contain: <code>&lt; &gt; | : " * ? / \</code></li>
+<li>File names cannot be exactly <code>. ..</code></li>
+<li>Maximum file name length is 250 bytes</li>
+<li>Some unicode characters including emojis are not supported</li>
+</ul>
+<h3 id="api-rate-limits">API rate limits</h3>
+<p>Huawei Drive imposes API rate limits. Rclone automatically handles
+these by backing off when limits are hit.</p>
+<h3 id="oauth2-token-expiry">OAuth2 token expiry</h3>
+<ul>
+<li>Access tokens expire after 1 hour</li>
+<li>Refresh tokens expire after 180 days<br />
+</li>
+<li>Rclone will automatically refresh tokens as needed</li>
+</ul>
+<h3 id="file-size-limits-1">File size limits</h3>
+<ul>
+<li>Maximum file size is 50 GiB</li>
+<li>Files larger than this cannot be uploaded</li>
+</ul>
+<h3 id="upload-behavior">Upload behavior</h3>
+<ul>
+<li>Files smaller than <code>upload_cutoff</code> (default 20MB) are
+uploaded in a single request using content or multipart method</li>
+<li>Larger files are uploaded using resumable uploads with configurable
+chunk size</li>
+<li>Maximum single chunk size for resumable uploads is 64MB</li>
+<li>Resumable uploads support automatic retry on network errors</li>
+<li>SHA256 hash verification is supported for uploaded files</li>
+</ul>
+<h3 id="server-side-operations">Server-side operations</h3>
+<ul>
+<li>Server-side copy: Files can be copied within Huawei Drive without
+downloading and re-uploading</li>
+<li>Server-side move: Files and directories can be moved/renamed on the
+server side</li>
+<li>Directory move: Entire directories can be moved with a single API
+call</li>
+</ul>
+<h3 id="directory-operations">Directory operations</h3>
+<ul>
+<li>Huawei Drive supports creating empty directories</li>
+<li>Recursive listing is supported via <code>--fast-list</code> for
+efficient directory traversal</li>
+<li>Huawei Drive has a special "applicationData" folder for app-specific
+data (not accessible via rclone's default configuration)</li>
+</ul>
+<h2 id="error-handling-1">Error handling</h2>
+<p>Common errors and their meanings:</p>
+<ul>
+<li><code>401 Unauthorized</code>: Invalid credentials or expired
+token</li>
+<li><code>403 Forbidden</code>: Usually indicates insufficient
+permissions or API quota exceeded</li>
+<li><code>404 Not Found</code>: File or directory does not exist</li>
+<li><code>409 Conflict</code>: Directory already exists</li>
+<li><code>429 Too Many Requests</code>: API rate limit exceeded, rclone
+will automatically retry</li>
+</ul>
+<h2 id="performance-tuning">Performance tuning</h2>
+<p>For better performance:</p>
+<ul>
+<li>Increase <code>--transfers</code> for concurrent operations (default
+is 4)</li>
+<li>Adjust <code>chunk_size</code> based on your network speed and file
+sizes</li>
+<li>Use <code>--fast-list</code> for operations on directories with many
+files to reduce API calls</li>
+</ul>
+<h2 id="making-backups">Making backups</h2>
+<p>Huawei Drive is suitable for backups with some considerations:</p>
+<ul>
+<li>Use <code>rclone sync</code> rather than <code>rclone copy</code> to
+maintain exact directory structure</li>
+<li>Consider using <code>--backup-dir</code> to preserve deleted
+files</li>
+<li>Verify transfers with <code>--checksum</code> flag for critical
+data</li>
+<li>Be aware of the 50 GiB file size limit for individual files</li>
+</ul>
+<h2 id="supported-features">Supported features</h2>
+<p>Huawei Drive supports the following rclone features:</p>
+<ul>
+<li><code>Copy</code> - Server-side copy of files</li>
+<li><code>Move</code> - Server-side move/rename of files</li>
+<li><code>DirMove</code> - Server-side move of directories</li>
+<li><code>ListR</code> - Recursive listing for
+<code>--fast-list</code></li>
+<li><code>About</code> - Storage quota information</li>
+<li><code>Purge</code> - Delete directory and all contents</li>
+<li><code>CleanUp</code> - Empty the trash</li>
+<li><code>UserInfo</code> - Get user account information</li>
+<li><code>Metadata</code> - Read and write file metadata/properties</li>
+<li><code>ChangeNotify</code> - Poll for remote changes (used by
+<code>rclone mount</code> and
+<code>rclone rc vfs/poll-interval</code>)</li>
+</ul>
+<h2 id="integration-with-other-services">Integration with other
+services</h2>
+<p>Huawei Drive can be used as a backend for various rclone
+operations:</p>
+<ul>
+<li>Mount as a local filesystem using <code>rclone mount</code></li>
+<li>Serve over HTTP using <code>rclone serve http</code></li>
+<li>Serve over FTP using <code>rclone serve ftp</code></li>
+<li>Serve over WebDAV using <code>rclone serve webdav</code></li>
+</ul>
+<p>Note that some operations may be slower than local storage due to API
+limitations and network latency.</p>
<h1 id="hdfs">HDFS</h1>
<p><a
href="https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-hdfs/HdfsDesign.html">HDFS</a>
@@ -45939,7 +47948,7 @@ 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-25">Configuration</h2>
+<h2 id="configuration-26">Configuration</h2>
<p>Here is an example of how to make a remote called
<code>remote</code>. First run:</p>
<pre class="console"><code>rclone config</code></pre>
@@ -46024,11 +48033,11 @@ docker build --rm -t rclone/test-hdfs .</code></pre>
<p><strong>NB</strong> it need few seconds to startup.</p>
<p>For this docker image the remote needs to be configured like
this:</p>
-<div class="sourceCode" id="cb1397"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1397-1"><a href="#cb1397-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[remote]</span></span>
-<span id="cb1397-2"><a href="#cb1397-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> hdfs</span></span>
-<span id="cb1397-3"><a href="#cb1397-3" aria-hidden="true" tabindex="-1"></a><span class="dt">namenode </span><span class="ot">=</span><span class="st"> 127.0.0.1:8020</span></span>
-<span id="cb1397-4"><a href="#cb1397-4" aria-hidden="true" tabindex="-1"></a><span class="dt">username </span><span class="ot">=</span><span class="st"> root</span></span></code></pre></div>
+<div class="sourceCode" id="cb1435"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1435-1"><a href="#cb1435-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[remote]</span></span>
+<span id="cb1435-2"><a href="#cb1435-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> hdfs</span></span>
+<span id="cb1435-3"><a href="#cb1435-3" aria-hidden="true" tabindex="-1"></a><span class="dt">namenode </span><span class="ot">=</span><span class="st"> 127.0.0.1:8020</span></span>
+<span id="cb1435-4"><a href="#cb1435-4" aria-hidden="true" tabindex="-1"></a><span class="dt">username </span><span class="ot">=</span><span class="st"> root</span></span></code></pre></div>
<p>You can stop this image with <code>docker kill rclone-hdfs</code>
(<strong>NB</strong> it does not use volumes, so all data uploaded will
be lost.)</p>
@@ -46039,7 +48048,7 @@ be lost.)</p>
<h3 id="usage-information">Usage information</h3>
<p>You can use the <code>rclone about remote:</code> command which will
display filesystem size and current usage.</p>
-<h3 id="restricted-filename-characters-13">Restricted filename
+<h3 id="restricted-filename-characters-14">Restricted filename
characters</h3>
<p>In addition to the <a
href="https://rclone.org/overview/#restricted-characters">default
@@ -46065,7 +48074,7 @@ replaced:</p>
href="https://rclone.org/overview/#invalid-utf8">replaced</a>.</p>
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/hdfs/hdfs.go and run make backenddocs to verify -->
<!-- markdownlint-disable-line line-length -->
-<h3 id="standard-options-26">Standard options</h3>
+<h3 id="standard-options-27">Standard options</h3>
<p>Here are the Standard options specific to hdfs (Hadoop distributed
file system).</p>
<h4 id="hdfs-namenode">--hdfs-namenode</h4>
@@ -46095,7 +48104,7 @@ namenodes at port 8020.</p>
</ul></li>
</ul></li>
</ul>
-<h3 id="advanced-options-26">Advanced options</h3>
+<h3 id="advanced-options-27">Advanced options</h3>
<p>Here are the Advanced options specific to hdfs (Hadoop distributed
file system).</p>
<h4 id="hdfs-service-principal-name">--hdfs-service-principal-name</h4>
@@ -46154,7 +48163,7 @@ section in the overview</a> for more info.</p>
<li>Required: false</li>
</ul>
<!-- autogenerated options stop -->
-<h2 id="limitations-19">Limitations</h2>
+<h2 id="limitations-20">Limitations</h2>
<ul>
<li>Erasure coding not supported, see <a
href="https://github.com/rclone/rclone/issues/8808">issue #8808</a></li>
@@ -46168,7 +48177,7 @@ href="https://github.com/rclone/rclone/issues/8808">issue #8808</a></li>
<p>The initial setup for hidrive involves getting a token from HiDrive
which you need to do in your browser. <code>rclone config</code> walks
you through it.</p>
-<h2 id="configuration-26">Configuration</h2>
+<h2 id="configuration-27">Configuration</h2>
<p>Here is an example of how to make a remote called
<code>remote</code>. First run:</p>
<pre class="console"><code>rclone config</code></pre>
@@ -46262,14 +48271,14 @@ account again.</p>
<pre class="console"><code>rclone config reconnect remote:</code></pre>
<p>the process is very similar to the process of initial setup
exemplified before.</p>
-<h3 id="modification-times-and-hashes-12">Modification times and
+<h3 id="modification-times-and-hashes-13">Modification times and
hashes</h3>
<p>HiDrive allows modification times to be set on objects accurate to 1
second.</p>
<p>HiDrive supports <a href="https://static.hidrive.com/dev/0001">its
own hash type</a> which is used to verify the integrity of file contents
after successful transfers.</p>
-<h3 id="restricted-filename-characters-14">Restricted filename
+<h3 id="restricted-filename-characters-15">Restricted filename
characters</h3>
<p>HiDrive cannot store files or folders that include <code>/</code>
(0x2F) or null-bytes (0x00) in their name. Any other characters can be
@@ -46328,7 +48337,7 @@ information is not explicitly needed. For this, the
details.</p>
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/hidrive/hidrive.go and run make backenddocs to verify -->
<!-- markdownlint-disable-line line-length -->
-<h3 id="standard-options-27">Standard options</h3>
+<h3 id="standard-options-28">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>
@@ -46371,7 +48380,7 @@ HiDrive.</p>
</ul></li>
</ul></li>
</ul>
-<h3 id="advanced-options-27">Advanced options</h3>
+<h3 id="advanced-options-28">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>
@@ -46563,7 +48572,7 @@ section in the overview</a> for more info.</p>
<li>Required: false</li>
</ul>
<!-- autogenerated options stop -->
-<h2 id="limitations-20">Limitations</h2>
+<h2 id="limitations-21">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>
@@ -46612,7 +48621,7 @@ 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-27">Configuration</h2>
+<h2 id="configuration-28">Configuration</h2>
<p>Here is an example of how to make a remote called
<code>remote</code>. First run:</p>
<pre class="console"><code>rclone config</code></pre>
@@ -46683,7 +48692,7 @@ without a config file:</p>
<pre class="console"><code>rclone lsd :http,url=&#39;https://beta.rclone.org&#39;:</code></pre>
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/http/http.go and run make backenddocs to verify -->
<!-- markdownlint-disable-line line-length -->
-<h3 id="standard-options-28">Standard options</h3>
+<h3 id="standard-options-29">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>
@@ -46705,7 +48714,7 @@ a username and password.</p>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
-<h3 id="advanced-options-28">Advanced options</h3>
+<h3 id="advanced-options-29">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>
@@ -46772,7 +48781,7 @@ may be in the listing.</p>
<li>Type: string</li>
<li>Required: false</li>
</ul>
-<h3 id="metadata-12">Metadata</h3>
+<h3 id="metadata-13">Metadata</h3>
<p>HTTP metadata keys are case insensitive and are always returned in
lower case.</p>
<p>Here are the possible system metadata items for the http backend.</p>
@@ -46865,7 +48874,7 @@ with the new parameters. Only new parameters need be passed as the
values will default to those currently in use.</p>
<p>It doesn't return anything.</p>
<!-- autogenerated options stop -->
-<h2 id="limitations-21">Limitations</h2>
+<h2 id="limitations-22">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
@@ -46885,7 +48894,7 @@ href="https://imagekit.io/registration/">create an account</a> on
ImageKit. Start with a free plan with generous usage limits. Then, as
your requirements grow, upgrade to a plan that best fits your needs. See
<a href="https://imagekit.io/plans">the pricing details</a>.</p>
-<h2 id="configuration-28">Configuration</h2>
+<h2 id="configuration-29">Configuration</h2>
<p>Here is an example of making an imagekit configuration.</p>
<p>Firstly create a <a href="https://imagekit.io/">ImageKit.io</a>
account and choose a plan.</p>
@@ -46956,7 +48965,7 @@ y/e/d&gt; y</code></pre>
<p>No checksums are supported.</p>
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/imagekit/imagekit.go and run make backenddocs to verify -->
<!-- markdownlint-disable-line line-length -->
-<h3 id="standard-options-29">Standard options</h3>
+<h3 id="standard-options-30">Standard options</h3>
<p>Here are the Standard options specific to imagekit (ImageKit.io).</p>
<h4 id="imagekit-endpoint">--imagekit-endpoint</h4>
<p>You can find your ImageKit.io URL endpoint in your <a
@@ -46988,7 +48997,7 @@ href="https://imagekit.io/dashboard/developer/api-keys">dashboard</a></p>
<li>Type: string</li>
<li>Required: true</li>
</ul>
-<h3 id="advanced-options-29">Advanced options</h3>
+<h3 id="advanced-options-30">Advanced options</h3>
<p>Here are the Advanced options specific to imagekit (ImageKit.io).</p>
<h4 id="imagekit-only-signed">--imagekit-only-signed</h4>
<p>If you have configured <code>Restrict unsigned image URLs</code> in
@@ -47039,7 +49048,7 @@ Slash,LtGt,DoubleQuote,Dollar,Question,Hash,Percent,BackSlash,Del,Ctl,InvalidUtf
<li>Type: string</li>
<li>Required: false</li>
</ul>
-<h3 id="metadata-13">Metadata</h3>
+<h3 id="metadata-14">Metadata</h3>
<p>Any metadata supported by the underlying remote is read and
written.</p>
<p>Here are the possible system metadata items for the imagekit
@@ -47145,20 +49154,43 @@ image</td>
<p>See the <a href="https://rclone.org/docs/#metadata">metadata</a> docs
for more info.</p>
<!-- autogenerated options stop -->
-<h1 id="icloud-drive">iCloud Drive</h1>
-<h2 id="configuration-29">Configuration</h2>
-<p>The initial setup for an iCloud Drive backend involves getting a
-trust token/session. This can be done by simply using the regular iCloud
-password, and accepting the code prompt on another iCloud connected
-device.</p>
-<p><strong>IMPORTANT</strong>: At the moment an app specific password
-won't be accepted. Only use your regular password and 2FA.</p>
+<h1 id="icloud-drive-and-photos">iCloud Drive and Photos</h1>
+<h2 id="configuration-30">Configuration</h2>
+<p>The initial setup for an iCloud backend involves getting a trust
+token/session. This uses your regular Apple ID password plus 2FA, either
+from a trusted device prompt or an SMS code sent to a trusted phone
+number.</p>
+<p><strong>IMPORTANT</strong>: App-specific passwords are not accepted.
+Only use your regular Apple ID password and 2FA.</p>
+<p>This backend serves two Apple services:</p>
+<ul>
+<li><code>drive</code> - iCloud Drive (default)</li>
+<li><code>photos</code> - iCloud Photos</li>
+</ul>
<p><code>rclone config</code> walks you through the token creation. The
trust token is valid for 30 days. After which you will have to
reauthenticate with <code>rclone reconnect</code> or
<code>rclone config</code>.</p>
-<p>Here is an example of how to make a remote called
-<code>iclouddrive</code>. First run:</p>
+<h2 id="authentication-7">Authentication</h2>
+<p>rclone authenticates with Apple using <a
+href="https://en.wikipedia.org/wiki/Secure_Remote_Password_protocol">SRP
+(Secure Remote Password)</a>, the same protocol used by the iCloud web
+interface. Your password is never sent to Apple's servers -- instead, a
+cryptographic proof is exchanged that verifies you know the password
+without revealing it.</p>
+<p>The authentication flow is:</p>
+<ol type="1">
+<li>rclone initiates a session with Apple's identity service</li>
+<li>An SRP key exchange takes place (your password is used locally to
+derive a key)</li>
+<li>Apple sends a 2FA prompt to your trusted devices, or lets you
+request an SMS code</li>
+<li>After you enter the 2FA code, rclone receives a trust token for
+future sessions</li>
+</ol>
+<p>Here is an example of how to make a Photos remote called
+<code>icloudphotos</code>. For iCloud Drive, leave <code>service</code>
+at its default <code>drive</code> value. First run:</p>
<pre class="console"><code>rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
<pre class="text"><code>No remotes found, make a new one?
@@ -47166,7 +49198,7 @@ n) New remote
s) Set configuration password
q) Quit config
n/s/q&gt; n
-name&gt; iclouddrive
+name&gt; icloudphotos
Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
@@ -47175,6 +49207,15 @@ XX / iCloud Drive
\ (iclouddrive)
[snip]
Storage&gt; iclouddrive
+Option service.
+iCloud service to use.
+Choose a number from below, or type in your own value of type string.
+Press Enter for the default (drive).
+ 1 / iCloud Drive
+ \ (drive)
+ 2 / iCloud Photos
+ \ (photos)
+service&gt; 2
Option apple_id.
Apple ID.
Enter a value.
@@ -47194,13 +49235,14 @@ y) Yes
n) No (default)
y/n&gt; n
Option config_2fa.
-Two-factor authentication: please enter your 2FA code
+Two-factor authentication: enter your 2FA code or type &#39;sms&#39; for a text message
Enter a value.
config_2fa&gt; 2FACODE
Remote config
--------------------
-[iclouddrive]
+[icloudphotos]
- type: iclouddrive
+- service: photos
- apple_id: APPLEID
- password: *** ENCRYPTED ***
- cookies: ****************************
@@ -47210,31 +49252,133 @@ y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
+<h2 id="icloud-photos">iCloud Photos</h2>
+<p>The iCloud Drive backend also supports accessing iCloud Photos by
+setting the <code>service</code> option to <code>photos</code>:</p>
+<pre class="console"><code>rclone lsd iclouddrive: --iclouddrive-service photos</code></pre>
+<p>This presents a read-only hierarchy rooted at photo libraries:</p>
+<ul>
+<li><strong>Level 1</strong>: Photo libraries — your personal library
+(<code>PrimarySync</code>) and any Shared Photo Library
+(<code>SharedSync-XXXX</code>)</li>
+<li><strong>Level 2+</strong>: Albums and folders within a library,
+nested recursively as in Apple Photos</li>
+<li><strong>Leaf level</strong>: Photos/videos within an album,
+including Live Photo <code>.MOV</code> companions</li>
+</ul>
+<p>Examples:</p>
+<pre class="console"><code># List libraries
+rclone lsd iclouddrive: --iclouddrive-service photos
+
+# List albums in your primary library
+rclone lsd iclouddrive:PrimarySync/ --iclouddrive-service photos
+
+# List photos in an album
+rclone ls iclouddrive:PrimarySync/All\ Photos/ --iclouddrive-service photos
+
+# Download a photo
+rclone copy iclouddrive:PrimarySync/Favorites/IMG_0001.HEIC /tmp/ --iclouddrive-service photos</code></pre>
+<p>You can either:</p>
+<ul>
+<li>set <code>service = photos</code> in <code>rclone config</code> for
+a dedicated Photos remote</li>
+<li>keep <code>service = drive</code> and pass
+<code>--iclouddrive-service photos</code> when needed</li>
+</ul>
+<h3 id="metadata-15">Metadata</h3>
+<p>With <code>--metadata</code>, Photos entries expose these read-only
+metadata keys:</p>
+<ul>
+<li><code>width</code></li>
+<li><code>height</code></li>
+<li><code>added-time</code></li>
+<li><code>favorite</code></li>
+<li><code>hidden</code></li>
+</ul>
+<p>These metadata keys are only available when
+<code>service = photos</code>.</p>
+<h3 id="caching">Caching</h3>
+<p>iCloud Photos caches album listings to disk for fast subsequent
+access. On the first run, listing a large album uses parallel
+<code>startRank</code> partitions to fetch pages concurrently. After
+that, a lightweight change check (~200ms) determines whether the cache
+is still valid.</p>
+<p>Cache location:
+<code>~/.cache/rclone/iclouddrive-photos/&lt;remote&gt;/&lt;zone&gt;/</code></p>
+<p>To clear the cache: delete that directory or run
+<code>rclone config reconnect</code>.</p>
+<h3 id="fuse-mounts">FUSE mounts</h3>
+<p>For mounting iCloud Photos via <code>rclone mount</code>, the
+following flags are recommended:</p>
+<pre><code>rclone mount remote: /mnt/photos \
+ --iclouddrive-service photos \
+ --vfs-refresh \
+ --dir-cache-time 1h \
+ --vfs-cache-mode full \
+ --attr-timeout 1m \
+ --read-only</code></pre>
+<ul>
+<li><code>--vfs-refresh</code> pre-warms directory caches in the
+background on mount start so that albums are ready when you browse
+them</li>
+<li><code>--dir-cache-time 1h</code> extends the in-memory cache
+lifetime beyond the default 5 minutes (change detection is fast, so this
+is safe)</li>
+<li><code>--vfs-cache-mode full</code> caches downloaded photos and
+videos to local disk for fast repeated access</li>
+<li><code>--attr-timeout 1m</code> reduces kernel attribute lookups
+(safe because the backend is read-only)</li>
+<li><code>--read-only</code> prevents confusing write errors</li>
+</ul>
+<p>The first listing of a very large album (e.g. 75,000 items in "All
+Photos") can take several minutes due to API pagination limits. This
+happens once — subsequent listings use the disk cache.</p>
+<h3 id="limitations-23">Limitations</h3>
+<p>iCloud Photos is read-only. Upload, delete, rename, and move
+operations are not supported.</p>
<h2 id="advanced-data-protection">Advanced Data Protection</h2>
-<p>ADP is currently unsupported and need to be disabled</p>
+<p>Advanced Data Protection is supported.</p>
<p>On iPhone, Settings <code>&gt;</code> Apple Account <code>&gt;</code>
-iCloud <code>&gt;</code> 'Access iCloud Data on the Web' must be ON, and
-'Advanced Data Protection' OFF.</p>
+iCloud <code>&gt;</code> 'Access iCloud Data on the Web' must be ON.</p>
+<p>If ADP is enabled on your account, rclone requests PCS cookies after
+2FA. Apple may require approval on a trusted device before those cookies
+are issued.</p>
<h2 id="troubleshooting-2">Troubleshooting</h2>
-<h3 id="missing-pcs-cookies-from-the-request">Missing PCS cookies from
-the request</h3>
-<p>This means you have Advanced Data Protection (ADP) turned on. This is
-not supported at the moment. If you want to use rclone you will have to
-turn it off. See above for how to turn it off.</p>
-<p>You will need to clear the <code>cookies</code> and the
-<code>trust_token</code> fields in the config. Or you can delete the
-remote config and start again.</p>
-<p>You should then run <code>rclone reconnect remote:</code>.</p>
-<p>Note that changing the ADP setting may not take effect immediately -
-you may need to wait a few hours or a day before you can get rclone to
-work - keep clearing the config entry and running
-<code>rclone reconnect remote:</code> until rclone functions
-properly.</p>
+<h3 id="pcs-cookie-errors-with-adp">PCS cookie errors with ADP</h3>
+<p>If you see <code>Missing PCS cookies from the request</code> or a
+<code>requestPCS:</code> error, the ADP approval flow did not complete
+successfully.</p>
+<p>Check that 'Access iCloud Data on the Web' is enabled and approve any
+prompt on your trusted device.</p>
+<p>Then run <code>rclone reconnect remote:</code>.</p>
+<p>If the remote still has stale auth state, clear the
+<code>cookies</code> and <code>trust_token</code> fields in the config,
+or delete and recreate the remote.</p>
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/iclouddrive/iclouddrive.go and run make backenddocs to verify -->
<!-- markdownlint-disable-line line-length -->
-<h3 id="standard-options-30">Standard options</h3>
-<p>Here are the Standard options specific to iclouddrive (iCloud
-Drive).</p>
+<h3 id="standard-options-31">Standard options</h3>
+<p>Here are the Standard options specific to iclouddrive (iCloud Drive
+and Photos).</p>
+<h4 id="iclouddrive-service">--iclouddrive-service</h4>
+<p>iCloud service to use.</p>
+<p>Properties:</p>
+<ul>
+<li>Config: service</li>
+<li>Env Var: RCLONE_ICLOUDDRIVE_SERVICE</li>
+<li>Type: string</li>
+<li>Default: "drive"</li>
+<li>Examples:
+<ul>
+<li>"drive"
+<ul>
+<li>iCloud Drive</li>
+</ul></li>
+<li>"photos"
+<ul>
+<li>iCloud Photos</li>
+</ul></li>
+</ul></li>
+</ul>
<h4 id="iclouddrive-apple-id">--iclouddrive-apple-id</h4>
<p>Apple ID.</p>
<p>Properties:</p>
@@ -47257,7 +49401,7 @@ obscure</a>.</p>
<li>Required: true</li>
</ul>
<h4 id="iclouddrive-trust-token">--iclouddrive-trust-token</h4>
-<p>Trust token (internal use)</p>
+<p>Trust token for session authentication.</p>
<p>Properties:</p>
<ul>
<li>Config: trust_token</li>
@@ -47266,7 +49410,7 @@ obscure</a>.</p>
<li>Required: false</li>
</ul>
<h4 id="iclouddrive-cookies">--iclouddrive-cookies</h4>
-<p>cookies (internal use only)</p>
+<p>Session cookies.</p>
<p>Properties:</p>
<ul>
<li>Config: cookies</li>
@@ -47274,11 +49418,11 @@ obscure</a>.</p>
<li>Type: string</li>
<li>Required: false</li>
</ul>
-<h3 id="advanced-options-30">Advanced options</h3>
-<p>Here are the Advanced options specific to iclouddrive (iCloud
-Drive).</p>
+<h3 id="advanced-options-31">Advanced options</h3>
+<p>Here are the Advanced options specific to iclouddrive (iCloud Drive
+and Photos).</p>
<h4 id="iclouddrive-client-id">--iclouddrive-client-id</h4>
-<p>Client id</p>
+<p>Client ID for iCloud API access.</p>
<p>Properties:</p>
<ul>
<li>Config: client_id</li>
@@ -47307,6 +49451,67 @@ section in the overview</a> for more info.</p>
<li>Type: string</li>
<li>Required: false</li>
</ul>
+<h3 id="metadata-16">Metadata</h3>
+<p>Metadata is read-only and available for the Photos service only.</p>
+<p>Here are the possible system metadata items for the iclouddrive
+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>added-time</td>
+<td>Time the item was added to the iCloud library</td>
+<td>RFC 3339</td>
+<td>2006-01-02T15:04:05Z</td>
+<td><strong>Y</strong></td>
+</tr>
+<tr class="even">
+<td>favorite</td>
+<td>Whether the item is marked as favorite</td>
+<td>bool</td>
+<td></td>
+<td><strong>Y</strong></td>
+</tr>
+<tr class="odd">
+<td>height</td>
+<td>Image height in pixels</td>
+<td>int</td>
+<td></td>
+<td><strong>Y</strong></td>
+</tr>
+<tr class="even">
+<td>hidden</td>
+<td>Whether the item is hidden</td>
+<td>bool</td>
+<td></td>
+<td><strong>Y</strong></td>
+</tr>
+<tr class="odd">
+<td>width</td>
+<td>Image width in pixels</td>
+<td>int</td>
+<td></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>
<!-- autogenerated options stop -->
<h1 id="internet-archive">Internet Archive</h1>
<p>The Internet Archive backend utilizes Items on <a
@@ -47387,7 +49592,7 @@ filtering</a>.</p>
<p>Which excludes from the sync any files which have the
<code>source=metadata</code> or <code>format=Metadata</code> flags which
are added to Internet Archive auto-created files.</p>
-<h2 id="configuration-30">Configuration</h2>
+<h2 id="configuration-31">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>
@@ -47460,7 +49665,7 @@ d) Delete this remote
y/e/d&gt; y</code></pre>
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/internetarchive/internetarchive.go and run make backenddocs to verify -->
<!-- markdownlint-disable-line line-length -->
-<h3 id="standard-options-31">Standard options</h3>
+<h3 id="standard-options-32">Standard options</h3>
<p>Here are the Standard options specific to internetarchive (Internet
Archive).</p>
<h4
@@ -47500,7 +49705,7 @@ infrastructure.</p>
<li>Type: bool</li>
<li>Default: true</li>
</ul>
-<h3 id="advanced-options-31">Advanced options</h3>
+<h3 id="advanced-options-32">Advanced options</h3>
<p>Here are the Advanced options specific to internetarchive (Internet
Archive).</p>
<h4 id="internetarchive-endpoint">--internetarchive-endpoint</h4>
@@ -47583,7 +49788,7 @@ section in the overview</a> for more info.</p>
<li>Type: string</li>
<li>Required: false</li>
</ul>
-<h3 id="metadata-14">Metadata</h3>
+<h3 id="metadata-17">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>
@@ -47720,13 +49925,13 @@ encrypted cloud storage service.</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="limitations-22">Limitations</h2>
+<h2 id="limitations-24">Limitations</h2>
<p><strong>Note:</strong> The Internxt backend may not work with all
account types. Please refer to <a
href="https://internxt.com/pricing">Internxt plan details</a> or contact
<a href="https://help.internxt.com">Internxt support</a> to verify
rclone compatibility with your subscription.</p>
-<h2 id="configuration-31">Configuration</h2>
+<h2 id="configuration-32">Configuration</h2>
<p>Here is an example of how to make a remote called
<code>internxt</code>. Run <code>rclone config</code> and follow the
prompts:</p>
@@ -47794,20 +49999,20 @@ rclone mount internxt: /path/to/mountpoint
# Check storage usage
rclone about internxt:</code></pre>
-<h3 id="modification-times-and-hashes-13">Modification times and
+<h3 id="modification-times-and-hashes-14">Modification times and
hashes</h3>
<p>The Internxt backend does not support hashes.</p>
<p>Modification times are read from the server but cannot be set. The
backend reports <code>ModTimeNotSupported</code> precision, so
modification times will not be used for sync comparisons.</p>
-<h3 id="restricted-filename-characters-15">Restricted filename
+<h3 id="restricted-filename-characters-16">Restricted filename
characters</h3>
<p>The Internxt backend replaces the <a
href="https://rclone.org/overview/#restricted-characters">default
restricted characters set</a>.</p>
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/internxt/internxt.go and run make backenddocs to verify -->
<!-- markdownlint-disable-line line-length -->
-<h3 id="standard-options-32">Standard options</h3>
+<h3 id="standard-options-33">Standard options</h3>
<p>Here are the Standard options specific to internxt (Internxt
Drive).</p>
<h4 id="internxt-email">--internxt-email</h4>
@@ -47831,7 +50036,7 @@ obscure</a>.</p>
<li>Type: string</li>
<li>Required: true</li>
</ul>
-<h3 id="advanced-options-32">Advanced options</h3>
+<h3 id="advanced-options-33">Advanced options</h3>
<p>Here are the Advanced options specific to internxt (Internxt
Drive).</p>
<h4 id="internxt-mnemonic">--internxt-mnemonic</h4>
@@ -47855,6 +50060,41 @@ validation.</p>
<li>Type: bool</li>
<li>Default: true</li>
</ul>
+<h4 id="internxt-upload-concurrency">--internxt-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>Note that each chunk is buffered in memory.</p>
+<p>Properties:</p>
+<ul>
+<li>Config: upload_concurrency</li>
+<li>Env Var: RCLONE_INTERNXT_UPLOAD_CONCURRENCY</li>
+<li>Type: int</li>
+<li>Default: 4</li>
+</ul>
+<h4 id="internxt-upload-cutoff">--internxt-upload-cutoff</h4>
+<p>Cutoff for switching to multipart upload.</p>
+<p>Any files larger than this will be uploaded in chunks of chunk_size.
+The minimum is 100 MiB and the maximum is 5 GiB.</p>
+<p>Properties:</p>
+<ul>
+<li>Config: upload_cutoff</li>
+<li>Env Var: RCLONE_INTERNXT_UPLOAD_CUTOFF</li>
+<li>Type: SizeSuffix</li>
+<li>Default: 100Mi</li>
+</ul>
+<h4 id="internxt-chunk-size">--internxt-chunk-size</h4>
+<p>Chunk size for multipart uploads.</p>
+<p>Files larger than upload_cutoff will be uploaded in chunks of this
+size.</p>
+<p>Memory usage is approximately chunk_size * upload_concurrency.</p>
+<p>Properties:</p>
+<ul>
+<li>Config: chunk_size</li>
+<li>Env Var: RCLONE_INTERNXT_CHUNK_SIZE</li>
+<li>Type: SizeSuffix</li>
+<li>Default: 30Mi</li>
+</ul>
<h4 id="internxt-encoding">--internxt-encoding</h4>
<p>The encoding for the backend.</p>
<p>See the <a href="https://rclone.org/overview/#encoding">encoding
@@ -47883,7 +50123,7 @@ company, using its own datacenters in Norway.</p>
href="https://www.jottacloud.com/">jottacloud.com</a>, it also provides
white-label solutions to different companies. The following are
currently supported by this backend, using a different authentication
-setup as described <a href="#whitelabel-authentication">below</a>:</p>
+setup as described <a href="#traditional">below</a>:</p>
<ul>
<li>Elkjøp (with subsidiaries):
<ul>
@@ -47915,7 +50155,7 @@ setup as described <a href="#whitelabel-authentication">below</a>:</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-7">Authentication</h2>
+<h2 id="authentication-8">Authentication</h2>
<p>Authentication in Jottacloud is in general based on OAuth and OpenID
Connect (OIDC). There are different variants to choose from, depending
on which service you are using, e.g. a white-label service may only
@@ -48044,7 +50284,7 @@ migrated to the newer methods, some white-label versions (those from
Elkjøp) still used this legacy method for a long time. Currently there
are no known uses of this, it is still supported by rclone, but the
support will be removed in a future version.</p>
-<h2 id="configuration-32">Configuration</h2>
+<h2 id="configuration-33">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 class="console"><code>rclone config</code></pre>
@@ -48183,7 +50423,7 @@ to long wait time before the first results are shown.</p>
<a href="https://rclone.org/overview/#mime-type">MIME types</a> and
metadata item <a href="#metadata">utime</a> are not available when using
<code>--fast-list</code>.</p>
-<h3 id="modification-times-and-hashes-14">Modification times and
+<h3 id="modification-times-and-hashes-15">Modification times 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
@@ -48201,7 +50441,7 @@ available, so this does not apply. Starting with rclone version 1.52 the
same is true for encrypted remotes (in older versions the crypt backend
would not calculate hashes for uploads from local disk, so the
Jottacloud backend had to do it as described above).</p>
-<h3 id="restricted-filename-characters-16">Restricted filename
+<h3 id="restricted-filename-characters-17">Restricted filename
characters</h3>
<p>In addition to the <a
href="https://rclone.org/overview/#restricted-characters">default
@@ -48251,6 +50491,11 @@ replaced:</p>
<td style="text-align: center;">0x7C</td>
<td style="text-align: center;">|</td>
</tr>
+<tr class="even">
+<td>%</td>
+<td style="text-align: center;">0x25</td>
+<td style="text-align: center;">%</td>
+</tr>
</tbody>
</table>
<p>Invalid UTF-8 bytes will also be <a
@@ -48274,13 +50519,13 @@ accessed via the Jottacloud Website.</p>
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>
+<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 (unless it is unlimited) and the current usage.</p>
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/jottacloud/jottacloud.go and run make backenddocs to verify -->
<!-- markdownlint-disable-line line-length -->
-<h3 id="standard-options-33">Standard options</h3>
+<h3 id="standard-options-34">Standard options</h3>
<p>Here are the Standard options specific to jottacloud
(Jottacloud).</p>
<h4 id="jottacloud-client-id">--jottacloud-client-id</h4>
@@ -48303,7 +50548,7 @@ limit (unless it is unlimited) and the current usage.</p>
<li>Type: string</li>
<li>Required: false</li>
</ul>
-<h3 id="advanced-options-33">Advanced options</h3>
+<h3 id="advanced-options-34">Advanced options</h3>
<p>Here are the Advanced options specific to jottacloud
(Jottacloud).</p>
<h4 id="jottacloud-token">--jottacloud-token</h4>
@@ -48408,7 +50653,7 @@ section in the overview</a> for more info.</p>
<li>Env Var: RCLONE_JOTTACLOUD_ENCODING</li>
<li>Type: Encoding</li>
<li>Default:
-Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot</li>
+Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Percent,Del,Ctl,InvalidUtf8,Dot</li>
</ul>
<h4 id="jottacloud-description">--jottacloud-description</h4>
<p>Description of the remote.</p>
@@ -48419,7 +50664,7 @@ Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
-<h3 id="metadata-15">Metadata</h3>
+<h3 id="metadata-18">Metadata</h3>
<p>Jottacloud has limited support for metadata, currently an extended
set of timestamps.</p>
<p>Here are the possible system metadata items for the jottacloud
@@ -48476,7 +50721,7 @@ backend</td>
<p>See the <a href="https://rclone.org/docs/#metadata">metadata</a> docs
for more info.</p>
<!-- autogenerated options stop -->
-<h2 id="limitations-23">Limitations</h2>
+<h2 id="limitations-25">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
@@ -48494,7 +50739,7 @@ cases.</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-33">Configuration</h2>
+<h2 id="configuration-34">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
@@ -48569,7 +50814,7 @@ choose an alternative mount instead of your primary storage.</p>
<pre class="console"><code>rclone ls koofr:</code></pre>
<p>To copy a local directory to an Koofr directory called backup</p>
<pre class="console"><code>rclone copy /home/source koofr:backup</code></pre>
-<h3 id="restricted-filename-characters-17">Restricted filename
+<h3 id="restricted-filename-characters-18">Restricted filename
characters</h3>
<p>In addition to the <a
href="https://rclone.org/overview/#restricted-characters">default
@@ -48596,7 +50841,7 @@ href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they
can't be used in XML strings.</p>
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/koofr/koofr.go and run make backenddocs to verify -->
<!-- markdownlint-disable-line line-length -->
-<h3 id="standard-options-34">Standard options</h3>
+<h3 id="standard-options-35">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>
@@ -48656,7 +50901,7 @@ obscure</a>.</p>
<li>Type: string</li>
<li>Required: true</li>
</ul>
-<h3 id="advanced-options-34">Advanced options</h3>
+<h3 id="advanced-options-35">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>
@@ -48701,7 +50946,7 @@ section in the overview</a> for more info.</p>
<li>Required: false</li>
</ul>
<!-- autogenerated options stop -->
-<h2 id="limitations-24">Limitations</h2>
+<h2 id="limitations-26">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>
@@ -48841,8 +51086,17 @@ y/e/d&gt; y</code></pre>
<h1 id="linkbox">Linkbox</h1>
<p>Linkbox is <a href="https://linkbox.to/">a private cloud
drive</a>.</p>
-<h2 id="configuration-34">Configuration</h2>
+<h2 id="configuration-35">Configuration</h2>
<p>Here is an example of making a remote for Linkbox.</p>
+<p>You will need: - An API token from
+https://www.linkbox.to/admin/account - The email and password for your
+Linkbox account</p>
+<p><strong>Note:</strong> As of v1.74, email and password are required
+in addition to the API token. The API token is used for uploads and
+modifications, while email/password authentication is used for listing
+and downloading files. If you have an existing Linkbox remote, you will
+need to reconfigure it with <code>rclone config</code> to edit the
+remote and add the email and password.</p>
<p>First run:</p>
<pre class="console"><code>rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
@@ -48865,12 +51119,24 @@ Storage&gt; XX
Option token.
Token from https://www.linkbox.to/admin/account
Enter a value.
-token&gt; testFromCLToken
+token&gt; YOUR_API_TOKEN
+
+Option email.
+Email for login
+Enter a value.
+
+Option password.
+Password for login
+Enter a value.
+password&gt; YOUR_PASSWORD
Configuration complete.
Options:
- type: linkbox
- token: XXXXXXXXXXX
+- password: *** ENCRYPTED ***
Keep this &quot;linkbox&quot; remote?
y) Yes this is OK (default)
e) Edit this remote
@@ -48879,7 +51145,7 @@ y/e/d&gt; y
</code></pre>
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/linkbox/linkbox.go and run make backenddocs to verify -->
<!-- markdownlint-disable-line line-length -->
-<h3 id="standard-options-35">Standard options</h3>
+<h3 id="standard-options-36">Standard options</h3>
<p>Here are the Standard options specific to linkbox (Linkbox).</p>
<h4 id="linkbox-token">--linkbox-token</h4>
<p>Token from https://www.linkbox.to/admin/account</p>
@@ -48890,7 +51156,37 @@ y/e/d&gt; y
<li>Type: string</li>
<li>Required: true</li>
</ul>
-<h3 id="advanced-options-35">Advanced options</h3>
+<h4 id="linkbox-email">--linkbox-email</h4>
+<p>Email for login</p>
+<p>Properties:</p>
+<ul>
+<li>Config: email</li>
+<li>Env Var: RCLONE_LINKBOX_EMAIL</li>
+<li>Type: string</li>
+<li>Required: true</li>
+</ul>
+<h4 id="linkbox-password">--linkbox-password</h4>
+<p>Password for login</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_LINKBOX_PASSWORD</li>
+<li>Type: string</li>
+<li>Required: true</li>
+</ul>
+<h4 id="linkbox-web-token">--linkbox-web-token</h4>
+<p>Web API login token - set automatically.</p>
+<p>Properties:</p>
+<ul>
+<li>Config: web_token</li>
+<li>Env Var: RCLONE_LINKBOX_WEB_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 linkbox (Linkbox).</p>
<h4 id="linkbox-description">--linkbox-description</h4>
<p>Description of the remote.</p>
@@ -48902,7 +51198,7 @@ y/e/d&gt; y
<li>Required: false</li>
</ul>
<!-- autogenerated options stop -->
-<h2 id="limitations-25">Limitations</h2>
+<h2 id="limitations-27">Limitations</h2>
<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>
@@ -48930,7 +51226,7 @@ deduplication, the hash algorithm is a modified SHA1</li>
submit file hash instead of long file upload (this optimization is
supported by rclone)</li>
</ul>
-<h2 id="configuration-35">Configuration</h2>
+<h2 id="configuration-36">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
@@ -49021,7 +51317,7 @@ You can use the configured backend as shown below:</p>
<p>Sync <code>/home/local/directory</code> to the remote path, deleting
any excess files in the path.</p>
<pre class="console"><code>rclone sync --interactive /home/local/directory remote:directory</code></pre>
-<h3 id="modification-times-and-hashes-15">Modification times and
+<h3 id="modification-times-and-hashes-16">Modification times and
hashes</h3>
<p>Files support a modification time attribute with up to 1 second
precision. Directories do not have a modification time, which is shown
@@ -49038,11 +51334,11 @@ 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>
+<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-18">Restricted filename
+<h3 id="restricted-filename-characters-19">Restricted filename
characters</h3>
<p>In addition to the <a
href="https://rclone.org/overview/#restricted-characters">default
@@ -49104,7 +51400,7 @@ href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they
can't be used in JSON strings.</p>
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/mailru/mailru.go and run make backenddocs to verify -->
<!-- markdownlint-disable-line line-length -->
-<h3 id="standard-options-36">Standard options</h3>
+<h3 id="standard-options-37">Standard options</h3>
<p>Here are the Standard options specific to mailru (Mail.ru Cloud).</p>
<h4 id="mailru-client-id">--mailru-client-id</h4>
<p>OAuth Client Id.</p>
@@ -49179,7 +51475,7 @@ this optimization.</p>
</ul></li>
</ul></li>
</ul>
-<h3 id="advanced-options-36">Advanced options</h3>
+<h3 id="advanced-options-37">Advanced options</h3>
<p>Here are the Advanced options specific to mailru (Mail.ru Cloud).</p>
<h4 id="mailru-token">--mailru-token</h4>
<p>OAuth Access Token as a JSON blob.</p>
@@ -49376,7 +51672,7 @@ Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf
<li>Required: false</li>
</ul>
<!-- autogenerated options stop -->
-<h2 id="limitations-26">Limitations</h2>
+<h2 id="limitations-28">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>
@@ -49396,7 +51692,7 @@ recommended for new projects.</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-36">Configuration</h2>
+<h2 id="configuration-37">Configuration</h2>
<p>Here is an example of how to make a remote called
<code>remote</code>. First run:</p>
<pre class="console"><code>rclone config</code></pre>
@@ -49447,10 +51743,10 @@ use the credentials in <code>rclone</code> will fail.</p>
<pre class="console"><code>rclone ls remote:</code></pre>
<p>To copy a local directory to an Mega directory called backup</p>
<pre class="console"><code>rclone copy /home/source remote:backup</code></pre>
-<h3 id="modification-times-and-hashes-16">Modification times and
+<h3 id="modification-times-and-hashes-17">Modification times and
hashes</h3>
<p>Mega does not support modification times or hashes yet.</p>
-<h3 id="restricted-filename-characters-19">Restricted filename
+<h3 id="restricted-filename-characters-20">Restricted filename
characters</h3>
<table>
<thead>
@@ -49550,7 +51846,7 @@ log-in and you are sure the user and the password are correct, likely
you have got the remote blocked for a while.</p>
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/mega/mega.go and run make backenddocs to verify -->
<!-- markdownlint-disable-line line-length -->
-<h3 id="standard-options-37">Standard options</h3>
+<h3 id="standard-options-38">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>
@@ -49583,7 +51879,7 @@ one</p>
<li>Type: string</li>
<li>Required: false</li>
</ul>
-<h3 id="advanced-options-37">Advanced options</h3>
+<h3 id="advanced-options-38">Advanced options</h3>
<p>Here are the Advanced options specific to mega (Mega).</p>
<h4 id="mega-session-id">--mega-session-id</h4>
<p>Session (internal use only)</p>
@@ -49669,7 +51965,7 @@ type has sufficient memory/CPU to execute the commands. Use the resource
monitoring tools to inspect after sending the commands. Look <a
href="https://forum.rclone.org/t/rclone-with-mega-appears-to-work-only-in-some-accounts/40233/4">at
this issue</a>.</p>
-<h2 id="limitations-27">Limitations</h2>
+<h2 id="limitations-29">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
@@ -49683,7 +51979,7 @@ there are likely quite a few errors still remaining in this library.</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-37">Configuration</h2>
+<h2 id="configuration-38">Configuration</h2>
<p>You can configure it as a remote like this with
<code>rclone config</code> too if you want to:</p>
<pre class="text"><code>No remotes found, make a new one\?
@@ -49717,18 +52013,18 @@ testing or with an rclone server or rclone mount, e.g.</p>
<pre class="console"><code>rclone mount :memory: /mnt/tmp
rclone serve webdav :memory:
rclone serve sftp :memory:</code></pre>
-<h3 id="modification-times-and-hashes-17">Modification times and
+<h3 id="modification-times-and-hashes-18">Modification times and
hashes</h3>
<p>The memory backend supports MD5 hashes and modification times
accurate to 1 nS.</p>
-<h3 id="restricted-filename-characters-20">Restricted filename
+<h3 id="restricted-filename-characters-21">Restricted filename
characters</h3>
<p>The memory backend replaces the <a
href="https://rclone.org/overview/#restricted-characters">default
restricted characters set</a>.</p>
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/memory/memory.go and run make backenddocs to verify -->
<!-- markdownlint-disable-line line-length -->
-<h3 id="advanced-options-38">Advanced options</h3>
+<h3 id="advanced-options-39">Advanced options</h3>
<p>Here are the Advanced options specific to memory (In memory object
storage system.).</p>
<h4 id="memory-discard">--memory-discard</h4>
@@ -49777,7 +52073,7 @@ code:</p>
<p>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-38">Configuration</h2>
+<h2 id="configuration-39">Configuration</h2>
<p>Here's an example of how to make a remote called
<code>ns1</code>.</p>
<ol type="1">
@@ -49947,7 +52243,7 @@ using quick-delete method will not delete the tree immediately and
objects targeted for quick-delete may still be accessible.</p>
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/netstorage/netstorage.go and run make backenddocs to verify -->
<!-- markdownlint-disable-line line-length -->
-<h3 id="standard-options-38">Standard options</h3>
+<h3 id="standard-options-39">Standard options</h3>
<p>Here are the Standard options specific to netstorage (Akamai
NetStorage).</p>
<h4 id="netstorage-host">--netstorage-host</h4>
@@ -49984,7 +52280,7 @@ obscure</a>.</p>
<li>Type: string</li>
<li>Required: true</li>
</ul>
-<h3 id="advanced-options-39">Advanced options</h3>
+<h3 id="advanced-options-40">Advanced options</h3>
<p>Here are the Advanced options specific to netstorage (Akamai
NetStorage).</p>
<h4 id="netstorage-protocol">--netstorage-protocol</h4>
@@ -50049,7 +52345,7 @@ applicable.</p>
<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-39">Configuration</h2>
+<h2 id="configuration-40">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 class="console"><code>rclone config</code></pre>
@@ -50099,7 +52395,7 @@ deleting any excess files in the container.</p>
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="modification-times-and-hashes-18">Modification times and
+<h3 id="modification-times-and-hashes-19">Modification times and
hashes</h3>
<p>The modification time is stored as metadata on the object with the
<code>mtime</code> key. It is stored using RFC3339 Format time with
@@ -50148,7 +52444,7 @@ 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-21">Restricted filename
+<h3 id="restricted-filename-characters-22">Restricted filename
characters</h3>
<p>In addition to the <a
href="https://rclone.org/overview/#restricted-characters">default
@@ -50381,12 +52677,12 @@ must be explicitly specified using exactly one of the
<p>If none of <code>msi_object_id</code>, <code>msi_client_id</code>, or
<code>msi_mi_res_id</code> is set, this is is equivalent to using
<code>env_auth</code>.</p>
-<h4 id="fedrated-identity-credentials">Fedrated Identity
+<h4 id="federated-identity-credentials">Federated Identity
Credentials</h4>
-<p>If these variables are set, rclone will authenticate with fedrated
+<p>If these variables are set, rclone will authenticate with federated
identity.</p>
<ul>
-<li><code>tenant_id</code>: tenant_id to authenticate in storage</li>
+<li><code>tenant</code>: tenant ID of of the storage</li>
<li><code>client_id</code>: client ID of the application the user will
authenticate to storage</li>
<li><code>msi_client_id</code>: managed identity client ID of the
@@ -50394,7 +52690,7 @@ application the user will authenticate to</li>
</ul>
<p>By default "api://AzureADTokenExchange" is used as scope for token
retrieval over MSI. This token is then exchanged for actual storage
-token using 'tenant_id' and 'client_id'.</p>
+token using 'tenant' and 'client_id'.</p>
<h4 id="use_az">Azure CLI tool <code>az</code></h4>
<p>Set to use the <a
href="https://learn.microsoft.com/en-us/cli/azure/">Azure CLI tool
@@ -50410,7 +52706,7 @@ config:</p>
<pre class="console"><code>rclone lsf :azureblob,account=ACCOUNT:CONTAINER</code></pre>
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/azureblob/azureblob.go and run make backenddocs to verify -->
<!-- markdownlint-disable-line line-length -->
-<h3 id="standard-options-39">Standard options</h3>
+<h3 id="standard-options-40">Standard options</h3>
<p>Here are the Standard options specific to azureblob (Microsoft Azure
Blob Storage).</p>
<h4 id="azureblob-account">--azureblob-account</h4>
@@ -50531,7 +52827,7 @@ obscure</a>.</p>
<li>Type: string</li>
<li>Required: false</li>
</ul>
-<h3 id="advanced-options-40">Advanced options</h3>
+<h3 id="advanced-options-41">Advanced options</h3>
<p>Here are the Advanced options specific to azureblob (Microsoft Azure
Blob Storage).</p>
<h4
@@ -50772,6 +53068,19 @@ concurrency.</p>
<li>Type: int</li>
<li>Default: 512</li>
</ul>
+<h4
+id="azureblob-copy-total-concurrency">--azureblob-copy-total-concurrency</h4>
+<p>Global concurrency limit for multipart copy chunks.</p>
+<p>This limits the total number of multipart copy chunks running at once
+across all files.</p>
+<p>Set to 0 to disable this limiter.</p>
+<p>Properties:</p>
+<ul>
+<li>Config: copy_total_concurrency</li>
+<li>Env Var: RCLONE_AZUREBLOB_COPY_TOTAL_CONCURRENCY</li>
+<li>Type: int</li>
+<li>Default: 0</li>
+</ul>
<h4 id="azureblob-use-copy-blob">--azureblob-use-copy-blob</h4>
<p>Whether to use the Copy Blob API when copying to the same storage
account.</p>
@@ -50975,6 +53284,22 @@ blob.</li>
</ul></li>
</ul></li>
</ul>
+<h4 id="azureblob-decompress">--azureblob-decompress</h4>
+<p>If set this will decompress gzip encoded objects.</p>
+<p>It is possible to upload objects to Azure Blob Storage 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_AZUREBLOB_DECOMPRESS</li>
+<li>Type: bool</li>
+<li>Default: false</li>
+</ul>
<h4 id="azureblob-description">--azureblob-description</h4>
<p>Description of the remote.</p>
<p>Properties:</p>
@@ -50984,7 +53309,7 @@ blob.</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
-<h3 id="metadata-16">Metadata</h3>
+<h3 id="metadata-19">Metadata</h3>
<p>User metadata is stored as x-ms-meta- keys. Azure metadata keys are
case insensitive and are always returned in lower case.</p>
<p>Here are the possible system metadata items for the azureblob
@@ -51074,7 +53399,7 @@ for more info.</p>
</ul>
<p>Eg <code>--header-upload "Content-Type: text/potato"</code> or
<code>--header-upload "X-MS-Tags: foo=bar"</code>.</p>
-<h2 id="limitations-28">Limitations</h2>
+<h2 id="limitations-30">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
@@ -51104,7 +53429,7 @@ in the advanced settings, setting it to
Storage</h1>
<p>Paths are specified as <code>remote:</code> You may put
subdirectories in too, e.g. <code>remote:path/to/dir</code>.</p>
-<h2 id="configuration-40">Configuration</h2>
+<h2 id="configuration-41">Configuration</h2>
<p>Here is an example of making a Microsoft Azure Files Storage
configuration. For a remote called <code>remote</code>. First run:</p>
<pre class="console"><code>rclone config</code></pre>
@@ -51192,7 +53517,7 @@ 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-22">Restricted filename
+<h3 id="restricted-filename-characters-23">Restricted filename
characters</h3>
<p>In addition to the <a
href="https://rclone.org/overview/#restricted-characters">default
@@ -51442,12 +53767,12 @@ must be explicitly specified using exactly one of the
<p>If none of <code>msi_object_id</code>, <code>msi_client_id</code>, or
<code>msi_mi_res_id</code> is set, this is is equivalent to using
<code>env_auth</code>.</p>
-<h4 id="fedrated-identity-credentials-1">Fedrated Identity
+<h4 id="federated-identity-credentials-1">Federated Identity
Credentials</h4>
-<p>If these variables are set, rclone will authenticate with fedrated
+<p>If these variables are set, rclone will authenticate with federated
identity.</p>
<ul>
-<li><code>tenant_id</code>: tenant_id to authenticate in storage</li>
+<li><code>tenant</code>: tenant ID of of the storage</li>
<li><code>client_id</code>: client ID of the application the user will
authenticate to storage</li>
<li><code>msi_client_id</code>: managed identity client ID of the
@@ -51455,7 +53780,7 @@ application the user will authenticate to</li>
</ul>
<p>By default "api://AzureADTokenExchange" is used as scope for token
retrieval over MSI. This token is then exchanged for actual storage
-token using 'tenant_id' and 'client_id'.</p>
+token using 'tenant' and 'client_id'.</p>
<h4 id="use_az">Azure CLI tool <code>az</code></h4>
<p>Set to use the <a
href="https://learn.microsoft.com/en-us/cli/azure/">Azure CLI tool
@@ -51465,7 +53790,7 @@ a System Managed Identity that you do not want to use. Don't set
<code>env_auth</code> at the same time.</p>
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/azurefiles/azurefiles.go and run make backenddocs to verify -->
<!-- markdownlint-disable-line line-length -->
-<h3 id="standard-options-40">Standard options</h3>
+<h3 id="standard-options-41">Standard options</h3>
<p>Here are the Standard options specific to azurefiles (Microsoft Azure
Files).</p>
<h4 id="azurefiles-account">--azurefiles-account</h4>
@@ -51597,7 +53922,7 @@ obscure</a>.</p>
<li>Type: string</li>
<li>Required: false</li>
</ul>
-<h3 id="advanced-options-41">Advanced options</h3>
+<h3 id="advanced-options-42">Advanced options</h3>
<p>Here are the Advanced options specific to azurefiles (Microsoft Azure
Files).</p>
<h4
@@ -51850,14 +54175,14 @@ Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,RightPerio
<li>Content-Type</li>
</ul>
<p>Eg <code>--header-upload "Content-Type: text/potato"</code></p>
-<h2 id="limitations-29">Limitations</h2>
+<h2 id="limitations-31">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>
<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-41">Configuration</h2>
+<h2 id="configuration-42">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>
@@ -52078,7 +54403,7 @@ data using the app-only token without requiring their credentials.</p>
application means that anyone with the <em>Client ID</em> and <em>Client
Secret</em> can access your OneDrive files. Take care to safeguard these
credentials.</p>
-<h3 id="modification-times-and-hashes-19">Modification times and
+<h3 id="modification-times-and-hashes-20">Modification times 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
@@ -52121,7 +54446,7 @@ using.</p>
<p>Some commands (like <code>rclone lsf -R</code>) will use
<code>ListR</code> by default - you can turn this off with
<code>--disable ListR</code> if you need to.</p>
-<h3 id="restricted-filename-characters-23">Restricted filename
+<h3 id="restricted-filename-characters-24">Restricted filename
characters</h3>
<p>In addition to the <a
href="https://rclone.org/overview/#restricted-characters">default
@@ -52234,7 +54559,7 @@ trash, so you will have to do that with one of Microsoft's apps or via
the OneDrive website.</p>
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/onedrive/onedrive.go and run make backenddocs to verify -->
<!-- markdownlint-disable-line line-length -->
-<h3 id="standard-options-41">Standard options</h3>
+<h3 id="standard-options-42">Standard options</h3>
<p>Here are the Standard options specific to onedrive (Microsoft
OneDrive).</p>
<h4 id="onedrive-client-id">--onedrive-client-id</h4>
@@ -52296,7 +54621,7 @@ ID.</p>
<li>Type: string</li>
<li>Required: false</li>
</ul>
-<h3 id="advanced-options-42">Advanced options</h3>
+<h3 id="advanced-options-43">Advanced options</h3>
<p>Here are the Advanced options specific to onedrive (Microsoft
OneDrive).</p>
<h4 id="onedrive-token">--onedrive-token</h4>
@@ -52733,7 +55058,7 @@ Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftSpace,
<li>Type: string</li>
<li>Required: false</li>
</ul>
-<h3 id="metadata-17">Metadata</h3>
+<h3 id="metadata-20">Metadata</h3>
<p>OneDrive supports System Metadata (not User Metadata, as of this
writing) for both files and directories. Much of the metadata is
read-only, and there are some differences between OneDrive Personal and
@@ -52753,69 +55078,69 @@ href="https://learn.microsoft.com/en-us/onedrive/developer/rest-api/resources/pe
API</a>, which differs slightly between OneDrive Personal and
Business.</p>
<p>Example for OneDrive Personal:</p>
-<div class="sourceCode" id="cb1517"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb1517-1"><a href="#cb1517-1" aria-hidden="true" tabindex="-1"></a><span class="ot">[</span></span>
-<span id="cb1517-2"><a href="#cb1517-2" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
-<span id="cb1517-3"><a href="#cb1517-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;id&quot;</span><span class="fu">:</span> <span class="st">&quot;1234567890ABC!123&quot;</span><span class="fu">,</span></span>
-<span id="cb1517-4"><a href="#cb1517-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;grantedTo&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
-<span id="cb1517-5"><a href="#cb1517-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;user&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
-<span id="cb1517-6"><a href="#cb1517-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;id&quot;</span><span class="fu">:</span> <span class="st">&quot;[email protected]&quot;</span></span>
-<span id="cb1517-7"><a href="#cb1517-7" aria-hidden="true" tabindex="-1"></a> <span class="fu">},</span></span>
-<span id="cb1517-8"><a href="#cb1517-8" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;application&quot;</span><span class="fu">:</span> <span class="fu">{},</span></span>
-<span id="cb1517-9"><a href="#cb1517-9" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;device&quot;</span><span class="fu">:</span> <span class="fu">{}</span></span>
-<span id="cb1517-10"><a href="#cb1517-10" aria-hidden="true" tabindex="-1"></a> <span class="fu">},</span></span>
-<span id="cb1517-11"><a href="#cb1517-11" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;invitation&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
-<span id="cb1517-12"><a href="#cb1517-12" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;email&quot;</span><span class="fu">:</span> <span class="st">&quot;[email protected]&quot;</span></span>
-<span id="cb1517-13"><a href="#cb1517-13" aria-hidden="true" tabindex="-1"></a> <span class="fu">},</span></span>
-<span id="cb1517-14"><a href="#cb1517-14" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;link&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
-<span id="cb1517-15"><a href="#cb1517-15" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;webUrl&quot;</span><span class="fu">:</span> <span class="st">&quot;https://1drv.ms/t/s!1234567890ABC&quot;</span></span>
-<span id="cb1517-16"><a href="#cb1517-16" aria-hidden="true" tabindex="-1"></a> <span class="fu">},</span></span>
-<span id="cb1517-17"><a href="#cb1517-17" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;roles&quot;</span><span class="fu">:</span> <span class="ot">[</span></span>
-<span id="cb1517-18"><a href="#cb1517-18" aria-hidden="true" tabindex="-1"></a> <span class="st">&quot;read&quot;</span></span>
-<span id="cb1517-19"><a href="#cb1517-19" aria-hidden="true" tabindex="-1"></a> <span class="ot">]</span><span class="fu">,</span></span>
-<span id="cb1517-20"><a href="#cb1517-20" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;shareId&quot;</span><span class="fu">:</span> <span class="st">&quot;s!1234567890ABC&quot;</span></span>
-<span id="cb1517-21"><a href="#cb1517-21" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
-<span id="cb1517-22"><a href="#cb1517-22" aria-hidden="true" tabindex="-1"></a><span class="ot">]</span></span></code></pre></div>
+<div class="sourceCode" id="cb1558"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb1558-1"><a href="#cb1558-1" aria-hidden="true" tabindex="-1"></a><span class="ot">[</span></span>
+<span id="cb1558-2"><a href="#cb1558-2" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
+<span id="cb1558-3"><a href="#cb1558-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;id&quot;</span><span class="fu">:</span> <span class="st">&quot;1234567890ABC!123&quot;</span><span class="fu">,</span></span>
+<span id="cb1558-4"><a href="#cb1558-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;grantedTo&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
+<span id="cb1558-5"><a href="#cb1558-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;user&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
+<span id="cb1558-6"><a href="#cb1558-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;id&quot;</span><span class="fu">:</span> <span class="st">&quot;[email protected]&quot;</span></span>
+<span id="cb1558-7"><a href="#cb1558-7" aria-hidden="true" tabindex="-1"></a> <span class="fu">},</span></span>
+<span id="cb1558-8"><a href="#cb1558-8" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;application&quot;</span><span class="fu">:</span> <span class="fu">{},</span></span>
+<span id="cb1558-9"><a href="#cb1558-9" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;device&quot;</span><span class="fu">:</span> <span class="fu">{}</span></span>
+<span id="cb1558-10"><a href="#cb1558-10" aria-hidden="true" tabindex="-1"></a> <span class="fu">},</span></span>
+<span id="cb1558-11"><a href="#cb1558-11" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;invitation&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
+<span id="cb1558-12"><a href="#cb1558-12" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;email&quot;</span><span class="fu">:</span> <span class="st">&quot;[email protected]&quot;</span></span>
+<span id="cb1558-13"><a href="#cb1558-13" aria-hidden="true" tabindex="-1"></a> <span class="fu">},</span></span>
+<span id="cb1558-14"><a href="#cb1558-14" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;link&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
+<span id="cb1558-15"><a href="#cb1558-15" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;webUrl&quot;</span><span class="fu">:</span> <span class="st">&quot;https://1drv.ms/t/s!1234567890ABC&quot;</span></span>
+<span id="cb1558-16"><a href="#cb1558-16" aria-hidden="true" tabindex="-1"></a> <span class="fu">},</span></span>
+<span id="cb1558-17"><a href="#cb1558-17" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;roles&quot;</span><span class="fu">:</span> <span class="ot">[</span></span>
+<span id="cb1558-18"><a href="#cb1558-18" aria-hidden="true" tabindex="-1"></a> <span class="st">&quot;read&quot;</span></span>
+<span id="cb1558-19"><a href="#cb1558-19" aria-hidden="true" tabindex="-1"></a> <span class="ot">]</span><span class="fu">,</span></span>
+<span id="cb1558-20"><a href="#cb1558-20" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;shareId&quot;</span><span class="fu">:</span> <span class="st">&quot;s!1234567890ABC&quot;</span></span>
+<span id="cb1558-21"><a href="#cb1558-21" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
+<span id="cb1558-22"><a href="#cb1558-22" aria-hidden="true" tabindex="-1"></a><span class="ot">]</span></span></code></pre></div>
<p>Example for OneDrive Business:</p>
-<div class="sourceCode" id="cb1518"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb1518-1"><a href="#cb1518-1" aria-hidden="true" tabindex="-1"></a><span class="ot">[</span></span>
-<span id="cb1518-2"><a href="#cb1518-2" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
-<span id="cb1518-3"><a href="#cb1518-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;id&quot;</span><span class="fu">:</span> <span class="st">&quot;48d31887-5fad-4d73-a9f5-3c356e68a038&quot;</span><span class="fu">,</span></span>
-<span id="cb1518-4"><a href="#cb1518-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;grantedToIdentities&quot;</span><span class="fu">:</span> <span class="ot">[</span></span>
-<span id="cb1518-5"><a href="#cb1518-5" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
-<span id="cb1518-6"><a href="#cb1518-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;user&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
-<span id="cb1518-7"><a href="#cb1518-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;displayName&quot;</span><span class="fu">:</span> <span class="st">&quot;[email protected]&quot;</span></span>
-<span id="cb1518-8"><a href="#cb1518-8" aria-hidden="true" tabindex="-1"></a> <span class="fu">},</span></span>
-<span id="cb1518-9"><a href="#cb1518-9" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;application&quot;</span><span class="fu">:</span> <span class="fu">{},</span></span>
-<span id="cb1518-10"><a href="#cb1518-10" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;device&quot;</span><span class="fu">:</span> <span class="fu">{}</span></span>
-<span id="cb1518-11"><a href="#cb1518-11" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
-<span id="cb1518-12"><a href="#cb1518-12" aria-hidden="true" tabindex="-1"></a> <span class="ot">]</span><span class="fu">,</span></span>
-<span id="cb1518-13"><a href="#cb1518-13" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;link&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
-<span id="cb1518-14"><a href="#cb1518-14" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;type&quot;</span><span class="fu">:</span> <span class="st">&quot;view&quot;</span><span class="fu">,</span></span>
-<span id="cb1518-15"><a href="#cb1518-15" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;scope&quot;</span><span class="fu">:</span> <span class="st">&quot;users&quot;</span><span class="fu">,</span></span>
-<span id="cb1518-16"><a href="#cb1518-16" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;webUrl&quot;</span><span class="fu">:</span> <span class="st">&quot;https://contoso.sharepoint.com/:w:/t/design/a577ghg9hgh737613bmbjf839026561fmzhsr85ng9f3hjck2t5s&quot;</span></span>
-<span id="cb1518-17"><a href="#cb1518-17" aria-hidden="true" tabindex="-1"></a> <span class="fu">},</span></span>
-<span id="cb1518-18"><a href="#cb1518-18" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;roles&quot;</span><span class="fu">:</span> <span class="ot">[</span></span>
-<span id="cb1518-19"><a href="#cb1518-19" aria-hidden="true" tabindex="-1"></a> <span class="st">&quot;read&quot;</span></span>
-<span id="cb1518-20"><a href="#cb1518-20" aria-hidden="true" tabindex="-1"></a> <span class="ot">]</span><span class="fu">,</span></span>
-<span id="cb1518-21"><a href="#cb1518-21" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;shareId&quot;</span><span class="fu">:</span> <span class="st">&quot;u!LKj1lkdlals90j1nlkascl&quot;</span></span>
-<span id="cb1518-22"><a href="#cb1518-22" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span><span class="ot">,</span></span>
-<span id="cb1518-23"><a href="#cb1518-23" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
-<span id="cb1518-24"><a href="#cb1518-24" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;id&quot;</span><span class="fu">:</span> <span class="st">&quot;5D33DD65C6932946&quot;</span><span class="fu">,</span></span>
-<span id="cb1518-25"><a href="#cb1518-25" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;grantedTo&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
-<span id="cb1518-26"><a href="#cb1518-26" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;user&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
-<span id="cb1518-27"><a href="#cb1518-27" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;displayName&quot;</span><span class="fu">:</span> <span class="st">&quot;John Doe&quot;</span><span class="fu">,</span></span>
-<span id="cb1518-28"><a href="#cb1518-28" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;id&quot;</span><span class="fu">:</span> <span class="st">&quot;efee1b77-fb3b-4f65-99d6-274c11914d12&quot;</span></span>
-<span id="cb1518-29"><a href="#cb1518-29" aria-hidden="true" tabindex="-1"></a> <span class="fu">},</span></span>
-<span id="cb1518-30"><a href="#cb1518-30" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;application&quot;</span><span class="fu">:</span> <span class="fu">{},</span></span>
-<span id="cb1518-31"><a href="#cb1518-31" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;device&quot;</span><span class="fu">:</span> <span class="fu">{}</span></span>
-<span id="cb1518-32"><a href="#cb1518-32" aria-hidden="true" tabindex="-1"></a> <span class="fu">},</span></span>
-<span id="cb1518-33"><a href="#cb1518-33" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;roles&quot;</span><span class="fu">:</span> <span class="ot">[</span></span>
-<span id="cb1518-34"><a href="#cb1518-34" aria-hidden="true" tabindex="-1"></a> <span class="st">&quot;owner&quot;</span></span>
-<span id="cb1518-35"><a href="#cb1518-35" aria-hidden="true" tabindex="-1"></a> <span class="ot">]</span><span class="fu">,</span></span>
-<span id="cb1518-36"><a href="#cb1518-36" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;shareId&quot;</span><span class="fu">:</span> <span class="st">&quot;FWxc1lasfdbEAGM5fI7B67aB5ZMPDMmQ11U&quot;</span></span>
-<span id="cb1518-37"><a href="#cb1518-37" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
-<span id="cb1518-38"><a href="#cb1518-38" aria-hidden="true" tabindex="-1"></a><span class="ot">]</span></span></code></pre></div>
+<div class="sourceCode" id="cb1559"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb1559-1"><a href="#cb1559-1" aria-hidden="true" tabindex="-1"></a><span class="ot">[</span></span>
+<span id="cb1559-2"><a href="#cb1559-2" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
+<span id="cb1559-3"><a href="#cb1559-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;id&quot;</span><span class="fu">:</span> <span class="st">&quot;48d31887-5fad-4d73-a9f5-3c356e68a038&quot;</span><span class="fu">,</span></span>
+<span id="cb1559-4"><a href="#cb1559-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;grantedToIdentities&quot;</span><span class="fu">:</span> <span class="ot">[</span></span>
+<span id="cb1559-5"><a href="#cb1559-5" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
+<span id="cb1559-6"><a href="#cb1559-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;user&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
+<span id="cb1559-7"><a href="#cb1559-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;displayName&quot;</span><span class="fu">:</span> <span class="st">&quot;[email protected]&quot;</span></span>
+<span id="cb1559-8"><a href="#cb1559-8" aria-hidden="true" tabindex="-1"></a> <span class="fu">},</span></span>
+<span id="cb1559-9"><a href="#cb1559-9" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;application&quot;</span><span class="fu">:</span> <span class="fu">{},</span></span>
+<span id="cb1559-10"><a href="#cb1559-10" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;device&quot;</span><span class="fu">:</span> <span class="fu">{}</span></span>
+<span id="cb1559-11"><a href="#cb1559-11" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
+<span id="cb1559-12"><a href="#cb1559-12" aria-hidden="true" tabindex="-1"></a> <span class="ot">]</span><span class="fu">,</span></span>
+<span id="cb1559-13"><a href="#cb1559-13" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;link&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
+<span id="cb1559-14"><a href="#cb1559-14" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;type&quot;</span><span class="fu">:</span> <span class="st">&quot;view&quot;</span><span class="fu">,</span></span>
+<span id="cb1559-15"><a href="#cb1559-15" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;scope&quot;</span><span class="fu">:</span> <span class="st">&quot;users&quot;</span><span class="fu">,</span></span>
+<span id="cb1559-16"><a href="#cb1559-16" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;webUrl&quot;</span><span class="fu">:</span> <span class="st">&quot;https://contoso.sharepoint.com/:w:/t/design/a577ghg9hgh737613bmbjf839026561fmzhsr85ng9f3hjck2t5s&quot;</span></span>
+<span id="cb1559-17"><a href="#cb1559-17" aria-hidden="true" tabindex="-1"></a> <span class="fu">},</span></span>
+<span id="cb1559-18"><a href="#cb1559-18" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;roles&quot;</span><span class="fu">:</span> <span class="ot">[</span></span>
+<span id="cb1559-19"><a href="#cb1559-19" aria-hidden="true" tabindex="-1"></a> <span class="st">&quot;read&quot;</span></span>
+<span id="cb1559-20"><a href="#cb1559-20" aria-hidden="true" tabindex="-1"></a> <span class="ot">]</span><span class="fu">,</span></span>
+<span id="cb1559-21"><a href="#cb1559-21" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;shareId&quot;</span><span class="fu">:</span> <span class="st">&quot;u!LKj1lkdlals90j1nlkascl&quot;</span></span>
+<span id="cb1559-22"><a href="#cb1559-22" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span><span class="ot">,</span></span>
+<span id="cb1559-23"><a href="#cb1559-23" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
+<span id="cb1559-24"><a href="#cb1559-24" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;id&quot;</span><span class="fu">:</span> <span class="st">&quot;5D33DD65C6932946&quot;</span><span class="fu">,</span></span>
+<span id="cb1559-25"><a href="#cb1559-25" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;grantedTo&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
+<span id="cb1559-26"><a href="#cb1559-26" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;user&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
+<span id="cb1559-27"><a href="#cb1559-27" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;displayName&quot;</span><span class="fu">:</span> <span class="st">&quot;John Doe&quot;</span><span class="fu">,</span></span>
+<span id="cb1559-28"><a href="#cb1559-28" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;id&quot;</span><span class="fu">:</span> <span class="st">&quot;efee1b77-fb3b-4f65-99d6-274c11914d12&quot;</span></span>
+<span id="cb1559-29"><a href="#cb1559-29" aria-hidden="true" tabindex="-1"></a> <span class="fu">},</span></span>
+<span id="cb1559-30"><a href="#cb1559-30" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;application&quot;</span><span class="fu">:</span> <span class="fu">{},</span></span>
+<span id="cb1559-31"><a href="#cb1559-31" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;device&quot;</span><span class="fu">:</span> <span class="fu">{}</span></span>
+<span id="cb1559-32"><a href="#cb1559-32" aria-hidden="true" tabindex="-1"></a> <span class="fu">},</span></span>
+<span id="cb1559-33"><a href="#cb1559-33" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;roles&quot;</span><span class="fu">:</span> <span class="ot">[</span></span>
+<span id="cb1559-34"><a href="#cb1559-34" aria-hidden="true" tabindex="-1"></a> <span class="st">&quot;owner&quot;</span></span>
+<span id="cb1559-35"><a href="#cb1559-35" aria-hidden="true" tabindex="-1"></a> <span class="ot">]</span><span class="fu">,</span></span>
+<span id="cb1559-36"><a href="#cb1559-36" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;shareId&quot;</span><span class="fu">:</span> <span class="st">&quot;FWxc1lasfdbEAGM5fI7B67aB5ZMPDMmQ11U&quot;</span></span>
+<span id="cb1559-37"><a href="#cb1559-37" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
+<span id="cb1559-38"><a href="#cb1559-38" aria-hidden="true" tabindex="-1"></a><span class="ot">]</span></span></code></pre></div>
<p>To write permissions, pass in a "permissions" metadata key using this
same format. The <a
href="https://rclone.org/docs/#metadata-mapper"><code>--metadata-mapper</code></a>
@@ -52829,12 +55154,12 @@ for a user. Creating a Public Link is also supported, if
<code>Link.Scope</code> is set to <code>"anonymous"</code>.</p>
<p>Example request to add a "read" permission with
<code>--metadata-mapper</code>:</p>
-<div class="sourceCode" id="cb1519"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb1519-1"><a href="#cb1519-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
-<span id="cb1519-2"><a href="#cb1519-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Metadata&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
-<span id="cb1519-3"><a href="#cb1519-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;permissions&quot;</span><span class="fu">:</span> <span class="st">&quot;[{</span><span class="ch">\&quot;</span><span class="st">grantedToIdentities</span><span class="ch">\&quot;</span><span class="st">:[{</span><span class="ch">\&quot;</span><span class="st">user</span><span class="ch">\&quot;</span><span class="st">:{</span><span class="ch">\&quot;</span><span class="st">id</span><span class="ch">\&quot;</span><span class="st">:</span><span class="ch">\&quot;</span><span class="st">[email protected]</span><span class="ch">\&quot;</span><span class="st">}}],</span><span class="ch">\&quot;</span><span class="st">roles</span><span class="ch">\&quot;</span><span class="st">:[</span><span class="ch">\&quot;</span><span class="st">read</span><span class="ch">\&quot;</span><span class="st">]}]&quot;</span></span>
-<span id="cb1519-4"><a href="#cb1519-4" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
-<span id="cb1519-5"><a href="#cb1519-5" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
+<div class="sourceCode" id="cb1560"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb1560-1"><a href="#cb1560-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
+<span id="cb1560-2"><a href="#cb1560-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Metadata&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
+<span id="cb1560-3"><a href="#cb1560-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;permissions&quot;</span><span class="fu">:</span> <span class="st">&quot;[{</span><span class="ch">\&quot;</span><span class="st">grantedToIdentities</span><span class="ch">\&quot;</span><span class="st">:[{</span><span class="ch">\&quot;</span><span class="st">user</span><span class="ch">\&quot;</span><span class="st">:{</span><span class="ch">\&quot;</span><span class="st">id</span><span class="ch">\&quot;</span><span class="st">:</span><span class="ch">\&quot;</span><span class="st">[email protected]</span><span class="ch">\&quot;</span><span class="st">}}],</span><span class="ch">\&quot;</span><span class="st">roles</span><span class="ch">\&quot;</span><span class="st">:[</span><span class="ch">\&quot;</span><span class="st">read</span><span class="ch">\&quot;</span><span class="st">]}]&quot;</span></span>
+<span id="cb1560-4"><a href="#cb1560-4" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
+<span id="cb1560-5"><a href="#cb1560-5" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>Note that adding a permission can fail if a conflicting permission
already exists for the file/folder.</p>
<p>To update an existing permission, include both the Permission ID and
@@ -53042,7 +55367,7 @@ hopefully give you a message of
URL of the format
<code>https://{tenant}-my.sharepoint.com/personal/{user_name_domain_tld}/Documents</code></p></li>
</ol>
-<h2 id="limitations-30">Limitations</h2>
+<h2 id="limitations-32">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
@@ -53285,7 +55610,7 @@ ERROR : 20230203_123826234_iOS.heic: vfs cache: failed to download: vfs reader:
<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-42">Configuration</h2>
+<h2 id="configuration-43">Configuration</h2>
<p>Here is an example of how to make a remote called
<code>remote</code>. First run:</p>
<pre class="console"><code>rclone config</code></pre>
@@ -53328,13 +55653,13 @@ y/e/d&gt; y</code></pre>
<pre class="console"><code>rclone ls remote:</code></pre>
<p>To copy a local directory to an OpenDrive directory called backup</p>
<pre class="console"><code>rclone copy /home/source remote:backup</code></pre>
-<h3 id="modification-times-and-hashes-20">Modification times and
+<h3 id="modification-times-and-hashes-21">Modification times and
hashes</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>
<p>The MD5 hash algorithm is supported.</p>
-<h3 id="restricted-filename-characters-24">Restricted filename
+<h3 id="restricted-filename-characters-25">Restricted filename
characters</h3>
<table>
<thead>
@@ -53441,7 +55766,7 @@ href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they
can't be used in JSON strings.</p>
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/opendrive/opendrive.go and run make backenddocs to verify -->
<!-- markdownlint-disable-line line-length -->
-<h3 id="standard-options-42">Standard options</h3>
+<h3 id="standard-options-43">Standard options</h3>
<p>Here are the Standard options specific to opendrive (OpenDrive).</p>
<h4 id="opendrive-username">--opendrive-username</h4>
<p>Username.</p>
@@ -53464,7 +55789,7 @@ obscure</a>.</p>
<li>Type: string</li>
<li>Required: true</li>
</ul>
-<h3 id="advanced-options-43">Advanced options</h3>
+<h3 id="advanced-options-44">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>
@@ -53529,7 +55854,7 @@ access the contents</li>
<li>Required: false</li>
</ul>
<!-- autogenerated options stop -->
-<h2 id="limitations-31">Limitations</h2>
+<h2 id="limitations-33">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
@@ -53561,7 +55886,7 @@ subdirectories in too, e.g. <code>remote:bucket/path/to/dir</code>.</p>
<p>Sample command to transfer local artifacts to remote:bucket in oracle
object storage:</p>
<pre class="console"><code>rclone -vvv --progress --stats-one-line --max-stats-groups 10 --log-format date,time,UTC,longfile --fast-list --buffer-size 256Mi --oos-no-check-bucket --oos-upload-cutoff 10Mi --multi-thread-cutoff 16Mi --multi-thread-streams 3000 --transfers 3000 --checkers 64 --retries 2 --oos-chunk-size 10Mi --oos-upload-concurrency 10000 --oos-attempt-resume-upload --oos-leave-parts-on-error sync ./artifacts remote:bucket -vv</code></pre>
-<h2 id="configuration-43">Configuration</h2>
+<h2 id="configuration-44">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
@@ -53689,15 +56014,15 @@ No authentication</code></pre>
<h3 id="user-principal">User Principal</h3>
<p>Sample rclone config file for Authentication Provider User
Principal:</p>
-<div class="sourceCode" id="cb1543"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1543-1"><a href="#cb1543-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[oos]</span></span>
-<span id="cb1543-2"><a href="#cb1543-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> oracleobjectstorage</span></span>
-<span id="cb1543-3"><a href="#cb1543-3" aria-hidden="true" tabindex="-1"></a><span class="dt">namespace </span><span class="ot">=</span><span class="st"> id&lt;redacted&gt;34</span></span>
-<span id="cb1543-4"><a href="#cb1543-4" aria-hidden="true" tabindex="-1"></a><span class="dt">compartment </span><span class="ot">=</span><span class="st"> ocid1.compartment.oc1..aa&lt;redacted&gt;ba</span></span>
-<span id="cb1543-5"><a href="#cb1543-5" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span><span class="st"> us-ashburn-1</span></span>
-<span id="cb1543-6"><a href="#cb1543-6" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> user_principal_auth</span></span>
-<span id="cb1543-7"><a href="#cb1543-7" aria-hidden="true" tabindex="-1"></a><span class="dt">config_file </span><span class="ot">=</span><span class="st"> /home/opc/.oci/config</span></span>
-<span id="cb1543-8"><a href="#cb1543-8" aria-hidden="true" tabindex="-1"></a><span class="dt">config_profile </span><span class="ot">=</span><span class="st"> </span><span class="kw">Default</span></span></code></pre></div>
+<div class="sourceCode" id="cb1584"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1584-1"><a href="#cb1584-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[oos]</span></span>
+<span id="cb1584-2"><a href="#cb1584-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> oracleobjectstorage</span></span>
+<span id="cb1584-3"><a href="#cb1584-3" aria-hidden="true" tabindex="-1"></a><span class="dt">namespace </span><span class="ot">=</span><span class="st"> id&lt;redacted&gt;34</span></span>
+<span id="cb1584-4"><a href="#cb1584-4" aria-hidden="true" tabindex="-1"></a><span class="dt">compartment </span><span class="ot">=</span><span class="st"> ocid1.compartment.oc1..aa&lt;redacted&gt;ba</span></span>
+<span id="cb1584-5"><a href="#cb1584-5" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span><span class="st"> us-ashburn-1</span></span>
+<span id="cb1584-6"><a href="#cb1584-6" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> user_principal_auth</span></span>
+<span id="cb1584-7"><a href="#cb1584-7" aria-hidden="true" tabindex="-1"></a><span class="dt">config_file </span><span class="ot">=</span><span class="st"> /home/opc/.oci/config</span></span>
+<span id="cb1584-8"><a href="#cb1584-8" aria-hidden="true" tabindex="-1"></a><span class="dt">config_profile </span><span class="ot">=</span><span class="st"> </span><span class="kw">Default</span></span></code></pre></div>
<p>Advantages:</p>
<ul>
<li>One can use this method from any server within OCI or on-premises or
@@ -53754,13 +56079,13 @@ export OCI_RESOURCE_PRINCIPAL_PRIVATE_PEM=/usr/share/model-server/key.pem
export OCI_RESOURCE_PRINCIPAL_RPST=/usr/share/model-server/security_token</code></pre>
<p>Sample rclone configuration file for Authentication Provider Resource
Principal:</p>
-<div class="sourceCode" id="cb1546"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1546-1"><a href="#cb1546-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[oos]</span></span>
-<span id="cb1546-2"><a href="#cb1546-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> oracleobjectstorage</span></span>
-<span id="cb1546-3"><a href="#cb1546-3" aria-hidden="true" tabindex="-1"></a><span class="dt">namespace </span><span class="ot">=</span><span class="st"> id&lt;redacted&gt;34</span></span>
-<span id="cb1546-4"><a href="#cb1546-4" aria-hidden="true" tabindex="-1"></a><span class="dt">compartment </span><span class="ot">=</span><span class="st"> ocid1.compartment.oc1..aa&lt;redacted&gt;ba</span></span>
-<span id="cb1546-5"><a href="#cb1546-5" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span><span class="st"> us-ashburn-1</span></span>
-<span id="cb1546-6"><a href="#cb1546-6" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> resource_principal_auth</span></span></code></pre></div>
+<div class="sourceCode" id="cb1587"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1587-1"><a href="#cb1587-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[oos]</span></span>
+<span id="cb1587-2"><a href="#cb1587-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> oracleobjectstorage</span></span>
+<span id="cb1587-3"><a href="#cb1587-3" aria-hidden="true" tabindex="-1"></a><span class="dt">namespace </span><span class="ot">=</span><span class="st"> id&lt;redacted&gt;34</span></span>
+<span id="cb1587-4"><a href="#cb1587-4" aria-hidden="true" tabindex="-1"></a><span class="dt">compartment </span><span class="ot">=</span><span class="st"> ocid1.compartment.oc1..aa&lt;redacted&gt;ba</span></span>
+<span id="cb1587-5"><a href="#cb1587-5" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span><span class="st"> us-ashburn-1</span></span>
+<span id="cb1587-6"><a href="#cb1587-6" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> resource_principal_auth</span></span></code></pre></div>
<h3 id="workload-identity">Workload Identity</h3>
<p>Workload Identity auth may be used when running Rclone from
Kubernetes pod on a Container Engine for Kubernetes (OKE) cluster. For
@@ -53774,14 +56099,14 @@ export OCI_RESOURCE_PRINCIPAL_REGION=us-ashburn-1</code></pre>
<h3 id="no-authentication">No authentication</h3>
<p>Public buckets do not require any authentication mechanism to read
objects. Sample rclone configuration file for No authentication:</p>
-<div class="sourceCode" id="cb1548"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1548-1"><a href="#cb1548-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[oos]</span></span>
-<span id="cb1548-2"><a href="#cb1548-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> oracleobjectstorage</span></span>
-<span id="cb1548-3"><a href="#cb1548-3" aria-hidden="true" tabindex="-1"></a><span class="dt">namespace </span><span class="ot">=</span><span class="st"> id&lt;redacted&gt;34</span></span>
-<span id="cb1548-4"><a href="#cb1548-4" aria-hidden="true" tabindex="-1"></a><span class="dt">compartment </span><span class="ot">=</span><span class="st"> ocid1.compartment.oc1..aa&lt;redacted&gt;ba</span></span>
-<span id="cb1548-5"><a href="#cb1548-5" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span><span class="st"> us-ashburn-1</span></span>
-<span id="cb1548-6"><a href="#cb1548-6" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> no_auth</span></span></code></pre></div>
-<h3 id="modification-times-and-hashes-21">Modification times and
+<div class="sourceCode" id="cb1589"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1589-1"><a href="#cb1589-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[oos]</span></span>
+<span id="cb1589-2"><a href="#cb1589-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> oracleobjectstorage</span></span>
+<span id="cb1589-3"><a href="#cb1589-3" aria-hidden="true" tabindex="-1"></a><span class="dt">namespace </span><span class="ot">=</span><span class="st"> id&lt;redacted&gt;34</span></span>
+<span id="cb1589-4"><a href="#cb1589-4" aria-hidden="true" tabindex="-1"></a><span class="dt">compartment </span><span class="ot">=</span><span class="st"> ocid1.compartment.oc1..aa&lt;redacted&gt;ba</span></span>
+<span id="cb1589-5"><a href="#cb1589-5" aria-hidden="true" tabindex="-1"></a><span class="dt">region </span><span class="ot">=</span><span class="st"> us-ashburn-1</span></span>
+<span id="cb1589-6"><a href="#cb1589-6" aria-hidden="true" tabindex="-1"></a><span class="dt">provider </span><span class="ot">=</span><span class="st"> no_auth</span></span></code></pre></div>
+<h3 id="modification-times-and-hashes-22">Modification times and
hashes</h3>
<p>The modification time is stored as metadata on the object as
<code>opc-meta-mtime</code> as floating point since the epoch, accurate
@@ -53820,7 +56145,7 @@ values are high enough to gain most of the possible performance without
using too much memory.</p>
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/oracleobjectstorage/oracleobjectstorage.go and run make backenddocs to verify -->
<!-- markdownlint-disable-line line-length -->
-<h3 id="standard-options-43">Standard options</h3>
+<h3 id="standard-options-44">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>
@@ -53944,7 +56269,7 @@ buckets</li>
</ul></li>
</ul></li>
</ul>
-<h3 id="advanced-options-44">Advanced options</h3>
+<h3 id="advanced-options-45">Advanced options</h3>
<p>Here are the Advanced options specific to oracleobjectstorage (Oracle
Cloud Infrastructure Object Storage).</p>
<h4 id="oos-storage-tier">--oos-storage-tier</h4>
@@ -54242,7 +56567,7 @@ Encryption
<li>Type: string</li>
<li>Required: false</li>
</ul>
-<h3 id="metadata-18">Metadata</h3>
+<h3 id="metadata-21">Metadata</h3>
<p>User metadata is stored as opc-meta- keys.</p>
<p>Here are the possible system metadata items for the
oracleobjectstorage backend.</p>
@@ -54338,26 +56663,26 @@ format.</p>
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>
-<div class="sourceCode" id="cb1554"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb1554-1"><a href="#cb1554-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
-<span id="cb1554-2"><a href="#cb1554-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;test-bucket&quot;</span><span class="fu">:</span> <span class="ot">[</span></span>
-<span id="cb1554-3"><a href="#cb1554-3" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
-<span id="cb1554-4"><a href="#cb1554-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;namespace&quot;</span><span class="fu">:</span> <span class="st">&quot;test-namespace&quot;</span><span class="fu">,</span></span>
-<span id="cb1554-5"><a href="#cb1554-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;bucket&quot;</span><span class="fu">:</span> <span class="st">&quot;test-bucket&quot;</span><span class="fu">,</span></span>
-<span id="cb1554-6"><a href="#cb1554-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;object&quot;</span><span class="fu">:</span> <span class="st">&quot;600m.bin&quot;</span><span class="fu">,</span></span>
-<span id="cb1554-7"><a href="#cb1554-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;uploadId&quot;</span><span class="fu">:</span> <span class="st">&quot;51dd8114-52a4-b2f2-c42f-5291f05eb3c8&quot;</span><span class="fu">,</span></span>
-<span id="cb1554-8"><a href="#cb1554-8" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;timeCreated&quot;</span><span class="fu">:</span> <span class="st">&quot;2022-07-29T06:21:16.595Z&quot;</span><span class="fu">,</span></span>
-<span id="cb1554-9"><a href="#cb1554-9" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;storageTier&quot;</span><span class="fu">:</span> <span class="st">&quot;Standard&quot;</span></span>
-<span id="cb1554-10"><a href="#cb1554-10" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
-<span id="cb1554-11"><a href="#cb1554-11" aria-hidden="true" tabindex="-1"></a> <span class="ot">]</span></span>
-<span id="cb1554-12"><a href="#cb1554-12" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span>
-<span id="cb1554-13"><a href="#cb1554-13" aria-hidden="true" tabindex="-1"></a></span>
-<span id="cb1554-14"><a href="#cb1554-14" aria-hidden="true" tabindex="-1"></a><span class="er">###</span> <span class="er">cleanup</span></span>
-<span id="cb1554-15"><a href="#cb1554-15" aria-hidden="true" tabindex="-1"></a></span>
-<span id="cb1554-16"><a href="#cb1554-16" aria-hidden="true" tabindex="-1"></a><span class="er">Remove</span> <span class="er">unfinished</span> <span class="er">multipart</span> <span class="er">uploads.</span></span>
-<span id="cb1554-17"><a href="#cb1554-17" aria-hidden="true" tabindex="-1"></a></span>
-<span id="cb1554-18"><a href="#cb1554-18" aria-hidden="true" tabindex="-1"></a><span class="er">```console</span></span>
-<span id="cb1554-19"><a href="#cb1554-19" aria-hidden="true" tabindex="-1"></a><span class="er">rclone</span> <span class="er">backend</span> <span class="er">cleanup</span> <span class="er">remote:</span> <span class="ot">[</span><span class="er">options</span><span class="ot">]</span> <span class="ot">[</span><span class="er">&lt;arguments&gt;+</span><span class="ot">]</span></span></code></pre></div>
+<div class="sourceCode" id="cb1595"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb1595-1"><a href="#cb1595-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
+<span id="cb1595-2"><a href="#cb1595-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;test-bucket&quot;</span><span class="fu">:</span> <span class="ot">[</span></span>
+<span id="cb1595-3"><a href="#cb1595-3" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
+<span id="cb1595-4"><a href="#cb1595-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;namespace&quot;</span><span class="fu">:</span> <span class="st">&quot;test-namespace&quot;</span><span class="fu">,</span></span>
+<span id="cb1595-5"><a href="#cb1595-5" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;bucket&quot;</span><span class="fu">:</span> <span class="st">&quot;test-bucket&quot;</span><span class="fu">,</span></span>
+<span id="cb1595-6"><a href="#cb1595-6" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;object&quot;</span><span class="fu">:</span> <span class="st">&quot;600m.bin&quot;</span><span class="fu">,</span></span>
+<span id="cb1595-7"><a href="#cb1595-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;uploadId&quot;</span><span class="fu">:</span> <span class="st">&quot;51dd8114-52a4-b2f2-c42f-5291f05eb3c8&quot;</span><span class="fu">,</span></span>
+<span id="cb1595-8"><a href="#cb1595-8" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;timeCreated&quot;</span><span class="fu">:</span> <span class="st">&quot;2022-07-29T06:21:16.595Z&quot;</span><span class="fu">,</span></span>
+<span id="cb1595-9"><a href="#cb1595-9" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;storageTier&quot;</span><span class="fu">:</span> <span class="st">&quot;Standard&quot;</span></span>
+<span id="cb1595-10"><a href="#cb1595-10" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
+<span id="cb1595-11"><a href="#cb1595-11" aria-hidden="true" tabindex="-1"></a> <span class="ot">]</span></span>
+<span id="cb1595-12"><a href="#cb1595-12" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span>
+<span id="cb1595-13"><a href="#cb1595-13" aria-hidden="true" tabindex="-1"></a></span>
+<span id="cb1595-14"><a href="#cb1595-14" aria-hidden="true" tabindex="-1"></a><span class="er">###</span> <span class="er">cleanup</span></span>
+<span id="cb1595-15"><a href="#cb1595-15" aria-hidden="true" tabindex="-1"></a></span>
+<span id="cb1595-16"><a href="#cb1595-16" aria-hidden="true" tabindex="-1"></a><span class="er">Remove</span> <span class="er">unfinished</span> <span class="er">multipart</span> <span class="er">uploads.</span></span>
+<span id="cb1595-17"><a href="#cb1595-17" aria-hidden="true" tabindex="-1"></a></span>
+<span id="cb1595-18"><a href="#cb1595-18" aria-hidden="true" tabindex="-1"></a><span class="er">```console</span></span>
+<span id="cb1595-19"><a href="#cb1595-19" aria-hidden="true" tabindex="-1"></a><span class="er">rclone</span> <span class="er">backend</span> <span class="er">cleanup</span> <span class="er">remote:</span> <span class="ot">[</span><span class="er">options</span><span class="ot">]</span> <span class="ot">[</span><span class="er">&lt;arguments&gt;+</span><span class="ot">]</span></span></code></pre></div>
<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 --interactive/-i or --dry-run with this command
@@ -54386,17 +56711,17 @@ rclone backend restore oos:bucket -o hours=HOURS</code></pre>
<p>It returns a list of status dictionaries with Object Name and Status
keys. The Status will be "RESTORED"" if it was successful or an error
message if not.</p>
-<div class="sourceCode" id="cb1560"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb1560-1"><a href="#cb1560-1" aria-hidden="true" tabindex="-1"></a><span class="ot">[</span></span>
-<span id="cb1560-2"><a href="#cb1560-2" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
-<span id="cb1560-3"><a href="#cb1560-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Object&quot;</span><span class="fu">:</span> <span class="st">&quot;test.txt&quot;</span></span>
-<span id="cb1560-4"><a href="#cb1560-4" aria-hidden="true" tabindex="-1"></a> <span class="st">&quot;Status&quot;</span><span class="er">:</span> <span class="st">&quot;RESTORED&quot;</span><span class="fu">,</span></span>
-<span id="cb1560-5"><a href="#cb1560-5" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span><span class="ot">,</span></span>
-<span id="cb1560-6"><a href="#cb1560-6" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
-<span id="cb1560-7"><a href="#cb1560-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Object&quot;</span><span class="fu">:</span> <span class="st">&quot;test/file4.txt&quot;</span></span>
-<span id="cb1560-8"><a href="#cb1560-8" aria-hidden="true" tabindex="-1"></a> <span class="st">&quot;Status&quot;</span><span class="er">:</span> <span class="st">&quot;RESTORED&quot;</span><span class="fu">,</span></span>
-<span id="cb1560-9"><a href="#cb1560-9" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
-<span id="cb1560-10"><a href="#cb1560-10" aria-hidden="true" tabindex="-1"></a><span class="ot">]</span></span></code></pre></div>
+<div class="sourceCode" id="cb1601"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb1601-1"><a href="#cb1601-1" aria-hidden="true" tabindex="-1"></a><span class="ot">[</span></span>
+<span id="cb1601-2"><a href="#cb1601-2" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
+<span id="cb1601-3"><a href="#cb1601-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Object&quot;</span><span class="fu">:</span> <span class="st">&quot;test.txt&quot;</span></span>
+<span id="cb1601-4"><a href="#cb1601-4" aria-hidden="true" tabindex="-1"></a> <span class="st">&quot;Status&quot;</span><span class="er">:</span> <span class="st">&quot;RESTORED&quot;</span><span class="fu">,</span></span>
+<span id="cb1601-5"><a href="#cb1601-5" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span><span class="ot">,</span></span>
+<span id="cb1601-6"><a href="#cb1601-6" aria-hidden="true" tabindex="-1"></a> <span class="fu">{</span></span>
+<span id="cb1601-7"><a href="#cb1601-7" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Object&quot;</span><span class="fu">:</span> <span class="st">&quot;test/file4.txt&quot;</span></span>
+<span id="cb1601-8"><a href="#cb1601-8" aria-hidden="true" tabindex="-1"></a> <span class="st">&quot;Status&quot;</span><span class="er">:</span> <span class="st">&quot;RESTORED&quot;</span><span class="fu">,</span></span>
+<span id="cb1601-9"><a href="#cb1601-9" aria-hidden="true" tabindex="-1"></a> <span class="fu">}</span></span>
+<span id="cb1601-10"><a href="#cb1601-10" aria-hidden="true" tabindex="-1"></a><span class="ot">]</span></span></code></pre></div>
<p>Options:</p>
<ul>
<li>"hours": The number of hours for which this object will be restored.
@@ -54411,7 +56736,7 @@ Buckets</a></h3>
<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-44">Configuration</h2>
+<h2 id="configuration-45">Configuration</h2>
<p>Here is an example of making an QingStor configuration. First run</p>
<pre class="console"><code>rclone config</code></pre>
<p>This will guide you through an interactive setup process.</p>
@@ -54502,7 +56827,7 @@ 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-8">Authentication</h3>
+<h3 id="authentication-9">Authentication</h3>
<p>There are two ways to supply <code>rclone</code> with a set of
QingStor credentials. In order of precedence:</p>
<ul>
@@ -54526,7 +56851,7 @@ file</li>
</ul></li>
</ul></li>
</ul>
-<h3 id="restricted-filename-characters-25">Restricted filename
+<h3 id="restricted-filename-characters-26">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
@@ -54536,7 +56861,7 @@ href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they
can't be used in JSON strings.</p>
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/qingstor/qingstor.go and run make backenddocs to verify -->
<!-- markdownlint-disable-line line-length -->
-<h3 id="standard-options-44">Standard options</h3>
+<h3 id="standard-options-45">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>
@@ -54620,7 +56945,7 @@ IAM).</li>
</ul></li>
</ul></li>
</ul>
-<h3 id="advanced-options-45">Advanced options</h3>
+<h3 id="advanced-options-46">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>
@@ -54696,7 +57021,7 @@ section in the overview</a> for more info.</p>
<li>Required: false</li>
</ul>
<!-- autogenerated options stop -->
-<h2 id="limitations-32">Limitations</h2>
+<h2 id="limitations-34">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
@@ -54720,7 +57045,7 @@ class="uri">https://docs.maytech.net/quatrix/quatrix-api/api-explorer#/API-Key/p
<p>See complete <a
href="https://docs.maytech.net/quatrix/quatrix-api/api-explorer">Swagger
documentation for Quatrix</a>.</p>
-<h2 id="configuration-45">Configuration</h2>
+<h2 id="configuration-46">Configuration</h2>
<p>Here is an example of how to make a remote called
<code>remote</code>. First run:</p>
<pre class="console"><code>rclone config</code></pre>
@@ -54810,14 +57135,14 @@ y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
-<h3 id="modification-times-and-hashes-22">Modification times and
+<h3 id="modification-times-and-hashes-23">Modification times and
hashes</h3>
<p>Quatrix allows modification times to be set on objects accurate to 1
microsecond. These will be used to detect whether objects need syncing
or not.</p>
<p>Quatrix does not support hashes, so you cannot use the
<code>--checksum</code> flag.</p>
-<h3 id="restricted-filename-characters-26">Restricted filename
+<h3 id="restricted-filename-characters-27">Restricted filename
characters</h3>
<p>File names in Quatrix are case sensitive and have limitations like
the maximum length of a filename is 255, and the minimum length is 1. A
@@ -54847,7 +57172,7 @@ and an API to empty the Trash so that you can remove files permanently
from your account.</p>
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/quatrix/quatrix.go and run make backenddocs to verify -->
<!-- markdownlint-disable-line line-length -->
-<h3 id="standard-options-45">Standard options</h3>
+<h3 id="standard-options-46">Standard options</h3>
<p>Here are the Standard options specific to quatrix (Quatrix by
Maytech).</p>
<h4 id="quatrix-api-key">--quatrix-api-key</h4>
@@ -54868,7 +57193,7 @@ Maytech).</p>
<li>Type: string</li>
<li>Required: true</li>
</ul>
-<h3 id="advanced-options-46">Advanced options</h3>
+<h3 id="advanced-options-47">Advanced options</h3>
<p>Here are the Advanced options specific to quatrix (Quatrix by
Maytech).</p>
<h4 id="quatrix-encoding">--quatrix-encoding</h4>
@@ -54947,7 +57272,7 @@ purchase. You can restrict any user with a smaller storage limit. The
account limit is applied if the user has no custom storage limit. Once
you've reached the limit, the upload of files will fail. This can be
fixed by freeing up the space or increasing the quota.</p>
-<h2 id="server-side-operations">Server-side operations</h2>
+<h2 id="server-side-operations-1">Server-side operations</h2>
<p>Quatrix supports server-side operations (copy and move). In case of
conflict, files are overwritten during server-side operation.</p>
<h1 id="sia">Sia</h1>
@@ -55009,7 +57334,7 @@ it <strong>on localhost</strong> with command line argument
<code>--authorize-api=false</code>, but this is insecure and
<strong>strongly discouraged</strong>.</li>
</ol>
-<h2 id="configuration-46">Configuration</h2>
+<h2 id="configuration-47">Configuration</h2>
<p>Here is an example of how to make a <code>sia</code> remote called
<code>mySia</code>. First, run:</p>
<pre class="console"><code>rclone config</code></pre>
@@ -55069,7 +57394,7 @@ y/e/d&gt; y</code></pre>
</ul>
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/sia/sia.go and run make backenddocs to verify -->
<!-- markdownlint-disable-line line-length -->
-<h3 id="standard-options-46">Standard options</h3>
+<h3 id="standard-options-47">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>
@@ -55098,7 +57423,7 @@ obscure</a>.</p>
<li>Type: string</li>
<li>Required: false</li>
</ul>
-<h3 id="advanced-options-47">Advanced options</h3>
+<h3 id="advanced-options-48">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>
@@ -55133,7 +57458,7 @@ section in the overview</a> for more info.</p>
<li>Required: false</li>
</ul>
<!-- autogenerated options stop -->
-<h2 id="limitations-33">Limitations</h2>
+<h2 id="limitations-35">Limitations</h2>
<ul>
<li>Modification times not supported</li>
<li>Checksums not supported</li>
@@ -55170,7 +57495,7 @@ Bluemix Cloud ObjectStorage Swift</a></li>
<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-47">Configuration</h2>
+<h2 id="configuration-48">Configuration</h2>
<p>Here is an example of making a swift configuration. First run</p>
<pre class="console"><code>rclone config</code></pre>
<p>This will guide you through an interactive setup process.</p>
@@ -55279,27 +57604,27 @@ deleting any excess files in the container.</p>
from an OpenStack credentials file</h3>
<p>An OpenStack credentials file typically looks something something
like this (without the comments)</p>
-<div class="sourceCode" id="cb1584"><pre
-class="sourceCode sh"><code class="sourceCode bash"><span id="cb1584-1"><a href="#cb1584-1" aria-hidden="true" tabindex="-1"></a><span class="bu">export</span> <span class="va">OS_AUTH_URL</span><span class="op">=</span>https://a.provider.net/v2.0</span>
-<span id="cb1584-2"><a href="#cb1584-2" aria-hidden="true" tabindex="-1"></a><span class="bu">export</span> <span class="va">OS_TENANT_ID</span><span class="op">=</span>ffffffffffffffffffffffffffffffff</span>
-<span id="cb1584-3"><a href="#cb1584-3" aria-hidden="true" tabindex="-1"></a><span class="bu">export</span> <span class="va">OS_TENANT_NAME</span><span class="op">=</span><span class="st">&quot;1234567890123456&quot;</span></span>
-<span id="cb1584-4"><a href="#cb1584-4" aria-hidden="true" tabindex="-1"></a><span class="bu">export</span> <span class="va">OS_USERNAME</span><span class="op">=</span><span class="st">&quot;123abc567xy&quot;</span></span>
-<span id="cb1584-5"><a href="#cb1584-5" aria-hidden="true" tabindex="-1"></a><span class="bu">echo</span> <span class="st">&quot;Please enter your OpenStack Password: &quot;</span></span>
-<span id="cb1584-6"><a href="#cb1584-6" aria-hidden="true" tabindex="-1"></a><span class="bu">read</span> <span class="at">-sr</span> <span class="va">OS_PASSWORD_INPUT</span></span>
-<span id="cb1584-7"><a href="#cb1584-7" aria-hidden="true" tabindex="-1"></a><span class="bu">export</span> <span class="va">OS_PASSWORD</span><span class="op">=</span><span class="va">$OS_PASSWORD_INPUT</span></span>
-<span id="cb1584-8"><a href="#cb1584-8" aria-hidden="true" tabindex="-1"></a><span class="bu">export</span> <span class="va">OS_REGION_NAME</span><span class="op">=</span><span class="st">&quot;SBG1&quot;</span></span>
-<span id="cb1584-9"><a href="#cb1584-9" aria-hidden="true" tabindex="-1"></a><span class="cf">if</span> <span class="bu">[</span> <span class="ot">-z</span> <span class="st">&quot;</span><span class="va">$OS_REGION_NAME</span><span class="st">&quot;</span> <span class="bu">]</span><span class="kw">;</span> <span class="cf">then</span> <span class="bu">unset</span> <span class="va">OS_REGION_NAME</span><span class="kw">;</span> <span class="cf">fi</span></span></code></pre></div>
+<div class="sourceCode" id="cb1625"><pre
+class="sourceCode sh"><code class="sourceCode bash"><span id="cb1625-1"><a href="#cb1625-1" aria-hidden="true" tabindex="-1"></a><span class="bu">export</span> <span class="va">OS_AUTH_URL</span><span class="op">=</span>https://a.provider.net/v2.0</span>
+<span id="cb1625-2"><a href="#cb1625-2" aria-hidden="true" tabindex="-1"></a><span class="bu">export</span> <span class="va">OS_TENANT_ID</span><span class="op">=</span>ffffffffffffffffffffffffffffffff</span>
+<span id="cb1625-3"><a href="#cb1625-3" aria-hidden="true" tabindex="-1"></a><span class="bu">export</span> <span class="va">OS_TENANT_NAME</span><span class="op">=</span><span class="st">&quot;1234567890123456&quot;</span></span>
+<span id="cb1625-4"><a href="#cb1625-4" aria-hidden="true" tabindex="-1"></a><span class="bu">export</span> <span class="va">OS_USERNAME</span><span class="op">=</span><span class="st">&quot;123abc567xy&quot;</span></span>
+<span id="cb1625-5"><a href="#cb1625-5" aria-hidden="true" tabindex="-1"></a><span class="bu">echo</span> <span class="st">&quot;Please enter your OpenStack Password: &quot;</span></span>
+<span id="cb1625-6"><a href="#cb1625-6" aria-hidden="true" tabindex="-1"></a><span class="bu">read</span> <span class="at">-sr</span> <span class="va">OS_PASSWORD_INPUT</span></span>
+<span id="cb1625-7"><a href="#cb1625-7" aria-hidden="true" tabindex="-1"></a><span class="bu">export</span> <span class="va">OS_PASSWORD</span><span class="op">=</span><span class="va">$OS_PASSWORD_INPUT</span></span>
+<span id="cb1625-8"><a href="#cb1625-8" aria-hidden="true" tabindex="-1"></a><span class="bu">export</span> <span class="va">OS_REGION_NAME</span><span class="op">=</span><span class="st">&quot;SBG1&quot;</span></span>
+<span id="cb1625-9"><a href="#cb1625-9" aria-hidden="true" tabindex="-1"></a><span class="cf">if</span> <span class="bu">[</span> <span class="ot">-z</span> <span class="st">&quot;</span><span class="va">$OS_REGION_NAME</span><span class="st">&quot;</span> <span class="bu">]</span><span class="kw">;</span> <span class="cf">then</span> <span class="bu">unset</span> <span class="va">OS_REGION_NAME</span><span class="kw">;</span> <span class="cf">fi</span></span></code></pre></div>
<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>
-<div class="sourceCode" id="cb1585"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1585-1"><a href="#cb1585-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[remote]</span></span>
-<span id="cb1585-2"><a href="#cb1585-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> swift</span></span>
-<span id="cb1585-3"><a href="#cb1585-3" aria-hidden="true" tabindex="-1"></a><span class="dt">user </span><span class="ot">=</span><span class="st"> $OS_USERNAME</span></span>
-<span id="cb1585-4"><a href="#cb1585-4" aria-hidden="true" tabindex="-1"></a><span class="dt">key </span><span class="ot">=</span><span class="st"> $OS_PASSWORD</span></span>
-<span id="cb1585-5"><a href="#cb1585-5" aria-hidden="true" tabindex="-1"></a><span class="dt">auth </span><span class="ot">=</span><span class="st"> $OS_AUTH_URL</span></span>
-<span id="cb1585-6"><a href="#cb1585-6" aria-hidden="true" tabindex="-1"></a><span class="dt">tenant </span><span class="ot">=</span><span class="st"> $OS_TENANT_NAME</span></span></code></pre></div>
+<div class="sourceCode" id="cb1626"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1626-1"><a href="#cb1626-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[remote]</span></span>
+<span id="cb1626-2"><a href="#cb1626-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> swift</span></span>
+<span id="cb1626-3"><a href="#cb1626-3" aria-hidden="true" tabindex="-1"></a><span class="dt">user </span><span class="ot">=</span><span class="st"> $OS_USERNAME</span></span>
+<span id="cb1626-4"><a href="#cb1626-4" aria-hidden="true" tabindex="-1"></a><span class="dt">key </span><span class="ot">=</span><span class="st"> $OS_PASSWORD</span></span>
+<span id="cb1626-5"><a href="#cb1626-5" aria-hidden="true" tabindex="-1"></a><span class="dt">auth </span><span class="ot">=</span><span class="st"> $OS_AUTH_URL</span></span>
+<span id="cb1626-6"><a href="#cb1626-6" aria-hidden="true" tabindex="-1"></a><span class="dt">tenant </span><span class="ot">=</span><span class="st"> $OS_TENANT_NAME</span></span></code></pre></div>
<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
@@ -55328,11 +57653,11 @@ OpenStack installation.</p>
config file</h4>
<p>You can use rclone with swift without a config file, if desired, like
this:</p>
-<div class="sourceCode" id="cb1586"><pre
-class="sourceCode sh"><code class="sourceCode bash"><span id="cb1586-1"><a href="#cb1586-1" aria-hidden="true" tabindex="-1"></a><span class="bu">source</span> openstack-credentials-file</span>
-<span id="cb1586-2"><a href="#cb1586-2" aria-hidden="true" tabindex="-1"></a><span class="bu">export</span> <span class="va">RCLONE_CONFIG_MYREMOTE_TYPE</span><span class="op">=</span>swift</span>
-<span id="cb1586-3"><a href="#cb1586-3" aria-hidden="true" tabindex="-1"></a><span class="bu">export</span> <span class="va">RCLONE_CONFIG_MYREMOTE_ENV_AUTH</span><span class="op">=</span>true</span>
-<span id="cb1586-4"><a href="#cb1586-4" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> lsd myremote:</span></code></pre></div>
+<div class="sourceCode" id="cb1627"><pre
+class="sourceCode sh"><code class="sourceCode bash"><span id="cb1627-1"><a href="#cb1627-1" aria-hidden="true" tabindex="-1"></a><span class="bu">source</span> openstack-credentials-file</span>
+<span id="cb1627-2"><a href="#cb1627-2" aria-hidden="true" tabindex="-1"></a><span class="bu">export</span> <span class="va">RCLONE_CONFIG_MYREMOTE_TYPE</span><span class="op">=</span>swift</span>
+<span id="cb1627-3"><a href="#cb1627-3" aria-hidden="true" tabindex="-1"></a><span class="bu">export</span> <span class="va">RCLONE_CONFIG_MYREMOTE_ENV_AUTH</span><span class="op">=</span>true</span>
+<span id="cb1627-4"><a href="#cb1627-4" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> lsd myremote:</span></code></pre></div>
<h3 id="fast-list-8">--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
@@ -55350,7 +57675,7 @@ 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="modification-times-and-hashes-23">Modification times and
+<h3 id="modification-times-and-hashes-24">Modification times and
hashes</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
@@ -55358,7 +57683,7 @@ 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>
<p>The MD5 hash algorithm is supported.</p>
-<h3 id="restricted-filename-characters-27">Restricted filename
+<h3 id="restricted-filename-characters-28">Restricted filename
characters</h3>
<table>
<thead>
@@ -55386,7 +57711,7 @@ href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they
can't be used in JSON strings.</p>
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/swift/swift.go and run make backenddocs to verify -->
<!-- markdownlint-disable-line line-length -->
-<h3 id="standard-options-47">Standard options</h3>
+<h3 id="standard-options-48">Standard options</h3>
<p>Here are the Standard options specific to swift (OpenStack Swift
(Rackspace Cloud Files, Blomp Cloud Storage, Memset Memstore, OVH)).</p>
<h4 id="swift-env-auth">--swift-env-auth</h4>
@@ -55638,7 +57963,7 @@ provider.</p>
</ul></li>
</ul></li>
</ul>
-<h3 id="advanced-options-48">Advanced options</h3>
+<h3 id="advanced-options-49">Advanced options</h3>
<p>Here are the Advanced options specific to swift (OpenStack Swift
(Rackspace Cloud Files, Blomp Cloud Storage, Memset Memstore, OVH)).</p>
<h4 id="swift-leave-parts-on-error">--swift-leave-parts-on-error</h4>
@@ -55798,7 +58123,7 @@ section in the overview</a> for more info.</p>
<li>Required: false</li>
</ul>
<!-- autogenerated options stop -->
-<h2 id="limitations-34">Limitations</h2>
+<h2 id="limitations-36">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>
@@ -55839,7 +58164,7 @@ the following:</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-48">Configuration</h2>
+<h2 id="configuration-49">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>
@@ -55910,7 +58235,7 @@ you to unblock it temporarily if you are running a host firewall.</p>
<pre class="console"><code>rclone ls remote:</code></pre>
<p>To copy a local directory to a pCloud directory called backup</p>
<pre class="console"><code>rclone copy /home/source remote:backup</code></pre>
-<h3 id="modification-times-and-hashes-24">Modification times and
+<h3 id="modification-times-and-hashes-25">Modification times 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
@@ -55919,7 +58244,7 @@ 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-28">Restricted filename
+<h3 id="restricted-filename-characters-29">Restricted filename
characters</h3>
<p>In addition to the <a
href="https://rclone.org/overview/#restricted-characters">default
@@ -55997,12 +58322,12 @@ without manual refreshes.</li>
</ul>
<p>If you want to debug or verify notifications, you can use the helper
command:</p>
-<div class="sourceCode" id="cb1594"><pre
-class="sourceCode bash"><code class="sourceCode bash"><span id="cb1594-1"><a href="#cb1594-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> test changenotify remote:</span></code></pre></div>
+<div class="sourceCode" id="cb1635"><pre
+class="sourceCode bash"><code class="sourceCode bash"><span id="cb1635-1"><a href="#cb1635-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> test changenotify remote:</span></code></pre></div>
<p>This will log incoming change notifications for the given remote.</p>
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/pcloud/pcloud.go and run make backenddocs to verify -->
<!-- markdownlint-disable-line line-length -->
-<h3 id="standard-options-48">Standard options</h3>
+<h3 id="standard-options-49">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>
@@ -56024,7 +58349,7 @@ class="sourceCode bash"><code class="sourceCode bash"><span id="cb1594-1"><a hre
<li>Type: string</li>
<li>Required: false</li>
</ul>
-<h3 id="advanced-options-49">Advanced options</h3>
+<h3 id="advanced-options-50">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>
@@ -56151,7 +58476,7 @@ obscure</a>.</p>
drive</a>.</p>
<p>Paths are specified as <code>remote:path</code>, and may be as deep
as required, e.g. <code>remote:directory/subdirectory</code>.</p>
-<h2 id="configuration-49">Configuration</h2>
+<h2 id="configuration-50">Configuration</h2>
<p>Here is an example of making a remote for PikPak.</p>
<p>First run:</p>
<pre class="console"><code>rclone config</code></pre>
@@ -56204,7 +58529,7 @@ y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d&gt; y</code></pre>
-<h3 id="modification-times-and-hashes-25">Modification times and
+<h3 id="modification-times-and-hashes-26">Modification times and
hashes</h3>
<p>PikPak keeps modification times on objects, and updates them when
uploading objects, but it does not support changing only the
@@ -56212,7 +58537,7 @@ modification time</p>
<p>The MD5 hash algorithm is supported.</p>
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/pikpak/pikpak.go and run make backenddocs to verify -->
<!-- markdownlint-disable-line line-length -->
-<h3 id="standard-options-49">Standard options</h3>
+<h3 id="standard-options-50">Standard options</h3>
<p>Here are the Standard options specific to pikpak (PikPak).</p>
<h4 id="pikpak-user">--pikpak-user</h4>
<p>Pikpak username.</p>
@@ -56235,7 +58560,7 @@ obscure</a>.</p>
<li>Type: string</li>
<li>Required: true</li>
</ul>
-<h3 id="advanced-options-50">Advanced options</h3>
+<h3 id="advanced-options-51">Advanced options</h3>
<p>Here are the Advanced options specific to pikpak (PikPak).</p>
<h4 id="pikpak-device-id">--pikpak-device-id</h4>
<p>Device ID used for authorization.</p>
@@ -56397,10 +58722,15 @@ href="https://rclone.org/rc/#backend-command">backend/command</a>.</p>
<p>Add offline download task for url.</p>
<pre class="console"><code>rclone backend addurl remote: [options] [&lt;arguments&gt;+]</code></pre>
<p>This command adds offline download task for url.</p>
-<p>Usage example:</p>
-<pre class="console"><code>rclone backend addurl pikpak:dirpath url</code></pre>
+<p>Usage examples:</p>
+<pre class="console"><code>rclone backend addurl pikpak:dirpath url
+rclone backend addurl pikpak:dirpath url -o name=custom_filename.zip</code></pre>
<p>Downloads will be stored in 'dirpath'. If 'dirpath' is invalid,
download will fallback to default 'My Pack' folder.</p>
+<p>Options:</p>
+<ul>
+<li>"name": Custom filename for the downloaded file.</li>
+</ul>
<h3 id="decompress">decompress</h3>
<p>Request decompress of a file/files in a folder.</p>
<pre class="console"><code>rclone backend decompress remote: [options] [&lt;arguments&gt;+]</code></pre>
@@ -56413,14 +58743,14 @@ in 'pikpak:dirpath'. You may want to pass '-o password=password' for a
password-protected files. Also, pass '-o delete-src-file' to delete
source files after decompression finished.</p>
<p>Result:</p>
-<div class="sourceCode" id="cb1602"><pre
-class="sourceCode json"><code class="sourceCode json"><span id="cb1602-1"><a href="#cb1602-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
-<span id="cb1602-2"><a href="#cb1602-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Decompressed&quot;</span><span class="fu">:</span> <span class="dv">17</span><span class="fu">,</span></span>
-<span id="cb1602-3"><a href="#cb1602-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;SourceDeleted&quot;</span><span class="fu">:</span> <span class="dv">0</span><span class="fu">,</span></span>
-<span id="cb1602-4"><a href="#cb1602-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Errors&quot;</span><span class="fu">:</span> <span class="dv">0</span></span>
-<span id="cb1602-5"><a href="#cb1602-5" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
+<div class="sourceCode" id="cb1643"><pre
+class="sourceCode json"><code class="sourceCode json"><span id="cb1643-1"><a href="#cb1643-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
+<span id="cb1643-2"><a href="#cb1643-2" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Decompressed&quot;</span><span class="fu">:</span> <span class="dv">17</span><span class="fu">,</span></span>
+<span id="cb1643-3"><a href="#cb1643-3" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;SourceDeleted&quot;</span><span class="fu">:</span> <span class="dv">0</span><span class="fu">,</span></span>
+<span id="cb1643-4"><a href="#cb1643-4" aria-hidden="true" tabindex="-1"></a> <span class="dt">&quot;Errors&quot;</span><span class="fu">:</span> <span class="dv">0</span></span>
+<span id="cb1643-5"><a href="#cb1643-5" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<!-- autogenerated options stop -->
-<h2 id="limitations-35">Limitations</h2>
+<h2 id="limitations-37">Limitations</h2>
<h3 id="hashes-may-be-empty">Hashes may be empty</h3>
<p>PikPak supports MD5 hash, but sometimes given empty especially for
user-uploaded files.</p>
@@ -56525,7 +58855,7 @@ directory and their public IDs.</p>
access the directory.</p>
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/pixeldrain/pixeldrain.go and run make backenddocs to verify -->
<!-- markdownlint-disable-line line-length -->
-<h3 id="standard-options-50">Standard options</h3>
+<h3 id="standard-options-51">Standard options</h3>
<p>Here are the Standard options specific to pixeldrain (Pixeldrain
Filesystem).</p>
<h4 id="pixeldrain-api-key">--pixeldrain-api-key</h4>
@@ -56549,7 +58879,7 @@ directory ID to use a shared directory.</p>
<li>Type: string</li>
<li>Default: "me"</li>
</ul>
-<h3 id="advanced-options-51">Advanced options</h3>
+<h3 id="advanced-options-52">Advanced options</h3>
<p>Here are the Advanced options specific to pixeldrain (Pixeldrain
Filesystem).</p>
<h4 id="pixeldrain-api-url">--pixeldrain-api-url</h4>
@@ -56572,7 +58902,7 @@ testing purposes.</p>
<li>Type: string</li>
<li>Required: false</li>
</ul>
-<h3 id="metadata-19">Metadata</h3>
+<h3 id="metadata-22">Metadata</h3>
<p>Pixeldrain supports file modes and creation times.</p>
<p>Here are the possible system metadata items for the pixeldrain
backend.</p>
@@ -56624,7 +58954,7 @@ for more info.</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-50">Configuration</h2>
+<h2 id="configuration-51">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.
@@ -56687,12 +59017,12 @@ you to unblock it temporarily if you are running a host firewall.</p>
<p>To copy a local directory to an premiumize.me directory called
backup</p>
<pre class="console"><code>rclone copy /home/source remote:backup</code></pre>
-<h3 id="modification-times-and-hashes-26">Modification times and
+<h3 id="modification-times-and-hashes-27">Modification times 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-29">Restricted filename
+<h3 id="restricted-filename-characters-30">Restricted filename
characters</h3>
<p>In addition to the <a
href="https://rclone.org/overview/#restricted-characters">default
@@ -56724,7 +59054,7 @@ href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they
can't be used in JSON strings.</p>
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/premiumizeme/premiumizeme.go and run make backenddocs to verify -->
<!-- markdownlint-disable-line line-length -->
-<h3 id="standard-options-51">Standard options</h3>
+<h3 id="standard-options-52">Standard options</h3>
<p>Here are the Standard options specific to premiumizeme
(premiumize.me).</p>
<h4 id="premiumizeme-client-id">--premiumizeme-client-id</h4>
@@ -56757,7 +59087,7 @@ can't be used in JSON strings.</p>
<li>Type: string</li>
<li>Required: false</li>
</ul>
-<h3 id="advanced-options-52">Advanced options</h3>
+<h3 id="advanced-options-53">Advanced options</h3>
<p>Here are the Advanced options specific to premiumizeme
(premiumize.me).</p>
<h4 id="premiumizeme-token">--premiumizeme-token</h4>
@@ -56823,7 +59153,7 @@ section in the overview</a> for more info.</p>
<li>Required: false</li>
</ul>
<!-- autogenerated options stop -->
-<h2 id="limitations-36">Limitations</h2>
+<h2 id="limitations-38">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
@@ -56905,12 +59235,12 @@ attempting to use the credentials in <code>rclone</code> will fail.</p>
<p>To copy a local directory to an Proton Drive directory called
backup</p>
<pre class="console"><code>rclone copy /home/source remote:backup</code></pre>
-<h3 id="modification-times-and-hashes-27">Modification times and
+<h3 id="modification-times-and-hashes-28">Modification times and
hashes</h3>
<p>Proton Drive Bridge does not support updating modification times
yet.</p>
<p>The SHA1 hash algorithm is supported.</p>
-<h3 id="restricted-filename-characters-30">Restricted filename
+<h3 id="restricted-filename-characters-31">Restricted filename
characters</h3>
<p>Invalid UTF-8 bytes will be <a
href="https://rclone.org/overview/#invalid-utf8">replaced</a>, also left
@@ -56925,7 +59255,7 @@ might or might not be overwritten.</p>
href="https://proton.me/support/the-difference-between-the-mailbox-password-and-login-password">Mailbox
password</a></h3>
<p>Please set your mailbox password in the advanced config section.</p>
-<h3 id="caching">Caching</h3>
+<h3 id="caching-1">Caching</h3>
<p>The cache is currently built for the case when the rclone is the only
instance performing operations to the mount point. The event system,
which is the proton API system that provides visibility of what has
@@ -56935,7 +59265,7 @@ clients accessing the same mount point, then we might have a problem
with caching the stale data.</p>
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/protondrive/protondrive.go and run make backenddocs to verify -->
<!-- markdownlint-disable-line line-length -->
-<h3 id="standard-options-52">Standard options</h3>
+<h3 id="standard-options-53">Standard options</h3>
<p>Here are the Standard options specific to protondrive (Proton
Drive).</p>
<h4 id="protondrive-username">--protondrive-username</h4>
@@ -56987,7 +59317,7 @@ obscure</a>.</p>
<li>Type: string</li>
<li>Required: false</li>
</ul>
-<h3 id="advanced-options-53">Advanced options</h3>
+<h3 id="advanced-options-54">Advanced options</h3>
<p>Here are the Advanced options specific to protondrive (Proton
Drive).</p>
<h4
@@ -57073,15 +59403,17 @@ content size, will fail to operate properly</p>
</ul>
<h4 id="protondrive-app-version">--protondrive-app-version</h4>
<p>The app version string</p>
-<p>The app version string indicates the client that is currently
-performing the API request. This information is required and will be
-sent with every API request.</p>
+<pre><code> The app version string identifies the client that is currently performing
+ the API request. Third-party Proton Drive integrations should use the form
+ external-drive-&lt;project&gt;@&lt;version&gt;. If this option is left empty, rclone
+ derives a compliant value from its own version. This value is sent with
+ every API request; the option itself is optional.</code></pre>
<p>Properties:</p>
<ul>
<li>Config: app_version</li>
<li>Env Var: RCLONE_PROTONDRIVE_APP_VERSION</li>
<li>Type: string</li>
-<li>Default: "[email protected]+rclone"</li>
+<li>Required: false</li>
</ul>
<h4
id="protondrive-replace-existing-draft">--protondrive-replace-existing-draft</h4>
@@ -57137,7 +59469,7 @@ with caching the stale data.</p>
<li>Required: false</li>
</ul>
<!-- autogenerated options stop -->
-<h2 id="limitations-37">Limitations</h2>
+<h2 id="limitations-39">Limitations</h2>
<p>This backend uses the <a
href="https://github.com/henrybear327/Proton-API-Bridge">Proton-API-Bridge</a>,
which is based on <a
@@ -57166,7 +59498,7 @@ this library, as there isn't official documentation available.</p>
<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-51">Configuration</h2>
+<h2 id="configuration-52">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>
@@ -57242,7 +59574,7 @@ mode.</p>
<pre class="console"><code>rclone ls remote:</code></pre>
<p>To copy a local directory to a put.io directory called backup</p>
<pre class="console"><code>rclone copy /home/source remote:backup</code></pre>
-<h3 id="restricted-filename-characters-31">Restricted filename
+<h3 id="restricted-filename-characters-32">Restricted filename
characters</h3>
<p>In addition to the <a
href="https://rclone.org/overview/#restricted-characters">default
@@ -57269,7 +59601,7 @@ href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they
can't be used in JSON strings.</p>
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/putio/putio.go and run make backenddocs to verify -->
<!-- markdownlint-disable-line line-length -->
-<h3 id="standard-options-53">Standard options</h3>
+<h3 id="standard-options-54">Standard options</h3>
<p>Here are the Standard options specific to putio (Put.io).</p>
<h4 id="putio-client-id">--putio-client-id</h4>
<p>OAuth Client Id.</p>
@@ -57291,7 +59623,7 @@ can't be used in JSON strings.</p>
<li>Type: string</li>
<li>Required: false</li>
</ul>
-<h3 id="advanced-options-54">Advanced options</h3>
+<h3 id="advanced-options-55">Advanced options</h3>
<p>Here are the Advanced options specific to putio (Put.io).</p>
<h4 id="putio-token">--putio-token</h4>
<p>OAuth Access Token as a JSON blob.</p>
@@ -57355,7 +59687,7 @@ section in the overview</a> for more info.</p>
<li>Required: false</li>
</ul>
<!-- autogenerated options stop -->
-<h2 id="limitations-38">Limitations</h2>
+<h2 id="limitations-40">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
@@ -57436,12 +59768,12 @@ attempting to use the credentials in <code>rclone</code> will fail.</p>
<p>To copy a local directory to an Proton Drive directory called
backup</p>
<pre class="console"><code>rclone copy /home/source remote:backup</code></pre>
-<h3 id="modification-times-and-hashes-28">Modification times and
+<h3 id="modification-times-and-hashes-29">Modification times and
hashes</h3>
<p>Proton Drive Bridge does not support updating modification times
yet.</p>
<p>The SHA1 hash algorithm is supported.</p>
-<h3 id="restricted-filename-characters-32">Restricted filename
+<h3 id="restricted-filename-characters-33">Restricted filename
characters</h3>
<p>Invalid UTF-8 bytes will be <a
href="https://rclone.org/overview/#invalid-utf8">replaced</a>, also left
@@ -57456,7 +59788,7 @@ might or might not be overwritten.</p>
href="https://proton.me/support/the-difference-between-the-mailbox-password-and-login-password">Mailbox
password</a></h3>
<p>Please set your mailbox password in the advanced config section.</p>
-<h3 id="caching-1">Caching</h3>
+<h3 id="caching-2">Caching</h3>
<p>The cache is currently built for the case when the rclone is the only
instance performing operations to the mount point. The event system,
which is the proton API system that provides visibility of what has
@@ -57466,7 +59798,7 @@ clients accessing the same mount point, then we might have a problem
with caching the stale data.</p>
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/protondrive/protondrive.go and run make backenddocs to verify -->
<!-- markdownlint-disable-line line-length -->
-<h3 id="standard-options-54">Standard options</h3>
+<h3 id="standard-options-55">Standard options</h3>
<p>Here are the Standard options specific to protondrive (Proton
Drive).</p>
<h4 id="protondrive-username-1">--protondrive-username</h4>
@@ -57518,7 +59850,7 @@ obscure</a>.</p>
<li>Type: string</li>
<li>Required: false</li>
</ul>
-<h3 id="advanced-options-55">Advanced options</h3>
+<h3 id="advanced-options-56">Advanced options</h3>
<p>Here are the Advanced options specific to protondrive (Proton
Drive).</p>
<h4
@@ -57604,15 +59936,17 @@ content size, will fail to operate properly</p>
</ul>
<h4 id="protondrive-app-version-1">--protondrive-app-version</h4>
<p>The app version string</p>
-<p>The app version string indicates the client that is currently
-performing the API request. This information is required and will be
-sent with every API request.</p>
+<pre><code> The app version string identifies the client that is currently performing
+ the API request. Third-party Proton Drive integrations should use the form
+ external-drive-&lt;project&gt;@&lt;version&gt;. If this option is left empty, rclone
+ derives a compliant value from its own version. This value is sent with
+ every API request; the option itself is optional.</code></pre>
<p>Properties:</p>
<ul>
<li>Config: app_version</li>
<li>Env Var: RCLONE_PROTONDRIVE_APP_VERSION</li>
<li>Type: string</li>
-<li>Default: "[email protected]+rclone"</li>
+<li>Required: false</li>
</ul>
<h4
id="protondrive-replace-existing-draft-1">--protondrive-replace-existing-draft</h4>
@@ -57668,7 +60002,7 @@ with caching the stale data.</p>
<li>Required: false</li>
</ul>
<!-- autogenerated options stop -->
-<h2 id="limitations-39">Limitations</h2>
+<h2 id="limitations-41">Limitations</h2>
<p>This backend uses the <a
href="https://github.com/henrybear327/Proton-API-Bridge">Proton-API-Bridge</a>,
which is based on <a
@@ -57704,7 +60038,7 @@ edition.</li>
<li>It supports 2FA enabled users</li>
<li>Using a Library API Token is <strong>not</strong> supported</li>
</ul>
-<h2 id="configuration-52">Configuration</h2>
+<h2 id="configuration-53">Configuration</h2>
<p>There are two distinct modes you can setup your remote:</p>
<ul>
<li>you point your remote to the <strong>root of the server</strong>,
@@ -57891,7 +60225,7 @@ 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-33">Restricted filename
+<h3 id="restricted-filename-characters-34">Restricted filename
characters</h3>
<p>In addition to the <a
href="https://rclone.org/overview/#restricted-characters">default
@@ -57956,7 +60290,7 @@ href="https://hub.docker.com/r/seafileltd/seafile-mc/">latest docker
image</a> of the seafile community server.</p>
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/seafile/seafile.go and run make backenddocs to verify -->
<!-- markdownlint-disable-line line-length -->
-<h3 id="standard-options-55">Standard options</h3>
+<h3 id="standard-options-56">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>
@@ -58037,7 +60371,7 @@ obscure</a>.</p>
<li>Type: string</li>
<li>Required: false</li>
</ul>
-<h3 id="advanced-options-56">Advanced options</h3>
+<h3 id="advanced-options-57">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>
@@ -58098,7 +60432,7 @@ 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-53">Configuration</h2>
+<h2 id="configuration-54">Configuration</h2>
<p>Here is an example of making an SFTP configuration. First run</p>
<pre class="console"><code>rclone config</code></pre>
<p>This will guide you through an interactive setup process.</p>
@@ -58205,13 +60539,13 @@ provide the path to the user certificate public key file in
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>
-<div class="sourceCode" id="cb1647"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1647-1"><a href="#cb1647-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[remote]</span></span>
-<span id="cb1647-2"><a href="#cb1647-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> sftp</span></span>
-<span id="cb1647-3"><a href="#cb1647-3" aria-hidden="true" tabindex="-1"></a><span class="dt">host </span><span class="ot">=</span><span class="st"> example.com</span></span>
-<span id="cb1647-4"><a href="#cb1647-4" aria-hidden="true" tabindex="-1"></a><span class="dt">user </span><span class="ot">=</span><span class="st"> sftpuser</span></span>
-<span id="cb1647-5"><a href="#cb1647-5" aria-hidden="true" tabindex="-1"></a><span class="dt">key_file </span><span class="ot">=</span><span class="st"> ~/id_rsa</span></span>
-<span id="cb1647-6"><a href="#cb1647-6" aria-hidden="true" tabindex="-1"></a><span class="dt">pubkey_file </span><span class="ot">=</span><span class="st"> ~/id_rsa-cert.pub</span></span></code></pre></div>
+<div class="sourceCode" id="cb1690"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1690-1"><a href="#cb1690-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[remote]</span></span>
+<span id="cb1690-2"><a href="#cb1690-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> sftp</span></span>
+<span id="cb1690-3"><a href="#cb1690-3" aria-hidden="true" tabindex="-1"></a><span class="dt">host </span><span class="ot">=</span><span class="st"> example.com</span></span>
+<span id="cb1690-4"><a href="#cb1690-4" aria-hidden="true" tabindex="-1"></a><span class="dt">user </span><span class="ot">=</span><span class="st"> sftpuser</span></span>
+<span id="cb1690-5"><a href="#cb1690-5" aria-hidden="true" tabindex="-1"></a><span class="dt">key_file </span><span class="ot">=</span><span class="st"> ~/id_rsa</span></span>
+<span id="cb1690-6"><a href="#cb1690-6" aria-hidden="true" tabindex="-1"></a><span class="dt">pubkey_file </span><span class="ot">=</span><span class="st"> ~/id_rsa-cert.pub</span></span></code></pre></div>
<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>
@@ -58226,13 +60560,13 @@ 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>
-<div class="sourceCode" id="cb1649"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1649-1"><a href="#cb1649-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[remote]</span></span>
-<span id="cb1649-2"><a href="#cb1649-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> sftp</span></span>
-<span id="cb1649-3"><a href="#cb1649-3" aria-hidden="true" tabindex="-1"></a><span class="dt">host </span><span class="ot">=</span><span class="st"> example.com</span></span>
-<span id="cb1649-4"><a href="#cb1649-4" aria-hidden="true" tabindex="-1"></a><span class="dt">user </span><span class="ot">=</span><span class="st"> sftpuser</span></span>
-<span id="cb1649-5"><a href="#cb1649-5" aria-hidden="true" tabindex="-1"></a><span class="dt">pass </span><span class="ot">=</span><span class="st"> </span></span>
-<span id="cb1649-6"><a href="#cb1649-6" aria-hidden="true" tabindex="-1"></a><span class="dt">known_hosts_file </span><span class="ot">=</span><span class="st"> ~/.ssh/known_hosts</span></span></code></pre></div>
+<div class="sourceCode" id="cb1692"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1692-1"><a href="#cb1692-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[remote]</span></span>
+<span id="cb1692-2"><a href="#cb1692-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> sftp</span></span>
+<span id="cb1692-3"><a href="#cb1692-3" aria-hidden="true" tabindex="-1"></a><span class="dt">host </span><span class="ot">=</span><span class="st"> example.com</span></span>
+<span id="cb1692-4"><a href="#cb1692-4" aria-hidden="true" tabindex="-1"></a><span class="dt">user </span><span class="ot">=</span><span class="st"> sftpuser</span></span>
+<span id="cb1692-5"><a href="#cb1692-5" aria-hidden="true" tabindex="-1"></a><span class="dt">pass </span><span class="ot">=</span><span class="st"> </span></span>
+<span id="cb1692-6"><a href="#cb1692-6" aria-hidden="true" tabindex="-1"></a><span class="dt">known_hosts_file </span><span class="ot">=</span><span class="st"> ~/.ssh/known_hosts</span></span></code></pre></div>
<p>Alternatively you can create your own known hosts file like this:</p>
<pre class="console"><code>ssh-keyscan -t dsa,rsa,ecdsa,ed25519 example.com &gt;&gt; known_hosts</code></pre>
<p>There are some limitations:</p>
@@ -58379,7 +60713,7 @@ option <code>hashes</code> to <code>none</code> or options
<code>none</code> to not only disable checksumming, but also disable all
other functionality that are based on remote shell command
execution.</p>
-<h3 id="modification-times-and-hashes-29">Modification times and
+<h3 id="modification-times-and-hashes-30">Modification times and
hashes</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>
@@ -58404,7 +60738,7 @@ 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>
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/sftp/sftp.go and run make backenddocs to verify -->
<!-- markdownlint-disable-line line-length -->
-<h3 id="standard-options-56">Standard options</h3>
+<h3 id="standard-options-57">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>
@@ -58599,7 +60933,7 @@ connection for every hash it calculates.</p>
<li>Type: SpaceSepList</li>
<li>Default:</li>
</ul>
-<h3 id="advanced-options-57">Advanced options</h3>
+<h3 id="advanced-options-58">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>
@@ -59063,7 +61397,7 @@ as the source and the destination will be the same file.</p>
<li>Required: false</li>
</ul>
<!-- autogenerated options stop -->
-<h2 id="limitations-40">Limitations</h2>
+<h2 id="limitations-42">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. You can either use
<a href="#--sftp-path-override"><code>--sftp-path-override</code></a> or
@@ -59111,7 +61445,7 @@ can start with a free account and get 20GB of storage for free.</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-54">Configuration</h2>
+<h2 id="configuration-55">Configuration</h2>
<p>Here is an example of making a Shade configuration.</p>
<p>First, create a <a href="https://app.shade.inc/">create a free
account</a> account and choose a plan.</p>
@@ -59121,55 +61455,55 @@ account and created drive respectively.</p>
<p>Now run</p>
<p><code>rclone config</code></p>
<p>Follow this interactive process:</p>
-<div class="sourceCode" id="cb1674"><pre
-class="sourceCode sh"><code class="sourceCode bash"><span id="cb1674-1"><a href="#cb1674-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone config</span>
-<span id="cb1674-2"><a href="#cb1674-2" aria-hidden="true" tabindex="-1"></a><span class="ex">e</span><span class="er">)</span> <span class="ex">Edit</span> existing remote</span>
-<span id="cb1674-3"><a href="#cb1674-3" aria-hidden="true" tabindex="-1"></a><span class="ex">n</span><span class="er">)</span> <span class="ex">New</span> remote</span>
-<span id="cb1674-4"><a href="#cb1674-4" aria-hidden="true" tabindex="-1"></a><span class="ex">d</span><span class="er">)</span> <span class="ex">Delete</span> remote</span>
-<span id="cb1674-5"><a href="#cb1674-5" aria-hidden="true" tabindex="-1"></a><span class="ex">r</span><span class="er">)</span> <span class="ex">Rename</span> remote</span>
-<span id="cb1674-6"><a href="#cb1674-6" aria-hidden="true" tabindex="-1"></a><span class="ex">c</span><span class="er">)</span> <span class="ex">Copy</span> remote</span>
-<span id="cb1674-7"><a href="#cb1674-7" aria-hidden="true" tabindex="-1"></a><span class="ex">s</span><span class="er">)</span> <span class="ex">Set</span> configuration password</span>
-<span id="cb1674-8"><a href="#cb1674-8" aria-hidden="true" tabindex="-1"></a><span class="ex">q</span><span class="er">)</span> <span class="ex">Quit</span> config</span>
-<span id="cb1674-9"><a href="#cb1674-9" aria-hidden="true" tabindex="-1"></a><span class="ex">e/n/d/r/c/s/q</span><span class="op">&gt;</span> n</span>
-<span id="cb1674-10"><a href="#cb1674-10" aria-hidden="true" tabindex="-1"></a></span>
-<span id="cb1674-11"><a href="#cb1674-11" aria-hidden="true" tabindex="-1"></a><span class="ex">Enter</span> name for new remote.</span>
-<span id="cb1674-12"><a href="#cb1674-12" aria-hidden="true" tabindex="-1"></a><span class="ex">name</span><span class="op">&gt;</span> Shade</span>
-<span id="cb1674-13"><a href="#cb1674-13" aria-hidden="true" tabindex="-1"></a></span>
-<span id="cb1674-14"><a href="#cb1674-14" aria-hidden="true" tabindex="-1"></a><span class="ex">Option</span> Storage.</span>
-<span id="cb1674-15"><a href="#cb1674-15" aria-hidden="true" tabindex="-1"></a><span class="ex">Type</span> of storage to configure.</span>
-<span id="cb1674-16"><a href="#cb1674-16" aria-hidden="true" tabindex="-1"></a><span class="ex">Choose</span> a number from below, or type in your own value.</span>
-<span id="cb1674-17"><a href="#cb1674-17" aria-hidden="true" tabindex="-1"></a><span class="ex">[OTHER</span> OPTIONS]</span>
-<span id="cb1674-18"><a href="#cb1674-18" aria-hidden="true" tabindex="-1"></a><span class="ex">xx</span> / Shade FS</span>
-<span id="cb1674-19"><a href="#cb1674-19" aria-hidden="true" tabindex="-1"></a> <span class="ex">\ </span><span class="er">(</span><span class="ex">shade</span><span class="kw">)</span></span>
-<span id="cb1674-20"><a href="#cb1674-20" aria-hidden="true" tabindex="-1"></a><span class="ex">[OTHER</span> OPTIONS]</span>
-<span id="cb1674-21"><a href="#cb1674-21" aria-hidden="true" tabindex="-1"></a><span class="ex">Storage</span><span class="op">&gt;</span> xx</span>
-<span id="cb1674-22"><a href="#cb1674-22" aria-hidden="true" tabindex="-1"></a></span>
-<span id="cb1674-23"><a href="#cb1674-23" aria-hidden="true" tabindex="-1"></a><span class="ex">Option</span> drive_id.</span>
-<span id="cb1674-24"><a href="#cb1674-24" aria-hidden="true" tabindex="-1"></a><span class="ex">The</span> ID of your drive, see this in the drive settings. Individual rclone configs must be made per drive.</span>
-<span id="cb1674-25"><a href="#cb1674-25" aria-hidden="true" tabindex="-1"></a><span class="ex">Enter</span> a value.</span>
-<span id="cb1674-26"><a href="#cb1674-26" aria-hidden="true" tabindex="-1"></a><span class="ex">drive_id</span><span class="op">&gt;</span> <span class="pp">[</span><span class="ss">YOUR_ID</span><span class="pp">]</span></span>
-<span id="cb1674-27"><a href="#cb1674-27" aria-hidden="true" tabindex="-1"></a></span>
-<span id="cb1674-28"><a href="#cb1674-28" aria-hidden="true" tabindex="-1"></a><span class="ex">Option</span> api_key.</span>
-<span id="cb1674-29"><a href="#cb1674-29" aria-hidden="true" tabindex="-1"></a><span class="ex">An</span> API key for your account.</span>
-<span id="cb1674-30"><a href="#cb1674-30" aria-hidden="true" tabindex="-1"></a><span class="ex">Enter</span> a value.</span>
-<span id="cb1674-31"><a href="#cb1674-31" aria-hidden="true" tabindex="-1"></a><span class="ex">api_key</span><span class="op">&gt;</span> <span class="pp">[</span><span class="ss">YOUR_API_KEY</span><span class="pp">]</span></span>
-<span id="cb1674-32"><a href="#cb1674-32" aria-hidden="true" tabindex="-1"></a></span>
-<span id="cb1674-33"><a href="#cb1674-33" aria-hidden="true" tabindex="-1"></a><span class="ex">Edit</span> advanced config<span class="pp">?</span></span>
-<span id="cb1674-34"><a href="#cb1674-34" aria-hidden="true" tabindex="-1"></a><span class="ex">y</span><span class="er">)</span> <span class="ex">Yes</span></span>
-<span id="cb1674-35"><a href="#cb1674-35" aria-hidden="true" tabindex="-1"></a><span class="ex">n</span><span class="er">)</span> <span class="ex">No</span> <span class="er">(</span><span class="ex">default</span><span class="kw">)</span></span>
-<span id="cb1674-36"><a href="#cb1674-36" aria-hidden="true" tabindex="-1"></a><span class="ex">y/n</span><span class="op">&gt;</span> n</span>
-<span id="cb1674-37"><a href="#cb1674-37" aria-hidden="true" tabindex="-1"></a></span>
-<span id="cb1674-38"><a href="#cb1674-38" aria-hidden="true" tabindex="-1"></a><span class="ex">Configuration</span> complete.</span>
-<span id="cb1674-39"><a href="#cb1674-39" aria-hidden="true" tabindex="-1"></a><span class="ex">Options:</span></span>
-<span id="cb1674-40"><a href="#cb1674-40" aria-hidden="true" tabindex="-1"></a><span class="ex">-</span> type: shade</span>
-<span id="cb1674-41"><a href="#cb1674-41" aria-hidden="true" tabindex="-1"></a><span class="ex">-</span> drive_id: <span class="pp">[</span><span class="ss">YOUR_ID</span><span class="pp">]</span></span>
-<span id="cb1674-42"><a href="#cb1674-42" aria-hidden="true" tabindex="-1"></a><span class="ex">-</span> api_key: <span class="pp">[</span><span class="ss">YOUR_API_KEY</span><span class="pp">]</span></span>
-<span id="cb1674-43"><a href="#cb1674-43" aria-hidden="true" tabindex="-1"></a><span class="ex">Keep</span> this <span class="st">&quot;Shade&quot;</span> remote<span class="pp">?</span></span>
-<span id="cb1674-44"><a href="#cb1674-44" aria-hidden="true" tabindex="-1"></a><span class="ex">y</span><span class="er">)</span> <span class="ex">Yes</span> this is OK <span class="er">(</span><span class="ex">default</span><span class="kw">)</span></span>
-<span id="cb1674-45"><a href="#cb1674-45" aria-hidden="true" tabindex="-1"></a><span class="ex">e</span><span class="er">)</span> <span class="ex">Edit</span> this remote</span>
-<span id="cb1674-46"><a href="#cb1674-46" aria-hidden="true" tabindex="-1"></a><span class="ex">d</span><span class="er">)</span> <span class="ex">Delete</span> this remote</span>
-<span id="cb1674-47"><a href="#cb1674-47" aria-hidden="true" tabindex="-1"></a><span class="ex">y/e/d</span><span class="op">&gt;</span> y</span></code></pre></div>
-<h3 id="modification-times-and-hashes-30">Modification times and
+<div class="sourceCode" id="cb1717"><pre
+class="sourceCode sh"><code class="sourceCode bash"><span id="cb1717-1"><a href="#cb1717-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone config</span>
+<span id="cb1717-2"><a href="#cb1717-2" aria-hidden="true" tabindex="-1"></a><span class="ex">e</span><span class="er">)</span> <span class="ex">Edit</span> existing remote</span>
+<span id="cb1717-3"><a href="#cb1717-3" aria-hidden="true" tabindex="-1"></a><span class="ex">n</span><span class="er">)</span> <span class="ex">New</span> remote</span>
+<span id="cb1717-4"><a href="#cb1717-4" aria-hidden="true" tabindex="-1"></a><span class="ex">d</span><span class="er">)</span> <span class="ex">Delete</span> remote</span>
+<span id="cb1717-5"><a href="#cb1717-5" aria-hidden="true" tabindex="-1"></a><span class="ex">r</span><span class="er">)</span> <span class="ex">Rename</span> remote</span>
+<span id="cb1717-6"><a href="#cb1717-6" aria-hidden="true" tabindex="-1"></a><span class="ex">c</span><span class="er">)</span> <span class="ex">Copy</span> remote</span>
+<span id="cb1717-7"><a href="#cb1717-7" aria-hidden="true" tabindex="-1"></a><span class="ex">s</span><span class="er">)</span> <span class="ex">Set</span> configuration password</span>
+<span id="cb1717-8"><a href="#cb1717-8" aria-hidden="true" tabindex="-1"></a><span class="ex">q</span><span class="er">)</span> <span class="ex">Quit</span> config</span>
+<span id="cb1717-9"><a href="#cb1717-9" aria-hidden="true" tabindex="-1"></a><span class="ex">e/n/d/r/c/s/q</span><span class="op">&gt;</span> n</span>
+<span id="cb1717-10"><a href="#cb1717-10" aria-hidden="true" tabindex="-1"></a></span>
+<span id="cb1717-11"><a href="#cb1717-11" aria-hidden="true" tabindex="-1"></a><span class="ex">Enter</span> name for new remote.</span>
+<span id="cb1717-12"><a href="#cb1717-12" aria-hidden="true" tabindex="-1"></a><span class="ex">name</span><span class="op">&gt;</span> Shade</span>
+<span id="cb1717-13"><a href="#cb1717-13" aria-hidden="true" tabindex="-1"></a></span>
+<span id="cb1717-14"><a href="#cb1717-14" aria-hidden="true" tabindex="-1"></a><span class="ex">Option</span> Storage.</span>
+<span id="cb1717-15"><a href="#cb1717-15" aria-hidden="true" tabindex="-1"></a><span class="ex">Type</span> of storage to configure.</span>
+<span id="cb1717-16"><a href="#cb1717-16" aria-hidden="true" tabindex="-1"></a><span class="ex">Choose</span> a number from below, or type in your own value.</span>
+<span id="cb1717-17"><a href="#cb1717-17" aria-hidden="true" tabindex="-1"></a><span class="ex">[OTHER</span> OPTIONS]</span>
+<span id="cb1717-18"><a href="#cb1717-18" aria-hidden="true" tabindex="-1"></a><span class="ex">xx</span> / Shade FS</span>
+<span id="cb1717-19"><a href="#cb1717-19" aria-hidden="true" tabindex="-1"></a> <span class="ex">\ </span><span class="er">(</span><span class="ex">shade</span><span class="kw">)</span></span>
+<span id="cb1717-20"><a href="#cb1717-20" aria-hidden="true" tabindex="-1"></a><span class="ex">[OTHER</span> OPTIONS]</span>
+<span id="cb1717-21"><a href="#cb1717-21" aria-hidden="true" tabindex="-1"></a><span class="ex">Storage</span><span class="op">&gt;</span> xx</span>
+<span id="cb1717-22"><a href="#cb1717-22" aria-hidden="true" tabindex="-1"></a></span>
+<span id="cb1717-23"><a href="#cb1717-23" aria-hidden="true" tabindex="-1"></a><span class="ex">Option</span> drive_id.</span>
+<span id="cb1717-24"><a href="#cb1717-24" aria-hidden="true" tabindex="-1"></a><span class="ex">The</span> ID of your drive, see this in the drive settings. Individual rclone configs must be made per drive.</span>
+<span id="cb1717-25"><a href="#cb1717-25" aria-hidden="true" tabindex="-1"></a><span class="ex">Enter</span> a value.</span>
+<span id="cb1717-26"><a href="#cb1717-26" aria-hidden="true" tabindex="-1"></a><span class="ex">drive_id</span><span class="op">&gt;</span> <span class="pp">[</span><span class="ss">YOUR_ID</span><span class="pp">]</span></span>
+<span id="cb1717-27"><a href="#cb1717-27" aria-hidden="true" tabindex="-1"></a></span>
+<span id="cb1717-28"><a href="#cb1717-28" aria-hidden="true" tabindex="-1"></a><span class="ex">Option</span> api_key.</span>
+<span id="cb1717-29"><a href="#cb1717-29" aria-hidden="true" tabindex="-1"></a><span class="ex">An</span> API key for your account.</span>
+<span id="cb1717-30"><a href="#cb1717-30" aria-hidden="true" tabindex="-1"></a><span class="ex">Enter</span> a value.</span>
+<span id="cb1717-31"><a href="#cb1717-31" aria-hidden="true" tabindex="-1"></a><span class="ex">api_key</span><span class="op">&gt;</span> <span class="pp">[</span><span class="ss">YOUR_API_KEY</span><span class="pp">]</span></span>
+<span id="cb1717-32"><a href="#cb1717-32" aria-hidden="true" tabindex="-1"></a></span>
+<span id="cb1717-33"><a href="#cb1717-33" aria-hidden="true" tabindex="-1"></a><span class="ex">Edit</span> advanced config<span class="pp">?</span></span>
+<span id="cb1717-34"><a href="#cb1717-34" aria-hidden="true" tabindex="-1"></a><span class="ex">y</span><span class="er">)</span> <span class="ex">Yes</span></span>
+<span id="cb1717-35"><a href="#cb1717-35" aria-hidden="true" tabindex="-1"></a><span class="ex">n</span><span class="er">)</span> <span class="ex">No</span> <span class="er">(</span><span class="ex">default</span><span class="kw">)</span></span>
+<span id="cb1717-36"><a href="#cb1717-36" aria-hidden="true" tabindex="-1"></a><span class="ex">y/n</span><span class="op">&gt;</span> n</span>
+<span id="cb1717-37"><a href="#cb1717-37" aria-hidden="true" tabindex="-1"></a></span>
+<span id="cb1717-38"><a href="#cb1717-38" aria-hidden="true" tabindex="-1"></a><span class="ex">Configuration</span> complete.</span>
+<span id="cb1717-39"><a href="#cb1717-39" aria-hidden="true" tabindex="-1"></a><span class="ex">Options:</span></span>
+<span id="cb1717-40"><a href="#cb1717-40" aria-hidden="true" tabindex="-1"></a><span class="ex">-</span> type: shade</span>
+<span id="cb1717-41"><a href="#cb1717-41" aria-hidden="true" tabindex="-1"></a><span class="ex">-</span> drive_id: <span class="pp">[</span><span class="ss">YOUR_ID</span><span class="pp">]</span></span>
+<span id="cb1717-42"><a href="#cb1717-42" aria-hidden="true" tabindex="-1"></a><span class="ex">-</span> api_key: <span class="pp">[</span><span class="ss">YOUR_API_KEY</span><span class="pp">]</span></span>
+<span id="cb1717-43"><a href="#cb1717-43" aria-hidden="true" tabindex="-1"></a><span class="ex">Keep</span> this <span class="st">&quot;Shade&quot;</span> remote<span class="pp">?</span></span>
+<span id="cb1717-44"><a href="#cb1717-44" aria-hidden="true" tabindex="-1"></a><span class="ex">y</span><span class="er">)</span> <span class="ex">Yes</span> this is OK <span class="er">(</span><span class="ex">default</span><span class="kw">)</span></span>
+<span id="cb1717-45"><a href="#cb1717-45" aria-hidden="true" tabindex="-1"></a><span class="ex">e</span><span class="er">)</span> <span class="ex">Edit</span> this remote</span>
+<span id="cb1717-46"><a href="#cb1717-46" aria-hidden="true" tabindex="-1"></a><span class="ex">d</span><span class="er">)</span> <span class="ex">Delete</span> this remote</span>
+<span id="cb1717-47"><a href="#cb1717-47" aria-hidden="true" tabindex="-1"></a><span class="ex">y/e/d</span><span class="op">&gt;</span> y</span></code></pre></div>
+<h3 id="modification-times-and-hashes-31">Modification times and
hashes</h3>
<p>Shade does not support hashes and writing mod times.</p>
<h3 id="transfers-5">Transfers</h3>
@@ -59184,7 +61518,7 @@ delete the file instantly, instead of sending it to the trash. This
means that it will not be recoverable.</p>
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/shade/shade.go and run make backenddocs to verify -->
<!-- markdownlint-disable-line line-length -->
-<h3 id="standard-options-57">Standard options</h3>
+<h3 id="standard-options-58">Standard options</h3>
<p>Here are the Standard options specific to shade (Shade FS).</p>
<h4 id="shade-drive-id">--shade-drive-id</h4>
<p>The ID of your drive, see this in the drive settings. Individual
@@ -59205,7 +61539,7 @@ rclone configs must be made per drive.</p>
<li>Type: string</li>
<li>Required: true</li>
</ul>
-<h3 id="advanced-options-58">Advanced options</h3>
+<h3 id="advanced-options-59">Advanced options</h3>
<p>Here are the Advanced options specific to shade (Shade FS).</p>
<h4 id="shade-endpoint">--shade-endpoint</h4>
<p>Endpoint for the service.</p>
@@ -59292,7 +61626,7 @@ section in the overview</a> for more info.</p>
<li>Required: false</li>
</ul>
<!-- autogenerated options stop -->
-<h2 id="limitations-41">Limitations</h2>
+<h2 id="limitations-43">Limitations</h2>
<p>Note that Shade is case insensitive so you can't have a file called
"Hello.doc" and one called "hello.doc".</p>
<p>Shade only supports filenames up to 255 characters in length.</p>
@@ -59337,7 +61671,7 @@ 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-55">Configuration</h2>
+<h2 id="configuration-56">Configuration</h2>
<p>Here is an example of making a SMB configuration.</p>
<p>First run</p>
<pre class="console"><code>rclone config</code></pre>
@@ -59414,7 +61748,7 @@ d) Delete this remote
y/e/d&gt; d</code></pre>
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/smb/smb.go and run make backenddocs to verify -->
<!-- markdownlint-disable-line line-length -->
-<h3 id="standard-options-58">Standard options</h3>
+<h3 id="standard-options-59">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>
@@ -59492,7 +61826,7 @@ KRB5_CONFIG and KRB5CCNAME environment variables.</p>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
-<h3 id="advanced-options-59">Advanced options</h3>
+<h3 id="advanced-options-60">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>
@@ -59684,7 +62018,7 @@ upload</li>
gateway</li>
</ul></li>
</ul>
-<h2 id="configuration-56">Configuration</h2>
+<h2 id="configuration-57">Configuration</h2>
<p>To make a new Storj configuration you need one of the following:</p>
<ul>
<li>Access Grant that someone else shared with you.</li>
@@ -59791,7 +62125,7 @@ d) Delete this remote
y/e/d&gt; y</code></pre>
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/storj/storj.go and run make backenddocs to verify -->
<!-- markdownlint-disable-line line-length -->
-<h3 id="standard-options-59">Standard options</h3>
+<h3 id="standard-options-60">Standard options</h3>
<p>Here are the Standard options specific to storj (Storj Decentralized
Cloud Storage).</p>
<h4 id="storj-provider">--storj-provider</h4>
@@ -59873,7 +62207,7 @@ passphrase.</li>
<li>Type: string</li>
<li>Required: false</li>
</ul>
-<h3 id="advanced-options-60">Advanced options</h3>
+<h3 id="advanced-options-61">Advanced options</h3>
<p>Here are the Advanced options specific to storj (Storj Decentralized
Cloud Storage).</p>
<h4 id="storj-description">--storj-description</h4>
@@ -59960,7 +62294,7 @@ deleted.</p>
<pre class="console"><code>rclone sync --interactive --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 class="console"><code>rclone sync --interactive --progress s3:bucket/path/to/dir/ storj:bucket/path/to/dir/</code></pre>
-<h2 id="limitations-42">Limitations</h2>
+<h2 id="limitations-44">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
@@ -59989,7 +62323,7 @@ operating system manual.</p>
<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-57">Configuration</h2>
+<h2 id="configuration-58">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>
@@ -60062,13 +62396,13 @@ store them, it only uses them to get the initial token.</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="modification-times-and-hashes-31">Modification times and
+<h3 id="modification-times-and-hashes-32">Modification times 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-34">Restricted filename
+<h3 id="restricted-filename-characters-35">Restricted filename
characters</h3>
<p>SugarSync replaces the <a
href="https://rclone.org/overview/#restricted-characters">default
@@ -60084,7 +62418,7 @@ or set the config parameter <code>hard_delete = true</code> if you would
like files to be deleted straight away.</p>
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/sugarsync/sugarsync.go and run make backenddocs to verify -->
<!-- markdownlint-disable-line line-length -->
-<h3 id="standard-options-60">Standard options</h3>
+<h3 id="standard-options-61">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>
@@ -60127,7 +62461,7 @@ files.</p>
<li>Type: bool</li>
<li>Default: false</li>
</ul>
-<h3 id="advanced-options-61">Advanced options</h3>
+<h3 id="advanced-options-62">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>
@@ -60211,7 +62545,7 @@ section in the overview</a> for more info.</p>
<li>Required: false</li>
</ul>
<!-- autogenerated options stop -->
-<h2 id="limitations-43">Limitations</h2>
+<h2 id="limitations-45">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
@@ -60225,7 +62559,7 @@ href="https://rclone.org/commands/rclone_about/">rclone about</a>.</p>
<code>remote:directory/subdirectory</code>.</p>
<p>The initial setup for Uloz.to involves filling in the user
credentials. <code>rclone config</code> walks you through it.</p>
-<h2 id="configuration-58">Configuration</h2>
+<h2 id="configuration-59">Configuration</h2>
<p>Here is an example of how to make a remote called
<code>remote</code>. First run:</p>
<pre class="console"><code>rclone config</code></pre>
@@ -60290,7 +62624,7 @@ y/e/d&gt; y</code></pre>
and password. Uloz.to offers an API key as well, but it's reserved for
the use of Uloz.to's in-house application and using it in different
circumstances is unreliable.</p>
-<h3 id="modification-times-and-hashes-32">Modification times and
+<h3 id="modification-times-and-hashes-33">Modification times and
hashes</h3>
<p>Uloz.to doesn't allow the user to set a custom modification time, or
retrieve the hashes after upload. As a result, the integration uses a
@@ -60300,7 +62634,7 @@ and hashes. Timestamps are stored with microsecond precision.</p>
Afterwards, the backend only serves the client-side calculated hashes.
Hashes can also be retrieved upon creating a file download link, but
it's impractical for <code>list</code>-like use cases.</p>
-<h3 id="restricted-filename-characters-35">Restricted filename
+<h3 id="restricted-filename-characters-36">Restricted filename
characters</h3>
<p>In addition to the <a
href="https://rclone.org/overview/#restricted-characters">default
@@ -60356,7 +62690,7 @@ in the remote path. For example, if your remote's
<code>ABSOLUTE_ULOZTO_ROOT/foo/bar/baz/qux</code>.</p>
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/ulozto/ulozto.go and run make backenddocs to verify -->
<!-- markdownlint-disable-line line-length -->
-<h3 id="standard-options-61">Standard options</h3>
+<h3 id="standard-options-62">Standard options</h3>
<p>Here are the Standard options specific to ulozto (Uloz.to).</p>
<h4 id="ulozto-app-token">--ulozto-app-token</h4>
<p>The application token identifying the app. An app API key can be
@@ -60390,7 +62724,7 @@ obscure</a>.</p>
<li>Type: string</li>
<li>Required: false</li>
</ul>
-<h3 id="advanced-options-62">Advanced options</h3>
+<h3 id="advanced-options-63">Advanced options</h3>
<p>Here are the Advanced options specific to ulozto (Uloz.to).</p>
<h4 id="ulozto-root-folder-slug">--ulozto-root-folder-slug</h4>
<p>If set, rclone will use this folder as the root folder for all
@@ -60433,7 +62767,7 @@ section in the overview</a> for more info.</p>
<li>Required: false</li>
</ul>
<!-- autogenerated options stop -->
-<h2 id="limitations-44">Limitations</h2>
+<h2 id="limitations-46">Limitations</h2>
<p>Uloz.to 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>
@@ -60480,7 +62814,7 @@ named <code>backup</code> with the remotes
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-59">Configuration</h2>
+<h2 id="configuration-60">Configuration</h2>
<p>Here is an example of how to make a union called <code>remote</code>
for local folders. First run:</p>
<pre class="console"><code>rclone config</code></pre>
@@ -60759,13 +63093,13 @@ upstream.</td>
<h3 id="writeback">Writeback</h3>
<p>The tag <code>:writeback</code> on an upstream remote can be used to
make a simple cache system like this:</p>
-<div class="sourceCode" id="cb1715"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1715-1"><a href="#cb1715-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[union]</span></span>
-<span id="cb1715-2"><a href="#cb1715-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> union</span></span>
-<span id="cb1715-3"><a href="#cb1715-3" aria-hidden="true" tabindex="-1"></a><span class="dt">action_policy </span><span class="ot">=</span><span class="st"> all</span></span>
-<span id="cb1715-4"><a href="#cb1715-4" aria-hidden="true" tabindex="-1"></a><span class="dt">create_policy </span><span class="ot">=</span><span class="st"> all</span></span>
-<span id="cb1715-5"><a href="#cb1715-5" aria-hidden="true" tabindex="-1"></a><span class="dt">search_policy </span><span class="ot">=</span><span class="st"> ff</span></span>
-<span id="cb1715-6"><a href="#cb1715-6" aria-hidden="true" tabindex="-1"></a><span class="dt">upstreams </span><span class="ot">=</span><span class="st"> /local:writeback remote:dir</span></span></code></pre></div>
+<div class="sourceCode" id="cb1758"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1758-1"><a href="#cb1758-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[union]</span></span>
+<span id="cb1758-2"><a href="#cb1758-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> union</span></span>
+<span id="cb1758-3"><a href="#cb1758-3" aria-hidden="true" tabindex="-1"></a><span class="dt">action_policy </span><span class="ot">=</span><span class="st"> all</span></span>
+<span id="cb1758-4"><a href="#cb1758-4" aria-hidden="true" tabindex="-1"></a><span class="dt">create_policy </span><span class="ot">=</span><span class="st"> all</span></span>
+<span id="cb1758-5"><a href="#cb1758-5" aria-hidden="true" tabindex="-1"></a><span class="dt">search_policy </span><span class="ot">=</span><span class="st"> ff</span></span>
+<span id="cb1758-6"><a href="#cb1758-6" aria-hidden="true" tabindex="-1"></a><span class="dt">upstreams </span><span class="ot">=</span><span class="st"> /local:writeback remote:dir</span></span></code></pre></div>
<p>When files are opened for read, if the file is in
<code>remote:dir</code> but not <code>/local</code> then rclone will
copy the file entirely into <code>/local</code> before returning a
@@ -60782,7 +63116,7 @@ other than writing files back to it. So if you need to expire old files
or manage the size then you will have to do this yourself.</p>
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/union/union.go and run make backenddocs to verify -->
<!-- markdownlint-disable-line line-length -->
-<h3 id="standard-options-62">Standard options</h3>
+<h3 id="standard-options-63">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>
@@ -60833,7 +63167,7 @@ dir" upstreamb:', etc.</p>
<li>Type: int</li>
<li>Default: 120</li>
</ul>
-<h3 id="advanced-options-63">Advanced options</h3>
+<h3 id="advanced-options-64">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>
@@ -60856,7 +63190,7 @@ considered for use in lfs or eplfs policies.</p>
<li>Type: string</li>
<li>Required: false</li>
</ul>
-<h3 id="metadata-20">Metadata</h3>
+<h3 id="metadata-23">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
@@ -60866,7 +63200,7 @@ for more info.</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-60">Configuration</h2>
+<h2 id="configuration-61">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>
@@ -60944,7 +63278,7 @@ y/e/d&gt; y</code></pre>
<pre class="console"><code>rclone ls remote:</code></pre>
<p>To copy a local directory to an WebDAV directory called backup</p>
<pre class="console"><code>rclone copy /home/source remote:backup</code></pre>
-<h3 id="modification-times-and-hashes-33">Modification times and
+<h3 id="modification-times-and-hashes-34">Modification times and
hashes</h3>
<p>Plain WebDAV does not support modified times. However when used with
Fastmail Files, ownCloud or Nextcloud rclone will support modified
@@ -60956,7 +63290,7 @@ may appear on all objects, or only on objects which had a hash uploaded
with them.</p>
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/webdav/webdav.go and run make backenddocs to verify -->
<!-- markdownlint-disable-line line-length -->
-<h3 id="standard-options-63">Standard options</h3>
+<h3 id="standard-options-64">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>
@@ -61046,7 +63380,7 @@ obscure</a>.</p>
<li>Type: string</li>
<li>Required: false</li>
</ul>
-<h3 id="advanced-options-64">Advanced options</h3>
+<h3 id="advanced-options-65">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>
@@ -61225,13 +63559,13 @@ 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>
-<div class="sourceCode" id="cb1721"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1721-1"><a href="#cb1721-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[sharepoint]</span></span>
-<span id="cb1721-2"><a href="#cb1721-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> webdav</span></span>
-<span id="cb1721-3"><a href="#cb1721-3" aria-hidden="true" tabindex="-1"></a><span class="dt">url </span><span class="ot">=</span><span class="st"> https://[YOUR-DOMAIN]-my.sharepoint.com/personal/[YOUR-EMAIL]/Documents</span></span>
-<span id="cb1721-4"><a href="#cb1721-4" aria-hidden="true" tabindex="-1"></a><span class="dt">vendor </span><span class="ot">=</span><span class="st"> sharepoint</span></span>
-<span id="cb1721-5"><a href="#cb1721-5" aria-hidden="true" tabindex="-1"></a><span class="dt">user </span><span class="ot">=</span><span class="st"> YourEmailAddress</span></span>
-<span id="cb1721-6"><a href="#cb1721-6" aria-hidden="true" tabindex="-1"></a><span class="dt">pass </span><span class="ot">=</span><span class="st"> encryptedpassword</span></span></code></pre></div>
+<div class="sourceCode" id="cb1764"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1764-1"><a href="#cb1764-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[sharepoint]</span></span>
+<span id="cb1764-2"><a href="#cb1764-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> webdav</span></span>
+<span id="cb1764-3"><a href="#cb1764-3" aria-hidden="true" tabindex="-1"></a><span class="dt">url </span><span class="ot">=</span><span class="st"> https://[YOUR-DOMAIN]-my.sharepoint.com/personal/[YOUR-EMAIL]/Documents</span></span>
+<span id="cb1764-4"><a href="#cb1764-4" aria-hidden="true" tabindex="-1"></a><span class="dt">vendor </span><span class="ot">=</span><span class="st"> sharepoint</span></span>
+<span id="cb1764-5"><a href="#cb1764-5" aria-hidden="true" tabindex="-1"></a><span class="dt">user </span><span class="ot">=</span><span class="st"> YourEmailAddress</span></span>
+<span id="cb1764-6"><a href="#cb1764-6" aria-hidden="true" tabindex="-1"></a><span class="dt">pass </span><span class="ot">=</span><span class="st"> encryptedpassword</span></span></code></pre></div>
<h3 id="sharepoint-with-ntlm-authentication">Sharepoint with NTLM
Authentication</h3>
<p>Use this option in case your (hosted) Sharepoint is not tied to
@@ -61249,13 +63583,13 @@ class="uri">https://example.sharepoint.com/sites/12345/Documents</a></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>
-<div class="sourceCode" id="cb1722"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1722-1"><a href="#cb1722-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[sharepoint]</span></span>
-<span id="cb1722-2"><a href="#cb1722-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> webdav</span></span>
-<span id="cb1722-3"><a href="#cb1722-3" aria-hidden="true" tabindex="-1"></a><span class="dt">url </span><span class="ot">=</span><span class="st"> https://[YOUR-DOMAIN]/some-path-to/Documents</span></span>
-<span id="cb1722-4"><a href="#cb1722-4" aria-hidden="true" tabindex="-1"></a><span class="dt">vendor </span><span class="ot">=</span><span class="st"> sharepoint-ntlm</span></span>
-<span id="cb1722-5"><a href="#cb1722-5" aria-hidden="true" tabindex="-1"></a><span class="dt">user </span><span class="ot">=</span><span class="st"> DOMAIN\user</span></span>
-<span id="cb1722-6"><a href="#cb1722-6" aria-hidden="true" tabindex="-1"></a><span class="dt">pass </span><span class="ot">=</span><span class="st"> encryptedpassword</span></span></code></pre></div>
+<div class="sourceCode" id="cb1765"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1765-1"><a href="#cb1765-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[sharepoint]</span></span>
+<span id="cb1765-2"><a href="#cb1765-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> webdav</span></span>
+<span id="cb1765-3"><a href="#cb1765-3" aria-hidden="true" tabindex="-1"></a><span class="dt">url </span><span class="ot">=</span><span class="st"> https://[YOUR-DOMAIN]/some-path-to/Documents</span></span>
+<span id="cb1765-4"><a href="#cb1765-4" aria-hidden="true" tabindex="-1"></a><span class="dt">vendor </span><span class="ot">=</span><span class="st"> sharepoint-ntlm</span></span>
+<span id="cb1765-5"><a href="#cb1765-5" aria-hidden="true" tabindex="-1"></a><span class="dt">user </span><span class="ot">=</span><span class="st"> DOMAIN\user</span></span>
+<span id="cb1765-6"><a href="#cb1765-6" aria-hidden="true" tabindex="-1"></a><span class="dt">pass </span><span class="ot">=</span><span class="st"> encryptedpassword</span></span></code></pre></div>
<h4 id="required-flags-for-sharepoint">Required Flags for
SharePoint</h4>
<p>As SharePoint does some special things with uploaded documents, you
@@ -61285,14 +63619,14 @@ access tokens.</p>
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>
-<div class="sourceCode" id="cb1724"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1724-1"><a href="#cb1724-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[dcache]</span></span>
-<span id="cb1724-2"><a href="#cb1724-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> webdav</span></span>
-<span id="cb1724-3"><a href="#cb1724-3" aria-hidden="true" tabindex="-1"></a><span class="dt">url </span><span class="ot">=</span><span class="st"> https://dcache...</span></span>
-<span id="cb1724-4"><a href="#cb1724-4" aria-hidden="true" tabindex="-1"></a><span class="dt">vendor </span><span class="ot">=</span><span class="st"> other</span></span>
-<span id="cb1724-5"><a href="#cb1724-5" aria-hidden="true" tabindex="-1"></a><span class="dt">user </span><span class="ot">=</span></span>
-<span id="cb1724-6"><a href="#cb1724-6" aria-hidden="true" tabindex="-1"></a><span class="dt">pass </span><span class="ot">=</span></span>
-<span id="cb1724-7"><a href="#cb1724-7" aria-hidden="true" tabindex="-1"></a><span class="dt">bearer_token </span><span class="ot">=</span><span class="st"> your-macaroon</span></span></code></pre></div>
+<div class="sourceCode" id="cb1767"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1767-1"><a href="#cb1767-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[dcache]</span></span>
+<span id="cb1767-2"><a href="#cb1767-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> webdav</span></span>
+<span id="cb1767-3"><a href="#cb1767-3" aria-hidden="true" tabindex="-1"></a><span class="dt">url </span><span class="ot">=</span><span class="st"> https://dcache...</span></span>
+<span id="cb1767-4"><a href="#cb1767-4" aria-hidden="true" tabindex="-1"></a><span class="dt">vendor </span><span class="ot">=</span><span class="st"> other</span></span>
+<span id="cb1767-5"><a href="#cb1767-5" aria-hidden="true" tabindex="-1"></a><span class="dt">user </span><span class="ot">=</span></span>
+<span id="cb1767-6"><a href="#cb1767-6" aria-hidden="true" tabindex="-1"></a><span class="dt">pass </span><span class="ot">=</span></span>
+<span id="cb1767-7"><a href="#cb1767-7" aria-hidden="true" tabindex="-1"></a><span class="dt">bearer_token </span><span class="ot">=</span><span class="st"> your-macaroon</span></span></code></pre></div>
<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
@@ -61332,16 +63666,16 @@ the advanced config and enter the command to get a bearer token (e.g.,
<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>
-<div class="sourceCode" id="cb1726"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1726-1"><a href="#cb1726-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[dcache]</span></span>
-<span id="cb1726-2"><a href="#cb1726-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> webdav</span></span>
-<span id="cb1726-3"><a href="#cb1726-3" aria-hidden="true" tabindex="-1"></a><span class="dt">url </span><span class="ot">=</span><span class="st"> https://dcache.example.org/</span></span>
-<span id="cb1726-4"><a href="#cb1726-4" aria-hidden="true" tabindex="-1"></a><span class="dt">vendor </span><span class="ot">=</span><span class="st"> other</span></span>
-<span id="cb1726-5"><a href="#cb1726-5" aria-hidden="true" tabindex="-1"></a><span class="dt">bearer_token_command </span><span class="ot">=</span><span class="st"> oidc-token XDC</span></span></code></pre></div>
+<div class="sourceCode" id="cb1769"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1769-1"><a href="#cb1769-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[dcache]</span></span>
+<span id="cb1769-2"><a href="#cb1769-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> webdav</span></span>
+<span id="cb1769-3"><a href="#cb1769-3" aria-hidden="true" tabindex="-1"></a><span class="dt">url </span><span class="ot">=</span><span class="st"> https://dcache.example.org/</span></span>
+<span id="cb1769-4"><a href="#cb1769-4" aria-hidden="true" tabindex="-1"></a><span class="dt">vendor </span><span class="ot">=</span><span class="st"> other</span></span>
+<span id="cb1769-5"><a href="#cb1769-5" aria-hidden="true" tabindex="-1"></a><span class="dt">bearer_token_command </span><span class="ot">=</span><span class="st"> oidc-token XDC</span></span></code></pre></div>
<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-61">Configuration</h2>
+<h2 id="configuration-62">Configuration</h2>
<p>Here is an example of making a yandex configuration. First run</p>
<pre class="console"><code>rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
@@ -61405,7 +63739,7 @@ any excess files in the path.</p>
<pre class="console"><code>rclone sync --interactive /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="modification-times-and-hashes-34">Modification times and
+<h3 id="modification-times-and-hashes-35">Modification times and
hashes</h3>
<p>Modified times are supported and are stored accurate to 1 ns in
custom metadata called <code>rclone_modified</code> in RFC3339 with
@@ -61416,11 +63750,11 @@ nanoseconds format.</p>
<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>
+<h3 id="quota-information-4">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-36">Restricted filename
+<h3 id="restricted-filename-characters-37">Restricted filename
characters</h3>
<p>The <a
href="https://rclone.org/overview/#restricted-characters">default
@@ -61430,7 +63764,7 @@ href="https://rclone.org/overview/#invalid-utf8">replaced</a>, as they
can't be used in JSON strings.</p>
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/yandex/yandex.go and run make backenddocs to verify -->
<!-- markdownlint-disable-line line-length -->
-<h3 id="standard-options-64">Standard options</h3>
+<h3 id="standard-options-65">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>
@@ -61452,7 +63786,7 @@ can't be used in JSON strings.</p>
<li>Type: string</li>
<li>Required: false</li>
</ul>
-<h3 id="advanced-options-65">Advanced options</h3>
+<h3 id="advanced-options-66">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>
@@ -61535,7 +63869,7 @@ client. May help with upload performance.</p>
<li>Required: false</li>
</ul>
<!-- autogenerated options stop -->
-<h2 id="limitations-45">Limitations</h2>
+<h2 id="limitations-47">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)
@@ -61555,7 +63889,7 @@ Rclone won't be able to complete any actions.</p>
<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-62">Configuration</h2>
+<h2 id="configuration-63">Configuration</h2>
<p>Here is an example of making a zoho configuration. First run</p>
<pre class="console"><code>rclone config</code></pre>
<p>This will guide you through an interactive setup process:</p>
@@ -61638,7 +63972,7 @@ any excess files in the path.</p>
<pre class="console"><code>rclone sync --interactive /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="modification-times-and-hashes-35">Modification times and
+<h3 id="modification-times-and-hashes-36">Modification times and
hashes</h3>
<p>Modified times are currently not supported for Zoho Workdrive</p>
<p>No hash algorithms are supported.</p>
@@ -61646,14 +63980,14 @@ hashes</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-37">Restricted filename
+<h3 id="restricted-filename-characters-38">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>
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/zoho/zoho.go and run make backenddocs to verify -->
<!-- markdownlint-disable-line line-length -->
-<h3 id="standard-options-65">Standard options</h3>
+<h3 id="standard-options-66">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>
@@ -61714,7 +64048,7 @@ browser.</p>
</ul></li>
</ul></li>
</ul>
-<h3 id="advanced-options-66">Advanced options</h3>
+<h3 id="advanced-options-67">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>
@@ -61807,7 +64141,7 @@ enable it in other regions.</p></li>
<pre class="console"><code>rclone sync --interactive /home/source /tmp/destination</code></pre>
<p>Will sync <code>/home/source</code> to
<code>/tmp/destination</code>.</p>
-<h2 id="configuration-63">Configuration</h2>
+<h2 id="configuration-64">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>,
@@ -61860,7 +64194,7 @@ handling file names.</p>
</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
+href="https://docs.microsoft.com/windows/desktop/FileIO/naming-a-file#naming-conventions">Windows
file naming conventions</a>.</p>
<table>
<thead>
@@ -62138,22 +64472,22 @@ 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>
-<div class="sourceCode" id="cb1742"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1742-1"><a href="#cb1742-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[local]</span></span>
-<span id="cb1742-2"><a href="#cb1742-2" aria-hidden="true" tabindex="-1"></a><span class="dt">nounc </span><span class="ot">=</span><span class="st"> </span><span class="kw">true</span></span></code></pre></div>
+<div class="sourceCode" id="cb1785"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1785-1"><a href="#cb1785-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[local]</span></span>
+<span id="cb1785-2"><a href="#cb1785-2" aria-hidden="true" tabindex="-1"></a><span class="dt">nounc </span><span class="ot">=</span><span class="st"> </span><span class="kw">true</span></span></code></pre></div>
<p>If you want to selectively disable UNC, you can add it to a separate
entry like this:</p>
-<div class="sourceCode" id="cb1743"><pre
-class="sourceCode ini"><code class="sourceCode ini"><span id="cb1743-1"><a href="#cb1743-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[nounc]</span></span>
-<span id="cb1743-2"><a href="#cb1743-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> local</span></span>
-<span id="cb1743-3"><a href="#cb1743-3" aria-hidden="true" tabindex="-1"></a><span class="dt">nounc </span><span class="ot">=</span><span class="st"> </span><span class="kw">true</span></span></code></pre></div>
+<div class="sourceCode" id="cb1786"><pre
+class="sourceCode ini"><code class="sourceCode ini"><span id="cb1786-1"><a href="#cb1786-1" aria-hidden="true" tabindex="-1"></a><span class="kw">[nounc]</span></span>
+<span id="cb1786-2"><a href="#cb1786-2" aria-hidden="true" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> local</span></span>
+<span id="cb1786-3"><a href="#cb1786-3" aria-hidden="true" tabindex="-1"></a><span class="dt">nounc </span><span class="ot">=</span><span class="st"> </span><span class="kw">true</span></span></code></pre></div>
<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>
+<h3 id="symlinks-junction-points-1">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
@@ -62266,7 +64600,7 @@ systems. On systems where it isn't supported (e.g. Windows) it will be
ignored.</p>
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/local/local.go and run make backenddocs to verify -->
<!-- markdownlint-disable-line line-length -->
-<h3 id="advanced-options-67">Advanced options</h3>
+<h3 id="advanced-options-68">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>
@@ -62568,7 +64902,7 @@ section in the overview</a> for more info.</p>
<li>Type: string</li>
<li>Required: false</li>
</ul>
-<h3 id="metadata-21">Metadata</h3>
+<h3 id="metadata-24">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,
@@ -62674,6 +65008,468 @@ the output.</p>
<!-- autogenerated options stop -->
<!-- markdownlint-disable line-length -->
<h1 id="changelog-1">Changelog</h1>
+<h2 id="v1.74.0---2026-05-01">v1.74.0 - 2026-05-01</h2>
+<p><a
+href="https://github.com/rclone/rclone/compare/v1.73.0...v1.74.0">See
+commits</a></p>
+<ul>
+<li>New backends
+<ul>
+<li><a href="https://rclone.org/huaweidrive/">Huawei Drive</a>
+(王一赫)</li>
+<li><a href="https://rclone.org/iclouddrive/#icloud-photos">iCloud
+Photos</a> (read only) (Yakov Till)</li>
+<li>New S3 providers
+<ul>
+<li><a href="https://rclone.org/s3/#fastly">Fastly Object Storage</a>
+(Leon Brocard)</li>
+<li><a href="https://rclone.org/s3/#hcp">HCP</a> (Chris)</li>
+<li><a href="https://rclone.org/s3/#impossible-cloud">Impossible
+Cloud</a> (Nick Craig-Wood)</li>
+<li><a href="https://rclone.org/s3/#us3">UCloud US3</a> (jinkeyuu)</li>
+<li><a href="https://rclone.org/s3/#zadara">Zadara</a> (Shlomi
+Avihou)</li>
+</ul></li>
+</ul></li>
+<li>New commands
+<ul>
+<li><a href="https://rclone.org/gui/">gui</a>: launch new embedded web
+based GUI for basic rclone operations (FTCHD, Nick Craig-Wood)</li>
+</ul></li>
+<li>New Features
+<ul>
+<li>build
+<ul>
+<li>Update <code>golang.org/x/image/webp</code> to v0.39.0 to fix
+CVE-2026-33813 (Nick Craig-Wood)</li>
+<li>Bump <code>github.com/Azure/go-ntlmssp</code> to 0.1.1 to fix
+CVE-2026-32952 (dependabot[bot])</li>
+<li>Update to go1.26 and make go1.25 the minimum required version (Nick
+Craig-Wood)</li>
+<li>Update all dependencies (Nick Craig-Wood)</li>
+<li>Modernize Go code with go fix for go1.25 (Nick Craig-Wood)</li>
+<li>Fix <code>loong64</code> and <code>s390x</code> build (Suyun)</li>
+</ul></li>
+<li>docs
+<ul>
+<li>Modernize rclone.org site design (Nick Craig-Wood)</li>
+<li>fixes (albertony, Enduriel, Jason, Luke Cyca, mathieulongtin, Nick
+Craig-Wood, SyoBoN)</li>
+</ul></li>
+<li>fshttp: Add <code>--dump curl</code> for dumping HTTP requests as
+curl commands (Nick Craig-Wood)</li>
+<li>graphics: Optimise images losslessly with ImageOptim (Leon
+Brocard)</li>
+<li>listremotes: Add <code>--exact</code> flag for filtering (Anton
+Bordwine)</li>
+<li>rc
+<ul>
+<li>Flip auth default so all endpoints require auth unless opted out
+(Nick Craig-Wood)</li>
+<li>Add <code>core/disks</code> to enumerate attached disks (Nick
+Craig-Wood)</li>
+<li>Add <code>deletedDirs</code> stat to <code>core/stats</code> help
+output (Billy Hughes)</li>
+</ul></li>
+<li>serve http
+<ul>
+<li>Add fallback embedded favicon (Leon Brocard)</li>
+<li>Add gzip compression for text responses (Leon Brocard)</li>
+<li>Dark mode for file browser (FTCHD)</li>
+<li>Add HTTP/2 cleartext support for all http servers (TheBabu)</li>
+</ul></li>
+<li>touch: Add metadata when using <code>--metadata-set</code> (Prakhar
+Chhalotre)</li>
+</ul></li>
+<li>Bug Fixes
+<ul>
+<li>accounting
+<ul>
+<li>Update String method output format for clarity in transfer rate
+representation (Prakhar Chhalotre)</li>
+<li>Fix <code>rcat</code>/<code>copyurl</code> for
+<code>files.com</code> (Nick Craig-Wood)</li>
+</ul></li>
+<li>bisync
+<ul>
+<li>Add missing rc params (nielash)</li>
+<li>Add more structured info to rc output (nielash)</li>
+<li>Auto-generate rc help docs (nielash)</li>
+<li>Fix handling of unreadable lockfiles (lif)</li>
+<li>Fix flaky TestBisyncConcurrent by increasing random name entropy
+(Nick Craig-Wood)</li>
+<li>Fix integration tests after sftp log changes (Nick Craig-Wood)</li>
+</ul></li>
+<li>copyurl: Fix ignored <code>--upload-headers</code> and
+<code>--download-headers</code> (Andriy Senyshyn)</li>
+<li>librclone/ctest: Add Windows support and fix memory management
+(BizaNator)</li>
+<li>log: Fix data race on OutputHandler.format field (Nick
+Craig-Wood)</li>
+<li>operations
+<ul>
+<li>Multithread copy: grab memory before making go routines (Nick
+Craig-Wood)</li>
+</ul></li>
+<li>serve dlna: Fix Samsung TV compatibility (Nick Craig-Wood)</li>
+<li>serve nfs: Fix EOF flag in READ response not being set when read
+reaches end of file (Nick Craig-Wood)</li>
+</ul></li>
+<li>Mount
+<ul>
+<li>rc: fix mounts created with mountPoint "*" overwriting each other
+(Nick Craig-Wood)</li>
+</ul></li>
+<li>VFS
+<ul>
+<li>Fix slow <code>nfs serve</code> by adding
+<code>--vfs-handle-caching</code> (Nick Craig-Wood)</li>
+<li>Add context parameter to New() for config propagation (Nick
+Craig-Wood)</li>
+<li>Replace <code>context.TODO</code>/<code>Background</code> with
+stored VFS context (Nick Craig-Wood)</li>
+</ul></li>
+<li>Local
+<ul>
+<li>Remove fadvise calls that cause spinlock contention (Patrick
+Farrell)</li>
+</ul></li>
+<li>Azure Blob
+<ul>
+<li>Add <code>--azureblob-copy-total-concurrency</code> to limit total
+multipart copy concurrency (Duncan F)</li>
+<li>Add server side copy real time accounting (Nick Craig-Wood)</li>
+<li>Add <code>--azureblob-decompress</code> flag to download
+gzip-encoded files (Nick Craig-Wood)</li>
+</ul></li>
+<li>Azurefiles
+<ul>
+<li>Fix missing <code>x-ms-file-request-intent</code> header with OAuth
+(Nick Craig-Wood)</li>
+</ul></li>
+<li>B2
+<ul>
+<li>Add server side copy real time accounting (Nick Craig-Wood)</li>
+</ul></li>
+<li>Drime
+<ul>
+<li>Implement About (Cohinem)</li>
+<li>Fix listings of large directories (John Volk)</li>
+</ul></li>
+<li>Drive
+<ul>
+<li>Add integration test for handling folder names with single quotes
+(Prakhar Chhalotre)</li>
+</ul></li>
+<li>Filelu
+<ul>
+<li>Add multipart init response type (kingston125)</li>
+<li>Migrate API calls to <code>lib/rest</code> (kingston125)</li>
+</ul></li>
+<li>Filen
+<ul>
+<li>Make multi-threaded upload chunks individually retryable
+(Enduriel)</li>
+</ul></li>
+<li>Iclouddrive
+<ul>
+<li>Replace plaintext signin with SRP authentication (Mike GIllan)</li>
+<li>Use dynamic origin for SRP auth headers (Xiangzhe)</li>
+<li>Lowercase Apple ID for SRP authentication (Mike GIllan)</li>
+<li>Add read only iCloud Photos support and SRP authentication (Yakov
+Till)</li>
+</ul></li>
+<li>Internxt
+<ul>
+<li>Implement multi-part uploads (José Zúniga)</li>
+</ul></li>
+<li>Jottacloud
+<ul>
+<li>Add encoding of percent character to default backend encoding
+(albertony)</li>
+</ul></li>
+<li>Linkbox
+<ul>
+<li>Fix downloading files by using web API (Nick Craig-Wood)</li>
+</ul></li>
+<li>Mega
+<ul>
+<li>Fix crash when logging in with previous auth keys fails (Andrew
+Gunnerson)</li>
+</ul></li>
+<li>Pcloud
+<ul>
+<li>Fix recursive listing from the root (Nick Craig-Wood)</li>
+</ul></li>
+<li>Pikpak
+<ul>
+<li>Support custom filenames for addurl backend command (wiserain)</li>
+</ul></li>
+<li>Protondrive
+<ul>
+<li>Align backend with newer Proton SDK stack (tdawe)</li>
+<li>Update to latest go-proton-api to use new host (dlaumen)</li>
+<li>Fix server-side moveto and DirMove against current API (Nick
+Craig-Wood)</li>
+</ul></li>
+<li>S3
+<ul>
+<li>Add Fastly Object Storage provider (Leon Brocard)</li>
+<li>Add HCP provider and <code>list_versions_oldest_first</code> quirk
+(Chris)</li>
+<li>Add Impossible Cloud as a new S3 provider (Nick Craig-Wood)</li>
+<li>Add UCloud Object Storage provider (#9230) (jinkeyuu)</li>
+<li>Add Zadara Object Storage provider (Shlomi Avihou)</li>
+<li>Remove StackPath Object Storage provider (Leon Brocard)</li>
+<li>Add server side copy real time accounting (Nick Craig-Wood)</li>
+<li>Add OVHcloud storage classes (Bjoern Franke)</li>
+<li>Add Object Lock support (Chris)</li>
+<li>Add new Fastly Object Storage regions (Leon Brocard)</li>
+<li>Scaleway: ONEZONE_IA is available in all zones, GLACIER only in
+FR-PAR (Bjoern Franke)</li>
+<li>Ionos: updated regions &amp; endpoints (hxnd)</li>
+<li>IBM COS: provide ibm_iam_endpoint as a configurable param for IBM
+IAM-based auth (Bhagyashreek8)</li>
+<li>Fix Content-MD5 for Object Lock uploads and add GCS quirk
+(Chris)</li>
+<li>Fix regression where PutObject fails with non-seekable readers
+(Chris)</li>
+<li>Fix <code>--s3-versions</code> flag ignored by cleanup-hidden when
+GetBucketVersioning fails (Chris)</li>
+<li>Fix bucket creation failing on Ceph/radosgw (Jan Heylen)</li>
+</ul></li>
+<li>SFTP
+<ul>
+<li>Warn the user if no host key validation is configured (Nick
+Craig-Wood)</li>
+</ul></li>
+<li>WebDAV
+<ul>
+<li>Permit redirects on PROPFIND for metadata (Brian Bockelman)</li>
+<li>Request only required properties in listAll to improve performance
+(ZRHan)</li>
+<li>Optimize performance by using <code>Depth=0</code> for metadata
+requests (ZRHan)</li>
+</ul></li>
+</ul>
+<h2 id="v1.73.5---2026-04-19">v1.73.5 - 2026-04-19</h2>
+<p><a
+href="https://github.com/rclone/rclone/compare/v1.73.4...v1.73.5">See
+commits</a></p>
+<ul>
+<li>Bug Fixes
+<ul>
+<li>operations: Add AuthRequired to operations/fsinfo to prevent backend
+creation CVE-2026-41179 (Nick Craig-Wood)</li>
+<li>rc
+<ul>
+<li>Add AuthRequired to options/set to prevent auth bypass
+CVE-2026-41176 (Nick Craig-Wood)</li>
+<li>Snapshot NoAuth at startup to prevent runtime auth bypass
+CVE-2026-41176 (Nick Craig-Wood)</li>
+</ul></li>
+<li>filter: Fix debug logs that fire before logger is configured (Nick
+Craig-Wood)</li>
+</ul></li>
+<li>Azureblob
+<ul>
+<li>Add Microsoft Partner Network User-Agent prefix (Nick
+Craig-Wood)</li>
+</ul></li>
+<li>Drime
+<ul>
+<li>Fix User.EntryPermissions JSON unmarshalling (a1pcm)</li>
+</ul></li>
+<li>Iclouddrive
+<ul>
+<li>Fix 'directory not found' error when the directory contains accent
+marks (Brais Couce)</li>
+</ul></li>
+<li>S3
+<ul>
+<li>Fix TencentCOS CDN endpoint failing on bucket check (Mozi)</li>
+<li>Fix empty delimiter parameter rejected by Archiware P5 server (Nick
+Craig-Wood)</li>
+</ul></li>
+</ul>
+<h2 id="v1.73.4---2026-04-08">v1.73.4 - 2026-04-08</h2>
+<p><a
+href="https://github.com/rclone/rclone/compare/v1.73.3...v1.73.4">See
+commits</a></p>
+<ul>
+<li>Bug Fixes
+<ul>
+<li>build
+<ul>
+<li>Update to go 1.25.9 to fix multiple CVEs (Nick Craig-Wood)
+<ul>
+<li>CVE-2026-32282: os: Root.Chmod can follow symlinks out of the root
+on Linux</li>
+<li>CVE-2026-32289: html/template: JS template literal context
+incorrectly tracked</li>
+<li>CVE-2026-33810: crypto/x509: excluded DNS constraints not properly
+applied to wildcard domains</li>
+<li>CVE-2026-27144: cmd/compile: no-op interface conversion bypasses
+overlap checking</li>
+<li>CVE-2026-27143: cmd/compile: possible memory corruption after bound
+check elimination</li>
+<li>CVE-2026-32288: archive/tar: unbounded allocation when parsing old
+format GNU sparse map</li>
+<li>CVE-2026-32283: crypto/tls: multiple key update handshake messages
+can cause connection to deadlock</li>
+<li>CVE-2026-27140: cmd/go: trust layer bypass when using cgo and
+SWIG</li>
+<li>CVE-2026-32280: crypto/x509: unexpected work during chain
+building</li>
+<li>CVE-2026-32281: crypto/x509: inefficient policy validation</li>
+</ul></li>
+<li>Fix Denial of Service due to Panic in AWS SDK for Go v2 SDK
+EventStream Decoder (dependabot[bot])</li>
+<li>Update golang.org/x/image to 0.38.0 to fix CVE-2026-33809
+(dependabot[bot])</li>
+</ul></li>
+<li>docs
+<ul>
+<li>Fix header level for metadata option (Clément Notin)</li>
+<li>Fix markdown issues in mount docs (albertony)</li>
+<li>Fix link to not be language specific (Ross Smith II)</li>
+<li>Note macOS 10.15 (Catalina) support with version v1.70.3
+(kapitainsky)</li>
+</ul></li>
+</ul></li>
+<li>Filen
+<ul>
+<li>Update SDK version (Enduriel)</li>
+</ul></li>
+</ul>
+<h2 id="v1.73.3---2026-03-23">v1.73.3 - 2026-03-23</h2>
+<p><a
+href="https://github.com/rclone/rclone/compare/v1.73.2...v1.73.3">See
+commits</a></p>
+<ul>
+<li>Bug Fixes
+<ul>
+<li>build
+<ul>
+<li>Update to google.golang.org/grpc 1.79.3 to fix CVE-2026-33186
+(dependabot[bot])</li>
+<li>Update to github.com/buger/jsonparser 1.1.2 to fix
+GHSA-6g7g-w4f8-9c9x (dependabot[bot])</li>
+</ul></li>
+<li>doc fixes
+<ul>
+<li>Added text to the label showing version-introduced info (Jan-Philipp
+Reßler)</li>
+<li>Clarify Filen password change requires updating both password and
+API key in rclone config (Jason)</li>
+<li>s3: clarify multi tenant support for Cubbit (Marco Ferretti)</li>
+<li>jottacloud: Fix broken link (albertony)</li>
+</ul></li>
+<li>lib/rest: Fix URLPathEscapeAll breaking WebDAV servers (eg nzbdav)
+with strict path matching (Andrew Furman)</li>
+<li>list: Fix nil pointer panic in Sorter when temp file creation fails
+(Nick Craig-Wood)</li>
+</ul></li>
+</ul>
+<h2 id="v1.73.2---2026-03-06">v1.73.2 - 2026-03-06</h2>
+<p><a
+href="https://github.com/rclone/rclone/compare/v1.73.1...v1.73.2">See
+commits</a></p>
+<ul>
+<li>Bug Fixes
+<ul>
+<li>build
+<ul>
+<li>Update to go 1.25.8 to fix CVE-2026-27137 CVE-2026-27138
+CVE-2026-25679 CVE-2026-27142 (Nick Craig-Wood)</li>
+<li>Update github.com/cloudflare/circl to v1.6.3 to fix CVE-2026-1229
+(Nick Craig-Wood)</li>
+<li>Update to golang.org/x/net v0.51.0 to fix CVE-2026-27141 (Nick
+Craig-Wood)</li>
+</ul></li>
+<li>docs fixes:
+<ul>
+<li>bisync: Add group Sync to the bisync command (Jan-Philipp
+Reßler)</li>
+<li>Note that --use-server-modtime only works on some backends (Nick
+Craig-Wood)</li>
+<li>Document unsupported S3 object keys with double slashes (Adam
+Kasztenny)</li>
+<li>Fix headers hierarchy for mount.md (Dark Dragon)</li>
+<li>Fix new drive flag typo in changelog (razorloves)</li>
+</ul></li>
+</ul></li>
+<li>Archive
+<ul>
+<li>Extract: fix extraction with "./" prefix from tar entry paths (Varun
+Chawla)</li>
+</ul></li>
+<li>Drime
+<ul>
+<li>Fix chunk-uploaded files ignoring workspace ID (a1pcm)</li>
+</ul></li>
+<li>Internxt
+<ul>
+<li>Fix Entry doesn't belong in directory errors on windows
+(jzunigax2)</li>
+</ul></li>
+<li>WebDAV
+<ul>
+<li>Escape reserved characters in URL path segments (Varun Chawla)</li>
+<li>Add missing headers for CORS (Romāns Potašovs)</li>
+</ul></li>
+</ul>
+<h2 id="v1.73.1---2026-02-17">v1.73.1 - 2026-02-17</h2>
+<p><a
+href="https://github.com/rclone/rclone/compare/v1.73.0...v1.73.1">See
+commits</a></p>
+<ul>
+<li>Bug Fixes
+<ul>
+<li>accounting: Fix missing server side stats from core/stats rc (Nick
+Craig-Wood)</li>
+<li>build
+<ul>
+<li>Fix CVE-2025-68121 by updating go to 1.25.7 or later (Nick
+Craig-Wood)</li>
+<li>Bump github.com/go-chi/chi/v5 from 5.2.3 to 5.2.5 to fix
+GO-2026-4316 (albertony)</li>
+</ul></li>
+<li>docs: Extend copyurl docs with an example of CSV FILENAMEs starting
+with a path. (Jack Kelly)</li>
+<li>march: Fix runtime: program exceeds 10000-thread limit (Nick
+Craig-Wood)</li>
+<li>pacer
+<ul>
+<li>Fix deadlock between pacer token and --max-connections (Nick
+Craig-Wood)</li>
+<li>Re-read the sleep time as it may be stale (Nick Craig-Wood)</li>
+</ul></li>
+</ul></li>
+<li>Drime
+<ul>
+<li>Fix files and directories being created in the default workspace
+(Nick Craig-Wood)</li>
+</ul></li>
+<li>Filelu
+<ul>
+<li>Avoid buffering entire file in memory (kingston125)</li>
+<li>Add multipart upload support with configurable cutoff
+(kingston125)</li>
+</ul></li>
+<li>Filen
+<ul>
+<li>Fix 32 bit targets not being able to list directories
+(Enduriel)</li>
+<li>Fix potential panic in case of error during upload (Enduriel)</li>
+</ul></li>
+<li>Internxt
+<ul>
+<li>Implement re-login under refresh logic, improve retry logic (José
+Zúniga) -S3</li>
+<li>Set list_version to 2 for FileLu S3 configuration (kingston125)</li>
+</ul></li>
+</ul>
<h2 id="v1.73.0---2026-01-30">v1.73.0 - 2026-01-30</h2>
<p><a
href="https://github.com/rclone/rclone/compare/v1.72.0...v1.73.0">See
@@ -62731,8 +65527,8 @@ Frey)</li>
</ul></li>
<li>Drive
<ul>
-<li>Add <code>--drive-metadata-force-expansive-access</code> flag (Nick
-Craig-Wood)</li>
+<li>Add <code>--drive-metadata-enforce-expansive-access</code> flag
+(Nick Craig-Wood)</li>
<li>Fix crash when trying to creating shortcut to a Google doc (Nick
Craig-Wood)</li>
</ul></li>
@@ -74434,7 +77230,7 @@ installations</li>
<li>Project started</li>
</ul>
<h1 id="bugs-and-limitations">Bugs and Limitations</h1>
-<h2 id="limitations-46">Limitations</h2>
+<h2 id="limitations-48">Limitations</h2>
<h3 id="directory-timestamps-arent-preserved-on-some-backends">Directory
timestamps aren't preserved on some backends</h3>
<p>As of <code>v1.66</code>, rclone supports syncing directory modtimes,
@@ -74644,10 +77440,10 @@ formats</p>
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>
-<div class="sourceCode" id="cb1770"><pre
-class="sourceCode sh"><code class="sourceCode bash"><span id="cb1770-1"><a href="#cb1770-1" aria-hidden="true" tabindex="-1"></a><span class="co"># both should print a long list of possible IP addresses</span></span>
-<span id="cb1770-2"><a href="#cb1770-2" aria-hidden="true" tabindex="-1"></a><span class="ex">dig</span> www.googleapis.com <span class="co"># resolve using your default DNS</span></span>
-<span id="cb1770-3"><a href="#cb1770-3" aria-hidden="true" tabindex="-1"></a><span class="ex">dig</span> www.googleapis.com @8.8.8.8 <span class="co"># resolve with Google&#39;s DNS server</span></span></code></pre></div>
+<div class="sourceCode" id="cb1813"><pre
+class="sourceCode sh"><code class="sourceCode bash"><span id="cb1813-1"><a href="#cb1813-1" aria-hidden="true" tabindex="-1"></a><span class="co"># both should print a long list of possible IP addresses</span></span>
+<span id="cb1813-2"><a href="#cb1813-2" aria-hidden="true" tabindex="-1"></a><span class="ex">dig</span> www.googleapis.com <span class="co"># resolve using your default DNS</span></span>
+<span id="cb1813-3"><a href="#cb1813-3" aria-hidden="true" tabindex="-1"></a><span class="ex">dig</span> www.googleapis.com @8.8.8.8 <span class="co"># resolve with Google&#39;s DNS server</span></span></code></pre></div>
<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>
@@ -74670,8 +77466,8 @@ yyyy/mm/dd hh:mm:ss Fatal error: config failed to refresh token: failed to start
with opening the port on the host.</p>
<p>A simple solution may be restarting the Host Network Service with eg.
Powershell</p>
-<div class="sourceCode" id="cb1772"><pre
-class="sourceCode powershell"><code class="sourceCode powershell"><span id="cb1772-1"><a href="#cb1772-1" aria-hidden="true" tabindex="-1"></a><span class="fu">Restart-Service</span> hns</span></code></pre></div>
+<div class="sourceCode" id="cb1815"><pre
+class="sourceCode powershell"><code class="sourceCode powershell"><span id="cb1815-1"><a href="#cb1815-1" aria-hidden="true" tabindex="-1"></a><span class="fu">Restart-Service</span> hns</span></code></pre></div>
<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
@@ -74741,20 +77537,20 @@ TLS (TLS 1.2/1.3) and ECDHE-based cipher suites you can re-enable legacy
ciphers via <code>GODEBUG</code>:</p>
<ul>
<li><p>Windows (cmd.exe):</p>
-<div class="sourceCode" id="cb1773"><pre
-class="sourceCode bat"><code class="sourceCode dosbat"><span id="cb1773-1"><a href="#cb1773-1" aria-hidden="true" tabindex="-1"></a><span class="bu">set</span> <span class="va">GODEBUG</span>=tlsrsakex=1</span>
-<span id="cb1773-2"><a href="#cb1773-2" aria-hidden="true" tabindex="-1"></a>rclone copy ...</span></code></pre></div></li>
+<div class="sourceCode" id="cb1816"><pre
+class="sourceCode bat"><code class="sourceCode dosbat"><span id="cb1816-1"><a href="#cb1816-1" aria-hidden="true" tabindex="-1"></a><span class="bu">set</span> <span class="va">GODEBUG</span>=tlsrsakex=1</span>
+<span id="cb1816-2"><a href="#cb1816-2" aria-hidden="true" tabindex="-1"></a>rclone copy ...</span></code></pre></div></li>
<li><p>Windows (PowerShell):</p>
-<div class="sourceCode" id="cb1774"><pre
-class="sourceCode powershell"><code class="sourceCode powershell"><span id="cb1774-1"><a href="#cb1774-1" aria-hidden="true" tabindex="-1"></a><span class="va">$env</span><span class="op">:</span>GODEBUG<span class="op">=</span><span class="st">&quot;tlsrsakex=1&quot;</span></span>
-<span id="cb1774-2"><a href="#cb1774-2" aria-hidden="true" tabindex="-1"></a>rclone <span class="fu">copy</span> <span class="op">...</span></span></code></pre></div></li>
+<div class="sourceCode" id="cb1817"><pre
+class="sourceCode powershell"><code class="sourceCode powershell"><span id="cb1817-1"><a href="#cb1817-1" aria-hidden="true" tabindex="-1"></a><span class="va">$env</span><span class="op">:</span>GODEBUG<span class="op">=</span><span class="st">&quot;tlsrsakex=1&quot;</span></span>
+<span id="cb1817-2"><a href="#cb1817-2" aria-hidden="true" tabindex="-1"></a>rclone <span class="fu">copy</span> <span class="op">...</span></span></code></pre></div></li>
<li><p>Linux/macOS:</p>
-<div class="sourceCode" id="cb1775"><pre
-class="sourceCode sh"><code class="sourceCode bash"><span id="cb1775-1"><a href="#cb1775-1" aria-hidden="true" tabindex="-1"></a><span class="va">GODEBUG</span><span class="op">=</span>tlsrsakex=1 <span class="ex">rclone</span> copy ...</span></code></pre></div></li>
+<div class="sourceCode" id="cb1818"><pre
+class="sourceCode sh"><code class="sourceCode bash"><span id="cb1818-1"><a href="#cb1818-1" aria-hidden="true" tabindex="-1"></a><span class="va">GODEBUG</span><span class="op">=</span>tlsrsakex=1 <span class="ex">rclone</span> copy ...</span></code></pre></div></li>
</ul>
<p>If the server only supports 3DES, try:</p>
-<div class="sourceCode" id="cb1776"><pre
-class="sourceCode sh"><code class="sourceCode bash"><span id="cb1776-1"><a href="#cb1776-1" aria-hidden="true" tabindex="-1"></a><span class="va">GODEBUG</span><span class="op">=</span>tls3des=1 <span class="ex">rclone</span> ...</span></code></pre></div>
+<div class="sourceCode" id="cb1819"><pre
+class="sourceCode sh"><code class="sourceCode bash"><span id="cb1819-1"><a href="#cb1819-1" aria-hidden="true" tabindex="-1"></a><span class="va">GODEBUG</span><span class="op">=</span>tls3des=1 <span class="ex">rclone</span> ...</span></code></pre></div>
<p>This applies to <strong>any rclone feature using TLS</strong> (HTTPS,
FTPS, WebDAV over TLS, proxies with TLS interception, etc.). Use these
workarounds only long enough to get the server/proxy updated.</p>
@@ -76857,7 +79653,9 @@ class="email">[email protected]</a></li>
<li>Flora Thiebaut <a href="mailto:[email protected]"
class="email">[email protected]</a></li>
<li>kingston125 <a href="mailto:[email protected]"
-class="email">[email protected]</a></li>
+class="email">[email protected]</a> <a
+href="mailto:[email protected]"
+class="email">[email protected]</a></li>
<li>Ser-Bul <a href="mailto:[email protected]"
class="email">[email protected]</a></li>
<li>jinjingroad <a href="mailto:[email protected]"
@@ -77065,6 +79863,117 @@ class="email">[email protected]</a></li>
class="email">[email protected]</a></li>
<li>StarHack <a href="mailto:[email protected]"
class="email">[email protected]</a></li>
+<li>Leon Brocard <a href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>Cohinem <a href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>Jack Kelly <a href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>Prakhar Chhalotre <a href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>Varun Chawla <a
+href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>Jan-Philipp Reßler <a
+href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>Shlomi Avihou <a href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>Chris <a
+href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>Jan-Philipp Reßler <a href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>Dark Dragon <a href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>Leon Brocard <a href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>a1pcm <a href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>FTCHD <a href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>Bjoern Franke <a href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>hxnd <a href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>Adam Kasztenny <a href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>Romāns Potašovs <a href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>Brian Bockelman <a href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>Bjoern Franke <a href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>razorloves <a href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>Duncan F <a
+href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>Billy Hughes <a href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>Bhagyashreek8 <a
+href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>Andriy Senyshyn <a
+href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>Andrew Furman <a
+href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>ZRHan <a href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>Jason <a href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>Patrick Farrell <a href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>BizaNator <a
+href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>lif <a href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>jinkeyuu <a href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>jinyu.han <a href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>Claude Opus 4.6 <a href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>Andriy Senyshyn <a href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>Mike GIllan <a href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>Xiangzhe <a href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>Suyun <a href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>TheBabu <a href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>Brais Couce <a href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>Mozi <a href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>SyoBoN <a href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>Jan Heylen <a href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>tdawe <a href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>Anton Bordwine <a
+href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>mathieulongtin <a
+href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>Luke Cyca <a href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>dlaumen <a href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>Yakov Till <a
+href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>Chris Coughlan <a href="mailto:[email protected]"
+class="email">[email protected]</a></li>
+<li>John Volk <a href="mailto:[email protected]"
+class="email">[email protected]</a></li>
</ul>
<h1 id="contact-the-rclone-project">Contact the rclone project</h1>
<h2 id="forum">Forum</h2>
diff --git a/MANUAL.md b/MANUAL.md
index d586ea5de..9fa88d862 100644
--- a/MANUAL.md
+++ b/MANUAL.md
@@ -1,6 +1,6 @@
% rclone(1) User Manual
% Nick Craig-Wood
-% Jan 30, 2026
+% May 01, 2026
# NAME
@@ -36,6 +36,7 @@ Available commands:
deletefile Remove a single file from remote.
gendocs Output markdown docs for rclone to the directory supplied.
gitannex Speaks with git-annex over stdin/stdout.
+ gui Open the web based GUI.
hashsum Produces a hashsum file for all the objects in the path.
help Show help for rclone commands, flags and backends.
link Generate public link to file/folder.
@@ -78,7 +79,7 @@ Use "rclone help backends" for a list of supported services.
# Rclone syncs your files to cloud storage
<!-- markdownlint-disable-next-line line-length -->
-<img width="50%" src="https://rclone.org/img/logo_on_light__horizontal_color.svg" alt="rclone logo" style="float:right; padding: 5px;" >
+<img width="50%" src="https://rclone.org/img/logo_on_light__horizontal_color.svg" dark-src="/img/logo_on_dark__horizontal_color.svg" alt="rclone logo" style="float:right; padding: 5px;" class="hide-mobile" >
- [About rclone](#about)
- [What can rclone do for you?](#what)
@@ -203,6 +204,7 @@ WebDAV or S3, that work out of the box.)
- Dropbox
- Enterprise File Fabric
- Exaba
+- Fastly Object Storage
- Fastmail Files
- FileLu Cloud Storage
- FileLu S5 (S3-Compatible Object Storage)
@@ -218,7 +220,9 @@ WebDAV or S3, that work out of the box.)
- Hetzner Object Storage
- Hetzner Storage Box
- HiDrive
+- Hitachi Content Platform (HCP)
- HTTP
+- Huawei Drive
- Huawei OBS
- iCloud Drive
- ImageKit
@@ -227,6 +231,7 @@ WebDAV or S3, that work out of the box.)
- Jottacloud
- IBM COS S3
- IDrive e2
+- Impossible Cloud
- Intercolo Object Storage
- IONOS Cloud
- Koofr
@@ -280,15 +285,16 @@ WebDAV or S3, that work out of the box.)
- Sia
- SMB / CIFS
- Spectra Logic
-- StackPath
- Storj
- Synology
- SugarSync
- Tencent Cloud Object Storage (COS)
- Uloz.to
+- US3
- Wasabi
- WebDAV
- Yandex Disk
+- Zadara Object Storage
- Zoho WorkDrive
- Zata
- The local filesystem
@@ -317,9 +323,9 @@ These backends adapt or modify other storage providers:
## Links
-- [Home page](https://rclone.org/)
-- [GitHub project page for source and bug tracker](https://github.com/rclone/rclone)
-- [Rclone Forum](https://forum.rclone.org)
+- [Home page](https://rclone.org/)
+- [GitHub project page for source and bug tracker](https://github.com/rclone/rclone)
+- [Rclone Forum](https://forum.rclone.org)
- [Downloads](https://rclone.org/downloads/)
# Install
@@ -699,7 +705,7 @@ not the rclone developers so it may be out of date. Its current version is as be
## Source installation {#source}
Make sure you have git and [Go](https://golang.org/) installed.
-Go version 1.24 or newer is required, the latest release is recommended.
+Go version 1.25 or newer is required, the latest release is recommended.
You can get it from your package manager, or download it from
[golang.org/dl](https://golang.org/dl/). Then you can run the following:
@@ -1059,6 +1065,7 @@ See the following for detailed instructions for
- [Hetzner Storage Box](https://rclone.org/sftp/#hetzner-storage-box)
- [HiDrive](https://rclone.org/hidrive/)
- [HTTP](https://rclone.org/http/)
+- [Huawei Drive](https://rclone.org/huaweidrive/)
- [iCloud Drive](https://rclone.org/iclouddrive/)
- [Internet Archive](https://rclone.org/internetarchive/)
- [Internxt](https://rclone.org/internxt/)
@@ -3690,6 +3697,7 @@ before using, or data loss can result. Questions can be asked in the
See [full bisync description](https://rclone.org/bisync/) for details.
+
```
rclone bisync remote1:path1 remote2:path2 [flags]
```
@@ -3721,7 +3729,7 @@ rclone bisync remote1:path1 remote2:path2 [flags]
-1, --resync Performs the resync run. Equivalent to --resync-mode path1. Consider using --verbose or --dry-run first.
--resync-mode string During resync, prefer the version that is: path1, path2, newer, older, larger, smaller (default: path1 if --resync, otherwise none for no resync.) (default "none")
--slow-hash-sync-only Ignore slow checksums for listings and deltas, but still consider them during sync calls.
- --workdir string Use custom working dir - useful for testing. (default: {WORKDIR})
+ --workdir string Use custom working dir - useful for testing. (default: $HOME/.cache/rclone/bisync)
```
Options shared with other commands are described next.
@@ -3768,6 +3776,26 @@ Flags for anything which can copy a file
-u, --update Skip files that are newer on the destination
```
+### Sync Options
+
+Flags used for sync commands
+
+```text
+ --backup-dir string Make backups into hierarchy based in DIR
+ --delete-after When synchronizing, delete files on destination after transferring (default)
+ --delete-before When synchronizing, delete files on destination before transferring
+ --delete-during When synchronizing, delete files during transfer
+ --fix-case Force rename of case insensitive dest to match source
+ --ignore-errors Delete even if there are I/O errors
+ --list-cutoff int To save memory, sort directory listings on disk above this threshold (default 1000000)
+ --max-delete int When synchronizing, limit the number of deletes (default -1)
+ --max-delete-size SizeSuffix When synchronizing, limit the total size of deletes (default off)
+ --suffix string Suffix to add to changed files
+ --suffix-keep-extension Preserve the extension when using --suffix
+ --track-renames When synchronizing, track file renames and do a server-side move if possible
+ --track-renames-strategy string Strategies to use when synchronizing using track-renames hash|modtime|leaf (default "hash")
+```
+
### Important Options
Important flags useful for most commands
@@ -5388,12 +5416,12 @@ rclone convmv "stories/The Quick Brown Fox!.txt" --name-transform "all,command=e
```console
rclone convmv "stories/The Quick Brown Fox!" --name-transform "date=-{YYYYMMDD}"
-// Output: stories/The Quick Brown Fox!-20260130
+// Output: stories/The Quick Brown Fox!-20260501
```
```console
rclone convmv "stories/The Quick Brown Fox!" --name-transform "date=-{macfriendlytime}"
-// Output: stories/The Quick Brown Fox!-2026-01-30 0825PM
+// Output: stories/The Quick Brown Fox!-2026-05-01 0208PM
```
```console
@@ -5841,6 +5869,15 @@ Note that `--stdout` and `--print-filename` are incompatible with `--urls`.
This will do `--transfers` copies in parallel. Note that if `--auto-filename`
is desired for all URLs then a file with only URLs and no filename can be used.
+Each FILENAME in the CSV file can start with a relative path which will be appended
+to the destination path provided at the command line. For example, running the command
+shown above with the following CSV file will write two files to the destination:
+`remote:dir/local/path/bar.json` and `remote:dir/another/local/directory/qux.json`
+```csv
+https://example.org/foo/bar.json,local/path/bar.json
+https://example.org/qux/baz.json,another/local/directory/qux.json
+```
+
## Troubleshooting
If you can't get `rclone copyurl` to work then here are some things you can try:
@@ -6245,6 +6282,119 @@ See the [global flags page](https://rclone.org/flags/) for global options not li
* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends.
+<!-- markdownlint-restore -->
+
+# rclone gui
+
+Open the web based GUI.
+
+## Synopsis
+
+This command starts an embedded web GUI for rclone and opens it in
+your default browser.
+
+This starts an RC API server and a GUI server on separate localhost
+ports, generates login credentials automatically unless --no-auth
+is specified, and opens the browser already authenticated.
+
+ rclone gui
+
+By default rclone gui serves the web GUI that was embedded into the
+rclone binary at build time from https://github.com/rclone/rclone-web/
+You can override this by passing a path to either an unpacked GUI
+directory or a dist.zip archive (e.g. one downloaded from the
+rclone-web releases page):
+
+ rclone gui ./my-dist/
+ rclone gui ./dist.zip
+
+This is useful for iterating on the GUI locally without rebuilding
+rclone, or for serving a different GUI release than the one embedded.
+
+Use --no-open-browser to skip opening the browser automatically:
+
+ rclone gui --no-open-browser
+
+Use --addr to bind the GUI to a specific address:
+
+ rclone gui --addr localhost:5580
+
+Use --user and --pass to set specific credentials:
+
+ rclone gui --user admin --pass secret
+
+Use --no-auth to disable authentication entirely:
+
+ rclone gui --no-auth
+
+For more help see [the GUI docs](https://rclone.org/gui/).
+
+
+```
+rclone gui [path] [flags]
+```
+
+## Options
+
+```
+ --addr stringArray IPaddress:Port for the GUI server (default auto-chosen localhost port)
+ --api-addr stringArray IPaddress:Port for the RC API server (default auto-chosen localhost port)
+ --enable-metrics Enable OpenMetrics/Prometheus compatible endpoint at /metrics
+ -h, --help help for gui
+ --no-auth Don't require auth for the RC API
+ --no-open-browser Skip opening the browser automatically
+ --pass string Password for RC authentication
+ --user string User name for RC authentication
+```
+
+Options shared with other commands are described next.
+See the [global flags page](https://rclone.org/flags/) for global options not listed here.
+
+### RC Options
+
+Flags to control the Remote Control API
+
+```text
+ --rc Enable the remote control server
+ --rc-addr stringArray IPaddress:Port or :Port to bind server to (default localhost:5572)
+ --rc-allow-origin string Origin which cross-domain request (CORS) can be executed from
+ --rc-baseurl string Prefix for URLs - leave blank for root
+ --rc-cert string TLS PEM key (concatenation of certificate and CA certificate)
+ --rc-client-ca string Client certificate authority to verify clients with
+ --rc-enable-metrics Enable the Prometheus metrics path at the remote control server
+ --rc-files string Path to local files to serve on the HTTP server
+ --rc-htpasswd string A htpasswd file - if not provided no authentication is done
+ --rc-job-expire-duration Duration Expire finished async jobs older than this value (default 1m0s)
+ --rc-job-expire-interval Duration Interval to check for expired async jobs (default 10s)
+ --rc-key string TLS PEM Private key
+ --rc-max-header-bytes int Maximum size of request header (default 4096)
+ --rc-min-tls-version string Minimum TLS version that is acceptable (default "tls1.0")
+ --rc-no-auth Don't require auth for certain methods
+ --rc-pass string Password for authentication
+ --rc-realm string Realm for authentication
+ --rc-salt string Password hashing salt (default "dlPL2MqE")
+ --rc-serve Enable the serving of remote objects
+ --rc-serve-no-modtime Don't read the modification time (can speed things up)
+ --rc-server-read-timeout Duration Timeout for server reading data (default 1h0m0s)
+ --rc-server-write-timeout Duration Timeout for server writing data (default 1h0m0s)
+ --rc-template string User-specified template
+ --rc-user string User name for authentication
+ --rc-user-from-header string User name from a defined HTTP header
+ --rc-web-fetch-url string URL to fetch the releases for webgui (default "https://api.github.com/repos/rclone/rclone-webui-react/releases/latest")
+ --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't open the browser automatically
+ --rc-web-gui-update Check and update to latest version of web gui
+```
+
+## See Also
+
+<!-- markdownlint-capture -->
+<!-- markdownlint-disable ul-style line-length -->
+
+* [rclone](https://rclone.org/commands/rclone/) - Show help for rclone commands, flags and backends.
+
+
<!-- markdownlint-restore -->
# rclone hashsum
@@ -6432,6 +6582,9 @@ Result can be filtered by a filter argument which applies to all attributes,
and/or filter flags specific for each attribute. The values must be specified
according to regular rclone filtering pattern syntax.
+By default filtering uses non-anchored matching, so `--type box` also
+matches `dropbox`. Use `--exact` to match complete values only.
+
```
rclone listremotes [<filter>] [flags]
```
@@ -6440,6 +6593,7 @@ rclone listremotes [<filter>] [flags]
```
--description string Filter remotes by description
+ --exact Match filter strings exactly instead of using non-anchored glob matching
-h, --help help for listremotes
--json Format output as JSON
--long Show type and description in addition to name
@@ -6892,7 +7046,8 @@ Mount the remote as file system on a mountpoint.
Rclone mount allows Linux, FreeBSD, macOS and Windows to
mount any of Rclone's cloud storage systems as a file system with FUSE.
-First set up your remote using `rclone config`. Check it works with `rclone ls` etc.
+First set up your remote using `rclone config`. Check it works with `rclone ls`
+etc.
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 `--daemon` flag
@@ -6920,8 +7075,8 @@ The following examples will mount to an automatically assigned drive,
to specific drive letter `X:`, to path `C:\path\parent\mount`
(where parent directory or drive must exist, and mount must **not** exist,
and is not supported when [mounting as a network drive](#mounting-modes-on-windows)),
-and the last example will mount as network share `\\cloud\remote` and map it to an
-automatically assigned drive:
+and the last example will mount as network share `\\cloud\remote` and map it to
+an automatically assigned drive:
```console
rclone mount remote:path/to/files *
@@ -7027,8 +7182,8 @@ rclone mount remote:path/to/files X: --volname \\server\share
You may also specify the network share UNC path as the mountpoint itself. Then rclone
will automatically assign a drive letter, same as with `*` and use that as
-mountpoint, and instead use the UNC path specified as the volume name, as if it were
-specified with the `--volname` option. This will also implicitly set
+mountpoint, and instead use the UNC path specified as the volume name, as if it
+were specified with the `--volname` option. This will also implicitly set
the `--network-mode` option. This means the following two examples have same result:
```console
@@ -7159,7 +7314,7 @@ does not suffer from the same limitations.
Mounting on macOS can be done either via [built-in NFS server](https://rclone.org/commands/rclone_serve_nfs/),
[macFUSE](https://osxfuse.github.io/) (also known as osxfuse) or
-[FUSE-T](https://www.fuse-t.org/).macFUSE is a traditional FUSE driver utilizing
+[FUSE-T](https://www.fuse-t.org/). macFUSE is a traditional FUSE driver utilizing
a macOS kernel extension (kext). FUSE-T is an alternative FUSE system which
"mounts" via an NFSv4 local server.
@@ -7202,29 +7357,30 @@ current as of FUSE-T version 1.0.14.
As per the [FUSE-T wiki](https://github.com/macos-fuse-t/fuse-t/wiki#caveats):
-> File access and modification times cannot be set separately as it seems to be an
-> issue with the NFS client which always modifies both. Can be reproduced with
-> 'touch -m' and 'touch -a' commands
+> File access and modification times cannot be set separately as it seems to be
+> an issue with the NFS client which always modifies both. Can be reproduced
+> with `touch -m` and `touch -a` commands
-This means that viewing files with various tools, notably macOS Finder, will cause
-rlcone to update the modification time of the file. This may make rclone upload a
-full new copy of the file.
+This means that viewing files with various tools, notably macOS Finder, will
+cause rlcone to update the modification time of the file. This may make rclone
+upload a full new copy of the file.
#### Read Only mounts
When mounting with `--read-only`, attempts to write to files will fail *silently*
as opposed to with a clear warning as in macFUSE.
-# Mounting on Linux
+## Mounting on Linux
On newer versions of Ubuntu, you may encounter the following error when running
`rclone mount`:
> NOTICE: mount helper error: fusermount3: mount failed: Permission denied
> CRITICAL: Fatal error: failed to mount FUSE fs: fusermount: exit status 1
+
This may be due to newer [Apparmor](https://wiki.ubuntu.com/AppArmor) restrictions,
-which can be disabled with `sudo aa-disable /usr/bin/fusermount3` (you may need to
-`sudo apt install apparmor-utils` beforehand).
+which can be disabled with `sudo aa-disable /usr/bin/fusermount3` (you may need
+to `sudo apt install apparmor-utils` beforehand).
## Limitations
@@ -7923,6 +8079,7 @@ rclone mount remote:path /path/to/mountpoint [flags]
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
@@ -8334,7 +8491,8 @@ Mount the remote as file system on a mountpoint.
Rclone nfsmount allows Linux, FreeBSD, macOS and Windows to
mount any of Rclone's cloud storage systems as a file system with FUSE.
-First set up your remote using `rclone config`. Check it works with `rclone ls` etc.
+First set up your remote using `rclone config`. Check it works with `rclone ls`
+etc.
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 `--daemon` flag
@@ -8362,8 +8520,8 @@ The following examples will mount to an automatically assigned drive,
to specific drive letter `X:`, to path `C:\path\parent\mount`
(where parent directory or drive must exist, and mount must **not** exist,
and is not supported when [mounting as a network drive](#mounting-modes-on-windows)),
-and the last example will mount as network share `\\cloud\remote` and map it to an
-automatically assigned drive:
+and the last example will mount as network share `\\cloud\remote` and map it to
+an automatically assigned drive:
```console
rclone nfsmount remote:path/to/files *
@@ -8469,8 +8627,8 @@ rclone nfsmount remote:path/to/files X: --volname \\server\share
You may also specify the network share UNC path as the mountpoint itself. Then rclone
will automatically assign a drive letter, same as with `*` and use that as
-mountpoint, and instead use the UNC path specified as the volume name, as if it were
-specified with the `--volname` option. This will also implicitly set
+mountpoint, and instead use the UNC path specified as the volume name, as if it
+were specified with the `--volname` option. This will also implicitly set
the `--network-mode` option. This means the following two examples have same result:
```console
@@ -8601,7 +8759,7 @@ does not suffer from the same limitations.
Mounting on macOS can be done either via [built-in NFS server](https://rclone.org/commands/rclone_serve_nfs/),
[macFUSE](https://osxfuse.github.io/) (also known as osxfuse) or
-[FUSE-T](https://www.fuse-t.org/).macFUSE is a traditional FUSE driver utilizing
+[FUSE-T](https://www.fuse-t.org/). macFUSE is a traditional FUSE driver utilizing
a macOS kernel extension (kext). FUSE-T is an alternative FUSE system which
"mounts" via an NFSv4 local server.
@@ -8644,29 +8802,30 @@ current as of FUSE-T version 1.0.14.
As per the [FUSE-T wiki](https://github.com/macos-fuse-t/fuse-t/wiki#caveats):
-> File access and modification times cannot be set separately as it seems to be an
-> issue with the NFS client which always modifies both. Can be reproduced with
-> 'touch -m' and 'touch -a' commands
+> File access and modification times cannot be set separately as it seems to be
+> an issue with the NFS client which always modifies both. Can be reproduced
+> with `touch -m` and `touch -a` commands
-This means that viewing files with various tools, notably macOS Finder, will cause
-rlcone to update the modification time of the file. This may make rclone upload a
-full new copy of the file.
+This means that viewing files with various tools, notably macOS Finder, will
+cause rlcone to update the modification time of the file. This may make rclone
+upload a full new copy of the file.
#### Read Only mounts
When mounting with `--read-only`, attempts to write to files will fail *silently*
as opposed to with a clear warning as in macFUSE.
-# Mounting on Linux
+## Mounting on Linux
On newer versions of Ubuntu, you may encounter the following error when running
`rclone mount`:
> NOTICE: mount helper error: fusermount3: mount failed: Permission denied
> CRITICAL: Fatal error: failed to mount FUSE fs: fusermount: exit status 1
+
This may be due to newer [Apparmor](https://wiki.ubuntu.com/AppArmor) restrictions,
-which can be disabled with `sudo aa-disable /usr/bin/fusermount3` (you may need to
-`sudo apt install apparmor-utils` beforehand).
+which can be disabled with `sudo aa-disable /usr/bin/fusermount3` (you may need
+to `sudo apt install apparmor-utils` beforehand).
## Limitations
@@ -9370,6 +9529,7 @@ rclone nfsmount remote:path /path/to/mountpoint [flags]
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
@@ -9706,6 +9866,12 @@ identically.
`--rc-disable-zip` may be set to disable the zipping download option.
+### Protocol
+
+The server supports HTTP/1.1 and HTTP/2. HTTP/2 is used automatically
+for TLS connections. For non-TLS connections, HTTP/2 cleartext (h2c)
+is supported, allowing HTTP/2 without encryption.
+
### TLS (SSL)
By default this will serve over http. If you want you can serve over
@@ -10620,6 +10786,7 @@ rclone serve dlna remote:path [flags]
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
@@ -11264,6 +11431,7 @@ rclone serve docker [flags]
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
@@ -11957,6 +12125,7 @@ rclone serve ftp remote:path [flags]
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
@@ -12064,6 +12233,12 @@ identically.
`--disable-zip` may be set to disable the zipping download option.
+### Protocol
+
+The server supports HTTP/1.1 and HTTP/2. HTTP/2 is used automatically
+for TLS connections. For non-TLS connections, HTTP/2 cleartext (h2c)
+is supported, allowing HTTP/2 without encryption.
+
### TLS (SSL)
By default this will serve over http. If you want you can serve over
@@ -12787,6 +12962,7 @@ rclone serve http remote:path [flags]
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
@@ -13449,6 +13625,7 @@ rclone serve nfs remote:path [flags]
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
@@ -13633,6 +13810,12 @@ identically.
`--disable-zip` may be set to disable the zipping download option.
+### Protocol
+
+The server supports HTTP/1.1 and HTTP/2. HTTP/2 is used automatically
+for TLS connections. For non-TLS connections, HTTP/2 cleartext (h2c)
+is supported, allowing HTTP/2 without encryption.
+
### TLS (SSL)
By default this will serve over http. If you want you can serve over
@@ -13973,6 +14156,12 @@ identically.
`--disable-zip` may be set to disable the zipping download option.
+### Protocol
+
+The server supports HTTP/1.1 and HTTP/2. HTTP/2 is used automatically
+for TLS connections. For non-TLS connections, HTTP/2 cleartext (h2c)
+is supported, allowing HTTP/2 without encryption.
+
### TLS (SSL)
By default this will serve over http. If you want you can serve over
@@ -14547,6 +14736,7 @@ rclone serve s3 remote:path [flags]
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
@@ -15285,6 +15475,7 @@ rclone serve sftp remote:path [flags]
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
@@ -15416,6 +15607,19 @@ rclone --webdav-unix-socket /tmp/my.socket --webdav-url http://localhost lsf :we
Note that there is no authentication on http protocol - this is expected to be
done by the permissions on the socket.
+## Symlinks / Junction points
+
+The webdav protocol does not support symlinks or junction points and
+by default rclone will skip them completely.
+
+You can use `-L` to get rclone to follow symlinks or you can
+use `--local-links` to make rclone show `.rclonelink`
+files in place of the symlinks.
+
+**NB** Do not use `--links` as since v1.69 this applies to
+the VFS layer too, use `--local-links` which only applies to
+the local backend only.
+
## Server options
Use `--addr` to specify which IP address and port the server should
@@ -15449,6 +15653,12 @@ identically.
`--disable-zip` may be set to disable the zipping download option.
+### Protocol
+
+The server supports HTTP/1.1 and HTTP/2. HTTP/2 is used automatically
+for TLS connections. For non-TLS connections, HTTP/2 cleartext (h2c)
+is supported, allowing HTTP/2 without encryption.
+
### TLS (SSL)
By default this will serve over http. If you want you can serve over
@@ -16174,6 +16384,7 @@ rclone serve webdav remote:path [flags]
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
@@ -16619,6 +16830,10 @@ time instead of the current time. Times may be specified as one of:
Note that value of `--timestamp` is in UTC. If you want local time
then add the `--localtime` flag.
+Metadata can be added when creating a new file with `--metadata-set`.
+For example:
+ rclone touch remote:path -M --metadata-set key=value
+
```
rclone touch remote:path [flags]
```
@@ -18685,7 +18900,7 @@ This is the default.
`CAUTIOUS` will try to prevent rclone from reaching the limit. Only applicable
for `--max-transfer`.
-## -M, --metadata
+### -M, --metadata
Setting this flag enables rclone to copy the metadata from the source
to the destination. For local backends this is ownership, permissions,
@@ -19587,6 +19802,10 @@ 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.
+This flag is only supported on certain backends and will be silently
+ignored on unsupported backends. Supported backends include
+`azureblob`, `oracleobjectstorage`, `s3`, `swift`.
+
Using this flag on a sync operation without also using `--update` 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.
@@ -19906,6 +20125,10 @@ The available flags are:
- `mapper` dumps the JSON blobs being sent to the program supplied with
`--metadata-mapper` and received from it. It can be useful for debugging
the metadata mapper interface.
+- `curl` dumps the HTTP request as a `curl` command. Can be used with
+ the other HTTP debugging flags (e.g. `requests`, `bodies`). By
+ default the auth will be masked - use with `auth` to have the curl
+ commands with authentication too.
## Filtering
@@ -21287,112 +21510,124 @@ the [rclone forum](https://forum.rclone.org/) are:
- Not using `/` to match from the root of a remote
- Not using `**` to match the contents of a directory
-# GUI (Experimental)
+# rclone gui
-Rclone can serve a web based GUI (graphical user interface). This is
-somewhat experimental at the moment so things may be subject to
-change.
+The `rclone gui` command starts the official Web GUI that comes
+bundled with rclone.
-Run this command in a terminal and rclone will download and then
-display the GUI in a web browser.
+With this command, rclone can serve a web-based GUI (graphical user
+interface) that is accessible from a normal web browser.
+
+Run it in a terminal and rclone will initialize and then start the
+GUI.
```console
-rclone rcd --rc-web-gui
+rclone gui
```
-This will produce logs like this and rclone needs to continue to run to serve
-the GUI:
+This will produce logs like this. The terminal window needs to stay
+open to continue to run the GUI:
-```text
-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/
+```console
+2026/04/14 11:36:04 NOTICE: Serving remote control on http://127.0.0.1:50803/
+2026/04/14 11:36:04 NOTICE: Serving GUI on http://127.0.0.1:50802/
+2026/04/14 11:36:04 NOTICE: GUI available at http://127.0.0.1:50802/login?pass=XXX&url=http%3A%2F%2F127.0.0.1%3A50803%2F&user=gui
```
-This assumes you are running rclone locally on your machine. It is
-possible to separate the rclone and the GUI - see below for details.
-
-If you wish to check for updates then you can add `--rc-web-gui-update`
-to the command line.
-
-If you find your GUI broken, you may force it to update by add `--rc-web-gui-force-update`.
-
-By default, rclone will open your browser. Add `--rc-web-gui-no-open-browser`
-to disable this feature.
+You can also add debugging flags when running the GUI, such as `-v`,
+which will show more logging output from the rc server.
## Using the GUI
-Once the GUI opens, you will be looking at the dashboard which has an overall overview.
+Once the browser opens, you will be presented with the Dashboard, the
+main screen where you can see the status of your remotes and system.
-On the left hand side you will see a series of view buttons you can click on:
+At the top, starting from the left, you will see a series of tabs you
+can click on. On the right side you will have the logout button and
+potentially an "Update available" message if a new rclone version has
+been released.
-- Dashboard - main overview
-- Configs - examine and create new configurations
-- Explorer - view, download and upload files to the cloud storage systems
-- Backend - view or alter the backend config
-- Log out
+### Dashboard
-(More docs and walkthrough video to come!)
+See live metrics, learn if your remotes are near capacity, and read
+the changelog for the current version.
-## How it works
+### Explorer
-When you run the `rclone rcd --rc-web-gui` this is what happens
+Explore and manage both local disks and remotes, download files and
+directories and start transfers.
-- Rclone starts but only runs the remote control API ("rc").
-- The API is bound to localhost with an auto-generated username and password.
-- If the API bundle is missing then rclone will download it.
-- rclone will start serving the files from the API bundle over the same port as
- the API
-- rclone will open the browser with a `login_token` so it can log straight in.
+### Remotes
-## Advanced use
+Scroll the list of remotes and tap on it to navigate to the explorer.
+There you can navigate the contents of your remotes, transfer,
+download, and even upload files.
-The `rclone rcd` may use any of the [flags documented on the rc page](https://rclone.org/rc/#supported-parameters).
+### Mounts
-The flag `--rc-web-gui` is shorthand for
+Mount remotes as local drives on your computer and check on your
+existing mounts.
-- Download the web GUI if necessary
-- Check we are using some authentication
-- `--rc-user gui`
-- `--rc-pass <random password>`
-- `--rc-serve`
+### Serves
-These flags can be overridden as desired.
+Get quick info about your active serve instances, and start new ones.
-See also the [rclone rcd documentation](https://rclone.org/commands/rclone_rcd/).
+### Settings
-### Example: Running a public GUI
+Edit your `rclone.conf` file directly, set logging flags, and
+performance parameters.
-For example the GUI could be served on a public port over SSL using an htpasswd
-file using the following flags:
+## How it works
-- `--rc-web-gui`
-- `--rc-addr :443`
-- `--rc-htpasswd /path/to/htpasswd`
-- `--rc-cert /path/to/ssl.crt`
-- `--rc-key /path/to/ssl.key`
+When you run `rclone gui` this is what happens
-### Example: Running a GUI behind a proxy
+- Rclone starts the remote control API ("rc").
+- Rclone starts a second server to serve the Web GUI.
+- If a port, username or password is not specified, then missing
+ values will be auto-generated.
+- Unless `--no-open-browser` is passed, a browser window will open.
+- The URL already contains the username & password, in which case the
+ GUI will use those values and log you in automatically.
-If you want to run the GUI behind a proxy at `/rclone` you could use these flags:
+## Security
-- `--rc-web-gui`
-- `--rc-baseurl rclone`
-- `--rc-htpasswd /path/to/htpasswd`
+It's important to think first about what rclone has access to and what
+you might be sharing.
-Or instead of htpasswd if you just want a single user and password:
+A few good measures:
-- `--rc-user me`
-- `--rc-pass mypassword`
+- Don't use `--no-auth` (this is for testing only).
+- Do not expose to the local network (eg with `--api-addr :5572 --addr
+ :8080`) unless you trust all devices on your local network. Prefer
+ `127.0.0.1` or `localhost` (the default).
+- Use a strong password and non-obvious usernames like "admin" or
+ "rclone" if you are using `--user` and `--pass`.
+- If you want to host it on a server and access it remotely, make sure
+ you're only exposing the GUI and not the RC API. They listen on
+ different ports.
-## Project
+If you want to access it remotely but want to avoid running a proxy
+and exposing ports, you can use Cloudflare Tunnels or localhost.run or
+Tailscale (all free).
-The GUI is being developed in the: [rclone/rclone-webui-react repository](https://github.com/rclone/rclone-webui-react).
+## Options
-Bug reports and contributions are very welcome :-)
+```console
+ --addr stringArray IPaddress:Port for the GUI server (default auto-chosen localhost port)
+ --api-addr stringArray IPaddress:Port for the RC API server (default auto-chosen localhost port)
+ --enable-metrics Enable OpenMetrics/Prometheus compatible endpoint at /metrics
+ -h, --help help for gui
+ --no-auth Don't require auth for the RC API
+ --no-open-browser Skip opening the browser automatically
+ --pass string Password for RC authentication
+ --user string User name for RC authentication
+```
+
+## History
-If you have questions then please ask them on the [rclone forum](https://forum.rclone.org/).
+In v1.74 the GUI was redone and embedded within rclone for ease of
+use. The GUI bundle ships as a compressed zip embedded in the rclone
+binary and is served from the zip at runtime.
# Remote controlling rclone with its API
@@ -22033,8 +22268,6 @@ Note that arguments must be preceded by the "-a" flag
See the [backend](https://rclone.org/commands/rclone_backend/) command for more information.
-**Authentication is required for this call.**
-
### cache/expire: Purge a remote from cache {#cache-expire}
Purge a remote from the cache backend. Supports either a directory or a file.
@@ -22078,6 +22311,8 @@ is used on top of the cache.
Show statistics for the cache remote.
+**Authentication is not required for this call.**
+
### config/create: create the config for a remote. {#config-create}
This takes the following parameters:
@@ -22098,8 +22333,6 @@ This takes the following parameters:
See the [config create](https://rclone.org/commands/rclone_config_create/) command for more information on the above.
-**Authentication is required for this call.**
-
### config/delete: Delete a remote in the config file. {#config-delete}
Parameters:
@@ -22108,8 +22341,6 @@ Parameters:
See the [config delete](https://rclone.org/commands/rclone_config_delete/) command for more information on the above.
-**Authentication is required for this call.**
-
### config/dump: Dumps the config file. {#config-dump}
Returns a JSON object:
@@ -22119,8 +22350,6 @@ Where keys are remote names and values are the config parameters.
See the [config dump](https://rclone.org/commands/rclone_config_dump/) command for more information on the above.
-**Authentication is required for this call.**
-
### config/get: Get a remote in the config file. {#config-get}
Parameters:
@@ -22129,8 +22358,6 @@ Parameters:
See the [config dump](https://rclone.org/commands/rclone_config_dump/) command for more information on the above.
-**Authentication is required for this call.**
-
### config/listremotes: Lists the remotes in the config file and defined in environment variables. {#config-listremotes}
Returns
@@ -22138,8 +22365,6 @@ Returns
See the [listremotes](https://rclone.org/commands/rclone_listremotes/) command for more information on the above.
-**Authentication is required for this call.**
-
### config/password: password the config for a remote. {#config-password}
This takes the following parameters:
@@ -22150,8 +22375,6 @@ This takes the following parameters:
See the [config password](https://rclone.org/commands/rclone_config_password/) command for more information on the above.
-**Authentication is required for this call.**
-
### config/paths: Reads the config file path and other important paths. {#config-paths}
Returns a JSON object with the following keys:
@@ -22170,8 +22393,6 @@ Eg
See the [config paths](https://rclone.org/commands/rclone_config_paths/) command for more information on the above.
-**Authentication is required for this call.**
-
### config/providers: Shows how providers are configured in the config file. {#config-providers}
Returns a JSON object:
@@ -22184,16 +22405,12 @@ Note that the Options blocks are in the same format as returned by
"options/info". They are described in the
[option blocks](#option-blocks) section.
-**Authentication is required for this call.**
-
### config/setpath: Set the path of the config file {#config-setpath}
Parameters:
- path - path to the config file to use
-**Authentication is required for this call.**
-
### config/unlock: Unlock the config file. {#config-unlock}
Unlocks the config file if it is locked.
@@ -22204,8 +22421,6 @@ Parameters:
A good idea is to disable AskPassword before making this call
-**Authentication is required for this call.**
-
### config/update: update the config for a remote. {#config-update}
This takes the following parameters:
@@ -22225,8 +22440,6 @@ This takes the following parameters:
See the [config update](https://rclone.org/commands/rclone_config_update/) command for more information on the above.
-**Authentication is required for this call.**
-
### core/bwlimit: Set the bandwidth limit. {#core-bwlimit}
This sets the bandwidth limit to the string passed in. This should be
@@ -22313,7 +22526,20 @@ OR
```
-**Authentication is required for this call.**
+### core/disks: List the local disks {#core-disks}
+
+This does not take any parameters
+
+This call is for rclone GUI programs to enumerate local disks and
+important directories for doing transfers to and from. The list
+returned will include the root directory and the user's home directory
+and any mounted disks. The returned items should be usable directly as
+remotes.
+
+Returns:
+
+- disks
+ - This is an array of strings of local disk names
### core/du: Returns disk usage of a locally attached disk. {#core-du}
@@ -22337,6 +22563,8 @@ Returns:
}
```
+**Authentication is not required for this call.**
+
### core/gc: Runs a garbage collection. {#core-gc}
This tells the go runtime to do a garbage collection run. It isn't
@@ -22359,6 +22587,8 @@ Returns the following values:
}
```
+**Authentication is not required for this call.**
+
### core/memstats: Returns the memory statistics {#core-memstats}
This returns the memory statistics of the running program. What the values mean
@@ -22409,6 +22639,7 @@ Returns the following values:
{
"bytes": total transferred bytes since the start of the group,
"checks": number of files checked,
+ "deletedDirs": number of directories deleted,
"deletes" : number of files deleted,
"elapsedTime": time in floating point seconds since rclone was started,
"errors": number of errors,
@@ -22447,6 +22678,8 @@ Returns the following values:
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.
+**Authentication is not required for this call.**
+
### core/stats-delete: Delete stats group. {#core-stats-delete}
This deletes entire stats group.
@@ -22498,6 +22731,8 @@ Returns the following values:
}
```
+**Authentication is not required for this call.**
+
### core/version: Shows the current version of rclone, Go and the OS. {#core-version}
This shows the current versions of rclone, Go and the OS:
@@ -22515,6 +22750,8 @@ This shows the current versions of rclone, Go and the OS:
- linking - type of rclone executable (static or dynamic)
- goTags - space separated build tags or "none"
+**Authentication is not required for this call.**
+
### debug/set-block-profile-rate: Set runtime.SetBlockProfileRate for blocking profiling. {#debug-set-block-profile-rate}
SetBlockProfileRate controls the fraction of goroutine blocking events
@@ -22610,8 +22847,6 @@ 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.
-**Authentication is required for this call.**
-
### fscache/entries: Returns the number of entries in the fs cache. {#fscache-entries}
This returns the number of entries in the fs cache.
@@ -22619,8 +22854,6 @@ This returns the number of entries in the fs cache.
Returns
- entries - number of items in the cache
-**Authentication is required for this call.**
-
### job/batch: Run a batch of rclone rc commands concurrently. {#job-batch}
This takes the following parameters:
@@ -22680,8 +22913,6 @@ Gives the result:
}
```
-**Authentication is required for this call.**
-
### job/list: Lists the IDs of the running jobs {#job-list}
Parameters: None.
@@ -22693,6 +22924,8 @@ Results:
- runningIds - array of integer job ids that are running
- finishedIds - array of integer job ids that are finished
+**Authentication is not required for this call.**
+
### job/status: Reads the status of the job ID {#job-status}
Parameters:
@@ -22713,6 +22946,8 @@ Results:
- output - output of the job as would have been returned if called synchronously
- progress - output of the progress related to the underlying job
+**Authentication is not required for this call.**
+
### job/stop: Stop the running job {#job-stop}
Parameters:
@@ -22737,8 +22972,6 @@ Eg
rclone rc mount/listmounts
-**Authentication is required for this call.**
-
### mount/mount: Create a new mount point {#mount-mount}
rclone allows Linux, FreeBSD, macOS and Windows to mount any of
@@ -22754,12 +22987,24 @@ This takes the following parameters:
- mountOpt: a JSON object with Mount options in.
- vfsOpt: a JSON object with VFS options in.
+On Windows mountPoint may be set to "*" to assign the next available
+drive letter automatically, or a network share UNC path (e.g.
+"\\server\share") to mount as a network drive. In these cases the
+actual drive letter is chosen at mount time.
+
+This returns the following values:
+
+- mountPoint: the actual mount point that was used (this may differ
+ from the input, e.g. on Windows when "*" is passed the allocated
+ drive letter is returned)
+
Example:
```console
rclone rc mount/mount fs=mydrive: mountPoint=/home/<user>/mountPoint
rclone rc mount/mount fs=mydrive: mountPoint=/home/<user>/mountPoint mountType=mount
rclone rc mount/mount fs=TestDrive: mountPoint=/mnt/tmp vfsOpt='{"CacheMode": 2}' mountOpt='{"AllowOther": true}'
+rclone rc mount/mount fs=mydrive: mountPoint=* mountType=cmount
```
The vfsOpt are as described in options/get and can be seen in the
@@ -22769,8 +23014,6 @@ The vfsOpt are as described in options/get and can be seen in the
rclone rc options/get
```
-**Authentication is required for this call.**
-
### mount/types: Show all possible mount types {#mount-types}
This shows all possible mount types and returns them as a list.
@@ -22786,8 +23029,6 @@ Eg
rclone rc mount/types
-**Authentication is required for this call.**
-
### mount/unmount: Unmount selected active mount {#mount-unmount}
rclone allows Linux, FreeBSD, macOS and Windows to
@@ -22802,8 +23043,6 @@ Example:
rclone rc mount/unmount mountPoint=/home/<user>/mountPoint
-**Authentication is required for this call.**
-
### mount/unmountall: Unmount all active mounts {#mount-unmountall}
rclone allows Linux, FreeBSD, macOS and Windows to
@@ -22816,8 +23055,6 @@ Eg
rclone rc mount/unmountall
-**Authentication is required for this call.**
-
### operations/about: Return the space used on the remote {#operations-about}
This takes the following parameters:
@@ -22828,8 +23065,6 @@ The result is as returned from rclone about --json
See the [about](https://rclone.org/commands/rclone_about/) command for more information on the above.
-**Authentication is required for this call.**
-
### operations/check: check the source and destination are the same {#operations-check}
Checks the files in the source and destination match. It compares
@@ -22878,8 +23113,6 @@ Returns:
- differ - array of strings of all non-matching files
- error - array of strings of all files with errors (hashing or reading)
-**Authentication is required for this call.**
-
### operations/cleanup: Remove trashed files in the remote or path {#operations-cleanup}
This takes the following parameters:
@@ -22888,8 +23121,6 @@ This takes the following parameters:
See the [cleanup](https://rclone.org/commands/rclone_cleanup/) command for more information on the above.
-**Authentication is required for this call.**
-
### operations/copyfile: Copy a file from source remote to destination remote {#operations-copyfile}
This takes the following parameters:
@@ -22899,8 +23130,6 @@ This takes the following parameters:
- dstFs - a remote name string e.g. "drive2:" for the destination, "/" for local filesystem
- dstRemote - a path within that remote e.g. "file2.txt" for the destination
-**Authentication is required for this call.**
-
### operations/copyurl: Copy the URL to the object {#operations-copyurl}
This takes the following parameters:
@@ -22912,8 +23141,6 @@ This takes the following parameters:
See the [copyurl](https://rclone.org/commands/rclone_copyurl/) command for more information on the above.
-**Authentication is required for this call.**
-
### operations/delete: Remove files in the path {#operations-delete}
This takes the following parameters:
@@ -22922,8 +23149,6 @@ This takes the following parameters:
See the [delete](https://rclone.org/commands/rclone_delete/) command for more information on the above.
-**Authentication is required for this call.**
-
### operations/deletefile: Remove the single file pointed to {#operations-deletefile}
This takes the following parameters:
@@ -22933,8 +23158,6 @@ This takes the following parameters:
See the [deletefile](https://rclone.org/commands/rclone_deletefile/) command for more information on the above.
-**Authentication is required for this call.**
-
### operations/fsinfo: Return information about the remote {#operations-fsinfo}
This takes the following parameters:
@@ -23091,8 +23314,6 @@ Example:
See the [hashsum](https://rclone.org/commands/rclone_hashsum/) command for more information on the above.
-**Authentication is required for this call.**
-
### operations/hashsumfile: Produces a hash for a single file. {#operations-hashsumfile}
Produces a hash for a single file using the hash named.
@@ -23125,8 +23346,6 @@ Example:
See the [hashsum](https://rclone.org/commands/rclone_hashsum/) command for more information on the above.
-**Authentication is required for this call.**
-
### operations/list: List the given remote and path in JSON format {#operations-list}
This takes the following parameters:
@@ -23152,8 +23371,6 @@ Returns:
See the [lsjson](https://rclone.org/commands/rclone_lsjson/) command for more information on the above and examples.
-**Authentication is required for this call.**
-
### operations/mkdir: Make a destination directory or container {#operations-mkdir}
This takes the following parameters:
@@ -23163,8 +23380,6 @@ This takes the following parameters:
See the [mkdir](https://rclone.org/commands/rclone_mkdir/) command for more information on the above.
-**Authentication is required for this call.**
-
### operations/movefile: Move a file from source remote to destination remote {#operations-movefile}
This takes the following parameters:
@@ -23174,8 +23389,6 @@ This takes the following parameters:
- dstFs - a remote name string e.g. "drive2:" for the destination, "/" for local filesystem
- dstRemote - a path within that remote e.g. "file2.txt" for the destination
-**Authentication is required for this call.**
-
### operations/publiclink: Create or retrieve a public link to the given file or folder. {#operations-publiclink}
This takes the following parameters:
@@ -23191,8 +23404,6 @@ Returns:
See the [link](https://rclone.org/commands/rclone_link/) command for more information on the above.
-**Authentication is required for this call.**
-
### operations/purge: Remove a directory or container and all of its contents {#operations-purge}
This takes the following parameters:
@@ -23202,8 +23413,6 @@ This takes the following parameters:
See the [purge](https://rclone.org/commands/rclone_purge/) command for more information on the above.
-**Authentication is required for this call.**
-
### operations/rmdir: Remove an empty directory or container {#operations-rmdir}
This takes the following parameters:
@@ -23213,8 +23422,6 @@ This takes the following parameters:
See the [rmdir](https://rclone.org/commands/rclone_rmdir/) command for more information on the above.
-**Authentication is required for this call.**
-
### operations/rmdirs: Remove all the empty directories in the path {#operations-rmdirs}
This takes the following parameters:
@@ -23225,8 +23432,6 @@ This takes the following parameters:
See the [rmdirs](https://rclone.org/commands/rclone_rmdirs/) command for more information on the above.
-**Authentication is required for this call.**
-
### operations/settier: Changes storage tier or class on all files in the path {#operations-settier}
This takes the following parameters:
@@ -23235,8 +23440,6 @@ This takes the following parameters:
See the [settier](https://rclone.org/commands/rclone_settier/) command for more information on the above.
-**Authentication is required for this call.**
-
### operations/settierfile: Changes storage tier or class on the single file pointed to {#operations-settierfile}
This takes the following parameters:
@@ -23244,8 +23447,6 @@ This takes the following parameters:
- fs - a remote name string e.g. "drive:"
- remote - a path within that remote e.g. "dir"
-**Authentication is required for this call.**
-
### operations/size: Count the number of bytes and files in remote {#operations-size}
This takes the following parameters:
@@ -23259,8 +23460,6 @@ Returns:
See the [size](https://rclone.org/commands/rclone_size/) command for more information on the above.
-**Authentication is required for this call.**
-
### operations/stat: Give information about the supplied file or directory {#operations-stat}
This takes the following parameters
@@ -23279,8 +23478,6 @@ efficient to set the filesOnly flag in the options.
See the [lsjson](https://rclone.org/commands/rclone_lsjson/) command for more information on the above and examples.
-**Authentication is required for this call.**
-
### operations/uploadfile: Upload file using multiform/form-data {#operations-uploadfile}
This takes the following parameters:
@@ -23289,8 +23486,6 @@ This takes the following parameters:
- remote - a path within that remote e.g. "dir"
- each part in body represents a file to be uploaded
-**Authentication is required for this call.**
-
### options/blocks: List all the option blocks {#options-blocks}
Returns:
@@ -23382,8 +23577,6 @@ Example:
rclone rc pluginsctl/addPlugin
-**Authentication is required for this call.**
-
### pluginsctl/getPluginsForType: Get plugins with type criteria {#pluginsctl-getPluginsForType}
This shows all possible plugins by a mime type.
@@ -23402,8 +23595,6 @@ Example:
rclone rc pluginsctl/getPluginsForType type=video/mp4
-**Authentication is required for this call.**
-
### pluginsctl/listPlugins: Get the list of currently loaded plugins {#pluginsctl-listPlugins}
This allows you to get the currently enabled plugins and their details.
@@ -23417,8 +23608,6 @@ E.g.
rclone rc pluginsctl/listPlugins
-**Authentication is required for this call.**
-
### pluginsctl/listTestPlugins: Show currently loaded test plugins {#pluginsctl-listTestPlugins}
Allows listing of test plugins with the rclone.test set to true in package.json of the plugin.
@@ -23431,8 +23620,6 @@ E.g.
rclone rc pluginsctl/listTestPlugins
-**Authentication is required for this call.**
-
### pluginsctl/removePlugin: Remove a loaded plugin {#pluginsctl-removePlugin}
This allows you to remove a plugin using it's name.
@@ -23445,8 +23632,6 @@ E.g.
rclone rc pluginsctl/removePlugin name=rclone/video-plugin
-**Authentication is required for this call.**
-
### pluginsctl/removeTestPlugin: Remove a test plugin {#pluginsctl-removeTestPlugin}
This allows you to remove a plugin using it's name.
@@ -23459,13 +23644,13 @@ Example:
rclone rc pluginsctl/removeTestPlugin name=rclone/rclone-webui-react
-**Authentication is required for this call.**
-
### rc/error: This returns an error {#rc-error}
This returns an error with the input as part of its error string.
Useful for testing error handling.
+**Authentication is not required for this call.**
+
### rc/fatal: This returns an fatal error {#rc-fatal}
This returns an error with the input as part of its error string.
@@ -23476,20 +23661,22 @@ Useful for testing error handling.
This lists all the registered remote control commands as a JSON map in
the commands response.
+**Authentication is not required for this call.**
+
### rc/noop: Echo the input to the output parameters {#rc-noop}
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.
+**Authentication is not required for this call.**
+
### rc/noopauth: Echo the input to the output parameters requiring auth {#rc-noopauth}
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.
-**Authentication is required for this call.**
-
### rc/panic: This returns an error by panicking {#rc-panic}
This returns an error with the input as part of its error string.
@@ -23536,8 +23723,6 @@ Returns
}
```
-**Authentication is required for this call.**
-
### serve/start: Create a new server {#serve-start}
Create a new server with the specified parameters.
@@ -23573,8 +23758,6 @@ Or an error if it failed to start.
Stop the server with `serve/stop` and list the running servers with `serve/list`.
-**Authentication is required for this call.**
-
### serve/stop: Unserve selected active serve {#serve-stop}
Stops a running `serve` instance by ID.
@@ -23589,8 +23772,6 @@ Example:
rclone rc serve/stop id=12345
-**Authentication is required for this call.**
-
### serve/stopall: Stop all active servers {#serve-stopall}
Stop all active servers.
@@ -23599,8 +23780,6 @@ This will stop all active servers.
rclone rc serve/stopall
-**Authentication is required for this call.**
-
### serve/types: Show all possible serve types {#serve-types}
This shows all possible serve types and returns them as a list.
@@ -23628,40 +23807,70 @@ Returns
}
```
-**Authentication is required for this call.**
-
### sync/bisync: Perform bidirectional synchronization between two paths. {#sync-bisync}
-This takes the following parameters
+<!--- Docs generated by help.go - use go generate to rebuild - DO NOT EDIT --->
+
+This takes the following parameters:
-- path1 - a remote directory string e.g. `drive:path1`
-- path2 - a remote directory string e.g. `drive:path2`
-- dryRun - dry-run mode
-- resync - performs the resync run
-- checkAccess - abort if RCLONE_TEST files are not found on both filesystems
-- checkFilename - file name for checkAccess (default: RCLONE_TEST)
-- maxDelete - abort sync if percentage of deleted files is above
- this threshold (default: 50)
-- force - Bypass maxDelete safety check and run the sync
-- checkSync - `true` by default, `false` disables comparison of final listings,
- `only` will skip sync, only compare listings from the last run
-- createEmptySrcDirs - Sync creation and deletion of empty directories.
- (Not compatible with --remove-empty-dirs)
-- removeEmptyDirs - remove empty directories at the final cleanup step
-- filtersFile - read filtering patterns from a file
-- ignoreListingChecksum - Do not use checksums for listings
-- resilient - Allow future runs to retry after certain less-serious errors, instead of requiring resync.
-- workdir - server directory for history files (default: `~/.cache/rclone/bisync`)
-- backupdir1 - --backup-dir for Path1. Must be a non-overlapping path on the same remote.
-- backupdir2 - --backup-dir for Path2. Must be a non-overlapping path on the same remote.
-- noCleanup - retain working files
+- path1 (required) - (string) a remote directory string e.g. `drive:path1`
+- path2 (required) - (string) a remote directory string e.g. `drive:path2`
+- dryRun - (bool) dry-run mode
+- backupDir1 - (string) --backup-dir for Path1. Must be a non-overlapping path on
+the same remote.
+- backupDir2 - (string) --backup-dir for Path2. Must be a non-overlapping path on
+the same remote.
+- checkAccess - (bool) Ensure expected RCLONE_TEST files are found on both
+Path1 and Path2 filesystems, else abort.
+- checkFilename - (string) Filename for --check-access (default: RCLONE_TEST)
+- checkSync - (string) Controls comparison of final listings: true|false|only
+(default: true)
+- compare - (string) Comma-separated list of bisync-specific compare options ex.
+'size,modtime,checksum' (default: 'size,modtime')
+- conflictLoser - (ConflictLoserAction) Action to take on the loser of a sync
+conflict (when there is a winner) or on both files (when there is no
+winner): , num, pathname, delete (default: num)
+- conflictResolve - (string) Automatically resolve conflicts by preferring the
+version that is: none, path1, path2, newer, older, larger, smaller (default:
+none)
+- conflictSuffix - (string) Suffix to use when renaming a --conflict-loser. Can
+be either one string or two comma-separated strings to assign different
+suffixes to Path1/Path2. (default: 'conflict')
+- createEmptySrcDirs - (bool) Sync creation and deletion of empty directories.
+(Not compatible with --remove-empty-dirs)
+- downloadHash - (bool) Compute hash by downloading when otherwise
+unavailable. (warning: may be slow and use lots of data!)
+- filtersFile - (string) Read filtering patterns from a file
+- force - (bool) Bypass --max-delete safety check and run the sync. Consider
+using with --verbose
+- ignoreListingChecksum - (bool) Do not use checksums for listings (add --ignore-
+checksum to additionally skip post-copy checksum checks)
+- maxLock - (Duration) Consider lock files older than this to be expired
+(default: 0 (never expire)) (minimum: 2m)
+- noCleanup - (bool) Retain working files (useful for troubleshooting and
+testing).
+- noSlowHash - (bool) Ignore listing checksums only on backends where they are
+slow
+- recover - (bool) Automatically recover from interruptions without requiring --
+resync.
+- removeEmptyDirs - (bool) Remove ALL empty directories at the final cleanup
+step.
+- resilient - (bool) Allow future runs to retry after certain less-serious
+errors, instead of requiring --resync.
+- resync - (bool) Performs the resync run. Equivalent to --resync-mode path1.
+Consider using --verbose or --dry-run first.
+- resyncMode - (string) During resync, prefer the version that is: path1,
+path2, newer, older, larger, smaller (default: path1 if --resync, otherwise
+none for no resync.)
+- slowHashSyncOnly - (bool) Ignore slow checksums for listings and deltas, but
+still consider them during sync calls.
+- workdir - (string) Use custom working dir - useful for testing. (default:
+/home/ncw/.cache/rclone/bisync)
See [bisync command help](https://rclone.org/commands/rclone_bisync/)
and [full bisync description](https://rclone.org/bisync/)
for more information.
-**Authentication is required for this call.**
-
### sync/copy: copy a directory from source remote to destination remote {#sync-copy}
This takes the following parameters:
@@ -23673,8 +23882,6 @@ This takes the following parameters:
See the [copy](https://rclone.org/commands/rclone_copy/) command for more information on the above.
-**Authentication is required for this call.**
-
### sync/move: move a directory from source remote to destination remote {#sync-move}
This takes the following parameters:
@@ -23687,8 +23894,6 @@ This takes the following parameters:
See the [move](https://rclone.org/commands/rclone_move/) command for more information on the above.
-**Authentication is required for this call.**
-
### sync/sync: sync a directory from source remote to destination remote {#sync-sync}
This takes the following parameters:
@@ -23700,8 +23905,6 @@ This takes the following parameters:
See the [sync](https://rclone.org/commands/rclone_sync/) command for more information on the above.
-**Authentication is required for this call.**
-
### vfs/forget: Forget files or directories in the directory cache. {#vfs-forget}
This forgets the paths in the directory cache causing them to be
@@ -23731,6 +23934,8 @@ 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.
+**Authentication is not required for this call.**
+
### vfs/poll-interval: Get the status or update the value of the poll-interval option. {#vfs-poll-interval}
Without any parameter given this returns the current status of the
@@ -23793,6 +23998,8 @@ 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.
+**Authentication is not required for this call.**
+
### vfs/queue-set-expiry: Set the expiry time for an item queued for upload. {#vfs-queue-set-expiry}
Use this to adjust the `expiry` time for an item in the upload queue.
@@ -23886,6 +24093,8 @@ 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.
+**Authentication is not required for this call.**
+
<!-- autogenerated stop -->
## Accessing the remote control via HTTP {#api-http}
@@ -24442,7 +24651,7 @@ parameter in the config file.
##### Encoding example: Windows
-As a nother example, take a Windows system where there is a file with
+As another example, take a Windows system where there is a file with
name `Test:1.jpg`, where `:` is the Unicode fullwidth colon symbol.
When using rclone to copy this to a remote which supports `:`,
the regular (halfwidth) colon (such as Google Drive), you will notice
@@ -24776,7 +24985,7 @@ Flags for general networking and HTTP stuff.
--tpslimit float Limit HTTP transactions per second to this
--tpslimit-burst int Max burst of transactions for --tpslimit (default 1)
--use-cookies Enable session cookiejar
- --user-agent string Set the user-agent to a specified string (default "rclone/v1.73.0")
+ --user-agent string Set the user-agent to a specified string (default "rclone/v1.74.0")
```
@@ -24829,7 +25038,7 @@ Flags for developers.
```
--cpuprofile string Write cpu profile to file
- --dump DumpFlags List of items to dump from: headers, bodies, requests, responses, auth, filters, goroutines, openfiles, mapper
+ --dump DumpFlags List of items to dump from: headers, bodies, requests, responses, auth, filters, goroutines, openfiles, mapper, curl
--dump-bodies Dump HTTP headers and bodies - may contain sensitive info
--dump-headers Dump HTTP headers - may contain sensitive info
--memprofile string Write memory profile to file
@@ -25010,6 +25219,8 @@ Backend-only flags (these can be set in the config file also).
--azureblob-connection-string string Storage Connection String
--azureblob-copy-concurrency int Concurrency for multipart copy (default 512)
--azureblob-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 8Mi)
+ --azureblob-copy-total-concurrency int Global concurrency limit for multipart copy chunks
+ --azureblob-decompress If set this will decompress gzip encoded objects
--azureblob-delete-snapshots string Set to specify how to deal with snapshots on blob deletion
--azureblob-description string Description of the remote
--azureblob-directory-markers Upload an empty object with a trailing slash when a new directory is created
@@ -25260,9 +25471,11 @@ Backend-only flags (these can be set in the config file also).
--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
+ --filelu-chunk-size SizeSuffix Chunk size to use for uploading. Used for multipart uploads (default 64Mi)
--filelu-description string Description of the remote
--filelu-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,Colon,Question,Asterisk,Pipe,Hash,Percent,BackSlash,CrLf,Del,Ctl,LeftSpace,LeftPeriod,LeftTilde,LeftCrLfHtVt,RightSpace,RightPeriod,RightCrLfHtVt,InvalidUtf8,Dot,SquareBracket,Semicolon,Exclamation)
--filelu-key string Your FileLu Rclone key from My Account
+ --filelu-upload-cutoff SizeSuffix Cutoff for switching to chunked upload. Any files larger than this will be uploaded in chunks of chunk_size (default 500Mi)
--filen-api-key string API Key for your Filen account (obscured)
--filen-auth-version string Authentication Version (internal use only)
--filen-base-folder-uuid string UUID of Account Root Directory (internal use only)
@@ -25383,11 +25596,24 @@ Backend-only flags (these can be set in the config file also).
--http-no-head Don't use HEAD requests
--http-no-slash Set this if the site doesn't end directories with /
--http-url string URL of HTTP host to connect to
+ --huaweidrive-auth-url string Auth server URL
+ --huaweidrive-chunk-size SizeSuffix Upload chunk size (default 8Mi)
+ --huaweidrive-client-credentials Use client credentials OAuth flow
+ --huaweidrive-client-id string OAuth Client Id
+ --huaweidrive-client-secret string OAuth Client Secret
+ --huaweidrive-description string Description of the remote
+ --huaweidrive-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftSpace,LeftPeriod,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot)
+ --huaweidrive-list-chunk int Size of listing chunk 1-1000 (default 1000)
+ --huaweidrive-root-folder-id string ID of the root folder
+ --huaweidrive-token string OAuth Access Token as a JSON blob
+ --huaweidrive-token-url string Token server url
+ --huaweidrive-upload-cutoff SizeSuffix Cutoff for switching to resumable upload (default 20Mi)
--iclouddrive-apple-id string Apple ID
- --iclouddrive-client-id string Client id (default "d39ba9916b7251055b22c7f910e2ea796ee65e98b2ddecea8f5dde8d9d1a815d")
+ --iclouddrive-client-id string Client ID for iCloud API access (default "d39ba9916b7251055b22c7f910e2ea796ee65e98b2ddecea8f5dde8d9d1a815d")
--iclouddrive-description string Description of the remote
--iclouddrive-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
--iclouddrive-password string Password (obscured)
+ --iclouddrive-service string iCloud service to use (default "drive")
--imagekit-description string Description of the remote
--imagekit-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Dollar,Question,Hash,Percent,BackSlash,Del,Ctl,InvalidUtf8,Dot,SquareBracket)
--imagekit-endpoint string You can find your ImageKit.io URL endpoint in your [dashboard](https://imagekit.io/dashboard/developer/api-keys)
@@ -25406,17 +25632,20 @@ Backend-only flags (these can be set in the config file also).
--internetarchive-item-metadata stringArray Metadata to be set on the IA item, this is different from file-level metadata that can be set using --metadata-set
--internetarchive-secret-access-key string IAS3 Secret Key (password)
--internetarchive-wait-archive Duration Timeout for waiting the server's processing tasks (specifically archive and book_op) to finish (default 0s)
+ --internxt-chunk-size SizeSuffix Chunk size for multipart uploads (default 30Mi)
--internxt-description string Description of the remote
--internxt-email string Email of your Internxt account
--internxt-encoding Encoding The encoding for the backend (default Slash,BackSlash,CrLf,RightPeriod,InvalidUtf8,Dot)
--internxt-pass string Password (obscured)
--internxt-skip-hash-validation Skip hash validation when downloading files (default true)
+ --internxt-upload-concurrency int Concurrency for multipart uploads (default 4)
+ --internxt-upload-cutoff SizeSuffix Cutoff for switching to multipart upload (default 100Mi)
--jottacloud-auth-url string Auth server URL
--jottacloud-client-credentials Use client credentials OAuth flow
--jottacloud-client-id string OAuth Client Id
--jottacloud-client-secret string OAuth Client Secret
--jottacloud-description string Description of the remote
- --jottacloud-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot)
+ --jottacloud-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Percent,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
@@ -25433,6 +25662,8 @@ Backend-only flags (these can be set in the config file also).
--koofr-setmtime Does the backend support setting modification time (default true)
--koofr-user string Your user name
--linkbox-description string Description of the remote
+ --linkbox-email string Email for login
+ --linkbox-password string Password for login (obscured)
--linkbox-token string Token from https://www.linkbox.to/admin/account
--local-case-insensitive Force the filesystem to report itself as case insensitive
--local-case-sensitive Force the filesystem to report itself as case sensitive
@@ -25578,7 +25809,7 @@ Backend-only flags (these can be set in the config file also).
--premiumizeme-token string OAuth Access Token as a JSON blob
--premiumizeme-token-url string Token server url
--protondrive-2fa string The 2FA code
- --protondrive-app-version string The app version string (default "[email protected]+rclone")
+ --protondrive-app-version string The app version string
--protondrive-description string Description of the remote
--protondrive-enable-caching Caches the files and folders metadata to reduce API calls (default true)
--protondrive-encoding Encoding The encoding for the backend (default Slash,LeftSpace,RightSpace,InvalidUtf8,Dot)
@@ -25619,6 +25850,8 @@ Backend-only flags (these can be set in the config file also).
--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-bucket-object-lock-enabled Enable Object Lock when creating new buckets
+ --s3-bypass-governance-retention Allow deleting or modifying objects locked with GOVERNANCE mode
--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
@@ -25633,11 +25866,13 @@ Backend-only flags (these can be set in the config file also).
--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-ibm-api-key string IBM API Key to be used to obtain IAM token
+ --s3-ibm-iam-endpoint string IBM IAM Endpoint to use for authentication
--s3-ibm-resource-instance-id string IBM service instance id
--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-list-versions-oldest-first Tristate Set if the backend returns object versions oldest first (default unset)
--s3-location-constraint string Location constraint - must be set to match the Region
--s3-max-upload-parts int Maximum number of parts in a multipart upload (default 10000)
--s3-might-gzip Tristate Set this if the backend might gzip objects (default unset)
@@ -25645,6 +25880,11 @@ Backend-only flags (these can be set in the config file also).
--s3-no-head If set, don'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-object-lock-legal-hold-status string Object Lock legal hold status to apply when uploading or copying objects
+ --s3-object-lock-mode string Object Lock mode to apply when uploading or copying objects
+ --s3-object-lock-retain-until-date string Object Lock retention until date to apply when uploading or copying objects
+ --s3-object-lock-set-after-upload Set Object Lock via separate API calls after upload
+ --s3-object-lock-supported Tristate Whether the provider supports S3 Object Lock (default unset)
--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
@@ -27299,6 +27539,12 @@ running -- and you can therefore be reasonably sure that any *expired* lock
file you may find was left there by an interrupted run, not one that is still
running and just taking awhile.
+If a lock file exists but its contents are unreadable (for example, due to an
+incomplete write or disk error), it is treated as expired when `--max-lock` is
+set to a value greater than `0`. If `--max-lock` is `0` or not set, an
+unreadable lock file will produce an error and block future runs until removed
+manually.
+
If `--max-lock` is `0` or not set, the default is that lock files will never
expire, and will block future runs (of these same two bisync paths)
indefinitely.
@@ -27528,11 +27774,7 @@ The following backends have known issues that need more investigation:
<!--- start list_failures - DO NOT EDIT THIS SECTION - use make commanddocs --->
- `TestDropbox` (`dropbox`)
- [`TestBisyncRemoteRemote/normalization`](https://pub.rclone.org/integration-tests/current/dropbox-cmd.bisync-TestDropbox-1.txt)
-- `TestSeafile` (`seafile`)
- - [`TestBisyncLocalRemote/volatile`](https://pub.rclone.org/integration-tests/current/seafile-cmd.bisync-TestSeafile-1.txt)
-- `TestSeafileV6` (`seafile`)
- - [`TestBisyncLocalRemote/volatile`](https://pub.rclone.org/integration-tests/current/seafile-cmd.bisync-TestSeafileV6-1.txt)
-- Updated: 2026-01-30-010015
+- Updated: 2026-05-01-010013
<!--- end list_failures - DO NOT EDIT THIS SECTION - use make commanddocs --->
The following backends either have not been tested recently or have known issues
@@ -28376,6 +28618,12 @@ about *Unison* and synchronization in general.
## Changelog
+### `v1.74`
+
+- Added several missing `rc` parameters.
+- Optional `rc` parameters are now truly optional.
+- `rc` output now provides more structured information.
+
### `v1.71`
- `bisync` is now officially released from beta.
@@ -28624,7 +28872,7 @@ gpg: aka "Nick Craig-Wood <[email protected]>" [unknown]
rclone-v1.63.1-windows-amd64.zip: OK
```
-# 1Fichier
+# 1Fichier
This is a backend for the [1fichier](https://1fichier.com) cloud
storage service. Note that a Premium subscription is required to use
@@ -28848,7 +29096,7 @@ remote.
See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features)
and [rclone about](https://rclone.org/commands/rclone_about/).
-# Alias
+# Alias
The `alias` remote provides a new name for another remote.
@@ -28983,7 +29231,7 @@ Properties:
<!-- autogenerated options stop -->
-# Amazon S3 Storage Providers
+# Amazon S3 Storage Providers
The S3 backend can be used with a number of different providers:
@@ -29002,12 +29250,15 @@ The S3 backend can be used with a number of different providers:
- DigitalOcean Spaces
- Dreamhost
- Exaba
+- Fastly Object Storage
- FileLu S5 (S3-Compatible Object Storage)
- GCS
- Hetzner
+- Hitachi Content Platform (HCP)
- Huawei OBS
- IBM COS S3
- IDrive e2
+- Impossible Cloud
- Intercolo Object Storage
- IONOS Cloud
- Leviia Object Storage
@@ -29030,11 +29281,12 @@ The S3 backend can be used with a number of different providers:
- Selectel
- Servercore Object Storage
- Spectra Logic
-- StackPath
- Storj
- Synology C2 Object Storage
- Tencent Cloud Object Storage (COS)
+- US3
- Wasabi
+- Zadara Object Storage
- Zata
@@ -29649,6 +29901,20 @@ work with the SDK properly:
| . | . |
| .. | .. |
+#### Important note about double slashes (`//`)
+
+Object keys containing consecutive forward slashes (`//`) are **not supported** by rclone.
+
+When rclone encounters an object key with `//` (e.g., `a//b`), it will normalize the path to use a single slash (e.g., `a/b`). This normalization can cause "object not found" errors when trying to access the original object, as rclone will look for the normalized path instead of the actual object key.
+
+**Example:**
+- Original S3 object key: `folder//file.txt`
+- rclone interprets it as: `folder/file.txt`
+- Result: "object not found" error when trying to access `folder//file.txt`
+
+**Workaround:**
+Avoid using consecutive forward slashes (`//`) in S3 object keys when using rclone. If you have existing objects with `//` in their keys, you will need to rename them to use single slashes or access them through other means.
+
### Multipart uploads
rclone supports multipart uploads with S3 which means that it can
@@ -29877,15 +30143,56 @@ According to AWS's [documentation on S3 Object Lock](https://docs.aws.amazon.com
> If you configure a default retention period on a bucket, requests to upload
objects in such a bucket must include the Content-MD5 header.
-As mentioned in the [Modification times and hashes](#modification-times-and-hashes)
-section, small files that are not uploaded as multipart, use a different tag, causing
-the upload to fail. A simple solution is to set the `--s3-upload-cutoff 0` and force
-all the files to be uploaded as multipart.
+Rclone automatically computes and includes the Content-MD5 header when
+uploading objects with Object Lock parameters set. No special
+configuration is needed.
+
+#### Setting Object Lock retention
+
+Rclone supports setting Object Lock retention on uploaded objects with
+the following options:
+
+- `--s3-object-lock-mode` - Set the Object Lock mode (GOVERNANCE or COMPLIANCE)
+- `--s3-object-lock-retain-until-date` - Set the retention date (RFC3339 format or duration like `365d`, `24h`)
+- `--s3-object-lock-legal-hold-status` - Set legal hold (ON or OFF)
+
+Example - upload files with 1 year GOVERNANCE retention:
+
+ rclone copy local:/data remote:bucket \
+ --s3-object-lock-mode GOVERNANCE \
+ --s3-object-lock-retain-until-date 365d
+
+#### Copying Object Lock settings from source
+
+When using `--metadata`, you can use the special value `copy` to preserve
+the source object's Object Lock settings:
+
+ rclone copy source:bucket dest:bucket \
+ --metadata \
+ --s3-object-lock-mode copy \
+ --s3-object-lock-retain-until-date copy
+
+You can also mix copied and explicit values. For example, to change the
+mode from COMPLIANCE to GOVERNANCE while preserving the original retention date:
+
+ rclone copy source:bucket dest:bucket \
+ --metadata \
+ --s3-object-lock-mode GOVERNANCE \
+ --s3-object-lock-retain-until-date copy
+
+#### Additional Object Lock options
+
+- `--s3-bypass-governance-retention` - Required to delete or overwrite objects
+ with GOVERNANCE mode retention before the retention date expires
+- `--s3-bucket-object-lock-enabled` - Enable Object Lock when creating a new
+ bucket with `rclone mkdir`
+- `--s3-object-lock-set-after-upload` - Set Object Lock via separate API calls
+ after upload (for providers that don't support Object Lock headers during PUT)
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/s3/s3.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options
-Here are the Standard options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, BizflyCloud, Ceph, ChinaMobile, Cloudflare, Cubbit, DigitalOcean, Dreamhost, Exaba, FileLu, FlashBlade, GCS, Hetzner, HuaweiOBS, IBMCOS, IDrive, Intercolo, IONOS, Leviia, Liara, Linode, LyveCloud, Magalu, Mega, Minio, Netease, Outscale, OVHcloud, Petabox, Qiniu, Rabata, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Servercore, SpectraLogic, StackPath, Storj, Synology, TencentCOS, Wasabi, Zata, Other).
+Here are the Standard options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, BizflyCloud, Ceph, ChinaMobile, Cloudflare, Cubbit, DigitalOcean, Dreamhost, Exaba, Fastly, FileLu, FlashBlade, GCS, HCP, Hetzner, HuaweiOBS, IBMCOS, IDrive, ImpossibleCloud, Intercolo, IONOS, Leviia, Liara, Linode, LyveCloud, Magalu, Mega, Minio, Netease, Outscale, OVHcloud, Petabox, Qiniu, Rabata, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Servercore, SpectraLogic, Storj, Synology, TencentCOS, US3, Wasabi, Zadara, Zata, Other).
#### --s3-provider
@@ -29920,12 +30227,16 @@ Properties:
- Dreamhost DreamObjects
- "Exaba"
- Exaba Object Storage
+ - "Fastly"
+ - Fastly Object Storage
- "FileLu"
- FileLu S5 (S3-Compatible Object Storage)
- "FlashBlade"
- Pure Storage FlashBlade Object Storage
- "GCS"
- Google Cloud Storage
+ - "HCP"
+ - Hitachi Content Platform (HCP)
- "Hetzner"
- Hetzner Object Storage
- "HuaweiOBS"
@@ -29934,6 +30245,8 @@ Properties:
- IBM COS S3
- "IDrive"
- IDrive e2
+ - "ImpossibleCloud"
+ - Impossible Cloud Object Storage
- "Intercolo"
- Intercolo Object Storage
- "IONOS"
@@ -29978,16 +30291,18 @@ Properties:
- Servercore Object Storage
- "SpectraLogic"
- Spectra Logic Black Pearl
- - "StackPath"
- - StackPath Object Storage
- "Storj"
- Storj (S3 Compatible Gateway)
- "Synology"
- Synology C2 Object Storage
- "TencentCOS"
- Tencent Cloud Object Storage (COS)
+ - "US3"
+ - US3 Object Storage
- "Wasabi"
- Wasabi Object Storage
+ - "Zadara"
+ - Zadara Object Storage
- "Zata"
- Zata (S3 compatible Gateway)
- "Other"
@@ -30047,7 +30362,7 @@ Properties:
- Config: region
- Env Var: RCLONE_S3_REGION
-- Provider: AWS,BizflyCloud,Ceph,Cloudflare,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,Hetzner,HuaweiOBS,IBMCOS,Intercolo,IONOS,Leviia,LyveCloud,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,Rabata,RackCorp,Scaleway,SeaweedFS,Selectel,Servercore,StackPath,Synology,Wasabi,Zata,Other
+- Provider: AWS,BizflyCloud,Ceph,Cloudflare,Cubbit,DigitalOcean,Dreamhost,Exaba,Fastly,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IBMCOS,ImpossibleCloud,Intercolo,IONOS,Leviia,LyveCloud,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,Rabata,RackCorp,Scaleway,SeaweedFS,Selectel,Servercore,Synology,Wasabi,Zadara,Zata,Other
- Type: string
- Required: false
- Examples:
@@ -30165,17 +30480,41 @@ Properties:
- ""
- Use this if unsure.
- Will use v4 signatures and an empty region.
- - Provider: Ceph,DigitalOcean,Dreamhost,Exaba,GCS,IBMCOS,Leviia,LyveCloud,Minio,Netease,SeaweedFS,StackPath,Wasabi,Other
+ - Provider: Ceph,DigitalOcean,Dreamhost,Exaba,GCS,HCP,IBMCOS,Leviia,LyveCloud,Minio,Netease,SeaweedFS,Wasabi,Other
- "other-v2-signature"
- Use this only if v4 signatures don't work.
- E.g. pre Jewel/v10 CEPH.
- - Provider: Ceph,DigitalOcean,Dreamhost,Exaba,GCS,IBMCOS,Leviia,LyveCloud,Minio,Netease,SeaweedFS,StackPath,Wasabi,Other
+ - Provider: Ceph,DigitalOcean,Dreamhost,Exaba,GCS,HCP,IBMCOS,Leviia,LyveCloud,Minio,Netease,SeaweedFS,Wasabi,Other
- "auto"
- R2 buckets are automatically distributed across Cloudflare's data centers for low latency.
- Provider: Cloudflare
- "eu-west-1"
- Europe West
- Provider: Cubbit
+ - "au-east-1"
+ - AU East 1
+ - Provider: Fastly
+ - "eu-central"
+ - EU Central
+ - Provider: Fastly
+ - "eu-south-1"
+ - EU South 1
+ - Provider: Fastly
+ - "jp-central-1"
+ - JP Central 1
+ - Provider: Fastly
+ - "uk-east-1"
+ - UK East 1
+ - Provider: Fastly
+ - "us-central-1"
+ - US Central 1
+ - Provider: Fastly
+ - "us-east"
+ - US East
+ - Provider: Fastly
+ - "us-west"
+ - US West
+ - Provider: Fastly
- "global"
- Global
- Provider: FileLu
@@ -30245,6 +30584,27 @@ Properties:
- "ru-northwest-2"
- RU-Moscow2
- Provider: HuaweiOBS
+ - "eu-central-2"
+ - Frankfurt, Germany
+ - Provider: ImpossibleCloud
+ - "eu-west-1"
+ - Amsterdam, Netherlands
+ - Provider: ImpossibleCloud
+ - "eu-west-2"
+ - London, UK
+ - Provider: ImpossibleCloud
+ - "eu-west-3"
+ - Paris, France
+ - Provider: ImpossibleCloud
+ - "eu-east-1"
+ - Poznań, Poland
+ - Provider: ImpossibleCloud
+ - "eu-north-1"
+ - Copenhagen, Denmark
+ - Provider: ImpossibleCloud
+ - "us-east-1"
+ - New York, USA
+ - Provider: ImpossibleCloud
- "de-fra"
- Frankfurt, Germany
- Provider: Intercolo
@@ -30254,9 +30614,18 @@ Properties:
- "eu-central-2"
- Berlin, Germany
- Provider: IONOS
+ - "eu-central-3"
+ - Berlin, Germany
+ - Provider: IONOS
+ - "eu-central-4"
+ - Frankfurt, Germany
+ - Provider: IONOS
- "eu-south-2"
- Logrono, Spain
- Provider: IONOS
+ - "us-central-1"
+ - Lenexa, USA
+ - Provider: IONOS
- "eu-west-2"
- Paris, France
- Provider: Outscale
@@ -30469,6 +30838,10 @@ Properties:
- "tw-001"
- Asia (Taiwan)
- Provider: Synology
+ - "us-east-1"
+ - The default region.
+ - Leave location constraint empty.
+ - Provider: Zadara
- "us-east-1"
- Indore, Madhya Pradesh, India
- Provider: Zata
@@ -30483,7 +30856,7 @@ Properties:
- Config: endpoint
- Env Var: RCLONE_S3_ENDPOINT
-- Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cloudflare,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,FlashBlade,GCS,Hetzner,HuaweiOBS,IBMCOS,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Mega,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,Rabata,RackCorp,Rclone,Scaleway,SeaweedFS,Selectel,Servercore,SpectraLogic,StackPath,Storj,Synology,TencentCOS,Wasabi,Zata,Other
+- Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cloudflare,Cubbit,DigitalOcean,Dreamhost,Exaba,Fastly,FileLu,FlashBlade,GCS,HCP,Hetzner,HuaweiOBS,IBMCOS,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Mega,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,Rabata,RackCorp,Rclone,Scaleway,SeaweedFS,Selectel,Servercore,SpectraLogic,Storj,Synology,TencentCOS,US3,Wasabi,Zadara,Zata,Other
- Type: string
- Required: false
- Examples:
@@ -30669,6 +31042,9 @@ Properties:
- "s3.cubbit.eu"
- Cubbit DS3 Object Storage endpoint
- Provider: Cubbit
+ - "s3.{tenant_name}.cubbit.eu"
+ - Multi-tenant endpoint - replace {tenant_name} with your actual tenant name. Do not select this directly
+ - Provider: Cubbit
- "syd1.digitaloceanspaces.com"
- DigitalOcean Spaces Sydney 1
- Provider: DigitalOcean
@@ -30702,6 +31078,30 @@ Properties:
- "objects-us-east-1.dream.io"
- Dream Objects endpoint
- Provider: Dreamhost
+ - "au-east-1.object.fastlystorage.app"
+ - AU East 1
+ - Provider: Fastly
+ - "eu-central.object.fastlystorage.app"
+ - EU Central
+ - Provider: Fastly
+ - "eu-south-1.object.fastlystorage.app"
+ - EU South 1
+ - Provider: Fastly
+ - "jp-central-1.object.fastlystorage.app"
+ - JP Central 1
+ - Provider: Fastly
+ - "uk-east-1.object.fastlystorage.app"
+ - UK East 1
+ - Provider: Fastly
+ - "us-central-1.object.fastlystorage.app"
+ - US Central 1
+ - Provider: Fastly
+ - "us-east.object.fastlystorage.app"
+ - US East
+ - Provider: Fastly
+ - "us-west.object.fastlystorage.app"
+ - US West
+ - Provider: Fastly
- "s5lu.com"
- Global FileLu S5 endpoint
- Provider: FileLu
@@ -30960,18 +31360,48 @@ Properties:
- "s3.private.sng01.cloud-object-storage.appdomain.cloud"
- Singapore Single Site Private Endpoint
- Provider: IBMCOS
+ - "eu-central-2.storage.impossibleapi.net"
+ - Frankfurt, Germany
+ - Provider: ImpossibleCloud
+ - "eu-west-1.storage.impossibleapi.net"
+ - Amsterdam, Netherlands
+ - Provider: ImpossibleCloud
+ - "eu-west-2.storage.impossibleapi.net"
+ - London, UK
+ - Provider: ImpossibleCloud
+ - "eu-west-3.storage.impossibleapi.net"
+ - Paris, France
+ - Provider: ImpossibleCloud
+ - "eu-east-1.storage.impossibleapi.net"
+ - Poznań, Poland
+ - Provider: ImpossibleCloud
+ - "eu-north-1.storage.impossibleapi.net"
+ - Copenhagen, Denmark
+ - Provider: ImpossibleCloud
+ - "us-east-1.storage.impossibleapi.net"
+ - New York, USA
+ - Provider: ImpossibleCloud
- "de-fra.i3storage.com"
- Frankfurt, Germany
- Provider: Intercolo
- - "s3-eu-central-1.ionoscloud.com"
+ - "s3.eu-central-1.ionoscloud.com"
- Frankfurt, Germany
- Provider: IONOS
- - "s3-eu-central-2.ionoscloud.com"
+ - "s3.eu-central-2.ionoscloud.com"
+ - Berlin, Germany
+ - Provider: IONOS
+ - "s3.eu-central-3.ionoscloud.com"
- Berlin, Germany
- Provider: IONOS
- - "s3-eu-south-2.ionoscloud.com"
+ - "s3.eu-central-4.ionoscloud.com"
+ - Frankfurt, Germany
+ - Provider: IONOS
+ - "s3.eu-south-2.ionoscloud.com"
- Logrono, Spain
- Provider: IONOS
+ - "s3.us-central-1.ionoscloud.com"
+ - Lenexa, USA
+ - Provider: IONOS
- "s3.leviia.com"
- The default endpoint
- Leviia
@@ -31271,15 +31701,6 @@ Properties:
- "s3.kz-1.srvstorage.kz"
- Almaty, Kazakhstan
- Provider: Servercore
- - "s3.us-east-2.stackpathstorage.com"
- - US East Endpoint
- - Provider: StackPath
- - "s3.us-west-1.stackpathstorage.com"
- - US West Endpoint
- - Provider: StackPath
- - "s3.eu-central-1.stackpathstorage.com"
- - EU Endpoint
- - Provider: StackPath
- "gateway.storjshare.io"
- Global Hosted Gateway
- Provider: Storj
@@ -31352,6 +31773,75 @@ Properties:
- "cos.accelerate.myqcloud.com"
- Use Tencent COS Accelerate Endpoint
- Provider: TencentCOS
+ - "s3-cn-bj.ufileos.com"
+ - North China (Beijing 2)
+ - Provider: US3
+ - "s3-cn-wlcb.ufileos.com"
+ - North China (Ulanqab)
+ - Provider: US3
+ - "s3-cn-sh2.ufileos.com"
+ - Shanghai
+ - Provider: US3
+ - "s3-cn-gd.ufileos.com"
+ - South China (Guangzhou)
+ - Provider: US3
+ - "s3-hk.ufileos.com"
+ - Hongkong
+ - Provider: US3
+ - "s3-us-ca.ufileos.com"
+ - United States (Los Angeles)
+ - Provider: US3
+ - "s3-sg.ufileos.com"
+ - Singapore
+ - Provider: US3
+ - "s3-idn-jakarta.ufileos.com"
+ - Indonesia (Jakarta)
+ - Provider: US3
+ - "s3-tw-tp.ufileos.com"
+ - Taiwan (Taipei)
+ - Provider: US3
+ - "s3-afr-nigeria.ufileos.com"
+ - Nigeria (Lagos)
+ - Provider: US3
+ - "s3-bra-saopaulo.ufileos.com"
+ - Brazil (São Paulo)
+ - Provider: US3
+ - "s3-uae-dubai.ufileos.com"
+ - United Arab Emirates (Dubai)
+ - Provider: US3
+ - "s3-ge-fra.ufileos.com"
+ - Germany (Frankfurt)
+ - Provider: US3
+ - "s3-vn-sng.ufileos.com"
+ - Vietnam (Ho Chi Minh City)
+ - Provider: US3
+ - "s3-us-ws.ufileos.com"
+ - United States (Washington)
+ - Provider: US3
+ - "s3-ind-mumbai.ufileos.com"
+ - India (Mumbai)
+ - Provider: US3
+ - "s3-kr-seoul.ufileos.com"
+ - Seoul (South Korea)
+ - Provider: US3
+ - "s3-jpn-tky.ufileos.com"
+ - Japan (Tokyo)
+ - Provider: US3
+ - "s3-th-bkk.ufileos.com"
+ - Bangkok (Thailand)
+ - Provider: US3
+ - "s3-uk-london.ufileos.com"
+ - United Kingdom (London)
+ - Provider: US3
+ - "s3-rus-mosc.ufileos.com"
+ - Russia (Moscow)
+ - Provider: US3
+ - "s3-cn-guiyang1.ufileos.com"
+ - Guiyang 1
+ - Provider: US3
+ - "s3-pk-khi.ufileos.com"
+ - Pakistan
+ - Provider: US3
- "s3.wasabisys.com"
- Wasabi US East 1 (N. Virginia)
- Provider: Wasabi
@@ -31408,7 +31898,7 @@ Properties:
- Config: location_constraint
- Env Var: RCLONE_S3_LOCATION_CONSTRAINT
-- Provider: AWS,ArvanCloud,Ceph,ChinaMobile,DigitalOcean,Dreamhost,Exaba,GCS,Hetzner,IBMCOS,LyveCloud,Minio,Netease,Qiniu,Rabata,RackCorp,SeaweedFS,Synology,Wasabi,Zata,Other
+- Provider: AWS,ArvanCloud,Ceph,ChinaMobile,DigitalOcean,Dreamhost,Exaba,GCS,HCP,Hetzner,IBMCOS,ImpossibleCloud,LyveCloud,Minio,Netease,Qiniu,Rabata,RackCorp,SeaweedFS,Synology,Wasabi,Zata,Other
- Type: string
- Required: false
- Examples:
@@ -31789,36 +32279,36 @@ Properties:
- Config: acl
- Env Var: RCLONE_S3_ACL
-- Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,Hetzner,HuaweiOBS,IBMCOS,IDrive,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,StackPath,TencentCOS,Wasabi,Zata,Other
+- Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IBMCOS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,US3,Wasabi,Zata,Other
- Type: string
- Required: false
- Examples:
- "private"
- Owner gets FULL_CONTROL.
- No one else has access rights (default).
- - Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,Hetzner,HuaweiOBS,IDrive,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,StackPath,Wasabi,Zata,Other
+ - Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,US3,Wasabi,Zata,Other
- "public-read"
- Owner gets FULL_CONTROL.
- The AllUsers group gets READ access.
- - Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,Hetzner,HuaweiOBS,IDrive,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,StackPath,TencentCOS,Wasabi,Zata,Other
+ - Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,US3,Wasabi,Zata,Other
- "public-read-write"
- Owner gets FULL_CONTROL.
- The AllUsers group gets READ and WRITE access.
- Granting this on a bucket is generally not recommended.
- - Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,Hetzner,HuaweiOBS,IDrive,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,StackPath,TencentCOS,Wasabi,Zata,Other
+ - Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,Wasabi,Zata,Other
- "authenticated-read"
- Owner gets FULL_CONTROL.
- The AuthenticatedUsers group gets READ access.
- - Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,Hetzner,HuaweiOBS,IDrive,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,StackPath,TencentCOS,Wasabi,Zata,Other
+ - Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,Wasabi,Zata,Other
- "bucket-owner-read"
- Object owner gets FULL_CONTROL.
- Bucket owner gets READ access.
- If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.
- - Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,Hetzner,HuaweiOBS,IDrive,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,StackPath,TencentCOS,Wasabi,Zata,Other
+ - Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,Wasabi,Zata,Other
- "bucket-owner-full-control"
- Both the object owner and the bucket owner get FULL_CONTROL over the object.
- If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.
- - Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,Hetzner,HuaweiOBS,IDrive,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,StackPath,TencentCOS,Wasabi,Zata,Other
+ - Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,Wasabi,Zata,Other
- "private"
- Owner gets FULL_CONTROL.
- No one else has access rights (default).
@@ -31892,22 +32382,22 @@ Properties:
- Config: storage_class
- Env Var: RCLONE_S3_STORAGE_CLASS
-- Provider: AWS,Alibaba,ArvanCloud,ChinaMobile,Liara,Magalu,Qiniu,Scaleway,TencentCOS
+- Provider: AWS,Alibaba,ArvanCloud,ChinaMobile,Liara,Magalu,OVHcloud,Qiniu,Scaleway,TencentCOS,US3
- Type: string
- Required: false
- Examples:
- ""
- Default
- - Provider: AWS,Alibaba,ChinaMobile,TencentCOS
+ - Provider: AWS,Alibaba,ChinaMobile,OVHcloud,TencentCOS,US3
- "STANDARD"
- Standard storage class
- - Provider: AWS,Alibaba,ArvanCloud,ChinaMobile,Liara,Magalu,Qiniu,TencentCOS
+ - Provider: AWS,Alibaba,ArvanCloud,ChinaMobile,Liara,Magalu,OVHcloud,Qiniu,TencentCOS,US3
- "REDUCED_REDUNDANCY"
- Reduced redundancy storage class
- Provider: AWS
- "STANDARD_IA"
- Standard Infrequent Access storage class
- - Provider: AWS
+ - Provider: AWS,OVHcloud
- "ONEZONE_IA"
- One Zone Infrequent Access storage class
- Provider: AWS
@@ -31928,7 +32418,25 @@ Properties:
- Provider: Alibaba,ChinaMobile,Qiniu
- "STANDARD_IA"
- Infrequent access storage mode
- - Provider: Alibaba,ChinaMobile,TencentCOS
+ - Provider: Alibaba,ChinaMobile,TencentCOS,US3
+ - "EXPRESS_ONEZONE"
+ - High Performance storage class
+ - Provider: OVHcloud
+ - "ONEZONE_IA"
+ - Standard Infrequent Access storage class
+ - Provider: OVHcloud
+ - "GLACIER"
+ - Active Archive storage class
+ - Provider: OVHcloud
+ - "GLACIER_IR"
+ - Active Archive storage class
+ - Provider: OVHcloud
+ - "DEEP_ARCHIVE"
+ - Cold Archive storage class
+ - Provider: OVHcloud
+ - "INTELLIGENT_TIERING"
+ - Standard storage class
+ - Provider: OVHcloud
- "LINE"
- Infrequent access storage mode
- Provider: Qiniu
@@ -31946,16 +32454,16 @@ Properties:
- "GLACIER"
- Archived storage.
- Prices are lower, but it needs to be restored first to be accessed.
- - Available in FR-PAR and NL-AMS regions.
+ - Available in the FR-PAR region only.
- Provider: Scaleway
- "ONEZONE_IA"
- One Zone - Infrequent Access.
- A good choice for storing secondary backup copies or easily re-creatable data.
- - Available in the FR-PAR region only.
+ - Available in all regions.
- Provider: Scaleway
- "ARCHIVE"
- Archive storage mode
- - Provider: TencentCOS
+ - Provider: TencentCOS,US3
#### --s3-ibm-api-key
@@ -31981,9 +32489,20 @@ Properties:
- Type: string
- Required: false
+#### --s3-bucket-object-lock-enabled
+
+Enable Object Lock when creating new buckets.
+
+Properties:
+
+- Config: bucket_object_lock_enabled
+- Env Var: RCLONE_S3_BUCKET_OBJECT_LOCK_ENABLED
+- Type: bool
+- Default: false
+
### Advanced options
-Here are the Advanced options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, BizflyCloud, Ceph, ChinaMobile, Cloudflare, Cubbit, DigitalOcean, Dreamhost, Exaba, FileLu, FlashBlade, GCS, Hetzner, HuaweiOBS, IBMCOS, IDrive, Intercolo, IONOS, Leviia, Liara, Linode, LyveCloud, Magalu, Mega, Minio, Netease, Outscale, OVHcloud, Petabox, Qiniu, Rabata, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Servercore, SpectraLogic, StackPath, Storj, Synology, TencentCOS, Wasabi, Zata, Other).
+Here are the Advanced options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, BizflyCloud, Ceph, ChinaMobile, Cloudflare, Cubbit, DigitalOcean, Dreamhost, Exaba, Fastly, FileLu, FlashBlade, GCS, HCP, Hetzner, HuaweiOBS, IBMCOS, IDrive, ImpossibleCloud, Intercolo, IONOS, Leviia, Liara, Linode, LyveCloud, Magalu, Mega, Minio, Netease, Outscale, OVHcloud, Petabox, Qiniu, Rabata, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Servercore, SpectraLogic, Storj, Synology, TencentCOS, US3, Wasabi, Zadara, Zata, Other).
#### --s3-bucket-acl
@@ -32002,7 +32521,7 @@ Properties:
- Config: bucket_acl
- Env Var: RCLONE_S3_BUCKET_ACL
-- Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,Hetzner,HuaweiOBS,IBMCOS,IDrive,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Mega,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,Servercore,StackPath,TencentCOS,Wasabi,Zata,Other
+- Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IBMCOS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Mega,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,Servercore,TencentCOS,US3,Wasabi,Zata,Other
- Type: string
- Required: false
- Examples:
@@ -32894,6 +33413,27 @@ Properties:
- Type: Tristate
- Default: unset
+#### --s3-list-versions-oldest-first
+
+Set if the backend returns object versions oldest first.
+
+The S3 standard returns object versions newest first. Some backends
+(e.g. Hitachi HCP) return them oldest first instead.
+
+Set this quirk if --s3-version-at or --s3-versions produce incorrect
+results with your backend.
+
+This should be automatically set correctly for all providers rclone
+knows about - please make a bug report if not.
+
+
+Properties:
+
+- Config: list_versions_oldest_first
+- Env Var: RCLONE_S3_LIST_VERSIONS_OLDEST_FIRST
+- Type: Tristate
+- Default: unset
+
#### --s3-use-x-id
Set if rclone should add x-id URL parameters.
@@ -32996,6 +33536,158 @@ Properties:
- Type: Bits
- Default: Off
+#### --s3-ibm-iam-endpoint
+
+IBM IAM Endpoint to use for authentication.
+
+Leave blank to use the default public endpoint.
+
+Properties:
+
+- Config: ibm_iam_endpoint
+- Env Var: RCLONE_S3_IBM_IAM_ENDPOINT
+- Provider: IBMCOS
+- Type: string
+- Required: false
+
+#### --s3-object-lock-mode
+
+Object Lock mode to apply when uploading or copying objects.
+
+Set this to apply Object Lock retention mode to objects.
+If not set, no Object Lock mode is applied (even with --metadata).
+
+Note: To enable Object Lock retention, you must set BOTH object_lock_mode
+AND object_lock_retain_until_date. Setting only one has no effect.
+
+- GOVERNANCE: Set Object Lock mode to GOVERNANCE
+- COMPLIANCE: Set Object Lock mode to COMPLIANCE
+- copy: Copy the mode from the source object (requires --metadata)
+
+See: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html
+
+Properties:
+
+- Config: object_lock_mode
+- Env Var: RCLONE_S3_OBJECT_LOCK_MODE
+- Type: string
+- Required: false
+- Examples:
+ - "GOVERNANCE"
+ - Set Object Lock mode to GOVERNANCE
+ - "COMPLIANCE"
+ - Set Object Lock mode to COMPLIANCE
+ - "copy"
+ - Copy from source object (requires --metadata)
+
+#### --s3-object-lock-retain-until-date
+
+Object Lock retention until date to apply when uploading or copying objects.
+
+Set this to apply Object Lock retention date to objects.
+If not set, no retention date is applied (even with --metadata).
+
+Note: To enable Object Lock retention, you must set BOTH object_lock_mode
+AND object_lock_retain_until_date. Setting only one has no effect.
+
+Accepts:
+- RFC 3339 format: 2030-01-02T15:04:05Z
+- Duration from now: 365d, 1y, 6M (days, years, months)
+- copy: Copy the date from the source object (requires --metadata)
+
+See: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html
+
+Properties:
+
+- Config: object_lock_retain_until_date
+- Env Var: RCLONE_S3_OBJECT_LOCK_RETAIN_UNTIL_DATE
+- Type: string
+- Required: false
+- Examples:
+ - "copy"
+ - Copy from source object (requires --metadata)
+ - "2030-01-01T00:00:00Z"
+ - Set specific date (RFC 3339 format)
+ - "365d"
+ - Set retention for 365 days from now
+ - "1y"
+ - Set retention for 1 year from now
+
+#### --s3-object-lock-legal-hold-status
+
+Object Lock legal hold status to apply when uploading or copying objects.
+
+Set this to apply Object Lock legal hold to objects.
+If not set, no legal hold is applied (even with --metadata).
+
+Note: Legal hold is independent of retention and can be set separately.
+
+- ON: Enable legal hold
+- OFF: Disable legal hold
+- copy: Copy the legal hold status from the source object (requires --metadata)
+
+See: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html
+
+Properties:
+
+- Config: object_lock_legal_hold_status
+- Env Var: RCLONE_S3_OBJECT_LOCK_LEGAL_HOLD_STATUS
+- Type: string
+- Required: false
+- Examples:
+ - "ON"
+ - Enable legal hold
+ - "OFF"
+ - Disable legal hold
+ - "copy"
+ - Copy from source object (requires --metadata)
+
+#### --s3-bypass-governance-retention
+
+Allow deleting or modifying objects locked with GOVERNANCE mode.
+
+Properties:
+
+- Config: bypass_governance_retention
+- Env Var: RCLONE_S3_BYPASS_GOVERNANCE_RETENTION
+- Type: bool
+- Default: false
+
+#### --s3-object-lock-set-after-upload
+
+Set Object Lock via separate API calls after upload.
+
+Use this for S3-compatible providers that don't support setting Object Lock
+headers during PUT operations. When enabled, Object Lock is set via separate
+PutObjectRetention and PutObjectLegalHold API calls after the upload completes.
+
+This adds extra API calls per object, so only enable if your provider requires it.
+
+Properties:
+
+- Config: object_lock_set_after_upload
+- Env Var: RCLONE_S3_OBJECT_LOCK_SET_AFTER_UPLOAD
+- Type: bool
+- Default: false
+
+#### --s3-object-lock-supported
+
+Whether the provider supports S3 Object Lock.
+
+This should be true, false or left unset to use the default for the provider.
+
+Set to false for providers that don't fully support the S3 Object Lock API
+(e.g. GCS which uses non-standard headers for bypass governance retention
+and doesn't implement Legal Hold via the S3 API).
+
+
+Properties:
+
+- Config: object_lock_supported
+- Env Var: RCLONE_S3_OBJECT_LOCK_SUPPORTED
+- Type: Tristate
+- Default: unset
+
#### --s3-description
Description of the remote.
@@ -33022,6 +33714,9 @@ Here are the possible system metadata items for the s3 backend.
| content-language | Content-Language header | string | en-US | N |
| content-type | Content-Type header | string | text/plain | N |
| mtime | Time of last modification, read from rclone metadata | RFC 3339 | 2006-01-02T15:04:05.999999999Z07:00 | N |
+| object-lock-legal-hold-status | Object Lock legal hold status: ON or OFF | string | OFF | N |
+| object-lock-mode | Object Lock mode: GOVERNANCE or COMPLIANCE | string | GOVERNANCE | N |
+| object-lock-retain-until-date | Object Lock retention until date | RFC 3339 | 2030-01-02T15:04:05Z | N |
| tier | Tier of the object | string | GLACIER | **Y** |
See the [metadata](https://rclone.org/docs/#metadata) docs for more info.
@@ -33971,7 +34666,7 @@ Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
...
-XX / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, China Mobile, Cloudflare, ArvanCloud, DigitalOcean, Dreamhost, Huawei OBS, IBM COS, Lyve Cloud, Minio, Magalu, Netease, RackCorp, Scaleway, SeaweedFS, StackPath, Storj, Synology, Tencent COS and Wasabi
+XX / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, China Mobile, Cloudflare, ArvanCloud, DigitalOcean, Dreamhost, Huawei OBS, IBM COS, Lyve Cloud, Minio, Magalu, Netease, RackCorp, Scaleway, SeaweedFS, Storj, Synology, Tencent COS and Wasabi
\ (s3)
...
Storage> s3
@@ -34065,7 +34760,9 @@ can follow this [guide](https://docs.cubbit.io/getting-started/quickstart#api-ke
to retrieve these keys. They will be needed when prompted by `rclone config`.
Default region will correspond to `eu-west-1` and the endpoint has to be specified
-as `s3.cubbit.eu`.
+as `s3.cubbit.eu`. If you set a custom tenant endpoint, you must use
+`s3.{tenant_name}.cubbit.eu`, because the generic `s3.cubbit.eu` endpoint will not
+work in this case.
Going through the whole process of creating a new remote by running `rclone config`,
each prompt should be answered as shown below:
@@ -34078,7 +34775,7 @@ env_auth> false
access_key_id> YOUR_ACCESS_KEY
secret_access_key> YOUR_SECRET_KEY
region> eu-west-1 (or leave empty)
-endpoint> s3.cubbit.eu
+endpoint> s3.cubbit.eu (or s3.{tenant_name}.cubbit.eu)
acl>
```
@@ -34258,6 +34955,92 @@ secret_access_key = XXX
endpoint = http://127.0.0.1:9000/
```
+### Fastly Object Storage {#fastly}
+
+[Fastly Object Storage](https://www.fastly.com/products/storage) is an
+S3-compatible object storage service from Fastly. It provides three
+regions (US East, US West, and EU Central) with mandatory server-side
+encryption.
+
+Here is an example of making a configuration. First run:
+
+```console
+rclone config
+```
+
+This will guide you through an interactive setup process.
+
+```text
+No remotes found, make a new one?
+n) New remote
+s) Set configuration password
+q) Quit config
+n/s/q> n
+
+Enter name for new remote.
+name> fastly
+
+Option Storage.
+Type of storage to configure.
+Storage> s3
+
+Option provider.
+Choose your S3 provider.
+provider> Fastly
+
+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.
+env_auth> false
+
+Option access_key_id.
+AWS Access Key ID.
+access_key_id> YOUR_ACCESS_KEY
+
+Option secret_access_key.
+AWS Secret Access Key (password).
+secret_access_key> YOUR_SECRET_KEY
+
+Option region.
+Region where your bucket will be created and your data stored.
+region> us-east
+
+Option endpoint.
+Endpoint for S3 API.
+endpoint> us-east.object.fastlystorage.app
+
+Edit advanced config?
+y) Yes
+n) No (default)
+y/n> n
+
+Configuration complete.
+Options:
+- type: s3
+- provider: Fastly
+- access_key_id: YOUR_ACCESS_KEY
+- secret_access_key: YOUR_SECRET_KEY
+- region: us-east
+- endpoint: us-east.object.fastlystorage.app
+Keep this "fastly" remote?
+y) Yes this is OK (default)
+e) Edit this remote
+d) Delete this remote
+y/e/d> y
+```
+
+The resulting configuration file should look like:
+
+```ini
+[fastly]
+type = s3
+provider = Fastly
+access_key_id = YOUR_ACCESS_KEY
+secret_access_key = YOUR_SECRET_KEY
+region = us-east
+endpoint = us-east.object.fastlystorage.app
+```
+
### Google Cloud Storage
[GoogleCloudStorage](https://cloud.google.com/storage/docs) is an
@@ -34309,7 +35092,7 @@ 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, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, GCS, Hetzner, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, StackPath, Storj, Synology, TencentCOS, Wasabi, Qiniu and others
+ XX / Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, GCS, Hetzner, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Storj, Synology, TencentCOS, Wasabi, Qiniu and others
\ (s3)
[snip]
Storage> s3
@@ -34430,6 +35213,132 @@ endpoint = hel1.your-objectstorage.com
acl = private
```
+### Hitachi Content Platform (HCP) {#hcp}
+
+Here is an example of making a [Hitachi Content Platform (HCP)](https://www.hitachivantara.com/en-us/products/storage/content-platform.html)
+configuration. First run:
+
+```console
+rclone config
+```
+
+This will guide you through an interactive setup process.
+
+```text
+No remotes found, make a new one?
+n) New remote
+s) Set configuration password
+q) Quit config
+n/s/q> n
+
+Enter name for new remote.
+name> my-hcp
+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, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, GCS, HCP, Hetzner, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Storj, Synology, TencentCOS, Wasabi, Qiniu and others
+ \ (s3)
+[snip]
+Storage> s3
+Option provider.
+Choose your S3 provider.
+Choose a number from below, or type in your own value.
+Press Enter to leave empty.
+[snip]
+XX / Hitachi Content Platform (HCP)
+ \ (HCP)
+[snip]
+provider> HCP
+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>
+Option access_key_id.
+AWS Access Key ID.
+Leave blank for anonymous access or runtime credentials.
+Enter a value. Press Enter to leave empty.
+access_key_id> ACCESS_KEY
+Option secret_access_key.
+AWS Secret Access Key (password).
+Leave blank for anonymous access or runtime credentials.
+Enter a value. Press Enter to leave empty.
+secret_access_key> SECRET_KEY
+Option endpoint.
+Endpoint for HCP S3 compatible API.
+Enter a value. Press Enter to leave empty.
+endpoint> https://hcp.example.com
+Edit advanced config?
+y) Yes
+n) No (default)
+y/n>
+Configuration complete.
+Options:
+- type: s3
+- provider: HCP
+- access_key_id: ACCESS_KEY
+- secret_access_key: SECRET_KEY
+- endpoint: https://hcp.example.com
+Keep this "my-hcp" remote?
+y) Yes this is OK (default)
+e) Edit this remote
+d) Delete this remote
+y/e/d>
+Current remotes:
+
+Name Type
+==== ====
+my-hcp 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>
+```
+
+This will leave the config file looking like this.
+
+```ini
+[my-hcp]
+type = s3
+provider = HCP
+access_key_id = ACCESS_KEY
+secret_access_key = SECRET_KEY
+endpoint = https://hcp.example.com
+```
+
+#### Known limitations
+
+These limitations have been observed with HCP version 9.7.x.
+
+**Automatic directory objects**
+
+HCP automatically creates zero-byte directory objects (keys ending in `/`) for
+every path component when an object is stored. These directory objects are
+managed by HCP internally: deleting one via the S3 API does not remove it but
+instead creates a delete marker with a special version ID (`-3`) that cannot
+itself be deleted. As a result, rclone cannot fully purge a bucket on HCP —
+leftover directory objects will remain after a `purge` or `delete` operation.
+
+**Transparent gzip decompression**
+
+HCP [transparently decompresses](https://docs.hitachivantara.com/r/en-us/content-platform/9.6.x/mk-95hcph002/using-the-hitachi-api-for-amazon-s3/working-with-objects/creating-an-object)
+objects uploaded with `Content-Encoding: gzip` before storing them. This means
+the stored object contains the raw (uncompressed) data, while the `Content-MD5`
+sent by rclone was computed over the compressed bytes. HCP will reject such
+uploads with a `BadDigest` error. To avoid this, do not set
+`content-encoding: gzip` in object metadata when using HCP.
+
### Huawei OBS {#huawei-obs}
Object Storage Service (OBS) provides stable, secure, efficient, and easy-to-use
@@ -34895,6 +35804,180 @@ d) Delete this remote
y/e/d> y
```
+### Impossible Cloud {#impossible-cloud}
+
+[Impossible Cloud](https://www.impossiblecloud.com/) is a European
+S3-compatible object storage provider with regions in Europe and the
+US.
+
+Note: Impossible Cloud does not preserve the `Cache-Control`,
+`Content-Disposition`, `Content-Encoding` or `Content-Language` system
+metadata fields on retrieval, even when they were set at upload time.
+Because the `Content-Encoding` response header is also dropped, the
+`--s3-decompress` flag has no effect on objects stored there. Other
+metadata such as `Content-Type` and the modification time round-trip
+normally.
+
+Here is an example of making an Impossible Cloud configuration. First run:
+
+```console
+rclone config
+```
+
+This will guide you through an interactive setup process.
+
+```text
+No remotes found, make a new one?
+n) New remote
+s) Set configuration password
+q) Quit config
+n/s/q> n
+
+Enter name for new remote.
+name> my-impossible-cloud
+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, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, GCS, Hetzner, HuaweiOBS, IBMCOS, IDrive, ImpossibleCloud, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Storj, Synology, TencentCOS, Wasabi, Qiniu and others
+ \ (s3)
+[snip]
+Storage> s3
+Option provider.
+Choose your S3 provider.
+Choose a number from below, or type in your own value.
+Press Enter to leave empty.
+[snip]
+XX / Impossible Cloud Object Storage
+ \ (ImpossibleCloud)
+[snip]
+provider> ImpossibleCloud
+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>
+Option access_key_id.
+AWS Access Key ID.
+Leave blank for anonymous access or runtime credentials.
+Enter a value. Press Enter to leave empty.
+access_key_id> ACCESS_KEY
+Option secret_access_key.
+AWS Secret Access Key (password).
+Leave blank for anonymous access or runtime credentials.
+Enter a value. Press Enter to leave empty.
+secret_access_key> SECRET_KEY
+Option region.
+Region to connect to.
+Choose a number from below, or type in your own value.
+Press Enter to leave empty.
+ 1 / Frankfurt, Germany
+ \ (eu-central-2)
+ 2 / Amsterdam, Netherlands
+ \ (eu-west-1)
+ 3 / London, UK
+ \ (eu-west-2)
+ 4 / Paris, France
+ \ (eu-west-3)
+ 5 / Poznań, Poland
+ \ (eu-east-1)
+ 6 / Copenhagen, Denmark
+ \ (eu-north-1)
+ 7 / New York, USA
+ \ (us-east-1)
+region> 1
+Option endpoint.
+Endpoint for Impossible Cloud Object Storage
+Choose a number from below, or type in your own value.
+Press Enter to leave empty.
+ 1 / Frankfurt, Germany
+ \ (eu-central-2.storage.impossibleapi.net)
+ 2 / Amsterdam, Netherlands
+ \ (eu-west-1.storage.impossibleapi.net)
+ 3 / London, UK
+ \ (eu-west-2.storage.impossibleapi.net)
+ 4 / Paris, France
+ \ (eu-west-3.storage.impossibleapi.net)
+ 5 / Poznań, Poland
+ \ (eu-east-1.storage.impossibleapi.net)
+ 6 / Copenhagen, Denmark
+ \ (eu-north-1.storage.impossibleapi.net)
+ 7 / New York, USA
+ \ (us-east-1.storage.impossibleapi.net)
+endpoint> 1
+Option location_constraint.
+Location constraint - must be set to match the Region.
+Leave blank if not sure. Used when creating buckets only.
+Enter a value. Press Enter to leave empty.
+location_constraint>
+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'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't copy the ACL from the source but rather writes a fresh one.
+If the acl is an empty string then no X-Amz-Acl: header is added and
+the default (private) will be used.
+Choose a number from below, or type in your own value.
+Press Enter to leave empty.
+ / Owner gets FULL_CONTROL.
+ 1 | No one else has access rights (default).
+ \ (private)
+ / Owner gets FULL_CONTROL.
+ 2 | The AllUsers group gets READ access.
+ \ (public-read)
+acl>
+Edit advanced config?
+y) Yes
+n) No (default)
+y/n>
+Configuration complete.
+Options:
+- type: s3
+- provider: ImpossibleCloud
+- access_key_id: ACCESS_KEY
+- secret_access_key: SECRET_KEY
+- region: eu-central-2
+- endpoint: eu-central-2.storage.impossibleapi.net
+Keep this "my-impossible-cloud" remote?
+y) Yes this is OK (default)
+e) Edit this remote
+d) Delete this remote
+y/e/d>
+Current remotes:
+
+Name Type
+==== ====
+my-impossible-cloud 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>
+```
+
+This will leave the config file looking like this.
+
+```ini
+[my-impossible-cloud]
+type = s3
+provider = ImpossibleCloud
+access_key_id = ACCESS_KEY
+secret_access_key = SECRET_KEY
+region = eu-central-2
+endpoint = eu-central-2.storage.impossibleapi.net
+acl = private
+```
+
### Intercolo Object Storage {#intercolo}
[Intercolo Object Storage](https://intercolo.de/object-storage) offers
@@ -36091,7 +37174,7 @@ 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, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, GCS, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, OVHcloud, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, StackPath, Storj, Synology, TencentCOS, Wasabi, Qiniu and others
+ XX / Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, GCS, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, OVHcloud, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Storj, Synology, TencentCOS, Wasabi, Qiniu and others
\ (s3)
[...]
Storage> s3
@@ -36465,7 +37548,7 @@ Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
[snip]
- 4 / Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, FlashBlade, GCS, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, StackPath, Storj, Synology, TencentCOS, Wasabi, Qiniu and others
+ 4 / Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, FlashBlade, GCS, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Storj, Synology, TencentCOS, Wasabi, Qiniu and others
\ (s3)
[snip]
Storage> s3
@@ -37965,6 +39048,152 @@ To configure access to Tencent COS, follow the steps below:
cos s3
```
+#### Tencent COS Global Acceleration Endpoint
+
+When using the Global Acceleration Endpoint (`cos.accelerate.myqcloud.com`),
+rclone automatically sets `no_check_bucket = true` because this acceleration
+endpoint does not support the `CreateBucket` call which is used for ensuring
+a bucket's existence by rclone. Global Acceleration is a per-bucket feature,
+so you should first create the bucket in one physical region, then enable it
+in the Tencent Cloud console.
+
+### US3 {#us3}
+[US3](https://www.ucloud.cn/site/product/ufile.html) Object Storage is a service that provides cloud storage for unstructured files for internet applications.
+
+To configure access to US3, follow the steps below:
+1. First run:
+ ```console
+ rclone config
+ No remotes found, make a new one?
+ n) New remote
+ s) Set configuration password
+ q) Quit config
+ n/s/q> n
+ ```
+2. Give the name of the configuration. For example, name it 'US3'.
+
+ ```text
+ name> US3
+ ```
+3. Select `s3` storage.
+
+ ```text
+ Choose a number from below, or type in your own value
+ [snip]
+ XX / Amazon S3 Compliant Storage Providers including AWS, ...
+ \ "s3"
+ [snip]
+ Storage> s3
+ ```
+4. Select `US3` provider.
+
+ ```text
+ Choose a number from below, or type in your own value.
+ XX / Amazon Web Services (AWS) S3
+ \ (AWS)
+ [snip]
+ XX / UCloud Object Storage (US3)
+ \ (US3)
+ [snip]
+ provider> US3
+ ```
+5. Enter your SecretId and SecretKey of US3.
+
+ ```text
+ 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).
+ Choose a number from below, or type in your own value
+ 1 / Enter AWS credentials in the next step
+ \ "false"
+ 2 / Get AWS credentials from the environment (env vars or IAM)
+ \ "true"
+ env_auth> 1
+ Option access_key_id.
+ AWS Access Key ID.
+ Leave blank for anonymous access or runtime credentials.
+ Enter a value. Press Enter to leave empty.
+ access_key_id> AKIDxxxxxxxxxx
+ AWS Secret Access Key (password)
+ Leave blank for anonymous access or runtime credentials.
+ Enter a string value. Press Enter for the default ("").
+ secret_access_key> xxxxxxxxxxx
+ ```
+
+6. Select endpoint.
+ ```text
+ Option endpoint.
+ Endpoint for S3 API.
+ Required when using an S3 clone.
+ Choose a number from below, or type in your own value.
+ Press Enter to leave empty.
+ 1 / North China (Beijing 2).
+ \ "s3-cn-bj.ufileos.com"
+ 2 / North China (Ulanqab).
+ \ "s3-cn-wlcb.ufileos.com"
+ 3 / Shanghai.
+ \ "s3-cn-sh2.ufileos.com"
+ 4 / South China (Guangzhou).
+ \ "s3-cn-gd.ufileos.com"
+ [snip]
+ endpoint> 1
+ ```
+
+7. Choose acl and storage class.
+
+ ```text
+ 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'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't copy the ACL from the source but rather writes a fresh one.
+ If the acl is an empty string then no X-Amz-Acl: header is added and
+ the default (private) will be used.
+ Choose a number from below, or type in your own value.
+ Press Enter to leave empty.
+ / Owner gets FULL_CONTROL.
+ 1 | No one else has access rights (default).
+ \ (private)
+ / Owner gets FULL_CONTROL.
+ 2 | The AllUsers group gets READ access.
+ \ (public-read)
+ acl> 1
+
+ The storage class to use when storing new objects in US3.
+ Enter a string value. Press Enter for the default ("").
+ Choose a number from below, or type in your own value
+ 1 / Default
+ \ ""
+ [snip]
+ storage_class> 1
+ Edit advanced config? (y/n)
+ y) Yes
+ n) No (default)
+ y/n> n
+
+ Configuration complete.
+ Options:
+ - type: s3
+ - provider: US3
+ - access_key_id: xx
+ - secret_access_key: xx
+ - endpoint: s3-cn-bj.ufileos.com
+ - acl: private
+
+ Keep this "US3" remote?
+ y) Yes this is OK (default)
+ e) Edit this remote
+ d) Delete this remote
+ y/e/d> y
+ Current remotes:
+
+ Name Type
+ ==== ====
+ US3 s3
+ ```
+
### Wasabi
[Wasabi](https://wasabi.com) is a cloud-based object storage service for a
@@ -38078,6 +39307,125 @@ server_side_encryption =
storage_class =
```
+### Zadara Object Storage {#zadara}
+
+[Zadara Object Storage](https://www.zadara.com) is a fully-managed,
+enterprise-grade, S3-compatible storage solution that provides scalable,
+multi-tenant object storage with flexible deployment options (on-prem,
+hybrid, or cloud).
+
+Zadara Object Storage can be configured using `rclone config` with `s3` as
+the type and `Zadara` as the provider name. Here is an example
+run of the configurator.
+
+Authentication and endpoint information, including the region field,
+should be fetched from Zadara’s Object Storage management interface
+
+To configure access to Zadara Object Storage, first run:
+
+```console
+rclone config
+```
+
+```text
+This will guide you through an interactive setup process:
+
+No remotes found, make a new one\?
+n) New remote
+s) Set configuration password
+n/s> n
+
+Enter name for new remote.
+name> Zadara-Object-Storage
+
+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 ...
+ \ (s3)
+
+Storage> s3
+
+Option provider.
+Choose your S3 provider.
+Choose a number from below, or type in your own value.
+Press Enter to leave empty.
+
+XX / Zadara Object Storage
+ \ (Zadara)
+
+provider> Zadara
+
+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>
+
+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> S3_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> S3_SECRET_KEY
+
+Option region.
+Region to connect to.
+Leave blank if you are using an S3 clone and you don't have a region.
+Choose a number from below, or type in your own value.
+Press Enter to leave empty.
+ / The default region.
+ 1 | Leave location constraint empty.
+ \ (us-east-1)
+region>
+
+Option endpoint.
+Endpoint for S3 API.
+Required when using an S3 clone.
+Enter a value. Press Enter to leave empty.
+endpoint> https://vsa-00000001-public-zadara-cloud-01.zadarazios.com
+
+Edit advanced config?
+y) Yes
+n) No (default)
+y/n>
+
+Configuration complete.
+Options:
+- type: s3
+- provider: Zadara
+- access_key_id: S3_ACCESS_KEY
+- secret_access_key: S3_SECRET_KEY
+- endpoint: https://vsa-00000001-public-zadara-cloud-01.zadarazios.com
+Keep this "Zadara-Object-Storage" remote?
+y) Yes this is OK (default)
+e) Edit this remote
+d) Delete this remote
+y/e/d> y
+```
+
+This will leave the config file looking like this.
+
+```ini
+[Zadara-Object-Storage]
+type = s3
+provider = Zadara
+access_key_id = S3_ACCESS_KEY
+secret_access_key = S3_SECRET_KEY
+endpoint = https://vsa-00000001-public-zadara-cloud-01.zadarazios.com
+```
+
### Zata Object Storage {#Zata}
[Zata Object Storage](https://zata.ai/) provides a secure, S3-compatible cloud
@@ -38265,7 +39613,7 @@ remote.
See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features)
and [rclone about](https://rclone.org/commands/rclone_about/).
-# Archive
+# Archive
The Archive backend allows read only access to the content of archive
files on cloud storage without downloading the complete archive. This
@@ -38546,7 +39894,7 @@ See the [metadata](https://rclone.org/docs/#metadata) docs for more info.
<!-- autogenerated options stop -->
-# Backblaze B2
+# Backblaze B2
B2 is [Backblaze's cloud storage system](https://www.backblaze.com/cloud-storage).
@@ -39419,7 +40767,7 @@ remote.
See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features)
and [rclone about](https://rclone.org/commands/rclone_about/).
-# Box
+# Box
Paths are specified as `remote:path`
@@ -39986,7 +41334,7 @@ and `Client Secret`, you'll need those for rclone.
and `Write all files and folders stored in box` (assuming you want to do both).
Leave others unchecked. Click `Save Changes` at the top right.
-# Cache
+# Cache
The `cache` remote wraps another existing remote and stores file structure
and its data for long running tasks like `rclone mount`.
@@ -40706,7 +42054,7 @@ rclone backend stats remote: [options] [<arguments>+]
<!-- autogenerated options stop -->
-# Chunker
+# Chunker
The `chunker` overlay transparently splits large files into smaller chunks
during upload to wrapped remote and transparently assembles them back
@@ -41184,7 +42532,7 @@ Properties:
<!-- autogenerated options stop -->
-# Cloudinary
+# Cloudinary
This is a backend for the [Cloudinary](https://cloudinary.com/) platform
@@ -41436,7 +42784,7 @@ Properties:
<!-- autogenerated options stop -->
-# Citrix ShareFile
+# Citrix ShareFile
[Citrix ShareFile](https://sharefile.com) is a secure file sharing and transfer
service aimed as business.
@@ -41787,7 +43135,7 @@ remote.
See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features)
and [rclone about](https://rclone.org/commands/rclone_about/).
-# Crypt
+# Crypt
Rclone `crypt` remotes encrypt and decrypt other remotes.
@@ -42625,7 +43973,7 @@ a salt.
- [rclone cryptdecode](https://rclone.org/commands/rclone_cryptdecode/) - Show forward/reverse
mapping of encrypted filenames.
-# Compress
+# Compress
## Warning
@@ -42841,7 +44189,7 @@ See the [metadata](https://rclone.org/docs/#metadata) docs for more info.
<!-- autogenerated options stop -->
-# Combine
+# Combine
The `combine` backend joins remotes together into a single directory
tree.
@@ -43022,7 +44370,7 @@ See the [metadata](https://rclone.org/docs/#metadata) docs for more info.
<!-- autogenerated options stop -->
-# DOI
+# DOI
The DOI remote is a read only remote for reading files from digital object
identifiers (DOI).
@@ -43218,7 +44566,7 @@ It doesn't return anything.
<!-- autogenerated options stop -->
-# Drime
+# Drime
[Drime](https://drime.cloud/) is a cloud storage and transfer service focused
on fast, resilient file delivery. It offers both free and paid tiers with
@@ -43531,7 +44879,7 @@ Properties:
Drime only supports filenames up to 255 bytes in length, where filenames are
encoded in UTF8.
-# Dropbox
+# Dropbox
Paths are specified as `remote:path`
@@ -44186,7 +45534,7 @@ values in rclone config to add a new remote or edit an existing remote.
The `App key` setting corresponds to `client_id` in rclone config, the
`App secret` corresponds to `client_secret`
-# Enterprise File Fabric
+# Enterprise File Fabric
This backend supports [Storage Made Easy's Enterprise File
Fabric™](https://storagemadeeasy.com/about/) which provides a software
@@ -44478,7 +45826,7 @@ Properties:
<!-- autogenerated options stop -->
-# FileLu
+# FileLu
[FileLu](https://filelu.com/) is a reliable cloud storage provider
offering features like secure file uploads, downloads, flexible
@@ -44693,6 +46041,28 @@ Properties:
Here are the Advanced options specific to filelu (FileLu Cloud Storage).
+#### --filelu-upload-cutoff
+
+Cutoff for switching to chunked upload. Any files larger than this will be uploaded in chunks of chunk_size.
+
+Properties:
+
+- Config: upload_cutoff
+- Env Var: RCLONE_FILELU_UPLOAD_CUTOFF
+- Type: SizeSuffix
+- Default: 500Mi
+
+#### --filelu-chunk-size
+
+Chunk size to use for uploading. Used for multipart uploads.
+
+Properties:
+
+- Config: chunk_size
+- Env Var: RCLONE_FILELU_CHUNK_SIZE
+- Type: SizeSuffix
+- Default: 64Mi
+
#### --filelu-encoding
The encoding for the backend.
@@ -44728,12 +46098,14 @@ for troubleshooting and updates.
For further information, visit [FileLu's website](https://filelu.com/).
-# Filen
+# Filen
## Configuration
The initial setup for Filen requires that you get an API key for your account,
currently this is only possible using the [Filen CLI](https://github.com/FilenCloudDienste/filen-cli).
This means you must first download the CLI, login, and then run the `export-api-key` command.
+**Note:** If you change your Filen account password, you will need to update your rclone configuration with the new password and a re-exported API key (via `export-api-key`).
+
Here is an example of how to make a remote called `FilenRemote`. First run:
rclone config
@@ -44846,7 +46218,7 @@ Properties:
#### --filen-api-key
-API Key for your Filen account
+API Key for your Filen account
Get this using the Filen CLI export-api-key command
You can download the Filen CLI from https://github.com/FilenCloudDienste/filen-cli
@@ -44963,7 +46335,7 @@ Properties:
<!-- autogenerated options stop -->
-# Files.com
+# Files.com
[Files.com](https://www.files.com/) is a cloud storage service that provides a
secure and easy way to store and share files.
@@ -45166,7 +46538,7 @@ Properties:
<!-- autogenerated options stop -->
-# FTP
+# FTP
FTP is the File Transfer Protocol. Rclone FTP support is provided using the
[github.com/jlaffaye/ftp](https://godoc.org/github.com/jlaffaye/ftp)
@@ -45781,7 +47153,7 @@ designating the remote time precision expressed as nanoseconds. A value of
`1000000000` means that file time precision of 1 second is available.
A value of `3153600000000000000` (or another large number) means "unsupported".
-# Gofile
+# Gofile
[Gofile](https://gofile.io) is a content storage and distribution
platform. Its aim is to provide as much service as possible for free
@@ -46049,7 +47421,7 @@ messages in the log about duplicates.
Use `rclone dedupe` to fix duplicated files.
-# Google Cloud Storage
+# Google Cloud Storage
Paths are specified as `remote:bucket` (or `remote:` for the `lsd`
command.) You may put subdirectories in too, e.g. `remote:bucket/path/to/dir`.
@@ -46889,7 +48261,7 @@ remote.
See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features)
and [rclone about](https://rclone.org/commands/rclone_about/).
-# Google Drive
+# Google Drive
Paths are specified as `drive:path`
@@ -48893,6 +50265,9 @@ Scroll down and click "+ Add users". Add yourself as a test user and press save.
10. Provide the noted client ID and client secret to rclone.
+11. Run the web-based authorization flow from within `rclone config`, by answering
+ "Y" when it asks "Already have a token - refresh?".
+
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
@@ -48915,7 +50290,7 @@ Drive API key can be created on the
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.
-# Google Photos
+# Google Photos
The rclone backend for [Google Photos](https://www.google.com/photos/about/) is
a specialized backend for transferring photos and videos to and from
@@ -49585,7 +50960,7 @@ https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata
https://www.googleapis.com/auth/photoslibrary.edit.appcreateddata
```
-# Hasher
+# Hasher
Hasher is a special overlay backend to create remotes which handle
checksums for other remotes. It's main functions include:
@@ -49962,7 +51337,515 @@ aliases into the `local` backend (unless encrypted or chunked) and stored
in `~/.cache/rclone/kv/local~hasher.bolt`.
Databases can be shared between multiple rclone processes.
-# HDFS
+# Huawei Drive
+
+Paths are specified as `huaweidrive:path`
+
+Huawei Drive paths may be as deep as required, e.g. `huaweidrive:directory/subdirectory`.
+
+## Configuration
+
+The initial setup for Huawei Drive involves getting a token from Huawei Drive
+which you need to do in your browser. `rclone config` walks you
+through it.
+
+Here is an example of how to make a remote called `remote`. First run:
+
+```sh
+rclone config
+```
+
+This will guide you through an interactive setup process:
+
+```text
+No remotes found, make a new one?
+n) New remote
+r) Rename remote
+c) Copy remote
+s) Set configuration password
+q) Quit config
+n/r/c/s/q> n
+name> remote
+Type of storage to configure.
+Choose a number from below, or type in your own value
+[snip]
+XX / Huawei Drive
+ \ "huaweidrive"
+[snip]
+Storage> huaweidrive
+OAuth Client Id - leave blank to use rclone's default.
+client_id>
+OAuth Client Secret - leave blank to use rclone's default.
+client_secret>
+Remote config
+Use web browser to automatically authenticate rclone with remote?
+ * Say Y if the machine running rclone has a web browser you can use
+ * Say N if running rclone on a (remote) machine without web browser access
+If not sure try Y. If Y failed, try N.
+y) Yes
+n) No
+y/n> y
+If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth
+Log in and authorize rclone for access
+Waiting for code...
+Got code
+Configuration complete.
+Options:
+- type: huaweidrive
+- client_id:
+- client_secret:
+- token: {"access_token":"XXX","token_type":"Bearer","refresh_token":"XXX","expiry":"2024-03-16T13:57:58.955387075Z"}
+Keep this "remote" remote?
+y) Yes this is OK
+e) Edit this remote
+d) Delete this remote
+y/e/d> y
+```
+
+See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a
+machine without an internet-connected web browser available.
+
+Note that rclone runs a webserver on your local machine to collect the
+token as returned from Huawei if using web browser to automatically
+authenticate. This only runs from the moment it opens your browser to the moment you get back
+the verification code. This is on `http://127.0.0.1:53682/` and it
+may require you to unblock it temporarily if you are running a host
+firewall, or use manual mode.
+
+You can then use it like this,
+
+List directories in top level of your drive
+
+```sh
+rclone lsd remote:
+```
+
+List all the files in your drive
+
+```sh
+rclone ls remote:
+```
+
+To copy a local directory to a drive directory called backup
+
+```sh
+rclone copy /home/source remote:backup
+```
+
+### Getting your own Client ID and Secret
+
+When you use rclone with Huawei 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 Huawei.
+
+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 a separate client ID for each service to avoid rate limiting issues.
+
+Here is how to create your own Huawei Drive client ID for rclone:
+
+Follow the detailed guides for complete setup instructions:
+
+- [Huawei HMS Core Web App Preparations](https://developer.huawei.com/consumer/cn/doc/HMSCore-Guides/web-preparations-0000001050050891)
+- [Huawei HMS Core Server Preparations](https://developer.huawei.com/consumer/cn/doc/HMSCore-Guides/server-preparations-0000001050185577#section194911701377)
+
+Rclone uses the web application access method to connect to Huawei Drive. Before starting, you need to implement quick login authorization through Huawei Account Open Service. With user authorization credentials, rclone can call Huawei Cloud Drive Service APIs.
+
+#### Create Server Application
+
+Before accessing Drive service, developers need to create a server application first. For details, please refer to the WEB Application Access Development Preparation section in the "Huawei Account Service Development Guide".
+
+#### Enable Drive Application Switch
+
+1. Log in to the AppGallery Connect website and click "My Projects".
+2. Find your project in the project list, select the application that needs to access Drive in the project, and click "API Management".
+3. In the "API Management" area of the "Project Settings" page, click the switch on the right side of Drive Kit to ensure the switch is in the open state.
+
+#### Sign Huawei Cloud Drive Privacy Notice and User Agreement
+
+Guide users to visit <https://cloud.huawei.com/>. First-time users need to sign the agreement before they can use Huawei Cloud Drive Service.
+
+#### Application Access to Obtain Authentication Credential Access Token
+
+Applications accessing Drive should use authentication credential Access Token. For specific acquisition methods, please refer to the WEB Application Access Development Guide section in the "Huawei Account Service Development Guide".
+
+Key steps summary:
+
+1. Log into the [Huawei Developer Console](https://developer.huawei.com/consumer/en/console) with your Huawei account.
+
+2. Create a new project or select an existing project.
+
+3. Go to "Manage APIs" and enable the "Drive Kit" API.
+
+4. Click on "Credentials" in the left side panel.
+
+5. Click "Create Credentials" and choose "OAuth client ID".
+
+6. Choose "Web application" as the application type.
+
+7. Add `http://localhost:53682/` to the "Authorized redirect URIs".
+
+8. Click "Create" and note down the Client ID and Client Secret.
+
+9. Provide the noted client ID and client secret to rclone during configuration.
+
+### Scopes
+
+Rclone uses the following OAuth2 scopes when accessing Huawei Drive:
+
+- `https://www.huawei.com/auth/drive` - Full access to Huawei Drive files (excluding application data folder)
+- `https://www.huawei.com/auth/drive.file` - Access to files created by the application
+- `openid` - OpenID Connect authentication
+- `profile` - Access to basic profile information
+
+The `drive.file` scope is included in the default set used by rclone.
+
+Alternative scopes available (not used by rclone by default):
+
+- `https://www.huawei.com/auth/drive.appdata` - Access to application data folder
+- `https://www.huawei.com/auth/drive.readonly` - Read-only access to file metadata and content
+- `https://www.huawei.com/auth/drive.metadata` - Read/write access to file metadata only
+- `https://www.huawei.com/auth/drive.metadata.readonly` - Read-only access to file metadata only
+
+The default scopes provide read/write access to all files in your Huawei Drive.
+
+### Modification times and hashes
+
+Huawei Drive does not support setting modification times. The API
+always uses server-side timestamps, so file modification times from
+the source are not preserved during upload. Modification times are
+available as read-only metadata (`mtime`, `btime`).
+
+Hash algorithm SHA256 is supported for file integrity verification.
+
+### Restricted filename characters
+
+Huawei Drive has strict restrictions on file and directory names:
+
+- Cannot contain: `< > | : " * ? / \` or emoji characters
+- Cannot be exactly `. ..`
+- Maximum length: 250 bytes
+- Single quotes must be escaped with `\'` in API calls
+
+These restrictions are handled by rclone's encoding:
+
+- Backslashes `\` are encoded
+- Invalid UTF-8 sequences are encoded
+- Right-side spaces are encoded
+
+Invalid characters will be [replaced](https://rclone.org/overview/#invalid-utf8) according to the encoding settings.
+
+### Resumable uploads
+
+Huawei Drive supports resumable uploads for files larger than the upload cutoff (default 20MB).
+Files are uploaded in chunks which allows for recovery from network interruptions.
+
+### File size limits
+
+The maximum file size for Huawei Drive is 50 GiB.
+
+### Quota information
+
+To view your current quota you can use the `rclone about remote:`
+command which will display your usage and quota information.
+
+<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/huaweidrive/huaweidrive.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
+### Standard options
+
+Here are the Standard options specific to huaweidrive (Huawei Drive).
+
+#### --huaweidrive-client-id
+
+OAuth Client Id.
+
+Leave blank normally.
+
+Properties:
+
+- Config: client_id
+- Env Var: RCLONE_HUAWEIDRIVE_CLIENT_ID
+- Type: string
+- Required: false
+
+#### --huaweidrive-client-secret
+
+OAuth Client Secret.
+
+Leave blank normally.
+
+Properties:
+
+- Config: client_secret
+- Env Var: RCLONE_HUAWEIDRIVE_CLIENT_SECRET
+- Type: string
+- Required: false
+
+### Advanced options
+
+Here are the Advanced options specific to huaweidrive (Huawei Drive).
+
+#### --huaweidrive-token
+
+OAuth Access Token as a JSON blob.
+
+Properties:
+
+- Config: token
+- Env Var: RCLONE_HUAWEIDRIVE_TOKEN
+- Type: string
+- Required: false
+
+#### --huaweidrive-auth-url
+
+Auth server URL.
+
+Leave blank to use the provider defaults.
+
+Properties:
+
+- Config: auth_url
+- Env Var: RCLONE_HUAWEIDRIVE_AUTH_URL
+- Type: string
+- Required: false
+
+#### --huaweidrive-token-url
+
+Token server url.
+
+Leave blank to use the provider defaults.
+
+Properties:
+
+- Config: token_url
+- Env Var: RCLONE_HUAWEIDRIVE_TOKEN_URL
+- Type: string
+- Required: false
+
+#### --huaweidrive-client-credentials
+
+Use client credentials OAuth flow.
+
+This will use the OAUTH2 client Credentials Flow as described in RFC 6749.
+
+Note that this option is NOT supported by all backends.
+
+Properties:
+
+- Config: client_credentials
+- Env Var: RCLONE_HUAWEIDRIVE_CLIENT_CREDENTIALS
+- Type: bool
+- Default: false
+
+#### --huaweidrive-root-folder-id
+
+ID of the root folder.
+
+Normally this is auto-detected, but if it fails or you want to speed up startup,
+you can set it manually.
+
+Leave blank normally.
+
+Properties:
+
+- Config: root_folder_id
+- Env Var: RCLONE_HUAWEIDRIVE_ROOT_FOLDER_ID
+- Type: string
+- Required: false
+
+#### --huaweidrive-chunk-size
+
+Upload chunk size.
+
+Must be a power of 2 >= 256k and <= 64MB.
+
+Properties:
+
+- Config: chunk_size
+- Env Var: RCLONE_HUAWEIDRIVE_CHUNK_SIZE
+- Type: SizeSuffix
+- Default: 8Mi
+
+#### --huaweidrive-list-chunk
+
+Size of listing chunk 1-1000.
+
+Properties:
+
+- Config: list_chunk
+- Env Var: RCLONE_HUAWEIDRIVE_LIST_CHUNK
+- Type: int
+- Default: 1000
+
+#### --huaweidrive-upload-cutoff
+
+Cutoff for switching to resumable upload.
+
+Any files larger than this will be uploaded using resumable upload.
+The minimum is 0 and the maximum is 20 MiB (Huawei Drive API limit for single request uploads).
+
+Properties:
+
+- Config: upload_cutoff
+- Env Var: RCLONE_HUAWEIDRIVE_UPLOAD_CUTOFF
+- Type: SizeSuffix
+- Default: 20Mi
+
+#### --huaweidrive-encoding
+
+The encoding for the backend.
+
+See the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info.
+
+Properties:
+
+- Config: encoding
+- Env Var: RCLONE_HUAWEIDRIVE_ENCODING
+- Type: Encoding
+- Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftSpace,LeftPeriod,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot
+
+#### --huaweidrive-description
+
+Description of the remote.
+
+Properties:
+
+- Config: description
+- Env Var: RCLONE_HUAWEIDRIVE_DESCRIPTION
+- Type: string
+- Required: false
+
+### Metadata
+
+Huawei Drive supports reading and writing custom metadata.
+
+User metadata can be set using the "properties" field in the API.
+System metadata includes standard file information such as:
+- content-type: MIME type of the object
+- description: User-provided description
+- favorite: Whether file is marked as favorite
+- btime/mtime/utime: Various timestamps
+- sha256: File hash
+- recycled/has-thumbnail: File status flags
+
+Custom metadata keys can be any string and will be stored in the file's properties.
+
+Here are the possible system metadata items for the huaweidrive backend.
+
+| Name | Help | Type | Example | Read Only |
+|------|------|------|---------|-----------|
+| btime | Time when the file was created (RFC 3339) | RFC 3339 | | **Y** |
+| content-type | MIME type of the object | string | | **Y** |
+| description | Description of the file | string | | N |
+| favorite | Whether the file is marked as favorite (true/false) | string | | N |
+| has-thumbnail | Whether the file has a thumbnail (true/false) | string | | **Y** |
+| mtime | Time when the file content was last modified (RFC 3339) | RFC 3339 | | **Y** |
+| recycled | Whether the file is in recycle bin (true/false) | string | | **Y** |
+| sha256 | SHA256 hash of the file | string | | **Y** |
+| utime | Time when the file was last edited by the current user (RFC 3339) | RFC 3339 | | **Y** |
+
+See the [metadata](https://rclone.org/docs/#metadata) docs for more info.
+
+<!-- autogenerated options stop -->
+
+## Limitations
+
+Huawei Drive has some rate limiting which may cause rclone to slow down transfers to avoid hitting the limits.
+
+### File name restrictions
+
+- File names cannot contain: `< > | : " * ? / \`
+- File names cannot be exactly `. ..`
+- Maximum file name length is 250 bytes
+- Some unicode characters including emojis are not supported
+
+### API rate limits
+
+Huawei Drive imposes API rate limits. Rclone automatically handles these by backing off when limits are hit.
+
+### OAuth2 token expiry
+
+- Access tokens expire after 1 hour
+- Refresh tokens expire after 180 days
+- Rclone will automatically refresh tokens as needed
+
+### File size limits
+
+- Maximum file size is 50 GiB
+- Files larger than this cannot be uploaded
+
+### Upload behavior
+
+- Files smaller than `upload_cutoff` (default 20MB) are uploaded in a single request using content or multipart method
+- Larger files are uploaded using resumable uploads with configurable chunk size
+- Maximum single chunk size for resumable uploads is 64MB
+- Resumable uploads support automatic retry on network errors
+- SHA256 hash verification is supported for uploaded files
+
+### Server-side operations
+
+- Server-side copy: Files can be copied within Huawei Drive without downloading and re-uploading
+- Server-side move: Files and directories can be moved/renamed on the server side
+- Directory move: Entire directories can be moved with a single API call
+
+### Directory operations
+
+- Huawei Drive supports creating empty directories
+- Recursive listing is supported via `--fast-list` for efficient directory traversal
+- Huawei Drive has a special "applicationData" folder for app-specific data (not accessible via rclone's default configuration)
+
+## Error handling
+
+Common errors and their meanings:
+
+- `401 Unauthorized`: Invalid credentials or expired token
+- `403 Forbidden`: Usually indicates insufficient permissions or API quota exceeded
+- `404 Not Found`: File or directory does not exist
+- `409 Conflict`: Directory already exists
+- `429 Too Many Requests`: API rate limit exceeded, rclone will automatically retry
+
+## Performance tuning
+
+For better performance:
+
+- Increase `--transfers` for concurrent operations (default is 4)
+- Adjust `chunk_size` based on your network speed and file sizes
+- Use `--fast-list` for operations on directories with many files to reduce API calls
+
+## Making backups
+
+Huawei Drive is suitable for backups with some considerations:
+
+- Use `rclone sync` rather than `rclone copy` to maintain exact directory structure
+- Consider using `--backup-dir` to preserve deleted files
+- Verify transfers with `--checksum` flag for critical data
+- Be aware of the 50 GiB file size limit for individual files
+
+## Supported features
+
+Huawei Drive supports the following rclone features:
+
+- `Copy` - Server-side copy of files
+- `Move` - Server-side move/rename of files
+- `DirMove` - Server-side move of directories
+- `ListR` - Recursive listing for `--fast-list`
+- `About` - Storage quota information
+- `Purge` - Delete directory and all contents
+- `CleanUp` - Empty the trash
+- `UserInfo` - Get user account information
+- `Metadata` - Read and write file metadata/properties
+- `ChangeNotify` - Poll for remote changes (used by `rclone mount` and `rclone rc vfs/poll-interval`)
+
+## Integration with other services
+
+Huawei Drive can be used as a backend for various rclone operations:
+
+- Mount as a local filesystem using `rclone mount`
+- Serve over HTTP using `rclone serve http`
+- Serve over FTP using `rclone serve ftp`
+- Serve over WebDAV using `rclone serve webdav`
+
+Note that some operations may be slower than local storage due to API limitations and network latency.
+
+# HDFS
[HDFS](https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-hdfs/HdfsDesign.html)
is a distributed file-system, part of the [Apache Hadoop](https://hadoop.apache.org/)
@@ -50219,7 +52102,7 @@ Properties:
- No server-side `Move` or `DirMove`.
- Checksums not implemented.
-# HiDrive
+# HiDrive
Paths are specified as `remote:path`
@@ -50700,7 +52583,7 @@ 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.
-# HTTP
+# HTTP
The HTTP remote is a read only remote for reading files of a
webserver. The webserver should provide file listings which rclone
@@ -51017,7 +52900,7 @@ remote.
See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features)
and [rclone about](https://rclone.org/commands/rclone_about/).
-# ImageKit
+# ImageKit
This is a backend for the [ImageKit.io](https://imagekit.io/) storage service.
@@ -51248,22 +53131,43 @@ See the [metadata](https://rclone.org/docs/#metadata) docs for more info.
<!-- autogenerated options stop -->
-# iCloud Drive
+# iCloud Drive and Photos
## Configuration
-The initial setup for an iCloud Drive backend involves getting a trust token/session.
-This can be done by simply using the regular iCloud password, and accepting the code
-prompt on another iCloud connected device.
+The initial setup for an iCloud backend involves getting a trust token/session.
+This uses your regular Apple ID password plus 2FA, either from a trusted
+device prompt or an SMS code sent to a trusted phone number.
+
+**IMPORTANT**: App-specific passwords are not accepted. Only use your
+regular Apple ID password and 2FA.
-**IMPORTANT**: At the moment an app specific password won't be accepted. Only
-use your regular password and 2FA.
+This backend serves two Apple services:
+
+- `drive` - iCloud Drive (default)
+- `photos` - iCloud Photos
`rclone config` walks you through the token creation. The trust token is valid
for 30 days. After which you will have to reauthenticate with `rclone reconnect`
or `rclone config`.
-Here is an example of how to make a remote called `iclouddrive`. First run:
+## Authentication
+
+rclone authenticates with Apple using [SRP (Secure Remote Password)](https://en.wikipedia.org/wiki/Secure_Remote_Password_protocol),
+the same protocol used by the iCloud web interface. Your password is never
+sent to Apple's servers -- instead, a cryptographic proof is exchanged that
+verifies you know the password without revealing it.
+
+The authentication flow is:
+
+1. rclone initiates a session with Apple's identity service
+2. An SRP key exchange takes place (your password is used locally to derive a key)
+3. Apple sends a 2FA prompt to your trusted devices, or lets you request an
+ SMS code
+4. After you enter the 2FA code, rclone receives a trust token for future sessions
+
+Here is an example of how to make a Photos remote called `icloudphotos`.
+For iCloud Drive, leave `service` at its default `drive` value. First run:
```console
rclone config
@@ -51277,7 +53181,7 @@ n) New remote
s) Set configuration password
q) Quit config
n/s/q> n
-name> iclouddrive
+name> icloudphotos
Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
@@ -51286,6 +53190,15 @@ XX / iCloud Drive
\ (iclouddrive)
[snip]
Storage> iclouddrive
+Option service.
+iCloud service to use.
+Choose a number from below, or type in your own value of type string.
+Press Enter for the default (drive).
+ 1 / iCloud Drive
+ \ (drive)
+ 2 / iCloud Photos
+ \ (photos)
+service> 2
Option apple_id.
Apple ID.
Enter a value.
@@ -51305,13 +53218,14 @@ y) Yes
n) No (default)
y/n> n
Option config_2fa.
-Two-factor authentication: please enter your 2FA code
+Two-factor authentication: enter your 2FA code or type 'sms' for a text message
Enter a value.
config_2fa> 2FACODE
Remote config
--------------------
-[iclouddrive]
+[icloudphotos]
- type: iclouddrive
+- service: photos
- apple_id: APPLEID
- password: *** ENCRYPTED ***
- cookies: ****************************
@@ -51323,35 +53237,145 @@ d) Delete this remote
y/e/d> y
```
+## iCloud Photos
+
+The iCloud Drive backend also supports accessing iCloud Photos by setting the
+`service` option to `photos`:
+
+```console
+rclone lsd iclouddrive: --iclouddrive-service photos
+```
+
+This presents a read-only hierarchy rooted at photo libraries:
+
+- **Level 1**: Photo libraries — your personal library (`PrimarySync`) and
+ any Shared Photo Library (`SharedSync-XXXX`)
+- **Level 2+**: Albums and folders within a library, nested recursively as in
+ Apple Photos
+- **Leaf level**: Photos/videos within an album, including Live Photo `.MOV`
+ companions
+
+Examples:
+
+```console
+# List libraries
+rclone lsd iclouddrive: --iclouddrive-service photos
+
+# List albums in your primary library
+rclone lsd iclouddrive:PrimarySync/ --iclouddrive-service photos
+
+# List photos in an album
+rclone ls iclouddrive:PrimarySync/All\ Photos/ --iclouddrive-service photos
+
+# Download a photo
+rclone copy iclouddrive:PrimarySync/Favorites/IMG_0001.HEIC /tmp/ --iclouddrive-service photos
+```
+
+You can either:
+
+- set `service = photos` in `rclone config` for a dedicated Photos remote
+- keep `service = drive` and pass `--iclouddrive-service photos` when needed
+
+### Metadata
+
+With `--metadata`, Photos entries expose these read-only metadata keys:
+
+- `width`
+- `height`
+- `added-time`
+- `favorite`
+- `hidden`
+
+These metadata keys are only available when `service = photos`.
+
+### Caching
+
+iCloud Photos caches album listings to disk for fast subsequent access.
+On the first run, listing a large album uses parallel `startRank`
+partitions to fetch pages concurrently. After that, a lightweight change
+check (~200ms) determines whether the cache is still valid.
+
+Cache location: `~/.cache/rclone/iclouddrive-photos/<remote>/<zone>/`
+
+To clear the cache: delete that directory or run `rclone config reconnect`.
+
+### FUSE mounts
+
+For mounting iCloud Photos via `rclone mount`, the following flags
+are recommended:
+
+ rclone mount remote: /mnt/photos \
+ --iclouddrive-service photos \
+ --vfs-refresh \
+ --dir-cache-time 1h \
+ --vfs-cache-mode full \
+ --attr-timeout 1m \
+ --read-only
+
+- `--vfs-refresh` pre-warms directory caches in the background on mount
+ start so that albums are ready when you browse them
+- `--dir-cache-time 1h` extends the in-memory cache lifetime beyond the
+ default 5 minutes (change detection is fast, so this is safe)
+- `--vfs-cache-mode full` caches downloaded photos and videos to local
+ disk for fast repeated access
+- `--attr-timeout 1m` reduces kernel attribute lookups (safe because
+ the backend is read-only)
+- `--read-only` prevents confusing write errors
+
+The first listing of a very large album (e.g. 75,000 items in "All
+Photos") can take several minutes due to API pagination limits. This
+happens once — subsequent listings use the disk cache.
+
+### Limitations
+
+iCloud Photos is read-only. Upload, delete, rename, and move operations
+are not supported.
+
## Advanced Data Protection
-ADP is currently unsupported and need to be disabled
+Advanced Data Protection is supported.
On iPhone, Settings `>` Apple Account `>` iCloud `>` 'Access iCloud Data on the Web'
-must be ON, and 'Advanced Data Protection' OFF.
+must be ON.
+
+If ADP is enabled on your account, rclone requests PCS cookies after 2FA.
+Apple may require approval on a trusted device before those cookies are issued.
## Troubleshooting
-### Missing PCS cookies from the request
+### PCS cookie errors with ADP
-This means you have Advanced Data Protection (ADP) turned on. This is not supported
-at the moment. If you want to use rclone you will have to turn it off. See above
-for how to turn it off.
+If you see `Missing PCS cookies from the request` or a `requestPCS:` error,
+the ADP approval flow did not complete successfully.
-You will need to clear the `cookies` and the `trust_token` fields in the config.
-Or you can delete the remote config and start again.
+Check that 'Access iCloud Data on the Web' is enabled and approve any prompt
+on your trusted device.
-You should then run `rclone reconnect remote:`.
+Then run `rclone reconnect remote:`.
-Note that changing the ADP setting may not take effect immediately - you may
-need to wait a few hours or a day before you can get rclone to work - keep
-clearing the config entry and running `rclone reconnect remote:` until rclone
-functions properly.
+If the remote still has stale auth state, clear the `cookies` and
+`trust_token` fields in the config, or delete and recreate the remote.
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/iclouddrive/iclouddrive.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options
-Here are the Standard options specific to iclouddrive (iCloud Drive).
+Here are the Standard options specific to iclouddrive (iCloud Drive and Photos).
+
+#### --iclouddrive-service
+
+iCloud service to use.
+
+Properties:
+
+- Config: service
+- Env Var: RCLONE_ICLOUDDRIVE_SERVICE
+- Type: string
+- Default: "drive"
+- Examples:
+ - "drive"
+ - iCloud Drive
+ - "photos"
+ - iCloud Photos
#### --iclouddrive-apple-id
@@ -51379,7 +53403,7 @@ Properties:
#### --iclouddrive-trust-token
-Trust token (internal use)
+Trust token for session authentication.
Properties:
@@ -51390,7 +53414,7 @@ Properties:
#### --iclouddrive-cookies
-cookies (internal use only)
+Session cookies.
Properties:
@@ -51401,11 +53425,11 @@ Properties:
### Advanced options
-Here are the Advanced options specific to iclouddrive (iCloud Drive).
+Here are the Advanced options specific to iclouddrive (iCloud Drive and Photos).
#### --iclouddrive-client-id
-Client id
+Client ID for iCloud API access.
Properties:
@@ -51438,9 +53462,25 @@ Properties:
- Type: string
- Required: false
+### Metadata
+
+Metadata is read-only and available for the Photos service only.
+
+Here are the possible system metadata items for the iclouddrive backend.
+
+| Name | Help | Type | Example | Read Only |
+|------|------|------|---------|-----------|
+| added-time | Time the item was added to the iCloud library | RFC 3339 | 2006-01-02T15:04:05Z | **Y** |
+| favorite | Whether the item is marked as favorite | bool | | **Y** |
+| height | Image height in pixels | int | | **Y** |
+| hidden | Whether the item is hidden | bool | | **Y** |
+| width | Image width in pixels | int | | **Y** |
+
+See the [metadata](https://rclone.org/docs/#metadata) docs for more info.
+
<!-- autogenerated options stop -->
-# Internet Archive
+# Internet Archive
The Internet Archive backend utilizes Items on [archive.org](https://archive.org/)
@@ -51789,7 +53829,7 @@ See the [metadata](https://rclone.org/docs/#metadata) docs for more info.
<!-- autogenerated options stop -->
-# Internxt Drive
+# Internxt Drive
[Internxt Drive](https://internxt.com) is a zero-knowledge encrypted cloud storage service.
@@ -51946,6 +53986,50 @@ Properties:
- Type: bool
- Default: true
+#### --internxt-upload-concurrency
+
+Concurrency for multipart uploads.
+
+This is the number of chunks of the same file that are uploaded concurrently.
+
+Note that each chunk is buffered in memory.
+
+Properties:
+
+- Config: upload_concurrency
+- Env Var: RCLONE_INTERNXT_UPLOAD_CONCURRENCY
+- Type: int
+- Default: 4
+
+#### --internxt-upload-cutoff
+
+Cutoff for switching to multipart upload.
+
+Any files larger than this will be uploaded in chunks of chunk_size.
+The minimum is 100 MiB and the maximum is 5 GiB.
+
+Properties:
+
+- Config: upload_cutoff
+- Env Var: RCLONE_INTERNXT_UPLOAD_CUTOFF
+- Type: SizeSuffix
+- Default: 100Mi
+
+#### --internxt-chunk-size
+
+Chunk size for multipart uploads.
+
+Files larger than upload_cutoff will be uploaded in chunks of this size.
+
+Memory usage is approximately chunk_size * upload_concurrency.
+
+Properties:
+
+- Config: chunk_size
+- Env Var: RCLONE_INTERNXT_CHUNK_SIZE
+- Type: SizeSuffix
+- Default: 30Mi
+
#### --internxt-encoding
The encoding for the backend.
@@ -51972,7 +54056,7 @@ Properties:
<!-- autogenerated options stop -->
-# Jottacloud
+# Jottacloud
Jottacloud is a cloud storage service provider from a Norwegian company, using
its own datacenters in Norway.
@@ -51980,7 +54064,7 @@ its own datacenters in Norway.
In addition to the official service at [jottacloud.com](https://www.jottacloud.com/),
it also provides white-label solutions to different companies. The following
are currently supported by this backend, using a different authentication setup
-as described [below](#whitelabel-authentication):
+as described [below](#traditional):
- Elkjøp (with subsidiaries):
- Elkjøp Cloud (cloud.elkjop.no)
@@ -52339,6 +54423,7 @@ the following characters are also replaced:
| > | 0x3E | > |
| ? | 0x3F | ? |
| \| | 0x7C | | |
+| % | 0x25 | % |
Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8),
as they can't be used in XML strings.
@@ -52522,7 +54607,7 @@ Properties:
- Config: encoding
- Env Var: RCLONE_JOTTACLOUD_ENCODING
- Type: Encoding
-- Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot
+- Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Percent,Del,Ctl,InvalidUtf8,Dot
#### --jottacloud-description
@@ -52569,7 +54654,7 @@ 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.
-# Koofr
+# Koofr
Paths are specified as `remote:path`
@@ -52958,7 +55043,7 @@ d) Delete this remote
y/e/d> y
```
-# Linkbox
+# Linkbox
Linkbox is [a private cloud drive](https://linkbox.to/).
@@ -52966,6 +55051,17 @@ Linkbox is [a private cloud drive](https://linkbox.to/).
Here is an example of making a remote for Linkbox.
+You will need:
+- An API token from https://www.linkbox.to/admin/account
+- The email and password for your Linkbox account
+
+**Note:** As of v1.74, email and password are required in addition to
+the API token. The API token is used for uploads and modifications,
+while email/password authentication is used for listing and
+downloading files. If you have an existing Linkbox remote, you will
+need to reconfigure it with `rclone config` to edit the remote and add
+the email and password.
+
First run:
```console
@@ -52994,12 +55090,24 @@ Storage> XX
Option token.
Token from https://www.linkbox.to/admin/account
Enter a value.
-token> testFromCLToken
+token> YOUR_API_TOKEN
+
+Option email.
+Email for login
+Enter a value.
+
+Option password.
+Password for login
+Enter a value.
+password> YOUR_PASSWORD
Configuration complete.
Options:
- type: linkbox
- token: XXXXXXXXXXX
+- password: *** ENCRYPTED ***
Keep this "linkbox" remote?
y) Yes this is OK (default)
e) Edit this remote
@@ -53024,6 +55132,41 @@ Properties:
- Type: string
- Required: true
+#### --linkbox-email
+
+Email for login
+
+Properties:
+
+- Config: email
+- Env Var: RCLONE_LINKBOX_EMAIL
+- Type: string
+- Required: true
+
+#### --linkbox-password
+
+Password for login
+
+**NB** Input to this must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/).
+
+Properties:
+
+- Config: password
+- Env Var: RCLONE_LINKBOX_PASSWORD
+- Type: string
+- Required: true
+
+#### --linkbox-web-token
+
+Web API login token - set automatically.
+
+Properties:
+
+- Config: web_token
+- Env Var: RCLONE_LINKBOX_WEB_TOKEN
+- Type: string
+- Required: false
+
### Advanced options
Here are the Advanced options specific to linkbox (Linkbox).
@@ -53046,7 +55189,7 @@ Properties:
Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8),
as they can't be used in JSON strings.
-# Mail.ru Cloud
+# Mail.ru Cloud
[Mail.ru Cloud](https://cloud.mail.ru/) is a cloud storage provided by a
Russian internet company [Mail.Ru Group](https://mail.ru). The official
@@ -53510,7 +55653,7 @@ site for the total uploaded size limits.
Note that Mailru is case insensitive so you can't have a file called
"Hello.doc" and one called "hello.doc".
-# Mega
+# Mega
[Mega](https://mega.nz/) is a cloud storage and file hosting service
known for its security feature where all files are encrypted locally
@@ -53865,7 +56008,7 @@ source code so there are likely quite a few errors still remaining in this libra
Mega allows duplicate files which may confuse rclone.
-# Memory
+# Memory
The memory backend is an in RAM backend. It does not persist its
data - use the local backend for that.
@@ -53968,7 +56111,7 @@ Properties:
<!-- autogenerated options stop -->
-# Akamai NetStorage
+# Akamai NetStorage
Paths are specified as `remote:`
You may put subdirectories in too, e.g. `remote:/path/to/dir`.
@@ -54333,7 +56476,7 @@ rclone backend symlink <src> <path>
<!-- autogenerated options stop -->
-# Microsoft Azure Blob Storage
+# Microsoft Azure Blob Storage
Paths are specified as `remote:container` (or `remote:` for the `lsd`
command.) You may put subdirectories in too, e.g.
@@ -54685,18 +56828,18 @@ be explicitly specified using exactly one of the `msi_object_id`,
If none of `msi_object_id`, `msi_client_id`, or `msi_mi_res_id` is
set, this is is equivalent to using `env_auth`.
-#### Fedrated Identity Credentials
+#### Federated Identity Credentials
-If these variables are set, rclone will authenticate with fedrated identity.
+If these variables are set, rclone will authenticate with federated identity.
-- `tenant_id`: tenant_id to authenticate in storage
+- `tenant`: tenant ID of of the storage
- `client_id`: client ID of the application the user will authenticate to storage
- `msi_client_id`: managed identity client ID of the application the user will
authenticate to
By default "api://AzureADTokenExchange" is used as scope for token retrieval
over MSI. This token is then exchanged for actual storage token using
-'tenant_id' and 'client_id'.
+'tenant' and 'client_id'.
#### Azure CLI tool `az` {#use_az}
@@ -55174,6 +57317,22 @@ Properties:
- Type: int
- Default: 512
+#### --azureblob-copy-total-concurrency
+
+Global concurrency limit for multipart copy chunks.
+
+This limits the total number of multipart copy chunks running at once
+across all files.
+
+Set to 0 to disable this limiter.
+
+Properties:
+
+- Config: copy_total_concurrency
+- Env Var: RCLONE_AZUREBLOB_COPY_TOTAL_CONCURRENCY
+- Type: int
+- Default: 0
+
#### --azureblob-use-copy-blob
Whether to use the Copy Blob API when copying to the same storage account.
@@ -55392,6 +57551,25 @@ Properties:
- "only"
- Specify 'only' to remove only the snapshots but keep the root blob.
+#### --azureblob-decompress
+
+If set this will decompress gzip encoded objects.
+
+It is possible to upload objects to Azure Blob Storage with "Content-Encoding: gzip"
+set. Normally rclone will download these files as compressed objects.
+
+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.
+
+
+Properties:
+
+- Config: decompress
+- Env Var: RCLONE_AZUREBLOB_DECOMPRESS
+- Type: bool
+- Default: false
+
#### --azureblob-description
Description of the remote.
@@ -55467,7 +57645,7 @@ advanced settings, setting it to
`http(s)://<host>:<port>/devstoreaccount1`
(e.g. `http://10.254.2.5:10000/devstoreaccount1`).
-# Microsoft Azure Files Storage
+# Microsoft Azure Files Storage
Paths are specified as `remote:` You may put subdirectories in too,
e.g. `remote:path/to/dir`.
@@ -55790,18 +57968,18 @@ be explicitly specified using exactly one of the `msi_object_id`,
If none of `msi_object_id`, `msi_client_id`, or `msi_mi_res_id` is
set, this is is equivalent to using `env_auth`.
-#### Fedrated Identity Credentials
+#### Federated Identity Credentials
-If these variables are set, rclone will authenticate with fedrated identity.
+If these variables are set, rclone will authenticate with federated identity.
-- `tenant_id`: tenant_id to authenticate in storage
+- `tenant`: tenant ID of of the storage
- `client_id`: client ID of the application the user will authenticate to storage
- `msi_client_id`: managed identity client ID of the application the user will
authenticate to
By default "api://AzureADTokenExchange" is used as scope for token retrieval
-over MSI. This token is then exchanged for actual storage token using 'tenant_id'
-and 'client_id'.
+over MSI. This token is then exchanged for actual storage token using
+'tenant' and 'client_id'.
#### Azure CLI tool `az` {#use_az}
@@ -56295,7 +58473,7 @@ Eg `--header-upload "Content-Type: text/potato"`
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.
-# Microsoft OneDrive
+# Microsoft OneDrive
Paths are specified as `remote:path`
@@ -57611,7 +59789,7 @@ INFO : 20230203_123826234_iOS.heic: vfs cache: downloader: error count now 1: v
ERROR : 20230203_123826234_iOS.heic: vfs cache: failed to download: vfs reader: failed to write to cache file: 416 Requested Range Not Satisfiable:
```
-# OpenDrive
+# OpenDrive
Paths are specified as `remote:path`
@@ -57827,7 +60005,7 @@ remote.
See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features)
and [rclone about](https://rclone.org/commands/rclone_about/).
-# Oracle Object Storage
+# Oracle Object Storage
Object Storage provided by the Oracle Cloud Infrastructure (OCI).
Read more at <oracle.com>:
@@ -58752,7 +60930,7 @@ Default is 24 hrs.
### [Mounting Buckets](https://rclone.org/oracleobjectstorage/tutorial_mount/)
-# QingStor
+# QingStor
Paths are specified as `remote:bucket` (or `remote:` for the `lsd`
command.) You may put subdirectories in too, e.g. `remote:bucket/path/to/dir`.
@@ -59092,7 +61270,7 @@ remote.
See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features)
and [rclone about](https://rclone.org/commands/rclone_about/).
-# Quatrix
+# Quatrix
Quatrix by Maytech is [Quatrix Secure Compliant File Sharing | Maytech](https://www.maytech.net/products/quatrix-business).
@@ -59381,7 +61559,7 @@ increasing the quota.
Quatrix supports server-side operations (copy and move). In case of conflict,
files are overwritten during server-side operation.
-# Sia
+# Sia
Sia ([sia.tech](https://sia.tech/)) is a decentralized cloud storage platform
based on the [blockchain](https://wikipedia.org/wiki/Blockchain) technology.
@@ -59597,7 +61775,7 @@ Properties:
signs in file names. rclone will transparently [encode](https://rclone.org/overview/#encoding)
them for you, but you'd better be aware
-# Swift
+# Swift
Swift refers to [OpenStack Object Storage](https://docs.openstack.org/swift/latest/).
Commercial implementations of that being:
@@ -60335,7 +62513,7 @@ end of the output with a message like the following:
Rclone will wait for the time specified then retry the copy.
-# pCloud
+# pCloud
Paths are specified as `remote:path`
@@ -60702,7 +62880,7 @@ Properties:
<!-- autogenerated options stop -->
-# PikPak
+# PikPak
PikPak is [a private cloud drive](https://mypikpak.com/).
@@ -61015,15 +63193,20 @@ rclone backend addurl remote: [options] [<arguments>+]
This command adds offline download task for url.
-Usage example:
+Usage examples:
```console
rclone backend addurl pikpak:dirpath url
+rclone backend addurl pikpak:dirpath url -o name=custom_filename.zip
```
Downloads will be stored in 'dirpath'. If 'dirpath' is invalid,
download will fallback to default 'My Pack' folder.
+Options:
+
+- "name": Custom filename for the downloaded file.
+
### decompress
Request decompress of a file/files in a folder.
@@ -61069,7 +63252,7 @@ PikPak supports MD5 hash, but sometimes given empty especially for user-uploaded
Deleted files will still be visible with `--pikpak-trashed-only` even after the
trash emptied. This goes away after few days.
-# Pixeldrain
+# Pixeldrain
This is the backend for Pixeldrain's premium filesystem feature. This is not the
same as pixeldrain's free file sharing product. The filesystem requires either a
@@ -61245,7 +63428,7 @@ See the [metadata](https://rclone.org/docs/#metadata) docs for more info.
<!-- autogenerated options stop -->
-# premiumize.me
+# premiumize.me
Paths are specified as `remote:path`
@@ -61492,7 +63675,7 @@ rclone maps these to and from an identical looking unicode equivalents
premiumize.me only supports filenames up to 255 characters in length.
-# Proton Drive
+# Proton Drive
[Proton Drive](https://proton.me/drive) is an end-to-end encrypted Swiss vault
for your files that protects your data.
@@ -61784,16 +63967,18 @@ Properties:
The app version string
-The app version string indicates the client that is currently performing
-the API request. This information is required and will be sent with every
-API request.
+ The app version string identifies the client that is currently performing
+ the API request. Third-party Proton Drive integrations should use the form
+ external-drive-<project>@<version>. If this option is left empty, rclone
+ derives a compliant value from its own version. This value is sent with
+ every API request; the option itself is optional.
Properties:
- Config: app_version
- Env Var: RCLONE_PROTONDRIVE_APP_VERSION
- Type: string
-- Default: "[email protected]+rclone"
+- Required: false
#### --protondrive-replace-existing-draft
@@ -61883,7 +64068,7 @@ developers to implement features for other software on top of this codebase.
There are likely quite a few errors in this library, as there isn't official
documentation available.
-# put.io
+# put.io
Paths are specified as `remote:path`
@@ -62123,7 +64308,7 @@ If you want to avoid ever hitting these limits, you may use the
`--tpslimit` flag with a low number. Note that the imposed limits
may be different for different operations, and may change over time.
-# Proton Drive
+# Proton Drive
[Proton Drive](https://proton.me/drive) is an end-to-end encrypted Swiss vault
for your files that protects your data.
@@ -62415,16 +64600,18 @@ Properties:
The app version string
-The app version string indicates the client that is currently performing
-the API request. This information is required and will be sent with every
-API request.
+ The app version string identifies the client that is currently performing
+ the API request. Third-party Proton Drive integrations should use the form
+ external-drive-<project>@<version>. If this option is left empty, rclone
+ derives a compliant value from its own version. This value is sent with
+ every API request; the option itself is optional.
Properties:
- Config: app_version
- Env Var: RCLONE_PROTONDRIVE_APP_VERSION
- Type: string
-- Default: "[email protected]+rclone"
+- Required: false
#### --protondrive-replace-existing-draft
@@ -62514,7 +64701,7 @@ developers to implement features for other software on top of this codebase.
There are likely quite a few errors in this library, as there isn't official
documentation available.
-# Seafile
+# Seafile
This is a backend for the [Seafile](https://www.seafile.com/) storage service:
@@ -62940,7 +65127,7 @@ Properties:
<!-- autogenerated options stop -->
-# SFTP
+# SFTP
SFTP is the [Secure (or SSH) File Transfer
Protocol](https://en.wikipedia.org/wiki/SSH_File_Transfer_Protocol).
@@ -64211,7 +66398,7 @@ Hetzner Storage Boxes are supported through the SFTP backend on port 23.
See [Hetzner's documentation for details](https://docs.hetzner.com/robot/storage-box/access/access-ssh-rsync-borg#rclone)
-# Shade
+# Shade
This is a backend for the [Shade](https://shade.inc/) platform
@@ -64472,7 +66659,7 @@ info on how to pass options and arguments.
These can be run on a running backend using the rc command
[backend/command](https://rclone.org/rc/#backend-command).
-# SMB
+# SMB
SMB is [a communication protocol to share files over network](https://en.wikipedia.org/wiki/Server_Message_Block).
@@ -64775,7 +66962,7 @@ Properties:
<!-- autogenerated options stop -->
-# Storj
+# Storj
[Storj](https://storj.io) is redefining the cloud to support the
future of data—sustainably and economically. Storj leverages the vast
@@ -65270,7 +67457,7 @@ e.g. `$HOME/.bashrc`, or change the system-wide configuration,
usually `/etc/sysctl.conf` and/or `/etc/security/limits.conf`, but please
refer to your operating system manual.
-# SugarSync
+# SugarSync
[SugarSync](https://sugarsync.com) is a cloud service that enables
active synchronization of files across computers and other devices for
@@ -65569,7 +67756,7 @@ remote.
See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features)
and [rclone about](https://rclone.org/commands/rclone_about/).
-# Uloz.to
+# Uloz.to
Paths are specified as `remote:path`
@@ -65846,7 +68033,7 @@ as a member of an rclone union remote.
See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features)
and [rclone about](https://rclone.org/commands/rclone_about/).
-# Union
+# Union
The `union` backend joins several remotes together to make a single unified view
of them.
@@ -66176,7 +68363,7 @@ See the [metadata](https://rclone.org/docs/#metadata) docs for more info.
<!-- autogenerated options stop -->
-# WebDAV
+# WebDAV
Paths are specified as `remote:path`
@@ -66735,7 +68922,7 @@ vendor = other
bearer_token_command = oidc-token XDC
```
-# Yandex Disk
+# Yandex Disk
[Yandex Disk](https://disk.yandex.com) is a cloud storage solution created by [Yandex](https://yandex.com).
@@ -67012,7 +69199,7 @@ complete any actions.
[403 - DiskUnsupportedUserAccountTypeError] User account type is not supported.
```
-# Zoho Workdrive
+# Zoho Workdrive
[Zoho WorkDrive](https://www.zoho.com/workdrive/) is a cloud storage solution
created by [Zoho](https://zoho.com).
@@ -67311,7 +69498,7 @@ other regions.
The client id and client secret can now be used with rclone.
-# Local Filesystem
+# Local Filesystem
Local paths are specified as normal filesystem paths, e.g. `/path/to/wherever`, so
@@ -67369,7 +69556,7 @@ handling file names.
| / | 0x2F | / |
When running on Windows the following characters are replaced. This
-list is based on the [Windows file naming conventions](https://docs.microsoft.com/de-de/windows/desktop/FileIO/naming-a-file#naming-conventions).
+list is based on the [Windows file naming conventions](https://docs.microsoft.com/windows/desktop/FileIO/naming-a-file#naming-conventions).
| Character | Value | Replacement |
| --------- |:-----:|:-----------:|
@@ -68058,6 +70245,250 @@ Options:
# Changelog
+## v1.74.0 - 2026-05-01
+
+[See commits](https://github.com/rclone/rclone/compare/v1.73.0...v1.74.0)
+
+- New backends
+ - [Huawei Drive](https://rclone.org/huaweidrive/) (王一赫)
+ - [iCloud Photos](https://rclone.org/iclouddrive/#icloud-photos) (read only) (Yakov Till)
+ - New S3 providers
+ - [Fastly Object Storage](https://rclone.org/s3/#fastly) (Leon Brocard)
+ - [HCP](https://rclone.org/s3/#hcp) (Chris)
+ - [Impossible Cloud](https://rclone.org/s3/#impossible-cloud) (Nick Craig-Wood)
+ - [UCloud US3](https://rclone.org/s3/#us3) (jinkeyuu)
+ - [Zadara](https://rclone.org/s3/#zadara) (Shlomi Avihou)
+- New commands
+ - [gui](https://rclone.org/gui/): launch new embedded web based GUI for basic rclone operations (FTCHD, Nick Craig-Wood)
+- New Features
+ - build
+ - Update `golang.org/x/image/webp` to v0.39.0 to fix CVE-2026-33813 (Nick Craig-Wood)
+ - Bump `github.com/Azure/go-ntlmssp` to 0.1.1 to fix CVE-2026-32952 (dependabot[bot])
+ - Update to go1.26 and make go1.25 the minimum required version (Nick Craig-Wood)
+ - Update all dependencies (Nick Craig-Wood)
+ - Modernize Go code with go fix for go1.25 (Nick Craig-Wood)
+ - Fix `loong64` and `s390x` build (Suyun)
+ - docs
+ - Modernize rclone.org site design (Nick Craig-Wood)
+ - fixes (albertony, Enduriel, Jason, Luke Cyca, mathieulongtin, Nick Craig-Wood, SyoBoN)
+ - fshttp: Add `--dump curl` for dumping HTTP requests as curl commands (Nick Craig-Wood)
+ - graphics: Optimise images losslessly with ImageOptim (Leon Brocard)
+ - listremotes: Add `--exact` flag for filtering (Anton Bordwine)
+ - rc
+ - Flip auth default so all endpoints require auth unless opted out (Nick Craig-Wood)
+ - Add `core/disks` to enumerate attached disks (Nick Craig-Wood)
+ - Add `deletedDirs` stat to `core/stats` help output (Billy Hughes)
+ - serve http
+ - Add fallback embedded favicon (Leon Brocard)
+ - Add gzip compression for text responses (Leon Brocard)
+ - Dark mode for file browser (FTCHD)
+ - Add HTTP/2 cleartext support for all http servers (TheBabu)
+ - touch: Add metadata when using `--metadata-set` (Prakhar Chhalotre)
+- Bug Fixes
+ - accounting
+ - Update String method output format for clarity in transfer rate representation (Prakhar Chhalotre)
+ - Fix `rcat`/`copyurl` for `files.com` (Nick Craig-Wood)
+ - bisync
+ - Add missing rc params (nielash)
+ - Add more structured info to rc output (nielash)
+ - Auto-generate rc help docs (nielash)
+ - Fix handling of unreadable lockfiles (lif)
+ - Fix flaky TestBisyncConcurrent by increasing random name entropy (Nick Craig-Wood)
+ - Fix integration tests after sftp log changes (Nick Craig-Wood)
+ - copyurl: Fix ignored `--upload-headers` and `--download-headers` (Andriy Senyshyn)
+ - librclone/ctest: Add Windows support and fix memory management (BizaNator)
+ - log: Fix data race on OutputHandler.format field (Nick Craig-Wood)
+ - operations
+ - Multithread copy: grab memory before making go routines (Nick Craig-Wood)
+ - serve dlna: Fix Samsung TV compatibility (Nick Craig-Wood)
+ - serve nfs: Fix EOF flag in READ response not being set when read reaches end of file (Nick Craig-Wood)
+- Mount
+ - rc: fix mounts created with mountPoint "*" overwriting each other (Nick Craig-Wood)
+- VFS
+ - Fix slow `nfs serve` by adding `--vfs-handle-caching` (Nick Craig-Wood)
+ - Add context parameter to New() for config propagation (Nick Craig-Wood)
+ - Replace `context.TODO`/`Background` with stored VFS context (Nick Craig-Wood)
+- Local
+ - Remove fadvise calls that cause spinlock contention (Patrick Farrell)
+- Azure Blob
+ - Add `--azureblob-copy-total-concurrency` to limit total multipart copy concurrency (Duncan F)
+ - Add server side copy real time accounting (Nick Craig-Wood)
+ - Add `--azureblob-decompress` flag to download gzip-encoded files (Nick Craig-Wood)
+- Azurefiles
+ - Fix missing `x-ms-file-request-intent` header with OAuth (Nick Craig-Wood)
+- B2
+ - Add server side copy real time accounting (Nick Craig-Wood)
+- Drime
+ - Implement About (Cohinem)
+ - Fix listings of large directories (John Volk)
+- Drive
+ - Add integration test for handling folder names with single quotes (Prakhar Chhalotre)
+- Filelu
+ - Add multipart init response type (kingston125)
+ - Migrate API calls to `lib/rest` (kingston125)
+- Filen
+ - Make multi-threaded upload chunks individually retryable (Enduriel)
+- Iclouddrive
+ - Replace plaintext signin with SRP authentication (Mike GIllan)
+ - Use dynamic origin for SRP auth headers (Xiangzhe)
+ - Lowercase Apple ID for SRP authentication (Mike GIllan)
+ - Add read only iCloud Photos support and SRP authentication (Yakov Till)
+- Internxt
+ - Implement multi-part uploads (José Zúniga)
+- Jottacloud
+ - Add encoding of percent character to default backend encoding (albertony)
+- Linkbox
+ - Fix downloading files by using web API (Nick Craig-Wood)
+- Mega
+ - Fix crash when logging in with previous auth keys fails (Andrew Gunnerson)
+- Pcloud
+ - Fix recursive listing from the root (Nick Craig-Wood)
+- Pikpak
+ - Support custom filenames for addurl backend command (wiserain)
+- Protondrive
+ - Align backend with newer Proton SDK stack (tdawe)
+ - Update to latest go-proton-api to use new host (dlaumen)
+ - Fix server-side moveto and DirMove against current API (Nick Craig-Wood)
+- S3
+ - Add Fastly Object Storage provider (Leon Brocard)
+ - Add HCP provider and `list_versions_oldest_first` quirk (Chris)
+ - Add Impossible Cloud as a new S3 provider (Nick Craig-Wood)
+ - Add UCloud Object Storage provider (#9230) (jinkeyuu)
+ - Add Zadara Object Storage provider (Shlomi Avihou)
+ - Remove StackPath Object Storage provider (Leon Brocard)
+ - Add server side copy real time accounting (Nick Craig-Wood)
+ - Add OVHcloud storage classes (Bjoern Franke)
+ - Add Object Lock support (Chris)
+ - Add new Fastly Object Storage regions (Leon Brocard)
+ - Scaleway: ONEZONE_IA is available in all zones, GLACIER only in FR-PAR (Bjoern Franke)
+ - Ionos: updated regions & endpoints (hxnd)
+ - IBM COS: provide ibm_iam_endpoint as a configurable param for IBM IAM-based auth (Bhagyashreek8)
+ - Fix Content-MD5 for Object Lock uploads and add GCS quirk (Chris)
+ - Fix regression where PutObject fails with non-seekable readers (Chris)
+ - Fix `--s3-versions` flag ignored by cleanup-hidden when GetBucketVersioning fails (Chris)
+ - Fix bucket creation failing on Ceph/radosgw (Jan Heylen)
+- SFTP
+ - Warn the user if no host key validation is configured (Nick Craig-Wood)
+- WebDAV
+ - Permit redirects on PROPFIND for metadata (Brian Bockelman)
+ - Request only required properties in listAll to improve performance (ZRHan)
+ - Optimize performance by using `Depth=0` for metadata requests (ZRHan)
+
+## v1.73.5 - 2026-04-19
+
+[See commits](https://github.com/rclone/rclone/compare/v1.73.4...v1.73.5)
+
+- Bug Fixes
+ - operations: Add AuthRequired to operations/fsinfo to prevent backend creation CVE-2026-41179 (Nick Craig-Wood)
+ - rc
+ - Add AuthRequired to options/set to prevent auth bypass CVE-2026-41176 (Nick Craig-Wood)
+ - Snapshot NoAuth at startup to prevent runtime auth bypass CVE-2026-41176 (Nick Craig-Wood)
+ - filter: Fix debug logs that fire before logger is configured (Nick Craig-Wood)
+- Azureblob
+ - Add Microsoft Partner Network User-Agent prefix (Nick Craig-Wood)
+- Drime
+ - Fix User.EntryPermissions JSON unmarshalling (a1pcm)
+- Iclouddrive
+ - Fix 'directory not found' error when the directory contains accent marks (Brais Couce)
+- S3
+ - Fix TencentCOS CDN endpoint failing on bucket check (Mozi)
+ - Fix empty delimiter parameter rejected by Archiware P5 server (Nick Craig-Wood)
+
+## v1.73.4 - 2026-04-08
+
+[See commits](https://github.com/rclone/rclone/compare/v1.73.3...v1.73.4)
+
+- Bug Fixes
+ - build
+ - Update to go 1.25.9 to fix multiple CVEs (Nick Craig-Wood)
+ - CVE-2026-32282: os: Root.Chmod can follow symlinks out of the root on Linux
+ - CVE-2026-32289: html/template: JS template literal context incorrectly tracked
+ - CVE-2026-33810: crypto/x509: excluded DNS constraints not properly applied to wildcard domains
+ - CVE-2026-27144: cmd/compile: no-op interface conversion bypasses overlap checking
+ - CVE-2026-27143: cmd/compile: possible memory corruption after bound check elimination
+ - CVE-2026-32288: archive/tar: unbounded allocation when parsing old format GNU sparse map
+ - CVE-2026-32283: crypto/tls: multiple key update handshake messages can cause connection to deadlock
+ - CVE-2026-27140: cmd/go: trust layer bypass when using cgo and SWIG
+ - CVE-2026-32280: crypto/x509: unexpected work during chain building
+ - CVE-2026-32281: crypto/x509: inefficient policy validation
+ - Fix Denial of Service due to Panic in AWS SDK for Go v2 SDK EventStream Decoder (dependabot[bot])
+ - Update golang.org/x/image to 0.38.0 to fix CVE-2026-33809 (dependabot[bot])
+ - docs
+ - Fix header level for metadata option (Clément Notin)
+ - Fix markdown issues in mount docs (albertony)
+ - Fix link to not be language specific (Ross Smith II)
+ - Note macOS 10.15 (Catalina) support with version v1.70.3 (kapitainsky)
+- Filen
+ - Update SDK version (Enduriel)
+
+## v1.73.3 - 2026-03-23
+
+[See commits](https://github.com/rclone/rclone/compare/v1.73.2...v1.73.3)
+
+- Bug Fixes
+ - build
+ - Update to google.golang.org/grpc 1.79.3 to fix CVE-2026-33186 (dependabot[bot])
+ - Update to github.com/buger/jsonparser 1.1.2 to fix GHSA-6g7g-w4f8-9c9x (dependabot[bot])
+ - doc fixes
+ - Added text to the label showing version-introduced info (Jan-Philipp Reßler)
+ - Clarify Filen password change requires updating both password and API key in rclone config (Jason)
+ - s3: clarify multi tenant support for Cubbit (Marco Ferretti)
+ - jottacloud: Fix broken link (albertony)
+ - lib/rest: Fix URLPathEscapeAll breaking WebDAV servers (eg nzbdav) with strict path matching (Andrew Furman)
+ - list: Fix nil pointer panic in Sorter when temp file creation fails (Nick Craig-Wood)
+
+## v1.73.2 - 2026-03-06
+
+[See commits](https://github.com/rclone/rclone/compare/v1.73.1...v1.73.2)
+
+- Bug Fixes
+ - build
+ - Update to go 1.25.8 to fix CVE-2026-27137 CVE-2026-27138 CVE-2026-25679 CVE-2026-27142 (Nick Craig-Wood)
+ - Update github.com/cloudflare/circl to v1.6.3 to fix CVE-2026-1229 (Nick Craig-Wood)
+ - Update to golang.org/x/net v0.51.0 to fix CVE-2026-27141 (Nick Craig-Wood)
+ - docs fixes:
+ - bisync: Add group Sync to the bisync command (Jan-Philipp Reßler)
+ - Note that --use-server-modtime only works on some backends (Nick Craig-Wood)
+ - Document unsupported S3 object keys with double slashes (Adam Kasztenny)
+ - Fix headers hierarchy for mount.md (Dark Dragon)
+ - Fix new drive flag typo in changelog (razorloves)
+- Archive
+ - Extract: fix extraction with "./" prefix from tar entry paths (Varun Chawla)
+- Drime
+ - Fix chunk-uploaded files ignoring workspace ID (a1pcm)
+- Internxt
+ - Fix Entry doesn't belong in directory errors on windows (jzunigax2)
+- WebDAV
+ - Escape reserved characters in URL path segments (Varun Chawla)
+ - Add missing headers for CORS (Romāns Potašovs)
+
+## v1.73.1 - 2026-02-17
+
+[See commits](https://github.com/rclone/rclone/compare/v1.73.0...v1.73.1)
+
+- Bug Fixes
+ - accounting: Fix missing server side stats from core/stats rc (Nick Craig-Wood)
+ - build
+ - Fix CVE-2025-68121 by updating go to 1.25.7 or later (Nick Craig-Wood)
+ - Bump github.com/go-chi/chi/v5 from 5.2.3 to 5.2.5 to fix GO-2026-4316 (albertony)
+ - docs: Extend copyurl docs with an example of CSV FILENAMEs starting with a path. (Jack Kelly)
+ - march: Fix runtime: program exceeds 10000-thread limit (Nick Craig-Wood)
+ - pacer
+ - Fix deadlock between pacer token and --max-connections (Nick Craig-Wood)
+ - Re-read the sleep time as it may be stale (Nick Craig-Wood)
+- Drime
+ - Fix files and directories being created in the default workspace (Nick Craig-Wood)
+- Filelu
+ - Avoid buffering entire file in memory (kingston125)
+ - Add multipart upload support with configurable cutoff (kingston125)
+- Filen
+ - Fix 32 bit targets not being able to list directories (Enduriel)
+ - Fix potential panic in case of error during upload (Enduriel)
+- Internxt
+ - Implement re-login under refresh logic, improve retry logic (José Zúniga)
+-S3
+ - Set list_version to 2 for FileLu S3 configuration (kingston125)
+
## v1.73.0 - 2026-01-30
[See commits](https://github.com/rclone/rclone/compare/v1.72.0...v1.73.0)
@@ -68088,7 +70519,7 @@ Options:
- B2
- Support authentication with new bucket restricted application keys (DianaNites)
- Drive
- - Add `--drive-metadata-force-expansive-access` flag (Nick Craig-Wood)
+ - Add `--drive-metadata-enforce-expansive-access` flag (Nick Craig-Wood)
- Fix crash when trying to creating shortcut to a Google doc (Nick Craig-Wood)
- FTP
- Add http proxy authentication support (Nicolas Dessart)
@@ -75649,7 +78080,7 @@ put them back in again. -->
- Nathanael Demacon <[email protected]>
- Flora Thiebaut <[email protected]>
-- kingston125 <[email protected]>
- Ser-Bul <[email protected]>
- jinjingroad <[email protected]>
- necaran <[email protected]>
@@ -75744,6 +78175,56 @@ put them back in again. -->
- jzunigax2 <[email protected]>
- lullius <[email protected]>
- StarHack <[email protected]>
+- Leon Brocard <[email protected]>
+- Cohinem <[email protected]>
+- Jack Kelly <[email protected]>
+- Prakhar Chhalotre <[email protected]>
+- Varun Chawla <[email protected]>
+- Jan-Philipp Reßler <[email protected]>
+- Shlomi Avihou <[email protected]>
+- Jan-Philipp Reßler <[email protected]>
+- Dark Dragon <[email protected]>
+- Leon Brocard <[email protected]>
+- Bjoern Franke <[email protected]>
+- Adam Kasztenny <[email protected]>
+- Romāns Potašovs <[email protected]>
+- Brian Bockelman <[email protected]>
+- Bjoern Franke <[email protected]>
+- razorloves <[email protected]>
+- Duncan F <[email protected]>
+- Billy Hughes <[email protected]>
+- Bhagyashreek8 <[email protected]>
+- Andriy Senyshyn <[email protected]>
+- Andrew Furman <[email protected]>
+- Patrick Farrell <[email protected]>
+- BizaNator <[email protected]>
+- jinkeyuu <[email protected]>
+- jinyu.han <[email protected]>
+- Claude Opus 4.6 <[email protected]>
+- Andriy Senyshyn <[email protected]>
+- Mike GIllan <[email protected]>
+- Xiangzhe <[email protected]>
+- TheBabu <[email protected]>
+- Brais Couce <[email protected]>
+- SyoBoN <[email protected]>
+- Jan Heylen <[email protected]>
+- Anton Bordwine <[email protected]>
+- mathieulongtin <[email protected]>
+- Luke Cyca <[email protected]>
+- dlaumen <[email protected]>
+- Yakov Till <[email protected]>
+- Chris Coughlan <[email protected]>
+- John Volk <[email protected]>
# Contact the rclone project
diff --git a/MANUAL.txt b/MANUAL.txt
index 668631e8b..759a00dd6 100644
--- a/MANUAL.txt
+++ b/MANUAL.txt
@@ -1,6 +1,6 @@
rclone(1) User Manual
Nick Craig-Wood
-Jan 30, 2026
+May 01, 2026
NAME
@@ -35,6 +35,7 @@ SYNOPSIS
deletefile Remove a single file from remote.
gendocs Output markdown docs for rclone to the directory supplied.
gitannex Speaks with git-annex over stdin/stdout.
+ gui Open the web based GUI.
hashsum Produces a hashsum file for all the objects in the path.
help Show help for rclone commands, flags and backends.
link Generate public link to file/folder.
@@ -183,6 +184,7 @@ S3, that work out of the box.)
- Dropbox
- Enterprise File Fabric
- Exaba
+- Fastly Object Storage
- Fastmail Files
- FileLu Cloud Storage
- FileLu S5 (S3-Compatible Object Storage)
@@ -198,7 +200,9 @@ S3, that work out of the box.)
- Hetzner Object Storage
- Hetzner Storage Box
- HiDrive
+- Hitachi Content Platform (HCP)
- HTTP
+- Huawei Drive
- Huawei OBS
- iCloud Drive
- ImageKit
@@ -207,6 +211,7 @@ S3, that work out of the box.)
- Jottacloud
- IBM COS S3
- IDrive e2
+- Impossible Cloud
- Intercolo Object Storage
- IONOS Cloud
- Koofr
@@ -260,15 +265,16 @@ S3, that work out of the box.)
- Sia
- SMB / CIFS
- Spectra Logic
-- StackPath
- Storj
- Synology
- SugarSync
- Tencent Cloud Object Storage (COS)
- Uloz.to
+- US3
- Wasabi
- WebDAV
- Yandex Disk
+- Zadara Object Storage
- Zoho WorkDrive
- Zata
- The local filesystem
@@ -624,7 +630,7 @@ developers so it may be out of date. Its current version is as below.
Source installation
-Make sure you have git and Go installed. Go version 1.24 or newer is
+Make sure you have git and Go installed. Go version 1.25 or newer is
required, the latest release is recommended. You can get it from your
package manager, or download it from golang.org/dl. Then you can run the
following:
@@ -966,6 +972,7 @@ See the following for detailed instructions for
- Hetzner Storage Box
- HiDrive
- HTTP
+- Huawei Drive
- iCloud Drive
- Internet Archive
- Internxt
@@ -3233,7 +3240,7 @@ Options
-1, --resync Performs the resync run. Equivalent to --resync-mode path1. Consider using --verbose or --dry-run first.
--resync-mode string During resync, prefer the version that is: path1, path2, newer, older, larger, smaller (default: path1 if --resync, otherwise none for no resync.) (default "none")
--slow-hash-sync-only Ignore slow checksums for listings and deltas, but still consider them during sync calls.
- --workdir string Use custom working dir - useful for testing. (default: {WORKDIR})
+ --workdir string Use custom working dir - useful for testing. (default: $HOME/.cache/rclone/bisync)
Options shared with other commands are described next. See the global
flags page for global options not listed here.
@@ -3277,6 +3284,24 @@ Flags for anything which can copy a file
--streaming-upload-cutoff SizeSuffix Cutoff for switching to chunked upload if file size is unknown, upload starts after reaching cutoff or when file ends (default 100Ki)
-u, --update Skip files that are newer on the destination
+Sync Options
+
+Flags used for sync commands
+
+ --backup-dir string Make backups into hierarchy based in DIR
+ --delete-after When synchronizing, delete files on destination after transferring (default)
+ --delete-before When synchronizing, delete files on destination before transferring
+ --delete-during When synchronizing, delete files during transfer
+ --fix-case Force rename of case insensitive dest to match source
+ --ignore-errors Delete even if there are I/O errors
+ --list-cutoff int To save memory, sort directory listings on disk above this threshold (default 1000000)
+ --max-delete int When synchronizing, limit the number of deletes (default -1)
+ --max-delete-size SizeSuffix When synchronizing, limit the total size of deletes (default off)
+ --suffix string Suffix to add to changed files
+ --suffix-keep-extension Preserve the extension when using --suffix
+ --track-renames When synchronizing, track file renames and do a server-side move if possible
+ --track-renames-strategy string Strategies to use when synchronizing using track-renames hash|modtime|leaf (default "hash")
+
Important Options
Important flags useful for most commands
@@ -4607,10 +4632,10 @@ Examples:
// Output: stories/The Quick Brown Fox!.txt
rclone convmv "stories/The Quick Brown Fox!" --name-transform "date=-{YYYYMMDD}"
- // Output: stories/The Quick Brown Fox!-20260130
+ // Output: stories/The Quick Brown Fox!-20260501
rclone convmv "stories/The Quick Brown Fox!" --name-transform "date=-{macfriendlytime}"
- // Output: stories/The Quick Brown Fox!-2026-01-30 0825PM
+ // Output: stories/The Quick Brown Fox!-2026-05-01 0208PM
rclone convmv "stories/The Quick Brown Fox!.txt" --name-transform "all,regex=[\\.\\w]/ab"
// Output: ababababababab/ababab ababababab ababababab ababab!abababab
@@ -5032,6 +5057,15 @@ incompatible with --urls. This will do --transfers copies in parallel.
Note that if --auto-filename is desired for all URLs then a file with
only URLs and no filename can be used.
+Each FILENAME in the CSV file can start with a relative path which will
+be appended to the destination path provided at the command line. For
+example, running the command shown above with the following CSV file
+will write two files to the destination: remote:dir/local/path/bar.json
+and remote:dir/another/local/directory/qux.json
+
+ https://example.org/foo/bar.json,local/path/bar.json
+ https://example.org/qux/baz.json,another/local/directory/qux.json
+
Troubleshooting
If you can't get rclone copyurl to work then here are some things you
@@ -5355,6 +5389,106 @@ See Also
- rclone - Show help for rclone commands, flags and backends.
+rclone gui
+
+Open the web based GUI.
+
+Synopsis
+
+This command starts an embedded web GUI for rclone and opens it in your
+default browser.
+
+This starts an RC API server and a GUI server on separate localhost
+ports, generates login credentials automatically unless --no-auth is
+specified, and opens the browser already authenticated.
+
+ rclone gui
+
+By default rclone gui serves the web GUI that was embedded into the
+rclone binary at build time from https://github.com/rclone/rclone-web/
+You can override this by passing a path to either an unpacked GUI
+directory or a dist.zip archive (e.g. one downloaded from the rclone-web
+releases page):
+
+ rclone gui ./my-dist/
+ rclone gui ./dist.zip
+
+This is useful for iterating on the GUI locally without rebuilding
+rclone, or for serving a different GUI release than the one embedded.
+
+Use --no-open-browser to skip opening the browser automatically:
+
+ rclone gui --no-open-browser
+
+Use --addr to bind the GUI to a specific address:
+
+ rclone gui --addr localhost:5580
+
+Use --user and --pass to set specific credentials:
+
+ rclone gui --user admin --pass secret
+
+Use --no-auth to disable authentication entirely:
+
+ rclone gui --no-auth
+
+For more help see the GUI docs.
+
+ rclone gui [path] [flags]
+
+Options
+
+ --addr stringArray IPaddress:Port for the GUI server (default auto-chosen localhost port)
+ --api-addr stringArray IPaddress:Port for the RC API server (default auto-chosen localhost port)
+ --enable-metrics Enable OpenMetrics/Prometheus compatible endpoint at /metrics
+ -h, --help help for gui
+ --no-auth Don't require auth for the RC API
+ --no-open-browser Skip opening the browser automatically
+ --pass string Password for RC authentication
+ --user string User name for RC authentication
+
+Options shared with other commands are described next. See the global
+flags page for global options not listed here.
+
+RC Options
+
+Flags to control the Remote Control API
+
+ --rc Enable the remote control server
+ --rc-addr stringArray IPaddress:Port or :Port to bind server to (default localhost:5572)
+ --rc-allow-origin string Origin which cross-domain request (CORS) can be executed from
+ --rc-baseurl string Prefix for URLs - leave blank for root
+ --rc-cert string TLS PEM key (concatenation of certificate and CA certificate)
+ --rc-client-ca string Client certificate authority to verify clients with
+ --rc-enable-metrics Enable the Prometheus metrics path at the remote control server
+ --rc-files string Path to local files to serve on the HTTP server
+ --rc-htpasswd string A htpasswd file - if not provided no authentication is done
+ --rc-job-expire-duration Duration Expire finished async jobs older than this value (default 1m0s)
+ --rc-job-expire-interval Duration Interval to check for expired async jobs (default 10s)
+ --rc-key string TLS PEM Private key
+ --rc-max-header-bytes int Maximum size of request header (default 4096)
+ --rc-min-tls-version string Minimum TLS version that is acceptable (default "tls1.0")
+ --rc-no-auth Don't require auth for certain methods
+ --rc-pass string Password for authentication
+ --rc-realm string Realm for authentication
+ --rc-salt string Password hashing salt (default "dlPL2MqE")
+ --rc-serve Enable the serving of remote objects
+ --rc-serve-no-modtime Don't read the modification time (can speed things up)
+ --rc-server-read-timeout Duration Timeout for server reading data (default 1h0m0s)
+ --rc-server-write-timeout Duration Timeout for server writing data (default 1h0m0s)
+ --rc-template string User-specified template
+ --rc-user string User name for authentication
+ --rc-user-from-header string User name from a defined HTTP header
+ --rc-web-fetch-url string URL to fetch the releases for webgui (default "https://api.github.com/repos/rclone/rclone-webui-react/releases/latest")
+ --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't open the browser automatically
+ --rc-web-gui-update Check and update to latest version of web gui
+
+See Also
+
+- rclone - Show help for rclone commands, flags and backends.
+
rclone hashsum
Produces a hashsum file for all the objects in the path.
@@ -5512,11 +5646,15 @@ Result can be filtered by a filter argument which applies to all
attributes, and/or filter flags specific for each attribute. The values
must be specified according to regular rclone filtering pattern syntax.
+By default filtering uses non-anchored matching, so --type box also
+matches dropbox. Use --exact to match complete values only.
+
rclone listremotes [<filter>] [flags]
Options
--description string Filter remotes by description
+ --exact Match filter strings exactly instead of using non-anchored glob matching
-h, --help help for listremotes
--json Format output as JSON
--long Show type and description in addition to name
@@ -6173,7 +6311,7 @@ not suffer from the same limitations.
Mounting on macOS
Mounting on macOS can be done either via built-in NFS server, macFUSE
-(also known as osxfuse) or FUSE-T.macFUSE is a traditional FUSE driver
+(also known as osxfuse) or FUSE-T. macFUSE is a traditional FUSE driver
utilizing a macOS kernel extension (kext). FUSE-T is an alternative FUSE
system which "mounts" via an NFSv4 local server.
@@ -6218,7 +6356,7 @@ As per the FUSE-T wiki:
File access and modification times cannot be set separately as it
seems to be an issue with the NFS client which always modifies both.
- Can be reproduced with 'touch -m' and 'touch -a' commands
+ Can be reproduced with touch -m and touch -a commands
This means that viewing files with various tools, notably macOS Finder,
will cause rlcone to update the modification time of the file. This may
@@ -6236,9 +6374,11 @@ running rclone mount:
NOTICE: mount helper error: fusermount3: mount failed: Permission
denied CRITICAL: Fatal error: failed to mount FUSE fs: fusermount:
- exit status 1 This may be due to newer Apparmor restrictions, which
- can be disabled with sudo aa-disable /usr/bin/fusermount3 (you may
- need to sudo apt install apparmor-utils beforehand).
+ exit status 1
+
+This may be due to newer Apparmor restrictions, which can be disabled
+with sudo aa-disable /usr/bin/fusermount3 (you may need to
+sudo apt install apparmor-utils beforehand).
Limitations
@@ -6899,6 +7039,7 @@ Options
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
@@ -7522,7 +7663,7 @@ not suffer from the same limitations.
Mounting on macOS
Mounting on macOS can be done either via built-in NFS server, macFUSE
-(also known as osxfuse) or FUSE-T.macFUSE is a traditional FUSE driver
+(also known as osxfuse) or FUSE-T. macFUSE is a traditional FUSE driver
utilizing a macOS kernel extension (kext). FUSE-T is an alternative FUSE
system which "mounts" via an NFSv4 local server.
@@ -7567,7 +7708,7 @@ As per the FUSE-T wiki:
File access and modification times cannot be set separately as it
seems to be an issue with the NFS client which always modifies both.
- Can be reproduced with 'touch -m' and 'touch -a' commands
+ Can be reproduced with touch -m and touch -a commands
This means that viewing files with various tools, notably macOS Finder,
will cause rlcone to update the modification time of the file. This may
@@ -7585,9 +7726,11 @@ running rclone mount:
NOTICE: mount helper error: fusermount3: mount failed: Permission
denied CRITICAL: Fatal error: failed to mount FUSE fs: fusermount:
- exit status 1 This may be due to newer Apparmor restrictions, which
- can be disabled with sudo aa-disable /usr/bin/fusermount3 (you may
- need to sudo apt install apparmor-utils beforehand).
+ exit status 1
+
+This may be due to newer Apparmor restrictions, which can be disabled
+with sudo aa-disable /usr/bin/fusermount3 (you may need to
+sudo apt install apparmor-utils beforehand).
Limitations
@@ -8253,6 +8396,7 @@ Options
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
@@ -8533,6 +8677,12 @@ identically.
--rc-disable-zip may be set to disable the zipping download option.
+Protocol
+
+The server supports HTTP/1.1 and HTTP/2. HTTP/2 is used automatically
+for TLS connections. For non-TLS connections, HTTP/2 cleartext (h2c) is
+supported, allowing HTTP/2 without encryption.
+
TLS (SSL)
By default this will serve over http. If you want you can serve over
@@ -9415,6 +9565,7 @@ Options
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
@@ -10018,6 +10169,7 @@ Options
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
@@ -10663,6 +10815,7 @@ Options
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
@@ -10761,6 +10914,12 @@ identically.
--disable-zip may be set to disable the zipping download option.
+Protocol
+
+The server supports HTTP/1.1 and HTTP/2. HTTP/2 is used automatically
+for TLS connections. For non-TLS connections, HTTP/2 cleartext (h2c) is
+supported, allowing HTTP/2 without encryption.
+
TLS (SSL)
By default this will serve over http. If you want you can serve over
@@ -11492,6 +11651,7 @@ Options
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
@@ -12108,6 +12268,7 @@ Options
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
@@ -12274,6 +12435,12 @@ identically.
--disable-zip may be set to disable the zipping download option.
+Protocol
+
+The server supports HTTP/1.1 and HTTP/2. HTTP/2 is used automatically
+for TLS connections. For non-TLS connections, HTTP/2 cleartext (h2c) is
+supported, allowing HTTP/2 without encryption.
+
TLS (SSL)
By default this will serve over http. If you want you can serve over
@@ -12585,6 +12752,12 @@ identically.
--disable-zip may be set to disable the zipping download option.
+Protocol
+
+The server supports HTTP/1.1 and HTTP/2. HTTP/2 is used automatically
+for TLS connections. For non-TLS connections, HTTP/2 cleartext (h2c) is
+supported, allowing HTTP/2 without encryption.
+
TLS (SSL)
By default this will serve over http. If you want you can serve over
@@ -13128,6 +13301,7 @@ Options
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
@@ -13815,6 +13989,7 @@ Options
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
@@ -13928,6 +14103,18 @@ and connect to it like this using rclone and the webdav backend:
Note that there is no authentication on http protocol - this is expected
to be done by the permissions on the socket.
+Symlinks / Junction points
+
+The webdav protocol does not support symlinks or junction points and by
+default rclone will skip them completely.
+
+You can use -L to get rclone to follow symlinks or you can use
+--local-links to make rclone show .rclonelink files in place of the
+symlinks.
+
+NB Do not use --links as since v1.69 this applies to the VFS layer too,
+use --local-links which only applies to the local backend only.
+
Server options
Use --addr to specify which IP address and port the server should listen
@@ -13962,6 +14149,12 @@ identically.
--disable-zip may be set to disable the zipping download option.
+Protocol
+
+The server supports HTTP/1.1 and HTTP/2. HTTP/2 is used automatically
+for TLS connections. For non-TLS connections, HTTP/2 cleartext (h2c) is
+supported, allowing HTTP/2 without encryption.
+
TLS (SSL)
By default this will serve over http. If you want you can serve over
@@ -14695,6 +14888,7 @@ Options
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
@@ -15040,6 +15234,9 @@ instead of the current time. Times may be specified as one of:
Note that value of --timestamp is in UTC. If you want local time then
add the --localtime flag.
+Metadata can be added when creating a new file with --metadata-set. For
+example: rclone touch remote:path -M --metadata-set key=value
+
rclone touch remote:path [flags]
Options
@@ -17856,6 +18053,10 @@ server's modified time. In cases such as a local to remote sync using
uploaded to the remote is sufficient. In those cases, this flag can
speed up the process and reduce the number of API calls necessary.
+This flag is only supported on certain backends and will be silently
+ignored on unsupported backends. Supported backends include azureblob,
+oracleobjectstorage, s3, swift.
+
Using this flag on a sync operation without also using --update 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.
@@ -18153,6 +18354,10 @@ The available flags are:
- mapper dumps the JSON blobs being sent to the program supplied with
--metadata-mapper and received from it. It can be useful for
debugging the metadata mapper interface.
+- curl dumps the HTTP request as a curl command. Can be used with the
+ other HTTP debugging flags (e.g. requests, bodies). By default the
+ auth will be masked - use with auth to have the curl commands with
+ authentication too.
Filtering
@@ -19448,114 +19653,117 @@ The most frequent filter support issues on the rclone forum are:
- Not using / to match from the root of a remote
- Not using ** to match the contents of a directory
-GUI (Experimental)
+rclone gui
-Rclone can serve a web based GUI (graphical user interface). This is
-somewhat experimental at the moment so things may be subject to change.
+The rclone gui command starts the official Web GUI that comes bundled
+with rclone.
-Run this command in a terminal and rclone will download and then display
-the GUI in a web browser.
+With this command, rclone can serve a web-based GUI (graphical user
+interface) that is accessible from a normal web browser.
- rclone rcd --rc-web-gui
+Run it in a terminal and rclone will initialize and then start the GUI.
-This will produce logs like this and rclone needs to continue to run to
-serve the GUI:
+ rclone gui
- 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/
+This will produce logs like this. The terminal window needs to stay open
+to continue to run the GUI:
-This assumes you are running rclone locally on your machine. It is
-possible to separate the rclone and the GUI - see below for details.
+ 2026/04/14 11:36:04 NOTICE: Serving remote control on http://127.0.0.1:50803/
+ 2026/04/14 11:36:04 NOTICE: Serving GUI on http://127.0.0.1:50802/
+ 2026/04/14 11:36:04 NOTICE: GUI available at http://127.0.0.1:50802/login?pass=XXX&url=http%3A%2F%2F127.0.0.1%3A50803%2F&user=gui
-If you wish to check for updates then you can add --rc-web-gui-update to
-the command line.
-
-If you find your GUI broken, you may force it to update by add
---rc-web-gui-force-update.
-
-By default, rclone will open your browser. Add
---rc-web-gui-no-open-browser to disable this feature.
+You can also add debugging flags when running the GUI, such as -v, which
+will show more logging output from the rc server.
Using the GUI
-Once the GUI opens, you will be looking at the dashboard which has an
-overall overview.
+Once the browser opens, you will be presented with the Dashboard, the
+main screen where you can see the status of your remotes and system.
-On the left hand side you will see a series of view buttons you can
-click on:
+At the top, starting from the left, you will see a series of tabs you
+can click on. On the right side you will have the logout button and
+potentially an "Update available" message if a new rclone version has
+been released.
-- Dashboard - main overview
-- Configs - examine and create new configurations
-- Explorer - view, download and upload files to the cloud storage
- systems
-- Backend - view or alter the backend config
-- Log out
+Dashboard
-(More docs and walkthrough video to come!)
+See live metrics, learn if your remotes are near capacity, and read the
+changelog for the current version.
-How it works
+Explorer
-When you run the rclone rcd --rc-web-gui this is what happens
+Explore and manage both local disks and remotes, download files and
+directories and start transfers.
-- Rclone starts but only runs the remote control API ("rc").
-- The API is bound to localhost with an auto-generated username and
- password.
-- If the API bundle is missing then rclone will download it.
-- rclone will start serving the files from the API bundle over the
- same port as the API
-- rclone will open the browser with a login_token so it can log
- straight in.
+Remotes
-Advanced use
+Scroll the list of remotes and tap on it to navigate to the explorer.
+There you can navigate the contents of your remotes, transfer, download,
+and even upload files.
-The rclone rcd may use any of the flags documented on the rc page.
+Mounts
-The flag --rc-web-gui is shorthand for
+Mount remotes as local drives on your computer and check on your
+existing mounts.
-- Download the web GUI if necessary
-- Check we are using some authentication
-- --rc-user gui
-- --rc-pass <random password>
-- --rc-serve
+Serves
-These flags can be overridden as desired.
+Get quick info about your active serve instances, and start new ones.
-See also the rclone rcd documentation.
+Settings
-Example: Running a public GUI
+Edit your rclone.conf file directly, set logging flags, and performance
+parameters.
+
+How it works
-For example the GUI could be served on a public port over SSL using an
-htpasswd file using the following flags:
+When you run rclone gui this is what happens
-- --rc-web-gui
-- --rc-addr :443
-- --rc-htpasswd /path/to/htpasswd
-- --rc-cert /path/to/ssl.crt
-- --rc-key /path/to/ssl.key
+- Rclone starts the remote control API ("rc").
+- Rclone starts a second server to serve the Web GUI.
+- If a port, username or password is not specified, then missing
+ values will be auto-generated.
+- Unless --no-open-browser is passed, a browser window will open.
+- The URL already contains the username & password, in which case the
+ GUI will use those values and log you in automatically.
-Example: Running a GUI behind a proxy
+Security
-If you want to run the GUI behind a proxy at /rclone you could use these
-flags:
+It's important to think first about what rclone has access to and what
+you might be sharing.
-- --rc-web-gui
-- --rc-baseurl rclone
-- --rc-htpasswd /path/to/htpasswd
+A few good measures:
-Or instead of htpasswd if you just want a single user and password:
+- Don't use --no-auth (this is for testing only).
+- Do not expose to the local network (eg with
+ --api-addr :5572 --addr :8080) unless you trust all devices on
+ your local network. Prefer 127.0.0.1 or localhost (the default).
+- Use a strong password and non-obvious usernames like "admin" or
+ "rclone" if you are using --user and --pass.
+- If you want to host it on a server and access it remotely, make sure
+ you're only exposing the GUI and not the RC API. They listen on
+ different ports.
-- --rc-user me
-- --rc-pass mypassword
+If you want to access it remotely but want to avoid running a proxy and
+exposing ports, you can use Cloudflare Tunnels or localhost.run or
+Tailscale (all free).
-Project
+Options
-The GUI is being developed in the: rclone/rclone-webui-react repository.
+ --addr stringArray IPaddress:Port for the GUI server (default auto-chosen localhost port)
+ --api-addr stringArray IPaddress:Port for the RC API server (default auto-chosen localhost port)
+ --enable-metrics Enable OpenMetrics/Prometheus compatible endpoint at /metrics
+ -h, --help help for gui
+ --no-auth Don't require auth for the RC API
+ --no-open-browser Skip opening the browser automatically
+ --pass string Password for RC authentication
+ --user string User name for RC authentication
-Bug reports and contributions are very welcome :-)
+History
-If you have questions then please ask them on the rclone forum.
+In v1.74 the GUI was redone and embedded within rclone for ease of use.
+The GUI bundle ships as a compressed zip embedded in the rclone binary
+and is served from the zip at runtime.
Remote controlling rclone with its API
@@ -20192,8 +20400,6 @@ Note that arguments must be preceded by the "-a" flag
See the backend command for more information.
-Authentication is required for this call.
-
cache/expire: Purge a remote from cache
Purge a remote from the cache backend. Supports either a directory or a
@@ -20235,6 +20441,8 @@ cache/stats: Get cache stats
Show statistics for the cache remote.
+Authentication is not required for this call.
+
config/create: create the config for a remote.
This takes the following parameters:
@@ -20255,8 +20463,6 @@ This takes the following parameters:
See the config create command for more information on the above.
-Authentication is required for this call.
-
config/delete: Delete a remote in the config file.
Parameters:
@@ -20265,8 +20471,6 @@ Parameters:
See the config delete command for more information on the above.
-Authentication is required for this call.
-
config/dump: Dumps the config file.
Returns a JSON object: - key: value
@@ -20275,8 +20479,6 @@ Where keys are remote names and values are the config parameters.
See the config dump command for more information on the above.
-Authentication is required for this call.
-
config/get: Get a remote in the config file.
Parameters:
@@ -20285,16 +20487,12 @@ Parameters:
See the config dump command for more information on the above.
-Authentication is required for this call.
-
config/listremotes: Lists the remotes in the config file and defined in environment variables.
Returns - remotes - array of remote names
See the listremotes command for more information on the above.
-Authentication is required for this call.
-
config/password: password the config for a remote.
This takes the following parameters:
@@ -20304,8 +20502,6 @@ This takes the following parameters:
See the config password command for more information on the above.
-Authentication is required for this call.
-
config/paths: Reads the config file path and other important paths.
Returns a JSON object with the following keys:
@@ -20324,8 +20520,6 @@ Eg
See the config paths command for more information on the above.
-Authentication is required for this call.
-
config/providers: Shows how providers are configured in the config file.
Returns a JSON object: - providers - array of objects
@@ -20335,16 +20529,12 @@ See the config providers command for more information on the above.
Note that the Options blocks are in the same format as returned by
"options/info". They are described in the option blocks section.
-Authentication is required for this call.
-
config/setpath: Set the path of the config file
Parameters:
- path - path to the config file to use
-Authentication is required for this call.
-
config/unlock: Unlock the config file.
Unlocks the config file if it is locked.
@@ -20355,8 +20545,6 @@ Parameters:
A good idea is to disable AskPassword before making this call
-Authentication is required for this call.
-
config/update: update the config for a remote.
This takes the following parameters:
@@ -20376,8 +20564,6 @@ This takes the following parameters:
See the config update command for more information on the above.
-Authentication is required for this call.
-
core/bwlimit: Set the bandwidth limit.
This sets the bandwidth limit to the string passed in. This should be a
@@ -20464,7 +20650,19 @@ Returns:
"result": "<Raw command line output>"
}
-Authentication is required for this call.
+core/disks: List the local disks
+
+This does not take any parameters
+
+This call is for rclone GUI programs to enumerate local disks and
+important directories for doing transfers to and from. The list returned
+will include the root directory and the user's home directory and any
+mounted disks. The returned items should be usable directly as remotes.
+
+Returns:
+
+- disks
+ - This is an array of strings of local disk names
core/du: Returns disk usage of a locally attached disk.
@@ -20486,6 +20684,8 @@ Returns:
}
}
+Authentication is not required for this call.
+
core/gc: Runs a garbage collection.
This tells the go runtime to do a garbage collection run. It isn't
@@ -20507,6 +20707,8 @@ Returns the following values:
]
}
+Authentication is not required for this call.
+
core/memstats: Returns the memory statistics
This returns the memory statistics of the running program. What the
@@ -20557,6 +20759,7 @@ Returns the following values:
{
"bytes": total transferred bytes since the start of the group,
"checks": number of files checked,
+ "deletedDirs": number of directories deleted,
"deletes" : number of files deleted,
"elapsedTime": time in floating point seconds since rclone was started,
"errors": number of errors,
@@ -20596,6 +20799,8 @@ 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.
+Authentication is not required for this call.
+
core/stats-delete: Delete stats group.
This deletes entire stats group.
@@ -20646,6 +20851,8 @@ Returns the following values:
]
}
+Authentication is not required for this call.
+
core/version: Shows the current version of rclone, Go and the OS.
This shows the current versions of rclone, Go and the OS:
@@ -20663,6 +20870,8 @@ This shows the current versions of rclone, Go and the OS:
- linking - type of rclone executable (static or dynamic)
- goTags - space separated build tags or "none"
+Authentication is not required for this call.
+
debug/set-block-profile-rate: Set runtime.SetBlockProfileRate for blocking profiling.
SetBlockProfileRate controls the fraction of goroutine blocking events
@@ -20769,16 +20978,12 @@ are cached for a short while to make repeated rc calls more efficient.
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.
-Authentication is required for this call.
-
fscache/entries: Returns the number of entries in the fs cache.
This returns the number of entries in the fs cache.
Returns - entries - number of items in the cache
-Authentication is required for this call.
-
job/batch: Run a batch of rclone rc commands concurrently.
This takes the following parameters:
@@ -20836,8 +21041,6 @@ Gives the result:
]
}
-Authentication is required for this call.
-
job/list: Lists the IDs of the running jobs
Parameters: None.
@@ -20849,6 +21052,8 @@ Results:
- runningIds - array of integer job ids that are running
- finishedIds - array of integer job ids that are finished
+Authentication is not required for this call.
+
job/status: Reads the status of the job ID
Parameters:
@@ -20873,6 +21078,8 @@ Results:
synchronously
- progress - output of the progress related to the underlying job
+Authentication is not required for this call.
+
job/stop: Stop the running job
Parameters:
@@ -20898,8 +21105,6 @@ Eg
rclone rc mount/listmounts
-Authentication is required for this call.
-
mount/mount: Create a new mount point
rclone allows Linux, FreeBSD, macOS and Windows to mount any of Rclone's
@@ -20917,11 +21122,23 @@ This takes the following parameters:
- mountOpt: a JSON object with Mount options in.
- vfsOpt: a JSON object with VFS options in.
+On Windows mountPoint may be set to "*" to assign the next available
+drive letter automatically, or a network share UNC path (e.g. "\server")
+to mount as a network drive. In these cases the actual drive letter is
+chosen at mount time.
+
+This returns the following values:
+
+- mountPoint: the actual mount point that was used (this may differ
+ from the input, e.g. on Windows when "*" is passed the allocated
+ drive letter is returned)
+
Example:
rclone rc mount/mount fs=mydrive: mountPoint=/home/<user>/mountPoint
rclone rc mount/mount fs=mydrive: mountPoint=/home/<user>/mountPoint mountType=mount
rclone rc mount/mount fs=TestDrive: mountPoint=/mnt/tmp vfsOpt='{"CacheMode": 2}' mountOpt='{"AllowOther": true}'
+ rclone rc mount/mount fs=mydrive: mountPoint=* mountType=cmount
The vfsOpt are as described in options/get and can be seen in the "vfs"
section when running and the mountOpt can be seen in the "mount"
@@ -20929,8 +21146,6 @@ section:
rclone rc options/get
-Authentication is required for this call.
-
mount/types: Show all possible mount types
This shows all possible mount types and returns them as a list.
@@ -20946,8 +21161,6 @@ Eg
rclone rc mount/types
-Authentication is required for this call.
-
mount/unmount: Unmount selected active mount
rclone allows Linux, FreeBSD, macOS and Windows to mount any of Rclone's
@@ -20962,8 +21175,6 @@ Example:
rclone rc mount/unmount mountPoint=/home/<user>/mountPoint
-Authentication is required for this call.
-
mount/unmountall: Unmount all active mounts
rclone allows Linux, FreeBSD, macOS and Windows to mount any of Rclone's
@@ -20975,8 +21186,6 @@ Eg
rclone rc mount/unmountall
-Authentication is required for this call.
-
operations/about: Return the space used on the remote
This takes the following parameters:
@@ -20987,8 +21196,6 @@ The result is as returned from rclone about --json
See the about command for more information on the above.
-Authentication is required for this call.
-
operations/check: check the source and destination are the same
Checks the files in the source and destination match. It compares sizes
@@ -21047,8 +21254,6 @@ Returns:
- error - array of strings of all files with errors (hashing or
reading)
-Authentication is required for this call.
-
operations/cleanup: Remove trashed files in the remote or path
This takes the following parameters:
@@ -21057,8 +21262,6 @@ This takes the following parameters:
See the cleanup command for more information on the above.
-Authentication is required for this call.
-
operations/copyfile: Copy a file from source remote to destination remote
This takes the following parameters:
@@ -21071,8 +21274,6 @@ This takes the following parameters:
- dstRemote - a path within that remote e.g. "file2.txt" for the
destination
-Authentication is required for this call.
-
operations/copyurl: Copy the URL to the object
This takes the following parameters:
@@ -21085,8 +21286,6 @@ This takes the following parameters:
See the copyurl command for more information on the above.
-Authentication is required for this call.
-
operations/delete: Remove files in the path
This takes the following parameters:
@@ -21095,8 +21294,6 @@ This takes the following parameters:
See the delete command for more information on the above.
-Authentication is required for this call.
-
operations/deletefile: Remove the single file pointed to
This takes the following parameters:
@@ -21106,8 +21303,6 @@ This takes the following parameters:
See the deletefile command for more information on the above.
-Authentication is required for this call.
-
operations/fsinfo: Return information about the remote
This takes the following parameters:
@@ -21265,8 +21460,6 @@ Example:
See the hashsum command for more information on the above.
-Authentication is required for this call.
-
operations/hashsumfile: Produces a hash for a single file.
Produces a hash for a single file using the hash named.
@@ -21299,8 +21492,6 @@ Example:
See the hashsum command for more information on the above.
-Authentication is required for this call.
-
operations/list: List the given remote and path in JSON format
This takes the following parameters:
@@ -21327,8 +21518,6 @@ Returns:
See the lsjson command for more information on the above and examples.
-Authentication is required for this call.
-
operations/mkdir: Make a destination directory or container
This takes the following parameters:
@@ -21338,8 +21527,6 @@ This takes the following parameters:
See the mkdir command for more information on the above.
-Authentication is required for this call.
-
operations/movefile: Move a file from source remote to destination remote
This takes the following parameters:
@@ -21352,8 +21539,6 @@ This takes the following parameters:
- dstRemote - a path within that remote e.g. "file2.txt" for the
destination
-Authentication is required for this call.
-
operations/publiclink: Create or retrieve a public link to the given file or folder.
This takes the following parameters:
@@ -21370,8 +21555,6 @@ Returns:
See the link command for more information on the above.
-Authentication is required for this call.
-
operations/purge: Remove a directory or container and all of its contents
This takes the following parameters:
@@ -21381,8 +21564,6 @@ This takes the following parameters:
See the purge command for more information on the above.
-Authentication is required for this call.
-
operations/rmdir: Remove an empty directory or container
This takes the following parameters:
@@ -21392,8 +21573,6 @@ This takes the following parameters:
See the rmdir command for more information on the above.
-Authentication is required for this call.
-
operations/rmdirs: Remove all the empty directories in the path
This takes the following parameters:
@@ -21404,8 +21583,6 @@ This takes the following parameters:
See the rmdirs command for more information on the above.
-Authentication is required for this call.
-
operations/settier: Changes storage tier or class on all files in the path
This takes the following parameters:
@@ -21414,8 +21591,6 @@ This takes the following parameters:
See the settier command for more information on the above.
-Authentication is required for this call.
-
operations/settierfile: Changes storage tier or class on the single file pointed to
This takes the following parameters:
@@ -21423,8 +21598,6 @@ This takes the following parameters:
- fs - a remote name string e.g. "drive:"
- remote - a path within that remote e.g. "dir"
-Authentication is required for this call.
-
operations/size: Count the number of bytes and files in remote
This takes the following parameters:
@@ -21438,8 +21611,6 @@ Returns:
See the size command for more information on the above.
-Authentication is required for this call.
-
operations/stat: Give information about the supplied file or directory
This takes the following parameters
@@ -21459,8 +21630,6 @@ efficient to set the filesOnly flag in the options.
See the lsjson command for more information on the above and examples.
-Authentication is required for this call.
-
operations/uploadfile: Upload file using multiform/form-data
This takes the following parameters:
@@ -21469,8 +21638,6 @@ This takes the following parameters:
- remote - a path within that remote e.g. "dir"
- each part in body represents a file to be uploaded
-Authentication is required for this call.
-
options/blocks: List all the option blocks
Returns: - options - a list of the options block names
@@ -21562,8 +21729,6 @@ Example:
rclone rc pluginsctl/addPlugin
-Authentication is required for this call.
-
pluginsctl/getPluginsForType: Get plugins with type criteria
This shows all possible plugins by a mime type.
@@ -21585,8 +21750,6 @@ Example:
rclone rc pluginsctl/getPluginsForType type=video/mp4
-Authentication is required for this call.
-
pluginsctl/listPlugins: Get the list of currently loaded plugins
This allows you to get the currently enabled plugins and their details.
@@ -21601,8 +21764,6 @@ E.g.
rclone rc pluginsctl/listPlugins
-Authentication is required for this call.
-
pluginsctl/listTestPlugins: Show currently loaded test plugins
Allows listing of test plugins with the rclone.test set to true in
@@ -21616,8 +21777,6 @@ E.g.
rclone rc pluginsctl/listTestPlugins
-Authentication is required for this call.
-
pluginsctl/removePlugin: Remove a loaded plugin
This allows you to remove a plugin using it's name.
@@ -21630,8 +21789,6 @@ E.g.
rclone rc pluginsctl/removePlugin name=rclone/video-plugin
-Authentication is required for this call.
-
pluginsctl/removeTestPlugin: Remove a test plugin
This allows you to remove a plugin using it's name.
@@ -21644,13 +21801,13 @@ Example:
rclone rc pluginsctl/removeTestPlugin name=rclone/rclone-webui-react
-Authentication is required for this call.
-
rc/error: This returns an error
This returns an error with the input as part of its error string. Useful
for testing error handling.
+Authentication is not required for this call.
+
rc/fatal: This returns an fatal error
This returns an error with the input as part of its error string. Useful
@@ -21661,20 +21818,22 @@ rc/list: List all the registered remote control commands
This lists all the registered remote control commands as a JSON map in
the commands response.
+Authentication is not required for this call.
+
rc/noop: Echo the input to the output parameters
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.
+Authentication is not required for this call.
+
rc/noopauth: Echo the input to the output parameters requiring auth
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.
-Authentication is required for this call.
-
rc/panic: This returns an error by panicking
This returns an error with the input as part of its error string. Useful
@@ -21719,8 +21878,6 @@ Returns
]
}
-Authentication is required for this call.
-
serve/start: Create a new server
Create a new server with the specified parameters.
@@ -21755,8 +21912,6 @@ Or an error if it failed to start.
Stop the server with serve/stop and list the running servers with
serve/list.
-Authentication is required for this call.
-
serve/stop: Unserve selected active serve
Stops a running serve instance by ID.
@@ -21771,8 +21926,6 @@ Example:
rclone rc serve/stop id=12345
-Authentication is required for this call.
-
serve/stopall: Stop all active servers
Stop all active servers.
@@ -21781,8 +21934,6 @@ This will stop all active servers.
rclone rc serve/stopall
-Authentication is required for this call.
-
serve/types: Show all possible serve types
This shows all possible serve types and returns them as a list.
@@ -21808,45 +21959,72 @@ Returns
]
}
-Authentication is required for this call.
-
sync/bisync: Perform bidirectional synchronization between two paths.
-This takes the following parameters
+This takes the following parameters:
-- path1 - a remote directory string e.g. drive:path1
-- path2 - a remote directory string e.g. drive:path2
-- dryRun - dry-run mode
-- resync - performs the resync run
-- checkAccess - abort if RCLONE_TEST files are not found on both
- filesystems
-- checkFilename - file name for checkAccess (default: RCLONE_TEST)
-- maxDelete - abort sync if percentage of deleted files is above this
- threshold (default: 50)
-- force - Bypass maxDelete safety check and run the sync
-- checkSync - true by default, false disables comparison of final
- listings, only will skip sync, only compare listings from the last
- run
-- createEmptySrcDirs - Sync creation and deletion of empty
+- path1 (required) - (string) a remote directory string e.g.
+ drive:path1
+- path2 (required) - (string) a remote directory string e.g.
+ drive:path2
+- dryRun - (bool) dry-run mode
+- backupDir1 - (string) --backup-dir for Path1. Must be a
+ non-overlapping path on the same remote.
+- backupDir2 - (string) --backup-dir for Path2. Must be a
+ non-overlapping path on the same remote.
+- checkAccess - (bool) Ensure expected RCLONE_TEST files are found on
+ both Path1 and Path2 filesystems, else abort.
+- checkFilename - (string) Filename for --check-access (default:
+ RCLONE_TEST)
+- checkSync - (string) Controls comparison of final listings:
+ true|false|only (default: true)
+- compare - (string) Comma-separated list of bisync-specific compare
+ options ex. 'size,modtime,checksum' (default: 'size,modtime')
+- conflictLoser - (ConflictLoserAction) Action to take on the loser of
+ a sync conflict (when there is a winner) or on both files (when
+ there is no winner): , num, pathname, delete (default: num)
+- conflictResolve - (string) Automatically resolve conflicts by
+ preferring the version that is: none, path1, path2, newer, older,
+ larger, smaller (default: none)
+- conflictSuffix - (string) Suffix to use when renaming a
+ --conflict-loser. Can be either one string or two comma-separated
+ strings to assign different suffixes to Path1/Path2. (default:
+ 'conflict')
+- createEmptySrcDirs - (bool) Sync creation and deletion of empty
directories. (Not compatible with --remove-empty-dirs)
-- removeEmptyDirs - remove empty directories at the final cleanup step
-- filtersFile - read filtering patterns from a file
-- ignoreListingChecksum - Do not use checksums for listings
-- resilient - Allow future runs to retry after certain less-serious
- errors, instead of requiring resync.
-- workdir - server directory for history files (default:
- ~/.cache/rclone/bisync)
-- backupdir1 - --backup-dir for Path1. Must be a non-overlapping path
- on the same remote.
-- backupdir2 - --backup-dir for Path2. Must be a non-overlapping path
- on the same remote.
-- noCleanup - retain working files
+- downloadHash - (bool) Compute hash by downloading when otherwise
+ unavailable. (warning: may be slow and use lots of data!)
+- filtersFile - (string) Read filtering patterns from a file
+- force - (bool) Bypass --max-delete safety check and run the sync.
+ Consider using with --verbose
+- ignoreListingChecksum - (bool) Do not use checksums for listings
+ (add --ignore- checksum to additionally skip post-copy checksum
+ checks)
+- maxLock - (Duration) Consider lock files older than this to be
+ expired (default: 0 (never expire)) (minimum: 2m)
+- noCleanup - (bool) Retain working files (useful for troubleshooting
+ and testing).
+- noSlowHash - (bool) Ignore listing checksums only on backends where
+ they are slow
+- recover - (bool) Automatically recover from interruptions without
+ requiring -- resync.
+- removeEmptyDirs - (bool) Remove ALL empty directories at the final
+ cleanup step.
+- resilient - (bool) Allow future runs to retry after certain
+ less-serious errors, instead of requiring --resync.
+- resync - (bool) Performs the resync run. Equivalent to --resync-mode
+ path1. Consider using --verbose or --dry-run first.
+- resyncMode - (string) During resync, prefer the version that is:
+ path1, path2, newer, older, larger, smaller (default: path1 if
+ --resync, otherwise none for no resync.)
+- slowHashSyncOnly - (bool) Ignore slow checksums for listings and
+ deltas, but still consider them during sync calls.
+- workdir - (string) Use custom working dir - useful for testing.
+ (default: /home/ncw/.cache/rclone/bisync)
See bisync command help and full bisync description for more
information.
-Authentication is required for this call.
-
sync/copy: copy a directory from source remote to destination remote
This takes the following parameters:
@@ -21858,8 +22036,6 @@ This takes the following parameters:
See the copy command for more information on the above.
-Authentication is required for this call.
-
sync/move: move a directory from source remote to destination remote
This takes the following parameters:
@@ -21872,8 +22048,6 @@ This takes the following parameters:
See the move command for more information on the above.
-Authentication is required for this call.
-
sync/sync: sync a directory from source remote to destination remote
This takes the following parameters:
@@ -21885,8 +22059,6 @@ This takes the following parameters:
See the sync command for more information on the above.
-Authentication is required for this call.
-
vfs/forget: Forget files or directories in the directory cache.
This forgets the paths in the directory cache causing them to be re-read
@@ -21915,6 +22087,8 @@ 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.
+Authentication is not required for this call.
+
vfs/poll-interval: Get the status or update the value of the poll-interval option.
Without any parameter given this returns the current status of the
@@ -21972,6 +22146,8 @@ 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.
+Authentication is not required for this call.
+
vfs/queue-set-expiry: Set the expiry time for an item queued for upload.
Use this to adjust the expiry time for an item in the upload queue. You
@@ -22061,6 +22237,8 @@ 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.
+Authentication is not required for this call.
+
Accessing the remote control via HTTP
Rclone implements a simple HTTP based protocol.
@@ -22627,7 +22805,7 @@ parameter in the config file.
Encoding example: Windows
-As a nother example, take a Windows system where there is a file with
+As another example, take a Windows system where there is a file with
name Test:1.jpg, where : is the Unicode fullwidth colon symbol. When
using rclone to copy this to a remote which supports :, the regular
(halfwidth) colon (such as Google Drive), you will notice that the file
@@ -22962,7 +23140,7 @@ Flags for general networking and HTTP stuff.
--tpslimit float Limit HTTP transactions per second to this
--tpslimit-burst int Max burst of transactions for --tpslimit (default 1)
--use-cookies Enable session cookiejar
- --user-agent string Set the user-agent to a specified string (default "rclone/v1.73.0")
+ --user-agent string Set the user-agent to a specified string (default "rclone/v1.74.0")
Performance
@@ -23006,7 +23184,7 @@ Debugging
Flags for developers.
--cpuprofile string Write cpu profile to file
- --dump DumpFlags List of items to dump from: headers, bodies, requests, responses, auth, filters, goroutines, openfiles, mapper
+ --dump DumpFlags List of items to dump from: headers, bodies, requests, responses, auth, filters, goroutines, openfiles, mapper, curl
--dump-bodies Dump HTTP headers and bodies - may contain sensitive info
--dump-headers Dump HTTP headers - may contain sensitive info
--memprofile string Write memory profile to file
@@ -23166,6 +23344,8 @@ Backend-only flags (these can be set in the config file also).
--azureblob-connection-string string Storage Connection String
--azureblob-copy-concurrency int Concurrency for multipart copy (default 512)
--azureblob-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 8Mi)
+ --azureblob-copy-total-concurrency int Global concurrency limit for multipart copy chunks
+ --azureblob-decompress If set this will decompress gzip encoded objects
--azureblob-delete-snapshots string Set to specify how to deal with snapshots on blob deletion
--azureblob-description string Description of the remote
--azureblob-directory-markers Upload an empty object with a trailing slash when a new directory is created
@@ -23416,9 +23596,11 @@ Backend-only flags (these can be set in the config file also).
--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
+ --filelu-chunk-size SizeSuffix Chunk size to use for uploading. Used for multipart uploads (default 64Mi)
--filelu-description string Description of the remote
--filelu-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,Colon,Question,Asterisk,Pipe,Hash,Percent,BackSlash,CrLf,Del,Ctl,LeftSpace,LeftPeriod,LeftTilde,LeftCrLfHtVt,RightSpace,RightPeriod,RightCrLfHtVt,InvalidUtf8,Dot,SquareBracket,Semicolon,Exclamation)
--filelu-key string Your FileLu Rclone key from My Account
+ --filelu-upload-cutoff SizeSuffix Cutoff for switching to chunked upload. Any files larger than this will be uploaded in chunks of chunk_size (default 500Mi)
--filen-api-key string API Key for your Filen account (obscured)
--filen-auth-version string Authentication Version (internal use only)
--filen-base-folder-uuid string UUID of Account Root Directory (internal use only)
@@ -23539,11 +23721,24 @@ Backend-only flags (these can be set in the config file also).
--http-no-head Don't use HEAD requests
--http-no-slash Set this if the site doesn't end directories with /
--http-url string URL of HTTP host to connect to
+ --huaweidrive-auth-url string Auth server URL
+ --huaweidrive-chunk-size SizeSuffix Upload chunk size (default 8Mi)
+ --huaweidrive-client-credentials Use client credentials OAuth flow
+ --huaweidrive-client-id string OAuth Client Id
+ --huaweidrive-client-secret string OAuth Client Secret
+ --huaweidrive-description string Description of the remote
+ --huaweidrive-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftSpace,LeftPeriod,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot)
+ --huaweidrive-list-chunk int Size of listing chunk 1-1000 (default 1000)
+ --huaweidrive-root-folder-id string ID of the root folder
+ --huaweidrive-token string OAuth Access Token as a JSON blob
+ --huaweidrive-token-url string Token server url
+ --huaweidrive-upload-cutoff SizeSuffix Cutoff for switching to resumable upload (default 20Mi)
--iclouddrive-apple-id string Apple ID
- --iclouddrive-client-id string Client id (default "d39ba9916b7251055b22c7f910e2ea796ee65e98b2ddecea8f5dde8d9d1a815d")
+ --iclouddrive-client-id string Client ID for iCloud API access (default "d39ba9916b7251055b22c7f910e2ea796ee65e98b2ddecea8f5dde8d9d1a815d")
--iclouddrive-description string Description of the remote
--iclouddrive-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
--iclouddrive-password string Password (obscured)
+ --iclouddrive-service string iCloud service to use (default "drive")
--imagekit-description string Description of the remote
--imagekit-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Dollar,Question,Hash,Percent,BackSlash,Del,Ctl,InvalidUtf8,Dot,SquareBracket)
--imagekit-endpoint string You can find your ImageKit.io URL endpoint in your [dashboard](https://imagekit.io/dashboard/developer/api-keys)
@@ -23562,17 +23757,20 @@ Backend-only flags (these can be set in the config file also).
--internetarchive-item-metadata stringArray Metadata to be set on the IA item, this is different from file-level metadata that can be set using --metadata-set
--internetarchive-secret-access-key string IAS3 Secret Key (password)
--internetarchive-wait-archive Duration Timeout for waiting the server's processing tasks (specifically archive and book_op) to finish (default 0s)
+ --internxt-chunk-size SizeSuffix Chunk size for multipart uploads (default 30Mi)
--internxt-description string Description of the remote
--internxt-email string Email of your Internxt account
--internxt-encoding Encoding The encoding for the backend (default Slash,BackSlash,CrLf,RightPeriod,InvalidUtf8,Dot)
--internxt-pass string Password (obscured)
--internxt-skip-hash-validation Skip hash validation when downloading files (default true)
+ --internxt-upload-concurrency int Concurrency for multipart uploads (default 4)
+ --internxt-upload-cutoff SizeSuffix Cutoff for switching to multipart upload (default 100Mi)
--jottacloud-auth-url string Auth server URL
--jottacloud-client-credentials Use client credentials OAuth flow
--jottacloud-client-id string OAuth Client Id
--jottacloud-client-secret string OAuth Client Secret
--jottacloud-description string Description of the remote
- --jottacloud-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot)
+ --jottacloud-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Percent,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
@@ -23589,6 +23787,8 @@ Backend-only flags (these can be set in the config file also).
--koofr-setmtime Does the backend support setting modification time (default true)
--koofr-user string Your user name
--linkbox-description string Description of the remote
+ --linkbox-email string Email for login
+ --linkbox-password string Password for login (obscured)
--linkbox-token string Token from https://www.linkbox.to/admin/account
--local-case-insensitive Force the filesystem to report itself as case insensitive
--local-case-sensitive Force the filesystem to report itself as case sensitive
@@ -23734,7 +23934,7 @@ Backend-only flags (these can be set in the config file also).
--premiumizeme-token string OAuth Access Token as a JSON blob
--premiumizeme-token-url string Token server url
--protondrive-2fa string The 2FA code
- --protondrive-app-version string The app version string (default "[email protected]+rclone")
+ --protondrive-app-version string The app version string
--protondrive-description string Description of the remote
--protondrive-enable-caching Caches the files and folders metadata to reduce API calls (default true)
--protondrive-encoding Encoding The encoding for the backend (default Slash,LeftSpace,RightSpace,InvalidUtf8,Dot)
@@ -23775,6 +23975,8 @@ Backend-only flags (these can be set in the config file also).
--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-bucket-object-lock-enabled Enable Object Lock when creating new buckets
+ --s3-bypass-governance-retention Allow deleting or modifying objects locked with GOVERNANCE mode
--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
@@ -23789,11 +23991,13 @@ Backend-only flags (these can be set in the config file also).
--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-ibm-api-key string IBM API Key to be used to obtain IAM token
+ --s3-ibm-iam-endpoint string IBM IAM Endpoint to use for authentication
--s3-ibm-resource-instance-id string IBM service instance id
--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-list-versions-oldest-first Tristate Set if the backend returns object versions oldest first (default unset)
--s3-location-constraint string Location constraint - must be set to match the Region
--s3-max-upload-parts int Maximum number of parts in a multipart upload (default 10000)
--s3-might-gzip Tristate Set this if the backend might gzip objects (default unset)
@@ -23801,6 +24005,11 @@ Backend-only flags (these can be set in the config file also).
--s3-no-head If set, don'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-object-lock-legal-hold-status string Object Lock legal hold status to apply when uploading or copying objects
+ --s3-object-lock-mode string Object Lock mode to apply when uploading or copying objects
+ --s3-object-lock-retain-until-date string Object Lock retention until date to apply when uploading or copying objects
+ --s3-object-lock-set-after-upload Set Object Lock via separate API calls after upload
+ --s3-object-lock-supported Tristate Whether the provider supports S3 Object Lock (default unset)
--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
@@ -25351,6 +25560,12 @@ and you can therefore be reasonably sure that any expired lock file you
may find was left there by an interrupted run, not one that is still
running and just taking awhile.
+If a lock file exists but its contents are unreadable (for example, due
+to an incomplete write or disk error), it is treated as expired when
+--max-lock is set to a value greater than 0. If --max-lock is 0 or not
+set, an unreadable lock file will produce an error and block future runs
+until removed manually.
+
If --max-lock is 0 or not set, the default is that lock files will never
expire, and will block future runs (of these same two bisync paths)
indefinitely.
@@ -25626,11 +25841,7 @@ The following backends have known issues that need more investigation:
- TestDropbox (dropbox)
- TestBisyncRemoteRemote/normalization
-- TestSeafile (seafile)
- - TestBisyncLocalRemote/volatile
-- TestSeafileV6 (seafile)
- - TestBisyncLocalRemote/volatile
-- Updated: 2026-01-30-010015
+- Updated: 2026-05-01-010013
The following backends either have not been tested recently or have
known issues that are deemed unfixable for the time being:
@@ -26471,6 +26682,12 @@ Unison and synchronization in general.
Changelog
+v1.74
+
+- Added several missing rc parameters.
+- Optional rc parameters are now truly optional.
+- rc output now provides more structured information.
+
v1.71
- bisync is now officially released from beta.
@@ -27082,12 +27299,15 @@ The S3 backend can be used with a number of different providers:
- DigitalOcean Spaces
- Dreamhost
- Exaba
+- Fastly Object Storage
- FileLu S5 (S3-Compatible Object Storage)
- GCS
- Hetzner
+- Hitachi Content Platform (HCP)
- Huawei OBS
- IBM COS S3
- IDrive e2
+- Impossible Cloud
- Intercolo Object Storage
- IONOS Cloud
- Leviia Object Storage
@@ -27110,11 +27330,12 @@ The S3 backend can be used with a number of different providers:
- Selectel
- Servercore Object Storage
- Spectra Logic
-- StackPath
- Storj
- Synology C2 Object Storage
- Tencent Cloud Object Storage (COS)
+- US3
- Wasabi
+- Zadara Object Storage
- Zata
Paths are specified as remote:bucket (or remote: for the lsd command.)
@@ -27690,6 +27911,26 @@ work with the SDK properly:
. .
.. ..
+Important note about double slashes (//)
+
+Object keys containing consecutive forward slashes (//) are not
+supported by rclone.
+
+When rclone encounters an object key with // (e.g., a//b), it will
+normalize the path to use a single slash (e.g., a/b). This normalization
+can cause "object not found" errors when trying to access the original
+object, as rclone will look for the normalized path instead of the
+actual object key.
+
+Example: - Original S3 object key: folder//file.txt - rclone interprets
+it as: folder/file.txt - Result: "object not found" error when trying to
+access folder//file.txt
+
+Workaround: Avoid using consecutive forward slashes (//) in S3 object
+keys when using rclone. If you have existing objects with // in their
+keys, you will need to rename them to use single slashes or access them
+through other means.
+
Multipart uploads
rclone supports multipart uploads with S3 which means that it can upload
@@ -27920,21 +28161,68 @@ According to AWS's documentation on S3 Object Lock:
If you configure a default retention period on a bucket, requests to
upload objects in such a bucket must include the Content-MD5 header.
-As mentioned in the Modification times and hashes section, small files
-that are not uploaded as multipart, use a different tag, causing the
-upload to fail. A simple solution is to set the --s3-upload-cutoff 0 and
-force all the files to be uploaded as multipart.
+Rclone automatically computes and includes the Content-MD5 header when
+uploading objects with Object Lock parameters set. No special
+configuration is needed.
+
+Setting Object Lock retention
+
+Rclone supports setting Object Lock retention on uploaded objects with
+the following options:
+
+- --s3-object-lock-mode - Set the Object Lock mode (GOVERNANCE or
+ COMPLIANCE)
+- --s3-object-lock-retain-until-date - Set the retention date (RFC3339
+ format or duration like 365d, 24h)
+- --s3-object-lock-legal-hold-status - Set legal hold (ON or OFF)
+
+Example - upload files with 1 year GOVERNANCE retention:
+
+ rclone copy local:/data remote:bucket \
+ --s3-object-lock-mode GOVERNANCE \
+ --s3-object-lock-retain-until-date 365d
+
+Copying Object Lock settings from source
+
+When using --metadata, you can use the special value copy to preserve
+the source object's Object Lock settings:
+
+ rclone copy source:bucket dest:bucket \
+ --metadata \
+ --s3-object-lock-mode copy \
+ --s3-object-lock-retain-until-date copy
+
+You can also mix copied and explicit values. For example, to change the
+mode from COMPLIANCE to GOVERNANCE while preserving the original
+retention date:
+
+ rclone copy source:bucket dest:bucket \
+ --metadata \
+ --s3-object-lock-mode GOVERNANCE \
+ --s3-object-lock-retain-until-date copy
+
+Additional Object Lock options
+
+- --s3-bypass-governance-retention - Required to delete or overwrite
+ objects with GOVERNANCE mode retention before the retention date
+ expires
+- --s3-bucket-object-lock-enabled - Enable Object Lock when creating a
+ new bucket with rclone mkdir
+- --s3-object-lock-set-after-upload - Set Object Lock via separate API
+ calls after upload (for providers that don't support Object Lock
+ headers during PUT)
Standard options
Here are the Standard options specific to s3 (Amazon S3 Compliant
Storage Providers including AWS, Alibaba, ArvanCloud, BizflyCloud, Ceph,
-ChinaMobile, Cloudflare, Cubbit, DigitalOcean, Dreamhost, Exaba, FileLu,
-FlashBlade, GCS, Hetzner, HuaweiOBS, IBMCOS, IDrive, Intercolo, IONOS,
-Leviia, Liara, Linode, LyveCloud, Magalu, Mega, Minio, Netease,
-Outscale, OVHcloud, Petabox, Qiniu, Rabata, RackCorp, Rclone, Scaleway,
-SeaweedFS, Selectel, Servercore, SpectraLogic, StackPath, Storj,
-Synology, TencentCOS, Wasabi, Zata, Other).
+ChinaMobile, Cloudflare, Cubbit, DigitalOcean, Dreamhost, Exaba, Fastly,
+FileLu, FlashBlade, GCS, HCP, Hetzner, HuaweiOBS, IBMCOS, IDrive,
+ImpossibleCloud, Intercolo, IONOS, Leviia, Liara, Linode, LyveCloud,
+Magalu, Mega, Minio, Netease, Outscale, OVHcloud, Petabox, Qiniu,
+Rabata, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Servercore,
+SpectraLogic, Storj, Synology, TencentCOS, US3, Wasabi, Zadara, Zata,
+Other).
--s3-provider
@@ -27969,12 +28257,16 @@ Properties:
- Dreamhost DreamObjects
- "Exaba"
- Exaba Object Storage
+ - "Fastly"
+ - Fastly Object Storage
- "FileLu"
- FileLu S5 (S3-Compatible Object Storage)
- "FlashBlade"
- Pure Storage FlashBlade Object Storage
- "GCS"
- Google Cloud Storage
+ - "HCP"
+ - Hitachi Content Platform (HCP)
- "Hetzner"
- Hetzner Object Storage
- "HuaweiOBS"
@@ -27983,6 +28275,8 @@ Properties:
- IBM COS S3
- "IDrive"
- IDrive e2
+ - "ImpossibleCloud"
+ - Impossible Cloud Object Storage
- "Intercolo"
- Intercolo Object Storage
- "IONOS"
@@ -28027,16 +28321,18 @@ Properties:
- Servercore Object Storage
- "SpectraLogic"
- Spectra Logic Black Pearl
- - "StackPath"
- - StackPath Object Storage
- "Storj"
- Storj (S3 Compatible Gateway)
- "Synology"
- Synology C2 Object Storage
- "TencentCOS"
- Tencent Cloud Object Storage (COS)
+ - "US3"
+ - US3 Object Storage
- "Wasabi"
- Wasabi Object Storage
+ - "Zadara"
+ - Zadara Object Storage
- "Zata"
- Zata (S3 compatible Gateway)
- "Other"
@@ -28098,7 +28394,7 @@ Properties:
- Config: region
- Env Var: RCLONE_S3_REGION
- Provider:
- AWS,BizflyCloud,Ceph,Cloudflare,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,Hetzner,HuaweiOBS,IBMCOS,Intercolo,IONOS,Leviia,LyveCloud,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,Rabata,RackCorp,Scaleway,SeaweedFS,Selectel,Servercore,StackPath,Synology,Wasabi,Zata,Other
+ AWS,BizflyCloud,Ceph,Cloudflare,Cubbit,DigitalOcean,Dreamhost,Exaba,Fastly,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IBMCOS,ImpossibleCloud,Intercolo,IONOS,Leviia,LyveCloud,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,Rabata,RackCorp,Scaleway,SeaweedFS,Selectel,Servercore,Synology,Wasabi,Zadara,Zata,Other
- Type: string
- Required: false
- Examples:
@@ -28217,12 +28513,12 @@ Properties:
- Use this if unsure.
- Will use v4 signatures and an empty region.
- Provider:
- Ceph,DigitalOcean,Dreamhost,Exaba,GCS,IBMCOS,Leviia,LyveCloud,Minio,Netease,SeaweedFS,StackPath,Wasabi,Other
+ Ceph,DigitalOcean,Dreamhost,Exaba,GCS,HCP,IBMCOS,Leviia,LyveCloud,Minio,Netease,SeaweedFS,Wasabi,Other
- "other-v2-signature"
- Use this only if v4 signatures don't work.
- E.g. pre Jewel/v10 CEPH.
- Provider:
- Ceph,DigitalOcean,Dreamhost,Exaba,GCS,IBMCOS,Leviia,LyveCloud,Minio,Netease,SeaweedFS,StackPath,Wasabi,Other
+ Ceph,DigitalOcean,Dreamhost,Exaba,GCS,HCP,IBMCOS,Leviia,LyveCloud,Minio,Netease,SeaweedFS,Wasabi,Other
- "auto"
- R2 buckets are automatically distributed across Cloudflare's
data centers for low latency.
@@ -28230,6 +28526,30 @@ Properties:
- "eu-west-1"
- Europe West
- Provider: Cubbit
+ - "au-east-1"
+ - AU East 1
+ - Provider: Fastly
+ - "eu-central"
+ - EU Central
+ - Provider: Fastly
+ - "eu-south-1"
+ - EU South 1
+ - Provider: Fastly
+ - "jp-central-1"
+ - JP Central 1
+ - Provider: Fastly
+ - "uk-east-1"
+ - UK East 1
+ - Provider: Fastly
+ - "us-central-1"
+ - US Central 1
+ - Provider: Fastly
+ - "us-east"
+ - US East
+ - Provider: Fastly
+ - "us-west"
+ - US West
+ - Provider: Fastly
- "global"
- Global
- Provider: FileLu
@@ -28299,6 +28619,27 @@ Properties:
- "ru-northwest-2"
- RU-Moscow2
- Provider: HuaweiOBS
+ - "eu-central-2"
+ - Frankfurt, Germany
+ - Provider: ImpossibleCloud
+ - "eu-west-1"
+ - Amsterdam, Netherlands
+ - Provider: ImpossibleCloud
+ - "eu-west-2"
+ - London, UK
+ - Provider: ImpossibleCloud
+ - "eu-west-3"
+ - Paris, France
+ - Provider: ImpossibleCloud
+ - "eu-east-1"
+ - Poznań, Poland
+ - Provider: ImpossibleCloud
+ - "eu-north-1"
+ - Copenhagen, Denmark
+ - Provider: ImpossibleCloud
+ - "us-east-1"
+ - New York, USA
+ - Provider: ImpossibleCloud
- "de-fra"
- Frankfurt, Germany
- Provider: Intercolo
@@ -28308,9 +28649,18 @@ Properties:
- "eu-central-2"
- Berlin, Germany
- Provider: IONOS
+ - "eu-central-3"
+ - Berlin, Germany
+ - Provider: IONOS
+ - "eu-central-4"
+ - Frankfurt, Germany
+ - Provider: IONOS
- "eu-south-2"
- Logrono, Spain
- Provider: IONOS
+ - "us-central-1"
+ - Lenexa, USA
+ - Provider: IONOS
- "eu-west-2"
- Paris, France
- Provider: Outscale
@@ -28523,6 +28873,10 @@ Properties:
- "tw-001"
- Asia (Taiwan)
- Provider: Synology
+ - "us-east-1"
+ - The default region.
+ - Leave location constraint empty.
+ - Provider: Zadara
- "us-east-1"
- Indore, Madhya Pradesh, India
- Provider: Zata
@@ -28538,7 +28892,7 @@ Properties:
- Config: endpoint
- Env Var: RCLONE_S3_ENDPOINT
- Provider:
- AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cloudflare,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,FlashBlade,GCS,Hetzner,HuaweiOBS,IBMCOS,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Mega,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,Rabata,RackCorp,Rclone,Scaleway,SeaweedFS,Selectel,Servercore,SpectraLogic,StackPath,Storj,Synology,TencentCOS,Wasabi,Zata,Other
+ AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cloudflare,Cubbit,DigitalOcean,Dreamhost,Exaba,Fastly,FileLu,FlashBlade,GCS,HCP,Hetzner,HuaweiOBS,IBMCOS,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Mega,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,Rabata,RackCorp,Rclone,Scaleway,SeaweedFS,Selectel,Servercore,SpectraLogic,Storj,Synology,TencentCOS,US3,Wasabi,Zadara,Zata,Other
- Type: string
- Required: false
- Examples:
@@ -28724,6 +29078,10 @@ Properties:
- "s3.cubbit.eu"
- Cubbit DS3 Object Storage endpoint
- Provider: Cubbit
+ - "s3.{tenant_name}.cubbit.eu"
+ - Multi-tenant endpoint - replace {tenant_name} with your
+ actual tenant name. Do not select this directly
+ - Provider: Cubbit
- "syd1.digitaloceanspaces.com"
- DigitalOcean Spaces Sydney 1
- Provider: DigitalOcean
@@ -28757,6 +29115,30 @@ Properties:
- "objects-us-east-1.dream.io"
- Dream Objects endpoint
- Provider: Dreamhost
+ - "au-east-1.object.fastlystorage.app"
+ - AU East 1
+ - Provider: Fastly
+ - "eu-central.object.fastlystorage.app"
+ - EU Central
+ - Provider: Fastly
+ - "eu-south-1.object.fastlystorage.app"
+ - EU South 1
+ - Provider: Fastly
+ - "jp-central-1.object.fastlystorage.app"
+ - JP Central 1
+ - Provider: Fastly
+ - "uk-east-1.object.fastlystorage.app"
+ - UK East 1
+ - Provider: Fastly
+ - "us-central-1.object.fastlystorage.app"
+ - US Central 1
+ - Provider: Fastly
+ - "us-east.object.fastlystorage.app"
+ - US East
+ - Provider: Fastly
+ - "us-west.object.fastlystorage.app"
+ - US West
+ - Provider: Fastly
- "s5lu.com"
- Global FileLu S5 endpoint
- Provider: FileLu
@@ -29015,18 +29397,48 @@ Properties:
- "s3.private.sng01.cloud-object-storage.appdomain.cloud"
- Singapore Single Site Private Endpoint
- Provider: IBMCOS
+ - "eu-central-2.storage.impossibleapi.net"
+ - Frankfurt, Germany
+ - Provider: ImpossibleCloud
+ - "eu-west-1.storage.impossibleapi.net"
+ - Amsterdam, Netherlands
+ - Provider: ImpossibleCloud
+ - "eu-west-2.storage.impossibleapi.net"
+ - London, UK
+ - Provider: ImpossibleCloud
+ - "eu-west-3.storage.impossibleapi.net"
+ - Paris, France
+ - Provider: ImpossibleCloud
+ - "eu-east-1.storage.impossibleapi.net"
+ - Poznań, Poland
+ - Provider: ImpossibleCloud
+ - "eu-north-1.storage.impossibleapi.net"
+ - Copenhagen, Denmark
+ - Provider: ImpossibleCloud
+ - "us-east-1.storage.impossibleapi.net"
+ - New York, USA
+ - Provider: ImpossibleCloud
- "de-fra.i3storage.com"
- Frankfurt, Germany
- Provider: Intercolo
- - "s3-eu-central-1.ionoscloud.com"
+ - "s3.eu-central-1.ionoscloud.com"
- Frankfurt, Germany
- Provider: IONOS
- - "s3-eu-central-2.ionoscloud.com"
+ - "s3.eu-central-2.ionoscloud.com"
- Berlin, Germany
- Provider: IONOS
- - "s3-eu-south-2.ionoscloud.com"
+ - "s3.eu-central-3.ionoscloud.com"
+ - Berlin, Germany
+ - Provider: IONOS
+ - "s3.eu-central-4.ionoscloud.com"
+ - Frankfurt, Germany
+ - Provider: IONOS
+ - "s3.eu-south-2.ionoscloud.com"
- Logrono, Spain
- Provider: IONOS
+ - "s3.us-central-1.ionoscloud.com"
+ - Lenexa, USA
+ - Provider: IONOS
- "s3.leviia.com"
- The default endpoint
- Leviia
@@ -29326,15 +29738,6 @@ Properties:
- "s3.kz-1.srvstorage.kz"
- Almaty, Kazakhstan
- Provider: Servercore
- - "s3.us-east-2.stackpathstorage.com"
- - US East Endpoint
- - Provider: StackPath
- - "s3.us-west-1.stackpathstorage.com"
- - US West Endpoint
- - Provider: StackPath
- - "s3.eu-central-1.stackpathstorage.com"
- - EU Endpoint
- - Provider: StackPath
- "gateway.storjshare.io"
- Global Hosted Gateway
- Provider: Storj
@@ -29407,6 +29810,75 @@ Properties:
- "cos.accelerate.myqcloud.com"
- Use Tencent COS Accelerate Endpoint
- Provider: TencentCOS
+ - "s3-cn-bj.ufileos.com"
+ - North China (Beijing 2)
+ - Provider: US3
+ - "s3-cn-wlcb.ufileos.com"
+ - North China (Ulanqab)
+ - Provider: US3
+ - "s3-cn-sh2.ufileos.com"
+ - Shanghai
+ - Provider: US3
+ - "s3-cn-gd.ufileos.com"
+ - South China (Guangzhou)
+ - Provider: US3
+ - "s3-hk.ufileos.com"
+ - Hongkong
+ - Provider: US3
+ - "s3-us-ca.ufileos.com"
+ - United States (Los Angeles)
+ - Provider: US3
+ - "s3-sg.ufileos.com"
+ - Singapore
+ - Provider: US3
+ - "s3-idn-jakarta.ufileos.com"
+ - Indonesia (Jakarta)
+ - Provider: US3
+ - "s3-tw-tp.ufileos.com"
+ - Taiwan (Taipei)
+ - Provider: US3
+ - "s3-afr-nigeria.ufileos.com"
+ - Nigeria (Lagos)
+ - Provider: US3
+ - "s3-bra-saopaulo.ufileos.com"
+ - Brazil (São Paulo)
+ - Provider: US3
+ - "s3-uae-dubai.ufileos.com"
+ - United Arab Emirates (Dubai)
+ - Provider: US3
+ - "s3-ge-fra.ufileos.com"
+ - Germany (Frankfurt)
+ - Provider: US3
+ - "s3-vn-sng.ufileos.com"
+ - Vietnam (Ho Chi Minh City)
+ - Provider: US3
+ - "s3-us-ws.ufileos.com"
+ - United States (Washington)
+ - Provider: US3
+ - "s3-ind-mumbai.ufileos.com"
+ - India (Mumbai)
+ - Provider: US3
+ - "s3-kr-seoul.ufileos.com"
+ - Seoul (South Korea)
+ - Provider: US3
+ - "s3-jpn-tky.ufileos.com"
+ - Japan (Tokyo)
+ - Provider: US3
+ - "s3-th-bkk.ufileos.com"
+ - Bangkok (Thailand)
+ - Provider: US3
+ - "s3-uk-london.ufileos.com"
+ - United Kingdom (London)
+ - Provider: US3
+ - "s3-rus-mosc.ufileos.com"
+ - Russia (Moscow)
+ - Provider: US3
+ - "s3-cn-guiyang1.ufileos.com"
+ - Guiyang 1
+ - Provider: US3
+ - "s3-pk-khi.ufileos.com"
+ - Pakistan
+ - Provider: US3
- "s3.wasabisys.com"
- Wasabi US East 1 (N. Virginia)
- Provider: Wasabi
@@ -29464,7 +29936,7 @@ Properties:
- Config: location_constraint
- Env Var: RCLONE_S3_LOCATION_CONSTRAINT
- Provider:
- AWS,ArvanCloud,Ceph,ChinaMobile,DigitalOcean,Dreamhost,Exaba,GCS,Hetzner,IBMCOS,LyveCloud,Minio,Netease,Qiniu,Rabata,RackCorp,SeaweedFS,Synology,Wasabi,Zata,Other
+ AWS,ArvanCloud,Ceph,ChinaMobile,DigitalOcean,Dreamhost,Exaba,GCS,HCP,Hetzner,IBMCOS,ImpossibleCloud,LyveCloud,Minio,Netease,Qiniu,Rabata,RackCorp,SeaweedFS,Synology,Wasabi,Zata,Other
- Type: string
- Required: false
- Examples:
@@ -29847,7 +30319,7 @@ Properties:
- Config: acl
- Env Var: RCLONE_S3_ACL
- Provider:
- AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,Hetzner,HuaweiOBS,IBMCOS,IDrive,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,StackPath,TencentCOS,Wasabi,Zata,Other
+ AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IBMCOS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,US3,Wasabi,Zata,Other
- Type: string
- Required: false
- Examples:
@@ -29855,37 +30327,37 @@ Properties:
- Owner gets FULL_CONTROL.
- No one else has access rights (default).
- Provider:
- AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,Hetzner,HuaweiOBS,IDrive,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,StackPath,Wasabi,Zata,Other
+ AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,US3,Wasabi,Zata,Other
- "public-read"
- Owner gets FULL_CONTROL.
- The AllUsers group gets READ access.
- Provider:
- AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,Hetzner,HuaweiOBS,IDrive,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,StackPath,TencentCOS,Wasabi,Zata,Other
+ AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,US3,Wasabi,Zata,Other
- "public-read-write"
- Owner gets FULL_CONTROL.
- The AllUsers group gets READ and WRITE access.
- Granting this on a bucket is generally not recommended.
- Provider:
- AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,Hetzner,HuaweiOBS,IDrive,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,StackPath,TencentCOS,Wasabi,Zata,Other
+ AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,Wasabi,Zata,Other
- "authenticated-read"
- Owner gets FULL_CONTROL.
- The AuthenticatedUsers group gets READ access.
- Provider:
- AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,Hetzner,HuaweiOBS,IDrive,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,StackPath,TencentCOS,Wasabi,Zata,Other
+ AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,Wasabi,Zata,Other
- "bucket-owner-read"
- Object owner gets FULL_CONTROL.
- Bucket owner gets READ access.
- If you specify this canned ACL when creating a bucket,
Amazon S3 ignores it.
- Provider:
- AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,Hetzner,HuaweiOBS,IDrive,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,StackPath,TencentCOS,Wasabi,Zata,Other
+ AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,Wasabi,Zata,Other
- "bucket-owner-full-control"
- Both the object owner and the bucket owner get FULL_CONTROL
over the object.
- If you specify this canned ACL when creating a bucket,
Amazon S3 ignores it.
- Provider:
- AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,Hetzner,HuaweiOBS,IDrive,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,StackPath,TencentCOS,Wasabi,Zata,Other
+ AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,Wasabi,Zata,Other
- "private"
- Owner gets FULL_CONTROL.
- No one else has access rights (default).
@@ -29965,23 +30437,23 @@ Properties:
- Config: storage_class
- Env Var: RCLONE_S3_STORAGE_CLASS
- Provider:
- AWS,Alibaba,ArvanCloud,ChinaMobile,Liara,Magalu,Qiniu,Scaleway,TencentCOS
+ AWS,Alibaba,ArvanCloud,ChinaMobile,Liara,Magalu,OVHcloud,Qiniu,Scaleway,TencentCOS,US3
- Type: string
- Required: false
- Examples:
- ""
- Default
- - Provider: AWS,Alibaba,ChinaMobile,TencentCOS
+ - Provider: AWS,Alibaba,ChinaMobile,OVHcloud,TencentCOS,US3
- "STANDARD"
- Standard storage class
- Provider:
- AWS,Alibaba,ArvanCloud,ChinaMobile,Liara,Magalu,Qiniu,TencentCOS
+ AWS,Alibaba,ArvanCloud,ChinaMobile,Liara,Magalu,OVHcloud,Qiniu,TencentCOS,US3
- "REDUCED_REDUNDANCY"
- Reduced redundancy storage class
- Provider: AWS
- "STANDARD_IA"
- Standard Infrequent Access storage class
- - Provider: AWS
+ - Provider: AWS,OVHcloud
- "ONEZONE_IA"
- One Zone Infrequent Access storage class
- Provider: AWS
@@ -30002,7 +30474,25 @@ Properties:
- Provider: Alibaba,ChinaMobile,Qiniu
- "STANDARD_IA"
- Infrequent access storage mode
- - Provider: Alibaba,ChinaMobile,TencentCOS
+ - Provider: Alibaba,ChinaMobile,TencentCOS,US3
+ - "EXPRESS_ONEZONE"
+ - High Performance storage class
+ - Provider: OVHcloud
+ - "ONEZONE_IA"
+ - Standard Infrequent Access storage class
+ - Provider: OVHcloud
+ - "GLACIER"
+ - Active Archive storage class
+ - Provider: OVHcloud
+ - "GLACIER_IR"
+ - Active Archive storage class
+ - Provider: OVHcloud
+ - "DEEP_ARCHIVE"
+ - Cold Archive storage class
+ - Provider: OVHcloud
+ - "INTELLIGENT_TIERING"
+ - Standard storage class
+ - Provider: OVHcloud
- "LINE"
- Infrequent access storage mode
- Provider: Qiniu
@@ -30021,17 +30511,17 @@ Properties:
- Archived storage.
- Prices are lower, but it needs to be restored first to be
accessed.
- - Available in FR-PAR and NL-AMS regions.
+ - Available in the FR-PAR region only.
- Provider: Scaleway
- "ONEZONE_IA"
- One Zone - Infrequent Access.
- A good choice for storing secondary backup copies or easily
re-creatable data.
- - Available in the FR-PAR region only.
+ - Available in all regions.
- Provider: Scaleway
- "ARCHIVE"
- Archive storage mode
- - Provider: TencentCOS
+ - Provider: TencentCOS,US3
--s3-ibm-api-key
@@ -30057,16 +30547,28 @@ Properties:
- Type: string
- Required: false
+--s3-bucket-object-lock-enabled
+
+Enable Object Lock when creating new buckets.
+
+Properties:
+
+- Config: bucket_object_lock_enabled
+- Env Var: RCLONE_S3_BUCKET_OBJECT_LOCK_ENABLED
+- Type: bool
+- Default: false
+
Advanced options
Here are the Advanced options specific to s3 (Amazon S3 Compliant
Storage Providers including AWS, Alibaba, ArvanCloud, BizflyCloud, Ceph,
-ChinaMobile, Cloudflare, Cubbit, DigitalOcean, Dreamhost, Exaba, FileLu,
-FlashBlade, GCS, Hetzner, HuaweiOBS, IBMCOS, IDrive, Intercolo, IONOS,
-Leviia, Liara, Linode, LyveCloud, Magalu, Mega, Minio, Netease,
-Outscale, OVHcloud, Petabox, Qiniu, Rabata, RackCorp, Rclone, Scaleway,
-SeaweedFS, Selectel, Servercore, SpectraLogic, StackPath, Storj,
-Synology, TencentCOS, Wasabi, Zata, Other).
+ChinaMobile, Cloudflare, Cubbit, DigitalOcean, Dreamhost, Exaba, Fastly,
+FileLu, FlashBlade, GCS, HCP, Hetzner, HuaweiOBS, IBMCOS, IDrive,
+ImpossibleCloud, Intercolo, IONOS, Leviia, Liara, Linode, LyveCloud,
+Magalu, Mega, Minio, Netease, Outscale, OVHcloud, Petabox, Qiniu,
+Rabata, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Servercore,
+SpectraLogic, Storj, Synology, TencentCOS, US3, Wasabi, Zadara, Zata,
+Other).
--s3-bucket-acl
@@ -30086,7 +30588,7 @@ Properties:
- Config: bucket_acl
- Env Var: RCLONE_S3_BUCKET_ACL
- Provider:
- AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,Hetzner,HuaweiOBS,IBMCOS,IDrive,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Mega,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,Servercore,StackPath,TencentCOS,Wasabi,Zata,Other
+ AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IBMCOS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Mega,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,Servercore,TencentCOS,US3,Wasabi,Zata,Other
- Type: string
- Required: false
- Examples:
@@ -30968,6 +31470,26 @@ Properties:
- Type: Tristate
- Default: unset
+--s3-list-versions-oldest-first
+
+Set if the backend returns object versions oldest first.
+
+The S3 standard returns object versions newest first. Some backends
+(e.g. Hitachi HCP) return them oldest first instead.
+
+Set this quirk if --s3-version-at or --s3-versions produce incorrect
+results with your backend.
+
+This should be automatically set correctly for all providers rclone
+knows about - please make a bug report if not.
+
+Properties:
+
+- Config: list_versions_oldest_first
+- Env Var: RCLONE_S3_LIST_VERSIONS_OLDEST_FIRST
+- Type: Tristate
+- Default: unset
+
--s3-use-x-id
Set if rclone should add x-id URL parameters.
@@ -31067,6 +31589,167 @@ Properties:
- Type: Bits
- Default: Off
+--s3-ibm-iam-endpoint
+
+IBM IAM Endpoint to use for authentication.
+
+Leave blank to use the default public endpoint.
+
+Properties:
+
+- Config: ibm_iam_endpoint
+- Env Var: RCLONE_S3_IBM_IAM_ENDPOINT
+- Provider: IBMCOS
+- Type: string
+- Required: false
+
+--s3-object-lock-mode
+
+Object Lock mode to apply when uploading or copying objects.
+
+Set this to apply Object Lock retention mode to objects. If not set, no
+Object Lock mode is applied (even with --metadata).
+
+Note: To enable Object Lock retention, you must set BOTH
+object_lock_mode AND object_lock_retain_until_date. Setting only one has
+no effect.
+
+- GOVERNANCE: Set Object Lock mode to GOVERNANCE
+- COMPLIANCE: Set Object Lock mode to COMPLIANCE
+- copy: Copy the mode from the source object (requires --metadata)
+
+See:
+https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html
+
+Properties:
+
+- Config: object_lock_mode
+- Env Var: RCLONE_S3_OBJECT_LOCK_MODE
+- Type: string
+- Required: false
+- Examples:
+ - "GOVERNANCE"
+ - Set Object Lock mode to GOVERNANCE
+ - "COMPLIANCE"
+ - Set Object Lock mode to COMPLIANCE
+ - "copy"
+ - Copy from source object (requires --metadata)
+
+--s3-object-lock-retain-until-date
+
+Object Lock retention until date to apply when uploading or copying
+objects.
+
+Set this to apply Object Lock retention date to objects. If not set, no
+retention date is applied (even with --metadata).
+
+Note: To enable Object Lock retention, you must set BOTH
+object_lock_mode AND object_lock_retain_until_date. Setting only one has
+no effect.
+
+Accepts: - RFC 3339 format: 2030-01-02T15:04:05Z - Duration from now:
+365d, 1y, 6M (days, years, months) - copy: Copy the date from the source
+object (requires --metadata)
+
+See:
+https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html
+
+Properties:
+
+- Config: object_lock_retain_until_date
+- Env Var: RCLONE_S3_OBJECT_LOCK_RETAIN_UNTIL_DATE
+- Type: string
+- Required: false
+- Examples:
+ - "copy"
+ - Copy from source object (requires --metadata)
+ - "2030-01-01T00:00:00Z"
+ - Set specific date (RFC 3339 format)
+ - "365d"
+ - Set retention for 365 days from now
+ - "1y"
+ - Set retention for 1 year from now
+
+--s3-object-lock-legal-hold-status
+
+Object Lock legal hold status to apply when uploading or copying
+objects.
+
+Set this to apply Object Lock legal hold to objects. If not set, no
+legal hold is applied (even with --metadata).
+
+Note: Legal hold is independent of retention and can be set separately.
+
+- ON: Enable legal hold
+- OFF: Disable legal hold
+- copy: Copy the legal hold status from the source object (requires
+ --metadata)
+
+See:
+https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html
+
+Properties:
+
+- Config: object_lock_legal_hold_status
+- Env Var: RCLONE_S3_OBJECT_LOCK_LEGAL_HOLD_STATUS
+- Type: string
+- Required: false
+- Examples:
+ - "ON"
+ - Enable legal hold
+ - "OFF"
+ - Disable legal hold
+ - "copy"
+ - Copy from source object (requires --metadata)
+
+--s3-bypass-governance-retention
+
+Allow deleting or modifying objects locked with GOVERNANCE mode.
+
+Properties:
+
+- Config: bypass_governance_retention
+- Env Var: RCLONE_S3_BYPASS_GOVERNANCE_RETENTION
+- Type: bool
+- Default: false
+
+--s3-object-lock-set-after-upload
+
+Set Object Lock via separate API calls after upload.
+
+Use this for S3-compatible providers that don't support setting Object
+Lock headers during PUT operations. When enabled, Object Lock is set via
+separate PutObjectRetention and PutObjectLegalHold API calls after the
+upload completes.
+
+This adds extra API calls per object, so only enable if your provider
+requires it.
+
+Properties:
+
+- Config: object_lock_set_after_upload
+- Env Var: RCLONE_S3_OBJECT_LOCK_SET_AFTER_UPLOAD
+- Type: bool
+- Default: false
+
+--s3-object-lock-supported
+
+Whether the provider supports S3 Object Lock.
+
+This should be true, false or left unset to use the default for the
+provider.
+
+Set to false for providers that don't fully support the S3 Object Lock
+API (e.g. GCS which uses non-standard headers for bypass governance
+retention and doesn't implement Legal Hold via the S3 API).
+
+Properties:
+
+- Config: object_lock_supported
+- Env Var: RCLONE_S3_OBJECT_LOCK_SUPPORTED
+- Type: Tristate
+- Default: unset
+
--s3-description
Description of the remote.
@@ -31085,32 +31768,43 @@ insensitive and are always returned in lower case.
Here are the possible system metadata items for the s3 backend.
- ------------------------------------------------------------------------------------------------------------------
- Name Help Type Example Read Only
- --------------------- --------------------- ----------- ------------------------------------- --------------------
- btime Time of file birth RFC 3339 2006-01-02T15:04:05.999999999Z07:00 Y
- (creation) read from
- Last-Modified header
+ ----------------------------------------------------------------------------------------------------------------------------
+ Name Help Type Example Read Only
+ ------------------------------- --------------------- ----------- ------------------------------------- --------------------
+ btime Time of file birth RFC 3339 2006-01-02T15:04:05.999999999Z07:00 Y
+ (creation) read from
+ Last-Modified header
- cache-control Cache-Control header string no-cache N
+ cache-control Cache-Control header string no-cache N
- content-disposition Content-Disposition string inline N
- header
+ content-disposition Content-Disposition string inline N
+ header
- content-encoding Content-Encoding string gzip N
- header
+ content-encoding Content-Encoding string gzip N
+ header
- content-language Content-Language string en-US N
- header
+ content-language Content-Language string en-US N
+ header
- content-type Content-Type header string text/plain N
+ content-type Content-Type header string text/plain N
- mtime Time of last RFC 3339 2006-01-02T15:04:05.999999999Z07:00 N
- modification, read
- from rclone metadata
+ mtime Time of last RFC 3339 2006-01-02T15:04:05.999999999Z07:00 N
+ modification, read
+ from rclone metadata
- tier Tier of the object string GLACIER Y
- ------------------------------------------------------------------------------------------------------------------
+ object-lock-legal-hold-status Object Lock legal string OFF N
+ hold status: ON or
+ OFF
+
+ object-lock-mode Object Lock mode: string GOVERNANCE N
+ GOVERNANCE or
+ COMPLIANCE
+
+ object-lock-retain-until-date Object Lock retention RFC 3339 2030-01-02T15:04:05Z N
+ until date
+
+ tier Tier of the object string GLACIER Y
+ ----------------------------------------------------------------------------------------------------------------------------
See the metadata docs for more info.
@@ -31986,7 +32680,7 @@ of a bucket publicly.
Type of storage to configure.
Choose a number from below, or type in your own value.
...
- XX / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, China Mobile, Cloudflare, ArvanCloud, DigitalOcean, Dreamhost, Huawei OBS, IBM COS, Lyve Cloud, Minio, Magalu, Netease, RackCorp, Scaleway, SeaweedFS, StackPath, Storj, Synology, Tencent COS and Wasabi
+ XX / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, China Mobile, Cloudflare, ArvanCloud, DigitalOcean, Dreamhost, Huawei OBS, IBM COS, Lyve Cloud, Minio, Magalu, Netease, RackCorp, Scaleway, SeaweedFS, Storj, Synology, Tencent COS and Wasabi
\ (s3)
...
Storage> s3
@@ -32076,7 +32770,9 @@ pair. You can follow this guide to retrieve these keys. They will be
needed when prompted by rclone config.
Default region will correspond to eu-west-1 and the endpoint has to be
-specified as s3.cubbit.eu.
+specified as s3.cubbit.eu. If you set a custom tenant endpoint, you must
+use s3.{tenant_name}.cubbit.eu, because the generic s3.cubbit.eu
+endpoint will not work in this case.
Going through the whole process of creating a new remote by running
rclone config, each prompt should be answered as shown below:
@@ -32088,7 +32784,7 @@ rclone config, each prompt should be answered as shown below:
access_key_id> YOUR_ACCESS_KEY
secret_access_key> YOUR_SECRET_KEY
region> eu-west-1 (or leave empty)
- endpoint> s3.cubbit.eu
+ endpoint> s3.cubbit.eu (or s3.{tenant_name}.cubbit.eu)
acl>
The resulting configuration file should look like:
@@ -32247,6 +32943,85 @@ And the config generated will end up looking like this:
secret_access_key = XXX
endpoint = http://127.0.0.1:9000/
+Fastly Object Storage
+
+Fastly Object Storage is an S3-compatible object storage service from
+Fastly. It provides three regions (US East, US West, and EU Central)
+with mandatory server-side encryption.
+
+Here is an example of making a configuration. First run:
+
+ rclone config
+
+This will guide you through an interactive setup process.
+
+ No remotes found, make a new one?
+ n) New remote
+ s) Set configuration password
+ q) Quit config
+ n/s/q> n
+
+ Enter name for new remote.
+ name> fastly
+
+ Option Storage.
+ Type of storage to configure.
+ Storage> s3
+
+ Option provider.
+ Choose your S3 provider.
+ provider> Fastly
+
+ 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.
+ env_auth> false
+
+ Option access_key_id.
+ AWS Access Key ID.
+ access_key_id> YOUR_ACCESS_KEY
+
+ Option secret_access_key.
+ AWS Secret Access Key (password).
+ secret_access_key> YOUR_SECRET_KEY
+
+ Option region.
+ Region where your bucket will be created and your data stored.
+ region> us-east
+
+ Option endpoint.
+ Endpoint for S3 API.
+ endpoint> us-east.object.fastlystorage.app
+
+ Edit advanced config?
+ y) Yes
+ n) No (default)
+ y/n> n
+
+ Configuration complete.
+ Options:
+ - type: s3
+ - provider: Fastly
+ - access_key_id: YOUR_ACCESS_KEY
+ - secret_access_key: YOUR_SECRET_KEY
+ - region: us-east
+ - endpoint: us-east.object.fastlystorage.app
+ Keep this "fastly" remote?
+ y) Yes this is OK (default)
+ e) Edit this remote
+ d) Delete this remote
+ y/e/d> y
+
+The resulting configuration file should look like:
+
+ [fastly]
+ type = s3
+ provider = Fastly
+ access_key_id = YOUR_ACCESS_KEY
+ secret_access_key = YOUR_SECRET_KEY
+ region = us-east
+ endpoint = us-east.object.fastlystorage.app
+
Google Cloud Storage
GoogleCloudStorage is an S3-interoperable object storage service from
@@ -32290,7 +33065,7 @@ This will guide you through an interactive setup process.
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, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, GCS, Hetzner, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, StackPath, Storj, Synology, TencentCOS, Wasabi, Qiniu and others
+ XX / Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, GCS, Hetzner, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Storj, Synology, TencentCOS, Wasabi, Qiniu and others
\ (s3)
[snip]
Storage> s3
@@ -32408,6 +33183,127 @@ This will leave the config file looking like this.
endpoint = hel1.your-objectstorage.com
acl = private
+Hitachi Content Platform (HCP)
+
+Here is an example of making a Hitachi Content Platform (HCP)
+configuration. First run:
+
+ rclone config
+
+This will guide you through an interactive setup process.
+
+ No remotes found, make a new one?
+ n) New remote
+ s) Set configuration password
+ q) Quit config
+ n/s/q> n
+
+ Enter name for new remote.
+ name> my-hcp
+ 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, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, GCS, HCP, Hetzner, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Storj, Synology, TencentCOS, Wasabi, Qiniu and others
+ \ (s3)
+ [snip]
+ Storage> s3
+ Option provider.
+ Choose your S3 provider.
+ Choose a number from below, or type in your own value.
+ Press Enter to leave empty.
+ [snip]
+ XX / Hitachi Content Platform (HCP)
+ \ (HCP)
+ [snip]
+ provider> HCP
+ 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>
+ Option access_key_id.
+ AWS Access Key ID.
+ Leave blank for anonymous access or runtime credentials.
+ Enter a value. Press Enter to leave empty.
+ access_key_id> ACCESS_KEY
+ Option secret_access_key.
+ AWS Secret Access Key (password).
+ Leave blank for anonymous access or runtime credentials.
+ Enter a value. Press Enter to leave empty.
+ secret_access_key> SECRET_KEY
+ Option endpoint.
+ Endpoint for HCP S3 compatible API.
+ Enter a value. Press Enter to leave empty.
+ endpoint> https://hcp.example.com
+ Edit advanced config?
+ y) Yes
+ n) No (default)
+ y/n>
+ Configuration complete.
+ Options:
+ - type: s3
+ - provider: HCP
+ - access_key_id: ACCESS_KEY
+ - secret_access_key: SECRET_KEY
+ - endpoint: https://hcp.example.com
+ Keep this "my-hcp" remote?
+ y) Yes this is OK (default)
+ e) Edit this remote
+ d) Delete this remote
+ y/e/d>
+ Current remotes:
+
+ Name Type
+ ==== ====
+ my-hcp 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>
+
+This will leave the config file looking like this.
+
+ [my-hcp]
+ type = s3
+ provider = HCP
+ access_key_id = ACCESS_KEY
+ secret_access_key = SECRET_KEY
+ endpoint = https://hcp.example.com
+
+Known limitations
+
+These limitations have been observed with HCP version 9.7.x.
+
+Automatic directory objects
+
+HCP automatically creates zero-byte directory objects (keys ending in /)
+for every path component when an object is stored. These directory
+objects are managed by HCP internally: deleting one via the S3 API does
+not remove it but instead creates a delete marker with a special version
+ID (-3) that cannot itself be deleted. As a result, rclone cannot fully
+purge a bucket on HCP — leftover directory objects will remain after a
+purge or delete operation.
+
+Transparent gzip decompression
+
+HCP transparently decompresses objects uploaded with
+Content-Encoding: gzip before storing them. This means the stored object
+contains the raw (uncompressed) data, while the Content-MD5 sent by
+rclone was computed over the compressed bytes. HCP will reject such
+uploads with a BadDigest error. To avoid this, do not set
+content-encoding: gzip in object metadata when using HCP.
+
Huawei OBS
Object Storage Service (OBS) provides stable, secure, efficient, and
@@ -32841,6 +33737,174 @@ This will guide you through an interactive setup process.
d) Delete this remote
y/e/d> y
+Impossible Cloud
+
+Impossible Cloud is a European S3-compatible object storage provider
+with regions in Europe and the US.
+
+Note: Impossible Cloud does not preserve the Cache-Control,
+Content-Disposition, Content-Encoding or Content-Language system
+metadata fields on retrieval, even when they were set at upload time.
+Because the Content-Encoding response header is also dropped, the
+--s3-decompress flag has no effect on objects stored there. Other
+metadata such as Content-Type and the modification time round-trip
+normally.
+
+Here is an example of making an Impossible Cloud configuration. First
+run:
+
+ rclone config
+
+This will guide you through an interactive setup process.
+
+ No remotes found, make a new one?
+ n) New remote
+ s) Set configuration password
+ q) Quit config
+ n/s/q> n
+
+ Enter name for new remote.
+ name> my-impossible-cloud
+ 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, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, GCS, Hetzner, HuaweiOBS, IBMCOS, IDrive, ImpossibleCloud, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Storj, Synology, TencentCOS, Wasabi, Qiniu and others
+ \ (s3)
+ [snip]
+ Storage> s3
+ Option provider.
+ Choose your S3 provider.
+ Choose a number from below, or type in your own value.
+ Press Enter to leave empty.
+ [snip]
+ XX / Impossible Cloud Object Storage
+ \ (ImpossibleCloud)
+ [snip]
+ provider> ImpossibleCloud
+ 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>
+ Option access_key_id.
+ AWS Access Key ID.
+ Leave blank for anonymous access or runtime credentials.
+ Enter a value. Press Enter to leave empty.
+ access_key_id> ACCESS_KEY
+ Option secret_access_key.
+ AWS Secret Access Key (password).
+ Leave blank for anonymous access or runtime credentials.
+ Enter a value. Press Enter to leave empty.
+ secret_access_key> SECRET_KEY
+ Option region.
+ Region to connect to.
+ Choose a number from below, or type in your own value.
+ Press Enter to leave empty.
+ 1 / Frankfurt, Germany
+ \ (eu-central-2)
+ 2 / Amsterdam, Netherlands
+ \ (eu-west-1)
+ 3 / London, UK
+ \ (eu-west-2)
+ 4 / Paris, France
+ \ (eu-west-3)
+ 5 / Poznań, Poland
+ \ (eu-east-1)
+ 6 / Copenhagen, Denmark
+ \ (eu-north-1)
+ 7 / New York, USA
+ \ (us-east-1)
+ region> 1
+ Option endpoint.
+ Endpoint for Impossible Cloud Object Storage
+ Choose a number from below, or type in your own value.
+ Press Enter to leave empty.
+ 1 / Frankfurt, Germany
+ \ (eu-central-2.storage.impossibleapi.net)
+ 2 / Amsterdam, Netherlands
+ \ (eu-west-1.storage.impossibleapi.net)
+ 3 / London, UK
+ \ (eu-west-2.storage.impossibleapi.net)
+ 4 / Paris, France
+ \ (eu-west-3.storage.impossibleapi.net)
+ 5 / Poznań, Poland
+ \ (eu-east-1.storage.impossibleapi.net)
+ 6 / Copenhagen, Denmark
+ \ (eu-north-1.storage.impossibleapi.net)
+ 7 / New York, USA
+ \ (us-east-1.storage.impossibleapi.net)
+ endpoint> 1
+ Option location_constraint.
+ Location constraint - must be set to match the Region.
+ Leave blank if not sure. Used when creating buckets only.
+ Enter a value. Press Enter to leave empty.
+ location_constraint>
+ 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'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't copy the ACL from the source but rather writes a fresh one.
+ If the acl is an empty string then no X-Amz-Acl: header is added and
+ the default (private) will be used.
+ Choose a number from below, or type in your own value.
+ Press Enter to leave empty.
+ / Owner gets FULL_CONTROL.
+ 1 | No one else has access rights (default).
+ \ (private)
+ / Owner gets FULL_CONTROL.
+ 2 | The AllUsers group gets READ access.
+ \ (public-read)
+ acl>
+ Edit advanced config?
+ y) Yes
+ n) No (default)
+ y/n>
+ Configuration complete.
+ Options:
+ - type: s3
+ - provider: ImpossibleCloud
+ - access_key_id: ACCESS_KEY
+ - secret_access_key: SECRET_KEY
+ - region: eu-central-2
+ - endpoint: eu-central-2.storage.impossibleapi.net
+ Keep this "my-impossible-cloud" remote?
+ y) Yes this is OK (default)
+ e) Edit this remote
+ d) Delete this remote
+ y/e/d>
+ Current remotes:
+
+ Name Type
+ ==== ====
+ my-impossible-cloud 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>
+
+This will leave the config file looking like this.
+
+ [my-impossible-cloud]
+ type = s3
+ provider = ImpossibleCloud
+ access_key_id = ACCESS_KEY
+ secret_access_key = SECRET_KEY
+ region = eu-central-2
+ endpoint = eu-central-2.storage.impossibleapi.net
+ acl = private
+
Intercolo Object Storage
Intercolo Object Storage offers GDPR-compliant, transparently priced,
@@ -33928,7 +34992,7 @@ with rclone config:
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, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, GCS, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, OVHcloud, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, StackPath, Storj, Synology, TencentCOS, Wasabi, Qiniu and others
+ XX / Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, GCS, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, OVHcloud, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Storj, Synology, TencentCOS, Wasabi, Qiniu and others
\ (s3)
[...]
Storage> s3
@@ -34289,7 +35353,7 @@ This will guide you through an interactive setup process:
Type of storage to configure.
Choose a number from below, or type in your own value.
[snip]
- 4 / Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, FlashBlade, GCS, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, StackPath, Storj, Synology, TencentCOS, Wasabi, Qiniu and others
+ 4 / Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, FlashBlade, GCS, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Storj, Synology, TencentCOS, Wasabi, Qiniu and others
\ (s3)
[snip]
Storage> s3
@@ -35699,6 +36763,139 @@ To configure access to Tencent COS, follow the steps below:
==== ====
cos s3
+Tencent COS Global Acceleration Endpoint
+
+When using the Global Acceleration Endpoint
+(cos.accelerate.myqcloud.com), rclone automatically sets
+no_check_bucket = true because this acceleration endpoint does not
+support the CreateBucket call which is used for ensuring a bucket's
+existence by rclone. Global Acceleration is a per-bucket feature, so you
+should first create the bucket in one physical region, then enable it in
+the Tencent Cloud console.
+
+US3
+
+US3 Object Storage is a service that provides cloud storage for
+unstructured files for internet applications.
+
+To configure access to US3, follow the steps below: 1. First run:
+console rclone config No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n
+2. Give the name of the configuration. For example, name it 'US3'.
+
+ name> US3
+
+3. Select s3 storage.
+
+ Choose a number from below, or type in your own value
+ [snip]
+ XX / Amazon S3 Compliant Storage Providers including AWS, ...
+ \ "s3"
+ [snip]
+ Storage> s3
+
+4. Select US3 provider.
+
+ Choose a number from below, or type in your own value.
+ XX / Amazon Web Services (AWS) S3
+ \ (AWS)
+ [snip]
+ XX / UCloud Object Storage (US3)
+ \ (US3)
+ [snip]
+ provider> US3
+
+5. Enter your SecretId and SecretKey of US3.
+
+ 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).
+ Choose a number from below, or type in your own value
+ 1 / Enter AWS credentials in the next step
+ \ "false"
+ 2 / Get AWS credentials from the environment (env vars or IAM)
+ \ "true"
+ env_auth> 1
+ Option access_key_id.
+ AWS Access Key ID.
+ Leave blank for anonymous access or runtime credentials.
+ Enter a value. Press Enter to leave empty.
+ access_key_id> AKIDxxxxxxxxxx
+ AWS Secret Access Key (password)
+ Leave blank for anonymous access or runtime credentials.
+ Enter a string value. Press Enter for the default ("").
+ secret_access_key> xxxxxxxxxxx
+
+6. Select endpoint.
+
+ Option endpoint.
+ Endpoint for S3 API.
+ Required when using an S3 clone.
+ Choose a number from below, or type in your own value.
+ Press Enter to leave empty.
+ 1 / North China (Beijing 2).
+ \ "s3-cn-bj.ufileos.com"
+ 2 / North China (Ulanqab).
+ \ "s3-cn-wlcb.ufileos.com"
+ 3 / Shanghai.
+ \ "s3-cn-sh2.ufileos.com"
+ 4 / South China (Guangzhou).
+ \ "s3-cn-gd.ufileos.com"
+ [snip]
+ endpoint> 1
+
+7. Choose acl and storage class.
+
+ 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'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't copy the ACL from the source but rather writes a fresh one.
+ If the acl is an empty string then no X-Amz-Acl: header is added and
+ the default (private) will be used.
+ Choose a number from below, or type in your own value.
+ Press Enter to leave empty.
+ / Owner gets FULL_CONTROL.
+ 1 | No one else has access rights (default).
+ \ (private)
+ / Owner gets FULL_CONTROL.
+ 2 | The AllUsers group gets READ access.
+ \ (public-read)
+ acl> 1
+
+ The storage class to use when storing new objects in US3.
+ Enter a string value. Press Enter for the default ("").
+ Choose a number from below, or type in your own value
+ 1 / Default
+ \ ""
+ [snip]
+ storage_class> 1
+ Edit advanced config? (y/n)
+ y) Yes
+ n) No (default)
+ y/n> n
+
+ Configuration complete.
+ Options:
+ - type: s3
+ - provider: US3
+ - access_key_id: xx
+ - secret_access_key: xx
+ - endpoint: s3-cn-bj.ufileos.com
+ - acl: private
+
+ Keep this "US3" remote?
+ y) Yes this is OK (default)
+ e) Edit this remote
+ d) Delete this remote
+ y/e/d> y
+ Current remotes:
+
+ Name Type
+ ==== ====
+ US3 s3
+
Wasabi
Wasabi is a cloud-based object storage service for a broad range of
@@ -35808,6 +37005,119 @@ This will leave the config file looking like this.
server_side_encryption =
storage_class =
+Zadara Object Storage
+
+Zadara Object Storage is a fully-managed, enterprise-grade,
+S3-compatible storage solution that provides scalable, multi-tenant
+object storage with flexible deployment options (on-prem, hybrid, or
+cloud).
+
+Zadara Object Storage can be configured using rclone config with s3 as
+the type and Zadara as the provider name. Here is an example run of the
+configurator.
+
+Authentication and endpoint information, including the region field,
+should be fetched from Zadara’s Object Storage management interface
+
+To configure access to Zadara Object Storage, first run:
+
+ rclone config
+
+ This will guide you through an interactive setup process:
+
+ No remotes found, make a new one\?
+ n) New remote
+ s) Set configuration password
+ n/s> n
+
+ Enter name for new remote.
+ name> Zadara-Object-Storage
+
+ 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 ...
+ \ (s3)
+
+ Storage> s3
+
+ Option provider.
+ Choose your S3 provider.
+ Choose a number from below, or type in your own value.
+ Press Enter to leave empty.
+
+ XX / Zadara Object Storage
+ \ (Zadara)
+
+ provider> Zadara
+
+ 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>
+
+ 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> S3_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> S3_SECRET_KEY
+
+ Option region.
+ Region to connect to.
+ Leave blank if you are using an S3 clone and you don't have a region.
+ Choose a number from below, or type in your own value.
+ Press Enter to leave empty.
+ / The default region.
+ 1 | Leave location constraint empty.
+ \ (us-east-1)
+ region>
+
+ Option endpoint.
+ Endpoint for S3 API.
+ Required when using an S3 clone.
+ Enter a value. Press Enter to leave empty.
+ endpoint> https://vsa-00000001-public-zadara-cloud-01.zadarazios.com
+
+ Edit advanced config?
+ y) Yes
+ n) No (default)
+ y/n>
+
+ Configuration complete.
+ Options:
+ - type: s3
+ - provider: Zadara
+ - access_key_id: S3_ACCESS_KEY
+ - secret_access_key: S3_SECRET_KEY
+ - endpoint: https://vsa-00000001-public-zadara-cloud-01.zadarazios.com
+ Keep this "Zadara-Object-Storage" remote?
+ y) Yes this is OK (default)
+ e) Edit this remote
+ d) Delete this remote
+ y/e/d> y
+
+This will leave the config file looking like this.
+
+ [Zadara-Object-Storage]
+ type = s3
+ provider = Zadara
+ access_key_id = S3_ACCESS_KEY
+ secret_access_key = S3_SECRET_KEY
+ endpoint = https://vsa-00000001-public-zadara-cloud-01.zadarazios.com
+
Zata Object Storage
Zata Object Storage provides a secure, S3-compatible cloud storage
@@ -42261,6 +43571,29 @@ Advanced options
Here are the Advanced options specific to filelu (FileLu Cloud Storage).
+--filelu-upload-cutoff
+
+Cutoff for switching to chunked upload. Any files larger than this will
+be uploaded in chunks of chunk_size.
+
+Properties:
+
+- Config: upload_cutoff
+- Env Var: RCLONE_FILELU_UPLOAD_CUTOFF
+- Type: SizeSuffix
+- Default: 500Mi
+
+--filelu-chunk-size
+
+Chunk size to use for uploading. Used for multipart uploads.
+
+Properties:
+
+- Config: chunk_size
+- Env Var: RCLONE_FILELU_CHUNK_SIZE
+- Type: SizeSuffix
+- Default: 64Mi
+
--filelu-encoding
The encoding for the backend.
@@ -42304,6 +43637,10 @@ account, currently this is only possible using the Filen CLI. This means
you must first download the CLI, login, and then run the export-api-key
command.
+Note: If you change your Filen account password, you will need to update
+your rclone configuration with the new password and a re-exported API
+key (via export-api-key).
+
Here is an example of how to make a remote called FilenRemote. First
run:
@@ -46379,6 +47716,9 @@ Here is how to create your own Google Drive client ID for rclone:
10. Provide the noted client ID and client secret to rclone.
+11. Run the web-based authorization flow from within rclone config, by
+ answering "Y" when it asks "Already have a token - refresh?".
+
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
@@ -47396,6 +48736,577 @@ database. All local paths are treated as aliases into the local backend
~/.cache/rclone/kv/local~hasher.bolt. Databases can be shared between
multiple rclone processes.
+Huawei Drive
+
+Paths are specified as huaweidrive:path
+
+Huawei Drive paths may be as deep as required, e.g.
+huaweidrive:directory/subdirectory.
+
+Configuration
+
+The initial setup for Huawei Drive involves getting a token from Huawei
+Drive which you need to do in your browser. rclone config walks you
+through it.
+
+Here is an example of how to make a remote called remote. First run:
+
+ rclone config
+
+This will guide you through an interactive setup process:
+
+ No remotes found, make a new one?
+ n) New remote
+ r) Rename remote
+ c) Copy remote
+ s) Set configuration password
+ q) Quit config
+ n/r/c/s/q> n
+ name> remote
+ Type of storage to configure.
+ Choose a number from below, or type in your own value
+ [snip]
+ XX / Huawei Drive
+ \ "huaweidrive"
+ [snip]
+ Storage> huaweidrive
+ OAuth Client Id - leave blank to use rclone's default.
+ client_id>
+ OAuth Client Secret - leave blank to use rclone's default.
+ client_secret>
+ Remote config
+ Use web browser to automatically authenticate rclone with remote?
+ * Say Y if the machine running rclone has a web browser you can use
+ * Say N if running rclone on a (remote) machine without web browser access
+ If not sure try Y. If Y failed, try N.
+ y) Yes
+ n) No
+ y/n> y
+ If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth
+ Log in and authorize rclone for access
+ Waiting for code...
+ Got code
+ Configuration complete.
+ Options:
+ - type: huaweidrive
+ - client_id:
+ - client_secret:
+ - token: {"access_token":"XXX","token_type":"Bearer","refresh_token":"XXX","expiry":"2024-03-16T13:57:58.955387075Z"}
+ Keep this "remote" remote?
+ y) Yes this is OK
+ e) Edit this remote
+ d) Delete this remote
+ y/e/d> y
+
+See the remote setup docs for how to set it up on a machine without an
+internet-connected web browser available.
+
+Note that rclone runs a webserver on your local machine to collect the
+token as returned from Huawei if using web browser to automatically
+authenticate. This only runs from the moment it opens your browser to
+the moment you get back the verification code. This is on
+http://127.0.0.1:53682/ and it may require you to unblock it temporarily
+if you are running a host firewall, or use manual mode.
+
+You can then use it like this,
+
+List directories in top level of your drive
+
+ rclone lsd remote:
+
+List all the files in your drive
+
+ rclone ls remote:
+
+To copy a local directory to a drive directory called backup
+
+ rclone copy /home/source remote:backup
+
+Getting your own Client ID and Secret
+
+When you use rclone with Huawei 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 Huawei.
+
+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 a separate client ID for each service to avoid rate
+limiting issues.
+
+Here is how to create your own Huawei Drive client ID for rclone:
+
+Follow the detailed guides for complete setup instructions:
+
+- Huawei HMS Core Web App Preparations
+- Huawei HMS Core Server Preparations
+
+Rclone uses the web application access method to connect to Huawei
+Drive. Before starting, you need to implement quick login authorization
+through Huawei Account Open Service. With user authorization
+credentials, rclone can call Huawei Cloud Drive Service APIs.
+
+Create Server Application
+
+Before accessing Drive service, developers need to create a server
+application first. For details, please refer to the WEB Application
+Access Development Preparation section in the "Huawei Account Service
+Development Guide".
+
+Enable Drive Application Switch
+
+1. Log in to the AppGallery Connect website and click "My Projects".
+2. Find your project in the project list, select the application that
+ needs to access Drive in the project, and click "API Management".
+3. In the "API Management" area of the "Project Settings" page, click
+ the switch on the right side of Drive Kit to ensure the switch is in
+ the open state.
+
+Sign Huawei Cloud Drive Privacy Notice and User Agreement
+
+Guide users to visit https://cloud.huawei.com/. First-time users need to
+sign the agreement before they can use Huawei Cloud Drive Service.
+
+Application Access to Obtain Authentication Credential Access Token
+
+Applications accessing Drive should use authentication credential Access
+Token. For specific acquisition methods, please refer to the WEB
+Application Access Development Guide section in the "Huawei Account
+Service Development Guide".
+
+Key steps summary:
+
+1. Log into the Huawei Developer Console with your Huawei account.
+
+2. Create a new project or select an existing project.
+
+3. Go to "Manage APIs" and enable the "Drive Kit" API.
+
+4. Click on "Credentials" in the left side panel.
+
+5. Click "Create Credentials" and choose "OAuth client ID".
+
+6. Choose "Web application" as the application type.
+
+7. Add http://localhost:53682/ to the "Authorized redirect URIs".
+
+8. Click "Create" and note down the Client ID and Client Secret.
+
+9. Provide the noted client ID and client secret to rclone during
+ configuration.
+
+Scopes
+
+Rclone uses the following OAuth2 scopes when accessing Huawei Drive:
+
+- https://www.huawei.com/auth/drive - Full access to Huawei Drive
+ files (excluding application data folder)
+- https://www.huawei.com/auth/drive.file - Access to files created by
+ the application
+- openid - OpenID Connect authentication
+- profile - Access to basic profile information
+
+The drive.file scope is included in the default set used by rclone.
+
+Alternative scopes available (not used by rclone by default):
+
+- https://www.huawei.com/auth/drive.appdata - Access to application
+ data folder
+- https://www.huawei.com/auth/drive.readonly - Read-only access to
+ file metadata and content
+- https://www.huawei.com/auth/drive.metadata - Read/write access to
+ file metadata only
+- https://www.huawei.com/auth/drive.metadata.readonly - Read-only
+ access to file metadata only
+
+The default scopes provide read/write access to all files in your Huawei
+Drive.
+
+Modification times and hashes
+
+Huawei Drive does not support setting modification times. The API always
+uses server-side timestamps, so file modification times from the source
+are not preserved during upload. Modification times are available as
+read-only metadata (mtime, btime).
+
+Hash algorithm SHA256 is supported for file integrity verification.
+
+Restricted filename characters
+
+Huawei Drive has strict restrictions on file and directory names:
+
+- Cannot contain: < > | : " * ? / \ or emoji characters
+- Cannot be exactly . ..
+- Maximum length: 250 bytes
+- Single quotes must be escaped with \' in API calls
+
+These restrictions are handled by rclone's encoding:
+
+- Backslashes \ are encoded
+- Invalid UTF-8 sequences are encoded
+- Right-side spaces are encoded
+
+Invalid characters will be replaced according to the encoding settings.
+
+Resumable uploads
+
+Huawei Drive supports resumable uploads for files larger than the upload
+cutoff (default 20MB). Files are uploaded in chunks which allows for
+recovery from network interruptions.
+
+File size limits
+
+The maximum file size for Huawei Drive is 50 GiB.
+
+Quota information
+
+To view your current quota you can use the rclone about remote: command
+which will display your usage and quota information.
+
+Standard options
+
+Here are the Standard options specific to huaweidrive (Huawei Drive).
+
+--huaweidrive-client-id
+
+OAuth Client Id.
+
+Leave blank normally.
+
+Properties:
+
+- Config: client_id
+- Env Var: RCLONE_HUAWEIDRIVE_CLIENT_ID
+- Type: string
+- Required: false
+
+--huaweidrive-client-secret
+
+OAuth Client Secret.
+
+Leave blank normally.
+
+Properties:
+
+- Config: client_secret
+- Env Var: RCLONE_HUAWEIDRIVE_CLIENT_SECRET
+- Type: string
+- Required: false
+
+Advanced options
+
+Here are the Advanced options specific to huaweidrive (Huawei Drive).
+
+--huaweidrive-token
+
+OAuth Access Token as a JSON blob.
+
+Properties:
+
+- Config: token
+- Env Var: RCLONE_HUAWEIDRIVE_TOKEN
+- Type: string
+- Required: false
+
+--huaweidrive-auth-url
+
+Auth server URL.
+
+Leave blank to use the provider defaults.
+
+Properties:
+
+- Config: auth_url
+- Env Var: RCLONE_HUAWEIDRIVE_AUTH_URL
+- Type: string
+- Required: false
+
+--huaweidrive-token-url
+
+Token server url.
+
+Leave blank to use the provider defaults.
+
+Properties:
+
+- Config: token_url
+- Env Var: RCLONE_HUAWEIDRIVE_TOKEN_URL
+- Type: string
+- Required: false
+
+--huaweidrive-client-credentials
+
+Use client credentials OAuth flow.
+
+This will use the OAUTH2 client Credentials Flow as described in RFC
+6749.
+
+Note that this option is NOT supported by all backends.
+
+Properties:
+
+- Config: client_credentials
+- Env Var: RCLONE_HUAWEIDRIVE_CLIENT_CREDENTIALS
+- Type: bool
+- Default: false
+
+--huaweidrive-root-folder-id
+
+ID of the root folder.
+
+Normally this is auto-detected, but if it fails or you want to speed up
+startup, you can set it manually.
+
+Leave blank normally.
+
+Properties:
+
+- Config: root_folder_id
+- Env Var: RCLONE_HUAWEIDRIVE_ROOT_FOLDER_ID
+- Type: string
+- Required: false
+
+--huaweidrive-chunk-size
+
+Upload chunk size.
+
+Must be a power of 2 >= 256k and <= 64MB.
+
+Properties:
+
+- Config: chunk_size
+- Env Var: RCLONE_HUAWEIDRIVE_CHUNK_SIZE
+- Type: SizeSuffix
+- Default: 8Mi
+
+--huaweidrive-list-chunk
+
+Size of listing chunk 1-1000.
+
+Properties:
+
+- Config: list_chunk
+- Env Var: RCLONE_HUAWEIDRIVE_LIST_CHUNK
+- Type: int
+- Default: 1000
+
+--huaweidrive-upload-cutoff
+
+Cutoff for switching to resumable upload.
+
+Any files larger than this will be uploaded using resumable upload. The
+minimum is 0 and the maximum is 20 MiB (Huawei Drive API limit for
+single request uploads).
+
+Properties:
+
+- Config: upload_cutoff
+- Env Var: RCLONE_HUAWEIDRIVE_UPLOAD_CUTOFF
+- Type: SizeSuffix
+- Default: 20Mi
+
+--huaweidrive-encoding
+
+The encoding for the backend.
+
+See the encoding section in the overview for more info.
+
+Properties:
+
+- Config: encoding
+- Env Var: RCLONE_HUAWEIDRIVE_ENCODING
+- Type: Encoding
+- Default:
+ Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftSpace,LeftPeriod,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot
+
+--huaweidrive-description
+
+Description of the remote.
+
+Properties:
+
+- Config: description
+- Env Var: RCLONE_HUAWEIDRIVE_DESCRIPTION
+- Type: string
+- Required: false
+
+Metadata
+
+Huawei Drive supports reading and writing custom metadata.
+
+User metadata can be set using the "properties" field in the API. System
+metadata includes standard file information such as: - content-type:
+MIME type of the object - description: User-provided description -
+favorite: Whether file is marked as favorite - btime/mtime/utime:
+Various timestamps - sha256: File hash - recycled/has-thumbnail: File
+status flags
+
+Custom metadata keys can be any string and will be stored in the file's
+properties.
+
+Here are the possible system metadata items for the huaweidrive backend.
+
+ --------------------------------------------------------------------------------
+ Name Help Type Example Read Only
+ --------------- -------------- ----------- ---------------- --------------------
+ btime Time when the RFC 3339 Y
+ file was
+ created (RFC
+ 3339)
+
+ content-type MIME type of string Y
+ the object
+
+ description Description of string N
+ the file
+
+ favorite Whether the string N
+ file is marked
+ as favorite
+ (true/false)
+
+ has-thumbnail Whether the string Y
+ file has a
+ thumbnail
+ (true/false)
+
+ mtime Time when the RFC 3339 Y
+ file content
+ was last
+ modified (RFC
+ 3339)
+
+ recycled Whether the string Y
+ file is in
+ recycle bin
+ (true/false)
+
+ sha256 SHA256 hash of string Y
+ the file
+
+ utime Time when the RFC 3339 Y
+ file was last
+ edited by the
+ current user
+ (RFC 3339)
+ --------------------------------------------------------------------------------
+
+See the metadata docs for more info.
+
+Limitations
+
+Huawei Drive has some rate limiting which may cause rclone to slow down
+transfers to avoid hitting the limits.
+
+File name restrictions
+
+- File names cannot contain: < > | : " * ? / \
+- File names cannot be exactly . ..
+- Maximum file name length is 250 bytes
+- Some unicode characters including emojis are not supported
+
+API rate limits
+
+Huawei Drive imposes API rate limits. Rclone automatically handles these
+by backing off when limits are hit.
+
+OAuth2 token expiry
+
+- Access tokens expire after 1 hour
+- Refresh tokens expire after 180 days
+- Rclone will automatically refresh tokens as needed
+
+File size limits
+
+- Maximum file size is 50 GiB
+- Files larger than this cannot be uploaded
+
+Upload behavior
+
+- Files smaller than upload_cutoff (default 20MB) are uploaded in a
+ single request using content or multipart method
+- Larger files are uploaded using resumable uploads with configurable
+ chunk size
+- Maximum single chunk size for resumable uploads is 64MB
+- Resumable uploads support automatic retry on network errors
+- SHA256 hash verification is supported for uploaded files
+
+Server-side operations
+
+- Server-side copy: Files can be copied within Huawei Drive without
+ downloading and re-uploading
+- Server-side move: Files and directories can be moved/renamed on the
+ server side
+- Directory move: Entire directories can be moved with a single API
+ call
+
+Directory operations
+
+- Huawei Drive supports creating empty directories
+- Recursive listing is supported via --fast-list for efficient
+ directory traversal
+- Huawei Drive has a special "applicationData" folder for app-specific
+ data (not accessible via rclone's default configuration)
+
+Error handling
+
+Common errors and their meanings:
+
+- 401 Unauthorized: Invalid credentials or expired token
+- 403 Forbidden: Usually indicates insufficient permissions or API
+ quota exceeded
+- 404 Not Found: File or directory does not exist
+- 409 Conflict: Directory already exists
+- 429 Too Many Requests: API rate limit exceeded, rclone will
+ automatically retry
+
+Performance tuning
+
+For better performance:
+
+- Increase --transfers for concurrent operations (default is 4)
+- Adjust chunk_size based on your network speed and file sizes
+- Use --fast-list for operations on directories with many files to
+ reduce API calls
+
+Making backups
+
+Huawei Drive is suitable for backups with some considerations:
+
+- Use rclone sync rather than rclone copy to maintain exact directory
+ structure
+- Consider using --backup-dir to preserve deleted files
+- Verify transfers with --checksum flag for critical data
+- Be aware of the 50 GiB file size limit for individual files
+
+Supported features
+
+Huawei Drive supports the following rclone features:
+
+- Copy - Server-side copy of files
+- Move - Server-side move/rename of files
+- DirMove - Server-side move of directories
+- ListR - Recursive listing for --fast-list
+- About - Storage quota information
+- Purge - Delete directory and all contents
+- CleanUp - Empty the trash
+- UserInfo - Get user account information
+- Metadata - Read and write file metadata/properties
+- ChangeNotify - Poll for remote changes (used by rclone mount and
+ rclone rc vfs/poll-interval)
+
+Integration with other services
+
+Huawei Drive can be used as a backend for various rclone operations:
+
+- Mount as a local filesystem using rclone mount
+- Serve over HTTP using rclone serve http
+- Serve over FTP using rclone serve ftp
+- Serve over WebDAV using rclone serve webdav
+
+Note that some operations may be slower than local storage due to API
+limitations and network latency.
+
HDFS
HDFS is a distributed file-system, part of the Apache Hadoop framework.
@@ -48689,24 +50600,46 @@ Here are the possible system metadata items for the imagekit backend.
See the metadata docs for more info.
-iCloud Drive
+iCloud Drive and Photos
Configuration
-The initial setup for an iCloud Drive backend involves getting a trust
-token/session. This can be done by simply using the regular iCloud
-password, and accepting the code prompt on another iCloud connected
-device.
+The initial setup for an iCloud backend involves getting a trust
+token/session. This uses your regular Apple ID password plus 2FA, either
+from a trusted device prompt or an SMS code sent to a trusted phone
+number.
-IMPORTANT: At the moment an app specific password won't be accepted.
-Only use your regular password and 2FA.
+IMPORTANT: App-specific passwords are not accepted. Only use your
+regular Apple ID password and 2FA.
+
+This backend serves two Apple services:
+
+- drive - iCloud Drive (default)
+- photos - iCloud Photos
rclone config walks you through the token creation. The trust token is
valid for 30 days. After which you will have to reauthenticate with
rclone reconnect or rclone config.
-Here is an example of how to make a remote called iclouddrive. First
-run:
+Authentication
+
+rclone authenticates with Apple using SRP (Secure Remote Password), the
+same protocol used by the iCloud web interface. Your password is never
+sent to Apple's servers -- instead, a cryptographic proof is exchanged
+that verifies you know the password without revealing it.
+
+The authentication flow is:
+
+1. rclone initiates a session with Apple's identity service
+2. An SRP key exchange takes place (your password is used locally to
+ derive a key)
+3. Apple sends a 2FA prompt to your trusted devices, or lets you
+ request an SMS code
+4. After you enter the 2FA code, rclone receives a trust token for
+ future sessions
+
+Here is an example of how to make a Photos remote called icloudphotos.
+For iCloud Drive, leave service at its default drive value. First run:
rclone config
@@ -48717,7 +50650,7 @@ This will guide you through an interactive setup process:
s) Set configuration password
q) Quit config
n/s/q> n
- name> iclouddrive
+ name> icloudphotos
Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
@@ -48726,6 +50659,15 @@ This will guide you through an interactive setup process:
\ (iclouddrive)
[snip]
Storage> iclouddrive
+ Option service.
+ iCloud service to use.
+ Choose a number from below, or type in your own value of type string.
+ Press Enter for the default (drive).
+ 1 / iCloud Drive
+ \ (drive)
+ 2 / iCloud Photos
+ \ (photos)
+ service> 2
Option apple_id.
Apple ID.
Enter a value.
@@ -48745,13 +50687,14 @@ This will guide you through an interactive setup process:
n) No (default)
y/n> n
Option config_2fa.
- Two-factor authentication: please enter your 2FA code
+ Two-factor authentication: enter your 2FA code or type 'sms' for a text message
Enter a value.
config_2fa> 2FACODE
Remote config
--------------------
- [iclouddrive]
+ [icloudphotos]
- type: iclouddrive
+ - service: photos
- apple_id: APPLEID
- password: *** ENCRYPTED ***
- cookies: ****************************
@@ -48762,34 +50705,144 @@ This will guide you through an interactive setup process:
d) Delete this remote
y/e/d> y
+iCloud Photos
+
+The iCloud Drive backend also supports accessing iCloud Photos by
+setting the service option to photos:
+
+ rclone lsd iclouddrive: --iclouddrive-service photos
+
+This presents a read-only hierarchy rooted at photo libraries:
+
+- Level 1: Photo libraries — your personal library (PrimarySync) and
+ any Shared Photo Library (SharedSync-XXXX)
+- Level 2+: Albums and folders within a library, nested recursively as
+ in Apple Photos
+- Leaf level: Photos/videos within an album, including Live Photo .MOV
+ companions
+
+Examples:
+
+ # List libraries
+ rclone lsd iclouddrive: --iclouddrive-service photos
+
+ # List albums in your primary library
+ rclone lsd iclouddrive:PrimarySync/ --iclouddrive-service photos
+
+ # List photos in an album
+ rclone ls iclouddrive:PrimarySync/All\ Photos/ --iclouddrive-service photos
+
+ # Download a photo
+ rclone copy iclouddrive:PrimarySync/Favorites/IMG_0001.HEIC /tmp/ --iclouddrive-service photos
+
+You can either:
+
+- set service = photos in rclone config for a dedicated Photos remote
+- keep service = drive and pass --iclouddrive-service photos when
+ needed
+
+Metadata
+
+With --metadata, Photos entries expose these read-only metadata keys:
+
+- width
+- height
+- added-time
+- favorite
+- hidden
+
+These metadata keys are only available when service = photos.
+
+Caching
+
+iCloud Photos caches album listings to disk for fast subsequent access.
+On the first run, listing a large album uses parallel startRank
+partitions to fetch pages concurrently. After that, a lightweight change
+check (~200ms) determines whether the cache is still valid.
+
+Cache location: ~/.cache/rclone/iclouddrive-photos/<remote>/<zone>/
+
+To clear the cache: delete that directory or run
+rclone config reconnect.
+
+FUSE mounts
+
+For mounting iCloud Photos via rclone mount, the following flags are
+recommended:
+
+ rclone mount remote: /mnt/photos \
+ --iclouddrive-service photos \
+ --vfs-refresh \
+ --dir-cache-time 1h \
+ --vfs-cache-mode full \
+ --attr-timeout 1m \
+ --read-only
+
+- --vfs-refresh pre-warms directory caches in the background on mount
+ start so that albums are ready when you browse them
+- --dir-cache-time 1h extends the in-memory cache lifetime beyond the
+ default 5 minutes (change detection is fast, so this is safe)
+- --vfs-cache-mode full caches downloaded photos and videos to local
+ disk for fast repeated access
+- --attr-timeout 1m reduces kernel attribute lookups (safe because the
+ backend is read-only)
+- --read-only prevents confusing write errors
+
+The first listing of a very large album (e.g. 75,000 items in "All
+Photos") can take several minutes due to API pagination limits. This
+happens once — subsequent listings use the disk cache.
+
+Limitations
+
+iCloud Photos is read-only. Upload, delete, rename, and move operations
+are not supported.
+
Advanced Data Protection
-ADP is currently unsupported and need to be disabled
+Advanced Data Protection is supported.
On iPhone, Settings > Apple Account > iCloud > 'Access iCloud Data on
-the Web' must be ON, and 'Advanced Data Protection' OFF.
+the Web' must be ON.
+
+If ADP is enabled on your account, rclone requests PCS cookies after
+2FA. Apple may require approval on a trusted device before those cookies
+are issued.
Troubleshooting
-Missing PCS cookies from the request
+PCS cookie errors with ADP
-This means you have Advanced Data Protection (ADP) turned on. This is
-not supported at the moment. If you want to use rclone you will have to
-turn it off. See above for how to turn it off.
+If you see Missing PCS cookies from the request or a requestPCS: error,
+the ADP approval flow did not complete successfully.
-You will need to clear the cookies and the trust_token fields in the
-config. Or you can delete the remote config and start again.
+Check that 'Access iCloud Data on the Web' is enabled and approve any
+prompt on your trusted device.
-You should then run rclone reconnect remote:.
+Then run rclone reconnect remote:.
-Note that changing the ADP setting may not take effect immediately - you
-may need to wait a few hours or a day before you can get rclone to
-work - keep clearing the config entry and running
-rclone reconnect remote: until rclone functions properly.
+If the remote still has stale auth state, clear the cookies and
+trust_token fields in the config, or delete and recreate the remote.
Standard options
-Here are the Standard options specific to iclouddrive (iCloud Drive).
+Here are the Standard options specific to iclouddrive (iCloud Drive and
+Photos).
+
+--iclouddrive-service
+
+iCloud service to use.
+
+Properties:
+
+- Config: service
+- Env Var: RCLONE_ICLOUDDRIVE_SERVICE
+- Type: string
+- Default: "drive"
+- Examples:
+ - "drive"
+ - iCloud Drive
+ - "photos"
+ - iCloud Photos
--iclouddrive-apple-id
@@ -48817,7 +50870,7 @@ Properties:
--iclouddrive-trust-token
-Trust token (internal use)
+Trust token for session authentication.
Properties:
@@ -48828,7 +50881,7 @@ Properties:
--iclouddrive-cookies
-cookies (internal use only)
+Session cookies.
Properties:
@@ -48839,11 +50892,12 @@ Properties:
Advanced options
-Here are the Advanced options specific to iclouddrive (iCloud Drive).
+Here are the Advanced options specific to iclouddrive (iCloud Drive and
+Photos).
--iclouddrive-client-id
-Client id
+Client ID for iCloud API access.
Properties:
@@ -48877,6 +50931,40 @@ Properties:
- Type: string
- Required: false
+Metadata
+
+Metadata is read-only and available for the Photos service only.
+
+Here are the possible system metadata items for the iclouddrive backend.
+
+ --------------------------------------------------------------------------------
+ Name Help Type Example Read Only
+ ------------ ----------- ----------- ---------------------- --------------------
+ added-time Time the RFC 3339 2006-01-02T15:04:05Z Y
+ item was
+ added to
+ the iCloud
+ library
+
+ favorite Whether the bool Y
+ item is
+ marked as
+ favorite
+
+ height Image int Y
+ height in
+ pixels
+
+ hidden Whether the bool Y
+ item is
+ hidden
+
+ width Image width int Y
+ in pixels
+ --------------------------------------------------------------------------------
+
+See the metadata docs for more info.
+
Internet Archive
The Internet Archive backend utilizes Items on archive.org
@@ -49413,6 +51501,51 @@ Properties:
- Type: bool
- Default: true
+--internxt-upload-concurrency
+
+Concurrency for multipart uploads.
+
+This is the number of chunks of the same file that are uploaded
+concurrently.
+
+Note that each chunk is buffered in memory.
+
+Properties:
+
+- Config: upload_concurrency
+- Env Var: RCLONE_INTERNXT_UPLOAD_CONCURRENCY
+- Type: int
+- Default: 4
+
+--internxt-upload-cutoff
+
+Cutoff for switching to multipart upload.
+
+Any files larger than this will be uploaded in chunks of chunk_size. The
+minimum is 100 MiB and the maximum is 5 GiB.
+
+Properties:
+
+- Config: upload_cutoff
+- Env Var: RCLONE_INTERNXT_UPLOAD_CUTOFF
+- Type: SizeSuffix
+- Default: 100Mi
+
+--internxt-chunk-size
+
+Chunk size for multipart uploads.
+
+Files larger than upload_cutoff will be uploaded in chunks of this size.
+
+Memory usage is approximately chunk_size * upload_concurrency.
+
+Properties:
+
+- Config: chunk_size
+- Env Var: RCLONE_INTERNXT_CHUNK_SIZE
+- Type: SizeSuffix
+- Default: 30Mi
+
--internxt-encoding
The encoding for the backend.
@@ -49802,6 +51935,7 @@ characters are also replaced:
> 0x3E >
? 0x3F ?
| 0x7C |
+ % 0x25 %
Invalid UTF-8 bytes will also be replaced, as they can't be used in XML
strings.
@@ -49990,7 +52124,7 @@ Properties:
- Env Var: RCLONE_JOTTACLOUD_ENCODING
- Type: Encoding
- Default:
- Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot
+ Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Percent,Del,Ctl,InvalidUtf8,Dot
--jottacloud-description
@@ -50437,6 +52571,16 @@ Configuration
Here is an example of making a remote for Linkbox.
+You will need: - An API token from
+https://www.linkbox.to/admin/account - The email and password for your
+Linkbox account
+
+Note: As of v1.74, email and password are required in addition to the
+API token. The API token is used for uploads and modifications, while
+email/password authentication is used for listing and downloading files.
+If you have an existing Linkbox remote, you will need to reconfigure it
+with rclone config to edit the remote and add the email and password.
+
First run:
rclone config
@@ -50462,12 +52606,24 @@ This will guide you through an interactive setup process:
Option token.
Token from https://www.linkbox.to/admin/account
Enter a value.
- token> testFromCLToken
+ token> YOUR_API_TOKEN
+
+ Option email.
+ Email for login
+ Enter a value.
+
+ Option password.
+ Password for login
+ Enter a value.
+ password> YOUR_PASSWORD
Configuration complete.
Options:
- type: linkbox
- token: XXXXXXXXXXX
+ - password: *** ENCRYPTED ***
Keep this "linkbox" remote?
y) Yes this is OK (default)
e) Edit this remote
@@ -50489,6 +52645,41 @@ Properties:
- Type: string
- Required: true
+--linkbox-email
+
+Email for login
+
+Properties:
+
+- Config: email
+- Env Var: RCLONE_LINKBOX_EMAIL
+- Type: string
+- Required: true
+
+--linkbox-password
+
+Password for login
+
+NB Input to this must be obscured - see rclone obscure.
+
+Properties:
+
+- Config: password
+- Env Var: RCLONE_LINKBOX_PASSWORD
+- Type: string
+- Required: true
+
+--linkbox-web-token
+
+Web API login token - set automatically.
+
+Properties:
+
+- Config: web_token
+- Env Var: RCLONE_LINKBOX_WEB_TOKEN
+- Type: string
+- Required: false
+
Advanced options
Here are the Advanced options specific to linkbox (Linkbox).
@@ -52071,12 +54262,12 @@ msi_client_id, or msi_mi_res_id parameters.
If none of msi_object_id, msi_client_id, or msi_mi_res_id is set, this
is is equivalent to using env_auth.
-Fedrated Identity Credentials
+Federated Identity Credentials
-If these variables are set, rclone will authenticate with fedrated
+If these variables are set, rclone will authenticate with federated
identity.
-- tenant_id: tenant_id to authenticate in storage
+- tenant: tenant ID of of the storage
- client_id: client ID of the application the user will authenticate
to storage
- msi_client_id: managed identity client ID of the application the
@@ -52084,7 +54275,7 @@ identity.
By default "api://AzureADTokenExchange" is used as scope for token
retrieval over MSI. This token is then exchanged for actual storage
-token using 'tenant_id' and 'client_id'.
+token using 'tenant' and 'client_id'.
Azure CLI tool az
@@ -52539,6 +54730,22 @@ Properties:
- Type: int
- Default: 512
+--azureblob-copy-total-concurrency
+
+Global concurrency limit for multipart copy chunks.
+
+This limits the total number of multipart copy chunks running at once
+across all files.
+
+Set to 0 to disable this limiter.
+
+Properties:
+
+- Config: copy_total_concurrency
+- Env Var: RCLONE_AZUREBLOB_COPY_TOTAL_CONCURRENCY
+- Type: int
+- Default: 0
+
--azureblob-use-copy-blob
Whether to use the Copy Blob API when copying to the same storage
@@ -52757,6 +54964,26 @@ Properties:
- Specify 'only' to remove only the snapshots but keep the
root blob.
+--azureblob-decompress
+
+If set this will decompress gzip encoded objects.
+
+It is possible to upload objects to Azure Blob Storage with
+"Content-Encoding: gzip" set. Normally rclone will download these files
+as compressed objects.
+
+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.
+
+Properties:
+
+- Config: decompress
+- Env Var: RCLONE_AZUREBLOB_DECOMPRESS
+- Type: bool
+- Default: false
+
--azureblob-description
Description of the remote.
@@ -53156,12 +55383,12 @@ msi_client_id, or msi_mi_res_id parameters.
If none of msi_object_id, msi_client_id, or msi_mi_res_id is set, this
is is equivalent to using env_auth.
-Fedrated Identity Credentials
+Federated Identity Credentials
-If these variables are set, rclone will authenticate with fedrated
+If these variables are set, rclone will authenticate with federated
identity.
-- tenant_id: tenant_id to authenticate in storage
+- tenant: tenant ID of of the storage
- client_id: client ID of the application the user will authenticate
to storage
- msi_client_id: managed identity client ID of the application the
@@ -53169,7 +55396,7 @@ identity.
By default "api://AzureADTokenExchange" is used as scope for token
retrieval over MSI. This token is then exchanged for actual storage
-token using 'tenant_id' and 'client_id'.
+token using 'tenant' and 'client_id'.
Azure CLI tool az
@@ -58289,13 +60516,18 @@ Add offline download task for url.
This command adds offline download task for url.
-Usage example:
+Usage examples:
rclone backend addurl pikpak:dirpath url
+ rclone backend addurl pikpak:dirpath url -o name=custom_filename.zip
Downloads will be stored in 'dirpath'. If 'dirpath' is invalid, download
will fallback to default 'My Pack' folder.
+Options:
+
+- "name": Custom filename for the downloaded file.
+
decompress
Request decompress of a file/files in a folder.
@@ -59034,16 +61266,18 @@ Properties:
The app version string
-The app version string indicates the client that is currently performing
-the API request. This information is required and will be sent with
-every API request.
+ The app version string identifies the client that is currently performing
+ the API request. Third-party Proton Drive integrations should use the form
+ external-drive-<project>@<version>. If this option is left empty, rclone
+ derives a compliant value from its own version. This value is sent with
+ every API request; the option itself is optional.
Properties:
- Config: app_version
- Env Var: RCLONE_PROTONDRIVE_APP_VERSION
- Type: string
-- Default: "[email protected]+rclone"
+- Required: false
--protondrive-replace-existing-draft
@@ -59638,16 +61872,18 @@ Properties:
The app version string
-The app version string indicates the client that is currently performing
-the API request. This information is required and will be sent with
-every API request.
+ The app version string identifies the client that is currently performing
+ the API request. Third-party Proton Drive integrations should use the form
+ external-drive-<project>@<version>. If this option is left empty, rclone
+ derives a compliant value from its own version. This value is sent with
+ every API request; the option itself is optional.
Properties:
- Config: app_version
- Env Var: RCLONE_PROTONDRIVE_APP_VERSION
- Type: string
-- Default: "[email protected]+rclone"
+- Required: false
--protondrive-replace-existing-draft
@@ -65100,6 +67336,332 @@ Options:
Changelog
+v1.74.0 - 2026-05-01
+
+See commits
+
+- New backends
+ - Huawei Drive (王一赫)
+ - iCloud Photos (read only) (Yakov Till)
+ - New S3 providers
+ - Fastly Object Storage (Leon Brocard)
+ - HCP (Chris)
+ - Impossible Cloud (Nick Craig-Wood)
+ - UCloud US3 (jinkeyuu)
+ - Zadara (Shlomi Avihou)
+- New commands
+ - gui: launch new embedded web based GUI for basic rclone
+ operations (FTCHD, Nick Craig-Wood)
+- New Features
+ - build
+ - Update golang.org/x/image/webp to v0.39.0 to fix
+ CVE-2026-33813 (Nick Craig-Wood)
+ - Bump github.com/Azure/go-ntlmssp to 0.1.1 to fix
+ CVE-2026-32952 (dependabot[bot])
+ - Update to go1.26 and make go1.25 the minimum required
+ version (Nick Craig-Wood)
+ - Update all dependencies (Nick Craig-Wood)
+ - Modernize Go code with go fix for go1.25 (Nick Craig-Wood)
+ - Fix loong64 and s390x build (Suyun)
+ - docs
+ - Modernize rclone.org site design (Nick Craig-Wood)
+ - fixes (albertony, Enduriel, Jason, Luke Cyca,
+ mathieulongtin, Nick Craig-Wood, SyoBoN)
+ - fshttp: Add --dump curl for dumping HTTP requests as curl
+ commands (Nick Craig-Wood)
+ - graphics: Optimise images losslessly with ImageOptim (Leon
+ Brocard)
+ - listremotes: Add --exact flag for filtering (Anton Bordwine)
+ - rc
+ - Flip auth default so all endpoints require auth unless opted
+ out (Nick Craig-Wood)
+ - Add core/disks to enumerate attached disks (Nick Craig-Wood)
+ - Add deletedDirs stat to core/stats help output (Billy
+ Hughes)
+ - serve http
+ - Add fallback embedded favicon (Leon Brocard)
+ - Add gzip compression for text responses (Leon Brocard)
+ - Dark mode for file browser (FTCHD)
+ - Add HTTP/2 cleartext support for all http servers (TheBabu)
+ - touch: Add metadata when using --metadata-set (Prakhar
+ Chhalotre)
+- Bug Fixes
+ - accounting
+ - Update String method output format for clarity in transfer
+ rate representation (Prakhar Chhalotre)
+ - Fix rcat/copyurl for files.com (Nick Craig-Wood)
+ - bisync
+ - Add missing rc params (nielash)
+ - Add more structured info to rc output (nielash)
+ - Auto-generate rc help docs (nielash)
+ - Fix handling of unreadable lockfiles (lif)
+ - Fix flaky TestBisyncConcurrent by increasing random name
+ entropy (Nick Craig-Wood)
+ - Fix integration tests after sftp log changes (Nick
+ Craig-Wood)
+ - copyurl: Fix ignored --upload-headers and --download-headers
+ (Andriy Senyshyn)
+ - librclone/ctest: Add Windows support and fix memory management
+ (BizaNator)
+ - log: Fix data race on OutputHandler.format field (Nick
+ Craig-Wood)
+ - operations
+ - Multithread copy: grab memory before making go routines
+ (Nick Craig-Wood)
+ - serve dlna: Fix Samsung TV compatibility (Nick Craig-Wood)
+ - serve nfs: Fix EOF flag in READ response not being set when read
+ reaches end of file (Nick Craig-Wood)
+- Mount
+ - rc: fix mounts created with mountPoint "*" overwriting each
+ other (Nick Craig-Wood)
+- VFS
+ - Fix slow nfs serve by adding --vfs-handle-caching (Nick
+ Craig-Wood)
+ - Add context parameter to New() for config propagation (Nick
+ Craig-Wood)
+ - Replace context.TODO/Background with stored VFS context (Nick
+ Craig-Wood)
+- Local
+ - Remove fadvise calls that cause spinlock contention (Patrick
+ Farrell)
+- Azure Blob
+ - Add --azureblob-copy-total-concurrency to limit total multipart
+ copy concurrency (Duncan F)
+ - Add server side copy real time accounting (Nick Craig-Wood)
+ - Add --azureblob-decompress flag to download gzip-encoded files
+ (Nick Craig-Wood)
+- Azurefiles
+ - Fix missing x-ms-file-request-intent header with OAuth (Nick
+ Craig-Wood)
+- B2
+ - Add server side copy real time accounting (Nick Craig-Wood)
+- Drime
+ - Implement About (Cohinem)
+ - Fix listings of large directories (John Volk)
+- Drive
+ - Add integration test for handling folder names with single
+ quotes (Prakhar Chhalotre)
+- Filelu
+ - Add multipart init response type (kingston125)
+ - Migrate API calls to lib/rest (kingston125)
+- Filen
+ - Make multi-threaded upload chunks individually retryable
+ (Enduriel)
+- Iclouddrive
+ - Replace plaintext signin with SRP authentication (Mike GIllan)
+ - Use dynamic origin for SRP auth headers (Xiangzhe)
+ - Lowercase Apple ID for SRP authentication (Mike GIllan)
+ - Add read only iCloud Photos support and SRP authentication
+ (Yakov Till)
+- Internxt
+ - Implement multi-part uploads (José Zúniga)
+- Jottacloud
+ - Add encoding of percent character to default backend encoding
+ (albertony)
+- Linkbox
+ - Fix downloading files by using web API (Nick Craig-Wood)
+- Mega
+ - Fix crash when logging in with previous auth keys fails (Andrew
+ Gunnerson)
+- Pcloud
+ - Fix recursive listing from the root (Nick Craig-Wood)
+- Pikpak
+ - Support custom filenames for addurl backend command (wiserain)
+- Protondrive
+ - Align backend with newer Proton SDK stack (tdawe)
+ - Update to latest go-proton-api to use new host (dlaumen)
+ - Fix server-side moveto and DirMove against current API (Nick
+ Craig-Wood)
+- S3
+ - Add Fastly Object Storage provider (Leon Brocard)
+ - Add HCP provider and list_versions_oldest_first quirk (Chris)
+ - Add Impossible Cloud as a new S3 provider (Nick Craig-Wood)
+ - Add UCloud Object Storage provider (#9230) (jinkeyuu)
+ - Add Zadara Object Storage provider (Shlomi Avihou)
+ - Remove StackPath Object Storage provider (Leon Brocard)
+ - Add server side copy real time accounting (Nick Craig-Wood)
+ - Add OVHcloud storage classes (Bjoern Franke)
+ - Add Object Lock support (Chris)
+ - Add new Fastly Object Storage regions (Leon Brocard)
+ - Scaleway: ONEZONE_IA is available in all zones, GLACIER only in
+ FR-PAR (Bjoern Franke)
+ - Ionos: updated regions & endpoints (hxnd)
+ - IBM COS: provide ibm_iam_endpoint as a configurable param for
+ IBM IAM-based auth (Bhagyashreek8)
+ - Fix Content-MD5 for Object Lock uploads and add GCS quirk
+ (Chris)
+ - Fix regression where PutObject fails with non-seekable readers
+ (Chris)
+ - Fix --s3-versions flag ignored by cleanup-hidden when
+ GetBucketVersioning fails (Chris)
+ - Fix bucket creation failing on Ceph/radosgw (Jan Heylen)
+- SFTP
+ - Warn the user if no host key validation is configured (Nick
+ Craig-Wood)
+- WebDAV
+ - Permit redirects on PROPFIND for metadata (Brian Bockelman)
+ - Request only required properties in listAll to improve
+ performance (ZRHan)
+ - Optimize performance by using Depth=0 for metadata requests
+ (ZRHan)
+
+v1.73.5 - 2026-04-19
+
+See commits
+
+- Bug Fixes
+ - operations: Add AuthRequired to operations/fsinfo to prevent
+ backend creation CVE-2026-41179 (Nick Craig-Wood)
+ - rc
+ - Add AuthRequired to options/set to prevent auth bypass
+ CVE-2026-41176 (Nick Craig-Wood)
+ - Snapshot NoAuth at startup to prevent runtime auth bypass
+ CVE-2026-41176 (Nick Craig-Wood)
+ - filter: Fix debug logs that fire before logger is configured
+ (Nick Craig-Wood)
+- Azureblob
+ - Add Microsoft Partner Network User-Agent prefix (Nick
+ Craig-Wood)
+- Drime
+ - Fix User.EntryPermissions JSON unmarshalling (a1pcm)
+- Iclouddrive
+ - Fix 'directory not found' error when the directory contains
+ accent marks (Brais Couce)
+- S3
+ - Fix TencentCOS CDN endpoint failing on bucket check (Mozi)
+ - Fix empty delimiter parameter rejected by Archiware P5 server
+ (Nick Craig-Wood)
+
+v1.73.4 - 2026-04-08
+
+See commits
+
+- Bug Fixes
+ - build
+ - Update to go 1.25.9 to fix multiple CVEs (Nick Craig-Wood)
+ - CVE-2026-32282: os: Root.Chmod can follow symlinks out
+ of the root on Linux
+ - CVE-2026-32289: html/template: JS template literal
+ context incorrectly tracked
+ - CVE-2026-33810: crypto/x509: excluded DNS constraints
+ not properly applied to wildcard domains
+ - CVE-2026-27144: cmd/compile: no-op interface conversion
+ bypasses overlap checking
+ - CVE-2026-27143: cmd/compile: possible memory corruption
+ after bound check elimination
+ - CVE-2026-32288: archive/tar: unbounded allocation when
+ parsing old format GNU sparse map
+ - CVE-2026-32283: crypto/tls: multiple key update
+ handshake messages can cause connection to deadlock
+ - CVE-2026-27140: cmd/go: trust layer bypass when using
+ cgo and SWIG
+ - CVE-2026-32280: crypto/x509: unexpected work during
+ chain building
+ - CVE-2026-32281: crypto/x509: inefficient policy
+ validation
+ - Fix Denial of Service due to Panic in AWS SDK for Go v2 SDK
+ EventStream Decoder (dependabot[bot])
+ - Update golang.org/x/image to 0.38.0 to fix CVE-2026-33809
+ (dependabot[bot])
+ - docs
+ - Fix header level for metadata option (Clément Notin)
+ - Fix markdown issues in mount docs (albertony)
+ - Fix link to not be language specific (Ross Smith II)
+ - Note macOS 10.15 (Catalina) support with version v1.70.3
+ (kapitainsky)
+- Filen
+ - Update SDK version (Enduriel)
+
+v1.73.3 - 2026-03-23
+
+See commits
+
+- Bug Fixes
+ - build
+ - Update to google.golang.org/grpc 1.79.3 to fix
+ CVE-2026-33186 (dependabot[bot])
+ - Update to github.com/buger/jsonparser 1.1.2 to fix
+ GHSA-6g7g-w4f8-9c9x (dependabot[bot])
+ - doc fixes
+ - Added text to the label showing version-introduced info
+ (Jan-Philipp Reßler)
+ - Clarify Filen password change requires updating both
+ password and API key in rclone config (Jason)
+ - s3: clarify multi tenant support for Cubbit (Marco Ferretti)
+ - jottacloud: Fix broken link (albertony)
+ - lib/rest: Fix URLPathEscapeAll breaking WebDAV servers (eg
+ nzbdav) with strict path matching (Andrew Furman)
+ - list: Fix nil pointer panic in Sorter when temp file creation
+ fails (Nick Craig-Wood)
+
+v1.73.2 - 2026-03-06
+
+See commits
+
+- Bug Fixes
+ - build
+ - Update to go 1.25.8 to fix CVE-2026-27137 CVE-2026-27138
+ CVE-2026-25679 CVE-2026-27142 (Nick Craig-Wood)
+ - Update github.com/cloudflare/circl to v1.6.3 to fix
+ CVE-2026-1229 (Nick Craig-Wood)
+ - Update to golang.org/x/net v0.51.0 to fix CVE-2026-27141
+ (Nick Craig-Wood)
+ - docs fixes:
+ - bisync: Add group Sync to the bisync command (Jan-Philipp
+ Reßler)
+ - Note that --use-server-modtime only works on some backends
+ (Nick Craig-Wood)
+ - Document unsupported S3 object keys with double slashes
+ (Adam Kasztenny)
+ - Fix headers hierarchy for mount.md (Dark Dragon)
+ - Fix new drive flag typo in changelog (razorloves)
+- Archive
+ - Extract: fix extraction with "./" prefix from tar entry paths
+ (Varun Chawla)
+- Drime
+ - Fix chunk-uploaded files ignoring workspace ID (a1pcm)
+- Internxt
+ - Fix Entry doesn't belong in directory errors on windows
+ (jzunigax2)
+- WebDAV
+ - Escape reserved characters in URL path segments (Varun Chawla)
+ - Add missing headers for CORS (Romāns Potašovs)
+
+v1.73.1 - 2026-02-17
+
+See commits
+
+- Bug Fixes
+ - accounting: Fix missing server side stats from core/stats rc
+ (Nick Craig-Wood)
+ - build
+ - Fix CVE-2025-68121 by updating go to 1.25.7 or later (Nick
+ Craig-Wood)
+ - Bump github.com/go-chi/chi/v5 from 5.2.3 to 5.2.5 to fix
+ GO-2026-4316 (albertony)
+ - docs: Extend copyurl docs with an example of CSV FILENAMEs
+ starting with a path. (Jack Kelly)
+ - march: Fix runtime: program exceeds 10000-thread limit (Nick
+ Craig-Wood)
+ - pacer
+ - Fix deadlock between pacer token and --max-connections (Nick
+ Craig-Wood)
+ - Re-read the sleep time as it may be stale (Nick Craig-Wood)
+- Drime
+ - Fix files and directories being created in the default workspace
+ (Nick Craig-Wood)
+- Filelu
+ - Avoid buffering entire file in memory (kingston125)
+ - Add multipart upload support with configurable cutoff
+ (kingston125)
+- Filen
+ - Fix 32 bit targets not being able to list directories (Enduriel)
+ - Fix potential panic in case of error during upload (Enduriel)
+- Internxt
+ - Implement re-login under refresh logic, improve retry logic
+ (José Zúniga) -S3
+ - Set list_version to 2 for FileLu S3 configuration (kingston125)
+
v1.73.0 - 2026-01-30
See commits
@@ -65135,7 +67697,7 @@ See commits
- Support authentication with new bucket restricted application
keys (DianaNites)
- Drive
- - Add --drive-metadata-force-expansive-access flag (Nick
+ - Add --drive-metadata-enforce-expansive-access flag (Nick
Craig-Wood)
- Fix crash when trying to creating shortcut to a Google doc (Nick
Craig-Wood)
@@ -74647,7 +77209,7 @@ Contributors
- Nathanael Demacon [email protected]
- Flora Thiebaut [email protected]
-- kingston125 [email protected]
- jinjingroad [email protected]
@@ -74745,6 +77307,56 @@ Contributors
- jzunigax2 [email protected]
- StarHack [email protected]
+- Leon Brocard [email protected]
+- Jack Kelly [email protected]
+- Prakhar Chhalotre [email protected]
+- Varun Chawla [email protected]
+- Jan-Philipp Reßler [email protected]
+- Shlomi Avihou [email protected]
+- Jan-Philipp Reßler [email protected]
+- Dark Dragon [email protected]
+- Leon Brocard [email protected]
+- Bjoern Franke [email protected]
+- Adam Kasztenny [email protected]
+- Romāns Potašovs [email protected]
+- Brian Bockelman [email protected]
+- Bjoern Franke [email protected]
+- razorloves [email protected]
+- Duncan F [email protected]
+- Billy Hughes [email protected]
+- Bhagyashreek8 [email protected]
+- Andriy Senyshyn [email protected]
+- Andrew Furman [email protected]
+- Patrick Farrell [email protected]
+- BizaNator [email protected]
+- jinkeyuu [email protected]
+- jinyu.han [email protected]
+- Claude Opus 4.6 [email protected]
+- Andriy Senyshyn [email protected]
+- Mike GIllan [email protected]
+- Xiangzhe [email protected]
+- Brais Couce [email protected]
+- Jan Heylen [email protected]
+- Anton Bordwine [email protected]
+- mathieulongtin [email protected]
+- Luke Cyca [email protected]
+- Yakov Till [email protected]
+- Chris Coughlan [email protected]
+- John Volk [email protected]
Contact the rclone project
diff --git a/cmd/bisync/rc.md b/cmd/bisync/rc.md
index 271d816ea..dc3efd482 100644
--- a/cmd/bisync/rc.md
+++ b/cmd/bisync/rc.md
@@ -54,7 +54,7 @@ none for no resync.)
- slowHashSyncOnly - (bool) Ignore slow checksums for listings and deltas, but
still consider them during sync calls.
- workdir - (string) Use custom working dir - useful for testing. (default:
-~/.cache/rclone/bisync)
+/home/ncw/.cache/rclone/bisync)
See [bisync command help](https://rclone.org/commands/rclone_bisync/)
and [full bisync description](https://rclone.org/bisync/)
diff --git a/docs/content/azureblob.md b/docs/content/azureblob.md
index e34ed5fcb..df401fe05 100644
--- a/docs/content/azureblob.md
+++ b/docs/content/azureblob.md
@@ -845,6 +845,22 @@ Properties:
- Type: int
- Default: 512
+#### --azureblob-copy-total-concurrency
+
+Global concurrency limit for multipart copy chunks.
+
+This limits the total number of multipart copy chunks running at once
+across all files.
+
+Set to 0 to disable this limiter.
+
+Properties:
+
+- Config: copy_total_concurrency
+- Env Var: RCLONE_AZUREBLOB_COPY_TOTAL_CONCURRENCY
+- Type: int
+- Default: 0
+
#### --azureblob-use-copy-blob
Whether to use the Copy Blob API when copying to the same storage account.
@@ -1063,6 +1079,25 @@ Properties:
- "only"
- Specify 'only' to remove only the snapshots but keep the root blob.
+#### --azureblob-decompress
+
+If set this will decompress gzip encoded objects.
+
+It is possible to upload objects to Azure Blob Storage with "Content-Encoding: gzip"
+set. Normally rclone will download these files as compressed objects.
+
+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.
+
+
+Properties:
+
+- Config: decompress
+- Env Var: RCLONE_AZUREBLOB_DECOMPRESS
+- Type: bool
+- Default: false
+
#### --azureblob-description
Description of the remote.
diff --git a/docs/content/bisync.md b/docs/content/bisync.md
index eca7565e5..98f7a9100 100644
--- a/docs/content/bisync.md
+++ b/docs/content/bisync.md
@@ -1055,11 +1055,7 @@ The following backends have known issues that need more investigation:
<!--- start list_failures - DO NOT EDIT THIS SECTION - use make commanddocs --->
- `TestDropbox` (`dropbox`)
- [`TestBisyncRemoteRemote/normalization`](https://pub.rclone.org/integration-tests/current/dropbox-cmd.bisync-TestDropbox-1.txt)
-- `TestSeafile` (`seafile`)
- - [`TestBisyncLocalRemote/volatile`](https://pub.rclone.org/integration-tests/current/seafile-cmd.bisync-TestSeafile-1.txt)
-- `TestSeafileV6` (`seafile`)
- - [`TestBisyncLocalRemote/volatile`](https://pub.rclone.org/integration-tests/current/seafile-cmd.bisync-TestSeafileV6-1.txt)
-- Updated: 2026-01-30-010015
+- Updated: 2026-05-01-010013
<!--- end list_failures - DO NOT EDIT THIS SECTION - use make commanddocs --->
The following backends either have not been tested recently or have known issues
diff --git a/docs/content/changelog.md b/docs/content/changelog.md
index be29898d9..09a0c13a3 100644
--- a/docs/content/changelog.md
+++ b/docs/content/changelog.md
@@ -6,6 +6,135 @@ description: "Rclone Changelog"
# Changelog
+## v1.74.0 - 2026-05-01
+
+[See commits](https://github.com/rclone/rclone/compare/v1.73.0...v1.74.0)
+
+- New backends
+ - [Huawei Drive](/huaweidrive/) (王一赫)
+ - [iCloud Photos](/iclouddrive/#icloud-photos) (read only) (Yakov Till)
+ - New S3 providers
+ - [Fastly Object Storage](/s3/#fastly) (Leon Brocard)
+ - [HCP](/s3/#hcp) (Chris)
+ - [Impossible Cloud](/s3/#impossible-cloud) (Nick Craig-Wood)
+ - [UCloud US3](/s3/#us3) (jinkeyuu)
+ - [Zadara](/s3/#zadara) (Shlomi Avihou)
+- New commands
+ - [gui](/gui/): launch new embedded web based GUI for basic rclone operations (FTCHD, Nick Craig-Wood)
+- New Features
+ - build
+ - Update `golang.org/x/image/webp` to v0.39.0 to fix CVE-2026-33813 (Nick Craig-Wood)
+ - Bump `github.com/Azure/go-ntlmssp` to 0.1.1 to fix CVE-2026-32952 (dependabot[bot])
+ - Update to go1.26 and make go1.25 the minimum required version (Nick Craig-Wood)
+ - Update all dependencies (Nick Craig-Wood)
+ - Modernize Go code with go fix for go1.25 (Nick Craig-Wood)
+ - Fix `loong64` and `s390x` build (Suyun)
+ - docs
+ - Modernize rclone.org site design (Nick Craig-Wood)
+ - fixes (albertony, Enduriel, Jason, Luke Cyca, mathieulongtin, Nick Craig-Wood, SyoBoN)
+ - fshttp: Add `--dump curl` for dumping HTTP requests as curl commands (Nick Craig-Wood)
+ - graphics: Optimise images losslessly with ImageOptim (Leon Brocard)
+ - listremotes: Add `--exact` flag for filtering (Anton Bordwine)
+ - rc
+ - Flip auth default so all endpoints require auth unless opted out (Nick Craig-Wood)
+ - Add `core/disks` to enumerate attached disks (Nick Craig-Wood)
+ - Add `deletedDirs` stat to `core/stats` help output (Billy Hughes)
+ - serve http
+ - Add fallback embedded favicon (Leon Brocard)
+ - Add gzip compression for text responses (Leon Brocard)
+ - Dark mode for file browser (FTCHD)
+ - Add HTTP/2 cleartext support for all http servers (TheBabu)
+ - touch: Add metadata when using `--metadata-set` (Prakhar Chhalotre)
+- Bug Fixes
+ - accounting
+ - Update String method output format for clarity in transfer rate representation (Prakhar Chhalotre)
+ - Fix `rcat`/`copyurl` for `files.com` (Nick Craig-Wood)
+ - bisync
+ - Add missing rc params (nielash)
+ - Add more structured info to rc output (nielash)
+ - Auto-generate rc help docs (nielash)
+ - Fix handling of unreadable lockfiles (lif)
+ - Fix flaky TestBisyncConcurrent by increasing random name entropy (Nick Craig-Wood)
+ - Fix integration tests after sftp log changes (Nick Craig-Wood)
+ - copyurl: Fix ignored `--upload-headers` and `--download-headers` (Andriy Senyshyn)
+ - librclone/ctest: Add Windows support and fix memory management (BizaNator)
+ - log: Fix data race on OutputHandler.format field (Nick Craig-Wood)
+ - operations
+ - Multithread copy: grab memory before making go routines (Nick Craig-Wood)
+ - serve dlna: Fix Samsung TV compatibility (Nick Craig-Wood)
+ - serve nfs: Fix EOF flag in READ response not being set when read reaches end of file (Nick Craig-Wood)
+- Mount
+ - rc: fix mounts created with mountPoint "*" overwriting each other (Nick Craig-Wood)
+- VFS
+ - Fix slow `nfs serve` by adding `--vfs-handle-caching` (Nick Craig-Wood)
+ - Add context parameter to New() for config propagation (Nick Craig-Wood)
+ - Replace `context.TODO`/`Background` with stored VFS context (Nick Craig-Wood)
+- Local
+ - Remove fadvise calls that cause spinlock contention (Patrick Farrell)
+- Azure Blob
+ - Add `--azureblob-copy-total-concurrency` to limit total multipart copy concurrency (Duncan F)
+ - Add server side copy real time accounting (Nick Craig-Wood)
+ - Add `--azureblob-decompress` flag to download gzip-encoded files (Nick Craig-Wood)
+- Azurefiles
+ - Fix missing `x-ms-file-request-intent` header with OAuth (Nick Craig-Wood)
+- B2
+ - Add server side copy real time accounting (Nick Craig-Wood)
+- Drime
+ - Implement About (Cohinem)
+ - Fix listings of large directories (John Volk)
+- Drive
+ - Add integration test for handling folder names with single quotes (Prakhar Chhalotre)
+- Filelu
+ - Add multipart init response type (kingston125)
+ - Migrate API calls to `lib/rest` (kingston125)
+- Filen
+ - Make multi-threaded upload chunks individually retryable (Enduriel)
+- Iclouddrive
+ - Replace plaintext signin with SRP authentication (Mike GIllan)
+ - Use dynamic origin for SRP auth headers (Xiangzhe)
+ - Lowercase Apple ID for SRP authentication (Mike GIllan)
+ - Add read only iCloud Photos support and SRP authentication (Yakov Till)
+- Internxt
+ - Implement multi-part uploads (José Zúniga)
+- Jottacloud
+ - Add encoding of percent character to default backend encoding (albertony)
+- Linkbox
+ - Fix downloading files by using web API (Nick Craig-Wood)
+- Mega
+ - Fix crash when logging in with previous auth keys fails (Andrew Gunnerson)
+- Pcloud
+ - Fix recursive listing from the root (Nick Craig-Wood)
+- Pikpak
+ - Support custom filenames for addurl backend command (wiserain)
+- Protondrive
+ - Align backend with newer Proton SDK stack (tdawe)
+ - Update to latest go-proton-api to use new host (dlaumen)
+ - Fix server-side moveto and DirMove against current API (Nick Craig-Wood)
+- S3
+ - Add Fastly Object Storage provider (Leon Brocard)
+ - Add HCP provider and `list_versions_oldest_first` quirk (Chris)
+ - Add Impossible Cloud as a new S3 provider (Nick Craig-Wood)
+ - Add UCloud Object Storage provider (#9230) (jinkeyuu)
+ - Add Zadara Object Storage provider (Shlomi Avihou)
+ - Remove StackPath Object Storage provider (Leon Brocard)
+ - Add server side copy real time accounting (Nick Craig-Wood)
+ - Add OVHcloud storage classes (Bjoern Franke)
+ - Add Object Lock support (Chris)
+ - Add new Fastly Object Storage regions (Leon Brocard)
+ - Scaleway: ONEZONE_IA is available in all zones, GLACIER only in FR-PAR (Bjoern Franke)
+ - Ionos: updated regions & endpoints (hxnd)
+ - IBM COS: provide ibm_iam_endpoint as a configurable param for IBM IAM-based auth (Bhagyashreek8)
+ - Fix Content-MD5 for Object Lock uploads and add GCS quirk (Chris)
+ - Fix regression where PutObject fails with non-seekable readers (Chris)
+ - Fix `--s3-versions` flag ignored by cleanup-hidden when GetBucketVersioning fails (Chris)
+ - Fix bucket creation failing on Ceph/radosgw (Jan Heylen)
+- SFTP
+ - Warn the user if no host key validation is configured (Nick Craig-Wood)
+- WebDAV
+ - Permit redirects on PROPFIND for metadata (Brian Bockelman)
+ - Request only required properties in listAll to improve performance (ZRHan)
+ - Optimize performance by using `Depth=0` for metadata requests (ZRHan)
+
## v1.73.5 - 2026-04-19
[See commits](https://github.com/rclone/rclone/compare/v1.73.4...v1.73.5)
diff --git a/docs/content/commands/rclone.md b/docs/content/commands/rclone.md
index 23788d2b8..b5a7f00b6 100644
--- a/docs/content/commands/rclone.md
+++ b/docs/content/commands/rclone.md
@@ -40,6 +40,8 @@ rclone [flags]
--azureblob-connection-string string Storage Connection String
--azureblob-copy-concurrency int Concurrency for multipart copy (default 512)
--azureblob-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 8Mi)
+ --azureblob-copy-total-concurrency int Global concurrency limit for multipart copy chunks
+ --azureblob-decompress If set this will decompress gzip encoded objects
--azureblob-delete-snapshots string Set to specify how to deal with snapshots on blob deletion
--azureblob-description string Description of the remote
--azureblob-directory-markers Upload an empty object with a trailing slash when a new directory is created
@@ -305,7 +307,7 @@ rclone [flags]
--dropbox-token-url string Token server url
-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, mapper
+ --dump DumpFlags List of items to dump from: headers, bodies, requests, responses, auth, filters, goroutines, openfiles, mapper, curl
--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
@@ -329,9 +331,11 @@ rclone [flags]
--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
+ --filelu-chunk-size SizeSuffix Chunk size to use for uploading. Used for multipart uploads (default 64Mi)
--filelu-description string Description of the remote
--filelu-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,Colon,Question,Asterisk,Pipe,Hash,Percent,BackSlash,CrLf,Del,Ctl,LeftSpace,LeftPeriod,LeftTilde,LeftCrLfHtVt,RightSpace,RightPeriod,RightCrLfHtVt,InvalidUtf8,Dot,SquareBracket,Semicolon,Exclamation)
--filelu-key string Your FileLu Rclone key from My Account
+ --filelu-upload-cutoff SizeSuffix Cutoff for switching to chunked upload. Any files larger than this will be uploaded in chunks of chunk_size (default 500Mi)
--filen-api-key string API Key for your Filen account (obscured)
--filen-auth-version string Authentication Version (internal use only)
--filen-base-folder-uuid string UUID of Account Root Directory (internal use only)
@@ -465,12 +469,25 @@ rclone [flags]
--http-no-slash Set this if the site doesn't end directories with /
--http-proxy string HTTP proxy URL
--http-url string URL of HTTP host to connect to
+ --huaweidrive-auth-url string Auth server URL
+ --huaweidrive-chunk-size SizeSuffix Upload chunk size (default 8Mi)
+ --huaweidrive-client-credentials Use client credentials OAuth flow
+ --huaweidrive-client-id string OAuth Client Id
+ --huaweidrive-client-secret string OAuth Client Secret
+ --huaweidrive-description string Description of the remote
+ --huaweidrive-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftSpace,LeftPeriod,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot)
+ --huaweidrive-list-chunk int Size of listing chunk 1-1000 (default 1000)
+ --huaweidrive-root-folder-id string ID of the root folder
+ --huaweidrive-token string OAuth Access Token as a JSON blob
+ --huaweidrive-token-url string Token server url
+ --huaweidrive-upload-cutoff SizeSuffix Cutoff for switching to resumable upload (default 20Mi)
--human-readable Print numbers in a human-readable format, sizes with suffix Ki|Mi|Gi|Ti|Pi
--iclouddrive-apple-id string Apple ID
- --iclouddrive-client-id string Client id (default "d39ba9916b7251055b22c7f910e2ea796ee65e98b2ddecea8f5dde8d9d1a815d")
+ --iclouddrive-client-id string Client ID for iCloud API access (default "d39ba9916b7251055b22c7f910e2ea796ee65e98b2ddecea8f5dde8d9d1a815d")
--iclouddrive-description string Description of the remote
--iclouddrive-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
--iclouddrive-password string Password (obscured)
+ --iclouddrive-service string iCloud service to use (default "drive")
--ignore-case Ignore case in filters (case insensitive)
--ignore-case-sync Ignore case when synchronizing
--ignore-checksum Skip post copy check of checksums
@@ -501,17 +518,20 @@ rclone [flags]
--internetarchive-item-metadata stringArray Metadata to be set on the IA item, this is different from file-level metadata that can be set using --metadata-set
--internetarchive-secret-access-key string IAS3 Secret Key (password)
--internetarchive-wait-archive Duration Timeout for waiting the server's processing tasks (specifically archive and book_op) to finish (default 0s)
+ --internxt-chunk-size SizeSuffix Chunk size for multipart uploads (default 30Mi)
--internxt-description string Description of the remote
--internxt-email string Email of your Internxt account
--internxt-encoding Encoding The encoding for the backend (default Slash,BackSlash,CrLf,RightPeriod,InvalidUtf8,Dot)
--internxt-pass string Password (obscured)
--internxt-skip-hash-validation Skip hash validation when downloading files (default true)
+ --internxt-upload-concurrency int Concurrency for multipart uploads (default 4)
+ --internxt-upload-cutoff SizeSuffix Cutoff for switching to multipart upload (default 100Mi)
--jottacloud-auth-url string Auth server URL
--jottacloud-client-credentials Use client credentials OAuth flow
--jottacloud-client-id string OAuth Client Id
--jottacloud-client-secret string OAuth Client Secret
--jottacloud-description string Description of the remote
- --jottacloud-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot)
+ --jottacloud-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Percent,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
@@ -529,6 +549,8 @@ rclone [flags]
--koofr-user string Your user name
--kv-lock-time Duration Maximum time to keep key-value database locked by process (default 1s)
--linkbox-description string Description of the remote
+ --linkbox-email string Email for login
+ --linkbox-password string Password for login (obscured)
--linkbox-token string Token from https://www.linkbox.to/admin/account
-l, --links Translate symlinks to/from regular files with a '.rclonelink' extension
--list-cutoff int To save memory, sort directory listings on disk above this threshold (default 1000000)
@@ -744,7 +766,7 @@ rclone [flags]
-P, --progress Show progress during transfer
--progress-terminal-title Show progress on the terminal title (requires -P/--progress)
--protondrive-2fa string The 2FA code
- --protondrive-app-version string The app version string (default "[email protected]+rclone")
+ --protondrive-app-version string The app version string
--protondrive-description string Description of the remote
--protondrive-enable-caching Caches the files and folders metadata to reduce API calls (default true)
--protondrive-encoding Encoding The encoding for the backend (default Slash,LeftSpace,RightSpace,InvalidUtf8,Dot)
@@ -819,6 +841,8 @@ rclone [flags]
--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-bucket-object-lock-enabled Enable Object Lock when creating new buckets
+ --s3-bypass-governance-retention Allow deleting or modifying objects locked with GOVERNANCE mode
--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
@@ -833,11 +857,13 @@ rclone [flags]
--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-ibm-api-key string IBM API Key to be used to obtain IAM token
+ --s3-ibm-iam-endpoint string IBM IAM Endpoint to use for authentication
--s3-ibm-resource-instance-id string IBM service instance id
--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-list-versions-oldest-first Tristate Set if the backend returns object versions oldest first (default unset)
--s3-location-constraint string Location constraint - must be set to match the Region
--s3-max-upload-parts int Maximum number of parts in a multipart upload (default 10000)
--s3-might-gzip Tristate Set this if the backend might gzip objects (default unset)
@@ -845,6 +871,11 @@ rclone [flags]
--s3-no-head If set, don'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-object-lock-legal-hold-status string Object Lock legal hold status to apply when uploading or copying objects
+ --s3-object-lock-mode string Object Lock mode to apply when uploading or copying objects
+ --s3-object-lock-retain-until-date string Object Lock retention until date to apply when uploading or copying objects
+ --s3-object-lock-set-after-upload Set Object Lock via separate API calls after upload
+ --s3-object-lock-supported Tristate Whether the provider supports S3 Object Lock (default unset)
--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
@@ -1063,7 +1094,7 @@ rclone [flags]
--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 "rclone/v1.73.0")
+ --user-agent string Set the user-agent to a specified string (default "rclone/v1.74.0")
-v, --verbose count Print lots more stuff (repeat for more)
-V, --version Print the version number
--webdav-auth-redirect Preserve authentication on redirect
@@ -1130,6 +1161,7 @@ rclone [flags]
* [rclone deletefile](/commands/rclone_deletefile/) - Remove a single file from remote.
* [rclone gendocs](/commands/rclone_gendocs/) - Output markdown docs for rclone to the directory supplied.
* [rclone gitannex](/commands/rclone_gitannex/) - Speaks with git-annex over stdin/stdout.
+* [rclone gui](/commands/rclone_gui/) - Open the web based GUI.
* [rclone hashsum](/commands/rclone_hashsum/) - Produces a hashsum file for all the objects in the path.
* [rclone link](/commands/rclone_link/) - Generate public link to file/folder.
* [rclone listremotes](/commands/rclone_listremotes/) - List all the remotes in the config file and defined in environment variables.
diff --git a/docs/content/commands/rclone_bisync.md b/docs/content/commands/rclone_bisync.md
index fc56fd535..beac96cd4 100644
--- a/docs/content/commands/rclone_bisync.md
+++ b/docs/content/commands/rclone_bisync.md
@@ -29,6 +29,7 @@ before using, or data loss can result. Questions can be asked in the
See [full bisync description](https://rclone.org/bisync/) for details.
+
```
rclone bisync remote1:path1 remote2:path2 [flags]
```
@@ -60,7 +61,7 @@ rclone bisync remote1:path1 remote2:path2 [flags]
-1, --resync Performs the resync run. Equivalent to --resync-mode path1. Consider using --verbose or --dry-run first.
--resync-mode string During resync, prefer the version that is: path1, path2, newer, older, larger, smaller (default: path1 if --resync, otherwise none for no resync.) (default "none")
--slow-hash-sync-only Ignore slow checksums for listings and deltas, but still consider them during sync calls.
- --workdir string Use custom working dir - useful for testing. (default: {WORKDIR})
+ --workdir string Use custom working dir - useful for testing. (default: $HOME/.cache/rclone/bisync)
```
Options shared with other commands are described next.
@@ -107,6 +108,26 @@ Flags for anything which can copy a file
-u, --update Skip files that are newer on the destination
```
+### Sync Options
+
+Flags used for sync commands
+
+```text
+ --backup-dir string Make backups into hierarchy based in DIR
+ --delete-after When synchronizing, delete files on destination after transferring (default)
+ --delete-before When synchronizing, delete files on destination before transferring
+ --delete-during When synchronizing, delete files during transfer
+ --fix-case Force rename of case insensitive dest to match source
+ --ignore-errors Delete even if there are I/O errors
+ --list-cutoff int To save memory, sort directory listings on disk above this threshold (default 1000000)
+ --max-delete int When synchronizing, limit the number of deletes (default -1)
+ --max-delete-size SizeSuffix When synchronizing, limit the total size of deletes (default off)
+ --suffix string Suffix to add to changed files
+ --suffix-keep-extension Preserve the extension when using --suffix
+ --track-renames When synchronizing, track file renames and do a server-side move if possible
+ --track-renames-strategy string Strategies to use when synchronizing using track-renames hash|modtime|leaf (default "hash")
+```
+
### Important Options
Important flags useful for most commands
diff --git a/docs/content/commands/rclone_convmv.md b/docs/content/commands/rclone_convmv.md
index 83840905a..98c232f73 100644
--- a/docs/content/commands/rclone_convmv.md
+++ b/docs/content/commands/rclone_convmv.md
@@ -231,12 +231,12 @@ rclone convmv "stories/The Quick Brown Fox!.txt" --name-transform "all,command=e
```console
rclone convmv "stories/The Quick Brown Fox!" --name-transform "date=-{YYYYMMDD}"
-// Output: stories/The Quick Brown Fox!-20260130
+// Output: stories/The Quick Brown Fox!-20260501
```
```console
rclone convmv "stories/The Quick Brown Fox!" --name-transform "date=-{macfriendlytime}"
-// Output: stories/The Quick Brown Fox!-2026-01-30 0825PM
+// Output: stories/The Quick Brown Fox!-2026-05-01 0208PM
```
```console
diff --git a/docs/content/commands/rclone_copyurl.md b/docs/content/commands/rclone_copyurl.md
index 0df388f87..47958051f 100644
--- a/docs/content/commands/rclone_copyurl.md
+++ b/docs/content/commands/rclone_copyurl.md
@@ -39,6 +39,15 @@ Note that `--stdout` and `--print-filename` are incompatible with `--urls`.
This will do `--transfers` copies in parallel. Note that if `--auto-filename`
is desired for all URLs then a file with only URLs and no filename can be used.
+Each FILENAME in the CSV file can start with a relative path which will be appended
+to the destination path provided at the command line. For example, running the command
+shown above with the following CSV file will write two files to the destination:
+`remote:dir/local/path/bar.json` and `remote:dir/another/local/directory/qux.json`
+```csv
+https://example.org/foo/bar.json,local/path/bar.json
+https://example.org/qux/baz.json,another/local/directory/qux.json
+```
+
## Troubleshooting
If you can't get `rclone copyurl` to work then here are some things you can try:
diff --git a/docs/content/commands/rclone_gui.md b/docs/content/commands/rclone_gui.md
new file mode 100644
index 000000000..7da610cc4
--- /dev/null
+++ b/docs/content/commands/rclone_gui.md
@@ -0,0 +1,118 @@
+---
+title: "rclone gui"
+description: "Open the web based GUI."
+versionIntroduced: v1.74
+# autogenerated - DO NOT EDIT, instead edit the source code in cmd/gui/ and as part of making a release run "make commanddocs"
+---
+# rclone gui
+
+Open the web based GUI.
+
+## Synopsis
+
+This command starts an embedded web GUI for rclone and opens it in
+your default browser.
+
+This starts an RC API server and a GUI server on separate localhost
+ports, generates login credentials automatically unless --no-auth
+is specified, and opens the browser already authenticated.
+
+ rclone gui
+
+By default rclone gui serves the web GUI that was embedded into the
+rclone binary at build time from https://github.com/rclone/rclone-web/
+You can override this by passing a path to either an unpacked GUI
+directory or a dist.zip archive (e.g. one downloaded from the
+rclone-web releases page):
+
+ rclone gui ./my-dist/
+ rclone gui ./dist.zip
+
+This is useful for iterating on the GUI locally without rebuilding
+rclone, or for serving a different GUI release than the one embedded.
+
+Use --no-open-browser to skip opening the browser automatically:
+
+ rclone gui --no-open-browser
+
+Use --addr to bind the GUI to a specific address:
+
+ rclone gui --addr localhost:5580
+
+Use --user and --pass to set specific credentials:
+
+ rclone gui --user admin --pass secret
+
+Use --no-auth to disable authentication entirely:
+
+ rclone gui --no-auth
+
+For more help see [the GUI docs](/gui/).
+
+
+```
+rclone gui [path] [flags]
+```
+
+## Options
+
+```
+ --addr stringArray IPaddress:Port for the GUI server (default auto-chosen localhost port)
+ --api-addr stringArray IPaddress:Port for the RC API server (default auto-chosen localhost port)
+ --enable-metrics Enable OpenMetrics/Prometheus compatible endpoint at /metrics
+ -h, --help help for gui
+ --no-auth Don't require auth for the RC API
+ --no-open-browser Skip opening the browser automatically
+ --pass string Password for RC authentication
+ --user string User name for RC authentication
+```
+
+Options shared with other commands are described next.
+See the [global flags page](/flags/) for global options not listed here.
+
+### RC Options
+
+Flags to control the Remote Control API
+
+```text
+ --rc Enable the remote control server
+ --rc-addr stringArray IPaddress:Port or :Port to bind server to (default localhost:5572)
+ --rc-allow-origin string Origin which cross-domain request (CORS) can be executed from
+ --rc-baseurl string Prefix for URLs - leave blank for root
+ --rc-cert string TLS PEM key (concatenation of certificate and CA certificate)
+ --rc-client-ca string Client certificate authority to verify clients with
+ --rc-enable-metrics Enable the Prometheus metrics path at the remote control server
+ --rc-files string Path to local files to serve on the HTTP server
+ --rc-htpasswd string A htpasswd file - if not provided no authentication is done
+ --rc-job-expire-duration Duration Expire finished async jobs older than this value (default 1m0s)
+ --rc-job-expire-interval Duration Interval to check for expired async jobs (default 10s)
+ --rc-key string TLS PEM Private key
+ --rc-max-header-bytes int Maximum size of request header (default 4096)
+ --rc-min-tls-version string Minimum TLS version that is acceptable (default "tls1.0")
+ --rc-no-auth Don't require auth for certain methods
+ --rc-pass string Password for authentication
+ --rc-realm string Realm for authentication
+ --rc-salt string Password hashing salt (default "dlPL2MqE")
+ --rc-serve Enable the serving of remote objects
+ --rc-serve-no-modtime Don't read the modification time (can speed things up)
+ --rc-server-read-timeout Duration Timeout for server reading data (default 1h0m0s)
+ --rc-server-write-timeout Duration Timeout for server writing data (default 1h0m0s)
+ --rc-template string User-specified template
+ --rc-user string User name for authentication
+ --rc-user-from-header string User name from a defined HTTP header
+ --rc-web-fetch-url string URL to fetch the releases for webgui (default "https://api.github.com/repos/rclone/rclone-webui-react/releases/latest")
+ --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't open the browser automatically
+ --rc-web-gui-update Check and update to latest version of web gui
+```
+
+## See Also
+
+<!-- markdownlint-capture -->
+<!-- markdownlint-disable ul-style line-length -->
+
+* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.
+
+
+<!-- markdownlint-restore -->
diff --git a/docs/content/commands/rclone_listremotes.md b/docs/content/commands/rclone_listremotes.md
index 51488704e..3f13e4aca 100644
--- a/docs/content/commands/rclone_listremotes.md
+++ b/docs/content/commands/rclone_listremotes.md
@@ -23,6 +23,9 @@ Result can be filtered by a filter argument which applies to all attributes,
and/or filter flags specific for each attribute. The values must be specified
according to regular rclone filtering pattern syntax.
+By default filtering uses non-anchored matching, so `--type box` also
+matches `dropbox`. Use `--exact` to match complete values only.
+
```
rclone listremotes [<filter>] [flags]
```
@@ -31,6 +34,7 @@ rclone listremotes [<filter>] [flags]
```
--description string Filter remotes by description
+ --exact Match filter strings exactly instead of using non-anchored glob matching
-h, --help help for listremotes
--json Format output as JSON
--long Show type and description in addition to name
diff --git a/docs/content/commands/rclone_mount.md b/docs/content/commands/rclone_mount.md
index 9b294500c..21e2d5697 100644
--- a/docs/content/commands/rclone_mount.md
+++ b/docs/content/commands/rclone_mount.md
@@ -13,7 +13,8 @@ Mount the remote as file system on a mountpoint.
Rclone mount allows Linux, FreeBSD, macOS and Windows to
mount any of Rclone's cloud storage systems as a file system with FUSE.
-First set up your remote using `rclone config`. Check it works with `rclone ls` etc.
+First set up your remote using `rclone config`. Check it works with `rclone ls`
+etc.
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 `--daemon` flag
@@ -41,8 +42,8 @@ The following examples will mount to an automatically assigned drive,
to specific drive letter `X:`, to path `C:\path\parent\mount`
(where parent directory or drive must exist, and mount must **not** exist,
and is not supported when [mounting as a network drive](#mounting-modes-on-windows)),
-and the last example will mount as network share `\\cloud\remote` and map it to an
-automatically assigned drive:
+and the last example will mount as network share `\\cloud\remote` and map it to
+an automatically assigned drive:
```console
rclone mount remote:path/to/files *
@@ -148,8 +149,8 @@ rclone mount remote:path/to/files X: --volname \\server\share
You may also specify the network share UNC path as the mountpoint itself. Then rclone
will automatically assign a drive letter, same as with `*` and use that as
-mountpoint, and instead use the UNC path specified as the volume name, as if it were
-specified with the `--volname` option. This will also implicitly set
+mountpoint, and instead use the UNC path specified as the volume name, as if it
+were specified with the `--volname` option. This will also implicitly set
the `--network-mode` option. This means the following two examples have same result:
```console
@@ -280,7 +281,7 @@ does not suffer from the same limitations.
Mounting on macOS can be done either via [built-in NFS server](/commands/rclone_serve_nfs/),
[macFUSE](https://osxfuse.github.io/) (also known as osxfuse) or
-[FUSE-T](https://www.fuse-t.org/).macFUSE is a traditional FUSE driver utilizing
+[FUSE-T](https://www.fuse-t.org/). macFUSE is a traditional FUSE driver utilizing
a macOS kernel extension (kext). FUSE-T is an alternative FUSE system which
"mounts" via an NFSv4 local server.
@@ -323,29 +324,30 @@ current as of FUSE-T version 1.0.14.
As per the [FUSE-T wiki](https://github.com/macos-fuse-t/fuse-t/wiki#caveats):
-> File access and modification times cannot be set separately as it seems to be an
-> issue with the NFS client which always modifies both. Can be reproduced with
-> 'touch -m' and 'touch -a' commands
+> File access and modification times cannot be set separately as it seems to be
+> an issue with the NFS client which always modifies both. Can be reproduced
+> with `touch -m` and `touch -a` commands
-This means that viewing files with various tools, notably macOS Finder, will cause
-rlcone to update the modification time of the file. This may make rclone upload a
-full new copy of the file.
+This means that viewing files with various tools, notably macOS Finder, will
+cause rlcone to update the modification time of the file. This may make rclone
+upload a full new copy of the file.
#### Read Only mounts
When mounting with `--read-only`, attempts to write to files will fail *silently*
as opposed to with a clear warning as in macFUSE.
-# Mounting on Linux
+## Mounting on Linux
On newer versions of Ubuntu, you may encounter the following error when running
`rclone mount`:
> NOTICE: mount helper error: fusermount3: mount failed: Permission denied
> CRITICAL: Fatal error: failed to mount FUSE fs: fusermount: exit status 1
+
This may be due to newer [Apparmor](https://wiki.ubuntu.com/AppArmor) restrictions,
-which can be disabled with `sudo aa-disable /usr/bin/fusermount3` (you may need to
-`sudo apt install apparmor-utils` beforehand).
+which can be disabled with `sudo aa-disable /usr/bin/fusermount3` (you may need
+to `sudo apt install apparmor-utils` beforehand).
## Limitations
@@ -1044,6 +1046,7 @@ rclone mount remote:path /path/to/mountpoint [flags]
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
diff --git a/docs/content/commands/rclone_nfsmount.md b/docs/content/commands/rclone_nfsmount.md
index 83b53ed49..c39f99146 100644
--- a/docs/content/commands/rclone_nfsmount.md
+++ b/docs/content/commands/rclone_nfsmount.md
@@ -14,7 +14,8 @@ Mount the remote as file system on a mountpoint.
Rclone nfsmount allows Linux, FreeBSD, macOS and Windows to
mount any of Rclone's cloud storage systems as a file system with FUSE.
-First set up your remote using `rclone config`. Check it works with `rclone ls` etc.
+First set up your remote using `rclone config`. Check it works with `rclone ls`
+etc.
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 `--daemon` flag
@@ -42,8 +43,8 @@ The following examples will mount to an automatically assigned drive,
to specific drive letter `X:`, to path `C:\path\parent\mount`
(where parent directory or drive must exist, and mount must **not** exist,
and is not supported when [mounting as a network drive](#mounting-modes-on-windows)),
-and the last example will mount as network share `\\cloud\remote` and map it to an
-automatically assigned drive:
+and the last example will mount as network share `\\cloud\remote` and map it to
+an automatically assigned drive:
```console
rclone nfsmount remote:path/to/files *
@@ -149,8 +150,8 @@ rclone nfsmount remote:path/to/files X: --volname \\server\share
You may also specify the network share UNC path as the mountpoint itself. Then rclone
will automatically assign a drive letter, same as with `*` and use that as
-mountpoint, and instead use the UNC path specified as the volume name, as if it were
-specified with the `--volname` option. This will also implicitly set
+mountpoint, and instead use the UNC path specified as the volume name, as if it
+were specified with the `--volname` option. This will also implicitly set
the `--network-mode` option. This means the following two examples have same result:
```console
@@ -281,7 +282,7 @@ does not suffer from the same limitations.
Mounting on macOS can be done either via [built-in NFS server](/commands/rclone_serve_nfs/),
[macFUSE](https://osxfuse.github.io/) (also known as osxfuse) or
-[FUSE-T](https://www.fuse-t.org/).macFUSE is a traditional FUSE driver utilizing
+[FUSE-T](https://www.fuse-t.org/). macFUSE is a traditional FUSE driver utilizing
a macOS kernel extension (kext). FUSE-T is an alternative FUSE system which
"mounts" via an NFSv4 local server.
@@ -324,29 +325,30 @@ current as of FUSE-T version 1.0.14.
As per the [FUSE-T wiki](https://github.com/macos-fuse-t/fuse-t/wiki#caveats):
-> File access and modification times cannot be set separately as it seems to be an
-> issue with the NFS client which always modifies both. Can be reproduced with
-> 'touch -m' and 'touch -a' commands
+> File access and modification times cannot be set separately as it seems to be
+> an issue with the NFS client which always modifies both. Can be reproduced
+> with `touch -m` and `touch -a` commands
-This means that viewing files with various tools, notably macOS Finder, will cause
-rlcone to update the modification time of the file. This may make rclone upload a
-full new copy of the file.
+This means that viewing files with various tools, notably macOS Finder, will
+cause rlcone to update the modification time of the file. This may make rclone
+upload a full new copy of the file.
#### Read Only mounts
When mounting with `--read-only`, attempts to write to files will fail *silently*
as opposed to with a clear warning as in macFUSE.
-# Mounting on Linux
+## Mounting on Linux
On newer versions of Ubuntu, you may encounter the following error when running
`rclone mount`:
> NOTICE: mount helper error: fusermount3: mount failed: Permission denied
> CRITICAL: Fatal error: failed to mount FUSE fs: fusermount: exit status 1
+
This may be due to newer [Apparmor](https://wiki.ubuntu.com/AppArmor) restrictions,
-which can be disabled with `sudo aa-disable /usr/bin/fusermount3` (you may need to
-`sudo apt install apparmor-utils` beforehand).
+which can be disabled with `sudo aa-disable /usr/bin/fusermount3` (you may need
+to `sudo apt install apparmor-utils` beforehand).
## Limitations
@@ -1050,6 +1052,7 @@ rclone nfsmount remote:path /path/to/mountpoint [flags]
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
diff --git a/docs/content/commands/rclone_rcd.md b/docs/content/commands/rclone_rcd.md
index ff0a83cbc..3146c6f75 100644
--- a/docs/content/commands/rclone_rcd.md
+++ b/docs/content/commands/rclone_rcd.md
@@ -53,6 +53,12 @@ identically.
`--rc-disable-zip` may be set to disable the zipping download option.
+### Protocol
+
+The server supports HTTP/1.1 and HTTP/2. HTTP/2 is used automatically
+for TLS connections. For non-TLS connections, HTTP/2 cleartext (h2c)
+is supported, allowing HTTP/2 without encryption.
+
### TLS (SSL)
By default this will serve over http. If you want you can serve over
diff --git a/docs/content/commands/rclone_serve_dlna.md b/docs/content/commands/rclone_serve_dlna.md
index 54873a53f..4357aacd7 100644
--- a/docs/content/commands/rclone_serve_dlna.md
+++ b/docs/content/commands/rclone_serve_dlna.md
@@ -560,6 +560,7 @@ rclone serve dlna remote:path [flags]
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
diff --git a/docs/content/commands/rclone_serve_docker.md b/docs/content/commands/rclone_serve_docker.md
index c0edbea83..1156ff1ca 100644
--- a/docs/content/commands/rclone_serve_docker.md
+++ b/docs/content/commands/rclone_serve_docker.md
@@ -592,6 +592,7 @@ rclone serve docker [flags]
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
diff --git a/docs/content/commands/rclone_serve_ftp.md b/docs/content/commands/rclone_serve_ftp.md
index 4f2197426..4fbced926 100644
--- a/docs/content/commands/rclone_serve_ftp.md
+++ b/docs/content/commands/rclone_serve_ftp.md
@@ -639,6 +639,7 @@ rclone serve ftp remote:path [flags]
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
diff --git a/docs/content/commands/rclone_serve_http.md b/docs/content/commands/rclone_serve_http.md
index 7d31e05ed..1742384bc 100644
--- a/docs/content/commands/rclone_serve_http.md
+++ b/docs/content/commands/rclone_serve_http.md
@@ -55,6 +55,12 @@ identically.
`--disable-zip` may be set to disable the zipping download option.
+### Protocol
+
+The server supports HTTP/1.1 and HTTP/2. HTTP/2 is used automatically
+for TLS connections. For non-TLS connections, HTTP/2 cleartext (h2c)
+is supported, allowing HTTP/2 without encryption.
+
### TLS (SSL)
By default this will serve over http. If you want you can serve over
@@ -778,6 +784,7 @@ rclone serve http remote:path [flags]
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
diff --git a/docs/content/commands/rclone_serve_nfs.md b/docs/content/commands/rclone_serve_nfs.md
index a3930cde0..26834e9c1 100644
--- a/docs/content/commands/rclone_serve_nfs.md
+++ b/docs/content/commands/rclone_serve_nfs.md
@@ -611,6 +611,7 @@ rclone serve nfs remote:path [flags]
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
diff --git a/docs/content/commands/rclone_serve_restic.md b/docs/content/commands/rclone_serve_restic.md
index 9815773b3..d297af0b0 100644
--- a/docs/content/commands/rclone_serve_restic.md
+++ b/docs/content/commands/rclone_serve_restic.md
@@ -132,6 +132,12 @@ identically.
`--disable-zip` may be set to disable the zipping download option.
+### Protocol
+
+The server supports HTTP/1.1 and HTTP/2. HTTP/2 is used automatically
+for TLS connections. For non-TLS connections, HTTP/2 cleartext (h2c)
+is supported, allowing HTTP/2 without encryption.
+
### TLS (SSL)
By default this will serve over http. If you want you can serve over
diff --git a/docs/content/commands/rclone_serve_s3.md b/docs/content/commands/rclone_serve_s3.md
index 1e8722114..712c16496 100644
--- a/docs/content/commands/rclone_serve_s3.md
+++ b/docs/content/commands/rclone_serve_s3.md
@@ -234,6 +234,12 @@ identically.
`--disable-zip` may be set to disable the zipping download option.
+### Protocol
+
+The server supports HTTP/1.1 and HTTP/2. HTTP/2 is used automatically
+for TLS connections. For non-TLS connections, HTTP/2 cleartext (h2c)
+is supported, allowing HTTP/2 without encryption.
+
### TLS (SSL)
By default this will serve over http. If you want you can serve over
@@ -808,6 +814,7 @@ rclone serve s3 remote:path [flags]
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
diff --git a/docs/content/commands/rclone_serve_sftp.md b/docs/content/commands/rclone_serve_sftp.md
index 60299de99..3ce3f612e 100644
--- a/docs/content/commands/rclone_serve_sftp.md
+++ b/docs/content/commands/rclone_serve_sftp.md
@@ -686,6 +686,7 @@ rclone serve sftp remote:path [flags]
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
diff --git a/docs/content/commands/rclone_serve_webdav.md b/docs/content/commands/rclone_serve_webdav.md
index c16133434..c35001bb0 100644
--- a/docs/content/commands/rclone_serve_webdav.md
+++ b/docs/content/commands/rclone_serve_webdav.md
@@ -79,6 +79,19 @@ rclone --webdav-unix-socket /tmp/my.socket --webdav-url http://localhost lsf :we
Note that there is no authentication on http protocol - this is expected to be
done by the permissions on the socket.
+## Symlinks / Junction points
+
+The webdav protocol does not support symlinks or junction points and
+by default rclone will skip them completely.
+
+You can use `-L` to get rclone to follow symlinks or you can
+use `--local-links` to make rclone show `.rclonelink`
+files in place of the symlinks.
+
+**NB** Do not use `--links` as since v1.69 this applies to
+the VFS layer too, use `--local-links` which only applies to
+the local backend only.
+
## Server options
Use `--addr` to specify which IP address and port the server should
@@ -112,6 +125,12 @@ identically.
`--disable-zip` may be set to disable the zipping download option.
+### Protocol
+
+The server supports HTTP/1.1 and HTTP/2. HTTP/2 is used automatically
+for TLS connections. For non-TLS connections, HTTP/2 cleartext (h2c)
+is supported, allowing HTTP/2 without encryption.
+
### TLS (SSL)
By default this will serve over http. If you want you can serve over
@@ -837,6 +856,7 @@ rclone serve webdav remote:path [flags]
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a '.rclonelink' extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
diff --git a/docs/content/commands/rclone_touch.md b/docs/content/commands/rclone_touch.md
index afbd9b1fc..56114f411 100644
--- a/docs/content/commands/rclone_touch.md
+++ b/docs/content/commands/rclone_touch.md
@@ -31,6 +31,10 @@ time instead of the current time. Times may be specified as one of:
Note that value of `--timestamp` is in UTC. If you want local time
then add the `--localtime` flag.
+Metadata can be added when creating a new file with `--metadata-set`.
+For example:
+ rclone touch remote:path -M --metadata-set key=value
+
```
rclone touch remote:path [flags]
```
diff --git a/docs/content/filelu.md b/docs/content/filelu.md
index 4e66e758e..d9ee416bc 100644
--- a/docs/content/filelu.md
+++ b/docs/content/filelu.md
@@ -219,6 +219,28 @@ Properties:
Here are the Advanced options specific to filelu (FileLu Cloud Storage).
+#### --filelu-upload-cutoff
+
+Cutoff for switching to chunked upload. Any files larger than this will be uploaded in chunks of chunk_size.
+
+Properties:
+
+- Config: upload_cutoff
+- Env Var: RCLONE_FILELU_UPLOAD_CUTOFF
+- Type: SizeSuffix
+- Default: 500Mi
+
+#### --filelu-chunk-size
+
+Chunk size to use for uploading. Used for multipart uploads.
+
+Properties:
+
+- Config: chunk_size
+- Env Var: RCLONE_FILELU_CHUNK_SIZE
+- Type: SizeSuffix
+- Default: 64Mi
+
#### --filelu-encoding
The encoding for the backend.
diff --git a/docs/content/filen.md b/docs/content/filen.md
index 5513ed1c8..e08579097 100644
--- a/docs/content/filen.md
+++ b/docs/content/filen.md
@@ -124,7 +124,7 @@ Properties:
#### --filen-api-key
-API Key for your Filen account
+API Key for your Filen account
Get this using the Filen CLI export-api-key command
You can download the Filen CLI from https://github.com/FilenCloudDienste/filen-cli
diff --git a/docs/content/flags.md b/docs/content/flags.md
index d7bb0af9b..c5a31ecfc 100644
--- a/docs/content/flags.md
+++ b/docs/content/flags.md
@@ -121,7 +121,7 @@ Flags for general networking and HTTP stuff.
--tpslimit float Limit HTTP transactions per second to this
--tpslimit-burst int Max burst of transactions for --tpslimit (default 1)
--use-cookies Enable session cookiejar
- --user-agent string Set the user-agent to a specified string (default "rclone/v1.73.0")
+ --user-agent string Set the user-agent to a specified string (default "rclone/v1.74.0")
```
@@ -174,7 +174,7 @@ Flags for developers.
```
--cpuprofile string Write cpu profile to file
- --dump DumpFlags List of items to dump from: headers, bodies, requests, responses, auth, filters, goroutines, openfiles, mapper
+ --dump DumpFlags List of items to dump from: headers, bodies, requests, responses, auth, filters, goroutines, openfiles, mapper, curl
--dump-bodies Dump HTTP headers and bodies - may contain sensitive info
--dump-headers Dump HTTP headers - may contain sensitive info
--memprofile string Write memory profile to file
@@ -355,6 +355,8 @@ Backend-only flags (these can be set in the config file also).
--azureblob-connection-string string Storage Connection String
--azureblob-copy-concurrency int Concurrency for multipart copy (default 512)
--azureblob-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 8Mi)
+ --azureblob-copy-total-concurrency int Global concurrency limit for multipart copy chunks
+ --azureblob-decompress If set this will decompress gzip encoded objects
--azureblob-delete-snapshots string Set to specify how to deal with snapshots on blob deletion
--azureblob-description string Description of the remote
--azureblob-directory-markers Upload an empty object with a trailing slash when a new directory is created
@@ -605,9 +607,11 @@ Backend-only flags (these can be set in the config file also).
--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
+ --filelu-chunk-size SizeSuffix Chunk size to use for uploading. Used for multipart uploads (default 64Mi)
--filelu-description string Description of the remote
--filelu-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,Colon,Question,Asterisk,Pipe,Hash,Percent,BackSlash,CrLf,Del,Ctl,LeftSpace,LeftPeriod,LeftTilde,LeftCrLfHtVt,RightSpace,RightPeriod,RightCrLfHtVt,InvalidUtf8,Dot,SquareBracket,Semicolon,Exclamation)
--filelu-key string Your FileLu Rclone key from My Account
+ --filelu-upload-cutoff SizeSuffix Cutoff for switching to chunked upload. Any files larger than this will be uploaded in chunks of chunk_size (default 500Mi)
--filen-api-key string API Key for your Filen account (obscured)
--filen-auth-version string Authentication Version (internal use only)
--filen-base-folder-uuid string UUID of Account Root Directory (internal use only)
@@ -728,11 +732,24 @@ Backend-only flags (these can be set in the config file also).
--http-no-head Don't use HEAD requests
--http-no-slash Set this if the site doesn't end directories with /
--http-url string URL of HTTP host to connect to
+ --huaweidrive-auth-url string Auth server URL
+ --huaweidrive-chunk-size SizeSuffix Upload chunk size (default 8Mi)
+ --huaweidrive-client-credentials Use client credentials OAuth flow
+ --huaweidrive-client-id string OAuth Client Id
+ --huaweidrive-client-secret string OAuth Client Secret
+ --huaweidrive-description string Description of the remote
+ --huaweidrive-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftSpace,LeftPeriod,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot)
+ --huaweidrive-list-chunk int Size of listing chunk 1-1000 (default 1000)
+ --huaweidrive-root-folder-id string ID of the root folder
+ --huaweidrive-token string OAuth Access Token as a JSON blob
+ --huaweidrive-token-url string Token server url
+ --huaweidrive-upload-cutoff SizeSuffix Cutoff for switching to resumable upload (default 20Mi)
--iclouddrive-apple-id string Apple ID
- --iclouddrive-client-id string Client id (default "d39ba9916b7251055b22c7f910e2ea796ee65e98b2ddecea8f5dde8d9d1a815d")
+ --iclouddrive-client-id string Client ID for iCloud API access (default "d39ba9916b7251055b22c7f910e2ea796ee65e98b2ddecea8f5dde8d9d1a815d")
--iclouddrive-description string Description of the remote
--iclouddrive-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
--iclouddrive-password string Password (obscured)
+ --iclouddrive-service string iCloud service to use (default "drive")
--imagekit-description string Description of the remote
--imagekit-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Dollar,Question,Hash,Percent,BackSlash,Del,Ctl,InvalidUtf8,Dot,SquareBracket)
--imagekit-endpoint string You can find your ImageKit.io URL endpoint in your [dashboard](https://imagekit.io/dashboard/developer/api-keys)
@@ -751,17 +768,20 @@ Backend-only flags (these can be set in the config file also).
--internetarchive-item-metadata stringArray Metadata to be set on the IA item, this is different from file-level metadata that can be set using --metadata-set
--internetarchive-secret-access-key string IAS3 Secret Key (password)
--internetarchive-wait-archive Duration Timeout for waiting the server's processing tasks (specifically archive and book_op) to finish (default 0s)
+ --internxt-chunk-size SizeSuffix Chunk size for multipart uploads (default 30Mi)
--internxt-description string Description of the remote
--internxt-email string Email of your Internxt account
--internxt-encoding Encoding The encoding for the backend (default Slash,BackSlash,CrLf,RightPeriod,InvalidUtf8,Dot)
--internxt-pass string Password (obscured)
--internxt-skip-hash-validation Skip hash validation when downloading files (default true)
+ --internxt-upload-concurrency int Concurrency for multipart uploads (default 4)
+ --internxt-upload-cutoff SizeSuffix Cutoff for switching to multipart upload (default 100Mi)
--jottacloud-auth-url string Auth server URL
--jottacloud-client-credentials Use client credentials OAuth flow
--jottacloud-client-id string OAuth Client Id
--jottacloud-client-secret string OAuth Client Secret
--jottacloud-description string Description of the remote
- --jottacloud-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot)
+ --jottacloud-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Percent,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
@@ -778,6 +798,8 @@ Backend-only flags (these can be set in the config file also).
--koofr-setmtime Does the backend support setting modification time (default true)
--koofr-user string Your user name
--linkbox-description string Description of the remote
+ --linkbox-email string Email for login
+ --linkbox-password string Password for login (obscured)
--linkbox-token string Token from https://www.linkbox.to/admin/account
--local-case-insensitive Force the filesystem to report itself as case insensitive
--local-case-sensitive Force the filesystem to report itself as case sensitive
@@ -923,7 +945,7 @@ Backend-only flags (these can be set in the config file also).
--premiumizeme-token string OAuth Access Token as a JSON blob
--premiumizeme-token-url string Token server url
--protondrive-2fa string The 2FA code
- --protondrive-app-version string The app version string (default "[email protected]+rclone")
+ --protondrive-app-version string The app version string
--protondrive-description string Description of the remote
--protondrive-enable-caching Caches the files and folders metadata to reduce API calls (default true)
--protondrive-encoding Encoding The encoding for the backend (default Slash,LeftSpace,RightSpace,InvalidUtf8,Dot)
@@ -964,6 +986,8 @@ Backend-only flags (these can be set in the config file also).
--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-bucket-object-lock-enabled Enable Object Lock when creating new buckets
+ --s3-bypass-governance-retention Allow deleting or modifying objects locked with GOVERNANCE mode
--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
@@ -978,11 +1002,13 @@ Backend-only flags (these can be set in the config file also).
--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-ibm-api-key string IBM API Key to be used to obtain IAM token
+ --s3-ibm-iam-endpoint string IBM IAM Endpoint to use for authentication
--s3-ibm-resource-instance-id string IBM service instance id
--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-list-versions-oldest-first Tristate Set if the backend returns object versions oldest first (default unset)
--s3-location-constraint string Location constraint - must be set to match the Region
--s3-max-upload-parts int Maximum number of parts in a multipart upload (default 10000)
--s3-might-gzip Tristate Set this if the backend might gzip objects (default unset)
@@ -990,6 +1016,11 @@ Backend-only flags (these can be set in the config file also).
--s3-no-head If set, don'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-object-lock-legal-hold-status string Object Lock legal hold status to apply when uploading or copying objects
+ --s3-object-lock-mode string Object Lock mode to apply when uploading or copying objects
+ --s3-object-lock-retain-until-date string Object Lock retention until date to apply when uploading or copying objects
+ --s3-object-lock-set-after-upload Set Object Lock via separate API calls after upload
+ --s3-object-lock-supported Tristate Whether the provider supports S3 Object Lock (default unset)
--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
diff --git a/docs/content/huaweidrive.md b/docs/content/huaweidrive.md
index 6337e495a..a36d98b9a 100644
--- a/docs/content/huaweidrive.md
+++ b/docs/content/huaweidrive.md
@@ -216,7 +216,6 @@ To view your current quota you can use the `rclone about remote:`
command which will display your usage and quota information.
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/huaweidrive/huaweidrive.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
-
### Standard options
Here are the Standard options specific to huaweidrive (Huawei Drive).
@@ -288,6 +287,21 @@ Properties:
- Type: string
- Required: false
+#### --huaweidrive-client-credentials
+
+Use client credentials OAuth flow.
+
+This will use the OAUTH2 client Credentials Flow as described in RFC 6749.
+
+Note that this option is NOT supported by all backends.
+
+Properties:
+
+- Config: client_credentials
+- Env Var: RCLONE_HUAWEIDRIVE_CLIENT_CREDENTIALS
+- Type: bool
+- Default: false
+
#### --huaweidrive-root-folder-id
ID of the root folder.
@@ -295,8 +309,7 @@ ID of the root folder.
Normally this is auto-detected, but if it fails or you want to speed up startup,
you can set it manually.
-Leave blank normally. Rclone will print the detected root folder ID in debug output
-which you can then save to the config.
+Leave blank normally.
Properties:
@@ -331,7 +344,7 @@ Properties:
#### --huaweidrive-upload-cutoff
-Cutoff for switching to multipart upload.
+Cutoff for switching to resumable upload.
Any files larger than this will be uploaded using resumable upload.
The minimum is 0 and the maximum is 20 MiB (Huawei Drive API limit for single request uploads).
@@ -354,7 +367,49 @@ Properties:
- Config: encoding
- Env Var: RCLONE_HUAWEIDRIVE_ENCODING
- Type: Encoding
-- Default: BackSlash,InvalidUtf8,RightSpace
+- Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftSpace,LeftPeriod,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot
+
+#### --huaweidrive-description
+
+Description of the remote.
+
+Properties:
+
+- Config: description
+- Env Var: RCLONE_HUAWEIDRIVE_DESCRIPTION
+- Type: string
+- Required: false
+
+### Metadata
+
+Huawei Drive supports reading and writing custom metadata.
+
+User metadata can be set using the "properties" field in the API.
+System metadata includes standard file information such as:
+- content-type: MIME type of the object
+- description: User-provided description
+- favorite: Whether file is marked as favorite
+- btime/mtime/utime: Various timestamps
+- sha256: File hash
+- recycled/has-thumbnail: File status flags
+
+Custom metadata keys can be any string and will be stored in the file's properties.
+
+Here are the possible system metadata items for the huaweidrive backend.
+
+| Name | Help | Type | Example | Read Only |
+|------|------|------|---------|-----------|
+| btime | Time when the file was created (RFC 3339) | RFC 3339 | | **Y** |
+| content-type | MIME type of the object | string | | **Y** |
+| description | Description of the file | string | | N |
+| favorite | Whether the file is marked as favorite (true/false) | string | | N |
+| has-thumbnail | Whether the file has a thumbnail (true/false) | string | | **Y** |
+| mtime | Time when the file content was last modified (RFC 3339) | RFC 3339 | | **Y** |
+| recycled | Whether the file is in recycle bin (true/false) | string | | **Y** |
+| sha256 | SHA256 hash of the file | string | | **Y** |
+| utime | Time when the file was last edited by the current user (RFC 3339) | RFC 3339 | | **Y** |
+
+See the [metadata](/docs/#metadata) docs for more info.
<!-- autogenerated options stop -->
diff --git a/docs/content/iclouddrive.md b/docs/content/iclouddrive.md
index d3675511d..07fa5da40 100644
--- a/docs/content/iclouddrive.md
+++ b/docs/content/iclouddrive.md
@@ -232,7 +232,23 @@ If the remote still has stale auth state, clear the `cookies` and
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/iclouddrive/iclouddrive.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options
-Here are the Standard options specific to iclouddrive (iCloud Drive).
+Here are the Standard options specific to iclouddrive (iCloud Drive and Photos).
+
+#### --iclouddrive-service
+
+iCloud service to use.
+
+Properties:
+
+- Config: service
+- Env Var: RCLONE_ICLOUDDRIVE_SERVICE
+- Type: string
+- Default: "drive"
+- Examples:
+ - "drive"
+ - iCloud Drive
+ - "photos"
+ - iCloud Photos
#### --iclouddrive-apple-id
@@ -260,7 +276,7 @@ Properties:
#### --iclouddrive-trust-token
-Trust token (internal use)
+Trust token for session authentication.
Properties:
@@ -271,7 +287,7 @@ Properties:
#### --iclouddrive-cookies
-cookies (internal use only)
+Session cookies.
Properties:
@@ -282,11 +298,11 @@ Properties:
### Advanced options
-Here are the Advanced options specific to iclouddrive (iCloud Drive).
+Here are the Advanced options specific to iclouddrive (iCloud Drive and Photos).
#### --iclouddrive-client-id
-Client id
+Client ID for iCloud API access.
Properties:
@@ -319,4 +335,20 @@ Properties:
- Type: string
- Required: false
+### Metadata
+
+Metadata is read-only and available for the Photos service only.
+
+Here are the possible system metadata items for the iclouddrive backend.
+
+| Name | Help | Type | Example | Read Only |
+|------|------|------|---------|-----------|
+| added-time | Time the item was added to the iCloud library | RFC 3339 | 2006-01-02T15:04:05Z | **Y** |
+| favorite | Whether the item is marked as favorite | bool | | **Y** |
+| height | Image height in pixels | int | | **Y** |
+| hidden | Whether the item is hidden | bool | | **Y** |
+| width | Image width in pixels | int | | **Y** |
+
+See the [metadata](/docs/#metadata) docs for more info.
+
<!-- autogenerated options stop -->
diff --git a/docs/content/internxt.md b/docs/content/internxt.md
index 73b082878..84d3da17e 100644
--- a/docs/content/internxt.md
+++ b/docs/content/internxt.md
@@ -161,6 +161,50 @@ Properties:
- Type: bool
- Default: true
+#### --internxt-upload-concurrency
+
+Concurrency for multipart uploads.
+
+This is the number of chunks of the same file that are uploaded concurrently.
+
+Note that each chunk is buffered in memory.
+
+Properties:
+
+- Config: upload_concurrency
+- Env Var: RCLONE_INTERNXT_UPLOAD_CONCURRENCY
+- Type: int
+- Default: 4
+
+#### --internxt-upload-cutoff
+
+Cutoff for switching to multipart upload.
+
+Any files larger than this will be uploaded in chunks of chunk_size.
+The minimum is 100 MiB and the maximum is 5 GiB.
+
+Properties:
+
+- Config: upload_cutoff
+- Env Var: RCLONE_INTERNXT_UPLOAD_CUTOFF
+- Type: SizeSuffix
+- Default: 100Mi
+
+#### --internxt-chunk-size
+
+Chunk size for multipart uploads.
+
+Files larger than upload_cutoff will be uploaded in chunks of this size.
+
+Memory usage is approximately chunk_size * upload_concurrency.
+
+Properties:
+
+- Config: chunk_size
+- Env Var: RCLONE_INTERNXT_CHUNK_SIZE
+- Type: SizeSuffix
+- Default: 30Mi
+
#### --internxt-encoding
The encoding for the backend.
diff --git a/docs/content/jottacloud.md b/docs/content/jottacloud.md
index d6349fd8b..5a62a7158 100644
--- a/docs/content/jottacloud.md
+++ b/docs/content/jottacloud.md
@@ -555,7 +555,7 @@ Properties:
- Config: encoding
- Env Var: RCLONE_JOTTACLOUD_ENCODING
- Type: Encoding
-- Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot
+- Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Percent,Del,Ctl,InvalidUtf8,Dot
#### --jottacloud-description
diff --git a/docs/content/linkbox.md b/docs/content/linkbox.md
index ea2947e70..127f2e8ea 100644
--- a/docs/content/linkbox.md
+++ b/docs/content/linkbox.md
@@ -93,6 +93,41 @@ Properties:
- Type: string
- Required: true
+#### --linkbox-email
+
+Email for login
+
+Properties:
+
+- Config: email
+- Env Var: RCLONE_LINKBOX_EMAIL
+- Type: string
+- Required: true
+
+#### --linkbox-password
+
+Password for login
+
+**NB** Input to this must be obscured - see [rclone obscure](/commands/rclone_obscure/).
+
+Properties:
+
+- Config: password
+- Env Var: RCLONE_LINKBOX_PASSWORD
+- Type: string
+- Required: true
+
+#### --linkbox-web-token
+
+Web API login token - set automatically.
+
+Properties:
+
+- Config: web_token
+- Env Var: RCLONE_LINKBOX_WEB_TOKEN
+- Type: string
+- Required: false
+
### Advanced options
Here are the Advanced options specific to linkbox (Linkbox).
diff --git a/docs/content/pikpak.md b/docs/content/pikpak.md
index e43219806..bb374c9d8 100644
--- a/docs/content/pikpak.md
+++ b/docs/content/pikpak.md
@@ -317,15 +317,20 @@ rclone backend addurl remote: [options] [<arguments>+]
This command adds offline download task for url.
-Usage example:
+Usage examples:
```console
rclone backend addurl pikpak:dirpath url
+rclone backend addurl pikpak:dirpath url -o name=custom_filename.zip
```
Downloads will be stored in 'dirpath'. If 'dirpath' is invalid,
download will fallback to default 'My Pack' folder.
+Options:
+
+- "name": Custom filename for the downloaded file.
+
### decompress
Request decompress of a file/files in a folder.
diff --git a/docs/content/protondrive.md b/docs/content/protondrive.md
index 0a7b182cc..08aa33041 100644
--- a/docs/content/protondrive.md
+++ b/docs/content/protondrive.md
@@ -296,16 +296,18 @@ Properties:
The app version string
-The app version string indicates the client that is currently performing
-the API request. This information is required and will be sent with every
-API request.
+ The app version string identifies the client that is currently performing
+ the API request. Third-party Proton Drive integrations should use the form
+ external-drive-<project>@<version>. If this option is left empty, rclone
+ derives a compliant value from its own version. This value is sent with
+ every API request; the option itself is optional.
Properties:
- Config: app_version
- Env Var: RCLONE_PROTONDRIVE_APP_VERSION
- Type: string
-- Default: "[email protected]+rclone"
+- Required: false
#### --protondrive-replace-existing-draft
diff --git a/docs/content/rc.md b/docs/content/rc.md
index 2e47b13ec..1466a63bd 100644
--- a/docs/content/rc.md
+++ b/docs/content/rc.md
@@ -643,8 +643,6 @@ Note that arguments must be preceded by the "-a" flag
See the [backend](/commands/rclone_backend/) command for more information.
-**Authentication is required for this call.**
-
### cache/expire: Purge a remote from cache {#cache-expire}
Purge a remote from the cache backend. Supports either a directory or a file.
@@ -688,6 +686,8 @@ is used on top of the cache.
Show statistics for the cache remote.
+**Authentication is not required for this call.**
+
### config/create: create the config for a remote. {#config-create}
This takes the following parameters:
@@ -708,8 +708,6 @@ This takes the following parameters:
See the [config create](/commands/rclone_config_create/) command for more information on the above.
-**Authentication is required for this call.**
-
### config/delete: Delete a remote in the config file. {#config-delete}
Parameters:
@@ -718,8 +716,6 @@ Parameters:
See the [config delete](/commands/rclone_config_delete/) command for more information on the above.
-**Authentication is required for this call.**
-
### config/dump: Dumps the config file. {#config-dump}
Returns a JSON object:
@@ -729,8 +725,6 @@ Where keys are remote names and values are the config parameters.
See the [config dump](/commands/rclone_config_dump/) command for more information on the above.
-**Authentication is required for this call.**
-
### config/get: Get a remote in the config file. {#config-get}
Parameters:
@@ -739,8 +733,6 @@ Parameters:
See the [config dump](/commands/rclone_config_dump/) command for more information on the above.
-**Authentication is required for this call.**
-
### config/listremotes: Lists the remotes in the config file and defined in environment variables. {#config-listremotes}
Returns
@@ -748,8 +740,6 @@ Returns
See the [listremotes](/commands/rclone_listremotes/) command for more information on the above.
-**Authentication is required for this call.**
-
### config/password: password the config for a remote. {#config-password}
This takes the following parameters:
@@ -760,8 +750,6 @@ This takes the following parameters:
See the [config password](/commands/rclone_config_password/) command for more information on the above.
-**Authentication is required for this call.**
-
### config/paths: Reads the config file path and other important paths. {#config-paths}
Returns a JSON object with the following keys:
@@ -780,8 +768,6 @@ Eg
See the [config paths](/commands/rclone_config_paths/) command for more information on the above.
-**Authentication is required for this call.**
-
### config/providers: Shows how providers are configured in the config file. {#config-providers}
Returns a JSON object:
@@ -794,16 +780,12 @@ Note that the Options blocks are in the same format as returned by
"options/info". They are described in the
[option blocks](#option-blocks) section.
-**Authentication is required for this call.**
-
### config/setpath: Set the path of the config file {#config-setpath}
Parameters:
- path - path to the config file to use
-**Authentication is required for this call.**
-
### config/unlock: Unlock the config file. {#config-unlock}
Unlocks the config file if it is locked.
@@ -814,8 +796,6 @@ Parameters:
A good idea is to disable AskPassword before making this call
-**Authentication is required for this call.**
-
### config/update: update the config for a remote. {#config-update}
This takes the following parameters:
@@ -835,8 +815,6 @@ This takes the following parameters:
See the [config update](/commands/rclone_config_update/) command for more information on the above.
-**Authentication is required for this call.**
-
### core/bwlimit: Set the bandwidth limit. {#core-bwlimit}
This sets the bandwidth limit to the string passed in. This should be
@@ -923,7 +901,20 @@ OR
```
-**Authentication is required for this call.**
+### core/disks: List the local disks {#core-disks}
+
+This does not take any parameters
+
+This call is for rclone GUI programs to enumerate local disks and
+important directories for doing transfers to and from. The list
+returned will include the root directory and the user's home directory
+and any mounted disks. The returned items should be usable directly as
+remotes.
+
+Returns:
+
+- disks
+ - This is an array of strings of local disk names
### core/du: Returns disk usage of a locally attached disk. {#core-du}
@@ -947,6 +938,8 @@ Returns:
}
```
+**Authentication is not required for this call.**
+
### core/gc: Runs a garbage collection. {#core-gc}
This tells the go runtime to do a garbage collection run. It isn't
@@ -969,6 +962,8 @@ Returns the following values:
}
```
+**Authentication is not required for this call.**
+
### core/memstats: Returns the memory statistics {#core-memstats}
This returns the memory statistics of the running program. What the values mean
@@ -1019,6 +1014,7 @@ Returns the following values:
{
"bytes": total transferred bytes since the start of the group,
"checks": number of files checked,
+ "deletedDirs": number of directories deleted,
"deletes" : number of files deleted,
"elapsedTime": time in floating point seconds since rclone was started,
"errors": number of errors,
@@ -1057,6 +1053,8 @@ Returns the following values:
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.
+**Authentication is not required for this call.**
+
### core/stats-delete: Delete stats group. {#core-stats-delete}
This deletes entire stats group.
@@ -1108,6 +1106,8 @@ Returns the following values:
}
```
+**Authentication is not required for this call.**
+
### core/version: Shows the current version of rclone, Go and the OS. {#core-version}
This shows the current versions of rclone, Go and the OS:
@@ -1125,6 +1125,8 @@ This shows the current versions of rclone, Go and the OS:
- linking - type of rclone executable (static or dynamic)
- goTags - space separated build tags or "none"
+**Authentication is not required for this call.**
+
### debug/set-block-profile-rate: Set runtime.SetBlockProfileRate for blocking profiling. {#debug-set-block-profile-rate}
SetBlockProfileRate controls the fraction of goroutine blocking events
@@ -1220,8 +1222,6 @@ 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.
-**Authentication is required for this call.**
-
### fscache/entries: Returns the number of entries in the fs cache. {#fscache-entries}
This returns the number of entries in the fs cache.
@@ -1229,8 +1229,6 @@ This returns the number of entries in the fs cache.
Returns
- entries - number of items in the cache
-**Authentication is required for this call.**
-
### job/batch: Run a batch of rclone rc commands concurrently. {#job-batch}
This takes the following parameters:
@@ -1290,8 +1288,6 @@ Gives the result:
}
```
-**Authentication is required for this call.**
-
### job/list: Lists the IDs of the running jobs {#job-list}
Parameters: None.
@@ -1303,6 +1299,8 @@ Results:
- runningIds - array of integer job ids that are running
- finishedIds - array of integer job ids that are finished
+**Authentication is not required for this call.**
+
### job/status: Reads the status of the job ID {#job-status}
Parameters:
@@ -1323,6 +1321,8 @@ Results:
- output - output of the job as would have been returned if called synchronously
- progress - output of the progress related to the underlying job
+**Authentication is not required for this call.**
+
### job/stop: Stop the running job {#job-stop}
Parameters:
@@ -1347,8 +1347,6 @@ Eg
rclone rc mount/listmounts
-**Authentication is required for this call.**
-
### mount/mount: Create a new mount point {#mount-mount}
rclone allows Linux, FreeBSD, macOS and Windows to mount any of
@@ -1364,12 +1362,24 @@ This takes the following parameters:
- mountOpt: a JSON object with Mount options in.
- vfsOpt: a JSON object with VFS options in.
+On Windows mountPoint may be set to "*" to assign the next available
+drive letter automatically, or a network share UNC path (e.g.
+"\\server\share") to mount as a network drive. In these cases the
+actual drive letter is chosen at mount time.
+
+This returns the following values:
+
+- mountPoint: the actual mount point that was used (this may differ
+ from the input, e.g. on Windows when "*" is passed the allocated
+ drive letter is returned)
+
Example:
```console
rclone rc mount/mount fs=mydrive: mountPoint=/home/<user>/mountPoint
rclone rc mount/mount fs=mydrive: mountPoint=/home/<user>/mountPoint mountType=mount
rclone rc mount/mount fs=TestDrive: mountPoint=/mnt/tmp vfsOpt='{"CacheMode": 2}' mountOpt='{"AllowOther": true}'
+rclone rc mount/mount fs=mydrive: mountPoint=* mountType=cmount
```
The vfsOpt are as described in options/get and can be seen in the
@@ -1379,8 +1389,6 @@ The vfsOpt are as described in options/get and can be seen in the
rclone rc options/get
```
-**Authentication is required for this call.**
-
### mount/types: Show all possible mount types {#mount-types}
This shows all possible mount types and returns them as a list.
@@ -1396,8 +1404,6 @@ Eg
rclone rc mount/types
-**Authentication is required for this call.**
-
### mount/unmount: Unmount selected active mount {#mount-unmount}
rclone allows Linux, FreeBSD, macOS and Windows to
@@ -1412,8 +1418,6 @@ Example:
rclone rc mount/unmount mountPoint=/home/<user>/mountPoint
-**Authentication is required for this call.**
-
### mount/unmountall: Unmount all active mounts {#mount-unmountall}
rclone allows Linux, FreeBSD, macOS and Windows to
@@ -1426,8 +1430,6 @@ Eg
rclone rc mount/unmountall
-**Authentication is required for this call.**
-
### operations/about: Return the space used on the remote {#operations-about}
This takes the following parameters:
@@ -1438,8 +1440,6 @@ The result is as returned from rclone about --json
See the [about](/commands/rclone_about/) command for more information on the above.
-**Authentication is required for this call.**
-
### operations/check: check the source and destination are the same {#operations-check}
Checks the files in the source and destination match. It compares
@@ -1488,8 +1488,6 @@ Returns:
- differ - array of strings of all non-matching files
- error - array of strings of all files with errors (hashing or reading)
-**Authentication is required for this call.**
-
### operations/cleanup: Remove trashed files in the remote or path {#operations-cleanup}
This takes the following parameters:
@@ -1498,8 +1496,6 @@ This takes the following parameters:
See the [cleanup](/commands/rclone_cleanup/) command for more information on the above.
-**Authentication is required for this call.**
-
### operations/copyfile: Copy a file from source remote to destination remote {#operations-copyfile}
This takes the following parameters:
@@ -1509,8 +1505,6 @@ This takes the following parameters:
- dstFs - a remote name string e.g. "drive2:" for the destination, "/" for local filesystem
- dstRemote - a path within that remote e.g. "file2.txt" for the destination
-**Authentication is required for this call.**
-
### operations/copyurl: Copy the URL to the object {#operations-copyurl}
This takes the following parameters:
@@ -1522,8 +1516,6 @@ This takes the following parameters:
See the [copyurl](/commands/rclone_copyurl/) command for more information on the above.
-**Authentication is required for this call.**
-
### operations/delete: Remove files in the path {#operations-delete}
This takes the following parameters:
@@ -1532,8 +1524,6 @@ This takes the following parameters:
See the [delete](/commands/rclone_delete/) command for more information on the above.
-**Authentication is required for this call.**
-
### operations/deletefile: Remove the single file pointed to {#operations-deletefile}
This takes the following parameters:
@@ -1543,8 +1533,6 @@ This takes the following parameters:
See the [deletefile](/commands/rclone_deletefile/) command for more information on the above.
-**Authentication is required for this call.**
-
### operations/fsinfo: Return information about the remote {#operations-fsinfo}
This takes the following parameters:
@@ -1701,8 +1689,6 @@ Example:
See the [hashsum](/commands/rclone_hashsum/) command for more information on the above.
-**Authentication is required for this call.**
-
### operations/hashsumfile: Produces a hash for a single file. {#operations-hashsumfile}
Produces a hash for a single file using the hash named.
@@ -1735,8 +1721,6 @@ Example:
See the [hashsum](/commands/rclone_hashsum/) command for more information on the above.
-**Authentication is required for this call.**
-
### operations/list: List the given remote and path in JSON format {#operations-list}
This takes the following parameters:
@@ -1762,8 +1746,6 @@ Returns:
See the [lsjson](/commands/rclone_lsjson/) command for more information on the above and examples.
-**Authentication is required for this call.**
-
### operations/mkdir: Make a destination directory or container {#operations-mkdir}
This takes the following parameters:
@@ -1773,8 +1755,6 @@ This takes the following parameters:
See the [mkdir](/commands/rclone_mkdir/) command for more information on the above.
-**Authentication is required for this call.**
-
### operations/movefile: Move a file from source remote to destination remote {#operations-movefile}
This takes the following parameters:
@@ -1784,8 +1764,6 @@ This takes the following parameters:
- dstFs - a remote name string e.g. "drive2:" for the destination, "/" for local filesystem
- dstRemote - a path within that remote e.g. "file2.txt" for the destination
-**Authentication is required for this call.**
-
### operations/publiclink: Create or retrieve a public link to the given file or folder. {#operations-publiclink}
This takes the following parameters:
@@ -1801,8 +1779,6 @@ Returns:
See the [link](/commands/rclone_link/) command for more information on the above.
-**Authentication is required for this call.**
-
### operations/purge: Remove a directory or container and all of its contents {#operations-purge}
This takes the following parameters:
@@ -1812,8 +1788,6 @@ This takes the following parameters:
See the [purge](/commands/rclone_purge/) command for more information on the above.
-**Authentication is required for this call.**
-
### operations/rmdir: Remove an empty directory or container {#operations-rmdir}
This takes the following parameters:
@@ -1823,8 +1797,6 @@ This takes the following parameters:
See the [rmdir](/commands/rclone_rmdir/) command for more information on the above.
-**Authentication is required for this call.**
-
### operations/rmdirs: Remove all the empty directories in the path {#operations-rmdirs}
This takes the following parameters:
@@ -1835,8 +1807,6 @@ This takes the following parameters:
See the [rmdirs](/commands/rclone_rmdirs/) command for more information on the above.
-**Authentication is required for this call.**
-
### operations/settier: Changes storage tier or class on all files in the path {#operations-settier}
This takes the following parameters:
@@ -1845,8 +1815,6 @@ This takes the following parameters:
See the [settier](/commands/rclone_settier/) command for more information on the above.
-**Authentication is required for this call.**
-
### operations/settierfile: Changes storage tier or class on the single file pointed to {#operations-settierfile}
This takes the following parameters:
@@ -1854,8 +1822,6 @@ This takes the following parameters:
- fs - a remote name string e.g. "drive:"
- remote - a path within that remote e.g. "dir"
-**Authentication is required for this call.**
-
### operations/size: Count the number of bytes and files in remote {#operations-size}
This takes the following parameters:
@@ -1869,8 +1835,6 @@ Returns:
See the [size](/commands/rclone_size/) command for more information on the above.
-**Authentication is required for this call.**
-
### operations/stat: Give information about the supplied file or directory {#operations-stat}
This takes the following parameters
@@ -1889,8 +1853,6 @@ efficient to set the filesOnly flag in the options.
See the [lsjson](/commands/rclone_lsjson/) command for more information on the above and examples.
-**Authentication is required for this call.**
-
### operations/uploadfile: Upload file using multiform/form-data {#operations-uploadfile}
This takes the following parameters:
@@ -1899,8 +1861,6 @@ This takes the following parameters:
- remote - a path within that remote e.g. "dir"
- each part in body represents a file to be uploaded
-**Authentication is required for this call.**
-
### options/blocks: List all the option blocks {#options-blocks}
Returns:
@@ -1992,8 +1952,6 @@ Example:
rclone rc pluginsctl/addPlugin
-**Authentication is required for this call.**
-
### pluginsctl/getPluginsForType: Get plugins with type criteria {#pluginsctl-getPluginsForType}
This shows all possible plugins by a mime type.
@@ -2012,8 +1970,6 @@ Example:
rclone rc pluginsctl/getPluginsForType type=video/mp4
-**Authentication is required for this call.**
-
### pluginsctl/listPlugins: Get the list of currently loaded plugins {#pluginsctl-listPlugins}
This allows you to get the currently enabled plugins and their details.
@@ -2027,8 +1983,6 @@ E.g.
rclone rc pluginsctl/listPlugins
-**Authentication is required for this call.**
-
### pluginsctl/listTestPlugins: Show currently loaded test plugins {#pluginsctl-listTestPlugins}
Allows listing of test plugins with the rclone.test set to true in package.json of the plugin.
@@ -2041,8 +1995,6 @@ E.g.
rclone rc pluginsctl/listTestPlugins
-**Authentication is required for this call.**
-
### pluginsctl/removePlugin: Remove a loaded plugin {#pluginsctl-removePlugin}
This allows you to remove a plugin using it's name.
@@ -2055,8 +2007,6 @@ E.g.
rclone rc pluginsctl/removePlugin name=rclone/video-plugin
-**Authentication is required for this call.**
-
### pluginsctl/removeTestPlugin: Remove a test plugin {#pluginsctl-removeTestPlugin}
This allows you to remove a plugin using it's name.
@@ -2069,13 +2019,13 @@ Example:
rclone rc pluginsctl/removeTestPlugin name=rclone/rclone-webui-react
-**Authentication is required for this call.**
-
### rc/error: This returns an error {#rc-error}
This returns an error with the input as part of its error string.
Useful for testing error handling.
+**Authentication is not required for this call.**
+
### rc/fatal: This returns an fatal error {#rc-fatal}
This returns an error with the input as part of its error string.
@@ -2086,20 +2036,22 @@ Useful for testing error handling.
This lists all the registered remote control commands as a JSON map in
the commands response.
+**Authentication is not required for this call.**
+
### rc/noop: Echo the input to the output parameters {#rc-noop}
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.
+**Authentication is not required for this call.**
+
### rc/noopauth: Echo the input to the output parameters requiring auth {#rc-noopauth}
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.
-**Authentication is required for this call.**
-
### rc/panic: This returns an error by panicking {#rc-panic}
This returns an error with the input as part of its error string.
@@ -2146,8 +2098,6 @@ Returns
}
```
-**Authentication is required for this call.**
-
### serve/start: Create a new server {#serve-start}
Create a new server with the specified parameters.
@@ -2183,8 +2133,6 @@ Or an error if it failed to start.
Stop the server with `serve/stop` and list the running servers with `serve/list`.
-**Authentication is required for this call.**
-
### serve/stop: Unserve selected active serve {#serve-stop}
Stops a running `serve` instance by ID.
@@ -2199,8 +2147,6 @@ Example:
rclone rc serve/stop id=12345
-**Authentication is required for this call.**
-
### serve/stopall: Stop all active servers {#serve-stopall}
Stop all active servers.
@@ -2209,8 +2155,6 @@ This will stop all active servers.
rclone rc serve/stopall
-**Authentication is required for this call.**
-
### serve/types: Show all possible serve types {#serve-types}
This shows all possible serve types and returns them as a list.
@@ -2238,40 +2182,70 @@ Returns
}
```
-**Authentication is required for this call.**
-
### sync/bisync: Perform bidirectional synchronization between two paths. {#sync-bisync}
-This takes the following parameters
+<!--- Docs generated by help.go - use go generate to rebuild - DO NOT EDIT --->
+
+This takes the following parameters:
-- path1 - a remote directory string e.g. `drive:path1`
-- path2 - a remote directory string e.g. `drive:path2`
-- dryRun - dry-run mode
-- resync - performs the resync run
-- checkAccess - abort if RCLONE_TEST files are not found on both filesystems
-- checkFilename - file name for checkAccess (default: RCLONE_TEST)
-- maxDelete - abort sync if percentage of deleted files is above
- this threshold (default: 50)
-- force - Bypass maxDelete safety check and run the sync
-- checkSync - `true` by default, `false` disables comparison of final listings,
- `only` will skip sync, only compare listings from the last run
-- createEmptySrcDirs - Sync creation and deletion of empty directories.
- (Not compatible with --remove-empty-dirs)
-- removeEmptyDirs - remove empty directories at the final cleanup step
-- filtersFile - read filtering patterns from a file
-- ignoreListingChecksum - Do not use checksums for listings
-- resilient - Allow future runs to retry after certain less-serious errors, instead of requiring resync.
-- workdir - server directory for history files (default: `~/.cache/rclone/bisync`)
-- backupdir1 - --backup-dir for Path1. Must be a non-overlapping path on the same remote.
-- backupdir2 - --backup-dir for Path2. Must be a non-overlapping path on the same remote.
-- noCleanup - retain working files
+- path1 (required) - (string) a remote directory string e.g. `drive:path1`
+- path2 (required) - (string) a remote directory string e.g. `drive:path2`
+- dryRun - (bool) dry-run mode
+- backupDir1 - (string) --backup-dir for Path1. Must be a non-overlapping path on
+the same remote.
+- backupDir2 - (string) --backup-dir for Path2. Must be a non-overlapping path on
+the same remote.
+- checkAccess - (bool) Ensure expected RCLONE_TEST files are found on both
+Path1 and Path2 filesystems, else abort.
+- checkFilename - (string) Filename for --check-access (default: RCLONE_TEST)
+- checkSync - (string) Controls comparison of final listings: true|false|only
+(default: true)
+- compare - (string) Comma-separated list of bisync-specific compare options ex.
+'size,modtime,checksum' (default: 'size,modtime')
+- conflictLoser - (ConflictLoserAction) Action to take on the loser of a sync
+conflict (when there is a winner) or on both files (when there is no
+winner): , num, pathname, delete (default: num)
+- conflictResolve - (string) Automatically resolve conflicts by preferring the
+version that is: none, path1, path2, newer, older, larger, smaller (default:
+none)
+- conflictSuffix - (string) Suffix to use when renaming a --conflict-loser. Can
+be either one string or two comma-separated strings to assign different
+suffixes to Path1/Path2. (default: 'conflict')
+- createEmptySrcDirs - (bool) Sync creation and deletion of empty directories.
+(Not compatible with --remove-empty-dirs)
+- downloadHash - (bool) Compute hash by downloading when otherwise
+unavailable. (warning: may be slow and use lots of data!)
+- filtersFile - (string) Read filtering patterns from a file
+- force - (bool) Bypass --max-delete safety check and run the sync. Consider
+using with --verbose
+- ignoreListingChecksum - (bool) Do not use checksums for listings (add --ignore-
+checksum to additionally skip post-copy checksum checks)
+- maxLock - (Duration) Consider lock files older than this to be expired
+(default: 0 (never expire)) (minimum: 2m)
+- noCleanup - (bool) Retain working files (useful for troubleshooting and
+testing).
+- noSlowHash - (bool) Ignore listing checksums only on backends where they are
+slow
+- recover - (bool) Automatically recover from interruptions without requiring --
+resync.
+- removeEmptyDirs - (bool) Remove ALL empty directories at the final cleanup
+step.
+- resilient - (bool) Allow future runs to retry after certain less-serious
+errors, instead of requiring --resync.
+- resync - (bool) Performs the resync run. Equivalent to --resync-mode path1.
+Consider using --verbose or --dry-run first.
+- resyncMode - (string) During resync, prefer the version that is: path1,
+path2, newer, older, larger, smaller (default: path1 if --resync, otherwise
+none for no resync.)
+- slowHashSyncOnly - (bool) Ignore slow checksums for listings and deltas, but
+still consider them during sync calls.
+- workdir - (string) Use custom working dir - useful for testing. (default:
+/home/ncw/.cache/rclone/bisync)
See [bisync command help](https://rclone.org/commands/rclone_bisync/)
and [full bisync description](https://rclone.org/bisync/)
for more information.
-**Authentication is required for this call.**
-
### sync/copy: copy a directory from source remote to destination remote {#sync-copy}
This takes the following parameters:
@@ -2283,8 +2257,6 @@ This takes the following parameters:
See the [copy](/commands/rclone_copy/) command for more information on the above.
-**Authentication is required for this call.**
-
### sync/move: move a directory from source remote to destination remote {#sync-move}
This takes the following parameters:
@@ -2297,8 +2269,6 @@ This takes the following parameters:
See the [move](/commands/rclone_move/) command for more information on the above.
-**Authentication is required for this call.**
-
### sync/sync: sync a directory from source remote to destination remote {#sync-sync}
This takes the following parameters:
@@ -2310,8 +2280,6 @@ This takes the following parameters:
See the [sync](/commands/rclone_sync/) command for more information on the above.
-**Authentication is required for this call.**
-
### vfs/forget: Forget files or directories in the directory cache. {#vfs-forget}
This forgets the paths in the directory cache causing them to be
@@ -2341,6 +2309,8 @@ 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.
+**Authentication is not required for this call.**
+
### vfs/poll-interval: Get the status or update the value of the poll-interval option. {#vfs-poll-interval}
Without any parameter given this returns the current status of the
@@ -2403,6 +2373,8 @@ 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.
+**Authentication is not required for this call.**
+
### vfs/queue-set-expiry: Set the expiry time for an item queued for upload. {#vfs-queue-set-expiry}
Use this to adjust the `expiry` time for an item in the upload queue.
@@ -2496,6 +2468,8 @@ 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.
+**Authentication is not required for this call.**
+
<!-- autogenerated stop -->
## Accessing the remote control via HTTP {#api-http}
diff --git a/docs/content/s3.md b/docs/content/s3.md
index 15e8984a2..edabd90b6 100644
--- a/docs/content/s3.md
+++ b/docs/content/s3.md
@@ -965,7 +965,7 @@ mode from COMPLIANCE to GOVERNANCE while preserving the original retention date:
<!-- autogenerated options start - DO NOT EDIT - instead edit fs.RegInfo in backend/s3/s3.go and run make backenddocs to verify --> <!-- markdownlint-disable-line line-length -->
### Standard options
-Here are the Standard options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, BizflyCloud, Ceph, ChinaMobile, Cloudflare, Cubbit, DigitalOcean, Dreamhost, Exaba, FileLu, FlashBlade, GCS, Hetzner, HuaweiOBS, IBMCOS, IDrive, Intercolo, IONOS, Leviia, Liara, Linode, LyveCloud, Magalu, Mega, Minio, Netease, Outscale, OVHcloud, Petabox, Qiniu, Rabata, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Servercore, SpectraLogic, Storj, Synology, TencentCOS, Wasabi, Zata, Other).
+Here are the Standard options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, BizflyCloud, Ceph, ChinaMobile, Cloudflare, Cubbit, DigitalOcean, Dreamhost, Exaba, Fastly, FileLu, FlashBlade, GCS, HCP, Hetzner, HuaweiOBS, IBMCOS, IDrive, ImpossibleCloud, Intercolo, IONOS, Leviia, Liara, Linode, LyveCloud, Magalu, Mega, Minio, Netease, Outscale, OVHcloud, Petabox, Qiniu, Rabata, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Servercore, SpectraLogic, Storj, Synology, TencentCOS, US3, Wasabi, Zadara, Zata, Other).
#### --s3-provider
@@ -1000,12 +1000,16 @@ Properties:
- Dreamhost DreamObjects
- "Exaba"
- Exaba Object Storage
+ - "Fastly"
+ - Fastly Object Storage
- "FileLu"
- FileLu S5 (S3-Compatible Object Storage)
- "FlashBlade"
- Pure Storage FlashBlade Object Storage
- "GCS"
- Google Cloud Storage
+ - "HCP"
+ - Hitachi Content Platform (HCP)
- "Hetzner"
- Hetzner Object Storage
- "HuaweiOBS"
@@ -1014,6 +1018,8 @@ Properties:
- IBM COS S3
- "IDrive"
- IDrive e2
+ - "ImpossibleCloud"
+ - Impossible Cloud Object Storage
- "Intercolo"
- Intercolo Object Storage
- "IONOS"
@@ -1064,8 +1070,12 @@ Properties:
- Synology C2 Object Storage
- "TencentCOS"
- Tencent Cloud Object Storage (COS)
+ - "US3"
+ - US3 Object Storage
- "Wasabi"
- Wasabi Object Storage
+ - "Zadara"
+ - Zadara Object Storage
- "Zata"
- Zata (S3 compatible Gateway)
- "Other"
@@ -1125,7 +1135,7 @@ Properties:
- Config: region
- Env Var: RCLONE_S3_REGION
-- Provider: AWS,BizflyCloud,Ceph,Cloudflare,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,Hetzner,HuaweiOBS,IBMCOS,Intercolo,IONOS,Leviia,LyveCloud,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,Rabata,RackCorp,Scaleway,SeaweedFS,Selectel,Servercore,Synology,Wasabi,Zata,Other
+- Provider: AWS,BizflyCloud,Ceph,Cloudflare,Cubbit,DigitalOcean,Dreamhost,Exaba,Fastly,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IBMCOS,ImpossibleCloud,Intercolo,IONOS,Leviia,LyveCloud,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,Rabata,RackCorp,Scaleway,SeaweedFS,Selectel,Servercore,Synology,Wasabi,Zadara,Zata,Other
- Type: string
- Required: false
- Examples:
@@ -1243,17 +1253,41 @@ Properties:
- ""
- Use this if unsure.
- Will use v4 signatures and an empty region.
- - Provider: Ceph,DigitalOcean,Dreamhost,Exaba,GCS,IBMCOS,Leviia,LyveCloud,Minio,Netease,SeaweedFS,Wasabi,Other
+ - Provider: Ceph,DigitalOcean,Dreamhost,Exaba,GCS,HCP,IBMCOS,Leviia,LyveCloud,Minio,Netease,SeaweedFS,Wasabi,Other
- "other-v2-signature"
- Use this only if v4 signatures don't work.
- E.g. pre Jewel/v10 CEPH.
- - Provider: Ceph,DigitalOcean,Dreamhost,Exaba,GCS,IBMCOS,Leviia,LyveCloud,Minio,Netease,SeaweedFS,Wasabi,Other
+ - Provider: Ceph,DigitalOcean,Dreamhost,Exaba,GCS,HCP,IBMCOS,Leviia,LyveCloud,Minio,Netease,SeaweedFS,Wasabi,Other
- "auto"
- R2 buckets are automatically distributed across Cloudflare's data centers for low latency.
- Provider: Cloudflare
- "eu-west-1"
- Europe West
- Provider: Cubbit
+ - "au-east-1"
+ - AU East 1
+ - Provider: Fastly
+ - "eu-central"
+ - EU Central
+ - Provider: Fastly
+ - "eu-south-1"
+ - EU South 1
+ - Provider: Fastly
+ - "jp-central-1"
+ - JP Central 1
+ - Provider: Fastly
+ - "uk-east-1"
+ - UK East 1
+ - Provider: Fastly
+ - "us-central-1"
+ - US Central 1
+ - Provider: Fastly
+ - "us-east"
+ - US East
+ - Provider: Fastly
+ - "us-west"
+ - US West
+ - Provider: Fastly
- "global"
- Global
- Provider: FileLu
@@ -1323,6 +1357,27 @@ Properties:
- "ru-northwest-2"
- RU-Moscow2
- Provider: HuaweiOBS
+ - "eu-central-2"
+ - Frankfurt, Germany
+ - Provider: ImpossibleCloud
+ - "eu-west-1"
+ - Amsterdam, Netherlands
+ - Provider: ImpossibleCloud
+ - "eu-west-2"
+ - London, UK
+ - Provider: ImpossibleCloud
+ - "eu-west-3"
+ - Paris, France
+ - Provider: ImpossibleCloud
+ - "eu-east-1"
+ - Poznań, Poland
+ - Provider: ImpossibleCloud
+ - "eu-north-1"
+ - Copenhagen, Denmark
+ - Provider: ImpossibleCloud
+ - "us-east-1"
+ - New York, USA
+ - Provider: ImpossibleCloud
- "de-fra"
- Frankfurt, Germany
- Provider: Intercolo
@@ -1332,9 +1387,18 @@ Properties:
- "eu-central-2"
- Berlin, Germany
- Provider: IONOS
+ - "eu-central-3"
+ - Berlin, Germany
+ - Provider: IONOS
+ - "eu-central-4"
+ - Frankfurt, Germany
+ - Provider: IONOS
- "eu-south-2"
- Logrono, Spain
- Provider: IONOS
+ - "us-central-1"
+ - Lenexa, USA
+ - Provider: IONOS
- "eu-west-2"
- Paris, France
- Provider: Outscale
@@ -1547,6 +1611,10 @@ Properties:
- "tw-001"
- Asia (Taiwan)
- Provider: Synology
+ - "us-east-1"
+ - The default region.
+ - Leave location constraint empty.
+ - Provider: Zadara
- "us-east-1"
- Indore, Madhya Pradesh, India
- Provider: Zata
@@ -1561,7 +1629,7 @@ Properties:
- Config: endpoint
- Env Var: RCLONE_S3_ENDPOINT
-- Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cloudflare,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,FlashBlade,GCS,Hetzner,HuaweiOBS,IBMCOS,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Mega,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,Rabata,RackCorp,Rclone,Scaleway,SeaweedFS,Selectel,Servercore,SpectraLogic,Storj,Synology,TencentCOS,Wasabi,Zata,Other
+- Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cloudflare,Cubbit,DigitalOcean,Dreamhost,Exaba,Fastly,FileLu,FlashBlade,GCS,HCP,Hetzner,HuaweiOBS,IBMCOS,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Mega,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,Rabata,RackCorp,Rclone,Scaleway,SeaweedFS,Selectel,Servercore,SpectraLogic,Storj,Synology,TencentCOS,US3,Wasabi,Zadara,Zata,Other
- Type: string
- Required: false
- Examples:
@@ -1747,6 +1815,9 @@ Properties:
- "s3.cubbit.eu"
- Cubbit DS3 Object Storage endpoint
- Provider: Cubbit
+ - "s3.{tenant_name}.cubbit.eu"
+ - Multi-tenant endpoint - replace {tenant_name} with your actual tenant name. Do not select this directly
+ - Provider: Cubbit
- "syd1.digitaloceanspaces.com"
- DigitalOcean Spaces Sydney 1
- Provider: DigitalOcean
@@ -1780,6 +1851,30 @@ Properties:
- "objects-us-east-1.dream.io"
- Dream Objects endpoint
- Provider: Dreamhost
+ - "au-east-1.object.fastlystorage.app"
+ - AU East 1
+ - Provider: Fastly
+ - "eu-central.object.fastlystorage.app"
+ - EU Central
+ - Provider: Fastly
+ - "eu-south-1.object.fastlystorage.app"
+ - EU South 1
+ - Provider: Fastly
+ - "jp-central-1.object.fastlystorage.app"
+ - JP Central 1
+ - Provider: Fastly
+ - "uk-east-1.object.fastlystorage.app"
+ - UK East 1
+ - Provider: Fastly
+ - "us-central-1.object.fastlystorage.app"
+ - US Central 1
+ - Provider: Fastly
+ - "us-east.object.fastlystorage.app"
+ - US East
+ - Provider: Fastly
+ - "us-west.object.fastlystorage.app"
+ - US West
+ - Provider: Fastly
- "s5lu.com"
- Global FileLu S5 endpoint
- Provider: FileLu
@@ -2038,18 +2133,48 @@ Properties:
- "s3.private.sng01.cloud-object-storage.appdomain.cloud"
- Singapore Single Site Private Endpoint
- Provider: IBMCOS
+ - "eu-central-2.storage.impossibleapi.net"
+ - Frankfurt, Germany
+ - Provider: ImpossibleCloud
+ - "eu-west-1.storage.impossibleapi.net"
+ - Amsterdam, Netherlands
+ - Provider: ImpossibleCloud
+ - "eu-west-2.storage.impossibleapi.net"
+ - London, UK
+ - Provider: ImpossibleCloud
+ - "eu-west-3.storage.impossibleapi.net"
+ - Paris, France
+ - Provider: ImpossibleCloud
+ - "eu-east-1.storage.impossibleapi.net"
+ - Poznań, Poland
+ - Provider: ImpossibleCloud
+ - "eu-north-1.storage.impossibleapi.net"
+ - Copenhagen, Denmark
+ - Provider: ImpossibleCloud
+ - "us-east-1.storage.impossibleapi.net"
+ - New York, USA
+ - Provider: ImpossibleCloud
- "de-fra.i3storage.com"
- Frankfurt, Germany
- Provider: Intercolo
- - "s3-eu-central-1.ionoscloud.com"
+ - "s3.eu-central-1.ionoscloud.com"
- Frankfurt, Germany
- Provider: IONOS
- - "s3-eu-central-2.ionoscloud.com"
+ - "s3.eu-central-2.ionoscloud.com"
+ - Berlin, Germany
+ - Provider: IONOS
+ - "s3.eu-central-3.ionoscloud.com"
- Berlin, Germany
- Provider: IONOS
- - "s3-eu-south-2.ionoscloud.com"
+ - "s3.eu-central-4.ionoscloud.com"
+ - Frankfurt, Germany
+ - Provider: IONOS
+ - "s3.eu-south-2.ionoscloud.com"
- Logrono, Spain
- Provider: IONOS
+ - "s3.us-central-1.ionoscloud.com"
+ - Lenexa, USA
+ - Provider: IONOS
- "s3.leviia.com"
- The default endpoint
- Leviia
@@ -2421,6 +2546,75 @@ Properties:
- "cos.accelerate.myqcloud.com"
- Use Tencent COS Accelerate Endpoint
- Provider: TencentCOS
+ - "s3-cn-bj.ufileos.com"
+ - North China (Beijing 2)
+ - Provider: US3
+ - "s3-cn-wlcb.ufileos.com"
+ - North China (Ulanqab)
+ - Provider: US3
+ - "s3-cn-sh2.ufileos.com"
+ - Shanghai
+ - Provider: US3
+ - "s3-cn-gd.ufileos.com"
+ - South China (Guangzhou)
+ - Provider: US3
+ - "s3-hk.ufileos.com"
+ - Hongkong
+ - Provider: US3
+ - "s3-us-ca.ufileos.com"
+ - United States (Los Angeles)
+ - Provider: US3
+ - "s3-sg.ufileos.com"
+ - Singapore
+ - Provider: US3
+ - "s3-idn-jakarta.ufileos.com"
+ - Indonesia (Jakarta)
+ - Provider: US3
+ - "s3-tw-tp.ufileos.com"
+ - Taiwan (Taipei)
+ - Provider: US3
+ - "s3-afr-nigeria.ufileos.com"
+ - Nigeria (Lagos)
+ - Provider: US3
+ - "s3-bra-saopaulo.ufileos.com"
+ - Brazil (São Paulo)
+ - Provider: US3
+ - "s3-uae-dubai.ufileos.com"
+ - United Arab Emirates (Dubai)
+ - Provider: US3
+ - "s3-ge-fra.ufileos.com"
+ - Germany (Frankfurt)
+ - Provider: US3
+ - "s3-vn-sng.ufileos.com"
+ - Vietnam (Ho Chi Minh City)
+ - Provider: US3
+ - "s3-us-ws.ufileos.com"
+ - United States (Washington)
+ - Provider: US3
+ - "s3-ind-mumbai.ufileos.com"
+ - India (Mumbai)
+ - Provider: US3
+ - "s3-kr-seoul.ufileos.com"
+ - Seoul (South Korea)
+ - Provider: US3
+ - "s3-jpn-tky.ufileos.com"
+ - Japan (Tokyo)
+ - Provider: US3
+ - "s3-th-bkk.ufileos.com"
+ - Bangkok (Thailand)
+ - Provider: US3
+ - "s3-uk-london.ufileos.com"
+ - United Kingdom (London)
+ - Provider: US3
+ - "s3-rus-mosc.ufileos.com"
+ - Russia (Moscow)
+ - Provider: US3
+ - "s3-cn-guiyang1.ufileos.com"
+ - Guiyang 1
+ - Provider: US3
+ - "s3-pk-khi.ufileos.com"
+ - Pakistan
+ - Provider: US3
- "s3.wasabisys.com"
- Wasabi US East 1 (N. Virginia)
- Provider: Wasabi
@@ -2477,7 +2671,7 @@ Properties:
- Config: location_constraint
- Env Var: RCLONE_S3_LOCATION_CONSTRAINT
-- Provider: AWS,ArvanCloud,Ceph,ChinaMobile,DigitalOcean,Dreamhost,Exaba,GCS,Hetzner,IBMCOS,LyveCloud,Minio,Netease,Qiniu,Rabata,RackCorp,SeaweedFS,Synology,Wasabi,Zata,Other
+- Provider: AWS,ArvanCloud,Ceph,ChinaMobile,DigitalOcean,Dreamhost,Exaba,GCS,HCP,Hetzner,IBMCOS,ImpossibleCloud,LyveCloud,Minio,Netease,Qiniu,Rabata,RackCorp,SeaweedFS,Synology,Wasabi,Zata,Other
- Type: string
- Required: false
- Examples:
@@ -2858,36 +3052,36 @@ Properties:
- Config: acl
- Env Var: RCLONE_S3_ACL
-- Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,Hetzner,HuaweiOBS,IBMCOS,IDrive,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,Wasabi,Zata,Other
+- Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IBMCOS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,US3,Wasabi,Zata,Other
- Type: string
- Required: false
- Examples:
- "private"
- Owner gets FULL_CONTROL.
- No one else has access rights (default).
- - Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,Hetzner,HuaweiOBS,IDrive,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,Wasabi,Zata,Other
+ - Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,US3,Wasabi,Zata,Other
- "public-read"
- Owner gets FULL_CONTROL.
- The AllUsers group gets READ access.
- - Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,Hetzner,HuaweiOBS,IDrive,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,Wasabi,Zata,Other
+ - Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,US3,Wasabi,Zata,Other
- "public-read-write"
- Owner gets FULL_CONTROL.
- The AllUsers group gets READ and WRITE access.
- Granting this on a bucket is generally not recommended.
- - Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,Hetzner,HuaweiOBS,IDrive,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,Wasabi,Zata,Other
+ - Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,Wasabi,Zata,Other
- "authenticated-read"
- Owner gets FULL_CONTROL.
- The AuthenticatedUsers group gets READ access.
- - Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,Hetzner,HuaweiOBS,IDrive,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,Wasabi,Zata,Other
+ - Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,Wasabi,Zata,Other
- "bucket-owner-read"
- Object owner gets FULL_CONTROL.
- Bucket owner gets READ access.
- If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.
- - Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,Hetzner,HuaweiOBS,IDrive,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,Wasabi,Zata,Other
+ - Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,Wasabi,Zata,Other
- "bucket-owner-full-control"
- Both the object owner and the bucket owner get FULL_CONTROL over the object.
- If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.
- - Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,Hetzner,HuaweiOBS,IDrive,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,Wasabi,Zata,Other
+ - Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,Wasabi,Zata,Other
- "private"
- Owner gets FULL_CONTROL.
- No one else has access rights (default).
@@ -2961,22 +3155,22 @@ Properties:
- Config: storage_class
- Env Var: RCLONE_S3_STORAGE_CLASS
-- Provider: AWS,Alibaba,ArvanCloud,ChinaMobile,Liara,Magalu,Qiniu,Scaleway,TencentCOS
+- Provider: AWS,Alibaba,ArvanCloud,ChinaMobile,Liara,Magalu,OVHcloud,Qiniu,Scaleway,TencentCOS,US3
- Type: string
- Required: false
- Examples:
- ""
- Default
- - Provider: AWS,Alibaba,ChinaMobile,TencentCOS
+ - Provider: AWS,Alibaba,ChinaMobile,OVHcloud,TencentCOS,US3
- "STANDARD"
- Standard storage class
- - Provider: AWS,Alibaba,ArvanCloud,ChinaMobile,Liara,Magalu,Qiniu,TencentCOS
+ - Provider: AWS,Alibaba,ArvanCloud,ChinaMobile,Liara,Magalu,OVHcloud,Qiniu,TencentCOS,US3
- "REDUCED_REDUNDANCY"
- Reduced redundancy storage class
- Provider: AWS
- "STANDARD_IA"
- Standard Infrequent Access storage class
- - Provider: AWS
+ - Provider: AWS,OVHcloud
- "ONEZONE_IA"
- One Zone Infrequent Access storage class
- Provider: AWS
@@ -2997,7 +3191,25 @@ Properties:
- Provider: Alibaba,ChinaMobile,Qiniu
- "STANDARD_IA"
- Infrequent access storage mode
- - Provider: Alibaba,ChinaMobile,TencentCOS
+ - Provider: Alibaba,ChinaMobile,TencentCOS,US3
+ - "EXPRESS_ONEZONE"
+ - High Performance storage class
+ - Provider: OVHcloud
+ - "ONEZONE_IA"
+ - Standard Infrequent Access storage class
+ - Provider: OVHcloud
+ - "GLACIER"
+ - Active Archive storage class
+ - Provider: OVHcloud
+ - "GLACIER_IR"
+ - Active Archive storage class
+ - Provider: OVHcloud
+ - "DEEP_ARCHIVE"
+ - Cold Archive storage class
+ - Provider: OVHcloud
+ - "INTELLIGENT_TIERING"
+ - Standard storage class
+ - Provider: OVHcloud
- "LINE"
- Infrequent access storage mode
- Provider: Qiniu
@@ -3015,16 +3227,16 @@ Properties:
- "GLACIER"
- Archived storage.
- Prices are lower, but it needs to be restored first to be accessed.
- - Available in FR-PAR and NL-AMS regions.
+ - Available in the FR-PAR region only.
- Provider: Scaleway
- "ONEZONE_IA"
- One Zone - Infrequent Access.
- A good choice for storing secondary backup copies or easily re-creatable data.
- - Available in the FR-PAR region only.
+ - Available in all regions.
- Provider: Scaleway
- "ARCHIVE"
- Archive storage mode
- - Provider: TencentCOS
+ - Provider: TencentCOS,US3
#### --s3-ibm-api-key
@@ -3050,9 +3262,20 @@ Properties:
- Type: string
- Required: false
+#### --s3-bucket-object-lock-enabled
+
+Enable Object Lock when creating new buckets.
+
+Properties:
+
+- Config: bucket_object_lock_enabled
+- Env Var: RCLONE_S3_BUCKET_OBJECT_LOCK_ENABLED
+- Type: bool
+- Default: false
+
### Advanced options
-Here are the Advanced options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, BizflyCloud, Ceph, ChinaMobile, Cloudflare, Cubbit, DigitalOcean, Dreamhost, Exaba, FileLu, FlashBlade, GCS, Hetzner, HuaweiOBS, IBMCOS, IDrive, Intercolo, IONOS, Leviia, Liara, Linode, LyveCloud, Magalu, Mega, Minio, Netease, Outscale, OVHcloud, Petabox, Qiniu, Rabata, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Servercore, SpectraLogic, Storj, Synology, TencentCOS, Wasabi, Zata, Other).
+Here are the Advanced options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, BizflyCloud, Ceph, ChinaMobile, Cloudflare, Cubbit, DigitalOcean, Dreamhost, Exaba, Fastly, FileLu, FlashBlade, GCS, HCP, Hetzner, HuaweiOBS, IBMCOS, IDrive, ImpossibleCloud, Intercolo, IONOS, Leviia, Liara, Linode, LyveCloud, Magalu, Mega, Minio, Netease, Outscale, OVHcloud, Petabox, Qiniu, Rabata, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Servercore, SpectraLogic, Storj, Synology, TencentCOS, US3, Wasabi, Zadara, Zata, Other).
#### --s3-bucket-acl
@@ -3071,7 +3294,7 @@ Properties:
- Config: bucket_acl
- Env Var: RCLONE_S3_BUCKET_ACL
-- Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,Hetzner,HuaweiOBS,IBMCOS,IDrive,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Mega,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,Servercore,TencentCOS,Wasabi,Zata,Other
+- Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IBMCOS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Mega,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,Servercore,TencentCOS,US3,Wasabi,Zata,Other
- Type: string
- Required: false
- Examples:
@@ -3963,6 +4186,27 @@ Properties:
- Type: Tristate
- Default: unset
+#### --s3-list-versions-oldest-first
+
+Set if the backend returns object versions oldest first.
+
+The S3 standard returns object versions newest first. Some backends
+(e.g. Hitachi HCP) return them oldest first instead.
+
+Set this quirk if --s3-version-at or --s3-versions produce incorrect
+results with your backend.
+
+This should be automatically set correctly for all providers rclone
+knows about - please make a bug report if not.
+
+
+Properties:
+
+- Config: list_versions_oldest_first
+- Env Var: RCLONE_S3_LIST_VERSIONS_OLDEST_FIRST
+- Type: Tristate
+- Default: unset
+
#### --s3-use-x-id
Set if rclone should add x-id URL parameters.
@@ -4065,6 +4309,158 @@ Properties:
- Type: Bits
- Default: Off
+#### --s3-ibm-iam-endpoint
+
+IBM IAM Endpoint to use for authentication.
+
+Leave blank to use the default public endpoint.
+
+Properties:
+
+- Config: ibm_iam_endpoint
+- Env Var: RCLONE_S3_IBM_IAM_ENDPOINT
+- Provider: IBMCOS
+- Type: string
+- Required: false
+
+#### --s3-object-lock-mode
+
+Object Lock mode to apply when uploading or copying objects.
+
+Set this to apply Object Lock retention mode to objects.
+If not set, no Object Lock mode is applied (even with --metadata).
+
+Note: To enable Object Lock retention, you must set BOTH object_lock_mode
+AND object_lock_retain_until_date. Setting only one has no effect.
+
+- GOVERNANCE: Set Object Lock mode to GOVERNANCE
+- COMPLIANCE: Set Object Lock mode to COMPLIANCE
+- copy: Copy the mode from the source object (requires --metadata)
+
+See: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html
+
+Properties:
+
+- Config: object_lock_mode
+- Env Var: RCLONE_S3_OBJECT_LOCK_MODE
+- Type: string
+- Required: false
+- Examples:
+ - "GOVERNANCE"
+ - Set Object Lock mode to GOVERNANCE
+ - "COMPLIANCE"
+ - Set Object Lock mode to COMPLIANCE
+ - "copy"
+ - Copy from source object (requires --metadata)
+
+#### --s3-object-lock-retain-until-date
+
+Object Lock retention until date to apply when uploading or copying objects.
+
+Set this to apply Object Lock retention date to objects.
+If not set, no retention date is applied (even with --metadata).
+
+Note: To enable Object Lock retention, you must set BOTH object_lock_mode
+AND object_lock_retain_until_date. Setting only one has no effect.
+
+Accepts:
+- RFC 3339 format: 2030-01-02T15:04:05Z
+- Duration from now: 365d, 1y, 6M (days, years, months)
+- copy: Copy the date from the source object (requires --metadata)
+
+See: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html
+
+Properties:
+
+- Config: object_lock_retain_until_date
+- Env Var: RCLONE_S3_OBJECT_LOCK_RETAIN_UNTIL_DATE
+- Type: string
+- Required: false
+- Examples:
+ - "copy"
+ - Copy from source object (requires --metadata)
+ - "2030-01-01T00:00:00Z"
+ - Set specific date (RFC 3339 format)
+ - "365d"
+ - Set retention for 365 days from now
+ - "1y"
+ - Set retention for 1 year from now
+
+#### --s3-object-lock-legal-hold-status
+
+Object Lock legal hold status to apply when uploading or copying objects.
+
+Set this to apply Object Lock legal hold to objects.
+If not set, no legal hold is applied (even with --metadata).
+
+Note: Legal hold is independent of retention and can be set separately.
+
+- ON: Enable legal hold
+- OFF: Disable legal hold
+- copy: Copy the legal hold status from the source object (requires --metadata)
+
+See: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html
+
+Properties:
+
+- Config: object_lock_legal_hold_status
+- Env Var: RCLONE_S3_OBJECT_LOCK_LEGAL_HOLD_STATUS
+- Type: string
+- Required: false
+- Examples:
+ - "ON"
+ - Enable legal hold
+ - "OFF"
+ - Disable legal hold
+ - "copy"
+ - Copy from source object (requires --metadata)
+
+#### --s3-bypass-governance-retention
+
+Allow deleting or modifying objects locked with GOVERNANCE mode.
+
+Properties:
+
+- Config: bypass_governance_retention
+- Env Var: RCLONE_S3_BYPASS_GOVERNANCE_RETENTION
+- Type: bool
+- Default: false
+
+#### --s3-object-lock-set-after-upload
+
+Set Object Lock via separate API calls after upload.
+
+Use this for S3-compatible providers that don't support setting Object Lock
+headers during PUT operations. When enabled, Object Lock is set via separate
+PutObjectRetention and PutObjectLegalHold API calls after the upload completes.
+
+This adds extra API calls per object, so only enable if your provider requires it.
+
+Properties:
+
+- Config: object_lock_set_after_upload
+- Env Var: RCLONE_S3_OBJECT_LOCK_SET_AFTER_UPLOAD
+- Type: bool
+- Default: false
+
+#### --s3-object-lock-supported
+
+Whether the provider supports S3 Object Lock.
+
+This should be true, false or left unset to use the default for the provider.
+
+Set to false for providers that don't fully support the S3 Object Lock API
+(e.g. GCS which uses non-standard headers for bypass governance retention
+and doesn't implement Legal Hold via the S3 API).
+
+
+Properties:
+
+- Config: object_lock_supported
+- Env Var: RCLONE_S3_OBJECT_LOCK_SUPPORTED
+- Type: Tristate
+- Default: unset
+
#### --s3-description
Description of the remote.
@@ -4091,6 +4487,9 @@ Here are the possible system metadata items for the s3 backend.
| content-language | Content-Language header | string | en-US | N |
| content-type | Content-Type header | string | text/plain | N |
| mtime | Time of last modification, read from rclone metadata | RFC 3339 | 2006-01-02T15:04:05.999999999Z07:00 | N |
+| object-lock-legal-hold-status | Object Lock legal hold status: ON or OFF | string | OFF | N |
+| object-lock-mode | Object Lock mode: GOVERNANCE or COMPLIANCE | string | GOVERNANCE | N |
+| object-lock-retain-until-date | Object Lock retention until date | RFC 3339 | 2030-01-02T15:04:05Z | N |
| tier | Tier of the object | string | GLACIER | **Y** |
See the [metadata](/docs/#metadata) docs for more info.
diff --git a/lib/transform/transform.md b/lib/transform/transform.md
index 609e7ac25..e0f6ba5a1 100644
--- a/lib/transform/transform.md
+++ b/lib/transform/transform.md
@@ -218,12 +218,12 @@ rclone convmv "stories/The Quick Brown Fox!.txt" --name-transform "all,command=e
```console
rclone convmv "stories/The Quick Brown Fox!" --name-transform "date=-{YYYYMMDD}"
-// Output: stories/The Quick Brown Fox!-20260130
+// Output: stories/The Quick Brown Fox!-20260501
```
```console
rclone convmv "stories/The Quick Brown Fox!" --name-transform "date=-{macfriendlytime}"
-// Output: stories/The Quick Brown Fox!-2026-01-30 0852PM
+// Output: stories/The Quick Brown Fox!-2026-05-01 0355PM
```
```console
diff --git a/rclone.1 b/rclone.1
index 42cf2d4fc..5e944400b 100644
--- a/rclone.1
+++ b/rclone.1
@@ -15,7 +15,7 @@
. ftr VB CB
. ftr VBI CBI
.\}
-.TH "rclone" "1" "Jan 30, 2026" "User Manual" ""
+.TH "rclone" "1" "May 01, 2026" "User Manual" ""
.hy
.SH NAME
.PP
@@ -51,6 +51,7 @@ Available commands:
deletefile Remove a single file from remote.
gendocs Output markdown docs for rclone to the directory supplied.
gitannex Speaks with git-annex over stdin/stdout.
+ gui Open the web based GUI.
hashsum Produces a hashsum file for all the objects in the path.
help Show help for rclone commands, flags and backends.
link Generate public link to file/folder.
@@ -273,6 +274,8 @@ Enterprise File Fabric
.IP \[bu] 2
Exaba
.IP \[bu] 2
+Fastly Object Storage
+.IP \[bu] 2
Fastmail Files
.IP \[bu] 2
FileLu Cloud Storage
@@ -303,8 +306,12 @@ Hetzner Storage Box
.IP \[bu] 2
HiDrive
.IP \[bu] 2
+Hitachi Content Platform (HCP)
+.IP \[bu] 2
HTTP
.IP \[bu] 2
+Huawei Drive
+.IP \[bu] 2
Huawei OBS
.IP \[bu] 2
iCloud Drive
@@ -321,6 +328,8 @@ IBM COS S3
.IP \[bu] 2
IDrive e2
.IP \[bu] 2
+Impossible Cloud
+.IP \[bu] 2
Intercolo Object Storage
.IP \[bu] 2
IONOS Cloud
@@ -427,8 +436,6 @@ SMB / CIFS
.IP \[bu] 2
Spectra Logic
.IP \[bu] 2
-StackPath
-.IP \[bu] 2
Storj
.IP \[bu] 2
Synology
@@ -439,12 +446,16 @@ Tencent Cloud Object Storage (COS)
.IP \[bu] 2
Uloz.to
.IP \[bu] 2
+US3
+.IP \[bu] 2
Wasabi
.IP \[bu] 2
WebDAV
.IP \[bu] 2
Yandex Disk
.IP \[bu] 2
+Zadara Object Storage
+.IP \[bu] 2
Zoho WorkDrive
.IP \[bu] 2
Zata
@@ -946,7 +957,7 @@ Its current version is as below.
.SS Source installation
.PP
Make sure you have git and Go (https://golang.org/) installed.
-Go version 1.24 or newer is required, the latest release is recommended.
+Go version 1.25 or newer is required, the latest release is recommended.
You can get it from your package manager, or download it from
golang.org/dl (https://golang.org/dl/).
Then you can run the following:
@@ -1417,6 +1428,8 @@ HiDrive (https://rclone.org/hidrive/)
.IP \[bu] 2
HTTP (https://rclone.org/http/)
.IP \[bu] 2
+Huawei Drive (https://rclone.org/huaweidrive/)
+.IP \[bu] 2
iCloud Drive (https://rclone.org/iclouddrive/)
.IP \[bu] 2
Internet Archive (https://rclone.org/internetarchive/)
@@ -4440,7 +4453,7 @@ rclone bisync remote1:path1 remote2:path2 [flags]
-1, --resync Performs the resync run. Equivalent to --resync-mode path1. Consider using --verbose or --dry-run first.
--resync-mode string During resync, prefer the version that is: path1, path2, newer, older, larger, smaller (default: path1 if --resync, otherwise none for no resync.) (default \[dq]none\[dq])
--slow-hash-sync-only Ignore slow checksums for listings and deltas, but still consider them during sync calls.
- --workdir string Use custom working dir - useful for testing. (default: {WORKDIR})
+ --workdir string Use custom working dir - useful for testing. (default: $HOME/.cache/rclone/bisync)
\f[R]
.fi
.PP
@@ -4489,6 +4502,27 @@ Flags for anything which can copy a file
-u, --update Skip files that are newer on the destination
\f[R]
.fi
+.SS Sync Options
+.PP
+Flags used for sync commands
+.IP
+.nf
+\f[C]
+ --backup-dir string Make backups into hierarchy based in DIR
+ --delete-after When synchronizing, delete files on destination after transferring (default)
+ --delete-before When synchronizing, delete files on destination before transferring
+ --delete-during When synchronizing, delete files during transfer
+ --fix-case Force rename of case insensitive dest to match source
+ --ignore-errors Delete even if there are I/O errors
+ --list-cutoff int To save memory, sort directory listings on disk above this threshold (default 1000000)
+ --max-delete int When synchronizing, limit the number of deletes (default -1)
+ --max-delete-size SizeSuffix When synchronizing, limit the total size of deletes (default off)
+ --suffix string Suffix to add to changed files
+ --suffix-keep-extension Preserve the extension when using --suffix
+ --track-renames When synchronizing, track file renames and do a server-side move if possible
+ --track-renames-strategy string Strategies to use when synchronizing using track-renames hash|modtime|leaf (default \[dq]hash\[dq])
+\f[R]
+.fi
.SS Important Options
.PP
Important flags useful for most commands
@@ -6292,14 +6326,14 @@ rclone convmv \[dq]stories/The Quick Brown Fox!.txt\[dq] --name-transform \[dq]a
.nf
\f[C]
rclone convmv \[dq]stories/The Quick Brown Fox!\[dq] --name-transform \[dq]date=-{YYYYMMDD}\[dq]
-// Output: stories/The Quick Brown Fox!-20260130
+// Output: stories/The Quick Brown Fox!-20260501
\f[R]
.fi
.IP
.nf
\f[C]
rclone convmv \[dq]stories/The Quick Brown Fox!\[dq] --name-transform \[dq]date=-{macfriendlytime}\[dq]
-// Output: stories/The Quick Brown Fox!-2026-01-30 0825PM
+// Output: stories/The Quick Brown Fox!-2026-05-01 0208PM
\f[R]
.fi
.IP
@@ -6832,6 +6866,20 @@ incompatible with \f[V]--urls\f[R].
This will do \f[V]--transfers\f[R] copies in parallel.
Note that if \f[V]--auto-filename\f[R] is desired for all URLs then a
file with only URLs and no filename can be used.
+.PP
+Each FILENAME in the CSV file can start with a relative path which will
+be appended to the destination path provided at the command line.
+For example, running the command shown above with the following CSV file
+will write two files to the destination:
+\f[V]remote:dir/local/path/bar.json\f[R] and
+\f[V]remote:dir/another/local/directory/qux.json\f[R]
+.IP
+.nf
+\f[C]
+https://example.org/foo/bar.json,local/path/bar.json
+https://example.org/qux/baz.json,another/local/directory/qux.json
+\f[R]
+.fi
.SS Troubleshooting
.PP
If you can\[aq]t get \f[V]rclone copyurl\f[R] to work then here are some
@@ -7276,6 +7324,139 @@ not listed here.
.IP \[bu] 2
rclone (https://rclone.org/commands/rclone/) - Show help for rclone
commands, flags and backends.
+.SH rclone gui
+.PP
+Open the web based GUI.
+.SS Synopsis
+.PP
+This command starts an embedded web GUI for rclone and opens it in your
+default browser.
+.PP
+This starts an RC API server and a GUI server on separate localhost
+ports, generates login credentials automatically unless --no-auth is
+specified, and opens the browser already authenticated.
+.IP
+.nf
+\f[C]
+rclone gui
+\f[R]
+.fi
+.PP
+By default rclone gui serves the web GUI that was embedded into the
+rclone binary at build time from https://github.com/rclone/rclone-web/
+You can override this by passing a path to either an unpacked GUI
+directory or a dist.zip archive (e.g.
+one downloaded from the rclone-web releases page):
+.IP
+.nf
+\f[C]
+rclone gui ./my-dist/
+rclone gui ./dist.zip
+\f[R]
+.fi
+.PP
+This is useful for iterating on the GUI locally without rebuilding
+rclone, or for serving a different GUI release than the one embedded.
+.PP
+Use --no-open-browser to skip opening the browser automatically:
+.IP
+.nf
+\f[C]
+rclone gui --no-open-browser
+\f[R]
+.fi
+.PP
+Use --addr to bind the GUI to a specific address:
+.IP
+.nf
+\f[C]
+rclone gui --addr localhost:5580
+\f[R]
+.fi
+.PP
+Use --user and --pass to set specific credentials:
+.IP
+.nf
+\f[C]
+rclone gui --user admin --pass secret
+\f[R]
+.fi
+.PP
+Use --no-auth to disable authentication entirely:
+.IP
+.nf
+\f[C]
+rclone gui --no-auth
+\f[R]
+.fi
+.PP
+For more help see the GUI docs (https://rclone.org/gui/).
+.IP
+.nf
+\f[C]
+rclone gui [path] [flags]
+\f[R]
+.fi
+.SS Options
+.IP
+.nf
+\f[C]
+ --addr stringArray IPaddress:Port for the GUI server (default auto-chosen localhost port)
+ --api-addr stringArray IPaddress:Port for the RC API server (default auto-chosen localhost port)
+ --enable-metrics Enable OpenMetrics/Prometheus compatible endpoint at /metrics
+ -h, --help help for gui
+ --no-auth Don\[aq]t require auth for the RC API
+ --no-open-browser Skip opening the browser automatically
+ --pass string Password for RC authentication
+ --user string User name for RC authentication
+\f[R]
+.fi
+.PP
+Options shared with other commands are described next.
+See the global flags page (https://rclone.org/flags/) for global options
+not listed here.
+.SS RC Options
+.PP
+Flags to control the Remote Control API
+.IP
+.nf
+\f[C]
+ --rc Enable the remote control server
+ --rc-addr stringArray IPaddress:Port or :Port to bind server to (default localhost:5572)
+ --rc-allow-origin string Origin which cross-domain request (CORS) can be executed from
+ --rc-baseurl string Prefix for URLs - leave blank for root
+ --rc-cert string TLS PEM key (concatenation of certificate and CA certificate)
+ --rc-client-ca string Client certificate authority to verify clients with
+ --rc-enable-metrics Enable the Prometheus metrics path at the remote control server
+ --rc-files string Path to local files to serve on the HTTP server
+ --rc-htpasswd string A htpasswd file - if not provided no authentication is done
+ --rc-job-expire-duration Duration Expire finished async jobs older than this value (default 1m0s)
+ --rc-job-expire-interval Duration Interval to check for expired async jobs (default 10s)
+ --rc-key string TLS PEM Private key
+ --rc-max-header-bytes int Maximum size of request header (default 4096)
+ --rc-min-tls-version string Minimum TLS version that is acceptable (default \[dq]tls1.0\[dq])
+ --rc-no-auth Don\[aq]t require auth for certain methods
+ --rc-pass string Password for authentication
+ --rc-realm string Realm for authentication
+ --rc-salt string Password hashing salt (default \[dq]dlPL2MqE\[dq])
+ --rc-serve Enable the serving of remote objects
+ --rc-serve-no-modtime Don\[aq]t read the modification time (can speed things up)
+ --rc-server-read-timeout Duration Timeout for server reading data (default 1h0m0s)
+ --rc-server-write-timeout Duration Timeout for server writing data (default 1h0m0s)
+ --rc-template string User-specified template
+ --rc-user string User name for authentication
+ --rc-user-from-header string User name from a defined HTTP header
+ --rc-web-fetch-url string URL to fetch the releases for webgui (default \[dq]https://api.github.com/repos/rclone/rclone-webui-react/releases/latest\[dq])
+ --rc-web-gui Launch WebGUI on localhost
+ --rc-web-gui-force-update Force update to latest version of web gui
+ --rc-web-gui-no-open-browser Don\[aq]t open the browser automatically
+ --rc-web-gui-update Check and update to latest version of web gui
+\f[R]
+.fi
+.SS See Also
+.IP \[bu] 2
+rclone (https://rclone.org/commands/rclone/) - Show help for rclone
+commands, flags and backends.
.SH rclone hashsum
.PP
Produces a hashsum file for all the objects in the path.
@@ -7465,6 +7646,10 @@ Result can be filtered by a filter argument which applies to all
attributes, and/or filter flags specific for each attribute.
The values must be specified according to regular rclone filtering
pattern syntax.
+.PP
+By default filtering uses non-anchored matching, so \f[V]--type box\f[R]
+also matches \f[V]dropbox\f[R].
+Use \f[V]--exact\f[R] to match complete values only.
.IP
.nf
\f[C]
@@ -7476,6 +7661,7 @@ rclone listremotes [<filter>] [flags]
.nf
\f[C]
--description string Filter remotes by description
+ --exact Match filter strings exactly instead of using non-anchored glob matching
-h, --help help for listremotes
--json Format output as JSON
--long Show type and description in addition to name
@@ -8309,8 +8495,9 @@ not suffer from the same limitations.
Mounting on macOS can be done either via built-in NFS
server (https://rclone.org/commands/rclone_serve_nfs/),
macFUSE (https://osxfuse.github.io/) (also known as osxfuse) or
-FUSE-T (https://www.fuse-t.org/).macFUSE is a traditional FUSE driver
-utilizing a macOS kernel extension (kext).
+FUSE-T (https://www.fuse-t.org/).
+macFUSE is a traditional FUSE driver utilizing a macOS kernel extension
+(kext).
FUSE-T is an alternative FUSE system which \[dq]mounts\[dq] via an NFSv4
local server.
.SS Unicode Normalization
@@ -8364,7 +8551,7 @@ wiki (https://github.com/macos-fuse-t/fuse-t/wiki#caveats):
.PP
File access and modification times cannot be set separately as it seems
to be an issue with the NFS client which always modifies both.
-Can be reproduced with \[aq]touch -m\[aq] and \[aq]touch -a\[aq]
+Can be reproduced with \f[V]touch -m\f[R] and \f[V]touch -a\f[R]
commands
.RE
.PP
@@ -8376,7 +8563,7 @@ This may make rclone upload a full new copy of the file.
When mounting with \f[V]--read-only\f[R], attempts to write to files
will fail \f[I]silently\f[R] as opposed to with a clear warning as in
macFUSE.
-.SH Mounting on Linux
+.SS Mounting on Linux
.PP
On newer versions of Ubuntu, you may encounter the following error when
running \f[V]rclone mount\f[R]:
@@ -8384,11 +8571,13 @@ running \f[V]rclone mount\f[R]:
.PP
NOTICE: mount helper error: fusermount3: mount failed: Permission denied
CRITICAL: Fatal error: failed to mount FUSE fs: fusermount: exit status
-1 This may be due to newer Apparmor (https://wiki.ubuntu.com/AppArmor)
+1
+.RE
+.PP
+This may be due to newer Apparmor (https://wiki.ubuntu.com/AppArmor)
restrictions, which can be disabled with
\f[V]sudo aa-disable /usr/bin/fusermount3\f[R] (you may need to
\f[V]sudo apt install apparmor-utils\f[R] beforehand).
-.RE
.SS Limitations
.PP
Without the use of \f[V]--vfs-cache-mode\f[R] this can only write files
@@ -9195,6 +9384,7 @@ rclone mount remote:path /path/to/mountpoint [flags]
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a \[aq].rclonelink\[aq] extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
@@ -9963,8 +10153,9 @@ not suffer from the same limitations.
Mounting on macOS can be done either via built-in NFS
server (https://rclone.org/commands/rclone_serve_nfs/),
macFUSE (https://osxfuse.github.io/) (also known as osxfuse) or
-FUSE-T (https://www.fuse-t.org/).macFUSE is a traditional FUSE driver
-utilizing a macOS kernel extension (kext).
+FUSE-T (https://www.fuse-t.org/).
+macFUSE is a traditional FUSE driver utilizing a macOS kernel extension
+(kext).
FUSE-T is an alternative FUSE system which \[dq]mounts\[dq] via an NFSv4
local server.
.SS Unicode Normalization
@@ -10018,7 +10209,7 @@ wiki (https://github.com/macos-fuse-t/fuse-t/wiki#caveats):
.PP
File access and modification times cannot be set separately as it seems
to be an issue with the NFS client which always modifies both.
-Can be reproduced with \[aq]touch -m\[aq] and \[aq]touch -a\[aq]
+Can be reproduced with \f[V]touch -m\f[R] and \f[V]touch -a\f[R]
commands
.RE
.PP
@@ -10030,7 +10221,7 @@ This may make rclone upload a full new copy of the file.
When mounting with \f[V]--read-only\f[R], attempts to write to files
will fail \f[I]silently\f[R] as opposed to with a clear warning as in
macFUSE.
-.SH Mounting on Linux
+.SS Mounting on Linux
.PP
On newer versions of Ubuntu, you may encounter the following error when
running \f[V]rclone mount\f[R]:
@@ -10038,11 +10229,13 @@ running \f[V]rclone mount\f[R]:
.PP
NOTICE: mount helper error: fusermount3: mount failed: Permission denied
CRITICAL: Fatal error: failed to mount FUSE fs: fusermount: exit status
-1 This may be due to newer Apparmor (https://wiki.ubuntu.com/AppArmor)
+1
+.RE
+.PP
+This may be due to newer Apparmor (https://wiki.ubuntu.com/AppArmor)
restrictions, which can be disabled with
\f[V]sudo aa-disable /usr/bin/fusermount3\f[R] (you may need to
\f[V]sudo apt install apparmor-utils\f[R] beforehand).
-.RE
.SS Limitations
.PP
Without the use of \f[V]--vfs-cache-mode\f[R] this can only write files
@@ -10855,6 +11048,7 @@ rclone nfsmount remote:path /path/to/mountpoint [flags]
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a \[aq].rclonelink\[aq] extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
@@ -11215,6 +11409,12 @@ Rclone automatically inserts leading and trailing \[dq]/\[dq] on
.PP
\f[V]--rc-disable-zip\f[R] may be set to disable the zipping download
option.
+.SS Protocol
+.PP
+The server supports HTTP/1.1 and HTTP/2.
+HTTP/2 is used automatically for TLS connections.
+For non-TLS connections, HTTP/2 cleartext (h2c) is supported, allowing
+HTTP/2 without encryption.
.SS TLS (SSL)
.PP
By default this will serve over http.
@@ -12354,6 +12554,7 @@ rclone serve dlna remote:path [flags]
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a \[aq].rclonelink\[aq] extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
@@ -13077,6 +13278,7 @@ rclone serve docker [flags]
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a \[aq].rclonelink\[aq] extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
@@ -13851,6 +14053,7 @@ rclone serve ftp remote:path [flags]
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a \[aq].rclonelink\[aq] extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
@@ -13959,6 +14162,12 @@ Rclone automatically inserts leading and trailing \[dq]/\[dq] on
.PP
\f[V]--disable-zip\f[R] may be set to disable the zipping download
option.
+.SS Protocol
+.PP
+The server supports HTTP/1.1 and HTTP/2.
+HTTP/2 is used automatically for TLS connections.
+For non-TLS connections, HTTP/2 cleartext (h2c) is supported, allowing
+HTTP/2 without encryption.
.SS TLS (SSL)
.PP
By default this will serve over http.
@@ -14891,6 +15100,7 @@ rclone serve http remote:path [flags]
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a \[aq].rclonelink\[aq] extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
@@ -15637,6 +15847,7 @@ rclone serve nfs remote:path [flags]
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a \[aq].rclonelink\[aq] extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
@@ -15827,6 +16038,12 @@ Rclone automatically inserts leading and trailing \[dq]/\[dq] on
.PP
\f[V]--disable-zip\f[R] may be set to disable the zipping download
option.
+.SS Protocol
+.PP
+The server supports HTTP/1.1 and HTTP/2.
+HTTP/2 is used automatically for TLS connections.
+For non-TLS connections, HTTP/2 cleartext (h2c) is supported, allowing
+HTTP/2 without encryption.
.SS TLS (SSL)
.PP
By default this will serve over http.
@@ -16227,6 +16444,12 @@ Rclone automatically inserts leading and trailing \[dq]/\[dq] on
.PP
\f[V]--disable-zip\f[R] may be set to disable the zipping download
option.
+.SS Protocol
+.PP
+The server supports HTTP/1.1 and HTTP/2.
+HTTP/2 is used automatically for TLS connections.
+For non-TLS connections, HTTP/2 cleartext (h2c) is supported, allowing
+HTTP/2 without encryption.
.SS TLS (SSL)
.PP
By default this will serve over http.
@@ -16882,6 +17105,7 @@ rclone serve s3 remote:path [flags]
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a \[aq].rclonelink\[aq] extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
@@ -17714,6 +17938,7 @@ rclone serve sftp remote:path [flags]
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a \[aq].rclonelink\[aq] extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
@@ -17850,6 +18075,18 @@ rclone --webdav-unix-socket /tmp/my.socket --webdav-url http://localhost lsf :we
.PP
Note that there is no authentication on http protocol - this is expected
to be done by the permissions on the socket.
+.SS Symlinks / Junction points
+.PP
+The webdav protocol does not support symlinks or junction points and by
+default rclone will skip them completely.
+.PP
+You can use \f[V]-L\f[R] to get rclone to follow symlinks or you can use
+\f[V]--local-links\f[R] to make rclone show \f[V].rclonelink\f[R] files
+in place of the symlinks.
+.PP
+\f[B]NB\f[R] Do not use \f[V]--links\f[R] as since v1.69 this applies to
+the VFS layer too, use \f[V]--local-links\f[R] which only applies to the
+local backend only.
.SS Server options
.PP
Use \f[V]--addr\f[R] to specify which IP address and port the server
@@ -17889,6 +18126,12 @@ Rclone automatically inserts leading and trailing \[dq]/\[dq] on
.PP
\f[V]--disable-zip\f[R] may be set to disable the zipping download
option.
+.SS Protocol
+.PP
+The server supports HTTP/1.1 and HTTP/2.
+HTTP/2 is used automatically for TLS connections.
+For non-TLS connections, HTTP/2 cleartext (h2c) is supported, allowing
+HTTP/2 without encryption.
.SS TLS (SSL)
.PP
By default this will serve over http.
@@ -18823,6 +19066,7 @@ rclone serve webdav remote:path [flags]
--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-handle-caching Duration Time to keep file handle and downloaders alive after last close (default 5s)
--vfs-links Translate symlinks to/from regular files with a \[aq].rclonelink\[aq] extension for the VFS
--vfs-metadata-extension string Set the extension to read metadata from
--vfs-read-ahead SizeSuffix Extra read ahead over --buffer-size when using cache-mode full
@@ -19271,6 +19515,10 @@ Times may be specified as one of:
.PP
Note that value of \f[V]--timestamp\f[R] is in UTC.
If you want local time then add the \f[V]--localtime\f[R] flag.
+.PP
+Metadata can be added when creating a new file with
+\f[V]--metadata-set\f[R].
+For example: rclone touch remote:path -M --metadata-set key=value
.IP
.nf
\f[C]
@@ -22761,6 +23009,11 @@ the remote is sufficient.
In those cases, this flag can speed up the process and reduce the number
of API calls necessary.
.PP
+This flag is only supported on certain backends and will be silently
+ignored on unsupported backends.
+Supported backends include \f[V]azureblob\f[R],
+\f[V]oracleobjectstorage\f[R], \f[V]s3\f[R], \f[V]swift\f[R].
+.PP
Using this flag on a sync operation without also using
\f[V]--update\f[R] would cause all files modified at any time other than
the last upload time to be uploaded again, which is probably not what
@@ -23150,6 +23403,12 @@ that installed to use it.
\f[V]mapper\f[R] dumps the JSON blobs being sent to the program supplied
with \f[V]--metadata-mapper\f[R] and received from it.
It can be useful for debugging the metadata mapper interface.
+.IP \[bu] 2
+\f[V]curl\f[R] dumps the HTTP request as a \f[V]curl\f[R] command.
+Can be used with the other HTTP debugging flags (e.g.
+\f[V]requests\f[R], \f[V]bodies\f[R]).
+By default the auth will be masked - use with \f[V]auth\f[R] to have the
+curl commands with authentication too.
.SS Filtering
.PP
For the filtering options
@@ -24986,140 +25245,128 @@ Not using paths relative to the root of the remote
Not using \f[V]/\f[R] to match from the root of a remote
.IP \[bu] 2
Not using \f[V]**\f[R] to match the contents of a directory
-.SH GUI (Experimental)
+.SH rclone gui
.PP
-Rclone can serve a web based GUI (graphical user interface).
-This is somewhat experimental at the moment so things may be subject to
-change.
+The \f[V]rclone gui\f[R] command starts the official Web GUI that comes
+bundled with rclone.
.PP
-Run this command in a terminal and rclone will download and then display
-the GUI in a web browser.
+With this command, rclone can serve a web-based GUI (graphical user
+interface) that is accessible from a normal web browser.
+.PP
+Run it in a terminal and rclone will initialize and then start the GUI.
.IP
.nf
\f[C]
-rclone rcd --rc-web-gui
+rclone gui
\f[R]
.fi
.PP
-This will produce logs like this and rclone needs to continue to run to
-serve the GUI:
+This will produce logs like this.
+The terminal window needs to stay open to continue to run the GUI:
.IP
.nf
\f[C]
-2019/08/25 11:40:14 NOTICE: A new release for gui is present at https://github.com/rclone/rclone-webui-react/releases/download/v0.0.6/currentbuild.zip
-2019/08/25 11:40:14 NOTICE: Downloading webgui binary. Please wait. [Size: 3813937, Path : /home/USER/.cache/rclone/webgui/v0.0.6.zip]
-2019/08/25 11:40:16 NOTICE: Unzipping
-2019/08/25 11:40:16 NOTICE: Serving remote control on http://127.0.0.1:5572/
+2026/04/14 11:36:04 NOTICE: Serving remote control on http://127.0.0.1:50803/
+2026/04/14 11:36:04 NOTICE: Serving GUI on http://127.0.0.1:50802/
+2026/04/14 11:36:04 NOTICE: GUI available at http://127.0.0.1:50802/login?pass=XXX&url=http%3A%2F%2F127.0.0.1%3A50803%2F&user=gui
\f[R]
.fi
.PP
-This assumes you are running rclone locally on your machine.
-It is possible to separate the rclone and the GUI - see below for
-details.
-.PP
-If you wish to check for updates then you can add
-\f[V]--rc-web-gui-update\f[R] to the command line.
-.PP
-If you find your GUI broken, you may force it to update by add
-\f[V]--rc-web-gui-force-update\f[R].
-.PP
-By default, rclone will open your browser.
-Add \f[V]--rc-web-gui-no-open-browser\f[R] to disable this feature.
+You can also add debugging flags when running the GUI, such as
+\f[V]-v\f[R], which will show more logging output from the rc server.
.SS Using the GUI
.PP
-Once the GUI opens, you will be looking at the dashboard which has an
-overall overview.
+Once the browser opens, you will be presented with the Dashboard, the
+main screen where you can see the status of your remotes and system.
.PP
-On the left hand side you will see a series of view buttons you can
-click on:
-.IP \[bu] 2
-Dashboard - main overview
-.IP \[bu] 2
-Configs - examine and create new configurations
-.IP \[bu] 2
-Explorer - view, download and upload files to the cloud storage systems
-.IP \[bu] 2
-Backend - view or alter the backend config
-.IP \[bu] 2
-Log out
+At the top, starting from the left, you will see a series of tabs you
+can click on.
+On the right side you will have the logout button and potentially an
+\[dq]Update available\[dq] message if a new rclone version has been
+released.
+.SS Dashboard
.PP
-(More docs and walkthrough video to come!)
-.SS How it works
+See live metrics, learn if your remotes are near capacity, and read the
+changelog for the current version.
+.SS Explorer
.PP
-When you run the \f[V]rclone rcd --rc-web-gui\f[R] this is what happens
-.IP \[bu] 2
-Rclone starts but only runs the remote control API (\[dq]rc\[dq]).
-.IP \[bu] 2
-The API is bound to localhost with an auto-generated username and
-password.
-.IP \[bu] 2
-If the API bundle is missing then rclone will download it.
-.IP \[bu] 2
-rclone will start serving the files from the API bundle over the same
-port as the API
-.IP \[bu] 2
-rclone will open the browser with a \f[V]login_token\f[R] so it can log
-straight in.
-.SS Advanced use
+Explore and manage both local disks and remotes, download files and
+directories and start transfers.
+.SS Remotes
.PP
-The \f[V]rclone rcd\f[R] may use any of the flags documented on the rc
-page (https://rclone.org/rc/#supported-parameters).
+Scroll the list of remotes and tap on it to navigate to the explorer.
+There you can navigate the contents of your remotes, transfer, download,
+and even upload files.
+.SS Mounts
.PP
-The flag \f[V]--rc-web-gui\f[R] is shorthand for
-.IP \[bu] 2
-Download the web GUI if necessary
-.IP \[bu] 2
-Check we are using some authentication
-.IP \[bu] 2
-\f[V]--rc-user gui\f[R]
-.IP \[bu] 2
-\f[V]--rc-pass <random password>\f[R]
-.IP \[bu] 2
-\f[V]--rc-serve\f[R]
+Mount remotes as local drives on your computer and check on your
+existing mounts.
+.SS Serves
.PP
-These flags can be overridden as desired.
+Get quick info about your active serve instances, and start new ones.
+.SS Settings
.PP
-See also the rclone rcd
-documentation (https://rclone.org/commands/rclone_rcd/).
-.SS Example: Running a public GUI
+Edit your \f[V]rclone.conf\f[R] file directly, set logging flags, and
+performance parameters.
+.SS How it works
.PP
-For example the GUI could be served on a public port over SSL using an
-htpasswd file using the following flags:
+When you run \f[V]rclone gui\f[R] this is what happens
.IP \[bu] 2
-\f[V]--rc-web-gui\f[R]
+Rclone starts the remote control API (\[dq]rc\[dq]).
.IP \[bu] 2
-\f[V]--rc-addr :443\f[R]
+Rclone starts a second server to serve the Web GUI.
.IP \[bu] 2
-\f[V]--rc-htpasswd /path/to/htpasswd\f[R]
+If a port, username or password is not specified, then missing values
+will be auto-generated.
.IP \[bu] 2
-\f[V]--rc-cert /path/to/ssl.crt\f[R]
+Unless \f[V]--no-open-browser\f[R] is passed, a browser window will
+open.
.IP \[bu] 2
-\f[V]--rc-key /path/to/ssl.key\f[R]
-.SS Example: Running a GUI behind a proxy
+The URL already contains the username & password, in which case the GUI
+will use those values and log you in automatically.
+.SS Security
.PP
-If you want to run the GUI behind a proxy at \f[V]/rclone\f[R] you could
-use these flags:
-.IP \[bu] 2
-\f[V]--rc-web-gui\f[R]
+It\[aq]s important to think first about what rclone has access to and
+what you might be sharing.
+.PP
+A few good measures:
.IP \[bu] 2
-\f[V]--rc-baseurl rclone\f[R]
+Don\[aq]t use \f[V]--no-auth\f[R] (this is for testing only).
.IP \[bu] 2
-\f[V]--rc-htpasswd /path/to/htpasswd\f[R]
-.PP
-Or instead of htpasswd if you just want a single user and password:
+Do not expose to the local network (eg with
+\f[V]--api-addr :5572 --addr :8080\f[R]) unless you trust all devices
+on your local network.
+Prefer \f[V]127.0.0.1\f[R] or \f[V]localhost\f[R] (the default).
.IP \[bu] 2
-\f[V]--rc-user me\f[R]
+Use a strong password and non-obvious usernames like \[dq]admin\[dq] or
+\[dq]rclone\[dq] if you are using \f[V]--user\f[R] and \f[V]--pass\f[R].
.IP \[bu] 2
-\f[V]--rc-pass mypassword\f[R]
-.SS Project
+If you want to host it on a server and access it remotely, make sure
+you\[aq]re only exposing the GUI and not the RC API.
+They listen on different ports.
.PP
-The GUI is being developed in the: rclone/rclone-webui-react
-repository (https://github.com/rclone/rclone-webui-react).
-.PP
-Bug reports and contributions are very welcome :-)
+If you want to access it remotely but want to avoid running a proxy and
+exposing ports, you can use Cloudflare Tunnels or localhost.run or
+Tailscale (all free).
+.SS Options
+.IP
+.nf
+\f[C]
+ --addr stringArray IPaddress:Port for the GUI server (default auto-chosen localhost port)
+ --api-addr stringArray IPaddress:Port for the RC API server (default auto-chosen localhost port)
+ --enable-metrics Enable OpenMetrics/Prometheus compatible endpoint at /metrics
+ -h, --help help for gui
+ --no-auth Don\[aq]t require auth for the RC API
+ --no-open-browser Skip opening the browser automatically
+ --pass string Password for RC authentication
+ --user string User name for RC authentication
+\f[R]
+.fi
+.SS History
.PP
-If you have questions then please ask them on the rclone
-forum (https://forum.rclone.org/).
+In v1.74 the GUI was redone and embedded within rclone for ease of use.
+The GUI bundle ships as a compressed zip embedded in the rclone binary
+and is served from the zip at runtime.
.SH Remote controlling rclone with its API
.PP
If rclone is run with the \f[V]--rc\f[R] flag then it starts an HTTP
@@ -25976,8 +26223,6 @@ Note that arguments must be preceded by the \[dq]-a\[dq] flag
.PP
See the backend (https://rclone.org/commands/rclone_backend/) command
for more information.
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS cache/expire: Purge a remote from cache
.PP
Purge a remote from the cache backend.
@@ -26027,6 +26272,8 @@ used on top of the cache.
.SS cache/stats: Get cache stats
.PP
Show statistics for the cache remote.
+.PP
+\f[B]Authentication is not required for this call.\f[R]
.SS config/create: create the config for a remote.
.PP
This takes the following parameters:
@@ -26061,8 +26308,6 @@ result - result to restart with - used with continue
See the config
create (https://rclone.org/commands/rclone_config_create/) command for
more information on the above.
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS config/delete: Delete a remote in the config file.
.PP
Parameters:
@@ -26072,8 +26317,6 @@ name - name of remote to delete
See the config
delete (https://rclone.org/commands/rclone_config_delete/) command for
more information on the above.
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS config/dump: Dumps the config file.
.PP
Returns a JSON object: - key: value
@@ -26082,8 +26325,6 @@ Where keys are remote names and values are the config parameters.
.PP
See the config dump (https://rclone.org/commands/rclone_config_dump/)
command for more information on the above.
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS config/get: Get a remote in the config file.
.PP
Parameters:
@@ -26092,16 +26333,12 @@ name - name of remote to get
.PP
See the config dump (https://rclone.org/commands/rclone_config_dump/)
command for more information on the above.
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS config/listremotes: Lists the remotes in the config file and defined in environment variables.
.PP
Returns - remotes - array of remote names
.PP
See the listremotes (https://rclone.org/commands/rclone_listremotes/)
command for more information on the above.
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS config/password: password the config for a remote.
.PP
This takes the following parameters:
@@ -26113,8 +26350,6 @@ parameters - a map of { \[dq]key\[dq]: \[dq]value\[dq] } pairs
See the config
password (https://rclone.org/commands/rclone_config_password/) command
for more information on the above.
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS config/paths: Reads the config file path and other important paths.
.PP
Returns a JSON object with the following keys:
@@ -26139,8 +26374,6 @@ Eg
.PP
See the config paths (https://rclone.org/commands/rclone_config_paths/)
command for more information on the above.
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS config/providers: Shows how providers are configured in the config file.
.PP
Returns a JSON object: - providers - array of objects
@@ -26152,15 +26385,11 @@ for more information on the above.
Note that the Options blocks are in the same format as returned by
\[dq]options/info\[dq].
They are described in the option blocks section.
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS config/setpath: Set the path of the config file
.PP
Parameters:
.IP \[bu] 2
path - path to the config file to use
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS config/unlock: Unlock the config file.
.PP
Unlocks the config file if it is locked.
@@ -26170,8 +26399,6 @@ Parameters:
\[aq]configPassword\[aq] - password to unlock the config file
.PP
A good idea is to disable AskPassword before making this call
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS config/update: update the config for a remote.
.PP
This takes the following parameters:
@@ -26204,8 +26431,6 @@ result - result to restart with - used with continue
See the config
update (https://rclone.org/commands/rclone_config_update/) command for
more information on the above.
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS core/bwlimit: Set the bandwidth limit.
.PP
This sets the bandwidth limit to the string passed in.
@@ -26320,8 +26545,23 @@ OR
}
\f[R]
.fi
+.SS core/disks: List the local disks
.PP
-\f[B]Authentication is required for this call.\f[R]
+This does not take any parameters
+.PP
+This call is for rclone GUI programs to enumerate local disks and
+important directories for doing transfers to and from.
+The list returned will include the root directory and the user\[aq]s
+home directory and any mounted disks.
+The returned items should be usable directly as remotes.
+.PP
+Returns:
+.IP \[bu] 2
+disks
+.RS 2
+.IP \[bu] 2
+This is an array of strings of local disk names
+.RE
.SS core/du: Returns disk usage of a locally attached disk.
.PP
This returns the disk usage for the local directory passed in as dir.
@@ -26345,6 +26585,8 @@ Returns:
}
\f[R]
.fi
+.PP
+\f[B]Authentication is not required for this call.\f[R]
.SS core/gc: Runs a garbage collection.
.PP
This tells the go runtime to do a garbage collection run.
@@ -26368,6 +26610,8 @@ Returns the following values:
}
\f[R]
.fi
+.PP
+\f[B]Authentication is not required for this call.\f[R]
.SS core/memstats: Returns the memory statistics
.PP
This returns the memory statistics of the running program.
@@ -26426,6 +26670,7 @@ Returns the following values:
{
\[dq]bytes\[dq]: total transferred bytes since the start of the group,
\[dq]checks\[dq]: number of files checked,
+ \[dq]deletedDirs\[dq]: number of directories deleted,
\[dq]deletes\[dq] : number of files deleted,
\[dq]elapsedTime\[dq]: time in floating point seconds since rclone was started,
\[dq]errors\[dq]: number of errors,
@@ -26466,6 +26711,8 @@ Returns the following values:
Values for \[dq]transferring\[dq], \[dq]checking\[dq] and
\[dq]lastError\[dq] are only assigned if data is available.
The value for \[dq]eta\[dq] is null if an eta cannot be determined.
+.PP
+\f[B]Authentication is not required for this call.\f[R]
.SS core/stats-delete: Delete stats group.
.PP
This deletes entire stats group.
@@ -26521,6 +26768,8 @@ Returns the following values:
}
\f[R]
.fi
+.PP
+\f[B]Authentication is not required for this call.\f[R]
.SS core/version: Shows the current version of rclone, Go and the OS.
.PP
This shows the current versions of rclone, Go and the OS:
@@ -26555,6 +26804,8 @@ goVersion - version of Go runtime in use (e.g.
linking - type of rclone executable (static or dynamic)
.IP \[bu] 2
goTags - space separated build tags or \[dq]none\[dq]
+.PP
+\f[B]Authentication is not required for this call.\f[R]
.SS debug/set-block-profile-rate: Set runtime.SetBlockProfileRate for blocking profiling.
.PP
SetBlockProfileRate controls the fraction of goroutine blocking events
@@ -26671,15 +26922,11 @@ to make repeated rc calls more efficient.
.PP
If you change the parameters of a backend then you may want to call this
to clear an existing remote out of the cache before re-creating it.
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS fscache/entries: Returns the number of entries in the fs cache.
.PP
This returns the number of entries in the fs cache.
.PP
Returns - entries - number of items in the cache
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS job/batch: Run a batch of rclone rc commands concurrently.
.PP
This takes the following parameters:
@@ -26749,8 +26996,6 @@ Gives the result:
}
\f[R]
.fi
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS job/list: Lists the IDs of the running jobs
.PP
Parameters: None.
@@ -26764,6 +27009,8 @@ jobids - array of integer job ids (starting at 1 on each restart)
runningIds - array of integer job ids that are running
.IP \[bu] 2
finishedIds - array of integer job ids that are finished
+.PP
+\f[B]Authentication is not required for this call.\f[R]
.SS job/status: Reads the status of the job ID
.PP
Parameters:
@@ -26797,6 +27044,8 @@ output - output of the job as would have been returned if called
synchronously
.IP \[bu] 2
progress - output of the progress related to the underlying job
+.PP
+\f[B]Authentication is not required for this call.\f[R]
.SS job/stop: Stop the running job
.PP
Parameters:
@@ -26823,8 +27072,6 @@ Eg
rclone rc mount/listmounts
\f[R]
.fi
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS mount/mount: Create a new mount point
.PP
rclone allows Linux, FreeBSD, macOS and Windows to mount any of
@@ -26846,6 +27093,18 @@ mountOpt: a JSON object with Mount options in.
.IP \[bu] 2
vfsOpt: a JSON object with VFS options in.
.PP
+On Windows mountPoint may be set to \[dq]*\[dq] to assign the next
+available drive letter automatically, or a network share UNC path (e.g.
+\[dq]\[rs]server\[dq]) to mount as a network drive.
+In these cases the actual drive letter is chosen at mount time.
+.PP
+This returns the following values:
+.IP \[bu] 2
+mountPoint: the actual mount point that was used (this may differ from
+the input, e.g.
+on Windows when \[dq]*\[dq] is passed the allocated drive letter is
+returned)
+.PP
Example:
.IP
.nf
@@ -26853,6 +27112,7 @@ Example:
rclone rc mount/mount fs=mydrive: mountPoint=/home/<user>/mountPoint
rclone rc mount/mount fs=mydrive: mountPoint=/home/<user>/mountPoint mountType=mount
rclone rc mount/mount fs=TestDrive: mountPoint=/mnt/tmp vfsOpt=\[aq]{\[dq]CacheMode\[dq]: 2}\[aq] mountOpt=\[aq]{\[dq]AllowOther\[dq]: true}\[aq]
+rclone rc mount/mount fs=mydrive: mountPoint=* mountType=cmount
\f[R]
.fi
.PP
@@ -26865,8 +27125,6 @@ The vfsOpt are as described in options/get and can be seen in the
rclone rc options/get
\f[R]
.fi
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS mount/types: Show all possible mount types
.PP
This shows all possible mount types and returns them as a list.
@@ -26886,8 +27144,6 @@ Eg
rclone rc mount/types
\f[R]
.fi
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS mount/unmount: Unmount selected active mount
.PP
rclone allows Linux, FreeBSD, macOS and Windows to mount any of
@@ -26905,8 +27161,6 @@ Example:
rclone rc mount/unmount mountPoint=/home/<user>/mountPoint
\f[R]
.fi
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS mount/unmountall: Unmount all active mounts
.PP
rclone allows Linux, FreeBSD, macOS and Windows to mount any of
@@ -26921,8 +27175,6 @@ Eg
rclone rc mount/unmountall
\f[R]
.fi
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS operations/about: Return the space used on the remote
.PP
This takes the following parameters:
@@ -26934,8 +27186,6 @@ The result is as returned from rclone about --json
.PP
See the about (https://rclone.org/commands/rclone_about/) command for
more information on the above.
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS operations/check: check the source and destination are the same
.PP
Checks the files in the source and destination match.
@@ -27012,8 +27262,6 @@ match - array of strings of all matching files
differ - array of strings of all non-matching files
.IP \[bu] 2
error - array of strings of all files with errors (hashing or reading)
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS operations/cleanup: Remove trashed files in the remote or path
.PP
This takes the following parameters:
@@ -27023,8 +27271,6 @@ fs - a remote name string e.g.
.PP
See the cleanup (https://rclone.org/commands/rclone_cleanup/) command
for more information on the above.
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS operations/copyfile: Copy a file from source remote to destination remote
.PP
This takes the following parameters:
@@ -27040,8 +27286,6 @@ dstFs - a remote name string e.g.
.IP \[bu] 2
dstRemote - a path within that remote e.g.
\[dq]file2.txt\[dq] for the destination
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS operations/copyurl: Copy the URL to the object
.PP
This takes the following parameters:
@@ -27059,8 +27303,6 @@ from url
.PP
See the copyurl (https://rclone.org/commands/rclone_copyurl/) command
for more information on the above.
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS operations/delete: Remove files in the path
.PP
This takes the following parameters:
@@ -27070,8 +27312,6 @@ fs - a remote name string e.g.
.PP
See the delete (https://rclone.org/commands/rclone_delete/) command for
more information on the above.
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS operations/deletefile: Remove the single file pointed to
.PP
This takes the following parameters:
@@ -27084,8 +27324,6 @@ remote - a path within that remote e.g.
.PP
See the deletefile (https://rclone.org/commands/rclone_deletefile/)
command for more information on the above.
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS operations/fsinfo: Return information about the remote
.PP
This takes the following parameters:
@@ -27262,8 +27500,6 @@ $ rclone rc --loopback operations/hashsum fs=bin hashType=MD5 download=true base
.PP
See the hashsum (https://rclone.org/commands/rclone_hashsum/) command
for more information on the above.
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS operations/hashsumfile: Produces a hash for a single file.
.PP
Produces a hash for a single file using the hash named.
@@ -27307,8 +27543,6 @@ $ rclone rc --loopback operations/hashsumfile fs=/ remote=/bin/bash hashType=MD5
.PP
See the hashsum (https://rclone.org/commands/rclone_hashsum/) command
for more information on the above.
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS operations/list: List the given remote and path in JSON format
.PP
This takes the following parameters:
@@ -27353,8 +27587,6 @@ This is an array of objects as described in the lsjson command
.PP
See the lsjson (https://rclone.org/commands/rclone_lsjson/) command for
more information on the above and examples.
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS operations/mkdir: Make a destination directory or container
.PP
This takes the following parameters:
@@ -27367,8 +27599,6 @@ remote - a path within that remote e.g.
.PP
See the mkdir (https://rclone.org/commands/rclone_mkdir/) command for
more information on the above.
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS operations/movefile: Move a file from source remote to destination remote
.PP
This takes the following parameters:
@@ -27384,8 +27614,6 @@ dstFs - a remote name string e.g.
.IP \[bu] 2
dstRemote - a path within that remote e.g.
\[dq]file2.txt\[dq] for the destination
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS operations/publiclink: Create or retrieve a public link to the given file or folder.
.PP
This takes the following parameters:
@@ -27408,8 +27636,6 @@ url - URL of the resource
.PP
See the link (https://rclone.org/commands/rclone_link/) command for more
information on the above.
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS operations/purge: Remove a directory or container and all of its contents
.PP
This takes the following parameters:
@@ -27422,8 +27648,6 @@ remote - a path within that remote e.g.
.PP
See the purge (https://rclone.org/commands/rclone_purge/) command for
more information on the above.
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS operations/rmdir: Remove an empty directory or container
.PP
This takes the following parameters:
@@ -27436,8 +27660,6 @@ remote - a path within that remote e.g.
.PP
See the rmdir (https://rclone.org/commands/rclone_rmdir/) command for
more information on the above.
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS operations/rmdirs: Remove all the empty directories in the path
.PP
This takes the following parameters:
@@ -27452,8 +27674,6 @@ leaveRoot - boolean, set to true not to delete the root
.PP
See the rmdirs (https://rclone.org/commands/rclone_rmdirs/) command for
more information on the above.
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS operations/settier: Changes storage tier or class on all files in the path
.PP
This takes the following parameters:
@@ -27463,8 +27683,6 @@ fs - a remote name string e.g.
.PP
See the settier (https://rclone.org/commands/rclone_settier/) command
for more information on the above.
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS operations/settierfile: Changes storage tier or class on the single file pointed to
.PP
This takes the following parameters:
@@ -27474,8 +27692,6 @@ fs - a remote name string e.g.
.IP \[bu] 2
remote - a path within that remote e.g.
\[dq]dir\[dq]
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS operations/size: Count the number of bytes and files in remote
.PP
This takes the following parameters:
@@ -27491,8 +27707,6 @@ bytes - number of bytes in those files
.PP
See the size (https://rclone.org/commands/rclone_size/) command for more
information on the above.
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS operations/stat: Give information about the supplied file or directory
.PP
This takes the following parameters
@@ -27517,8 +27731,6 @@ efficient to set the filesOnly flag in the options.
.PP
See the lsjson (https://rclone.org/commands/rclone_lsjson/) command for
more information on the above and examples.
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS operations/uploadfile: Upload file using multiform/form-data
.PP
This takes the following parameters:
@@ -27530,8 +27742,6 @@ remote - a path within that remote e.g.
\[dq]dir\[dq]
.IP \[bu] 2
each part in body represents a file to be uploaded
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS options/blocks: List all the option blocks
.PP
Returns: - options - a list of the options block names
@@ -27640,8 +27850,6 @@ url - http url of the github repo where the plugin is hosted
Example:
.PP
rclone rc pluginsctl/addPlugin
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS pluginsctl/getPluginsForType: Get plugins with type criteria
.PP
This shows all possible plugins by a mime type.
@@ -27664,8 +27872,6 @@ running on a different server.
Example:
.PP
rclone rc pluginsctl/getPluginsForType type=video/mp4
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS pluginsctl/listPlugins: Get the list of currently loaded plugins
.PP
This allows you to get the currently enabled plugins and their details.
@@ -27680,8 +27886,6 @@ running on a different server.
E.g.
.PP
rclone rc pluginsctl/listPlugins
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS pluginsctl/listTestPlugins: Show currently loaded test plugins
.PP
Allows listing of test plugins with the rclone.test set to true in
@@ -27698,8 +27902,6 @@ E.g.
rclone rc pluginsctl/listTestPlugins
\f[R]
.fi
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS pluginsctl/removePlugin: Remove a loaded plugin
.PP
This allows you to remove a plugin using it\[aq]s name.
@@ -27712,8 +27914,6 @@ name - name of the plugin in the format
E.g.
.PP
rclone rc pluginsctl/removePlugin name=rclone/video-plugin
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS pluginsctl/removeTestPlugin: Remove a test plugin
.PP
This allows you to remove a plugin using it\[aq]s name.
@@ -27730,12 +27930,12 @@ Example:
rclone rc pluginsctl/removeTestPlugin name=rclone/rclone-webui-react
\f[R]
.fi
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS rc/error: This returns an error
.PP
This returns an error with the input as part of its error string.
Useful for testing error handling.
+.PP
+\f[B]Authentication is not required for this call.\f[R]
.SS rc/fatal: This returns an fatal error
.PP
This returns an error with the input as part of its error string.
@@ -27744,20 +27944,22 @@ Useful for testing error handling.
.PP
This lists all the registered remote control commands as a JSON map in
the commands response.
+.PP
+\f[B]Authentication is not required for this call.\f[R]
.SS rc/noop: Echo the input to the output parameters
.PP
This echoes the input parameters to the output parameters for testing
purposes.
It can be used to check that rclone is still alive and to check that
parameter passing is working properly.
+.PP
+\f[B]Authentication is not required for this call.\f[R]
.SS rc/noopauth: Echo the input to the output parameters requiring auth
.PP
This echoes the input parameters to the output parameters for testing
purposes.
It can be used to check that rclone is still alive and to check that
parameter passing is working properly.
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS rc/panic: This returns an error by panicking
.PP
This returns an error with the input as part of its error string.
@@ -27810,8 +28012,6 @@ Returns
}
\f[R]
.fi
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS serve/start: Create a new server
.PP
Create a new server with the specified parameters.
@@ -27859,8 +28059,6 @@ Or an error if it failed to start.
.PP
Stop the server with \f[V]serve/stop\f[R] and list the running servers
with \f[V]serve/list\f[R].
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS serve/stop: Unserve selected active serve
.PP
Stops a running \f[V]serve\f[R] instance by ID.
@@ -27878,8 +28076,6 @@ Example:
rclone rc serve/stop id=12345
\f[R]
.fi
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS serve/stopall: Stop all active servers
.PP
Stop all active servers.
@@ -27891,8 +28087,6 @@ This will stop all active servers.
rclone rc serve/stopall
\f[R]
.fi
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS serve/types: Show all possible serve types
.PP
This shows all possible serve types and returns them as a list.
@@ -27926,64 +28120,171 @@ Returns
}
\f[R]
.fi
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS sync/bisync: Perform bidirectional synchronization between two paths.
.PP
-This takes the following parameters
+This takes the following parameters:
.IP \[bu] 2
-path1 - a remote directory string e.g.
+path1 (required) - (string) a remote directory string e.g.
\f[V]drive:path1\f[R]
.IP \[bu] 2
-path2 - a remote directory string e.g.
+path2 (required) - (string) a remote directory string e.g.
\f[V]drive:path2\f[R]
.IP \[bu] 2
-dryRun - dry-run mode
+dryRun - (bool) dry-run mode
.IP \[bu] 2
-resync - performs the resync run
+backupDir1 - (string) --backup-dir for Path1.
+Must be a non-overlapping path on the same remote.
+.PD 0
+.P
+.PD
.IP \[bu] 2
-checkAccess - abort if RCLONE_TEST files are not found on both
-filesystems
+backupDir2 - (string) --backup-dir for Path2.
+Must be a non-overlapping path on the same remote.
+.PD 0
+.P
+.PD
+.IP \[bu] 2
+checkAccess - (bool) Ensure expected RCLONE_TEST files are found on both
+Path1 and Path2 filesystems, else abort.
+.PD 0
+.P
+.PD
+.IP \[bu] 2
+checkFilename - (string) Filename for --check-access (default:
+RCLONE_TEST)
+.PD 0
+.P
+.PD
.IP \[bu] 2
-checkFilename - file name for checkAccess (default: RCLONE_TEST)
+checkSync - (string) Controls comparison of final listings:
+true|false|only (default: true)
+.PD 0
+.P
+.PD
.IP \[bu] 2
-maxDelete - abort sync if percentage of deleted files is above this
-threshold (default: 50)
+compare - (string) Comma-separated list of bisync-specific compare
+options ex.
+\[aq]size,modtime,checksum\[aq] (default: \[aq]size,modtime\[aq])
+.PD 0
+.P
+.PD
.IP \[bu] 2
-force - Bypass maxDelete safety check and run the sync
+conflictLoser - (ConflictLoserAction) Action to take on the loser of a
+sync conflict (when there is a winner) or on both files (when there is
+no winner): , num, pathname, delete (default: num)
+.PD 0
+.P
+.PD
.IP \[bu] 2
-checkSync - \f[V]true\f[R] by default, \f[V]false\f[R] disables
-comparison of final listings, \f[V]only\f[R] will skip sync, only
-compare listings from the last run
+conflictResolve - (string) Automatically resolve conflicts by preferring
+the version that is: none, path1, path2, newer, older, larger, smaller
+(default: none)
+.PD 0
+.P
+.PD
.IP \[bu] 2
-createEmptySrcDirs - Sync creation and deletion of empty directories.
+conflictSuffix - (string) Suffix to use when renaming a
+--conflict-loser.
+Can be either one string or two comma-separated strings to assign
+different suffixes to Path1/Path2.
+(default: \[aq]conflict\[aq])
+.PD 0
+.P
+.PD
+.IP \[bu] 2
+createEmptySrcDirs - (bool) Sync creation and deletion of empty
+directories.
(Not compatible with --remove-empty-dirs)
+.PD 0
+.P
+.PD
.IP \[bu] 2
-removeEmptyDirs - remove empty directories at the final cleanup step
+downloadHash - (bool) Compute hash by downloading when otherwise
+unavailable.
+(warning: may be slow and use lots of data!)
+.PD 0
+.P
+.PD
.IP \[bu] 2
-filtersFile - read filtering patterns from a file
+filtersFile - (string) Read filtering patterns from a file
+.PD 0
+.P
+.PD
.IP \[bu] 2
-ignoreListingChecksum - Do not use checksums for listings
+force - (bool) Bypass --max-delete safety check and run the sync.
+Consider using with --verbose
+.PD 0
+.P
+.PD
.IP \[bu] 2
-resilient - Allow future runs to retry after certain less-serious
-errors, instead of requiring resync.
+ignoreListingChecksum - (bool) Do not use checksums for listings (add
+--ignore- checksum to additionally skip post-copy checksum checks)
+.PD 0
+.P
+.PD
.IP \[bu] 2
-workdir - server directory for history files (default:
-\f[V]\[ti]/.cache/rclone/bisync\f[R])
+maxLock - (Duration) Consider lock files older than this to be expired
+(default: 0 (never expire)) (minimum: 2m)
+.PD 0
+.P
+.PD
.IP \[bu] 2
-backupdir1 - --backup-dir for Path1.
-Must be a non-overlapping path on the same remote.
+noCleanup - (bool) Retain working files (useful for troubleshooting and
+testing).
+.PD 0
+.P
+.PD
.IP \[bu] 2
-backupdir2 - --backup-dir for Path2.
-Must be a non-overlapping path on the same remote.
+noSlowHash - (bool) Ignore listing checksums only on backends where they
+are slow
+.PD 0
+.P
+.PD
+.IP \[bu] 2
+recover - (bool) Automatically recover from interruptions without
+requiring -- resync.
+.PD 0
+.P
+.PD
.IP \[bu] 2
-noCleanup - retain working files
+removeEmptyDirs - (bool) Remove ALL empty directories at the final
+cleanup step.
+.PD 0
+.P
+.PD
+.IP \[bu] 2
+resilient - (bool) Allow future runs to retry after certain less-serious
+errors, instead of requiring --resync.
+.PD 0
+.P
+.PD
+.IP \[bu] 2
+resync - (bool) Performs the resync run.
+Equivalent to --resync-mode path1.
+Consider using --verbose or --dry-run first.
+.PD 0
+.P
+.PD
+.IP \[bu] 2
+resyncMode - (string) During resync, prefer the version that is: path1,
+path2, newer, older, larger, smaller (default: path1 if --resync,
+otherwise none for no resync.)
+.PD 0
+.P
+.PD
+.IP \[bu] 2
+slowHashSyncOnly - (bool) Ignore slow checksums for listings and deltas,
+but still consider them during sync calls.
+.PD 0
+.P
+.PD
+.IP \[bu] 2
+workdir - (string) Use custom working dir - useful for testing.
+(default: /home/ncw/.cache/rclone/bisync)
.PP
See bisync command help (https://rclone.org/commands/rclone_bisync/) and
full bisync description (https://rclone.org/bisync/) for more
information.
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS sync/copy: copy a directory from source remote to destination remote
.PP
This takes the following parameters:
@@ -27998,8 +28299,6 @@ createEmptySrcDirs - create empty src directories on destination if set
.PP
See the copy (https://rclone.org/commands/rclone_copy/) command for more
information on the above.
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS sync/move: move a directory from source remote to destination remote
.PP
This takes the following parameters:
@@ -28016,8 +28315,6 @@ deleteEmptySrcDirs - delete empty src directories if set
.PP
See the move (https://rclone.org/commands/rclone_move/) command for more
information on the above.
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS sync/sync: sync a directory from source remote to destination remote
.PP
This takes the following parameters:
@@ -28032,8 +28329,6 @@ createEmptySrcDirs - create empty src directories on destination if set
.PP
See the sync (https://rclone.org/commands/rclone_sync/) command for more
information on the above.
-.PP
-\f[B]Authentication is required for this call.\f[R]
.SS vfs/forget: Forget files or directories in the directory cache.
.PP
This forgets the paths in the directory cache causing them to be re-read
@@ -28070,6 +28365,8 @@ This lists the active VFSes.
It returns a list under the key \[dq]vfses\[dq] where the values are the
VFS names that could be passed to the other VFS commands in the
\[dq]fs\[dq] parameter.
+.PP
+\f[B]Authentication is not required for this call.\f[R]
.SS vfs/poll-interval: Get the status or update the value of the poll-interval option.
.PP
Without any parameter given this returns the current status of the
@@ -28141,6 +28438,8 @@ If this parameter is not supplied and if there is only one VFS in use
then that VFS will be used.
If there is more than one VFS in use then the \[dq]fs\[dq] parameter
must be supplied.
+.PP
+\f[B]Authentication is not required for this call.\f[R]
.SS vfs/queue-set-expiry: Set the expiry time for an item queued for upload.
.PP
Use this to adjust the \f[V]expiry\f[R] time for an item in the upload
@@ -28251,6 +28550,8 @@ If this parameter is not supplied and if there is only one VFS in use
then that VFS will be used.
If there is more than one VFS in use then the \[dq]fs\[dq] parameter
must be supplied.
+.PP
+\f[B]Authentication is not required for this call.\f[R]
.SS Accessing the remote control via HTTP
.PP
Rclone implements a simple HTTP based protocol.
@@ -29327,7 +29628,7 @@ This can be specified using the \f[V]--ftp-encoding\f[R] flag or using
an \f[V]encoding\f[R] parameter in the config file.
.SS Encoding example: Windows
.PP
-As a nother example, take a Windows system where there is a file with
+As another example, take a Windows system where there is a file with
name \f[V]Test:1.jpg\f[R], where \f[V]:\f[R] is the Unicode fullwidth
colon symbol.
When using rclone to copy this to a remote which supports \f[V]:\f[R],
@@ -29878,7 +30179,7 @@ Flags for general networking and HTTP stuff.
--tpslimit float Limit HTTP transactions per second to this
--tpslimit-burst int Max burst of transactions for --tpslimit (default 1)
--use-cookies Enable session cookiejar
- --user-agent string Set the user-agent to a specified string (default \[dq]rclone/v1.73.0\[dq])
+ --user-agent string Set the user-agent to a specified string (default \[dq]rclone/v1.74.0\[dq])
\f[R]
.fi
.SS Performance
@@ -29931,7 +30232,7 @@ Flags for developers.
.nf
\f[C]
--cpuprofile string Write cpu profile to file
- --dump DumpFlags List of items to dump from: headers, bodies, requests, responses, auth, filters, goroutines, openfiles, mapper
+ --dump DumpFlags List of items to dump from: headers, bodies, requests, responses, auth, filters, goroutines, openfiles, mapper, curl
--dump-bodies Dump HTTP headers and bodies - may contain sensitive info
--dump-headers Dump HTTP headers - may contain sensitive info
--memprofile string Write memory profile to file
@@ -30112,6 +30413,8 @@ Backend-only flags (these can be set in the config file also).
--azureblob-connection-string string Storage Connection String
--azureblob-copy-concurrency int Concurrency for multipart copy (default 512)
--azureblob-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 8Mi)
+ --azureblob-copy-total-concurrency int Global concurrency limit for multipart copy chunks
+ --azureblob-decompress If set this will decompress gzip encoded objects
--azureblob-delete-snapshots string Set to specify how to deal with snapshots on blob deletion
--azureblob-description string Description of the remote
--azureblob-directory-markers Upload an empty object with a trailing slash when a new directory is created
@@ -30362,9 +30665,11 @@ Backend-only flags (these can be set in the config file also).
--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
+ --filelu-chunk-size SizeSuffix Chunk size to use for uploading. Used for multipart uploads (default 64Mi)
--filelu-description string Description of the remote
--filelu-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,Colon,Question,Asterisk,Pipe,Hash,Percent,BackSlash,CrLf,Del,Ctl,LeftSpace,LeftPeriod,LeftTilde,LeftCrLfHtVt,RightSpace,RightPeriod,RightCrLfHtVt,InvalidUtf8,Dot,SquareBracket,Semicolon,Exclamation)
--filelu-key string Your FileLu Rclone key from My Account
+ --filelu-upload-cutoff SizeSuffix Cutoff for switching to chunked upload. Any files larger than this will be uploaded in chunks of chunk_size (default 500Mi)
--filen-api-key string API Key for your Filen account (obscured)
--filen-auth-version string Authentication Version (internal use only)
--filen-base-folder-uuid string UUID of Account Root Directory (internal use only)
@@ -30485,11 +30790,24 @@ Backend-only flags (these can be set in the config file also).
--http-no-head Don\[aq]t use HEAD requests
--http-no-slash Set this if the site doesn\[aq]t end directories with /
--http-url string URL of HTTP host to connect to
+ --huaweidrive-auth-url string Auth server URL
+ --huaweidrive-chunk-size SizeSuffix Upload chunk size (default 8Mi)
+ --huaweidrive-client-credentials Use client credentials OAuth flow
+ --huaweidrive-client-id string OAuth Client Id
+ --huaweidrive-client-secret string OAuth Client Secret
+ --huaweidrive-description string Description of the remote
+ --huaweidrive-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftSpace,LeftPeriod,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot)
+ --huaweidrive-list-chunk int Size of listing chunk 1-1000 (default 1000)
+ --huaweidrive-root-folder-id string ID of the root folder
+ --huaweidrive-token string OAuth Access Token as a JSON blob
+ --huaweidrive-token-url string Token server url
+ --huaweidrive-upload-cutoff SizeSuffix Cutoff for switching to resumable upload (default 20Mi)
--iclouddrive-apple-id string Apple ID
- --iclouddrive-client-id string Client id (default \[dq]d39ba9916b7251055b22c7f910e2ea796ee65e98b2ddecea8f5dde8d9d1a815d\[dq])
+ --iclouddrive-client-id string Client ID for iCloud API access (default \[dq]d39ba9916b7251055b22c7f910e2ea796ee65e98b2ddecea8f5dde8d9d1a815d\[dq])
--iclouddrive-description string Description of the remote
--iclouddrive-encoding Encoding The encoding for the backend (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
--iclouddrive-password string Password (obscured)
+ --iclouddrive-service string iCloud service to use (default \[dq]drive\[dq])
--imagekit-description string Description of the remote
--imagekit-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Dollar,Question,Hash,Percent,BackSlash,Del,Ctl,InvalidUtf8,Dot,SquareBracket)
--imagekit-endpoint string You can find your ImageKit.io URL endpoint in your [dashboard](https://imagekit.io/dashboard/developer/api-keys)
@@ -30508,17 +30826,20 @@ Backend-only flags (these can be set in the config file also).
--internetarchive-item-metadata stringArray Metadata to be set on the IA item, this is different from file-level metadata that can be set using --metadata-set
--internetarchive-secret-access-key string IAS3 Secret Key (password)
--internetarchive-wait-archive Duration Timeout for waiting the server\[aq]s processing tasks (specifically archive and book_op) to finish (default 0s)
+ --internxt-chunk-size SizeSuffix Chunk size for multipart uploads (default 30Mi)
--internxt-description string Description of the remote
--internxt-email string Email of your Internxt account
--internxt-encoding Encoding The encoding for the backend (default Slash,BackSlash,CrLf,RightPeriod,InvalidUtf8,Dot)
--internxt-pass string Password (obscured)
--internxt-skip-hash-validation Skip hash validation when downloading files (default true)
+ --internxt-upload-concurrency int Concurrency for multipart uploads (default 4)
+ --internxt-upload-cutoff SizeSuffix Cutoff for switching to multipart upload (default 100Mi)
--jottacloud-auth-url string Auth server URL
--jottacloud-client-credentials Use client credentials OAuth flow
--jottacloud-client-id string OAuth Client Id
--jottacloud-client-secret string OAuth Client Secret
--jottacloud-description string Description of the remote
- --jottacloud-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot)
+ --jottacloud-encoding Encoding The encoding for the backend (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Percent,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
@@ -30535,6 +30856,8 @@ Backend-only flags (these can be set in the config file also).
--koofr-setmtime Does the backend support setting modification time (default true)
--koofr-user string Your user name
--linkbox-description string Description of the remote
+ --linkbox-email string Email for login
+ --linkbox-password string Password for login (obscured)
--linkbox-token string Token from https://www.linkbox.to/admin/account
--local-case-insensitive Force the filesystem to report itself as case insensitive
--local-case-sensitive Force the filesystem to report itself as case sensitive
@@ -30680,7 +31003,7 @@ Backend-only flags (these can be set in the config file also).
--premiumizeme-token string OAuth Access Token as a JSON blob
--premiumizeme-token-url string Token server url
--protondrive-2fa string The 2FA code
- --protondrive-app-version string The app version string (default \[dq]macos-drive\[at]1.0.0-alpha.1+rclone\[dq])
+ --protondrive-app-version string The app version string
--protondrive-description string Description of the remote
--protondrive-enable-caching Caches the files and folders metadata to reduce API calls (default true)
--protondrive-encoding Encoding The encoding for the backend (default Slash,LeftSpace,RightSpace,InvalidUtf8,Dot)
@@ -30721,6 +31044,8 @@ Backend-only flags (these can be set in the config file also).
--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-bucket-object-lock-enabled Enable Object Lock when creating new buckets
+ --s3-bypass-governance-retention Allow deleting or modifying objects locked with GOVERNANCE mode
--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
@@ -30735,11 +31060,13 @@ Backend-only flags (these can be set in the config file also).
--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-ibm-api-key string IBM API Key to be used to obtain IAM token
+ --s3-ibm-iam-endpoint string IBM IAM Endpoint to use for authentication
--s3-ibm-resource-instance-id string IBM service instance id
--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-list-versions-oldest-first Tristate Set if the backend returns object versions oldest first (default unset)
--s3-location-constraint string Location constraint - must be set to match the Region
--s3-max-upload-parts int Maximum number of parts in a multipart upload (default 10000)
--s3-might-gzip Tristate Set this if the backend might gzip objects (default unset)
@@ -30747,6 +31074,11 @@ Backend-only flags (these can be set in the config file also).
--s3-no-head If set, don\[aq]t HEAD uploaded objects to check integrity
--s3-no-head-object If set, do not do HEAD before GET when getting objects
--s3-no-system-metadata Suppress setting and reading of system metadata
+ --s3-object-lock-legal-hold-status string Object Lock legal hold status to apply when uploading or copying objects
+ --s3-object-lock-mode string Object Lock mode to apply when uploading or copying objects
+ --s3-object-lock-retain-until-date string Object Lock retention until date to apply when uploading or copying objects
+ --s3-object-lock-set-after-upload Set Object Lock via separate API calls after upload
+ --s3-object-lock-supported Tristate Whether the provider supports S3 Object Lock (default unset)
--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
@@ -32735,6 +33067,12 @@ and you can therefore be reasonably sure that any \f[I]expired\f[R] lock
file you may find was left there by an interrupted run, not one that is
still running and just taking awhile.
.PP
+If a lock file exists but its contents are unreadable (for example, due
+to an incomplete write or disk error), it is treated as expired when
+\f[V]--max-lock\f[R] is set to a value greater than \f[V]0\f[R].
+If \f[V]--max-lock\f[R] is \f[V]0\f[R] or not set, an unreadable lock
+file will produce an error and block future runs until removed manually.
+.PP
If \f[V]--max-lock\f[R] is \f[V]0\f[R] or not set, the default is that
lock files will never expire, and will block future runs (of these same
two bisync paths) indefinitely.
@@ -33145,19 +33483,7 @@ The following backends have known issues that need more investigation:
\f[V]TestBisyncRemoteRemote/normalization\f[R] (https://pub.rclone.org/integration-tests/current/dropbox-cmd.bisync-TestDropbox-1.txt)
.RE
.IP \[bu] 2
-\f[V]TestSeafile\f[R] (\f[V]seafile\f[R])
-.RS 2
-.IP \[bu] 2
-\f[V]TestBisyncLocalRemote/volatile\f[R] (https://pub.rclone.org/integration-tests/current/seafile-cmd.bisync-TestSeafile-1.txt)
-.RE
-.IP \[bu] 2
-\f[V]TestSeafileV6\f[R] (\f[V]seafile\f[R])
-.RS 2
-.IP \[bu] 2
-\f[V]TestBisyncLocalRemote/volatile\f[R] (https://pub.rclone.org/integration-tests/current/seafile-cmd.bisync-TestSeafileV6-1.txt)
-.RE
-.IP \[bu] 2
-Updated: 2026-01-30-010015
+Updated: 2026-05-01-010013
.PP
The following backends either have not been tested recently or have
known issues that are deemed unfixable for the time being:
@@ -34276,6 +34602,13 @@ Also note a number of academic publications by Benjamin
Pierce (http://www.cis.upenn.edu/%7Ebcpierce/papers/index.shtml#File%20Synchronization)
about \f[I]Unison\f[R] and synchronization in general.
.SS Changelog
+.SS \f[V]v1.74\f[R]
+.IP \[bu] 2
+Added several missing \f[V]rc\f[R] parameters.
+.IP \[bu] 2
+Optional \f[V]rc\f[R] parameters are now truly optional.
+.IP \[bu] 2
+\f[V]rc\f[R] output now provides more structured information.
.SS \f[V]v1.71\f[R]
.IP \[bu] 2
\f[V]bisync\f[R] is now officially released from beta.
@@ -35083,18 +35416,24 @@ Dreamhost
.IP \[bu] 2
Exaba
.IP \[bu] 2
+Fastly Object Storage
+.IP \[bu] 2
FileLu S5 (S3-Compatible Object Storage)
.IP \[bu] 2
GCS
.IP \[bu] 2
Hetzner
.IP \[bu] 2
+Hitachi Content Platform (HCP)
+.IP \[bu] 2
Huawei OBS
.IP \[bu] 2
IBM COS S3
.IP \[bu] 2
IDrive e2
.IP \[bu] 2
+Impossible Cloud
+.IP \[bu] 2
Intercolo Object Storage
.IP \[bu] 2
IONOS Cloud
@@ -35139,16 +35478,18 @@ Servercore Object Storage
.IP \[bu] 2
Spectra Logic
.IP \[bu] 2
-StackPath
-.IP \[bu] 2
Storj
.IP \[bu] 2
Synology C2 Object Storage
.IP \[bu] 2
Tencent Cloud Object Storage (COS)
.IP \[bu] 2
+US3
+.IP \[bu] 2
Wasabi
.IP \[bu] 2
+Zadara Object Storage
+.IP \[bu] 2
Zata
.PP
Paths are specified as \f[V]remote:bucket\f[R] (or \f[V]remote:\f[R] for
@@ -35860,6 +36201,28 @@ T}@T{
..
T}
.TE
+.SS Important note about double slashes (\f[V]//\f[R])
+.PP
+Object keys containing consecutive forward slashes (\f[V]//\f[R]) are
+\f[B]not supported\f[R] by rclone.
+.PP
+When rclone encounters an object key with \f[V]//\f[R] (e.g.,
+\f[V]a//b\f[R]), it will normalize the path to use a single slash (e.g.,
+\f[V]a/b\f[R]).
+This normalization can cause \[dq]object not found\[dq] errors when
+trying to access the original object, as rclone will look for the
+normalized path instead of the actual object key.
+.PP
+\f[B]Example:\f[R] - Original S3 object key: \f[V]folder//file.txt\f[R]
+- rclone interprets it as: \f[V]folder/file.txt\f[R] - Result:
+\[dq]object not found\[dq] error when trying to access
+\f[V]folder//file.txt\f[R]
+.PP
+\f[B]Workaround:\f[R] Avoid using consecutive forward slashes
+(\f[V]//\f[R]) in S3 object keys when using rclone.
+If you have existing objects with \f[V]//\f[R] in their keys, you will
+need to rename them to use single slashes or access them through other
+means.
.SS Multipart uploads
.PP
rclone supports multipart uploads with S3 which means that it can upload
@@ -36158,21 +36521,81 @@ If you configure a default retention period on a bucket, requests to
upload objects in such a bucket must include the Content-MD5 header.
.RE
.PP
-As mentioned in the Modification times and hashes section, small files
-that are not uploaded as multipart, use a different tag, causing the
-upload to fail.
-A simple solution is to set the \f[V]--s3-upload-cutoff 0\f[R] and force
-all the files to be uploaded as multipart.
+Rclone automatically computes and includes the Content-MD5 header when
+uploading objects with Object Lock parameters set.
+No special configuration is needed.
+.SS Setting Object Lock retention
+.PP
+Rclone supports setting Object Lock retention on uploaded objects with
+the following options:
+.IP \[bu] 2
+\f[V]--s3-object-lock-mode\f[R] - Set the Object Lock mode (GOVERNANCE
+or COMPLIANCE)
+.IP \[bu] 2
+\f[V]--s3-object-lock-retain-until-date\f[R] - Set the retention date
+(RFC3339 format or duration like \f[V]365d\f[R], \f[V]24h\f[R])
+.IP \[bu] 2
+\f[V]--s3-object-lock-legal-hold-status\f[R] - Set legal hold (ON or
+OFF)
+.PP
+Example - upload files with 1 year GOVERNANCE retention:
+.IP
+.nf
+\f[C]
+rclone copy local:/data remote:bucket \[rs]
+ --s3-object-lock-mode GOVERNANCE \[rs]
+ --s3-object-lock-retain-until-date 365d
+\f[R]
+.fi
+.SS Copying Object Lock settings from source
+.PP
+When using \f[V]--metadata\f[R], you can use the special value
+\f[V]copy\f[R] to preserve the source object\[aq]s Object Lock settings:
+.IP
+.nf
+\f[C]
+rclone copy source:bucket dest:bucket \[rs]
+ --metadata \[rs]
+ --s3-object-lock-mode copy \[rs]
+ --s3-object-lock-retain-until-date copy
+\f[R]
+.fi
+.PP
+You can also mix copied and explicit values.
+For example, to change the mode from COMPLIANCE to GOVERNANCE while
+preserving the original retention date:
+.IP
+.nf
+\f[C]
+rclone copy source:bucket dest:bucket \[rs]
+ --metadata \[rs]
+ --s3-object-lock-mode GOVERNANCE \[rs]
+ --s3-object-lock-retain-until-date copy
+\f[R]
+.fi
+.SS Additional Object Lock options
+.IP \[bu] 2
+\f[V]--s3-bypass-governance-retention\f[R] - Required to delete or
+overwrite objects with GOVERNANCE mode retention before the retention
+date expires
+.IP \[bu] 2
+\f[V]--s3-bucket-object-lock-enabled\f[R] - Enable Object Lock when
+creating a new bucket with \f[V]rclone mkdir\f[R]
+.IP \[bu] 2
+\f[V]--s3-object-lock-set-after-upload\f[R] - Set Object Lock via
+separate API calls after upload (for providers that don\[aq]t support
+Object Lock headers during PUT)
.SS Standard options
.PP
Here are the Standard options specific to s3 (Amazon S3 Compliant
Storage Providers including AWS, Alibaba, ArvanCloud, BizflyCloud, Ceph,
-ChinaMobile, Cloudflare, Cubbit, DigitalOcean, Dreamhost, Exaba, FileLu,
-FlashBlade, GCS, Hetzner, HuaweiOBS, IBMCOS, IDrive, Intercolo, IONOS,
-Leviia, Liara, Linode, LyveCloud, Magalu, Mega, Minio, Netease,
-Outscale, OVHcloud, Petabox, Qiniu, Rabata, RackCorp, Rclone, Scaleway,
-SeaweedFS, Selectel, Servercore, SpectraLogic, StackPath, Storj,
-Synology, TencentCOS, Wasabi, Zata, Other).
+ChinaMobile, Cloudflare, Cubbit, DigitalOcean, Dreamhost, Exaba, Fastly,
+FileLu, FlashBlade, GCS, HCP, Hetzner, HuaweiOBS, IBMCOS, IDrive,
+ImpossibleCloud, Intercolo, IONOS, Leviia, Liara, Linode, LyveCloud,
+Magalu, Mega, Minio, Netease, Outscale, OVHcloud, Petabox, Qiniu,
+Rabata, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Servercore,
+SpectraLogic, Storj, Synology, TencentCOS, US3, Wasabi, Zadara, Zata,
+Other).
.SS --s3-provider
.PP
Choose your S3 provider.
@@ -36256,6 +36679,12 @@ Dreamhost DreamObjects
Exaba Object Storage
.RE
.IP \[bu] 2
+\[dq]Fastly\[dq]
+.RS 2
+.IP \[bu] 2
+Fastly Object Storage
+.RE
+.IP \[bu] 2
\[dq]FileLu\[dq]
.RS 2
.IP \[bu] 2
@@ -36274,6 +36703,12 @@ Pure Storage FlashBlade Object Storage
Google Cloud Storage
.RE
.IP \[bu] 2
+\[dq]HCP\[dq]
+.RS 2
+.IP \[bu] 2
+Hitachi Content Platform (HCP)
+.RE
+.IP \[bu] 2
\[dq]Hetzner\[dq]
.RS 2
.IP \[bu] 2
@@ -36298,6 +36733,12 @@ IBM COS S3
IDrive e2
.RE
.IP \[bu] 2
+\[dq]ImpossibleCloud\[dq]
+.RS 2
+.IP \[bu] 2
+Impossible Cloud Object Storage
+.RE
+.IP \[bu] 2
\[dq]Intercolo\[dq]
.RS 2
.IP \[bu] 2
@@ -36430,12 +36871,6 @@ Servercore Object Storage
Spectra Logic Black Pearl
.RE
.IP \[bu] 2
-\[dq]StackPath\[dq]
-.RS 2
-.IP \[bu] 2
-StackPath Object Storage
-.RE
-.IP \[bu] 2
\[dq]Storj\[dq]
.RS 2
.IP \[bu] 2
@@ -36454,12 +36889,24 @@ Synology C2 Object Storage
Tencent Cloud Object Storage (COS)
.RE
.IP \[bu] 2
+\[dq]US3\[dq]
+.RS 2
+.IP \[bu] 2
+US3 Object Storage
+.RE
+.IP \[bu] 2
\[dq]Wasabi\[dq]
.RS 2
.IP \[bu] 2
Wasabi Object Storage
.RE
.IP \[bu] 2
+\[dq]Zadara\[dq]
+.RS 2
+.IP \[bu] 2
+Zadara Object Storage
+.RE
+.IP \[bu] 2
\[dq]Zata\[dq]
.RS 2
.IP \[bu] 2
@@ -36548,7 +36995,7 @@ Config: region
Env Var: RCLONE_S3_REGION
.IP \[bu] 2
Provider:
-AWS,BizflyCloud,Ceph,Cloudflare,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,Hetzner,HuaweiOBS,IBMCOS,Intercolo,IONOS,Leviia,LyveCloud,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,Rabata,RackCorp,Scaleway,SeaweedFS,Selectel,Servercore,StackPath,Synology,Wasabi,Zata,Other
+AWS,BizflyCloud,Ceph,Cloudflare,Cubbit,DigitalOcean,Dreamhost,Exaba,Fastly,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IBMCOS,ImpossibleCloud,Intercolo,IONOS,Leviia,LyveCloud,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,Rabata,RackCorp,Scaleway,SeaweedFS,Selectel,Servercore,Synology,Wasabi,Zadara,Zata,Other
.IP \[bu] 2
Type: string
.IP \[bu] 2
@@ -36843,7 +37290,7 @@ Use this if unsure.
Will use v4 signatures and an empty region.
.IP \[bu] 2
Provider:
-Ceph,DigitalOcean,Dreamhost,Exaba,GCS,IBMCOS,Leviia,LyveCloud,Minio,Netease,SeaweedFS,StackPath,Wasabi,Other
+Ceph,DigitalOcean,Dreamhost,Exaba,GCS,HCP,IBMCOS,Leviia,LyveCloud,Minio,Netease,SeaweedFS,Wasabi,Other
.RE
.IP \[bu] 2
\[dq]other-v2-signature\[dq]
@@ -36855,7 +37302,7 @@ E.g.
pre Jewel/v10 CEPH.
.IP \[bu] 2
Provider:
-Ceph,DigitalOcean,Dreamhost,Exaba,GCS,IBMCOS,Leviia,LyveCloud,Minio,Netease,SeaweedFS,StackPath,Wasabi,Other
+Ceph,DigitalOcean,Dreamhost,Exaba,GCS,HCP,IBMCOS,Leviia,LyveCloud,Minio,Netease,SeaweedFS,Wasabi,Other
.RE
.IP \[bu] 2
\[dq]auto\[dq]
@@ -36875,6 +37322,70 @@ Europe West
Provider: Cubbit
.RE
.IP \[bu] 2
+\[dq]au-east-1\[dq]
+.RS 2
+.IP \[bu] 2
+AU East 1
+.IP \[bu] 2
+Provider: Fastly
+.RE
+.IP \[bu] 2
+\[dq]eu-central\[dq]
+.RS 2
+.IP \[bu] 2
+EU Central
+.IP \[bu] 2
+Provider: Fastly
+.RE
+.IP \[bu] 2
+\[dq]eu-south-1\[dq]
+.RS 2
+.IP \[bu] 2
+EU South 1
+.IP \[bu] 2
+Provider: Fastly
+.RE
+.IP \[bu] 2
+\[dq]jp-central-1\[dq]
+.RS 2
+.IP \[bu] 2
+JP Central 1
+.IP \[bu] 2
+Provider: Fastly
+.RE
+.IP \[bu] 2
+\[dq]uk-east-1\[dq]
+.RS 2
+.IP \[bu] 2
+UK East 1
+.IP \[bu] 2
+Provider: Fastly
+.RE
+.IP \[bu] 2
+\[dq]us-central-1\[dq]
+.RS 2
+.IP \[bu] 2
+US Central 1
+.IP \[bu] 2
+Provider: Fastly
+.RE
+.IP \[bu] 2
+\[dq]us-east\[dq]
+.RS 2
+.IP \[bu] 2
+US East
+.IP \[bu] 2
+Provider: Fastly
+.RE
+.IP \[bu] 2
+\[dq]us-west\[dq]
+.RS 2
+.IP \[bu] 2
+US West
+.IP \[bu] 2
+Provider: Fastly
+.RE
+.IP \[bu] 2
\[dq]global\[dq]
.RS 2
.IP \[bu] 2
@@ -37059,6 +37570,62 @@ RU-Moscow2
Provider: HuaweiOBS
.RE
.IP \[bu] 2
+\[dq]eu-central-2\[dq]
+.RS 2
+.IP \[bu] 2
+Frankfurt, Germany
+.IP \[bu] 2
+Provider: ImpossibleCloud
+.RE
+.IP \[bu] 2
+\[dq]eu-west-1\[dq]
+.RS 2
+.IP \[bu] 2
+Amsterdam, Netherlands
+.IP \[bu] 2
+Provider: ImpossibleCloud
+.RE
+.IP \[bu] 2
+\[dq]eu-west-2\[dq]
+.RS 2
+.IP \[bu] 2
+London, UK
+.IP \[bu] 2
+Provider: ImpossibleCloud
+.RE
+.IP \[bu] 2
+\[dq]eu-west-3\[dq]
+.RS 2
+.IP \[bu] 2
+Paris, France
+.IP \[bu] 2
+Provider: ImpossibleCloud
+.RE
+.IP \[bu] 2
+\[dq]eu-east-1\[dq]
+.RS 2
+.IP \[bu] 2
+Poznań, Poland
+.IP \[bu] 2
+Provider: ImpossibleCloud
+.RE
+.IP \[bu] 2
+\[dq]eu-north-1\[dq]
+.RS 2
+.IP \[bu] 2
+Copenhagen, Denmark
+.IP \[bu] 2
+Provider: ImpossibleCloud
+.RE
+.IP \[bu] 2
+\[dq]us-east-1\[dq]
+.RS 2
+.IP \[bu] 2
+New York, USA
+.IP \[bu] 2
+Provider: ImpossibleCloud
+.RE
+.IP \[bu] 2
\[dq]de-fra\[dq]
.RS 2
.IP \[bu] 2
@@ -37083,6 +37650,22 @@ Berlin, Germany
Provider: IONOS
.RE
.IP \[bu] 2
+\[dq]eu-central-3\[dq]
+.RS 2
+.IP \[bu] 2
+Berlin, Germany
+.IP \[bu] 2
+Provider: IONOS
+.RE
+.IP \[bu] 2
+\[dq]eu-central-4\[dq]
+.RS 2
+.IP \[bu] 2
+Frankfurt, Germany
+.IP \[bu] 2
+Provider: IONOS
+.RE
+.IP \[bu] 2
\[dq]eu-south-2\[dq]
.RS 2
.IP \[bu] 2
@@ -37091,6 +37674,14 @@ Logrono, Spain
Provider: IONOS
.RE
.IP \[bu] 2
+\[dq]us-central-1\[dq]
+.RS 2
+.IP \[bu] 2
+Lenexa, USA
+.IP \[bu] 2
+Provider: IONOS
+.RE
+.IP \[bu] 2
\[dq]eu-west-2\[dq]
.RS 2
.IP \[bu] 2
@@ -37657,6 +38248,16 @@ Provider: Synology
\[dq]us-east-1\[dq]
.RS 2
.IP \[bu] 2
+The default region.
+.IP \[bu] 2
+Leave location constraint empty.
+.IP \[bu] 2
+Provider: Zadara
+.RE
+.IP \[bu] 2
+\[dq]us-east-1\[dq]
+.RS 2
+.IP \[bu] 2
Indore, Madhya Pradesh, India
.IP \[bu] 2
Provider: Zata
@@ -37675,7 +38276,7 @@ Config: endpoint
Env Var: RCLONE_S3_ENDPOINT
.IP \[bu] 2
Provider:
-AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cloudflare,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,FlashBlade,GCS,Hetzner,HuaweiOBS,IBMCOS,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Mega,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,Rabata,RackCorp,Rclone,Scaleway,SeaweedFS,Selectel,Servercore,SpectraLogic,StackPath,Storj,Synology,TencentCOS,Wasabi,Zata,Other
+AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cloudflare,Cubbit,DigitalOcean,Dreamhost,Exaba,Fastly,FileLu,FlashBlade,GCS,HCP,Hetzner,HuaweiOBS,IBMCOS,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Mega,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,Rabata,RackCorp,Rclone,Scaleway,SeaweedFS,Selectel,Servercore,SpectraLogic,Storj,Synology,TencentCOS,US3,Wasabi,Zadara,Zata,Other
.IP \[bu] 2
Type: string
.IP \[bu] 2
@@ -38168,6 +38769,16 @@ Cubbit DS3 Object Storage endpoint
Provider: Cubbit
.RE
.IP \[bu] 2
+\[dq]s3.{tenant_name}.cubbit.eu\[dq]
+.RS 2
+.IP \[bu] 2
+Multi-tenant endpoint - replace {tenant_name} with your actual tenant
+name.
+Do not select this directly
+.IP \[bu] 2
+Provider: Cubbit
+.RE
+.IP \[bu] 2
\[dq]syd1.digitaloceanspaces.com\[dq]
.RS 2
.IP \[bu] 2
@@ -38256,6 +38867,70 @@ Dream Objects endpoint
Provider: Dreamhost
.RE
.IP \[bu] 2
+\[dq]au-east-1.object.fastlystorage.app\[dq]
+.RS 2
+.IP \[bu] 2
+AU East 1
+.IP \[bu] 2
+Provider: Fastly
+.RE
+.IP \[bu] 2
+\[dq]eu-central.object.fastlystorage.app\[dq]
+.RS 2
+.IP \[bu] 2
+EU Central
+.IP \[bu] 2
+Provider: Fastly
+.RE
+.IP \[bu] 2
+\[dq]eu-south-1.object.fastlystorage.app\[dq]
+.RS 2
+.IP \[bu] 2
+EU South 1
+.IP \[bu] 2
+Provider: Fastly
+.RE
+.IP \[bu] 2
+\[dq]jp-central-1.object.fastlystorage.app\[dq]
+.RS 2
+.IP \[bu] 2
+JP Central 1
+.IP \[bu] 2
+Provider: Fastly
+.RE
+.IP \[bu] 2
+\[dq]uk-east-1.object.fastlystorage.app\[dq]
+.RS 2
+.IP \[bu] 2
+UK East 1
+.IP \[bu] 2
+Provider: Fastly
+.RE
+.IP \[bu] 2
+\[dq]us-central-1.object.fastlystorage.app\[dq]
+.RS 2
+.IP \[bu] 2
+US Central 1
+.IP \[bu] 2
+Provider: Fastly
+.RE
+.IP \[bu] 2
+\[dq]us-east.object.fastlystorage.app\[dq]
+.RS 2
+.IP \[bu] 2
+US East
+.IP \[bu] 2
+Provider: Fastly
+.RE
+.IP \[bu] 2
+\[dq]us-west.object.fastlystorage.app\[dq]
+.RS 2
+.IP \[bu] 2
+US West
+.IP \[bu] 2
+Provider: Fastly
+.RE
+.IP \[bu] 2
\[dq]s5lu.com\[dq]
.RS 2
.IP \[bu] 2
@@ -38944,6 +39619,62 @@ Singapore Single Site Private Endpoint
Provider: IBMCOS
.RE
.IP \[bu] 2
+\[dq]eu-central-2.storage.impossibleapi.net\[dq]
+.RS 2
+.IP \[bu] 2
+Frankfurt, Germany
+.IP \[bu] 2
+Provider: ImpossibleCloud
+.RE
+.IP \[bu] 2
+\[dq]eu-west-1.storage.impossibleapi.net\[dq]
+.RS 2
+.IP \[bu] 2
+Amsterdam, Netherlands
+.IP \[bu] 2
+Provider: ImpossibleCloud
+.RE
+.IP \[bu] 2
+\[dq]eu-west-2.storage.impossibleapi.net\[dq]
+.RS 2
+.IP \[bu] 2
+London, UK
+.IP \[bu] 2
+Provider: ImpossibleCloud
+.RE
+.IP \[bu] 2
+\[dq]eu-west-3.storage.impossibleapi.net\[dq]
+.RS 2
+.IP \[bu] 2
+Paris, France
+.IP \[bu] 2
+Provider: ImpossibleCloud
+.RE
+.IP \[bu] 2
+\[dq]eu-east-1.storage.impossibleapi.net\[dq]
+.RS 2
+.IP \[bu] 2
+Poznań, Poland
+.IP \[bu] 2
+Provider: ImpossibleCloud
+.RE
+.IP \[bu] 2
+\[dq]eu-north-1.storage.impossibleapi.net\[dq]
+.RS 2
+.IP \[bu] 2
+Copenhagen, Denmark
+.IP \[bu] 2
+Provider: ImpossibleCloud
+.RE
+.IP \[bu] 2
+\[dq]us-east-1.storage.impossibleapi.net\[dq]
+.RS 2
+.IP \[bu] 2
+New York, USA
+.IP \[bu] 2
+Provider: ImpossibleCloud
+.RE
+.IP \[bu] 2
\[dq]de-fra.i3storage.com\[dq]
.RS 2
.IP \[bu] 2
@@ -38952,7 +39683,7 @@ Frankfurt, Germany
Provider: Intercolo
.RE
.IP \[bu] 2
-\[dq]s3-eu-central-1.ionoscloud.com\[dq]
+\[dq]s3.eu-central-1.ionoscloud.com\[dq]
.RS 2
.IP \[bu] 2
Frankfurt, Germany
@@ -38960,7 +39691,15 @@ Frankfurt, Germany
Provider: IONOS
.RE
.IP \[bu] 2
-\[dq]s3-eu-central-2.ionoscloud.com\[dq]
+\[dq]s3.eu-central-2.ionoscloud.com\[dq]
+.RS 2
+.IP \[bu] 2
+Berlin, Germany
+.IP \[bu] 2
+Provider: IONOS
+.RE
+.IP \[bu] 2
+\[dq]s3.eu-central-3.ionoscloud.com\[dq]
.RS 2
.IP \[bu] 2
Berlin, Germany
@@ -38968,7 +39707,15 @@ Berlin, Germany
Provider: IONOS
.RE
.IP \[bu] 2
-\[dq]s3-eu-south-2.ionoscloud.com\[dq]
+\[dq]s3.eu-central-4.ionoscloud.com\[dq]
+.RS 2
+.IP \[bu] 2
+Frankfurt, Germany
+.IP \[bu] 2
+Provider: IONOS
+.RE
+.IP \[bu] 2
+\[dq]s3.eu-south-2.ionoscloud.com\[dq]
.RS 2
.IP \[bu] 2
Logrono, Spain
@@ -38976,6 +39723,14 @@ Logrono, Spain
Provider: IONOS
.RE
.IP \[bu] 2
+\[dq]s3.us-central-1.ionoscloud.com\[dq]
+.RS 2
+.IP \[bu] 2
+Lenexa, USA
+.IP \[bu] 2
+Provider: IONOS
+.RE
+.IP \[bu] 2
\[dq]s3.leviia.com\[dq]
.RS 2
.IP \[bu] 2
@@ -39777,30 +40532,6 @@ Almaty, Kazakhstan
Provider: Servercore
.RE
.IP \[bu] 2
-\[dq]s3.us-east-2.stackpathstorage.com\[dq]
-.RS 2
-.IP \[bu] 2
-US East Endpoint
-.IP \[bu] 2
-Provider: StackPath
-.RE
-.IP \[bu] 2
-\[dq]s3.us-west-1.stackpathstorage.com\[dq]
-.RS 2
-.IP \[bu] 2
-US West Endpoint
-.IP \[bu] 2
-Provider: StackPath
-.RE
-.IP \[bu] 2
-\[dq]s3.eu-central-1.stackpathstorage.com\[dq]
-.RS 2
-.IP \[bu] 2
-EU Endpoint
-.IP \[bu] 2
-Provider: StackPath
-.RE
-.IP \[bu] 2
\[dq]gateway.storjshare.io\[dq]
.RS 2
.IP \[bu] 2
@@ -39993,6 +40724,190 @@ Use Tencent COS Accelerate Endpoint
Provider: TencentCOS
.RE
.IP \[bu] 2
+\[dq]s3-cn-bj.ufileos.com\[dq]
+.RS 2
+.IP \[bu] 2
+North China (Beijing 2)
+.IP \[bu] 2
+Provider: US3
+.RE
+.IP \[bu] 2
+\[dq]s3-cn-wlcb.ufileos.com\[dq]
+.RS 2
+.IP \[bu] 2
+North China (Ulanqab)
+.IP \[bu] 2
+Provider: US3
+.RE
+.IP \[bu] 2
+\[dq]s3-cn-sh2.ufileos.com\[dq]
+.RS 2
+.IP \[bu] 2
+Shanghai
+.IP \[bu] 2
+Provider: US3
+.RE
+.IP \[bu] 2
+\[dq]s3-cn-gd.ufileos.com\[dq]
+.RS 2
+.IP \[bu] 2
+South China (Guangzhou)
+.IP \[bu] 2
+Provider: US3
+.RE
+.IP \[bu] 2
+\[dq]s3-hk.ufileos.com\[dq]
+.RS 2
+.IP \[bu] 2
+Hongkong
+.IP \[bu] 2
+Provider: US3
+.RE
+.IP \[bu] 2
+\[dq]s3-us-ca.ufileos.com\[dq]
+.RS 2
+.IP \[bu] 2
+United States (Los Angeles)
+.IP \[bu] 2
+Provider: US3
+.RE
+.IP \[bu] 2
+\[dq]s3-sg.ufileos.com\[dq]
+.RS 2
+.IP \[bu] 2
+Singapore
+.IP \[bu] 2
+Provider: US3
+.RE
+.IP \[bu] 2
+\[dq]s3-idn-jakarta.ufileos.com\[dq]
+.RS 2
+.IP \[bu] 2
+Indonesia (Jakarta)
+.IP \[bu] 2
+Provider: US3
+.RE
+.IP \[bu] 2
+\[dq]s3-tw-tp.ufileos.com\[dq]
+.RS 2
+.IP \[bu] 2
+Taiwan (Taipei)
+.IP \[bu] 2
+Provider: US3
+.RE
+.IP \[bu] 2
+\[dq]s3-afr-nigeria.ufileos.com\[dq]
+.RS 2
+.IP \[bu] 2
+Nigeria (Lagos)
+.IP \[bu] 2
+Provider: US3
+.RE
+.IP \[bu] 2
+\[dq]s3-bra-saopaulo.ufileos.com\[dq]
+.RS 2
+.IP \[bu] 2
+Brazil (São Paulo)
+.IP \[bu] 2
+Provider: US3
+.RE
+.IP \[bu] 2
+\[dq]s3-uae-dubai.ufileos.com\[dq]
+.RS 2
+.IP \[bu] 2
+United Arab Emirates (Dubai)
+.IP \[bu] 2
+Provider: US3
+.RE
+.IP \[bu] 2
+\[dq]s3-ge-fra.ufileos.com\[dq]
+.RS 2
+.IP \[bu] 2
+Germany (Frankfurt)
+.IP \[bu] 2
+Provider: US3
+.RE
+.IP \[bu] 2
+\[dq]s3-vn-sng.ufileos.com\[dq]
+.RS 2
+.IP \[bu] 2
+Vietnam (Ho Chi Minh City)
+.IP \[bu] 2
+Provider: US3
+.RE
+.IP \[bu] 2
+\[dq]s3-us-ws.ufileos.com\[dq]
+.RS 2
+.IP \[bu] 2
+United States (Washington)
+.IP \[bu] 2
+Provider: US3
+.RE
+.IP \[bu] 2
+\[dq]s3-ind-mumbai.ufileos.com\[dq]
+.RS 2
+.IP \[bu] 2
+India (Mumbai)
+.IP \[bu] 2
+Provider: US3
+.RE
+.IP \[bu] 2
+\[dq]s3-kr-seoul.ufileos.com\[dq]
+.RS 2
+.IP \[bu] 2
+Seoul (South Korea)
+.IP \[bu] 2
+Provider: US3
+.RE
+.IP \[bu] 2
+\[dq]s3-jpn-tky.ufileos.com\[dq]
+.RS 2
+.IP \[bu] 2
+Japan (Tokyo)
+.IP \[bu] 2
+Provider: US3
+.RE
+.IP \[bu] 2
+\[dq]s3-th-bkk.ufileos.com\[dq]
+.RS 2
+.IP \[bu] 2
+Bangkok (Thailand)
+.IP \[bu] 2
+Provider: US3
+.RE
+.IP \[bu] 2
+\[dq]s3-uk-london.ufileos.com\[dq]
+.RS 2
+.IP \[bu] 2
+United Kingdom (London)
+.IP \[bu] 2
+Provider: US3
+.RE
+.IP \[bu] 2
+\[dq]s3-rus-mosc.ufileos.com\[dq]
+.RS 2
+.IP \[bu] 2
+Russia (Moscow)
+.IP \[bu] 2
+Provider: US3
+.RE
+.IP \[bu] 2
+\[dq]s3-cn-guiyang1.ufileos.com\[dq]
+.RS 2
+.IP \[bu] 2
+Guiyang 1
+.IP \[bu] 2
+Provider: US3
+.RE
+.IP \[bu] 2
+\[dq]s3-pk-khi.ufileos.com\[dq]
+.RS 2
+.IP \[bu] 2
+Pakistan
+.IP \[bu] 2
+Provider: US3
+.RE
+.IP \[bu] 2
\[dq]s3.wasabisys.com\[dq]
.RS 2
.IP \[bu] 2
@@ -40129,7 +41044,7 @@ Config: location_constraint
Env Var: RCLONE_S3_LOCATION_CONSTRAINT
.IP \[bu] 2
Provider:
-AWS,ArvanCloud,Ceph,ChinaMobile,DigitalOcean,Dreamhost,Exaba,GCS,Hetzner,IBMCOS,LyveCloud,Minio,Netease,Qiniu,Rabata,RackCorp,SeaweedFS,Synology,Wasabi,Zata,Other
+AWS,ArvanCloud,Ceph,ChinaMobile,DigitalOcean,Dreamhost,Exaba,GCS,HCP,Hetzner,IBMCOS,ImpossibleCloud,LyveCloud,Minio,Netease,Qiniu,Rabata,RackCorp,SeaweedFS,Synology,Wasabi,Zata,Other
.IP \[bu] 2
Type: string
.IP \[bu] 2
@@ -41114,7 +42029,7 @@ Config: acl
Env Var: RCLONE_S3_ACL
.IP \[bu] 2
Provider:
-AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,Hetzner,HuaweiOBS,IBMCOS,IDrive,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,StackPath,TencentCOS,Wasabi,Zata,Other
+AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IBMCOS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,US3,Wasabi,Zata,Other
.IP \[bu] 2
Type: string
.IP \[bu] 2
@@ -41131,7 +42046,7 @@ Owner gets FULL_CONTROL.
No one else has access rights (default).
.IP \[bu] 2
Provider:
-AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,Hetzner,HuaweiOBS,IDrive,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,StackPath,Wasabi,Zata,Other
+AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,US3,Wasabi,Zata,Other
.RE
.IP \[bu] 2
\[dq]public-read\[dq]
@@ -41142,7 +42057,7 @@ Owner gets FULL_CONTROL.
The AllUsers group gets READ access.
.IP \[bu] 2
Provider:
-AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,Hetzner,HuaweiOBS,IDrive,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,StackPath,TencentCOS,Wasabi,Zata,Other
+AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,US3,Wasabi,Zata,Other
.RE
.IP \[bu] 2
\[dq]public-read-write\[dq]
@@ -41155,7 +42070,7 @@ The AllUsers group gets READ and WRITE access.
Granting this on a bucket is generally not recommended.
.IP \[bu] 2
Provider:
-AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,Hetzner,HuaweiOBS,IDrive,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,StackPath,TencentCOS,Wasabi,Zata,Other
+AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,Wasabi,Zata,Other
.RE
.IP \[bu] 2
\[dq]authenticated-read\[dq]
@@ -41166,7 +42081,7 @@ Owner gets FULL_CONTROL.
The AuthenticatedUsers group gets READ access.
.IP \[bu] 2
Provider:
-AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,Hetzner,HuaweiOBS,IDrive,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,StackPath,TencentCOS,Wasabi,Zata,Other
+AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,Wasabi,Zata,Other
.RE
.IP \[bu] 2
\[dq]bucket-owner-read\[dq]
@@ -41180,7 +42095,7 @@ If you specify this canned ACL when creating a bucket, Amazon S3 ignores
it.
.IP \[bu] 2
Provider:
-AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,Hetzner,HuaweiOBS,IDrive,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,StackPath,TencentCOS,Wasabi,Zata,Other
+AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,Wasabi,Zata,Other
.RE
.IP \[bu] 2
\[dq]bucket-owner-full-control\[dq]
@@ -41193,7 +42108,7 @@ If you specify this canned ACL when creating a bucket, Amazon S3 ignores
it.
.IP \[bu] 2
Provider:
-AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,Hetzner,HuaweiOBS,IDrive,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,StackPath,TencentCOS,Wasabi,Zata,Other
+AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,Wasabi,Zata,Other
.RE
.IP \[bu] 2
\[dq]private\[dq]
@@ -41344,7 +42259,7 @@ Config: storage_class
Env Var: RCLONE_S3_STORAGE_CLASS
.IP \[bu] 2
Provider:
-AWS,Alibaba,ArvanCloud,ChinaMobile,Liara,Magalu,Qiniu,Scaleway,TencentCOS
+AWS,Alibaba,ArvanCloud,ChinaMobile,Liara,Magalu,OVHcloud,Qiniu,Scaleway,TencentCOS,US3
.IP \[bu] 2
Type: string
.IP \[bu] 2
@@ -41358,7 +42273,7 @@ Examples:
.IP \[bu] 2
Default
.IP \[bu] 2
-Provider: AWS,Alibaba,ChinaMobile,TencentCOS
+Provider: AWS,Alibaba,ChinaMobile,OVHcloud,TencentCOS,US3
.RE
.IP \[bu] 2
\[dq]STANDARD\[dq]
@@ -41367,7 +42282,7 @@ Provider: AWS,Alibaba,ChinaMobile,TencentCOS
Standard storage class
.IP \[bu] 2
Provider:
-AWS,Alibaba,ArvanCloud,ChinaMobile,Liara,Magalu,Qiniu,TencentCOS
+AWS,Alibaba,ArvanCloud,ChinaMobile,Liara,Magalu,OVHcloud,Qiniu,TencentCOS,US3
.RE
.IP \[bu] 2
\[dq]REDUCED_REDUNDANCY\[dq]
@@ -41383,7 +42298,7 @@ Provider: AWS
.IP \[bu] 2
Standard Infrequent Access storage class
.IP \[bu] 2
-Provider: AWS
+Provider: AWS,OVHcloud
.RE
.IP \[bu] 2
\[dq]ONEZONE_IA\[dq]
@@ -41439,7 +42354,55 @@ Provider: Alibaba,ChinaMobile,Qiniu
.IP \[bu] 2
Infrequent access storage mode
.IP \[bu] 2
-Provider: Alibaba,ChinaMobile,TencentCOS
+Provider: Alibaba,ChinaMobile,TencentCOS,US3
+.RE
+.IP \[bu] 2
+\[dq]EXPRESS_ONEZONE\[dq]
+.RS 2
+.IP \[bu] 2
+High Performance storage class
+.IP \[bu] 2
+Provider: OVHcloud
+.RE
+.IP \[bu] 2
+\[dq]ONEZONE_IA\[dq]
+.RS 2
+.IP \[bu] 2
+Standard Infrequent Access storage class
+.IP \[bu] 2
+Provider: OVHcloud
+.RE
+.IP \[bu] 2
+\[dq]GLACIER\[dq]
+.RS 2
+.IP \[bu] 2
+Active Archive storage class
+.IP \[bu] 2
+Provider: OVHcloud
+.RE
+.IP \[bu] 2
+\[dq]GLACIER_IR\[dq]
+.RS 2
+.IP \[bu] 2
+Active Archive storage class
+.IP \[bu] 2
+Provider: OVHcloud
+.RE
+.IP \[bu] 2
+\[dq]DEEP_ARCHIVE\[dq]
+.RS 2
+.IP \[bu] 2
+Cold Archive storage class
+.IP \[bu] 2
+Provider: OVHcloud
+.RE
+.IP \[bu] 2
+\[dq]INTELLIGENT_TIERING\[dq]
+.RS 2
+.IP \[bu] 2
+Standard storage class
+.IP \[bu] 2
+Provider: OVHcloud
.RE
.IP \[bu] 2
\[dq]LINE\[dq]
@@ -41485,7 +42448,7 @@ Archived storage.
.IP \[bu] 2
Prices are lower, but it needs to be restored first to be accessed.
.IP \[bu] 2
-Available in FR-PAR and NL-AMS regions.
+Available in the FR-PAR region only.
.IP \[bu] 2
Provider: Scaleway
.RE
@@ -41498,7 +42461,7 @@ One Zone - Infrequent Access.
A good choice for storing secondary backup copies or easily re-creatable
data.
.IP \[bu] 2
-Available in the FR-PAR region only.
+Available in all regions.
.IP \[bu] 2
Provider: Scaleway
.RE
@@ -41508,7 +42471,7 @@ Provider: Scaleway
.IP \[bu] 2
Archive storage mode
.IP \[bu] 2
-Provider: TencentCOS
+Provider: TencentCOS,US3
.RE
.RE
.SS --s3-ibm-api-key
@@ -41541,16 +42504,30 @@ Provider: IBMCOS
Type: string
.IP \[bu] 2
Required: false
+.SS --s3-bucket-object-lock-enabled
+.PP
+Enable Object Lock when creating new buckets.
+.PP
+Properties:
+.IP \[bu] 2
+Config: bucket_object_lock_enabled
+.IP \[bu] 2
+Env Var: RCLONE_S3_BUCKET_OBJECT_LOCK_ENABLED
+.IP \[bu] 2
+Type: bool
+.IP \[bu] 2
+Default: false
.SS Advanced options
.PP
Here are the Advanced options specific to s3 (Amazon S3 Compliant
Storage Providers including AWS, Alibaba, ArvanCloud, BizflyCloud, Ceph,
-ChinaMobile, Cloudflare, Cubbit, DigitalOcean, Dreamhost, Exaba, FileLu,
-FlashBlade, GCS, Hetzner, HuaweiOBS, IBMCOS, IDrive, Intercolo, IONOS,
-Leviia, Liara, Linode, LyveCloud, Magalu, Mega, Minio, Netease,
-Outscale, OVHcloud, Petabox, Qiniu, Rabata, RackCorp, Rclone, Scaleway,
-SeaweedFS, Selectel, Servercore, SpectraLogic, StackPath, Storj,
-Synology, TencentCOS, Wasabi, Zata, Other).
+ChinaMobile, Cloudflare, Cubbit, DigitalOcean, Dreamhost, Exaba, Fastly,
+FileLu, FlashBlade, GCS, HCP, Hetzner, HuaweiOBS, IBMCOS, IDrive,
+ImpossibleCloud, Intercolo, IONOS, Leviia, Liara, Linode, LyveCloud,
+Magalu, Mega, Minio, Netease, Outscale, OVHcloud, Petabox, Qiniu,
+Rabata, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Servercore,
+SpectraLogic, Storj, Synology, TencentCOS, US3, Wasabi, Zadara, Zata,
+Other).
.SS --s3-bucket-acl
.PP
Canned ACL used when creating buckets.
@@ -41571,7 +42548,7 @@ Config: bucket_acl
Env Var: RCLONE_S3_BUCKET_ACL
.IP \[bu] 2
Provider:
-AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,Hetzner,HuaweiOBS,IBMCOS,IDrive,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Mega,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,Servercore,StackPath,TencentCOS,Wasabi,Zata,Other
+AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IBMCOS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Mega,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,Servercore,TencentCOS,US3,Wasabi,Zata,Other
.IP \[bu] 2
Type: string
.IP \[bu] 2
@@ -42656,6 +43633,29 @@ Env Var: RCLONE_S3_USE_MULTIPART_UPLOADS
Type: Tristate
.IP \[bu] 2
Default: unset
+.SS --s3-list-versions-oldest-first
+.PP
+Set if the backend returns object versions oldest first.
+.PP
+The S3 standard returns object versions newest first.
+Some backends (e.g.
+Hitachi HCP) return them oldest first instead.
+.PP
+Set this quirk if --s3-version-at or --s3-versions produce incorrect
+results with your backend.
+.PP
+This should be automatically set correctly for all providers rclone
+knows about - please make a bug report if not.
+.PP
+Properties:
+.IP \[bu] 2
+Config: list_versions_oldest_first
+.IP \[bu] 2
+Env Var: RCLONE_S3_LIST_VERSIONS_OLDEST_FIRST
+.IP \[bu] 2
+Type: Tristate
+.IP \[bu] 2
+Default: unset
.SS --s3-use-x-id
.PP
Set if rclone should add x-id URL parameters.
@@ -42781,6 +43781,236 @@ Env Var: RCLONE_S3_SDK_LOG_MODE
Type: Bits
.IP \[bu] 2
Default: Off
+.SS --s3-ibm-iam-endpoint
+.PP
+IBM IAM Endpoint to use for authentication.
+.PP
+Leave blank to use the default public endpoint.
+.PP
+Properties:
+.IP \[bu] 2
+Config: ibm_iam_endpoint
+.IP \[bu] 2
+Env Var: RCLONE_S3_IBM_IAM_ENDPOINT
+.IP \[bu] 2
+Provider: IBMCOS
+.IP \[bu] 2
+Type: string
+.IP \[bu] 2
+Required: false
+.SS --s3-object-lock-mode
+.PP
+Object Lock mode to apply when uploading or copying objects.
+.PP
+Set this to apply Object Lock retention mode to objects.
+If not set, no Object Lock mode is applied (even with --metadata).
+.PP
+Note: To enable Object Lock retention, you must set BOTH
+object_lock_mode AND object_lock_retain_until_date.
+Setting only one has no effect.
+.IP \[bu] 2
+GOVERNANCE: Set Object Lock mode to GOVERNANCE
+.IP \[bu] 2
+COMPLIANCE: Set Object Lock mode to COMPLIANCE
+.IP \[bu] 2
+copy: Copy the mode from the source object (requires --metadata)
+.PP
+See:
+https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html
+.PP
+Properties:
+.IP \[bu] 2
+Config: object_lock_mode
+.IP \[bu] 2
+Env Var: RCLONE_S3_OBJECT_LOCK_MODE
+.IP \[bu] 2
+Type: string
+.IP \[bu] 2
+Required: false
+.IP \[bu] 2
+Examples:
+.RS 2
+.IP \[bu] 2
+\[dq]GOVERNANCE\[dq]
+.RS 2
+.IP \[bu] 2
+Set Object Lock mode to GOVERNANCE
+.RE
+.IP \[bu] 2
+\[dq]COMPLIANCE\[dq]
+.RS 2
+.IP \[bu] 2
+Set Object Lock mode to COMPLIANCE
+.RE
+.IP \[bu] 2
+\[dq]copy\[dq]
+.RS 2
+.IP \[bu] 2
+Copy from source object (requires --metadata)
+.RE
+.RE
+.SS --s3-object-lock-retain-until-date
+.PP
+Object Lock retention until date to apply when uploading or copying
+objects.
+.PP
+Set this to apply Object Lock retention date to objects.
+If not set, no retention date is applied (even with --metadata).
+.PP
+Note: To enable Object Lock retention, you must set BOTH
+object_lock_mode AND object_lock_retain_until_date.
+Setting only one has no effect.
+.PP
+Accepts: - RFC 3339 format: 2030-01-02T15:04:05Z - Duration from now:
+365d, 1y, 6M (days, years, months) - copy: Copy the date from the source
+object (requires --metadata)
+.PP
+See:
+https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html
+.PP
+Properties:
+.IP \[bu] 2
+Config: object_lock_retain_until_date
+.IP \[bu] 2
+Env Var: RCLONE_S3_OBJECT_LOCK_RETAIN_UNTIL_DATE
+.IP \[bu] 2
+Type: string
+.IP \[bu] 2
+Required: false
+.IP \[bu] 2
+Examples:
+.RS 2
+.IP \[bu] 2
+\[dq]copy\[dq]
+.RS 2
+.IP \[bu] 2
+Copy from source object (requires --metadata)
+.RE
+.IP \[bu] 2
+\[dq]2030-01-01T00:00:00Z\[dq]
+.RS 2
+.IP \[bu] 2
+Set specific date (RFC 3339 format)
+.RE
+.IP \[bu] 2
+\[dq]365d\[dq]
+.RS 2
+.IP \[bu] 2
+Set retention for 365 days from now
+.RE
+.IP \[bu] 2
+\[dq]1y\[dq]
+.RS 2
+.IP \[bu] 2
+Set retention for 1 year from now
+.RE
+.RE
+.SS --s3-object-lock-legal-hold-status
+.PP
+Object Lock legal hold status to apply when uploading or copying
+objects.
+.PP
+Set this to apply Object Lock legal hold to objects.
+If not set, no legal hold is applied (even with --metadata).
+.PP
+Note: Legal hold is independent of retention and can be set separately.
+.IP \[bu] 2
+ON: Enable legal hold
+.IP \[bu] 2
+OFF: Disable legal hold
+.IP \[bu] 2
+copy: Copy the legal hold status from the source object (requires
+--metadata)
+.PP
+See:
+https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html
+.PP
+Properties:
+.IP \[bu] 2
+Config: object_lock_legal_hold_status
+.IP \[bu] 2
+Env Var: RCLONE_S3_OBJECT_LOCK_LEGAL_HOLD_STATUS
+.IP \[bu] 2
+Type: string
+.IP \[bu] 2
+Required: false
+.IP \[bu] 2
+Examples:
+.RS 2
+.IP \[bu] 2
+\[dq]ON\[dq]
+.RS 2
+.IP \[bu] 2
+Enable legal hold
+.RE
+.IP \[bu] 2
+\[dq]OFF\[dq]
+.RS 2
+.IP \[bu] 2
+Disable legal hold
+.RE
+.IP \[bu] 2
+\[dq]copy\[dq]
+.RS 2
+.IP \[bu] 2
+Copy from source object (requires --metadata)
+.RE
+.RE
+.SS --s3-bypass-governance-retention
+.PP
+Allow deleting or modifying objects locked with GOVERNANCE mode.
+.PP
+Properties:
+.IP \[bu] 2
+Config: bypass_governance_retention
+.IP \[bu] 2
+Env Var: RCLONE_S3_BYPASS_GOVERNANCE_RETENTION
+.IP \[bu] 2
+Type: bool
+.IP \[bu] 2
+Default: false
+.SS --s3-object-lock-set-after-upload
+.PP
+Set Object Lock via separate API calls after upload.
+.PP
+Use this for S3-compatible providers that don\[aq]t support setting
+Object Lock headers during PUT operations.
+When enabled, Object Lock is set via separate PutObjectRetention and
+PutObjectLegalHold API calls after the upload completes.
+.PP
+This adds extra API calls per object, so only enable if your provider
+requires it.
+.PP
+Properties:
+.IP \[bu] 2
+Config: object_lock_set_after_upload
+.IP \[bu] 2
+Env Var: RCLONE_S3_OBJECT_LOCK_SET_AFTER_UPLOAD
+.IP \[bu] 2
+Type: bool
+.IP \[bu] 2
+Default: false
+.SS --s3-object-lock-supported
+.PP
+Whether the provider supports S3 Object Lock.
+.PP
+This should be true, false or left unset to use the default for the
+provider.
+.PP
+Set to false for providers that don\[aq]t fully support the S3 Object
+Lock API (e.g.
+GCS which uses non-standard headers for bypass governance retention and
+doesn\[aq]t implement Legal Hold via the S3 API).
+.PP
+Properties:
+.IP \[bu] 2
+Config: object_lock_supported
+.IP \[bu] 2
+Env Var: RCLONE_S3_OBJECT_LOCK_SUPPORTED
+.IP \[bu] 2
+Type: Tristate
+.IP \[bu] 2
+Default: unset
.SS --s3-description
.PP
Description of the remote.
@@ -42895,6 +44125,39 @@ T}@T{
N
T}
T{
+object-lock-legal-hold-status
+T}@T{
+Object Lock legal hold status: ON or OFF
+T}@T{
+string
+T}@T{
+OFF
+T}@T{
+N
+T}
+T{
+object-lock-mode
+T}@T{
+Object Lock mode: GOVERNANCE or COMPLIANCE
+T}@T{
+string
+T}@T{
+GOVERNANCE
+T}@T{
+N
+T}
+T{
+object-lock-retain-until-date
+T}@T{
+Object Lock retention until date
+T}@T{
+RFC 3339
+T}@T{
+2030-01-02T15:04:05Z
+T}@T{
+N
+T}
+T{
tier
T}@T{
Tier of the object
@@ -43921,7 +45184,7 @@ Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
\&...
-XX / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, China Mobile, Cloudflare, ArvanCloud, DigitalOcean, Dreamhost, Huawei OBS, IBM COS, Lyve Cloud, Minio, Magalu, Netease, RackCorp, Scaleway, SeaweedFS, StackPath, Storj, Synology, Tencent COS and Wasabi
+XX / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, China Mobile, Cloudflare, ArvanCloud, DigitalOcean, Dreamhost, Huawei OBS, IBM COS, Lyve Cloud, Minio, Magalu, Netease, RackCorp, Scaleway, SeaweedFS, Storj, Synology, Tencent COS and Wasabi
\[rs] (s3)
\&...
Storage> s3
@@ -44022,6 +45285,9 @@ They will be needed when prompted by \f[V]rclone config\f[R].
.PP
Default region will correspond to \f[V]eu-west-1\f[R] and the endpoint
has to be specified as \f[V]s3.cubbit.eu\f[R].
+If you set a custom tenant endpoint, you must use
+\f[V]s3.{tenant_name}.cubbit.eu\f[R], because the generic
+\f[V]s3.cubbit.eu\f[R] endpoint will not work in this case.
.PP
Going through the whole process of creating a new remote by running
\f[V]rclone config\f[R], each prompt should be answered as shown below:
@@ -44035,7 +45301,7 @@ env_auth> false
access_key_id> YOUR_ACCESS_KEY
secret_access_key> YOUR_SECRET_KEY
region> eu-west-1 (or leave empty)
-endpoint> s3.cubbit.eu
+endpoint> s3.cubbit.eu (or s3.{tenant_name}.cubbit.eu)
acl>
\f[R]
.fi
@@ -44234,6 +45500,98 @@ secret_access_key = XXX
endpoint = http://127.0.0.1:9000/
\f[R]
.fi
+.SS Fastly Object Storage
+.PP
+Fastly Object Storage (https://www.fastly.com/products/storage) is an
+S3-compatible object storage service from Fastly.
+It provides three regions (US East, US West, and EU Central) with
+mandatory server-side encryption.
+.PP
+Here is an example of making a configuration.
+First run:
+.IP
+.nf
+\f[C]
+rclone config
+\f[R]
+.fi
+.PP
+This will guide you through an interactive setup process.
+.IP
+.nf
+\f[C]
+No remotes found, make a new one?
+n) New remote
+s) Set configuration password
+q) Quit config
+n/s/q> n
+
+Enter name for new remote.
+name> fastly
+
+Option Storage.
+Type of storage to configure.
+Storage> s3
+
+Option provider.
+Choose your S3 provider.
+provider> Fastly
+
+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.
+env_auth> false
+
+Option access_key_id.
+AWS Access Key ID.
+access_key_id> YOUR_ACCESS_KEY
+
+Option secret_access_key.
+AWS Secret Access Key (password).
+secret_access_key> YOUR_SECRET_KEY
+
+Option region.
+Region where your bucket will be created and your data stored.
+region> us-east
+
+Option endpoint.
+Endpoint for S3 API.
+endpoint> us-east.object.fastlystorage.app
+
+Edit advanced config?
+y) Yes
+n) No (default)
+y/n> n
+
+Configuration complete.
+Options:
+- type: s3
+- provider: Fastly
+- access_key_id: YOUR_ACCESS_KEY
+- secret_access_key: YOUR_SECRET_KEY
+- region: us-east
+- endpoint: us-east.object.fastlystorage.app
+Keep this \[dq]fastly\[dq] remote?
+y) Yes this is OK (default)
+e) Edit this remote
+d) Delete this remote
+y/e/d> y
+\f[R]
+.fi
+.PP
+The resulting configuration file should look like:
+.IP
+.nf
+\f[C]
+[fastly]
+type = s3
+provider = Fastly
+access_key_id = YOUR_ACCESS_KEY
+secret_access_key = YOUR_SECRET_KEY
+region = us-east
+endpoint = us-east.object.fastlystorage.app
+\f[R]
+.fi
.SS Google Cloud Storage
.PP
GoogleCloudStorage (https://cloud.google.com/storage/docs) is an
@@ -44296,7 +45654,7 @@ 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, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, GCS, Hetzner, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, StackPath, Storj, Synology, TencentCOS, Wasabi, Qiniu and others
+ XX / Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, GCS, Hetzner, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Storj, Synology, TencentCOS, Wasabi, Qiniu and others
\[rs] (s3)
[snip]
Storage> s3
@@ -44419,6 +45777,144 @@ endpoint = hel1.your-objectstorage.com
acl = private
\f[R]
.fi
+.SS Hitachi Content Platform (HCP)
+.PP
+Here is an example of making a Hitachi Content Platform
+(HCP) (https://www.hitachivantara.com/en-us/products/storage/content-platform.html)
+configuration.
+First run:
+.IP
+.nf
+\f[C]
+rclone config
+\f[R]
+.fi
+.PP
+This will guide you through an interactive setup process.
+.IP
+.nf
+\f[C]
+No remotes found, make a new one?
+n) New remote
+s) Set configuration password
+q) Quit config
+n/s/q> n
+
+Enter name for new remote.
+name> my-hcp
+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, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, GCS, HCP, Hetzner, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Storj, Synology, TencentCOS, Wasabi, Qiniu and others
+ \[rs] (s3)
+[snip]
+Storage> s3
+Option provider.
+Choose your S3 provider.
+Choose a number from below, or type in your own value.
+Press Enter to leave empty.
+[snip]
+XX / Hitachi Content Platform (HCP)
+ \[rs] (HCP)
+[snip]
+provider> HCP
+Option env_auth.
+Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).
+Only applies if access_key_id and secret_access_key is blank.
+Choose a number from below, or type in your own boolean value (true or false).
+Press Enter for the default (false).
+ 1 / Enter AWS credentials in the next step.
+ \[rs] (false)
+ 2 / Get AWS credentials from the environment (env vars or IAM).
+ \[rs] (true)
+env_auth>
+Option access_key_id.
+AWS Access Key ID.
+Leave blank for anonymous access or runtime credentials.
+Enter a value. Press Enter to leave empty.
+access_key_id> ACCESS_KEY
+Option secret_access_key.
+AWS Secret Access Key (password).
+Leave blank for anonymous access or runtime credentials.
+Enter a value. Press Enter to leave empty.
+secret_access_key> SECRET_KEY
+Option endpoint.
+Endpoint for HCP S3 compatible API.
+Enter a value. Press Enter to leave empty.
+endpoint> https://hcp.example.com
+Edit advanced config?
+y) Yes
+n) No (default)
+y/n>
+Configuration complete.
+Options:
+- type: s3
+- provider: HCP
+- access_key_id: ACCESS_KEY
+- secret_access_key: SECRET_KEY
+- endpoint: https://hcp.example.com
+Keep this \[dq]my-hcp\[dq] remote?
+y) Yes this is OK (default)
+e) Edit this remote
+d) Delete this remote
+y/e/d>
+Current remotes:
+
+Name Type
+==== ====
+my-hcp 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>
+\f[R]
+.fi
+.PP
+This will leave the config file looking like this.
+.IP
+.nf
+\f[C]
+[my-hcp]
+type = s3
+provider = HCP
+access_key_id = ACCESS_KEY
+secret_access_key = SECRET_KEY
+endpoint = https://hcp.example.com
+\f[R]
+.fi
+.SS Known limitations
+.PP
+These limitations have been observed with HCP version 9.7.x.
+.PP
+\f[B]Automatic directory objects\f[R]
+.PP
+HCP automatically creates zero-byte directory objects (keys ending in
+\f[V]/\f[R]) for every path component when an object is stored.
+These directory objects are managed by HCP internally: deleting one via
+the S3 API does not remove it but instead creates a delete marker with a
+special version ID (\f[V]-3\f[R]) that cannot itself be deleted.
+As a result, rclone cannot fully purge a bucket on HCP \[em] leftover
+directory objects will remain after a \f[V]purge\f[R] or
+\f[V]delete\f[R] operation.
+.PP
+\f[B]Transparent gzip decompression\f[R]
+.PP
+HCP transparently
+decompresses (https://docs.hitachivantara.com/r/en-us/content-platform/9.6.x/mk-95hcph002/using-the-hitachi-api-for-amazon-s3/working-with-objects/creating-an-object)
+objects uploaded with \f[V]Content-Encoding: gzip\f[R] before storing
+them.
+This means the stored object contains the raw (uncompressed) data, while
+the \f[V]Content-MD5\f[R] sent by rclone was computed over the
+compressed bytes.
+HCP will reject such uploads with a \f[V]BadDigest\f[R] error.
+To avoid this, do not set \f[V]content-encoding: gzip\f[R] in object
+metadata when using HCP.
.SS Huawei OBS
.PP
Object Storage Service (OBS) provides stable, secure, efficient, and
@@ -44946,6 +46442,187 @@ d) Delete this remote
y/e/d> y
\f[R]
.fi
+.SS Impossible Cloud
+.PP
+Impossible Cloud (https://www.impossiblecloud.com/) is a European
+S3-compatible object storage provider with regions in Europe and the US.
+.PP
+Note: Impossible Cloud does not preserve the \f[V]Cache-Control\f[R],
+\f[V]Content-Disposition\f[R], \f[V]Content-Encoding\f[R] or
+\f[V]Content-Language\f[R] system metadata fields on retrieval, even
+when they were set at upload time.
+Because the \f[V]Content-Encoding\f[R] response header is also dropped,
+the \f[V]--s3-decompress\f[R] flag has no effect on objects stored
+there.
+Other metadata such as \f[V]Content-Type\f[R] and the modification time
+round-trip normally.
+.PP
+Here is an example of making an Impossible Cloud configuration.
+First run:
+.IP
+.nf
+\f[C]
+rclone config
+\f[R]
+.fi
+.PP
+This will guide you through an interactive setup process.
+.IP
+.nf
+\f[C]
+No remotes found, make a new one?
+n) New remote
+s) Set configuration password
+q) Quit config
+n/s/q> n
+
+Enter name for new remote.
+name> my-impossible-cloud
+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, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, GCS, Hetzner, HuaweiOBS, IBMCOS, IDrive, ImpossibleCloud, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Storj, Synology, TencentCOS, Wasabi, Qiniu and others
+ \[rs] (s3)
+[snip]
+Storage> s3
+Option provider.
+Choose your S3 provider.
+Choose a number from below, or type in your own value.
+Press Enter to leave empty.
+[snip]
+XX / Impossible Cloud Object Storage
+ \[rs] (ImpossibleCloud)
+[snip]
+provider> ImpossibleCloud
+Option env_auth.
+Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).
+Only applies if access_key_id and secret_access_key is blank.
+Choose a number from below, or type in your own boolean value (true or false).
+Press Enter for the default (false).
+ 1 / Enter AWS credentials in the next step.
+ \[rs] (false)
+ 2 / Get AWS credentials from the environment (env vars or IAM).
+ \[rs] (true)
+env_auth>
+Option access_key_id.
+AWS Access Key ID.
+Leave blank for anonymous access or runtime credentials.
+Enter a value. Press Enter to leave empty.
+access_key_id> ACCESS_KEY
+Option secret_access_key.
+AWS Secret Access Key (password).
+Leave blank for anonymous access or runtime credentials.
+Enter a value. Press Enter to leave empty.
+secret_access_key> SECRET_KEY
+Option region.
+Region to connect to.
+Choose a number from below, or type in your own value.
+Press Enter to leave empty.
+ 1 / Frankfurt, Germany
+ \[rs] (eu-central-2)
+ 2 / Amsterdam, Netherlands
+ \[rs] (eu-west-1)
+ 3 / London, UK
+ \[rs] (eu-west-2)
+ 4 / Paris, France
+ \[rs] (eu-west-3)
+ 5 / Poznań, Poland
+ \[rs] (eu-east-1)
+ 6 / Copenhagen, Denmark
+ \[rs] (eu-north-1)
+ 7 / New York, USA
+ \[rs] (us-east-1)
+region> 1
+Option endpoint.
+Endpoint for Impossible Cloud Object Storage
+Choose a number from below, or type in your own value.
+Press Enter to leave empty.
+ 1 / Frankfurt, Germany
+ \[rs] (eu-central-2.storage.impossibleapi.net)
+ 2 / Amsterdam, Netherlands
+ \[rs] (eu-west-1.storage.impossibleapi.net)
+ 3 / London, UK
+ \[rs] (eu-west-2.storage.impossibleapi.net)
+ 4 / Paris, France
+ \[rs] (eu-west-3.storage.impossibleapi.net)
+ 5 / Poznań, Poland
+ \[rs] (eu-east-1.storage.impossibleapi.net)
+ 6 / Copenhagen, Denmark
+ \[rs] (eu-north-1.storage.impossibleapi.net)
+ 7 / New York, USA
+ \[rs] (us-east-1.storage.impossibleapi.net)
+endpoint> 1
+Option location_constraint.
+Location constraint - must be set to match the Region.
+Leave blank if not sure. Used when creating buckets only.
+Enter a value. Press Enter to leave empty.
+location_constraint>
+Option acl.
+Canned ACL used when creating buckets and storing or copying objects.
+This ACL is used for creating objects and if bucket_acl isn\[aq]t set, for creating buckets too.
+For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl
+Note that this ACL is applied when server-side copying objects as S3
+doesn\[aq]t copy the ACL from the source but rather writes a fresh one.
+If the acl is an empty string then no X-Amz-Acl: header is added and
+the default (private) will be used.
+Choose a number from below, or type in your own value.
+Press Enter to leave empty.
+ / Owner gets FULL_CONTROL.
+ 1 | No one else has access rights (default).
+ \[rs] (private)
+ / Owner gets FULL_CONTROL.
+ 2 | The AllUsers group gets READ access.
+ \[rs] (public-read)
+acl>
+Edit advanced config?
+y) Yes
+n) No (default)
+y/n>
+Configuration complete.
+Options:
+- type: s3
+- provider: ImpossibleCloud
+- access_key_id: ACCESS_KEY
+- secret_access_key: SECRET_KEY
+- region: eu-central-2
+- endpoint: eu-central-2.storage.impossibleapi.net
+Keep this \[dq]my-impossible-cloud\[dq] remote?
+y) Yes this is OK (default)
+e) Edit this remote
+d) Delete this remote
+y/e/d>
+Current remotes:
+
+Name Type
+==== ====
+my-impossible-cloud 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>
+\f[R]
+.fi
+.PP
+This will leave the config file looking like this.
+.IP
+.nf
+\f[C]
+[my-impossible-cloud]
+type = s3
+provider = ImpossibleCloud
+access_key_id = ACCESS_KEY
+secret_access_key = SECRET_KEY
+region = eu-central-2
+endpoint = eu-central-2.storage.impossibleapi.net
+acl = private
+\f[R]
+.fi
.SS Intercolo Object Storage
.PP
Intercolo Object Storage (https://intercolo.de/object-storage) offers
@@ -46286,7 +47963,7 @@ 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, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, GCS, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, OVHcloud, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, StackPath, Storj, Synology, TencentCOS, Wasabi, Qiniu and others
+ XX / Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, GCS, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, OVHcloud, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Storj, Synology, TencentCOS, Wasabi, Qiniu and others
\[rs] (s3)
[...]
Storage> s3
@@ -46676,7 +48353,7 @@ Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
[snip]
- 4 / Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, FlashBlade, GCS, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, StackPath, Storj, Synology, TencentCOS, Wasabi, Qiniu and others
+ 4 / Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, FlashBlade, GCS, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Storj, Synology, TencentCOS, Wasabi, Qiniu and others
\[rs] (s3)
[snip]
Storage> s3
@@ -48333,6 +50010,176 @@ cos s3
\f[R]
.fi
.RE
+.SS Tencent COS Global Acceleration Endpoint
+.PP
+When using the Global Acceleration Endpoint
+(\f[V]cos.accelerate.myqcloud.com\f[R]), rclone automatically sets
+\f[V]no_check_bucket = true\f[R] because this acceleration endpoint does
+not support the \f[V]CreateBucket\f[R] call which is used for ensuring a
+bucket\[aq]s existence by rclone.
+Global Acceleration is a per-bucket feature, so you should first create
+the bucket in one physical region, then enable it in the Tencent Cloud
+console.
+.SS US3
+.PP
+US3 (https://www.ucloud.cn/site/product/ufile.html) Object Storage is a
+service that provides cloud storage for unstructured files for internet
+applications.
+.PP
+To configure access to US3, follow the steps below: 1.
+First run:
+\f[V]console rclone config No remotes found, make a new one? n) New remote s) Set configuration password q) Quit config n/s/q> n\f[R]
+2.
+Give the name of the configuration.
+For example, name it \[aq]US3\[aq].
+.IP
+.nf
+\f[C]
+name> US3
+\f[R]
+.fi
+.IP "3." 3
+Select \f[V]s3\f[R] storage.
+.RS 4
+.IP
+.nf
+\f[C]
+Choose a number from below, or type in your own value
+[snip]
+XX / Amazon S3 Compliant Storage Providers including AWS, ...
+ \[rs] \[dq]s3\[dq]
+[snip]
+Storage> s3
+\f[R]
+.fi
+.RE
+.IP "4." 3
+Select \f[V]US3\f[R] provider.
+.RS 4
+.IP
+.nf
+\f[C]
+ Choose a number from below, or type in your own value.
+ XX / Amazon Web Services (AWS) S3
+ \[rs] (AWS)
+ [snip]
+ XX / UCloud Object Storage (US3)
+ \[rs] (US3)
+ [snip]
+ provider> US3
+\f[R]
+.fi
+.RE
+.IP "5." 3
+Enter your SecretId and SecretKey of US3.
+.RS 4
+.IP
+.nf
+\f[C]
+Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).
+Only applies if access_key_id and secret_access_key is blank.
+Choose a number from below, or type in your own boolean value (true or false).
+Press Enter for the default (false).
+Choose a number from below, or type in your own value
+ 1 / Enter AWS credentials in the next step
+ \[rs] \[dq]false\[dq]
+ 2 / Get AWS credentials from the environment (env vars or IAM)
+ \[rs] \[dq]true\[dq]
+env_auth> 1
+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> AKIDxxxxxxxxxx
+AWS Secret Access Key (password)
+Leave blank for anonymous access or runtime credentials.
+Enter a string value. Press Enter for the default (\[dq]\[dq]).
+secret_access_key> xxxxxxxxxxx
+\f[R]
+.fi
+.RE
+.IP "6." 3
+Select endpoint.
+.RS 4
+.IP
+.nf
+\f[C]
+ Option endpoint.
+ Endpoint for S3 API.
+ Required when using an S3 clone.
+ Choose a number from below, or type in your own value.
+ Press Enter to leave empty.
+ 1 / North China (Beijing 2).
+ \[rs] \[dq]s3-cn-bj.ufileos.com\[dq]
+ 2 / North China (Ulanqab).
+ \[rs] \[dq]s3-cn-wlcb.ufileos.com\[dq]
+ 3 / Shanghai.
+ \[rs] \[dq]s3-cn-sh2.ufileos.com\[dq]
+ 4 / South China (Guangzhou).
+ \[rs] \[dq]s3-cn-gd.ufileos.com\[dq]
+[snip]
+endpoint> 1
+\f[R]
+.fi
+.RE
+.IP "7." 3
+Choose acl and storage class.
+.RS 4
+.IP
+.nf
+\f[C]
+Option acl.
+Canned ACL used when creating buckets and storing or copying objects.
+This ACL is used for creating objects and if bucket_acl isn\[aq]t set, for creating buckets too.
+For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl
+Note that this ACL is applied when server-side copying objects as S3
+doesn\[aq]t copy the ACL from the source but rather writes a fresh one.
+If the acl is an empty string then no X-Amz-Acl: header is added and
+the default (private) will be used.
+Choose a number from below, or type in your own value.
+Press Enter to leave empty.
+ / Owner gets FULL_CONTROL.
+1 | No one else has access rights (default).
+ \[rs] (private)
+ / Owner gets FULL_CONTROL.
+2 | The AllUsers group gets READ access.
+ \[rs] (public-read)
+acl> 1
+
+The storage class to use when storing new objects in US3.
+Enter a string value. Press Enter for the default (\[dq]\[dq]).
+Choose a number from below, or type in your own value
+ 1 / Default
+ \[rs] \[dq]\[dq]
+[snip]
+storage_class> 1
+Edit advanced config? (y/n)
+y) Yes
+n) No (default)
+y/n> n
+
+ Configuration complete.
+ Options:
+ - type: s3
+ - provider: US3
+ - access_key_id: xx
+ - secret_access_key: xx
+ - endpoint: s3-cn-bj.ufileos.com
+ - acl: private
+
+ Keep this \[dq]US3\[dq] remote?
+ y) Yes this is OK (default)
+ e) Edit this remote
+ d) Delete this remote
+ y/e/d> y
+ Current remotes:
+
+ Name Type
+ ==== ====
+ US3 s3
+\f[R]
+.fi
+.RE
.SS Wasabi
.PP
Wasabi (https://wasabi.com) is a cloud-based object storage service for
@@ -48450,6 +50297,130 @@ server_side_encryption =
storage_class =
\f[R]
.fi
+.SS Zadara Object Storage
+.PP
+Zadara Object Storage (https://www.zadara.com) is a fully-managed,
+enterprise-grade, S3-compatible storage solution that provides scalable,
+multi-tenant object storage with flexible deployment options (on-prem,
+hybrid, or cloud).
+.PP
+Zadara Object Storage can be configured using \f[V]rclone config\f[R]
+with \f[V]s3\f[R] as the type and \f[V]Zadara\f[R] as the provider name.
+Here is an example run of the configurator.
+.PP
+Authentication and endpoint information, including the region field,
+should be fetched from Zadara\[cq]s Object Storage management interface
+.PP
+To configure access to Zadara Object Storage, first run:
+.IP
+.nf
+\f[C]
+rclone config
+\f[R]
+.fi
+.IP
+.nf
+\f[C]
+This will guide you through an interactive setup process:
+
+No remotes found, make a new one\[rs]?
+n) New remote
+s) Set configuration password
+n/s> n
+
+Enter name for new remote.
+name> Zadara-Object-Storage
+
+Option Storage.
+Type of storage to configure.
+Choose a number from below, or type in your own value.
+
+ XX / Amazon S3 Compliant Storage Providers including AWS ...
+ \[rs] (s3)
+
+Storage> s3
+
+Option provider.
+Choose your S3 provider.
+Choose a number from below, or type in your own value.
+Press Enter to leave empty.
+
+XX / Zadara Object Storage
+ \[rs] (Zadara)
+
+provider> Zadara
+
+Option env_auth.
+Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).
+Only applies if access_key_id and secret_access_key is blank.
+Choose a number from below, or type in your own boolean value (true or false).
+Press Enter for the default (false).
+ 1 / Enter AWS credentials in the next step.
+ \[rs] (false)
+ 2 / Get AWS credentials from the environment (env vars or IAM).
+ \[rs] (true)
+env_auth>
+
+Option access_key_id.
+AWS Access Key ID.
+Leave blank for anonymous access or runtime credentials.
+Enter a value. Press Enter to leave empty.
+access_key_id> S3_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> S3_SECRET_KEY
+
+Option region.
+Region to connect to.
+Leave blank if you are using an S3 clone and you don\[aq]t have a region.
+Choose a number from below, or type in your own value.
+Press Enter to leave empty.
+ / The default region.
+ 1 | Leave location constraint empty.
+ \[rs] (us-east-1)
+region>
+
+Option endpoint.
+Endpoint for S3 API.
+Required when using an S3 clone.
+Enter a value. Press Enter to leave empty.
+endpoint> https://vsa-00000001-public-zadara-cloud-01.zadarazios.com
+
+Edit advanced config?
+y) Yes
+n) No (default)
+y/n>
+
+Configuration complete.
+Options:
+- type: s3
+- provider: Zadara
+- access_key_id: S3_ACCESS_KEY
+- secret_access_key: S3_SECRET_KEY
+- endpoint: https://vsa-00000001-public-zadara-cloud-01.zadarazios.com
+Keep this \[dq]Zadara-Object-Storage\[dq] remote?
+y) Yes this is OK (default)
+e) Edit this remote
+d) Delete this remote
+y/e/d> y
+\f[R]
+.fi
+.PP
+This will leave the config file looking like this.
+.IP
+.nf
+\f[C]
+[Zadara-Object-Storage]
+type = s3
+provider = Zadara
+access_key_id = S3_ACCESS_KEY
+secret_access_key = S3_SECRET_KEY
+endpoint = https://vsa-00000001-public-zadara-cloud-01.zadarazios.com
+\f[R]
+.fi
.SS Zata Object Storage
.PP
Zata Object Storage (https://zata.ai/) provides a secure, S3-compatible
@@ -56514,6 +58485,34 @@ Required: true
.SS Advanced options
.PP
Here are the Advanced options specific to filelu (FileLu Cloud Storage).
+.SS --filelu-upload-cutoff
+.PP
+Cutoff for switching to chunked upload.
+Any files larger than this will be uploaded in chunks of chunk_size.
+.PP
+Properties:
+.IP \[bu] 2
+Config: upload_cutoff
+.IP \[bu] 2
+Env Var: RCLONE_FILELU_UPLOAD_CUTOFF
+.IP \[bu] 2
+Type: SizeSuffix
+.IP \[bu] 2
+Default: 500Mi
+.SS --filelu-chunk-size
+.PP
+Chunk size to use for uploading.
+Used for multipart uploads.
+.PP
+Properties:
+.IP \[bu] 2
+Config: chunk_size
+.IP \[bu] 2
+Env Var: RCLONE_FILELU_CHUNK_SIZE
+.IP \[bu] 2
+Type: SizeSuffix
+.IP \[bu] 2
+Default: 64Mi
.SS --filelu-encoding
.PP
The encoding for the backend.
@@ -56563,6 +58562,10 @@ CLI (https://github.com/FilenCloudDienste/filen-cli).
This means you must first download the CLI, login, and then run the
\f[V]export-api-key\f[R] command.
.PP
+\f[B]Note:\f[R] If you change your Filen account password, you will need
+to update your rclone configuration with the new password and a
+re-exported API key (via \f[V]export-api-key\f[R]).
+.PP
Here is an example of how to make a remote called \f[V]FilenRemote\f[R].
First run:
.IP
@@ -62209,6 +64212,10 @@ confirm.
Add yourself as a test user if you haven\[aq]t already.
.IP "10." 4
Provide the noted client ID and client secret to rclone.
+.IP "11." 4
+Run the web-based authorization flow from within
+\f[V]rclone config\f[R], by answering \[dq]Y\[dq] when it asks
+\[dq]Already have a token - refresh?\[dq].
.PP
Be aware that, due to the \[dq]enhanced security\[dq] recently
introduced by Google, you are theoretically expected to \[dq]submit your
@@ -63441,6 +65448,733 @@ All local paths are treated as aliases into the \f[V]local\f[R] backend
(unless encrypted or chunked) and stored in
\f[V]\[ti]/.cache/rclone/kv/local\[ti]hasher.bolt\f[R].
Databases can be shared between multiple rclone processes.
+.SH Huawei Drive
+.PP
+Paths are specified as \f[V]huaweidrive:path\f[R]
+.PP
+Huawei Drive paths may be as deep as required, e.g.
+\f[V]huaweidrive:directory/subdirectory\f[R].
+.SS Configuration
+.PP
+The initial setup for Huawei Drive involves getting a token from Huawei
+Drive which you need to do in your browser.
+\f[V]rclone config\f[R] walks you through it.
+.PP
+Here is an example of how to make a remote called \f[V]remote\f[R].
+First run:
+.IP
+.nf
+\f[C]
+rclone config
+\f[R]
+.fi
+.PP
+This will guide you through an interactive setup process:
+.IP
+.nf
+\f[C]
+No remotes found, make a new one?
+n) New remote
+r) Rename remote
+c) Copy remote
+s) Set configuration password
+q) Quit config
+n/r/c/s/q> n
+name> remote
+Type of storage to configure.
+Choose a number from below, or type in your own value
+[snip]
+XX / Huawei Drive
+ \[rs] \[dq]huaweidrive\[dq]
+[snip]
+Storage> huaweidrive
+OAuth Client Id - leave blank to use rclone\[aq]s default.
+client_id>
+OAuth Client Secret - leave blank to use rclone\[aq]s default.
+client_secret>
+Remote config
+Use web browser to automatically authenticate rclone with remote?
+ * Say Y if the machine running rclone has a web browser you can use
+ * Say N if running rclone on a (remote) machine without web browser access
+If not sure try Y. If Y failed, try N.
+y) Yes
+n) No
+y/n> y
+If your browser doesn\[aq]t open automatically go to the following link: http://127.0.0.1:53682/auth
+Log in and authorize rclone for access
+Waiting for code...
+Got code
+Configuration complete.
+Options:
+- type: huaweidrive
+- client_id:
+- client_secret:
+- token: {\[dq]access_token\[dq]:\[dq]XXX\[dq],\[dq]token_type\[dq]:\[dq]Bearer\[dq],\[dq]refresh_token\[dq]:\[dq]XXX\[dq],\[dq]expiry\[dq]:\[dq]2024-03-16T13:57:58.955387075Z\[dq]}
+Keep this \[dq]remote\[dq] remote?
+y) Yes this is OK
+e) Edit this remote
+d) Delete this remote
+y/e/d> y
+\f[R]
+.fi
+.PP
+See the remote setup docs (https://rclone.org/remote_setup/) for how to
+set it up on a machine without an internet-connected web browser
+available.
+.PP
+Note that rclone runs a webserver on your local machine to collect the
+token as returned from Huawei if using web browser to automatically
+authenticate.
+This only runs from the moment it opens your browser to the moment you
+get back the verification code.
+This is on \f[V]http://127.0.0.1:53682/\f[R] and it may require you to
+unblock it temporarily if you are running a host firewall, or use manual
+mode.
+.PP
+You can then use it like this,
+.PP
+List directories in top level of your drive
+.IP
+.nf
+\f[C]
+rclone lsd remote:
+\f[R]
+.fi
+.PP
+List all the files in your drive
+.IP
+.nf
+\f[C]
+rclone ls remote:
+\f[R]
+.fi
+.PP
+To copy a local directory to a drive directory called backup
+.IP
+.nf
+\f[C]
+rclone copy /home/source remote:backup
+\f[R]
+.fi
+.SS Getting your own Client ID and Secret
+.PP
+When you use rclone with Huawei Drive in its default configuration you
+are using rclone\[aq]s client_id.
+This is shared between all the rclone users.
+There is a global rate limit on the number of queries per second that
+each client_id can do set by Huawei.
+.PP
+It is strongly recommended to use your own client ID as the default
+rclone ID is heavily used.
+If you have multiple services running, it is recommended to use a
+separate client ID for each service to avoid rate limiting issues.
+.PP
+Here is how to create your own Huawei Drive client ID for rclone:
+.PP
+Follow the detailed guides for complete setup instructions:
+.IP \[bu] 2
+Huawei HMS Core Web App
+Preparations (https://developer.huawei.com/consumer/cn/doc/HMSCore-Guides/web-preparations-0000001050050891)
+.IP \[bu] 2
+Huawei HMS Core Server
+Preparations (https://developer.huawei.com/consumer/cn/doc/HMSCore-Guides/server-preparations-0000001050185577#section194911701377)
+.PP
+Rclone uses the web application access method to connect to Huawei
+Drive.
+Before starting, you need to implement quick login authorization through
+Huawei Account Open Service.
+With user authorization credentials, rclone can call Huawei Cloud Drive
+Service APIs.
+.SS Create Server Application
+.PP
+Before accessing Drive service, developers need to create a server
+application first.
+For details, please refer to the WEB Application Access Development
+Preparation section in the \[dq]Huawei Account Service Development
+Guide\[dq].
+.SS Enable Drive Application Switch
+.IP "1." 3
+Log in to the AppGallery Connect website and click \[dq]My
+Projects\[dq].
+.IP "2." 3
+Find your project in the project list, select the application that needs
+to access Drive in the project, and click \[dq]API Management\[dq].
+.IP "3." 3
+In the \[dq]API Management\[dq] area of the \[dq]Project Settings\[dq]
+page, click the switch on the right side of Drive Kit to ensure the
+switch is in the open state.
+.SS Sign Huawei Cloud Drive Privacy Notice and User Agreement
+.PP
+Guide users to visit <https://cloud.huawei.com/>.
+First-time users need to sign the agreement before they can use Huawei
+Cloud Drive Service.
+.SS Application Access to Obtain Authentication Credential Access Token
+.PP
+Applications accessing Drive should use authentication credential Access
+Token.
+For specific acquisition methods, please refer to the WEB Application
+Access Development Guide section in the \[dq]Huawei Account Service
+Development Guide\[dq].
+.PP
+Key steps summary:
+.IP "1." 3
+Log into the Huawei Developer
+Console (https://developer.huawei.com/consumer/en/console) with your
+Huawei account.
+.IP "2." 3
+Create a new project or select an existing project.
+.IP "3." 3
+Go to \[dq]Manage APIs\[dq] and enable the \[dq]Drive Kit\[dq] API.
+.IP "4." 3
+Click on \[dq]Credentials\[dq] in the left side panel.
+.IP "5." 3
+Click \[dq]Create Credentials\[dq] and choose \[dq]OAuth client ID\[dq].
+.IP "6." 3
+Choose \[dq]Web application\[dq] as the application type.
+.IP "7." 3
+Add \f[V]http://localhost:53682/\f[R] to the \[dq]Authorized redirect
+URIs\[dq].
+.IP "8." 3
+Click \[dq]Create\[dq] and note down the Client ID and Client Secret.
+.IP "9." 3
+Provide the noted client ID and client secret to rclone during
+configuration.
+.SS Scopes
+.PP
+Rclone uses the following OAuth2 scopes when accessing Huawei Drive:
+.IP \[bu] 2
+\f[V]https://www.huawei.com/auth/drive\f[R] - Full access to Huawei
+Drive files (excluding application data folder)
+.IP \[bu] 2
+\f[V]https://www.huawei.com/auth/drive.file\f[R] - Access to files
+created by the application
+.IP \[bu] 2
+\f[V]openid\f[R] - OpenID Connect authentication
+.IP \[bu] 2
+\f[V]profile\f[R] - Access to basic profile information
+.PP
+The \f[V]drive.file\f[R] scope is included in the default set used by
+rclone.
+.PP
+Alternative scopes available (not used by rclone by default):
+.IP \[bu] 2
+\f[V]https://www.huawei.com/auth/drive.appdata\f[R] - Access to
+application data folder
+.IP \[bu] 2
+\f[V]https://www.huawei.com/auth/drive.readonly\f[R] - Read-only access
+to file metadata and content
+.IP \[bu] 2
+\f[V]https://www.huawei.com/auth/drive.metadata\f[R] - Read/write access
+to file metadata only
+.IP \[bu] 2
+\f[V]https://www.huawei.com/auth/drive.metadata.readonly\f[R] -
+Read-only access to file metadata only
+.PP
+The default scopes provide read/write access to all files in your Huawei
+Drive.
+.SS Modification times and hashes
+.PP
+Huawei Drive does not support setting modification times.
+The API always uses server-side timestamps, so file modification times
+from the source are not preserved during upload.
+Modification times are available as read-only metadata (\f[V]mtime\f[R],
+\f[V]btime\f[R]).
+.PP
+Hash algorithm SHA256 is supported for file integrity verification.
+.SS Restricted filename characters
+.PP
+Huawei Drive has strict restrictions on file and directory names:
+.IP \[bu] 2
+Cannot contain: \f[V]< > | : \[dq] * ? / \[rs]\f[R] or emoji characters
+.IP \[bu] 2
+Cannot be exactly \f[V]. ..\f[R]
+.IP \[bu] 2
+Maximum length: 250 bytes
+.IP \[bu] 2
+Single quotes must be escaped with \f[V]\[rs]\[aq]\f[R] in API calls
+.PP
+These restrictions are handled by rclone\[aq]s encoding:
+.IP \[bu] 2
+Backslashes \f[V]\[rs]\f[R] are encoded
+.IP \[bu] 2
+Invalid UTF-8 sequences are encoded
+.PD 0
+.P
+.PD
+.IP \[bu] 2
+Right-side spaces are encoded
+.PP
+Invalid characters will be
+replaced (https://rclone.org/overview/#invalid-utf8) according to the
+encoding settings.
+.SS Resumable uploads
+.PP
+Huawei Drive supports resumable uploads for files larger than the upload
+cutoff (default 20MB).
+Files are uploaded in chunks which allows for recovery from network
+interruptions.
+.SS File size limits
+.PP
+The maximum file size for Huawei Drive is 50 GiB.
+.SS Quota information
+.PP
+To view your current quota you can use the
+\f[V]rclone about remote:\f[R] command which will display your usage and
+quota information.
+.SS Standard options
+.PP
+Here are the Standard options specific to huaweidrive (Huawei Drive).
+.SS --huaweidrive-client-id
+.PP
+OAuth Client Id.
+.PP
+Leave blank normally.
+.PP
+Properties:
+.IP \[bu] 2
+Config: client_id
+.IP \[bu] 2
+Env Var: RCLONE_HUAWEIDRIVE_CLIENT_ID
+.IP \[bu] 2
+Type: string
+.IP \[bu] 2
+Required: false
+.SS --huaweidrive-client-secret
+.PP
+OAuth Client Secret.
+.PP
+Leave blank normally.
+.PP
+Properties:
+.IP \[bu] 2
+Config: client_secret
+.IP \[bu] 2
+Env Var: RCLONE_HUAWEIDRIVE_CLIENT_SECRET
+.IP \[bu] 2
+Type: string
+.IP \[bu] 2
+Required: false
+.SS Advanced options
+.PP
+Here are the Advanced options specific to huaweidrive (Huawei Drive).
+.SS --huaweidrive-token
+.PP
+OAuth Access Token as a JSON blob.
+.PP
+Properties:
+.IP \[bu] 2
+Config: token
+.IP \[bu] 2
+Env Var: RCLONE_HUAWEIDRIVE_TOKEN
+.IP \[bu] 2
+Type: string
+.IP \[bu] 2
+Required: false
+.SS --huaweidrive-auth-url
+.PP
+Auth server URL.
+.PP
+Leave blank to use the provider defaults.
+.PP
+Properties:
+.IP \[bu] 2
+Config: auth_url
+.IP \[bu] 2
+Env Var: RCLONE_HUAWEIDRIVE_AUTH_URL
+.IP \[bu] 2
+Type: string
+.IP \[bu] 2
+Required: false
+.SS --huaweidrive-token-url
+.PP
+Token server url.
+.PP
+Leave blank to use the provider defaults.
+.PP
+Properties:
+.IP \[bu] 2
+Config: token_url
+.IP \[bu] 2
+Env Var: RCLONE_HUAWEIDRIVE_TOKEN_URL
+.IP \[bu] 2
+Type: string
+.IP \[bu] 2
+Required: false
+.SS --huaweidrive-client-credentials
+.PP
+Use client credentials OAuth flow.
+.PP
+This will use the OAUTH2 client Credentials Flow as described in RFC
+6749.
+.PP
+Note that this option is NOT supported by all backends.
+.PP
+Properties:
+.IP \[bu] 2
+Config: client_credentials
+.IP \[bu] 2
+Env Var: RCLONE_HUAWEIDRIVE_CLIENT_CREDENTIALS
+.IP \[bu] 2
+Type: bool
+.IP \[bu] 2
+Default: false
+.SS --huaweidrive-root-folder-id
+.PP
+ID of the root folder.
+.PP
+Normally this is auto-detected, but if it fails or you want to speed up
+startup, you can set it manually.
+.PP
+Leave blank normally.
+.PP
+Properties:
+.IP \[bu] 2
+Config: root_folder_id
+.IP \[bu] 2
+Env Var: RCLONE_HUAWEIDRIVE_ROOT_FOLDER_ID
+.IP \[bu] 2
+Type: string
+.IP \[bu] 2
+Required: false
+.SS --huaweidrive-chunk-size
+.PP
+Upload chunk size.
+.PP
+Must be a power of 2 >= 256k and <= 64MB.
+.PP
+Properties:
+.IP \[bu] 2
+Config: chunk_size
+.IP \[bu] 2
+Env Var: RCLONE_HUAWEIDRIVE_CHUNK_SIZE
+.IP \[bu] 2
+Type: SizeSuffix
+.IP \[bu] 2
+Default: 8Mi
+.SS --huaweidrive-list-chunk
+.PP
+Size of listing chunk 1-1000.
+.PP
+Properties:
+.IP \[bu] 2
+Config: list_chunk
+.IP \[bu] 2
+Env Var: RCLONE_HUAWEIDRIVE_LIST_CHUNK
+.IP \[bu] 2
+Type: int
+.IP \[bu] 2
+Default: 1000
+.SS --huaweidrive-upload-cutoff
+.PP
+Cutoff for switching to resumable upload.
+.PP
+Any files larger than this will be uploaded using resumable upload.
+The minimum is 0 and the maximum is 20 MiB (Huawei Drive API limit for
+single request uploads).
+.PP
+Properties:
+.IP \[bu] 2
+Config: upload_cutoff
+.IP \[bu] 2
+Env Var: RCLONE_HUAWEIDRIVE_UPLOAD_CUTOFF
+.IP \[bu] 2
+Type: SizeSuffix
+.IP \[bu] 2
+Default: 20Mi
+.SS --huaweidrive-encoding
+.PP
+The encoding for the backend.
+.PP
+See the encoding section in the
+overview (https://rclone.org/overview/#encoding) for more info.
+.PP
+Properties:
+.IP \[bu] 2
+Config: encoding
+.IP \[bu] 2
+Env Var: RCLONE_HUAWEIDRIVE_ENCODING
+.IP \[bu] 2
+Type: Encoding
+.IP \[bu] 2
+Default:
+Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftSpace,LeftPeriod,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot
+.SS --huaweidrive-description
+.PP
+Description of the remote.
+.PP
+Properties:
+.IP \[bu] 2
+Config: description
+.IP \[bu] 2
+Env Var: RCLONE_HUAWEIDRIVE_DESCRIPTION
+.IP \[bu] 2
+Type: string
+.IP \[bu] 2
+Required: false
+.SS Metadata
+.PP
+Huawei Drive supports reading and writing custom metadata.
+.PP
+User metadata can be set using the \[dq]properties\[dq] field in the
+API.
+System metadata includes standard file information such as: -
+content-type: MIME type of the object - description: User-provided
+description - favorite: Whether file is marked as favorite -
+btime/mtime/utime: Various timestamps - sha256: File hash -
+recycled/has-thumbnail: File status flags
+.PP
+Custom metadata keys can be any string and will be stored in the
+file\[aq]s properties.
+.PP
+Here are the possible system metadata items for the huaweidrive backend.
+.PP
+.TS
+tab(@);
+lw(11.1n) lw(11.1n) lw(11.1n) lw(16.6n) lw(20.3n).
+T{
+Name
+T}@T{
+Help
+T}@T{
+Type
+T}@T{
+Example
+T}@T{
+Read Only
+T}
+_
+T{
+btime
+T}@T{
+Time when the file was created (RFC 3339)
+T}@T{
+RFC 3339
+T}@T{
+T}@T{
+\f[B]Y\f[R]
+T}
+T{
+content-type
+T}@T{
+MIME type of the object
+T}@T{
+string
+T}@T{
+T}@T{
+\f[B]Y\f[R]
+T}
+T{
+description
+T}@T{
+Description of the file
+T}@T{
+string
+T}@T{
+T}@T{
+N
+T}
+T{
+favorite
+T}@T{
+Whether the file is marked as favorite (true/false)
+T}@T{
+string
+T}@T{
+T}@T{
+N
+T}
+T{
+has-thumbnail
+T}@T{
+Whether the file has a thumbnail (true/false)
+T}@T{
+string
+T}@T{
+T}@T{
+\f[B]Y\f[R]
+T}
+T{
+mtime
+T}@T{
+Time when the file content was last modified (RFC 3339)
+T}@T{
+RFC 3339
+T}@T{
+T}@T{
+\f[B]Y\f[R]
+T}
+T{
+recycled
+T}@T{
+Whether the file is in recycle bin (true/false)
+T}@T{
+string
+T}@T{
+T}@T{
+\f[B]Y\f[R]
+T}
+T{
+sha256
+T}@T{
+SHA256 hash of the file
+T}@T{
+string
+T}@T{
+T}@T{
+\f[B]Y\f[R]
+T}
+T{
+utime
+T}@T{
+Time when the file was last edited by the current user (RFC 3339)
+T}@T{
+RFC 3339
+T}@T{
+T}@T{
+\f[B]Y\f[R]
+T}
+.TE
+.PP
+See the metadata (https://rclone.org/docs/#metadata) docs for more info.
+.SS Limitations
+.PP
+Huawei Drive has some rate limiting which may cause rclone to slow down
+transfers to avoid hitting the limits.
+.SS File name restrictions
+.IP \[bu] 2
+File names cannot contain: \f[V]< > | : \[dq] * ? / \[rs]\f[R]
+.IP \[bu] 2
+File names cannot be exactly \f[V]. ..\f[R]
+.IP \[bu] 2
+Maximum file name length is 250 bytes
+.IP \[bu] 2
+Some unicode characters including emojis are not supported
+.SS API rate limits
+.PP
+Huawei Drive imposes API rate limits.
+Rclone automatically handles these by backing off when limits are hit.
+.SS OAuth2 token expiry
+.IP \[bu] 2
+Access tokens expire after 1 hour
+.IP \[bu] 2
+Refresh tokens expire after 180 days
+.PD 0
+.P
+.PD
+.IP \[bu] 2
+Rclone will automatically refresh tokens as needed
+.SS File size limits
+.IP \[bu] 2
+Maximum file size is 50 GiB
+.IP \[bu] 2
+Files larger than this cannot be uploaded
+.SS Upload behavior
+.IP \[bu] 2
+Files smaller than \f[V]upload_cutoff\f[R] (default 20MB) are uploaded
+in a single request using content or multipart method
+.IP \[bu] 2
+Larger files are uploaded using resumable uploads with configurable
+chunk size
+.IP \[bu] 2
+Maximum single chunk size for resumable uploads is 64MB
+.IP \[bu] 2
+Resumable uploads support automatic retry on network errors
+.IP \[bu] 2
+SHA256 hash verification is supported for uploaded files
+.SS Server-side operations
+.IP \[bu] 2
+Server-side copy: Files can be copied within Huawei Drive without
+downloading and re-uploading
+.IP \[bu] 2
+Server-side move: Files and directories can be moved/renamed on the
+server side
+.IP \[bu] 2
+Directory move: Entire directories can be moved with a single API call
+.SS Directory operations
+.IP \[bu] 2
+Huawei Drive supports creating empty directories
+.IP \[bu] 2
+Recursive listing is supported via \f[V]--fast-list\f[R] for efficient
+directory traversal
+.IP \[bu] 2
+Huawei Drive has a special \[dq]applicationData\[dq] folder for
+app-specific data (not accessible via rclone\[aq]s default
+configuration)
+.SS Error handling
+.PP
+Common errors and their meanings:
+.IP \[bu] 2
+\f[V]401 Unauthorized\f[R]: Invalid credentials or expired token
+.IP \[bu] 2
+\f[V]403 Forbidden\f[R]: Usually indicates insufficient permissions or
+API quota exceeded
+.IP \[bu] 2
+\f[V]404 Not Found\f[R]: File or directory does not exist
+.IP \[bu] 2
+\f[V]409 Conflict\f[R]: Directory already exists
+.IP \[bu] 2
+\f[V]429 Too Many Requests\f[R]: API rate limit exceeded, rclone will
+automatically retry
+.SS Performance tuning
+.PP
+For better performance:
+.IP \[bu] 2
+Increase \f[V]--transfers\f[R] for concurrent operations (default is 4)
+.IP \[bu] 2
+Adjust \f[V]chunk_size\f[R] based on your network speed and file sizes
+.IP \[bu] 2
+Use \f[V]--fast-list\f[R] for operations on directories with many files
+to reduce API calls
+.SS Making backups
+.PP
+Huawei Drive is suitable for backups with some considerations:
+.IP \[bu] 2
+Use \f[V]rclone sync\f[R] rather than \f[V]rclone copy\f[R] to maintain
+exact directory structure
+.IP \[bu] 2
+Consider using \f[V]--backup-dir\f[R] to preserve deleted files
+.IP \[bu] 2
+Verify transfers with \f[V]--checksum\f[R] flag for critical data
+.IP \[bu] 2
+Be aware of the 50 GiB file size limit for individual files
+.SS Supported features
+.PP
+Huawei Drive supports the following rclone features:
+.IP \[bu] 2
+\f[V]Copy\f[R] - Server-side copy of files
+.IP \[bu] 2
+\f[V]Move\f[R] - Server-side move/rename of files
+.IP \[bu] 2
+\f[V]DirMove\f[R] - Server-side move of directories
+.IP \[bu] 2
+\f[V]ListR\f[R] - Recursive listing for \f[V]--fast-list\f[R]
+.IP \[bu] 2
+\f[V]About\f[R] - Storage quota information
+.IP \[bu] 2
+\f[V]Purge\f[R] - Delete directory and all contents
+.IP \[bu] 2
+\f[V]CleanUp\f[R] - Empty the trash
+.IP \[bu] 2
+\f[V]UserInfo\f[R] - Get user account information
+.IP \[bu] 2
+\f[V]Metadata\f[R] - Read and write file metadata/properties
+.IP \[bu] 2
+\f[V]ChangeNotify\f[R] - Poll for remote changes (used by
+\f[V]rclone mount\f[R] and \f[V]rclone rc vfs/poll-interval\f[R])
+.SS Integration with other services
+.PP
+Huawei Drive can be used as a backend for various rclone operations:
+.IP \[bu] 2
+Mount as a local filesystem using \f[V]rclone mount\f[R]
+.IP \[bu] 2
+Serve over HTTP using \f[V]rclone serve http\f[R]
+.IP \[bu] 2
+Serve over FTP using \f[V]rclone serve ftp\f[R]
+.IP \[bu] 2
+Serve over WebDAV using \f[V]rclone serve webdav\f[R]
+.PP
+Note that some operations may be slower than local storage due to API
+limitations and network latency.
.SH HDFS
.PP
HDFS (https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-hdfs/HdfsDesign.html)
@@ -65167,24 +67901,53 @@ T}
.TE
.PP
See the metadata (https://rclone.org/docs/#metadata) docs for more info.
-.SH iCloud Drive
+.SH iCloud Drive and Photos
.SS Configuration
.PP
-The initial setup for an iCloud Drive backend involves getting a trust
+The initial setup for an iCloud backend involves getting a trust
token/session.
-This can be done by simply using the regular iCloud password, and
-accepting the code prompt on another iCloud connected device.
+This uses your regular Apple ID password plus 2FA, either from a trusted
+device prompt or an SMS code sent to a trusted phone number.
+.PP
+\f[B]IMPORTANT\f[R]: App-specific passwords are not accepted.
+Only use your regular Apple ID password and 2FA.
.PP
-\f[B]IMPORTANT\f[R]: At the moment an app specific password won\[aq]t be
-accepted.
-Only use your regular password and 2FA.
+This backend serves two Apple services:
+.IP \[bu] 2
+\f[V]drive\f[R] - iCloud Drive (default)
+.IP \[bu] 2
+\f[V]photos\f[R] - iCloud Photos
.PP
\f[V]rclone config\f[R] walks you through the token creation.
The trust token is valid for 30 days.
After which you will have to reauthenticate with
\f[V]rclone reconnect\f[R] or \f[V]rclone config\f[R].
+.SS Authentication
+.PP
+rclone authenticates with Apple using SRP (Secure Remote
+Password) (https://en.wikipedia.org/wiki/Secure_Remote_Password_protocol),
+the same protocol used by the iCloud web interface.
+Your password is never sent to Apple\[aq]s servers -- instead, a
+cryptographic proof is exchanged that verifies you know the password
+without revealing it.
+.PP
+The authentication flow is:
+.IP "1." 3
+rclone initiates a session with Apple\[aq]s identity service
+.IP "2." 3
+An SRP key exchange takes place (your password is used locally to derive
+a key)
+.IP "3." 3
+Apple sends a 2FA prompt to your trusted devices, or lets you request an
+SMS code
+.IP "4." 3
+After you enter the 2FA code, rclone receives a trust token for future
+sessions
.PP
-Here is an example of how to make a remote called \f[V]iclouddrive\f[R].
+Here is an example of how to make a Photos remote called
+\f[V]icloudphotos\f[R].
+For iCloud Drive, leave \f[V]service\f[R] at its default \f[V]drive\f[R]
+value.
First run:
.IP
.nf
@@ -65202,7 +67965,7 @@ n) New remote
s) Set configuration password
q) Quit config
n/s/q> n
-name> iclouddrive
+name> icloudphotos
Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
@@ -65211,6 +67974,15 @@ XX / iCloud Drive
\[rs] (iclouddrive)
[snip]
Storage> iclouddrive
+Option service.
+iCloud service to use.
+Choose a number from below, or type in your own value of type string.
+Press Enter for the default (drive).
+ 1 / iCloud Drive
+ \[rs] (drive)
+ 2 / iCloud Photos
+ \[rs] (photos)
+service> 2
Option apple_id.
Apple ID.
Enter a value.
@@ -65230,13 +68002,14 @@ y) Yes
n) No (default)
y/n> n
Option config_2fa.
-Two-factor authentication: please enter your 2FA code
+Two-factor authentication: enter your 2FA code or type \[aq]sms\[aq] for a text message
Enter a value.
config_2fa> 2FACODE
Remote config
--------------------
-[iclouddrive]
+[icloudphotos]
- type: iclouddrive
+- service: photos
- apple_id: APPLEID
- password: *** ENCRYPTED ***
- cookies: ****************************
@@ -65248,34 +68021,181 @@ d) Delete this remote
y/e/d> y
\f[R]
.fi
+.SS iCloud Photos
+.PP
+The iCloud Drive backend also supports accessing iCloud Photos by
+setting the \f[V]service\f[R] option to \f[V]photos\f[R]:
+.IP
+.nf
+\f[C]
+rclone lsd iclouddrive: --iclouddrive-service photos
+\f[R]
+.fi
+.PP
+This presents a read-only hierarchy rooted at photo libraries:
+.IP \[bu] 2
+\f[B]Level 1\f[R]: Photo libraries \[em] your personal library
+(\f[V]PrimarySync\f[R]) and any Shared Photo Library
+(\f[V]SharedSync-XXXX\f[R])
+.IP \[bu] 2
+\f[B]Level 2+\f[R]: Albums and folders within a library, nested
+recursively as in Apple Photos
+.IP \[bu] 2
+\f[B]Leaf level\f[R]: Photos/videos within an album, including Live
+Photo \f[V].MOV\f[R] companions
+.PP
+Examples:
+.IP
+.nf
+\f[C]
+# List libraries
+rclone lsd iclouddrive: --iclouddrive-service photos
+
+# List albums in your primary library
+rclone lsd iclouddrive:PrimarySync/ --iclouddrive-service photos
+
+# List photos in an album
+rclone ls iclouddrive:PrimarySync/All\[rs] Photos/ --iclouddrive-service photos
+
+# Download a photo
+rclone copy iclouddrive:PrimarySync/Favorites/IMG_0001.HEIC /tmp/ --iclouddrive-service photos
+\f[R]
+.fi
+.PP
+You can either:
+.IP \[bu] 2
+set \f[V]service = photos\f[R] in \f[V]rclone config\f[R] for a
+dedicated Photos remote
+.IP \[bu] 2
+keep \f[V]service = drive\f[R] and pass
+\f[V]--iclouddrive-service photos\f[R] when needed
+.SS Metadata
+.PP
+With \f[V]--metadata\f[R], Photos entries expose these read-only
+metadata keys:
+.IP \[bu] 2
+\f[V]width\f[R]
+.IP \[bu] 2
+\f[V]height\f[R]
+.IP \[bu] 2
+\f[V]added-time\f[R]
+.IP \[bu] 2
+\f[V]favorite\f[R]
+.IP \[bu] 2
+\f[V]hidden\f[R]
+.PP
+These metadata keys are only available when \f[V]service = photos\f[R].
+.SS Caching
+.PP
+iCloud Photos caches album listings to disk for fast subsequent access.
+On the first run, listing a large album uses parallel
+\f[V]startRank\f[R] partitions to fetch pages concurrently.
+After that, a lightweight change check (\[ti]200ms) determines whether
+the cache is still valid.
+.PP
+Cache location:
+\f[V]\[ti]/.cache/rclone/iclouddrive-photos/<remote>/<zone>/\f[R]
+.PP
+To clear the cache: delete that directory or run
+\f[V]rclone config reconnect\f[R].
+.SS FUSE mounts
+.PP
+For mounting iCloud Photos via \f[V]rclone mount\f[R], the following
+flags are recommended:
+.IP
+.nf
+\f[C]
+rclone mount remote: /mnt/photos \[rs]
+ --iclouddrive-service photos \[rs]
+ --vfs-refresh \[rs]
+ --dir-cache-time 1h \[rs]
+ --vfs-cache-mode full \[rs]
+ --attr-timeout 1m \[rs]
+ --read-only
+\f[R]
+.fi
+.IP \[bu] 2
+\f[V]--vfs-refresh\f[R] pre-warms directory caches in the background on
+mount start so that albums are ready when you browse them
+.IP \[bu] 2
+\f[V]--dir-cache-time 1h\f[R] extends the in-memory cache lifetime
+beyond the default 5 minutes (change detection is fast, so this is safe)
+.IP \[bu] 2
+\f[V]--vfs-cache-mode full\f[R] caches downloaded photos and videos to
+local disk for fast repeated access
+.IP \[bu] 2
+\f[V]--attr-timeout 1m\f[R] reduces kernel attribute lookups (safe
+because the backend is read-only)
+.IP \[bu] 2
+\f[V]--read-only\f[R] prevents confusing write errors
+.PP
+The first listing of a very large album (e.g.
+75,000 items in \[dq]All Photos\[dq]) can take several minutes due to
+API pagination limits.
+This happens once \[em] subsequent listings use the disk cache.
+.SS Limitations
+.PP
+iCloud Photos is read-only.
+Upload, delete, rename, and move operations are not supported.
.SS Advanced Data Protection
.PP
-ADP is currently unsupported and need to be disabled
+Advanced Data Protection is supported.
.PP
On iPhone, Settings \f[V]>\f[R] Apple Account \f[V]>\f[R] iCloud
-\f[V]>\f[R] \[aq]Access iCloud Data on the Web\[aq] must be ON, and
-\[aq]Advanced Data Protection\[aq] OFF.
+\f[V]>\f[R] \[aq]Access iCloud Data on the Web\[aq] must be ON.
+.PP
+If ADP is enabled on your account, rclone requests PCS cookies after
+2FA.
+Apple may require approval on a trusted device before those cookies are
+issued.
.SS Troubleshooting
-.SS Missing PCS cookies from the request
+.SS PCS cookie errors with ADP
.PP
-This means you have Advanced Data Protection (ADP) turned on.
-This is not supported at the moment.
-If you want to use rclone you will have to turn it off.
-See above for how to turn it off.
+If you see \f[V]Missing PCS cookies from the request\f[R] or a
+\f[V]requestPCS:\f[R] error, the ADP approval flow did not complete
+successfully.
.PP
-You will need to clear the \f[V]cookies\f[R] and the
-\f[V]trust_token\f[R] fields in the config.
-Or you can delete the remote config and start again.
+Check that \[aq]Access iCloud Data on the Web\[aq] is enabled and
+approve any prompt on your trusted device.
.PP
-You should then run \f[V]rclone reconnect remote:\f[R].
+Then run \f[V]rclone reconnect remote:\f[R].
.PP
-Note that changing the ADP setting may not take effect immediately - you
-may need to wait a few hours or a day before you can get rclone to work
-- keep clearing the config entry and running
-\f[V]rclone reconnect remote:\f[R] until rclone functions properly.
+If the remote still has stale auth state, clear the \f[V]cookies\f[R]
+and \f[V]trust_token\f[R] fields in the config, or delete and recreate
+the remote.
.SS Standard options
.PP
-Here are the Standard options specific to iclouddrive (iCloud Drive).
+Here are the Standard options specific to iclouddrive (iCloud Drive and
+Photos).
+.SS --iclouddrive-service
+.PP
+iCloud service to use.
+.PP
+Properties:
+.IP \[bu] 2
+Config: service
+.IP \[bu] 2
+Env Var: RCLONE_ICLOUDDRIVE_SERVICE
+.IP \[bu] 2
+Type: string
+.IP \[bu] 2
+Default: \[dq]drive\[dq]
+.IP \[bu] 2
+Examples:
+.RS 2
+.IP \[bu] 2
+\[dq]drive\[dq]
+.RS 2
+.IP \[bu] 2
+iCloud Drive
+.RE
+.IP \[bu] 2
+\[dq]photos\[dq]
+.RS 2
+.IP \[bu] 2
+iCloud Photos
+.RE
+.RE
.SS --iclouddrive-apple-id
.PP
Apple ID.
@@ -65307,7 +68227,7 @@ Type: string
Required: true
.SS --iclouddrive-trust-token
.PP
-Trust token (internal use)
+Trust token for session authentication.
.PP
Properties:
.IP \[bu] 2
@@ -65320,7 +68240,7 @@ Type: string
Required: false
.SS --iclouddrive-cookies
.PP
-cookies (internal use only)
+Session cookies.
.PP
Properties:
.IP \[bu] 2
@@ -65333,10 +68253,11 @@ Type: string
Required: false
.SS Advanced options
.PP
-Here are the Advanced options specific to iclouddrive (iCloud Drive).
+Here are the Advanced options specific to iclouddrive (iCloud Drive and
+Photos).
.SS --iclouddrive-client-id
.PP
-Client id
+Client ID for iCloud API access.
.PP
Properties:
.IP \[bu] 2
@@ -65377,6 +68298,81 @@ Env Var: RCLONE_ICLOUDDRIVE_DESCRIPTION
Type: string
.IP \[bu] 2
Required: false
+.SS Metadata
+.PP
+Metadata is read-only and available for the Photos service only.
+.PP
+Here are the possible system metadata items for the iclouddrive backend.
+.PP
+.TS
+tab(@);
+lw(11.1n) lw(11.1n) lw(11.1n) lw(16.6n) lw(20.3n).
+T{
+Name
+T}@T{
+Help
+T}@T{
+Type
+T}@T{
+Example
+T}@T{
+Read Only
+T}
+_
+T{
+added-time
+T}@T{
+Time the item was added to the iCloud library
+T}@T{
+RFC 3339
+T}@T{
+2006-01-02T15:04:05Z
+T}@T{
+\f[B]Y\f[R]
+T}
+T{
+favorite
+T}@T{
+Whether the item is marked as favorite
+T}@T{
+bool
+T}@T{
+T}@T{
+\f[B]Y\f[R]
+T}
+T{
+height
+T}@T{
+Image height in pixels
+T}@T{
+int
+T}@T{
+T}@T{
+\f[B]Y\f[R]
+T}
+T{
+hidden
+T}@T{
+Whether the item is hidden
+T}@T{
+bool
+T}@T{
+T}@T{
+\f[B]Y\f[R]
+T}
+T{
+width
+T}@T{
+Image width in pixels
+T}@T{
+int
+T}@T{
+T}@T{
+\f[B]Y\f[R]
+T}
+.TE
+.PP
+See the metadata (https://rclone.org/docs/#metadata) docs for more info.
.SH Internet Archive
.PP
The Internet Archive backend utilizes Items on
@@ -66117,6 +69113,57 @@ Env Var: RCLONE_INTERNXT_SKIP_HASH_VALIDATION
Type: bool
.IP \[bu] 2
Default: true
+.SS --internxt-upload-concurrency
+.PP
+Concurrency for multipart uploads.
+.PP
+This is the number of chunks of the same file that are uploaded
+concurrently.
+.PP
+Note that each chunk is buffered in memory.
+.PP
+Properties:
+.IP \[bu] 2
+Config: upload_concurrency
+.IP \[bu] 2
+Env Var: RCLONE_INTERNXT_UPLOAD_CONCURRENCY
+.IP \[bu] 2
+Type: int
+.IP \[bu] 2
+Default: 4
+.SS --internxt-upload-cutoff
+.PP
+Cutoff for switching to multipart upload.
+.PP
+Any files larger than this will be uploaded in chunks of chunk_size.
+The minimum is 100 MiB and the maximum is 5 GiB.
+.PP
+Properties:
+.IP \[bu] 2
+Config: upload_cutoff
+.IP \[bu] 2
+Env Var: RCLONE_INTERNXT_UPLOAD_CUTOFF
+.IP \[bu] 2
+Type: SizeSuffix
+.IP \[bu] 2
+Default: 100Mi
+.SS --internxt-chunk-size
+.PP
+Chunk size for multipart uploads.
+.PP
+Files larger than upload_cutoff will be uploaded in chunks of this size.
+.PP
+Memory usage is approximately chunk_size * upload_concurrency.
+.PP
+Properties:
+.IP \[bu] 2
+Config: chunk_size
+.IP \[bu] 2
+Env Var: RCLONE_INTERNXT_CHUNK_SIZE
+.IP \[bu] 2
+Type: SizeSuffix
+.IP \[bu] 2
+Default: 30Mi
.SS --internxt-encoding
.PP
The encoding for the backend.
@@ -66644,6 +69691,13 @@ T}@T{
T}@T{
|
T}
+T{
+%
+T}@T{
+0x25
+T}@T{
+%
+T}
.TE
.PP
Invalid UTF-8 bytes will also be
@@ -66858,7 +69912,7 @@ Env Var: RCLONE_JOTTACLOUD_ENCODING
Type: Encoding
.IP \[bu] 2
Default:
-Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot
+Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Percent,Del,Ctl,InvalidUtf8,Dot
.SS --jottacloud-description
.PP
Description of the remote.
@@ -67426,6 +70480,17 @@ Linkbox is a private cloud drive (https://linkbox.to/).
.PP
Here is an example of making a remote for Linkbox.
.PP
+You will need: - An API token from https://www.linkbox.to/admin/account
+- The email and password for your Linkbox account
+.PP
+\f[B]Note:\f[R] As of v1.74, email and password are required in addition
+to the API token.
+The API token is used for uploads and modifications, while
+email/password authentication is used for listing and downloading files.
+If you have an existing Linkbox remote, you will need to reconfigure it
+with \f[V]rclone config\f[R] to edit the remote and add the email and
+password.
+.PP
First run:
.IP
.nf
@@ -67457,12 +70522,24 @@ Storage> XX
Option token.
Token from https://www.linkbox.to/admin/account
Enter a value.
-token> testFromCLToken
+token> YOUR_API_TOKEN
+
+Option email.
+Email for login
+Enter a value.
+email> your\[at]email.com
+
+Option password.
+Password for login
+Enter a value.
+password> YOUR_PASSWORD
Configuration complete.
Options:
- type: linkbox
- token: XXXXXXXXXXX
+- email: your\[at]email.com
+- password: *** ENCRYPTED ***
Keep this \[dq]linkbox\[dq] remote?
y) Yes this is OK (default)
e) Edit this remote
@@ -67486,6 +70563,48 @@ Env Var: RCLONE_LINKBOX_TOKEN
Type: string
.IP \[bu] 2
Required: true
+.SS --linkbox-email
+.PP
+Email for login
+.PP
+Properties:
+.IP \[bu] 2
+Config: email
+.IP \[bu] 2
+Env Var: RCLONE_LINKBOX_EMAIL
+.IP \[bu] 2
+Type: string
+.IP \[bu] 2
+Required: true
+.SS --linkbox-password
+.PP
+Password for login
+.PP
+\f[B]NB\f[R] Input to this must be obscured - see rclone
+obscure (https://rclone.org/commands/rclone_obscure/).
+.PP
+Properties:
+.IP \[bu] 2
+Config: password
+.IP \[bu] 2
+Env Var: RCLONE_LINKBOX_PASSWORD
+.IP \[bu] 2
+Type: string
+.IP \[bu] 2
+Required: true
+.SS --linkbox-web-token
+.PP
+Web API login token - set automatically.
+.PP
+Properties:
+.IP \[bu] 2
+Config: web_token
+.IP \[bu] 2
+Env Var: RCLONE_LINKBOX_WEB_TOKEN
+.IP \[bu] 2
+Type: string
+.IP \[bu] 2
+Required: false
.SS Advanced options
.PP
Here are the Advanced options specific to linkbox (Linkbox).
@@ -69640,12 +72759,12 @@ be explicitly specified using exactly one of the
If none of \f[V]msi_object_id\f[R], \f[V]msi_client_id\f[R], or
\f[V]msi_mi_res_id\f[R] is set, this is is equivalent to using
\f[V]env_auth\f[R].
-.SS Fedrated Identity Credentials
+.SS Federated Identity Credentials
.PP
-If these variables are set, rclone will authenticate with fedrated
+If these variables are set, rclone will authenticate with federated
identity.
.IP \[bu] 2
-\f[V]tenant_id\f[R]: tenant_id to authenticate in storage
+\f[V]tenant\f[R]: tenant ID of of the storage
.IP \[bu] 2
\f[V]client_id\f[R]: client ID of the application the user will
authenticate to storage
@@ -69656,7 +72775,7 @@ the user will authenticate to
By default \[dq]api://AzureADTokenExchange\[dq] is used as scope for
token retrieval over MSI.
This token is then exchanged for actual storage token using
-\[aq]tenant_id\[aq] and \[aq]client_id\[aq].
+\[aq]tenant\[aq] and \[aq]client_id\[aq].
.SS Azure CLI tool \f[V]az\f[R]
.PP
Set to use the Azure CLI tool
@@ -70184,6 +73303,24 @@ Env Var: RCLONE_AZUREBLOB_COPY_CONCURRENCY
Type: int
.IP \[bu] 2
Default: 512
+.SS --azureblob-copy-total-concurrency
+.PP
+Global concurrency limit for multipart copy chunks.
+.PP
+This limits the total number of multipart copy chunks running at once
+across all files.
+.PP
+Set to 0 to disable this limiter.
+.PP
+Properties:
+.IP \[bu] 2
+Config: copy_total_concurrency
+.IP \[bu] 2
+Env Var: RCLONE_AZUREBLOB_COPY_TOTAL_CONCURRENCY
+.IP \[bu] 2
+Type: int
+.IP \[bu] 2
+Default: 0
.SS --azureblob-use-copy-blob
.PP
Whether to use the Copy Blob API when copying to the same storage
@@ -70473,6 +73610,28 @@ Specify \[aq]only\[aq] to remove only the snapshots but keep the root
blob.
.RE
.RE
+.SS --azureblob-decompress
+.PP
+If set this will decompress gzip encoded objects.
+.PP
+It is possible to upload objects to Azure Blob Storage with
+\[dq]Content-Encoding: gzip\[dq] set.
+Normally rclone will download these files as compressed objects.
+.PP
+If this flag is set then rclone will decompress these files with
+\[dq]Content-Encoding: gzip\[dq] as they are received.
+This means that rclone can\[aq]t check the size and hash but the file
+contents will be decompressed.
+.PP
+Properties:
+.IP \[bu] 2
+Config: decompress
+.IP \[bu] 2
+Env Var: RCLONE_AZUREBLOB_DECOMPRESS
+.IP \[bu] 2
+Type: bool
+.IP \[bu] 2
+Default: false
.SS --azureblob-description
.PP
Description of the remote.
@@ -71110,12 +74269,12 @@ be explicitly specified using exactly one of the
If none of \f[V]msi_object_id\f[R], \f[V]msi_client_id\f[R], or
\f[V]msi_mi_res_id\f[R] is set, this is is equivalent to using
\f[V]env_auth\f[R].
-.SS Fedrated Identity Credentials
+.SS Federated Identity Credentials
.PP
-If these variables are set, rclone will authenticate with fedrated
+If these variables are set, rclone will authenticate with federated
identity.
.IP \[bu] 2
-\f[V]tenant_id\f[R]: tenant_id to authenticate in storage
+\f[V]tenant\f[R]: tenant ID of of the storage
.IP \[bu] 2
\f[V]client_id\f[R]: client ID of the application the user will
authenticate to storage
@@ -71126,7 +74285,7 @@ the user will authenticate to
By default \[dq]api://AzureADTokenExchange\[dq] is used as scope for
token retrieval over MSI.
This token is then exchanged for actual storage token using
-\[aq]tenant_id\[aq] and \[aq]client_id\[aq].
+\[aq]tenant\[aq] and \[aq]client_id\[aq].
.SS Azure CLI tool \f[V]az\f[R]
.PP
Set to use the Azure CLI tool
@@ -77938,17 +81097,22 @@ rclone backend addurl remote: [options] [<arguments>+]
.PP
This command adds offline download task for url.
.PP
-Usage example:
+Usage examples:
.IP
.nf
\f[C]
rclone backend addurl pikpak:dirpath url
+rclone backend addurl pikpak:dirpath url -o name=custom_filename.zip
\f[R]
.fi
.PP
Downloads will be stored in \[aq]dirpath\[aq].
If \[aq]dirpath\[aq] is invalid, download will fallback to default
\[aq]My Pack\[aq] folder.
+.PP
+Options:
+.IP \[bu] 2
+\[dq]name\[dq]: Custom filename for the downloaded file.
.SS decompress
.PP
Request decompress of a file/files in a folder.
@@ -78849,10 +82013,16 @@ Default: true
.SS --protondrive-app-version
.PP
The app version string
-.PP
-The app version string indicates the client that is currently performing
-the API request.
-This information is required and will be sent with every API request.
+.IP
+.nf
+\f[C]
+ The app version string identifies the client that is currently performing
+ the API request. Third-party Proton Drive integrations should use the form
+ external-drive-<project>\[at]<version>. If this option is left empty, rclone
+ derives a compliant value from its own version. This value is sent with
+ every API request; the option itself is optional.
+\f[R]
+.fi
.PP
Properties:
.IP \[bu] 2
@@ -78862,7 +82032,7 @@ Env Var: RCLONE_PROTONDRIVE_APP_VERSION
.IP \[bu] 2
Type: string
.IP \[bu] 2
-Default: \[dq]macos-drive\[at]1.0.0-alpha.1+rclone\[dq]
+Required: false
.SS --protondrive-replace-existing-draft
.PP
Create a new revision when filename conflict is detected
@@ -79569,10 +82739,16 @@ Default: true
.SS --protondrive-app-version
.PP
The app version string
-.PP
-The app version string indicates the client that is currently performing
-the API request.
-This information is required and will be sent with every API request.
+.IP
+.nf
+\f[C]
+ The app version string identifies the client that is currently performing
+ the API request. Third-party Proton Drive integrations should use the form
+ external-drive-<project>\[at]<version>. If this option is left empty, rclone
+ derives a compliant value from its own version. This value is sent with
+ every API request; the option itself is optional.
+\f[R]
+.fi
.PP
Properties:
.IP \[bu] 2
@@ -79582,7 +82758,7 @@ Env Var: RCLONE_PROTONDRIVE_APP_VERSION
.IP \[bu] 2
Type: string
.IP \[bu] 2
-Default: \[dq]macos-drive\[at]1.0.0-alpha.1+rclone\[dq]
+Required: false
.SS --protondrive-replace-existing-draft
.PP
Create a new revision when filename conflict is detected
@@ -85633,7 +88809,7 @@ T}
.PP
When running on Windows the following characters are replaced.
This list is based on the Windows file naming
-conventions (https://docs.microsoft.com/de-de/windows/desktop/FileIO/naming-a-file#naming-conventions).
+conventions (https://docs.microsoft.com/windows/desktop/FileIO/naming-a-file#naming-conventions).
.PP
.TS
tab(@);
@@ -86814,6 +89990,636 @@ Options:
.IP \[bu] 2
\[dq]error\[dq]: Return an error based on option value.
.SH Changelog
+.SS v1.74.0 - 2026-05-01
+.PP
+See commits (https://github.com/rclone/rclone/compare/v1.73.0...v1.74.0)
+.IP \[bu] 2
+New backends
+.RS 2
+.IP \[bu] 2
+Huawei Drive (https://rclone.org/huaweidrive/) (王一赫)
+.IP \[bu] 2
+iCloud Photos (https://rclone.org/iclouddrive/#icloud-photos) (read
+only) (Yakov Till)
+.IP \[bu] 2
+New S3 providers
+.RS 2
+.IP \[bu] 2
+Fastly Object Storage (https://rclone.org/s3/#fastly) (Leon Brocard)
+.IP \[bu] 2
+HCP (https://rclone.org/s3/#hcp) (Chris)
+.IP \[bu] 2
+Impossible Cloud (https://rclone.org/s3/#impossible-cloud) (Nick
+Craig-Wood)
+.IP \[bu] 2
+UCloud US3 (https://rclone.org/s3/#us3) (jinkeyuu)
+.IP \[bu] 2
+Zadara (https://rclone.org/s3/#zadara) (Shlomi Avihou)
+.RE
+.RE
+.IP \[bu] 2
+New commands
+.RS 2
+.IP \[bu] 2
+gui (https://rclone.org/gui/): launch new embedded web based GUI for
+basic rclone operations (FTCHD, Nick Craig-Wood)
+.RE
+.IP \[bu] 2
+New Features
+.RS 2
+.IP \[bu] 2
+build
+.RS 2
+.IP \[bu] 2
+Update \f[V]golang.org/x/image/webp\f[R] to v0.39.0 to fix
+CVE-2026-33813 (Nick Craig-Wood)
+.IP \[bu] 2
+Bump \f[V]github.com/Azure/go-ntlmssp\f[R] to 0.1.1 to fix
+CVE-2026-32952 (dependabot[bot])
+.IP \[bu] 2
+Update to go1.26 and make go1.25 the minimum required version (Nick
+Craig-Wood)
+.IP \[bu] 2
+Update all dependencies (Nick Craig-Wood)
+.IP \[bu] 2
+Modernize Go code with go fix for go1.25 (Nick Craig-Wood)
+.IP \[bu] 2
+Fix \f[V]loong64\f[R] and \f[V]s390x\f[R] build (Suyun)
+.RE
+.IP \[bu] 2
+docs
+.RS 2
+.IP \[bu] 2
+Modernize rclone.org site design (Nick Craig-Wood)
+.IP \[bu] 2
+fixes (albertony, Enduriel, Jason, Luke Cyca, mathieulongtin, Nick
+Craig-Wood, SyoBoN)
+.RE
+.IP \[bu] 2
+fshttp: Add \f[V]--dump curl\f[R] for dumping HTTP requests as curl
+commands (Nick Craig-Wood)
+.IP \[bu] 2
+graphics: Optimise images losslessly with ImageOptim (Leon Brocard)
+.IP \[bu] 2
+listremotes: Add \f[V]--exact\f[R] flag for filtering (Anton Bordwine)
+.IP \[bu] 2
+rc
+.RS 2
+.IP \[bu] 2
+Flip auth default so all endpoints require auth unless opted out (Nick
+Craig-Wood)
+.IP \[bu] 2
+Add \f[V]core/disks\f[R] to enumerate attached disks (Nick Craig-Wood)
+.IP \[bu] 2
+Add \f[V]deletedDirs\f[R] stat to \f[V]core/stats\f[R] help output
+(Billy Hughes)
+.RE
+.IP \[bu] 2
+serve http
+.RS 2
+.IP \[bu] 2
+Add fallback embedded favicon (Leon Brocard)
+.IP \[bu] 2
+Add gzip compression for text responses (Leon Brocard)
+.IP \[bu] 2
+Dark mode for file browser (FTCHD)
+.IP \[bu] 2
+Add HTTP/2 cleartext support for all http servers (TheBabu)
+.RE
+.IP \[bu] 2
+touch: Add metadata when using \f[V]--metadata-set\f[R] (Prakhar
+Chhalotre)
+.RE
+.IP \[bu] 2
+Bug Fixes
+.RS 2
+.IP \[bu] 2
+accounting
+.RS 2
+.IP \[bu] 2
+Update String method output format for clarity in transfer rate
+representation (Prakhar Chhalotre)
+.IP \[bu] 2
+Fix \f[V]rcat\f[R]/\f[V]copyurl\f[R] for \f[V]files.com\f[R] (Nick
+Craig-Wood)
+.RE
+.IP \[bu] 2
+bisync
+.RS 2
+.IP \[bu] 2
+Add missing rc params (nielash)
+.IP \[bu] 2
+Add more structured info to rc output (nielash)
+.IP \[bu] 2
+Auto-generate rc help docs (nielash)
+.IP \[bu] 2
+Fix handling of unreadable lockfiles (lif)
+.IP \[bu] 2
+Fix flaky TestBisyncConcurrent by increasing random name entropy (Nick
+Craig-Wood)
+.IP \[bu] 2
+Fix integration tests after sftp log changes (Nick Craig-Wood)
+.RE
+.IP \[bu] 2
+copyurl: Fix ignored \f[V]--upload-headers\f[R] and
+\f[V]--download-headers\f[R] (Andriy Senyshyn)
+.IP \[bu] 2
+librclone/ctest: Add Windows support and fix memory management
+(BizaNator)
+.IP \[bu] 2
+log: Fix data race on OutputHandler.format field (Nick Craig-Wood)
+.IP \[bu] 2
+operations
+.RS 2
+.IP \[bu] 2
+Multithread copy: grab memory before making go routines (Nick
+Craig-Wood)
+.RE
+.IP \[bu] 2
+serve dlna: Fix Samsung TV compatibility (Nick Craig-Wood)
+.IP \[bu] 2
+serve nfs: Fix EOF flag in READ response not being set when read reaches
+end of file (Nick Craig-Wood)
+.RE
+.IP \[bu] 2
+Mount
+.RS 2
+.IP \[bu] 2
+rc: fix mounts created with mountPoint \[dq]*\[dq] overwriting each
+other (Nick Craig-Wood)
+.RE
+.IP \[bu] 2
+VFS
+.RS 2
+.IP \[bu] 2
+Fix slow \f[V]nfs serve\f[R] by adding \f[V]--vfs-handle-caching\f[R]
+(Nick Craig-Wood)
+.IP \[bu] 2
+Add context parameter to New() for config propagation (Nick Craig-Wood)
+.IP \[bu] 2
+Replace \f[V]context.TODO\f[R]/\f[V]Background\f[R] with stored VFS
+context (Nick Craig-Wood)
+.RE
+.IP \[bu] 2
+Local
+.RS 2
+.IP \[bu] 2
+Remove fadvise calls that cause spinlock contention (Patrick Farrell)
+.RE
+.IP \[bu] 2
+Azure Blob
+.RS 2
+.IP \[bu] 2
+Add \f[V]--azureblob-copy-total-concurrency\f[R] to limit total
+multipart copy concurrency (Duncan F)
+.IP \[bu] 2
+Add server side copy real time accounting (Nick Craig-Wood)
+.IP \[bu] 2
+Add \f[V]--azureblob-decompress\f[R] flag to download gzip-encoded files
+(Nick Craig-Wood)
+.RE
+.IP \[bu] 2
+Azurefiles
+.RS 2
+.IP \[bu] 2
+Fix missing \f[V]x-ms-file-request-intent\f[R] header with OAuth (Nick
+Craig-Wood)
+.RE
+.IP \[bu] 2
+B2
+.RS 2
+.IP \[bu] 2
+Add server side copy real time accounting (Nick Craig-Wood)
+.RE
+.IP \[bu] 2
+Drime
+.RS 2
+.IP \[bu] 2
+Implement About (Cohinem)
+.IP \[bu] 2
+Fix listings of large directories (John Volk)
+.RE
+.IP \[bu] 2
+Drive
+.RS 2
+.IP \[bu] 2
+Add integration test for handling folder names with single quotes
+(Prakhar Chhalotre)
+.RE
+.IP \[bu] 2
+Filelu
+.RS 2
+.IP \[bu] 2
+Add multipart init response type (kingston125)
+.IP \[bu] 2
+Migrate API calls to \f[V]lib/rest\f[R] (kingston125)
+.RE
+.IP \[bu] 2
+Filen
+.RS 2
+.IP \[bu] 2
+Make multi-threaded upload chunks individually retryable (Enduriel)
+.RE
+.IP \[bu] 2
+Iclouddrive
+.RS 2
+.IP \[bu] 2
+Replace plaintext signin with SRP authentication (Mike GIllan)
+.IP \[bu] 2
+Use dynamic origin for SRP auth headers (Xiangzhe)
+.IP \[bu] 2
+Lowercase Apple ID for SRP authentication (Mike GIllan)
+.IP \[bu] 2
+Add read only iCloud Photos support and SRP authentication (Yakov Till)
+.RE
+.IP \[bu] 2
+Internxt
+.RS 2
+.IP \[bu] 2
+Implement multi-part uploads (José Zúniga)
+.RE
+.IP \[bu] 2
+Jottacloud
+.RS 2
+.IP \[bu] 2
+Add encoding of percent character to default backend encoding
+(albertony)
+.RE
+.IP \[bu] 2
+Linkbox
+.RS 2
+.IP \[bu] 2
+Fix downloading files by using web API (Nick Craig-Wood)
+.RE
+.IP \[bu] 2
+Mega
+.RS 2
+.IP \[bu] 2
+Fix crash when logging in with previous auth keys fails (Andrew
+Gunnerson)
+.RE
+.IP \[bu] 2
+Pcloud
+.RS 2
+.IP \[bu] 2
+Fix recursive listing from the root (Nick Craig-Wood)
+.RE
+.IP \[bu] 2
+Pikpak
+.RS 2
+.IP \[bu] 2
+Support custom filenames for addurl backend command (wiserain)
+.RE
+.IP \[bu] 2
+Protondrive
+.RS 2
+.IP \[bu] 2
+Align backend with newer Proton SDK stack (tdawe)
+.IP \[bu] 2
+Update to latest go-proton-api to use new host (dlaumen)
+.IP \[bu] 2
+Fix server-side moveto and DirMove against current API (Nick Craig-Wood)
+.RE
+.IP \[bu] 2
+S3
+.RS 2
+.IP \[bu] 2
+Add Fastly Object Storage provider (Leon Brocard)
+.IP \[bu] 2
+Add HCP provider and \f[V]list_versions_oldest_first\f[R] quirk (Chris)
+.IP \[bu] 2
+Add Impossible Cloud as a new S3 provider (Nick Craig-Wood)
+.IP \[bu] 2
+Add UCloud Object Storage provider (#9230) (jinkeyuu)
+.IP \[bu] 2
+Add Zadara Object Storage provider (Shlomi Avihou)
+.IP \[bu] 2
+Remove StackPath Object Storage provider (Leon Brocard)
+.IP \[bu] 2
+Add server side copy real time accounting (Nick Craig-Wood)
+.IP \[bu] 2
+Add OVHcloud storage classes (Bjoern Franke)
+.IP \[bu] 2
+Add Object Lock support (Chris)
+.IP \[bu] 2
+Add new Fastly Object Storage regions (Leon Brocard)
+.IP \[bu] 2
+Scaleway: ONEZONE_IA is available in all zones, GLACIER only in FR-PAR
+(Bjoern Franke)
+.IP \[bu] 2
+Ionos: updated regions & endpoints (hxnd)
+.IP \[bu] 2
+IBM COS: provide ibm_iam_endpoint as a configurable param for IBM
+IAM-based auth (Bhagyashreek8)
+.IP \[bu] 2
+Fix Content-MD5 for Object Lock uploads and add GCS quirk (Chris)
+.IP \[bu] 2
+Fix regression where PutObject fails with non-seekable readers (Chris)
+.IP \[bu] 2
+Fix \f[V]--s3-versions\f[R] flag ignored by cleanup-hidden when
+GetBucketVersioning fails (Chris)
+.IP \[bu] 2
+Fix bucket creation failing on Ceph/radosgw (Jan Heylen)
+.RE
+.IP \[bu] 2
+SFTP
+.RS 2
+.IP \[bu] 2
+Warn the user if no host key validation is configured (Nick Craig-Wood)
+.RE
+.IP \[bu] 2
+WebDAV
+.RS 2
+.IP \[bu] 2
+Permit redirects on PROPFIND for metadata (Brian Bockelman)
+.IP \[bu] 2
+Request only required properties in listAll to improve performance
+(ZRHan)
+.IP \[bu] 2
+Optimize performance by using \f[V]Depth=0\f[R] for metadata requests
+(ZRHan)
+.RE
+.SS v1.73.5 - 2026-04-19
+.PP
+See commits (https://github.com/rclone/rclone/compare/v1.73.4...v1.73.5)
+.IP \[bu] 2
+Bug Fixes
+.RS 2
+.IP \[bu] 2
+operations: Add AuthRequired to operations/fsinfo to prevent backend
+creation CVE-2026-41179 (Nick Craig-Wood)
+.IP \[bu] 2
+rc
+.RS 2
+.IP \[bu] 2
+Add AuthRequired to options/set to prevent auth bypass CVE-2026-41176
+(Nick Craig-Wood)
+.IP \[bu] 2
+Snapshot NoAuth at startup to prevent runtime auth bypass CVE-2026-41176
+(Nick Craig-Wood)
+.RE
+.IP \[bu] 2
+filter: Fix debug logs that fire before logger is configured (Nick
+Craig-Wood)
+.RE
+.IP \[bu] 2
+Azureblob
+.RS 2
+.IP \[bu] 2
+Add Microsoft Partner Network User-Agent prefix (Nick Craig-Wood)
+.RE
+.IP \[bu] 2
+Drime
+.RS 2
+.IP \[bu] 2
+Fix User.EntryPermissions JSON unmarshalling (a1pcm)
+.RE
+.IP \[bu] 2
+Iclouddrive
+.RS 2
+.IP \[bu] 2
+Fix \[aq]directory not found\[aq] error when the directory contains
+accent marks (Brais Couce)
+.RE
+.IP \[bu] 2
+S3
+.RS 2
+.IP \[bu] 2
+Fix TencentCOS CDN endpoint failing on bucket check (Mozi)
+.IP \[bu] 2
+Fix empty delimiter parameter rejected by Archiware P5 server (Nick
+Craig-Wood)
+.RE
+.SS v1.73.4 - 2026-04-08
+.PP
+See commits (https://github.com/rclone/rclone/compare/v1.73.3...v1.73.4)
+.IP \[bu] 2
+Bug Fixes
+.RS 2
+.IP \[bu] 2
+build
+.RS 2
+.IP \[bu] 2
+Update to go 1.25.9 to fix multiple CVEs (Nick Craig-Wood)
+.RS 2
+.IP \[bu] 2
+CVE-2026-32282: os: Root.Chmod can follow symlinks out of the root on
+Linux
+.IP \[bu] 2
+CVE-2026-32289: html/template: JS template literal context incorrectly
+tracked
+.IP \[bu] 2
+CVE-2026-33810: crypto/x509: excluded DNS constraints not properly
+applied to wildcard domains
+.IP \[bu] 2
+CVE-2026-27144: cmd/compile: no-op interface conversion bypasses overlap
+checking
+.IP \[bu] 2
+CVE-2026-27143: cmd/compile: possible memory corruption after bound
+check elimination
+.IP \[bu] 2
+CVE-2026-32288: archive/tar: unbounded allocation when parsing old
+format GNU sparse map
+.IP \[bu] 2
+CVE-2026-32283: crypto/tls: multiple key update handshake messages can
+cause connection to deadlock
+.IP \[bu] 2
+CVE-2026-27140: cmd/go: trust layer bypass when using cgo and SWIG
+.IP \[bu] 2
+CVE-2026-32280: crypto/x509: unexpected work during chain building
+.IP \[bu] 2
+CVE-2026-32281: crypto/x509: inefficient policy validation
+.RE
+.IP \[bu] 2
+Fix Denial of Service due to Panic in AWS SDK for Go v2 SDK EventStream
+Decoder (dependabot[bot])
+.IP \[bu] 2
+Update golang.org/x/image to 0.38.0 to fix CVE-2026-33809
+(dependabot[bot])
+.RE
+.IP \[bu] 2
+docs
+.RS 2
+.IP \[bu] 2
+Fix header level for metadata option (Clément Notin)
+.IP \[bu] 2
+Fix markdown issues in mount docs (albertony)
+.IP \[bu] 2
+Fix link to not be language specific (Ross Smith II)
+.IP \[bu] 2
+Note macOS 10.15 (Catalina) support with version v1.70.3 (kapitainsky)
+.RE
+.RE
+.IP \[bu] 2
+Filen
+.RS 2
+.IP \[bu] 2
+Update SDK version (Enduriel)
+.RE
+.SS v1.73.3 - 2026-03-23
+.PP
+See commits (https://github.com/rclone/rclone/compare/v1.73.2...v1.73.3)
+.IP \[bu] 2
+Bug Fixes
+.RS 2
+.IP \[bu] 2
+build
+.RS 2
+.IP \[bu] 2
+Update to google.golang.org/grpc 1.79.3 to fix CVE-2026-33186
+(dependabot[bot])
+.IP \[bu] 2
+Update to github.com/buger/jsonparser 1.1.2 to fix GHSA-6g7g-w4f8-9c9x
+(dependabot[bot])
+.RE
+.IP \[bu] 2
+doc fixes
+.RS 2
+.IP \[bu] 2
+Added text to the label showing version-introduced info (Jan-Philipp
+Reßler)
+.IP \[bu] 2
+Clarify Filen password change requires updating both password and API
+key in rclone config (Jason)
+.IP \[bu] 2
+s3: clarify multi tenant support for Cubbit (Marco Ferretti)
+.IP \[bu] 2
+jottacloud: Fix broken link (albertony)
+.RE
+.IP \[bu] 2
+lib/rest: Fix URLPathEscapeAll breaking WebDAV servers (eg nzbdav) with
+strict path matching (Andrew Furman)
+.IP \[bu] 2
+list: Fix nil pointer panic in Sorter when temp file creation fails
+(Nick Craig-Wood)
+.RE
+.SS v1.73.2 - 2026-03-06
+.PP
+See commits (https://github.com/rclone/rclone/compare/v1.73.1...v1.73.2)
+.IP \[bu] 2
+Bug Fixes
+.RS 2
+.IP \[bu] 2
+build
+.RS 2
+.IP \[bu] 2
+Update to go 1.25.8 to fix CVE-2026-27137 CVE-2026-27138 CVE-2026-25679
+CVE-2026-27142 (Nick Craig-Wood)
+.IP \[bu] 2
+Update github.com/cloudflare/circl to v1.6.3 to fix CVE-2026-1229 (Nick
+Craig-Wood)
+.IP \[bu] 2
+Update to golang.org/x/net v0.51.0 to fix CVE-2026-27141 (Nick
+Craig-Wood)
+.RE
+.IP \[bu] 2
+docs fixes:
+.RS 2
+.IP \[bu] 2
+bisync: Add group Sync to the bisync command (Jan-Philipp Reßler)
+.IP \[bu] 2
+Note that --use-server-modtime only works on some backends (Nick
+Craig-Wood)
+.IP \[bu] 2
+Document unsupported S3 object keys with double slashes (Adam Kasztenny)
+.IP \[bu] 2
+Fix headers hierarchy for mount.md (Dark Dragon)
+.IP \[bu] 2
+Fix new drive flag typo in changelog (razorloves)
+.RE
+.RE
+.IP \[bu] 2
+Archive
+.RS 2
+.IP \[bu] 2
+Extract: fix extraction with \[dq]./\[dq] prefix from tar entry paths
+(Varun Chawla)
+.RE
+.IP \[bu] 2
+Drime
+.RS 2
+.IP \[bu] 2
+Fix chunk-uploaded files ignoring workspace ID (a1pcm)
+.RE
+.IP \[bu] 2
+Internxt
+.RS 2
+.IP \[bu] 2
+Fix Entry doesn\[aq]t belong in directory errors on windows (jzunigax2)
+.RE
+.IP \[bu] 2
+WebDAV
+.RS 2
+.IP \[bu] 2
+Escape reserved characters in URL path segments (Varun Chawla)
+.IP \[bu] 2
+Add missing headers for CORS (Romāns Potašovs)
+.RE
+.SS v1.73.1 - 2026-02-17
+.PP
+See commits (https://github.com/rclone/rclone/compare/v1.73.0...v1.73.1)
+.IP \[bu] 2
+Bug Fixes
+.RS 2
+.IP \[bu] 2
+accounting: Fix missing server side stats from core/stats rc (Nick
+Craig-Wood)
+.IP \[bu] 2
+build
+.RS 2
+.IP \[bu] 2
+Fix CVE-2025-68121 by updating go to 1.25.7 or later (Nick Craig-Wood)
+.IP \[bu] 2
+Bump github.com/go-chi/chi/v5 from 5.2.3 to 5.2.5 to fix GO-2026-4316
+(albertony)
+.RE
+.IP \[bu] 2
+docs: Extend copyurl docs with an example of CSV FILENAMEs starting with
+a path.
+(Jack Kelly)
+.IP \[bu] 2
+march: Fix runtime: program exceeds 10000-thread limit (Nick Craig-Wood)
+.IP \[bu] 2
+pacer
+.RS 2
+.IP \[bu] 2
+Fix deadlock between pacer token and --max-connections (Nick Craig-Wood)
+.IP \[bu] 2
+Re-read the sleep time as it may be stale (Nick Craig-Wood)
+.RE
+.RE
+.IP \[bu] 2
+Drime
+.RS 2
+.IP \[bu] 2
+Fix files and directories being created in the default workspace (Nick
+Craig-Wood)
+.RE
+.IP \[bu] 2
+Filelu
+.RS 2
+.IP \[bu] 2
+Avoid buffering entire file in memory (kingston125)
+.IP \[bu] 2
+Add multipart upload support with configurable cutoff (kingston125)
+.RE
+.IP \[bu] 2
+Filen
+.RS 2
+.IP \[bu] 2
+Fix 32 bit targets not being able to list directories (Enduriel)
+.IP \[bu] 2
+Fix potential panic in case of error during upload (Enduriel)
+.RE
+.IP \[bu] 2
+Internxt
+.RS 2
+.IP \[bu] 2
+Implement re-login under refresh logic, improve retry logic (José
+Zúniga) -S3
+.IP \[bu] 2
+Set list_version to 2 for FileLu S3 configuration (kingston125)
+.RE
.SS v1.73.0 - 2026-01-30
.PP
See commits (https://github.com/rclone/rclone/compare/v1.72.0...v1.73.0)
@@ -86894,7 +90700,7 @@ Support authentication with new bucket restricted application keys
Drive
.RS 2
.IP \[bu] 2
-Add \f[V]--drive-metadata-force-expansive-access\f[R] flag (Nick
+Add \f[V]--drive-metadata-enforce-expansive-access\f[R] flag (Nick
Craig-Wood)
.IP \[bu] 2
Fix crash when trying to creating shortcut to a Google doc (Nick
@@ -105711,7 +109517,7 @@ ahxxm <[email protected]>
.IP \[bu] 2
Flora Thiebaut <[email protected]>
.IP \[bu] 2
-kingston125 <[email protected]>
.IP \[bu] 2
.IP \[bu] 2
@@ -105903,6 +109709,106 @@ jzunigax2 <[email protected]>
.IP \[bu] 2
StarHack <[email protected]>
+.IP \[bu] 2
+Leon Brocard <[email protected]>
+.IP \[bu] 2
+.IP \[bu] 2
+Jack Kelly <[email protected]>
+.IP \[bu] 2
+Prakhar Chhalotre <[email protected]>
+.IP \[bu] 2
+Varun Chawla <[email protected]>
+.IP \[bu] 2
+Jan-Philipp Reßler <[email protected]>
+.IP \[bu] 2
+Shlomi Avihou <[email protected]>
+.IP \[bu] 2
+.IP \[bu] 2
+Jan-Philipp Reßler <[email protected]>
+.IP \[bu] 2
+Dark Dragon <[email protected]>
+.IP \[bu] 2
+Leon Brocard <[email protected]>
+.IP \[bu] 2
+.IP \[bu] 2
+.IP \[bu] 2
+Bjoern Franke <[email protected]>
+.IP \[bu] 2
+.IP \[bu] 2
+Adam Kasztenny <[email protected]>
+.IP \[bu] 2
+Romāns Potašovs <[email protected]>
+.IP \[bu] 2
+Brian Bockelman <[email protected]>
+.IP \[bu] 2
+Bjoern Franke <[email protected]>
+.IP \[bu] 2
+razorloves <[email protected]>
+.IP \[bu] 2
+Duncan F <[email protected]>
+.IP \[bu] 2
+Billy Hughes <[email protected]>
+.IP \[bu] 2
+Bhagyashreek8 <[email protected]>
+.IP \[bu] 2
+Andriy Senyshyn <[email protected]>
+.IP \[bu] 2
+Andrew Furman <[email protected]>
+.IP \[bu] 2
+.IP \[bu] 2
+.IP \[bu] 2
+Patrick Farrell <[email protected]>
+.IP \[bu] 2
+BizaNator <[email protected]>
+.IP \[bu] 2
+.IP \[bu] 2
+jinkeyuu <[email protected]>
+.IP \[bu] 2
+jinyu.han <[email protected]>
+.IP \[bu] 2
+Claude Opus 4.6 <[email protected]>
+.IP \[bu] 2
+Andriy Senyshyn <[email protected]>
+.IP \[bu] 2
+Mike GIllan <[email protected]>
+.IP \[bu] 2
+Xiangzhe <[email protected]>
+.IP \[bu] 2
+.IP \[bu] 2
+.IP \[bu] 2
+Brais Couce <[email protected]>
+.IP \[bu] 2
+.IP \[bu] 2
+.IP \[bu] 2
+Jan Heylen <[email protected]>
+.IP \[bu] 2
+.IP \[bu] 2
+Anton Bordwine <[email protected]>
+.IP \[bu] 2
+mathieulongtin <[email protected]>
+.IP \[bu] 2
+Luke Cyca <[email protected]>
+.IP \[bu] 2
+.IP \[bu] 2
+Yakov Till <[email protected]>
+.IP \[bu] 2
+Chris Coughlan <[email protected]>
+.IP \[bu] 2
+John Volk <[email protected]>
.SH Contact the rclone project
.SS Forum
.PP