johanels/rclone
1
0
Fork 0
mirror of https://github.com/rclone/rclone.git synced 2025-12-12 06:24:14 +01:00
Code Issues Actions 6 Packages Projects Releases Wiki Activity

Version v1.71.2
Some checks failed
build / windows (push) Has been cancelled
Details
build / other_os (push) Has been cancelled
Details
build / mac_amd64 (push) Has been cancelled
Details
build / mac_arm64 (push) Has been cancelled
Details
build / linux (push) Has been cancelled
Details
build / go1.24 (push) Has been cancelled
Details
build / linux_386 (push) Has been cancelled
Details
build / lint (push) Has been cancelled
Details
build / android-all (push) Has been cancelled
Details
Build & Push Docker Images / Build Docker Image for linux/386 (push) Has been cancelled
Details
Build & Push Docker Images / Build Docker Image for linux/amd64 (push) Has been cancelled
Details
Build & Push Docker Images / Build Docker Image for linux/arm/v6 (push) Has been cancelled
Details
Build & Push Docker Images / Build Docker Image for linux/arm/v7 (push) Has been cancelled
Details
Build & Push Docker Images / Build Docker Image for linux/arm64 (push) Has been cancelled
Details
Build & Push Docker Images / Merge & Push Final Docker Image (push) Has been cancelled
Details

Browse Source
This commit is contained in:
Nick Craig-Wood
2025-10-20 12:59:58 +01:00
parent 4013f006b8
commit a2b292b31d
16 changed files with 586 additions and 309 deletions
Download Patch File Download Diff File Expand all files Collapse all files

222
MANUAL.html generated
View File

@@ -233,7 +233,7 @@
<header id="title-block-header"> <header id="title-block-header">
<h1 class="title">rclone(1) User Manual</h1> <h1 class="title">rclone(1) User Manual</h1>
<p class="author">Nick Craig-Wood</p> <p class="author">Nick Craig-Wood</p>
<p class="date">Sep 24, 2025</p> <p class="date">Oct 20, 2025</p>
</header> </header>
<h1 id="name">NAME</h1> <h1 id="name">NAME</h1>
<p>rclone - manage files on cloud storage</p> <p>rclone - manage files on cloud storage</p>
@@ -444,6 +444,7 @@ S3, that work out of the box.)</p>
<li>Hetzner Storage Box</li> <li>Hetzner Storage Box</li>
<li>HiDrive</li> <li>HiDrive</li>
<li>HTTP</li> <li>HTTP</li>
<li>Huawei OBS</li>
<li>iCloud Drive</li> <li>iCloud Drive</li>
<li>ImageKit</li> <li>ImageKit</li>
<li>Internet Archive</li> <li>Internet Archive</li>
@@ -486,7 +487,9 @@ S3, that work out of the box.)</p>
<li>QingStor</li> <li>QingStor</li>
<li>Qiniu Cloud Object Storage (Kodo)</li> <li>Qiniu Cloud Object Storage (Kodo)</li>
<li>Quatrix by Maytech</li> <li>Quatrix by Maytech</li>
<li>RackCorp Object Storage</li>
<li>Rackspace Cloud Files</li> <li>Rackspace Cloud Files</li>
<li>Rclone Serve S3</li>
<li>rsync.net</li> <li>rsync.net</li>
<li>Scaleway</li> <li>Scaleway</li>
<li>Seafile</li> <li>Seafile</li>
@@ -2911,10 +2914,11 @@ for rclone commands, flags and backends.</li>
<p>Remote authorization.</p> <p>Remote authorization.</p>
<h2 id="synopsis-19">Synopsis</h2> <h2 id="synopsis-19">Synopsis</h2>
<p>Remote authorization. Used to authorize a remote or headless rclone <p>Remote authorization. Used to authorize a remote or headless rclone
from a machine with a browser - use as instructed by rclone config.</p> from a machine with a browser. Use as instructed by rclone config. See
also the <a href="/remote_setup">remote setup documentation</a>.</p>
<p>The command requires 1-3 arguments:</p> <p>The command requires 1-3 arguments:</p>
<ul> <ul>
<li>fs name (e.g., "drive", "s3", etc.)</li> <li>Name of a backend (e.g. "drive", "s3")</li>
<li>Either a base64 encoded JSON blob obtained from a previous rclone <li>Either a base64 encoded JSON blob obtained from a previous rclone
config session</li> config session</li>
<li>Or a client_id and client_secret pair obtained from the remote <li>Or a client_id and client_secret pair obtained from the remote
@@ -2925,7 +2929,7 @@ default browser automatically.</p>
<p>Use --template to generate HTML output via a custom Go template. If a <p>Use --template to generate HTML output via a custom Go template. If a
blank string is provided as an argument to this flag, the default blank string is provided as an argument to this flag, the default
template is used.</p> template is used.</p>
<pre><code>rclone authorize &lt;fs name&gt; [base64_json_blob | client_id client_secret] [flags]</code></pre> <pre><code>rclone authorize &lt;backendname&gt; [base64_json_blob | client_id client_secret] [flags]</code></pre>
<h2 id="options-19">Options</h2> <h2 id="options-19">Options</h2>
<pre><code> --auth-no-open-browser Do not automatically open auth link in default browser <pre><code> --auth-no-open-browser Do not automatically open auth link in default browser
-h, --help help for authorize -h, --help help for authorize
@@ -4301,10 +4305,10 @@ class="sourceCode sh"><code class="sourceCode bash"><span id="cb243-1"><a href="
<span id="cb243-2"><a href="#cb243-2" aria-hidden="true" tabindex="-1"></a><span class="ex">//</span> Output: stories/The Quick Brown Fox!.txt</span></code></pre></div> <span id="cb243-2"><a href="#cb243-2" aria-hidden="true" tabindex="-1"></a><span class="ex">//</span> Output: stories/The Quick Brown Fox!.txt</span></code></pre></div>
<div class="sourceCode" id="cb244"><pre <div class="sourceCode" id="cb244"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb244-1"><a href="#cb244-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> convmv <span class="st">&quot;stories/The Quick Brown Fox!&quot;</span> <span class="at">--name-transform</span> <span class="st">&quot;date=-{YYYYMMDD}&quot;</span></span> class="sourceCode sh"><code class="sourceCode bash"><span id="cb244-1"><a href="#cb244-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> convmv <span class="st">&quot;stories/The Quick Brown Fox!&quot;</span> <span class="at">--name-transform</span> <span class="st">&quot;date=-{YYYYMMDD}&quot;</span></span>
<span id="cb244-2"><a href="#cb244-2" aria-hidden="true" tabindex="-1"></a><span class="ex">//</span> Output: stories/The Quick Brown Fox!-20250924</span></code></pre></div> <span id="cb244-2"><a href="#cb244-2" aria-hidden="true" tabindex="-1"></a><span class="ex">//</span> Output: stories/The Quick Brown Fox!-20251020</span></code></pre></div>
<div class="sourceCode" id="cb245"><pre <div class="sourceCode" id="cb245"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb245-1"><a href="#cb245-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> convmv <span class="st">&quot;stories/The Quick Brown Fox!&quot;</span> <span class="at">--name-transform</span> <span class="st">&quot;date=-{macfriendlytime}&quot;</span></span> class="sourceCode sh"><code class="sourceCode bash"><span id="cb245-1"><a href="#cb245-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> convmv <span class="st">&quot;stories/The Quick Brown Fox!&quot;</span> <span class="at">--name-transform</span> <span class="st">&quot;date=-{macfriendlytime}&quot;</span></span>
<span id="cb245-2"><a href="#cb245-2" aria-hidden="true" tabindex="-1"></a><span class="ex">//</span> Output: stories/The Quick Brown Fox!-2025-09-24 0413PM</span></code></pre></div> <span id="cb245-2"><a href="#cb245-2" aria-hidden="true" tabindex="-1"></a><span class="ex">//</span> Output: stories/The Quick Brown Fox!-2025-10-20 1251PM</span></code></pre></div>
<div class="sourceCode" id="cb246"><pre <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> convmv <span class="st">&quot;stories/The Quick Brown Fox!.txt&quot;</span> <span class="at">--name-transform</span> <span class="st">&quot;all,regex=[</span><span class="dt">\\</span><span class="st">.</span><span class="dt">\\</span><span class="st">w]/ab&quot;</span></span> 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> convmv <span class="st">&quot;stories/The Quick Brown Fox!.txt&quot;</span> <span class="at">--name-transform</span> <span class="st">&quot;all,regex=[</span><span class="dt">\\</span><span class="st">.</span><span class="dt">\\</span><span class="st">w]/ab&quot;</span></span>
<span id="cb246-2"><a href="#cb246-2" aria-hidden="true" tabindex="-1"></a><span class="ex">//</span> Output: ababababababab/ababab ababababab ababababab ababab!abababab</span></code></pre></div> <span id="cb246-2"><a href="#cb246-2" aria-hidden="true" tabindex="-1"></a><span class="ex">//</span> Output: ababababababab/ababab ababababab ababababab ababab!abababab</span></code></pre></div>
@@ -7999,7 +8003,7 @@ set a single username and password with the <code>--rc-user</code> and
<p>Alternatively, you can have the reverse proxy manage authentication <p>Alternatively, you can have the reverse proxy manage authentication
and use the username provided in the configured header with and use the username provided in the configured header with
<code>--user-from-header</code> (e.g., <code>--user-from-header</code> (e.g.,
<code>--rc---user-from-header=x-remote-user</code>). Ensure the proxy is <code>--rc-user-from-header=x-remote-user</code>). Ensure the proxy is
trusted and headers cannot be spoofed, as misconfiguration may lead to trusted and headers cannot be spoofed, as misconfiguration may lead to
unauthorized access.</p> unauthorized access.</p>
<p>If either of the above authentication methods is not configured and <p>If either of the above authentication methods is not configured and
@@ -10014,7 +10018,7 @@ set a single username and password with the <code>--user</code> and
<p>Alternatively, you can have the reverse proxy manage authentication <p>Alternatively, you can have the reverse proxy manage authentication
and use the username provided in the configured header with and use the username provided in the configured header with
<code>--user-from-header</code> (e.g., <code>--user-from-header</code> (e.g.,
<code>----user-from-header=x-remote-user</code>). Ensure the proxy is <code>--user-from-header=x-remote-user</code>). Ensure the proxy is
trusted and headers cannot be spoofed, as misconfiguration may lead to trusted and headers cannot be spoofed, as misconfiguration may lead to
unauthorized access.</p> unauthorized access.</p>
<p>If either of the above authentication methods is not configured and <p>If either of the above authentication methods is not configured and
@@ -11259,7 +11263,7 @@ set a single username and password with the <code>--user</code> and
<p>Alternatively, you can have the reverse proxy manage authentication <p>Alternatively, you can have the reverse proxy manage authentication
and use the username provided in the configured header with and use the username provided in the configured header with
<code>--user-from-header</code> (e.g., <code>--user-from-header</code> (e.g.,
<code>----user-from-header=x-remote-user</code>). Ensure the proxy is <code>--user-from-header=x-remote-user</code>). Ensure the proxy is
trusted and headers cannot be spoofed, as misconfiguration may lead to trusted and headers cannot be spoofed, as misconfiguration may lead to
unauthorized access.</p> unauthorized access.</p>
<p>If either of the above authentication methods is not configured and <p>If either of the above authentication methods is not configured and
@@ -11439,7 +11443,7 @@ set a single username and password with the <code>--user</code> and
<p>Alternatively, you can have the reverse proxy manage authentication <p>Alternatively, you can have the reverse proxy manage authentication
and use the username provided in the configured header with and use the username provided in the configured header with
<code>--user-from-header</code> (e.g., <code>--user-from-header</code> (e.g.,
<code>----user-from-header=x-remote-user</code>). Ensure the proxy is <code>--user-from-header=x-remote-user</code>). Ensure the proxy is
trusted and headers cannot be spoofed, as misconfiguration may lead to trusted and headers cannot be spoofed, as misconfiguration may lead to
unauthorized access.</p> unauthorized access.</p>
<p>If either of the above authentication methods is not configured and <p>If either of the above authentication methods is not configured and
@@ -12856,7 +12860,7 @@ set a single username and password with the <code>--user</code> and
<p>Alternatively, you can have the reverse proxy manage authentication <p>Alternatively, you can have the reverse proxy manage authentication
and use the username provided in the configured header with and use the username provided in the configured header with
<code>--user-from-header</code> (e.g., <code>--user-from-header</code> (e.g.,
<code>----user-from-header=x-remote-user</code>). Ensure the proxy is <code>--user-from-header=x-remote-user</code>). Ensure the proxy is
trusted and headers cannot be spoofed, as misconfiguration may lead to trusted and headers cannot be spoofed, as misconfiguration may lead to
unauthorized access.</p> unauthorized access.</p>
<p>If either of the above authentication methods is not configured and <p>If either of the above authentication methods is not configured and
@@ -16752,18 +16756,20 @@ directory holding the config file.</li>
<h1 id="configuring-rclone-on-a-remote-headless-machine">Configuring <h1 id="configuring-rclone-on-a-remote-headless-machine">Configuring
rclone on a remote / headless machine</h1> rclone on a remote / headless machine</h1>
<p>Some of the configurations (those involving oauth2) require an <p>Some of the configurations (those involving oauth2) require an
Internet connected web browser.</p> internet-connected web browser.</p>
<p>If you are trying to set rclone up on a remote or headless box with <p>If you are trying to set rclone up on a remote or headless machine
no browser available on it (e.g. a NAS or a server in a datacenter) then with no browser available on it (e.g. a NAS or a server in a
you will need to use an alternative means of configuration. There are datacenter), then you will need to use an alternative means of
two ways of doing it, described below.</p> configuration. There are three ways of doing it, described below.</p>
<h2 id="configuring-using-rclone-authorize">Configuring using rclone <h2 id="configuring-using-rclone-authorize">Configuring using rclone
authorize</h2> authorize</h2>
<p>On the headless box run <code>rclone</code> config but answer <p>On the headless machine run <a href="/commands/rclone_config">rclone
<code>N</code> to the <code>Use auto config?</code> question.</p> config</a>, but answer <code>N</code> to the question
<pre class="text"><code>Use auto config? <code>Use web browser to automatically authenticate rclone with remote?</code>.</p>
* Say Y if not sure <pre class="text"><code>Use web browser to automatically authenticate rclone with remote?
* Say N if you are working on a remote or headless machine * 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 (default) y) Yes (default)
n) No n) No
@@ -16775,20 +16781,24 @@ a web browser available.
For more help and alternate methods see: https://rclone.org/remote_setup/ For more help and alternate methods see: https://rclone.org/remote_setup/
Execute the following on the machine with the web browser (same rclone Execute the following on the machine with the web browser (same rclone
version recommended): version recommended):
rclone authorize &quot;onedrive&quot; rclone authorize &quot;onedrive&quot;
Then paste the result. Then paste the result.
Enter a value. Enter a value.
config_token&gt;</code></pre> config_token&gt;</code></pre>
<p>Then on your main desktop machine</p> <p>Then on your main desktop machine, run <a
href="https://rclone.org/commands/rclone_authorize/">rclone
authorize</a>.</p>
<pre class="text"><code>rclone authorize &quot;onedrive&quot; <pre class="text"><code>rclone authorize &quot;onedrive&quot;
If your browser doesn&#39;t open automatically go to the following link: http://127.0.0.1:53682/auth NOTICE: Make sure your Redirect URL is set to &quot;http://localhost:53682/&quot; in your custom config.
Log in and authorize rclone for access NOTICE: If your browser doesn&#39;t open automatically go to the following link: http://127.0.0.1:53682/auth?state=xxxxxxxxxxxxxxxxxxxxxx
Waiting for code... NOTICE: Log in and authorize rclone for access
NOTICE: Waiting for code...
Got code Got code
Paste the following into your remote machine ---&gt; Paste the following into your remote machine ---&gt;
SECRET_TOKEN SECRET_TOKEN
&lt;---End paste</code></pre> &lt;---End paste</code></pre>
<p>Then back to the headless box, paste in the code</p> <p>Then back to the headless machine, paste in the code.</p>
<pre class="text"><code>config_token&gt; SECRET_TOKEN <pre class="text"><code>config_token&gt; SECRET_TOKEN
-------------------- --------------------
[acd12] [acd12]
@@ -16802,38 +16812,50 @@ d) Delete this remote
y/e/d&gt;</code></pre> y/e/d&gt;</code></pre>
<h2 id="configuring-by-copying-the-config-file">Configuring by copying <h2 id="configuring-by-copying-the-config-file">Configuring by copying
the config file</h2> the config file</h2>
<p>Rclone stores all of its config in a single configuration file. This <p>Rclone stores all of its configuration in a single file. This can
can easily be copied to configure a remote rclone.</p> easily be copied to configure a remote rclone (although some backends
<p>So first configure rclone on your desktop machine with</p> does not support reusing the same configuration, consult your backend
documentation to be sure).</p>
<p>Start by running <a href="/commands/rclone_config">rclone config</a>
to create the configuration file on your desktop machine.</p>
<div class="sourceCode" id="cb688"><pre <div class="sourceCode" id="cb688"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb688-1"><a href="#cb688-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config</span></code></pre></div> class="sourceCode sh"><code class="sourceCode bash"><span id="cb688-1"><a href="#cb688-1" aria-hidden="true" tabindex="-1"></a><span class="ex">rclone</span> config</span></code></pre></div>
<p>to set up the config file.</p> <p>Then locate the file by running <a
<p>Find the config file by running <code>rclone config file</code>, for href="/commands/rclone_config_file">rclone config file</a>.</p>
example</p>
<div class="sourceCode" id="cb689"><pre <div class="sourceCode" id="cb689"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb689-1"><a href="#cb689-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone config file</span> class="sourceCode sh"><code class="sourceCode bash"><span id="cb689-1"><a href="#cb689-1" aria-hidden="true" tabindex="-1"></a><span class="ex">$</span> rclone config file</span>
<span id="cb689-2"><a href="#cb689-2" aria-hidden="true" tabindex="-1"></a><span class="ex">Configuration</span> file is stored at:</span> <span id="cb689-2"><a href="#cb689-2" aria-hidden="true" tabindex="-1"></a><span class="ex">Configuration</span> file is stored at:</span>
<span id="cb689-3"><a href="#cb689-3" aria-hidden="true" tabindex="-1"></a><span class="ex">/home/user/.rclone.conf</span></span></code></pre></div> <span id="cb689-3"><a href="#cb689-3" aria-hidden="true" tabindex="-1"></a><span class="ex">/home/user/.rclone.conf</span></span></code></pre></div>
<p>Now transfer it to the remote box (scp, cut paste, ftp, sftp, etc.) <p>Finally, transfer the file to the remote machine (scp, cut paste,
and place it in the correct place (use <code>rclone config file</code> ftp, sftp, etc.) and place it in the correct location (use <a
on the remote box to find out where).</p> href="/commands/rclone_config_file">rclone config file</a> on the remote
machine to find out where).</p>
<h2 id="configuring-using-ssh-tunnel">Configuring using SSH Tunnel</h2> <h2 id="configuring-using-ssh-tunnel">Configuring using SSH Tunnel</h2>
<p>Linux and MacOS users can utilize SSH Tunnel to redirect the headless <p>If you have an SSH client installed on your local machine, you can
box port 53682 to local machine by using the following command:</p> set up an SSH tunnel to redirect the port 53682 into the headless
machine by using the following command:</p>
<div class="sourceCode" id="cb690"><pre <div class="sourceCode" id="cb690"><pre
class="sourceCode sh"><code class="sourceCode bash"><span id="cb690-1"><a href="#cb690-1" aria-hidden="true" tabindex="-1"></a><span class="fu">ssh</span> <span class="at">-L</span> localhost:53682:localhost:53682 username@remote_server</span></code></pre></div> class="sourceCode sh"><code class="sourceCode bash"><span id="cb690-1"><a href="#cb690-1" aria-hidden="true" tabindex="-1"></a><span class="fu">ssh</span> <span class="at">-L</span> localhost:53682:localhost:53682 username@remote_server</span></code></pre></div>
<p>Then on the headless box run <code>rclone config</code> and answer <p>Then on the headless machine run <a
<code>Y</code> to the <code>Use auto config?</code> question.</p> href="/commands/rclone_config">rclone config</a> and answer
<pre class="text"><code>Use auto config? <code>Y</code> to the question
* Say Y if not sure <code>Use web browser to automatically authenticate rclone with remote?</code>.</p>
* Say N if you are working on a remote or headless machine <pre class="text"><code>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 (default) y) Yes (default)
n) No n) No
y/n&gt; y</code></pre> y/n&gt; y
<p>Then copy and paste the auth url NOTICE: Make sure your Redirect URL is set to &quot;http://localhost:53682/&quot; in your custom config.
<code>http://127.0.0.1:53682/auth?state=xxxxxxxxxxxx</code> to the NOTICE: If your browser doesn&#39;t open automatically go to the following link: http://127.0.0.1:53682/auth?state=xxxxxxxxxxxxxxxxxxxxxx
browser on your local machine, complete the auth and it is done.</p> NOTICE: Log in and authorize rclone for access
NOTICE: Waiting for code...</code></pre>
<p>Finally, copy and paste the presented URL
<code>http://127.0.0.1:53682/auth?state=xxxxxxxxxxxxxxxxxxxxxx</code> to
the browser on your local machine, complete the auth and you are
done.</p>
<h1 id="filtering-includes-and-excludes">Filtering, includes and <h1 id="filtering-includes-and-excludes">Filtering, includes and
excludes</h1> excludes</h1>
<p>Filter flags determine which files rclone <code>sync</code>, <p>Filter flags determine which files rclone <code>sync</code>,
@@ -22311,7 +22333,7 @@ split into groups.</p>
--tpslimit float Limit HTTP transactions per second to this --tpslimit float Limit HTTP transactions per second to this
--tpslimit-burst int Max burst of transactions for --tpslimit (default 1) --tpslimit-burst int Max burst of transactions for --tpslimit (default 1)
--use-cookies Enable session cookiejar --use-cookies Enable session cookiejar
--user-agent string Set the user-agent to a specified string (default &quot;rclone/v1.71.1&quot;)</code></pre> --user-agent string Set the user-agent to a specified string (default &quot;rclone/v1.71.2&quot;)</code></pre>
<h2 id="performance">Performance</h2> <h2 id="performance">Performance</h2>
<p>Flags helpful for increasing performance.</p> <p>Flags helpful for increasing performance.</p>
<pre><code> --buffer-size SizeSuffix In memory buffer size when reading files for each --transfer (default 16Mi) <pre><code> --buffer-size SizeSuffix In memory buffer size when reading files for each --transfer (default 16Mi)
@@ -33426,8 +33448,8 @@ e) Edit this remote
d) Delete this remote d) Delete this remote
y/e/d&gt; y</code></pre> y/e/d&gt; y</code></pre>
<p>See the <a href="https://rclone.org/remote_setup/">remote setup <p>See the <a href="https://rclone.org/remote_setup/">remote setup
docs</a> for how to set it up on a machine with no Internet browser docs</a> for how to set it up on a machine without an internet-connected
available.</p> web browser available.</p>
<p>Note that rclone runs a webserver on your local machine to collect <p>Note that rclone runs a webserver on your local machine to collect
the token as returned from Box. This only runs from the moment it opens the token as returned from Box. This only runs from the moment it opens
your browser to the moment you get back the verification code. This is your browser to the moment you get back the verification code. This is
@@ -35232,8 +35254,8 @@ e) Edit this remote
d) Delete this remote d) Delete this remote
y/e/d&gt; y</code></pre> y/e/d&gt; y</code></pre>
<p>See the <a href="https://rclone.org/remote_setup/">remote setup <p>See the <a href="https://rclone.org/remote_setup/">remote setup
docs</a> for how to set it up on a machine with no Internet browser docs</a> for how to set it up on a machine without an internet-connected
available.</p> web browser available.</p>
<p>Note that rclone runs a webserver on your local machine to collect <p>Note that rclone runs a webserver on your local machine to collect
the token as returned from Citrix ShareFile. This only runs from the the token as returned from Citrix ShareFile. This only runs from the
moment it opens your browser to the moment you get back the verification moment it opens your browser to the moment you get back the verification
@@ -36733,8 +36755,8 @@ e) Edit this remote
d) Delete this remote d) Delete this remote
y/e/d&gt; y</code></pre> y/e/d&gt; y</code></pre>
<p>See the <a href="https://rclone.org/remote_setup/">remote setup <p>See the <a href="https://rclone.org/remote_setup/">remote setup
docs</a> for how to set it up on a machine with no Internet browser docs</a> for how to set it up on a machine without an internet-connected
available.</p> web browser available.</p>
<p>Note that rclone runs a webserver on your local machine to collect <p>Note that rclone runs a webserver on your local machine to collect
the token as returned from Dropbox. This only runs from the moment it the token as returned from Dropbox. This only runs from the moment it
opens your browser to the moment you get back the verification code. opens your browser to the moment you get back the verification code.
@@ -38736,7 +38758,9 @@ Choose a number from below, or type in your own value
\ &quot;us-east1&quot; \ &quot;us-east1&quot;
13 / Northern Virginia. 13 / Northern Virginia.
\ &quot;us-east4&quot; \ &quot;us-east4&quot;
14 / Oregon. 14 / Ohio.
\ &quot;us-east5&quot;
15 / Oregon.
\ &quot;us-west1&quot; \ &quot;us-west1&quot;
location&gt; 12 location&gt; 12
The storage class to use when storing objects in Google Cloud Storage. The storage class to use when storing objects in Google Cloud Storage.
@@ -38781,8 +38805,8 @@ e) Edit this remote
d) Delete this remote d) Delete this remote
y/e/d&gt; y</code></pre> y/e/d&gt; y</code></pre>
<p>See the <a href="https://rclone.org/remote_setup/">remote setup <p>See the <a href="https://rclone.org/remote_setup/">remote setup
docs</a> for how to set it up on a machine with no Internet browser docs</a> for how to set it up on a machine without an internet-connected
available.</p> web browser available.</p>
<p>Note that rclone runs a webserver on your local machine to collect <p>Note that rclone runs a webserver on your local machine to collect
the token as returned from Google if using web browser to automatically the token as returned from Google if using web browser to automatically
authenticate. This only runs from the moment it opens your browser to authenticate. This only runs from the moment it opens your browser to
@@ -39272,6 +39296,10 @@ then you will need to set this.</p>
<ul> <ul>
<li>Northern Virginia</li> <li>Northern Virginia</li>
</ul></li> </ul></li>
<li>"us-east5"
<ul>
<li>Ohio</li>
</ul></li>
<li>"us-west1" <li>"us-west1"
<ul> <ul>
<li>Oregon</li> <li>Oregon</li>
@@ -39596,8 +39624,8 @@ e) Edit this remote
d) Delete this remote d) Delete this remote
y/e/d&gt; y</code></pre> y/e/d&gt; y</code></pre>
<p>See the <a href="https://rclone.org/remote_setup/">remote setup <p>See the <a href="https://rclone.org/remote_setup/">remote setup
docs</a> for how to set it up on a machine with no Internet browser docs</a> for how to set it up on a machine without an internet-connected
available.</p> web browser available.</p>
<p>Note that rclone runs a webserver on your local machine to collect <p>Note that rclone runs a webserver on your local machine to collect
the token as returned from Google if using web browser to automatically the token as returned from Google if using web browser to automatically
authenticate. This only runs from the moment it opens your browser to authenticate. This only runs from the moment it opens your browser to
@@ -41538,8 +41566,8 @@ e) Edit this remote
d) Delete this remote d) Delete this remote
y/e/d&gt; y</code></pre> y/e/d&gt; y</code></pre>
<p>See the <a href="https://rclone.org/remote_setup/">remote setup <p>See the <a href="https://rclone.org/remote_setup/">remote setup
docs</a> for how to set it up on a machine with no Internet browser docs</a> for how to set it up on a machine without an internet-connected
available.</p> web browser available.</p>
<p>Note that rclone runs a webserver on your local machine to collect <p>Note that rclone runs a webserver on your local machine to collect
the token as returned from Google if using web browser to automatically the token as returned from Google if using web browser to automatically
authenticate. This only runs from the moment it opens your browser to authenticate. This only runs from the moment it opens your browser to
@@ -42597,8 +42625,8 @@ your account and hence should not be shared with other persons.</strong>
See the <a href="#keeping-your-tokens-safe">below section</a> for more See the <a href="#keeping-your-tokens-safe">below section</a> for more
information.</p> information.</p>
<p>See the <a href="https://rclone.org/remote_setup/">remote setup <p>See the <a href="https://rclone.org/remote_setup/">remote setup
docs</a> for how to set it up on a machine with no Internet browser docs</a> for how to set it up on a machine without an internet-connected
available.</p> web browser available.</p>
<p>Note that rclone runs a webserver on your local machine to collect <p>Note that rclone runs a webserver on your local machine to collect
the token as returned from HiDrive. This only runs from the moment it the token as returned from HiDrive. This only runs from the moment it
opens your browser to the moment you get back the verification code. The opens your browser to the moment you get back the verification code. The
@@ -47868,8 +47896,8 @@ e) Edit this remote
d) Delete this remote d) Delete this remote
y/e/d&gt; y</code></pre> y/e/d&gt; y</code></pre>
<p>See the <a href="https://rclone.org/remote_setup/">remote setup <p>See the <a href="https://rclone.org/remote_setup/">remote setup
docs</a> for how to set it up on a machine with no Internet browser docs</a> for how to set it up on a machine without an internet-connected
available.</p> web browser available.</p>
<p>Note that rclone runs a webserver on your local machine to collect <p>Note that rclone runs a webserver on your local machine to collect
the token as returned from Microsoft. This only runs from the moment it the token as returned from Microsoft. This only runs from the moment it
opens your browser to the moment you get back the verification code. opens your browser to the moment you get back the verification code.
@@ -51817,8 +51845,8 @@ e) Edit this remote
d) Delete this remote d) Delete this remote
y/e/d&gt; y</code></pre> y/e/d&gt; y</code></pre>
<p>See the <a href="https://rclone.org/remote_setup/">remote setup <p>See the <a href="https://rclone.org/remote_setup/">remote setup
docs</a> for how to set it up on a machine with no Internet browser docs</a> for how to set it up on a machine without an internet-connected
available.</p> web browser available.</p>
<p>Note if you are using remote config with rclone authorize while your <p>Note if you are using remote config with rclone authorize while your
pcloud server is the EU region, you will need to set the hostname in pcloud server is the EU region, you will need to set the hostname in
'Edit advanced config', otherwise you might get a token error.</p> 'Edit advanced config', otherwise you might get a token error.</p>
@@ -52568,8 +52596,8 @@ e) Edit this remote
d) Delete this remote d) Delete this remote
y/e/d&gt; </code></pre> y/e/d&gt; </code></pre>
<p>See the <a href="https://rclone.org/remote_setup/">remote setup <p>See the <a href="https://rclone.org/remote_setup/">remote setup
docs</a> for how to set it up on a machine with no Internet browser docs</a> for how to set it up on a machine without an internet-connected
available.</p> web browser available.</p>
<p>Note that rclone runs a webserver on your local machine to collect <p>Note that rclone runs a webserver on your local machine to collect
the token as returned from premiumize.me. This only runs from the moment the token as returned from premiumize.me. This only runs from the moment
it opens your browser to the moment you get back the verification code. it opens your browser to the moment you get back the verification code.
@@ -53107,8 +53135,8 @@ s) Set configuration password
q) Quit config q) Quit config
e/n/d/r/c/s/q&gt; q</code></pre> e/n/d/r/c/s/q&gt; q</code></pre>
<p>See the <a href="https://rclone.org/remote_setup/">remote setup <p>See the <a href="https://rclone.org/remote_setup/">remote setup
docs</a> for how to set it up on a machine with no Internet browser docs</a> for how to set it up on a machine without an internet-connected
available.</p> web browser available.</p>
<p>Note that rclone runs a webserver on your local machine to collect <p>Note that rclone runs a webserver on your local machine to collect
the token as returned from put.io if using web browser to automatically the token as returned from put.io if using web browser to automatically
authenticate. This only runs from the moment it opens your browser to authenticate. This only runs from the moment it opens your browser to
@@ -54987,7 +55015,7 @@ entered when you started to share on Windows. On smbd, it's the section
title in <code>smb.conf</code> (usually in <code>/etc/samba/</code>) title in <code>smb.conf</code> (usually in <code>/etc/samba/</code>)
file. You can find shares by querying the root if you're unsure (e.g. file. You can find shares by querying the root if you're unsure (e.g.
<code>rclone lsd remote:</code>).</p> <code>rclone lsd remote:</code>).</p>
<p>You can't access to the shared printers from rclone, obviously.</p> <p>You can't access the shared printers from rclone, obviously.</p>
<p>You can't use Anonymous access for logging in. You have to use the <p>You can't use Anonymous access for logging in. You have to use the
<code>guest</code> user with an empty password instead. The rclone <code>guest</code> user with an empty password instead. The rclone
client tries to avoid 8.3 names when uploading files by encoding client tries to avoid 8.3 names when uploading files by encoding
@@ -57192,8 +57220,8 @@ e) Edit this remote
d) Delete this remote d) Delete this remote
y/e/d&gt; y</code></pre> y/e/d&gt; y</code></pre>
<p>See the <a href="https://rclone.org/remote_setup/">remote setup <p>See the <a href="https://rclone.org/remote_setup/">remote setup
docs</a> for how to set it up on a machine with no Internet browser docs</a> for how to set it up on a machine without an internet-connected
available.</p> web browser available.</p>
<p>Note that rclone runs a webserver on your local machine to collect <p>Note that rclone runs a webserver on your local machine to collect
the token as returned from Yandex Disk. This only runs from the moment the token as returned from Yandex Disk. This only runs from the moment
it opens your browser to the moment you get back the verification code. it opens your browser to the moment you get back the verification code.
@@ -57425,8 +57453,8 @@ e) Edit this remote
d) Delete this remote d) Delete this remote
y/e/d&gt; </code></pre> y/e/d&gt; </code></pre>
<p>See the <a href="https://rclone.org/remote_setup/">remote setup <p>See the <a href="https://rclone.org/remote_setup/">remote setup
docs</a> for how to set it up on a machine with no Internet browser docs</a> for how to set it up on a machine without an internet-connected
available.</p> web browser available.</p>
<p>Rclone runs a webserver on your local computer to collect the <p>Rclone runs a webserver on your local computer to collect the
authorization token from Zoho Workdrive. This is only from the moment authorization token from Zoho Workdrive. This is only from the moment
your browser is opened until the token is returned. The webserver runs your browser is opened until the token is returned. The webserver runs
@@ -58481,6 +58509,48 @@ the output.</p>
</ul> </ul>
<!-- markdownlint-disable line-length --> <!-- markdownlint-disable line-length -->
<h1 id="changelog-1">Changelog</h1> <h1 id="changelog-1">Changelog</h1>
<h2 id="v1.71.2---2025-10-20">v1.71.2 - 2025-10-20</h2>
<p><a
href="https://github.com/rclone/rclone/compare/v1.71.1...v1.71.2">See
commits</a></p>
<ul>
<li>Bug Fixes
<ul>
<li>build
<ul>
<li>update Go to 1.25.3</li>
<li>Update Docker image Alpine version to fix CVE-2025-9230</li>
</ul></li>
<li>bisync: Fix race when CaptureOutput is used concurrently (Nick
Craig-Wood)</li>
<li>doc fixes (albertony, dougal, iTrooz, Matt LaPaglia, Nick
Craig-Wood)</li>
<li>index: Add missing providers (dougal)</li>
<li>serve http: Fix: logging URL on start (dougal)</li>
</ul></li>
<li>Azurefiles
<ul>
<li>Fix server side copy not waiting for completion (Vikas
Bhansali)</li>
</ul></li>
<li>B2
<ul>
<li>Fix 1TB+ uploads (dougal)</li>
</ul></li>
<li>Google Cloud Storage
<ul>
<li>Add region us-east5 (Dulani Woods)</li>
</ul></li>
<li>Mega
<ul>
<li>Fix 402 payment required errors (Nick Craig-Wood)</li>
</ul></li>
<li>Pikpak
<ul>
<li>Fix unnecessary retries by using URL expire parameter (Youfu
Zhang)</li>
</ul></li>
</ul>
<h2 id="v1.71.1---2025-09-24">v1.71.1 - 2025-09-24</h2> <h2 id="v1.71.1---2025-09-24">v1.71.1 - 2025-09-24</h2>
<p><a <p><a
href="https://github.com/rclone/rclone/compare/v1.71.0...v1.71.1">See href="https://github.com/rclone/rclone/compare/v1.71.0...v1.71.1">See

164
MANUAL.md generated
View File

@@ -1,6 +1,6 @@
% rclone(1) User Manual % rclone(1) User Manual
% Nick Craig-Wood % Nick Craig-Wood
% Sep 24, 2025 % Oct 20, 2025
# NAME # NAME
@@ -205,6 +205,7 @@ WebDAV or S3, that work out of the box.)
- Hetzner Storage Box - Hetzner Storage Box
- HiDrive - HiDrive
- HTTP - HTTP
- Huawei OBS
- iCloud Drive - iCloud Drive
- ImageKit - ImageKit
- Internet Archive - Internet Archive
@@ -247,7 +248,9 @@ WebDAV or S3, that work out of the box.)
- QingStor - QingStor
- Qiniu Cloud Object Storage (Kodo) - Qiniu Cloud Object Storage (Kodo)
- Quatrix by Maytech - Quatrix by Maytech
- RackCorp Object Storage
- Rackspace Cloud Files - Rackspace Cloud Files
- Rclone Serve S3
- rsync.net - rsync.net
- Scaleway - Scaleway
- Seafile - Seafile
@@ -3205,12 +3208,12 @@ Remote authorization.
## Synopsis ## Synopsis
Remote authorization. Used to authorize a remote or headless Remote authorization. Used to authorize a remote or headless
rclone from a machine with a browser - use as instructed by rclone from a machine with a browser. Use as instructed by rclone config.
rclone config. See also the [remote setup documentation](/remote_setup).
The command requires 1-3 arguments: The command requires 1-3 arguments:
- fs name (e.g., "drive", "s3", etc.) - Name of a backend (e.g. "drive", "s3")
- Either a base64 encoded JSON blob obtained from a previous rclone config session - Either a base64 encoded JSON blob obtained from a previous rclone config session
- Or a client_id and client_secret pair obtained from the remote service - Or a client_id and client_secret pair obtained from the remote service
@@ -3221,7 +3224,7 @@ Use --template to generate HTML output via a custom Go template. If a blank
string is provided as an argument to this flag, the default template is used. string is provided as an argument to this flag, the default template is used.
``` ```
rclone authorize <fs name> [base64_json_blob | client_id client_secret] [flags] rclone authorize <backendname> [base64_json_blob | client_id client_secret] [flags]
``` ```
## Options ## Options
@@ -4992,12 +4995,12 @@ rclone convmv "stories/The Quick Brown Fox!.txt" --name-transform "all,command=e
```sh ```sh
rclone convmv "stories/The Quick Brown Fox!" --name-transform "date=-{YYYYMMDD}" rclone convmv "stories/The Quick Brown Fox!" --name-transform "date=-{YYYYMMDD}"
// Output: stories/The Quick Brown Fox!-20250924 // Output: stories/The Quick Brown Fox!-20251020
``` ```
```sh ```sh
rclone convmv "stories/The Quick Brown Fox!" --name-transform "date=-{macfriendlytime}" rclone convmv "stories/The Quick Brown Fox!" --name-transform "date=-{macfriendlytime}"
// Output: stories/The Quick Brown Fox!-2025-09-24 0413PM // Output: stories/The Quick Brown Fox!-2025-10-20 1251PM
``` ```
```sh ```sh
@@ -9336,7 +9339,7 @@ You can either use an htpasswd file which can take lots of users, or
set a single username and password with the `--rc-user` and `--rc-pass` flags. set a single username and password with the `--rc-user` and `--rc-pass` flags.
Alternatively, you can have the reverse proxy manage authentication and use the Alternatively, you can have the reverse proxy manage authentication and use the
username provided in the configured header with `--user-from-header` (e.g., `--rc---user-from-header=x-remote-user`). username provided in the configured header with `--user-from-header` (e.g., `--rc-user-from-header=x-remote-user`).
Ensure the proxy is trusted and headers cannot be spoofed, as misconfiguration Ensure the proxy is trusted and headers cannot be spoofed, as misconfiguration
may lead to unauthorized access. may lead to unauthorized access.
@@ -11686,7 +11689,7 @@ You can either use an htpasswd file which can take lots of users, or
set a single username and password with the `--user` and `--pass` flags. set a single username and password with the `--user` and `--pass` flags.
Alternatively, you can have the reverse proxy manage authentication and use the Alternatively, you can have the reverse proxy manage authentication and use the
username provided in the configured header with `--user-from-header` (e.g., `----user-from-header=x-remote-user`). username provided in the configured header with `--user-from-header` (e.g., `--user-from-header=x-remote-user`).
Ensure the proxy is trusted and headers cannot be spoofed, as misconfiguration Ensure the proxy is trusted and headers cannot be spoofed, as misconfiguration
may lead to unauthorized access. may lead to unauthorized access.
@@ -13218,7 +13221,7 @@ You can either use an htpasswd file which can take lots of users, or
set a single username and password with the `--user` and `--pass` flags. set a single username and password with the `--user` and `--pass` flags.
Alternatively, you can have the reverse proxy manage authentication and use the Alternatively, you can have the reverse proxy manage authentication and use the
username provided in the configured header with `--user-from-header` (e.g., `----user-from-header=x-remote-user`). username provided in the configured header with `--user-from-header` (e.g., `--user-from-header=x-remote-user`).
Ensure the proxy is trusted and headers cannot be spoofed, as misconfiguration Ensure the proxy is trusted and headers cannot be spoofed, as misconfiguration
may lead to unauthorized access. may lead to unauthorized access.
@@ -13436,7 +13439,7 @@ You can either use an htpasswd file which can take lots of users, or
set a single username and password with the `--user` and `--pass` flags. set a single username and password with the `--user` and `--pass` flags.
Alternatively, you can have the reverse proxy manage authentication and use the Alternatively, you can have the reverse proxy manage authentication and use the
username provided in the configured header with `--user-from-header` (e.g., `----user-from-header=x-remote-user`). username provided in the configured header with `--user-from-header` (e.g., `--user-from-header=x-remote-user`).
Ensure the proxy is trusted and headers cannot be spoofed, as misconfiguration Ensure the proxy is trusted and headers cannot be spoofed, as misconfiguration
may lead to unauthorized access. may lead to unauthorized access.
@@ -15046,7 +15049,7 @@ You can either use an htpasswd file which can take lots of users, or
set a single username and password with the `--user` and `--pass` flags. set a single username and password with the `--user` and `--pass` flags.
Alternatively, you can have the reverse proxy manage authentication and use the Alternatively, you can have the reverse proxy manage authentication and use the
username provided in the configured header with `--user-from-header` (e.g., `----user-from-header=x-remote-user`). username provided in the configured header with `--user-from-header` (e.g., `--user-from-header=x-remote-user`).
Ensure the proxy is trusted and headers cannot be spoofed, as misconfiguration Ensure the proxy is trusted and headers cannot be spoofed, as misconfiguration
may lead to unauthorized access. may lead to unauthorized access.
@@ -19634,22 +19637,23 @@ The options set by environment variables can be seen with the `-vv` and
# Configuring rclone on a remote / headless machine # Configuring rclone on a remote / headless machine
Some of the configurations (those involving oauth2) require an Some of the configurations (those involving oauth2) require an
Internet connected web browser. internet-connected web browser.
If you are trying to set rclone up on a remote or headless box with no If you are trying to set rclone up on a remote or headless machine with no
browser available on it (e.g. a NAS or a server in a datacenter) then browser available on it (e.g. a NAS or a server in a datacenter), then
you will need to use an alternative means of configuration. There are you will need to use an alternative means of configuration. There are
two ways of doing it, described below. three ways of doing it, described below.
## Configuring using rclone authorize ## Configuring using rclone authorize
On the headless box run `rclone` config but answer `N` to the `Use auto config?` On the headless machine run [rclone config](/commands/rclone_config), but
question. answer `N` to the question `Use web browser to automatically authenticate rclone with remote?`.
```text ```text
Use auto config? Use web browser to automatically authenticate rclone with remote?
* Say Y if not sure * Say Y if the machine running rclone has a web browser you can use
* Say N if you are working on a remote or headless machine * 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 (default) y) Yes (default)
n) No n) No
@@ -19661,26 +19665,28 @@ a web browser available.
For more help and alternate methods see: https://rclone.org/remote_setup/ For more help and alternate methods see: https://rclone.org/remote_setup/
Execute the following on the machine with the web browser (same rclone Execute the following on the machine with the web browser (same rclone
version recommended): version recommended):
rclone authorize "onedrive" rclone authorize "onedrive"
Then paste the result. Then paste the result.
Enter a value. Enter a value.
config_token> config_token>
``` ```
Then on your main desktop machine Then on your main desktop machine, run [rclone authorize](https://rclone.org/commands/rclone_authorize/).
```text ```text
rclone authorize "onedrive" rclone authorize "onedrive"
If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth NOTICE: Make sure your Redirect URL is set to "http://localhost:53682/" in your custom config.
Log in and authorize rclone for access NOTICE: If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth?state=xxxxxxxxxxxxxxxxxxxxxx
Waiting for code... NOTICE: Log in and authorize rclone for access
NOTICE: Waiting for code...
Got code Got code
Paste the following into your remote machine ---> Paste the following into your remote machine --->
SECRET_TOKEN SECRET_TOKEN
<---End paste <---End paste
``` ```
Then back to the headless box, paste in the code Then back to the headless machine, paste in the code.
```text ```text
config_token> SECRET_TOKEN config_token> SECRET_TOKEN
@@ -19698,18 +19704,19 @@ y/e/d>
## Configuring by copying the config file ## Configuring by copying the config file
Rclone stores all of its config in a single configuration file. This Rclone stores all of its configuration in a single file. This can easily be
can easily be copied to configure a remote rclone. copied to configure a remote rclone (although some backends does not support
reusing the same configuration, consult your backend documentation to be
sure).
So first configure rclone on your desktop machine with Start by running [rclone config](/commands/rclone_config) to create the
configuration file on your desktop machine.
```sh ```sh
rclone config rclone config
``` ```
to set up the config file. Then locate the file by running [rclone config file](/commands/rclone_config_file).
Find the config file by running `rclone config file`, for example
```sh ```sh
$ rclone config file $ rclone config file
@@ -19717,34 +19724,40 @@ Configuration file is stored at:
/home/user/.rclone.conf /home/user/.rclone.conf
``` ```
Now transfer it to the remote box (scp, cut paste, ftp, sftp, etc.) and Finally, transfer the file to the remote machine (scp, cut paste, ftp, sftp, etc.)
place it in the correct place (use `rclone config file` on the remote and place it in the correct location (use [rclone config file](/commands/rclone_config_file)
box to find out where). on the remote machine to find out where).
## Configuring using SSH Tunnel ## Configuring using SSH Tunnel
Linux and MacOS users can utilize SSH Tunnel to redirect the headless box If you have an SSH client installed on your local machine, you can set up an
port 53682 to local machine by using the following command: SSH tunnel to redirect the port 53682 into the headless machine by using the
following command:
```sh ```sh
ssh -L localhost:53682:localhost:53682 username@remote_server ssh -L localhost:53682:localhost:53682 username@remote_server
``` ```
Then on the headless box run `rclone config` and answer `Y` to the Then on the headless machine run [rclone config](/commands/rclone_config) and
`Use auto config?` question. answer `Y` to the question `Use web browser to automatically authenticate rclone with remote?`.
```text ```text
Use auto config? Use web browser to automatically authenticate rclone with remote?
* Say Y if not sure * Say Y if the machine running rclone has a web browser you can use
* Say N if you are working on a remote or headless machine * 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 (default) y) Yes (default)
n) No n) No
y/n> y y/n> y
NOTICE: Make sure your Redirect URL is set to "http://localhost:53682/" in your custom config.
NOTICE: If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth?state=xxxxxxxxxxxxxxxxxxxxxx
NOTICE: Log in and authorize rclone for access
NOTICE: Waiting for code...
``` ```
Then copy and paste the auth url `http://127.0.0.1:53682/auth?state=xxxxxxxxxxxx` Finally, copy and paste the presented URL `http://127.0.0.1:53682/auth?state=xxxxxxxxxxxxxxxxxxxxxx`
to the browser on your local machine, complete the auth and it is done. to the browser on your local machine, complete the auth and you are done.
# Filtering, includes and excludes # Filtering, includes and excludes
@@ -24196,7 +24209,7 @@ Flags for general networking and HTTP stuff.
--tpslimit float Limit HTTP transactions per second to this --tpslimit float Limit HTTP transactions per second to this
--tpslimit-burst int Max burst of transactions for --tpslimit (default 1) --tpslimit-burst int Max burst of transactions for --tpslimit (default 1)
--use-cookies Enable session cookiejar --use-cookies Enable session cookiejar
--user-agent string Set the user-agent to a specified string (default "rclone/v1.71.1") --user-agent string Set the user-agent to a specified string (default "rclone/v1.71.2")
``` ```
@@ -35763,7 +35776,7 @@ y/e/d> y
``` ```
See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a
machine with no Internet browser available. machine without an internet-connected web browser available.
Note that rclone runs a webserver on your local machine to collect the Note that rclone runs a webserver on your local machine to collect the
token as returned from Box. This only runs from the moment it opens token as returned from Box. This only runs from the moment it opens
@@ -37755,7 +37768,7 @@ y/e/d> y
``` ```
See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a
machine with no Internet browser available. machine without an internet-connected web browser available.
Note that rclone runs a webserver on your local machine to collect the Note that rclone runs a webserver on your local machine to collect the
token as returned from Citrix ShareFile. This only runs from the moment it opens token as returned from Citrix ShareFile. This only runs from the moment it opens
@@ -39450,7 +39463,7 @@ y/e/d> y
``` ```
See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a
machine with no Internet browser available. machine without an internet-connected web browser available.
Note that rclone runs a webserver on your local machine to collect the Note that rclone runs a webserver on your local machine to collect the
token as returned from Dropbox. This only token as returned from Dropbox. This only
@@ -41750,7 +41763,9 @@ Choose a number from below, or type in your own value
\ "us-east1" \ "us-east1"
13 / Northern Virginia. 13 / Northern Virginia.
\ "us-east4" \ "us-east4"
14 / Oregon. 14 / Ohio.
\ "us-east5"
15 / Oregon.
\ "us-west1" \ "us-west1"
location> 12 location> 12
The storage class to use when storing objects in Google Cloud Storage. The storage class to use when storing objects in Google Cloud Storage.
@@ -41797,7 +41812,7 @@ y/e/d> y
``` ```
See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a
machine with no Internet browser available. machine without an internet-connected web browser available.
Note that rclone runs a webserver on your local machine to collect the Note that rclone runs a webserver on your local machine to collect the
token as returned from Google if using web browser to automatically token as returned from Google if using web browser to automatically
@@ -42243,6 +42258,8 @@ Properties:
- South Carolina - South Carolina
- "us-east4" - "us-east4"
- Northern Virginia - Northern Virginia
- "us-east5"
- Ohio
- "us-west1" - "us-west1"
- Oregon - Oregon
- "us-west2" - "us-west2"
@@ -42569,7 +42586,7 @@ y/e/d> y
``` ```
See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a
machine with no Internet browser available. machine without an internet-connected web browser available.
Note that rclone runs a webserver on your local machine to collect the Note that rclone runs a webserver on your local machine to collect the
token as returned from Google if using web browser to automatically token as returned from Google if using web browser to automatically
@@ -44514,7 +44531,7 @@ y/e/d> y
``` ```
See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a
machine with no Internet browser available. machine without an internet-connected web browser available.
Note that rclone runs a webserver on your local machine to collect the Note that rclone runs a webserver on your local machine to collect the
token as returned from Google if using web browser to automatically token as returned from Google if using web browser to automatically
@@ -45765,7 +45782,7 @@ and hence should not be shared with other persons.**
See the [below section](#keeping-your-tokens-safe) for more information. See the [below section](#keeping-your-tokens-safe) for more information.
See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a
machine with no Internet browser available. machine without an internet-connected web browser available.
Note that rclone runs a webserver on your local machine to collect the Note that rclone runs a webserver on your local machine to collect the
token as returned from HiDrive. This only runs from the moment it opens token as returned from HiDrive. This only runs from the moment it opens
@@ -51437,7 +51454,7 @@ y/e/d> y
``` ```
See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a
machine with no Internet browser available. machine without an internet-connected web browser available.
Note that rclone runs a webserver on your local machine to collect the Note that rclone runs a webserver on your local machine to collect the
token as returned from Microsoft. This only runs from the moment it token as returned from Microsoft. This only runs from the moment it
@@ -55335,7 +55352,7 @@ y/e/d> y
``` ```
See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a
machine with no Internet browser available. machine without an internet-connected web browser available.
Note if you are using remote config with rclone authorize while your pcloud Note if you are using remote config with rclone authorize while your pcloud
server is the EU region, you will need to set the hostname in 'Edit advanced server is the EU region, you will need to set the hostname in 'Edit advanced
@@ -56201,7 +56218,7 @@ y/e/d>
``` ```
See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a
machine with no Internet browser available. machine without an internet-connected web browser available.
Note that rclone runs a webserver on your local machine to collect the Note that rclone runs a webserver on your local machine to collect the
token as returned from premiumize.me. This only runs from the moment it opens token as returned from premiumize.me. This only runs from the moment it opens
@@ -56834,7 +56851,7 @@ e/n/d/r/c/s/q> q
``` ```
See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a
machine with no Internet browser available. machine without an internet-connected web browser available.
Note that rclone runs a webserver on your local machine to collect the Note that rclone runs a webserver on your local machine to collect the
token as returned from put.io if using web browser to automatically token as returned from put.io if using web browser to automatically
@@ -59078,7 +59095,7 @@ you started to share on Windows. On smbd, it's the section title in `smb.conf`
(usually in `/etc/samba/`) file. (usually in `/etc/samba/`) file.
You can find shares by querying the root if you're unsure (e.g. `rclone lsd remote:`). You can find shares by querying the root if you're unsure (e.g. `rclone lsd remote:`).
You can't access to the shared printers from rclone, obviously. You can't access the shared printers from rclone, obviously.
You can't use Anonymous access for logging in. You have to use the `guest` user You can't use Anonymous access for logging in. You have to use the `guest` user
with an empty password instead. The rclone client tries to avoid 8.3 names when with an empty password instead. The rclone client tries to avoid 8.3 names when
@@ -61501,7 +61518,7 @@ y/e/d> y
``` ```
See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a
machine with no Internet browser available. machine without an internet-connected web browser available.
Note that rclone runs a webserver on your local machine to collect the Note that rclone runs a webserver on your local machine to collect the
token as returned from Yandex Disk. This only runs from the moment it token as returned from Yandex Disk. This only runs from the moment it
@@ -61794,7 +61811,7 @@ y/e/d>
``` ```
See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a
machine with no Internet browser available. machine without an internet-connected web browser available.
Rclone runs a webserver on your local computer to collect the Rclone runs a webserver on your local computer to collect the
authorization token from Zoho Workdrive. This is only from the moment authorization token from Zoho Workdrive. This is only from the moment
@@ -62742,6 +62759,29 @@ Options:
# Changelog # Changelog
## v1.71.2 - 2025-10-20
[See commits](https://github.com/rclone/rclone/compare/v1.71.1...v1.71.2)
- Bug Fixes
- build
- update Go to 1.25.3
- Update Docker image Alpine version to fix CVE-2025-9230
- bisync: Fix race when CaptureOutput is used concurrently (Nick Craig-Wood)
- doc fixes (albertony, dougal, iTrooz, Matt LaPaglia, Nick Craig-Wood)
- index: Add missing providers (dougal)
- serve http: Fix: logging URL on start (dougal)
- Azurefiles
- Fix server side copy not waiting for completion (Vikas Bhansali)
- B2
- Fix 1TB+ uploads (dougal)
- Google Cloud Storage
- Add region us-east5 (Dulani Woods)
- Mega
- Fix 402 payment required errors (Nick Craig-Wood)
- Pikpak
- Fix unnecessary retries by using URL expire parameter (Youfu Zhang)
## v1.71.1 - 2025-09-24 ## v1.71.1 - 2025-09-24
[See commits](https://github.com/rclone/rclone/compare/v1.71.0...v1.71.1) [See commits](https://github.com/rclone/rclone/compare/v1.71.0...v1.71.1)

213
MANUAL.txt generated
View File

@@ -1,6 +1,6 @@
rclone(1) User Manual rclone(1) User Manual
Nick Craig-Wood Nick Craig-Wood
Sep 24, 2025 Oct 20, 2025
NAME NAME
@@ -192,6 +192,7 @@ S3, that work out of the box.)
- Hetzner Storage Box - Hetzner Storage Box
- HiDrive - HiDrive
- HTTP - HTTP
- Huawei OBS
- iCloud Drive - iCloud Drive
- ImageKit - ImageKit
- Internet Archive - Internet Archive
@@ -234,7 +235,9 @@ S3, that work out of the box.)
- QingStor - QingStor
- Qiniu Cloud Object Storage (Kodo) - Qiniu Cloud Object Storage (Kodo)
- Quatrix by Maytech - Quatrix by Maytech
- RackCorp Object Storage
- Rackspace Cloud Files - Rackspace Cloud Files
- Rclone Serve S3
- rsync.net - rsync.net
- Scaleway - Scaleway
- Seafile - Seafile
@@ -2832,11 +2835,12 @@ Remote authorization.
Synopsis Synopsis
Remote authorization. Used to authorize a remote or headless rclone from Remote authorization. Used to authorize a remote or headless rclone from
a machine with a browser - use as instructed by rclone config. a machine with a browser. Use as instructed by rclone config. See also
the remote setup documentation.
The command requires 1-3 arguments: The command requires 1-3 arguments:
- fs name (e.g., "drive", "s3", etc.) - Name of a backend (e.g. "drive", "s3")
- Either a base64 encoded JSON blob obtained from a previous rclone - Either a base64 encoded JSON blob obtained from a previous rclone
config session config session
- Or a client_id and client_secret pair obtained from the remote - Or a client_id and client_secret pair obtained from the remote
@@ -2849,7 +2853,7 @@ Use --template to generate HTML output via a custom Go template. If a
blank string is provided as an argument to this flag, the default blank string is provided as an argument to this flag, the default
template is used. template is used.
rclone authorize <fs name> [base64_json_blob | client_id client_secret] [flags] rclone authorize <backendname> [base64_json_blob | client_id client_secret] [flags]
Options Options
@@ -4307,10 +4311,10 @@ Examples:
// Output: stories/The Quick Brown Fox!.txt // Output: stories/The Quick Brown Fox!.txt
rclone convmv "stories/The Quick Brown Fox!" --name-transform "date=-{YYYYMMDD}" rclone convmv "stories/The Quick Brown Fox!" --name-transform "date=-{YYYYMMDD}"
// Output: stories/The Quick Brown Fox!-20250924 // Output: stories/The Quick Brown Fox!-20251020
rclone convmv "stories/The Quick Brown Fox!" --name-transform "date=-{macfriendlytime}" rclone convmv "stories/The Quick Brown Fox!" --name-transform "date=-{macfriendlytime}"
// Output: stories/The Quick Brown Fox!-2025-09-24 0413PM // Output: stories/The Quick Brown Fox!-2025-10-20 1251PM
rclone convmv "stories/The Quick Brown Fox!.txt" --name-transform "all,regex=[\\.\\w]/ab" rclone convmv "stories/The Quick Brown Fox!.txt" --name-transform "all,regex=[\\.\\w]/ab"
// Output: ababababababab/ababab ababababab ababababab ababab!abababab // Output: ababababababab/ababab ababababab ababababab ababab!abababab
@@ -8297,7 +8301,7 @@ a single username and password with the --rc-user and --rc-pass flags.
Alternatively, you can have the reverse proxy manage authentication and Alternatively, you can have the reverse proxy manage authentication and
use the username provided in the configured header with use the username provided in the configured header with
--user-from-header (e.g., --rc---user-from-header=x-remote-user). Ensure --user-from-header (e.g., --rc-user-from-header=x-remote-user). Ensure
the proxy is trusted and headers cannot be spoofed, as misconfiguration the proxy is trusted and headers cannot be spoofed, as misconfiguration
may lead to unauthorized access. may lead to unauthorized access.
@@ -10508,9 +10512,9 @@ a single username and password with the --user and --pass flags.
Alternatively, you can have the reverse proxy manage authentication and Alternatively, you can have the reverse proxy manage authentication and
use the username provided in the configured header with use the username provided in the configured header with
--user-from-header (e.g., ----user-from-header=x-remote-user). Ensure --user-from-header (e.g., --user-from-header=x-remote-user). Ensure the
the proxy is trusted and headers cannot be spoofed, as misconfiguration proxy is trusted and headers cannot be spoofed, as misconfiguration may
may lead to unauthorized access. lead to unauthorized access.
If either of the above authentication methods is not configured and If either of the above authentication methods is not configured and
client certificates are required by the --client-ca flag passed to the client certificates are required by the --client-ca flag passed to the
@@ -11935,9 +11939,9 @@ a single username and password with the --user and --pass flags.
Alternatively, you can have the reverse proxy manage authentication and Alternatively, you can have the reverse proxy manage authentication and
use the username provided in the configured header with use the username provided in the configured header with
--user-from-header (e.g., ----user-from-header=x-remote-user). Ensure --user-from-header (e.g., --user-from-header=x-remote-user). Ensure the
the proxy is trusted and headers cannot be spoofed, as misconfiguration proxy is trusted and headers cannot be spoofed, as misconfiguration may
may lead to unauthorized access. lead to unauthorized access.
If either of the above authentication methods is not configured and If either of the above authentication methods is not configured and
client certificates are required by the --client-ca flag passed to the client certificates are required by the --client-ca flag passed to the
@@ -12129,9 +12133,9 @@ a single username and password with the --user and --pass flags.
Alternatively, you can have the reverse proxy manage authentication and Alternatively, you can have the reverse proxy manage authentication and
use the username provided in the configured header with use the username provided in the configured header with
--user-from-header (e.g., ----user-from-header=x-remote-user). Ensure --user-from-header (e.g., --user-from-header=x-remote-user). Ensure the
the proxy is trusted and headers cannot be spoofed, as misconfiguration proxy is trusted and headers cannot be spoofed, as misconfiguration may
may lead to unauthorized access. lead to unauthorized access.
If either of the above authentication methods is not configured and If either of the above authentication methods is not configured and
client certificates are required by the --client-ca flag passed to the client certificates are required by the --client-ca flag passed to the
@@ -13677,9 +13681,9 @@ a single username and password with the --user and --pass flags.
Alternatively, you can have the reverse proxy manage authentication and Alternatively, you can have the reverse proxy manage authentication and
use the username provided in the configured header with use the username provided in the configured header with
--user-from-header (e.g., ----user-from-header=x-remote-user). Ensure --user-from-header (e.g., --user-from-header=x-remote-user). Ensure the
the proxy is trusted and headers cannot be spoofed, as misconfiguration proxy is trusted and headers cannot be spoofed, as misconfiguration may
may lead to unauthorized access. lead to unauthorized access.
If either of the above authentication methods is not configured and If either of the above authentication methods is not configured and
client certificates are required by the --client-ca flag passed to the client certificates are required by the --client-ca flag passed to the
@@ -17961,22 +17965,23 @@ The options set by environment variables can be seen with the -vv and
Configuring rclone on a remote / headless machine Configuring rclone on a remote / headless machine
Some of the configurations (those involving oauth2) require an Internet Some of the configurations (those involving oauth2) require an
connected web browser. internet-connected web browser.
If you are trying to set rclone up on a remote or headless box with no If you are trying to set rclone up on a remote or headless machine with
browser available on it (e.g. a NAS or a server in a datacenter) then no browser available on it (e.g. a NAS or a server in a datacenter),
you will need to use an alternative means of configuration. There are then you will need to use an alternative means of configuration. There
two ways of doing it, described below. are three ways of doing it, described below.
Configuring using rclone authorize Configuring using rclone authorize
On the headless box run rclone config but answer N to the On the headless machine run rclone config, but answer N to the question
Use auto config? question. Use web browser to automatically authenticate rclone with remote?.
Use auto config? Use web browser to automatically authenticate rclone with remote?
* Say Y if not sure * Say Y if the machine running rclone has a web browser you can use
* Say N if you are working on a remote or headless machine * 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 (default) y) Yes (default)
n) No n) No
@@ -17988,23 +17993,25 @@ Use auto config? question.
For more help and alternate methods see: https://rclone.org/remote_setup/ For more help and alternate methods see: https://rclone.org/remote_setup/
Execute the following on the machine with the web browser (same rclone Execute the following on the machine with the web browser (same rclone
version recommended): version recommended):
rclone authorize "onedrive" rclone authorize "onedrive"
Then paste the result. Then paste the result.
Enter a value. Enter a value.
config_token> config_token>
Then on your main desktop machine Then on your main desktop machine, run rclone authorize.
rclone authorize "onedrive" rclone authorize "onedrive"
If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth NOTICE: Make sure your Redirect URL is set to "http://localhost:53682/" in your custom config.
Log in and authorize rclone for access NOTICE: If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth?state=xxxxxxxxxxxxxxxxxxxxxx
Waiting for code... NOTICE: Log in and authorize rclone for access
NOTICE: Waiting for code...
Got code Got code
Paste the following into your remote machine ---> Paste the following into your remote machine --->
SECRET_TOKEN SECRET_TOKEN
<---End paste <---End paste
Then back to the headless box, paste in the code Then back to the headless machine, paste in the code.
config_token> SECRET_TOKEN config_token> SECRET_TOKEN
-------------------- --------------------
@@ -18020,46 +18027,54 @@ Then back to the headless box, paste in the code
Configuring by copying the config file Configuring by copying the config file
Rclone stores all of its config in a single configuration file. This can Rclone stores all of its configuration in a single file. This can easily
easily be copied to configure a remote rclone. be copied to configure a remote rclone (although some backends does not
support reusing the same configuration, consult your backend
documentation to be sure).
So first configure rclone on your desktop machine with Start by running rclone config to create the configuration file on your
desktop machine.
rclone config rclone config
to set up the config file. Then locate the file by running rclone config file.
Find the config file by running rclone config file, for example
$ rclone config file $ rclone config file
Configuration file is stored at: Configuration file is stored at:
/home/user/.rclone.conf /home/user/.rclone.conf
Now transfer it to the remote box (scp, cut paste, ftp, sftp, etc.) and Finally, transfer the file to the remote machine (scp, cut paste, ftp,
place it in the correct place (use rclone config file on the remote box sftp, etc.) and place it in the correct location (use rclone config file
to find out where). on the remote machine to find out where).
Configuring using SSH Tunnel Configuring using SSH Tunnel
Linux and MacOS users can utilize SSH Tunnel to redirect the headless If you have an SSH client installed on your local machine, you can set
box port 53682 to local machine by using the following command: up an SSH tunnel to redirect the port 53682 into the headless machine by
using the following command:
ssh -L localhost:53682:localhost:53682 username@remote_server ssh -L localhost:53682:localhost:53682 username@remote_server
Then on the headless box run rclone config and answer Y to the Then on the headless machine run rclone config and answer Y to the
Use auto config? question. question
Use web browser to automatically authenticate rclone with remote?.
Use auto config? Use web browser to automatically authenticate rclone with remote?
* Say Y if not sure * Say Y if the machine running rclone has a web browser you can use
* Say N if you are working on a remote or headless machine * 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 (default) y) Yes (default)
n) No n) No
y/n> y y/n> y
NOTICE: Make sure your Redirect URL is set to "http://localhost:53682/" in your custom config.
NOTICE: If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth?state=xxxxxxxxxxxxxxxxxxxxxx
NOTICE: Log in and authorize rclone for access
NOTICE: Waiting for code...
Then copy and paste the auth url Finally, copy and paste the presented URL
http://127.0.0.1:53682/auth?state=xxxxxxxxxxxx to the browser on your http://127.0.0.1:53682/auth?state=xxxxxxxxxxxxxxxxxxxxxx to the browser
local machine, complete the auth and it is done. on your local machine, complete the auth and you are done.
Filtering, includes and excludes Filtering, includes and excludes
@@ -22580,7 +22595,7 @@ Flags for general networking and HTTP stuff.
--tpslimit float Limit HTTP transactions per second to this --tpslimit float Limit HTTP transactions per second to this
--tpslimit-burst int Max burst of transactions for --tpslimit (default 1) --tpslimit-burst int Max burst of transactions for --tpslimit (default 1)
--use-cookies Enable session cookiejar --use-cookies Enable session cookiejar
--user-agent string Set the user-agent to a specified string (default "rclone/v1.71.1") --user-agent string Set the user-agent to a specified string (default "rclone/v1.71.2")
Performance Performance
@@ -33795,8 +33810,8 @@ This will guide you through an interactive setup process:
d) Delete this remote d) Delete this remote
y/e/d> y y/e/d> y
See the remote setup docs for how to set it up on a machine with no See the remote setup docs for how to set it up on a machine without an
Internet browser available. internet-connected web browser available.
Note that rclone runs a webserver on your local machine to collect the Note that rclone runs a webserver on your local machine to collect the
token as returned from Box. This only runs from the moment it opens your token as returned from Box. This only runs from the moment it opens your
@@ -35772,8 +35787,8 @@ This will guide you through an interactive setup process:
d) Delete this remote d) Delete this remote
y/e/d> y y/e/d> y
See the remote setup docs for how to set it up on a machine with no See the remote setup docs for how to set it up on a machine without an
Internet browser available. internet-connected web browser available.
Note that rclone runs a webserver on your local machine to collect the Note that rclone runs a webserver on your local machine to collect the
token as returned from Citrix ShareFile. This only runs from the moment token as returned from Citrix ShareFile. This only runs from the moment
@@ -37404,8 +37419,8 @@ This will guide you through an interactive setup process:
d) Delete this remote d) Delete this remote
y/e/d> y y/e/d> y
See the remote setup docs for how to set it up on a machine with no See the remote setup docs for how to set it up on a machine without an
Internet browser available. internet-connected web browser available.
Note that rclone runs a webserver on your local machine to collect the Note that rclone runs a webserver on your local machine to collect the
token as returned from Dropbox. This only runs from the moment it opens token as returned from Dropbox. This only runs from the moment it opens
@@ -39577,7 +39592,9 @@ This will guide you through an interactive setup process:
\ "us-east1" \ "us-east1"
13 / Northern Virginia. 13 / Northern Virginia.
\ "us-east4" \ "us-east4"
14 / Oregon. 14 / Ohio.
\ "us-east5"
15 / Oregon.
\ "us-west1" \ "us-west1"
location> 12 location> 12
The storage class to use when storing objects in Google Cloud Storage. The storage class to use when storing objects in Google Cloud Storage.
@@ -39622,8 +39639,8 @@ This will guide you through an interactive setup process:
d) Delete this remote d) Delete this remote
y/e/d> y y/e/d> y
See the remote setup docs for how to set it up on a machine with no See the remote setup docs for how to set it up on a machine without an
Internet browser available. internet-connected web browser available.
Note that rclone runs a webserver on your local machine to collect the Note that rclone runs a webserver on your local machine to collect the
token as returned from Google if using web browser to automatically token as returned from Google if using web browser to automatically
@@ -40048,6 +40065,8 @@ Properties:
- South Carolina - South Carolina
- "us-east4" - "us-east4"
- Northern Virginia - Northern Virginia
- "us-east5"
- Ohio
- "us-west1" - "us-west1"
- Oregon - Oregon
- "us-west2" - "us-west2"
@@ -40372,8 +40391,8 @@ This will guide you through an interactive setup process:
d) Delete this remote d) Delete this remote
y/e/d> y y/e/d> y
See the remote setup docs for how to set it up on a machine with no See the remote setup docs for how to set it up on a machine without an
Internet browser available. internet-connected web browser available.
Note that rclone runs a webserver on your local machine to collect the Note that rclone runs a webserver on your local machine to collect the
token as returned from Google if using web browser to automatically token as returned from Google if using web browser to automatically
@@ -42382,8 +42401,8 @@ This will guide you through an interactive setup process:
d) Delete this remote d) Delete this remote
y/e/d> y y/e/d> y
See the remote setup docs for how to set it up on a machine with no See the remote setup docs for how to set it up on a machine without an
Internet browser available. internet-connected web browser available.
Note that rclone runs a webserver on your local machine to collect the Note that rclone runs a webserver on your local machine to collect the
token as returned from Google if using web browser to automatically token as returned from Google if using web browser to automatically
@@ -43581,8 +43600,8 @@ You should be aware that OAuth-tokens can be used to access your account
and hence should not be shared with other persons. See the below section and hence should not be shared with other persons. See the below section
for more information. for more information.
See the remote setup docs for how to set it up on a machine with no See the remote setup docs for how to set it up on a machine without an
Internet browser available. internet-connected web browser available.
Note that rclone runs a webserver on your local machine to collect the Note that rclone runs a webserver on your local machine to collect the
token as returned from HiDrive. This only runs from the moment it opens token as returned from HiDrive. This only runs from the moment it opens
@@ -49176,8 +49195,8 @@ This will guide you through an interactive setup process:
d) Delete this remote d) Delete this remote
y/e/d> y y/e/d> y
See the remote setup docs for how to set it up on a machine with no See the remote setup docs for how to set it up on a machine without an
Internet browser available. internet-connected web browser available.
Note that rclone runs a webserver on your local machine to collect the Note that rclone runs a webserver on your local machine to collect the
token as returned from Microsoft. This only runs from the moment it token as returned from Microsoft. This only runs from the moment it
@@ -53111,8 +53130,8 @@ This will guide you through an interactive setup process:
d) Delete this remote d) Delete this remote
y/e/d> y y/e/d> y
See the remote setup docs for how to set it up on a machine with no See the remote setup docs for how to set it up on a machine without an
Internet browser available. internet-connected web browser available.
Note if you are using remote config with rclone authorize while your Note if you are using remote config with rclone authorize while your
pcloud server is the EU region, you will need to set the hostname in pcloud server is the EU region, you will need to set the hostname in
@@ -53971,8 +53990,8 @@ This will guide you through an interactive setup process:
d) Delete this remote d) Delete this remote
y/e/d> y/e/d>
See the remote setup docs for how to set it up on a machine with no See the remote setup docs for how to set it up on a machine without an
Internet browser available. internet-connected web browser available.
Note that rclone runs a webserver on your local machine to collect the Note that rclone runs a webserver on your local machine to collect the
token as returned from premiumize.me. This only runs from the moment it token as returned from premiumize.me. This only runs from the moment it
@@ -54576,8 +54595,8 @@ This will guide you through an interactive setup process:
q) Quit config q) Quit config
e/n/d/r/c/s/q> q e/n/d/r/c/s/q> q
See the remote setup docs for how to set it up on a machine with no See the remote setup docs for how to set it up on a machine without an
Internet browser available. internet-connected web browser available.
Note that rclone runs a webserver on your local machine to collect the Note that rclone runs a webserver on your local machine to collect the
token as returned from put.io if using web browser to automatically token as returned from put.io if using web browser to automatically
@@ -56727,7 +56746,7 @@ when you started to share on Windows. On smbd, it's the section title in
smb.conf (usually in /etc/samba/) file. You can find shares by querying smb.conf (usually in /etc/samba/) file. You can find shares by querying
the root if you're unsure (e.g. rclone lsd remote:). the root if you're unsure (e.g. rclone lsd remote:).
You can't access to the shared printers from rclone, obviously. You can't access the shared printers from rclone, obviously.
You can't use Anonymous access for logging in. You have to use the guest You can't use Anonymous access for logging in. You have to use the guest
user with an empty password instead. The rclone client tries to avoid user with an empty password instead. The rclone client tries to avoid
@@ -59122,8 +59141,8 @@ This will guide you through an interactive setup process:
d) Delete this remote d) Delete this remote
y/e/d> y y/e/d> y
See the remote setup docs for how to set it up on a machine with no See the remote setup docs for how to set it up on a machine without an
Internet browser available. internet-connected web browser available.
Note that rclone runs a webserver on your local machine to collect the Note that rclone runs a webserver on your local machine to collect the
token as returned from Yandex Disk. This only runs from the moment it token as returned from Yandex Disk. This only runs from the moment it
@@ -59400,8 +59419,8 @@ This will guide you through an interactive setup process:
d) Delete this remote d) Delete this remote
y/e/d> y/e/d>
See the remote setup docs for how to set it up on a machine with no See the remote setup docs for how to set it up on a machine without an
Internet browser available. internet-connected web browser available.
Rclone runs a webserver on your local computer to collect the Rclone runs a webserver on your local computer to collect the
authorization token from Zoho Workdrive. This is only from the moment authorization token from Zoho Workdrive. This is only from the moment
@@ -60326,6 +60345,32 @@ Options:
Changelog Changelog
v1.71.2 - 2025-10-20
See commits
- Bug Fixes
- build
- update Go to 1.25.3
- Update Docker image Alpine version to fix CVE-2025-9230
- bisync: Fix race when CaptureOutput is used concurrently (Nick
Craig-Wood)
- doc fixes (albertony, dougal, iTrooz, Matt LaPaglia, Nick
Craig-Wood)
- index: Add missing providers (dougal)
- serve http: Fix: logging URL on start (dougal)
- Azurefiles
- Fix server side copy not waiting for completion (Vikas Bhansali)
- B2
- Fix 1TB+ uploads (dougal)
- Google Cloud Storage
- Add region us-east5 (Dulani Woods)
- Mega
- Fix 402 payment required errors (Nick Craig-Wood)
- Pikpak
- Fix unnecessary retries by using URL expire parameter (Youfu
Zhang)
v1.71.1 - 2025-09-24 v1.71.1 - 2025-09-24
See commits See commits

23
docs/content/changelog.md
View File

@@ -6,6 +6,29 @@ description: "Rclone Changelog"
# Changelog # Changelog
## v1.71.2 - 2025-10-20
[See commits](https://github.com/rclone/rclone/compare/v1.71.1...v1.71.2)
- Bug Fixes
- build
- update Go to 1.25.3
- Update Docker image Alpine version to fix CVE-2025-9230
- bisync: Fix race when CaptureOutput is used concurrently (Nick Craig-Wood)
- doc fixes (albertony, dougal, iTrooz, Matt LaPaglia, Nick Craig-Wood)
- index: Add missing providers (dougal)
- serve http: Fix: logging URL on start (dougal)
- Azurefiles
- Fix server side copy not waiting for completion (Vikas Bhansali)
- B2
- Fix 1TB+ uploads (dougal)
- Google Cloud Storage
- Add region us-east5 (Dulani Woods)
- Mega
- Fix 402 payment required errors (Nick Craig-Wood)
- Pikpak
- Fix unnecessary retries by using URL expire parameter (Youfu Zhang)
## v1.71.1 - 2025-09-24 ## v1.71.1 - 2025-09-24
[See commits](https://github.com/rclone/rclone/compare/v1.71.0...v1.71.1) [See commits](https://github.com/rclone/rclone/compare/v1.71.0...v1.71.1)

2
docs/content/commands/rclone.md
View File

@@ -1013,7 +1013,7 @@ rclone [flags]
--use-json-log Use json log format --use-json-log Use json log format
--use-mmap Use mmap allocator (see docs) --use-mmap Use mmap allocator (see docs)
--use-server-modtime Use server modified time instead of object metadata --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.71.1") --user-agent string Set the user-agent to a specified string (default "rclone/v1.71.2")
-v, --verbose count Print lots more stuff (repeat for more) -v, --verbose count Print lots more stuff (repeat for more)
-V, --version Print the version number -V, --version Print the version number
--webdav-auth-redirect Preserve authentication on redirect --webdav-auth-redirect Preserve authentication on redirect

8
docs/content/commands/rclone_authorize.md
View File

@@ -11,12 +11,12 @@ Remote authorization.
## Synopsis ## Synopsis
Remote authorization. Used to authorize a remote or headless Remote authorization. Used to authorize a remote or headless
rclone from a machine with a browser - use as instructed by rclone from a machine with a browser. Use as instructed by rclone config.
rclone config. See also the [remote setup documentation](/remote_setup).
The command requires 1-3 arguments: The command requires 1-3 arguments:
- fs name (e.g., "drive", "s3", etc.) - Name of a backend (e.g. "drive", "s3")
- Either a base64 encoded JSON blob obtained from a previous rclone config session - Either a base64 encoded JSON blob obtained from a previous rclone config session
- Or a client_id and client_secret pair obtained from the remote service - Or a client_id and client_secret pair obtained from the remote service
@@ -27,7 +27,7 @@ Use --template to generate HTML output via a custom Go template. If a blank
string is provided as an argument to this flag, the default template is used. string is provided as an argument to this flag, the default template is used.
``` ```
rclone authorize <fs name> [base64_json_blob | client_id client_secret] [flags] rclone authorize <backendname> [base64_json_blob | client_id client_secret] [flags]
``` ```
## Options ## Options

4
docs/content/commands/rclone_convmv.md
View File

@@ -231,12 +231,12 @@ rclone convmv "stories/The Quick Brown Fox!.txt" --name-transform "all,command=e
```sh ```sh
rclone convmv "stories/The Quick Brown Fox!" --name-transform "date=-{YYYYMMDD}" rclone convmv "stories/The Quick Brown Fox!" --name-transform "date=-{YYYYMMDD}"
// Output: stories/The Quick Brown Fox!-20250924 // Output: stories/The Quick Brown Fox!-20251020
``` ```
```sh ```sh
rclone convmv "stories/The Quick Brown Fox!" --name-transform "date=-{macfriendlytime}" rclone convmv "stories/The Quick Brown Fox!" --name-transform "date=-{macfriendlytime}"
// Output: stories/The Quick Brown Fox!-2025-09-24 0413PM // Output: stories/The Quick Brown Fox!-2025-10-20 1251PM
``` ```
```sh ```sh

2
docs/content/commands/rclone_rcd.md
View File

@@ -130,7 +130,7 @@ You can either use an htpasswd file which can take lots of users, or
set a single username and password with the `--rc-user` and `--rc-pass` flags. set a single username and password with the `--rc-user` and `--rc-pass` flags.
Alternatively, you can have the reverse proxy manage authentication and use the Alternatively, you can have the reverse proxy manage authentication and use the
username provided in the configured header with `--user-from-header` (e.g., `--rc---user-from-header=x-remote-user`). username provided in the configured header with `--user-from-header` (e.g., `--rc-user-from-header=x-remote-user`).
Ensure the proxy is trusted and headers cannot be spoofed, as misconfiguration Ensure the proxy is trusted and headers cannot be spoofed, as misconfiguration
may lead to unauthorized access. may lead to unauthorized access.

2
docs/content/commands/rclone_serve_http.md
View File

@@ -132,7 +132,7 @@ You can either use an htpasswd file which can take lots of users, or
set a single username and password with the `--user` and `--pass` flags. set a single username and password with the `--user` and `--pass` flags.
Alternatively, you can have the reverse proxy manage authentication and use the Alternatively, you can have the reverse proxy manage authentication and use the
username provided in the configured header with `--user-from-header` (e.g., `----user-from-header=x-remote-user`). username provided in the configured header with `--user-from-header` (e.g., `--user-from-header=x-remote-user`).
Ensure the proxy is trusted and headers cannot be spoofed, as misconfiguration Ensure the proxy is trusted and headers cannot be spoofed, as misconfiguration
may lead to unauthorized access. may lead to unauthorized access.

2
docs/content/commands/rclone_serve_restic.md
View File

@@ -173,7 +173,7 @@ You can either use an htpasswd file which can take lots of users, or
set a single username and password with the `--user` and `--pass` flags. set a single username and password with the `--user` and `--pass` flags.
Alternatively, you can have the reverse proxy manage authentication and use the Alternatively, you can have the reverse proxy manage authentication and use the
username provided in the configured header with `--user-from-header` (e.g., `----user-from-header=x-remote-user`). username provided in the configured header with `--user-from-header` (e.g., `--user-from-header=x-remote-user`).
Ensure the proxy is trusted and headers cannot be spoofed, as misconfiguration Ensure the proxy is trusted and headers cannot be spoofed, as misconfiguration
may lead to unauthorized access. may lead to unauthorized access.

2
docs/content/commands/rclone_serve_s3.md
View File

@@ -155,7 +155,7 @@ You can either use an htpasswd file which can take lots of users, or
set a single username and password with the `--user` and `--pass` flags. set a single username and password with the `--user` and `--pass` flags.
Alternatively, you can have the reverse proxy manage authentication and use the Alternatively, you can have the reverse proxy manage authentication and use the
username provided in the configured header with `--user-from-header` (e.g., `----user-from-header=x-remote-user`). username provided in the configured header with `--user-from-header` (e.g., `--user-from-header=x-remote-user`).
Ensure the proxy is trusted and headers cannot be spoofed, as misconfiguration Ensure the proxy is trusted and headers cannot be spoofed, as misconfiguration
may lead to unauthorized access. may lead to unauthorized access.

2
docs/content/commands/rclone_serve_webdav.md
View File

@@ -189,7 +189,7 @@ You can either use an htpasswd file which can take lots of users, or
set a single username and password with the `--user` and `--pass` flags. set a single username and password with the `--user` and `--pass` flags.
Alternatively, you can have the reverse proxy manage authentication and use the Alternatively, you can have the reverse proxy manage authentication and use the
username provided in the configured header with `--user-from-header` (e.g., `----user-from-header=x-remote-user`). username provided in the configured header with `--user-from-header` (e.g., `--user-from-header=x-remote-user`).
Ensure the proxy is trusted and headers cannot be spoofed, as misconfiguration Ensure the proxy is trusted and headers cannot be spoofed, as misconfiguration
may lead to unauthorized access. may lead to unauthorized access.

2
docs/content/flags.md
View File

@@ -121,7 +121,7 @@ Flags for general networking and HTTP stuff.
--tpslimit float Limit HTTP transactions per second to this --tpslimit float Limit HTTP transactions per second to this
--tpslimit-burst int Max burst of transactions for --tpslimit (default 1) --tpslimit-burst int Max burst of transactions for --tpslimit (default 1)
--use-cookies Enable session cookiejar --use-cookies Enable session cookiejar
--user-agent string Set the user-agent to a specified string (default "rclone/v1.71.1") --user-agent string Set the user-agent to a specified string (default "rclone/v1.71.2")
``` ```

2
docs/content/googlecloudstorage.md
View File

@@ -595,6 +595,8 @@ Properties:
- South Carolina - South Carolina
- "us-east4" - "us-east4"
- Northern Virginia - Northern Virginia
- "us-east5"
- Ohio
- "us-west1" - "us-west1"
- Oregon - Oregon
- "us-west2" - "us-west2"

4
lib/transform/transform.md
View File

@@ -218,12 +218,12 @@ rclone convmv "stories/The Quick Brown Fox!.txt" --name-transform "all,command=e
```sh ```sh
rclone convmv "stories/The Quick Brown Fox!" --name-transform "date=-{YYYYMMDD}" rclone convmv "stories/The Quick Brown Fox!" --name-transform "date=-{YYYYMMDD}"
// Output: stories/The Quick Brown Fox!-20250924 // Output: stories/The Quick Brown Fox!-20251020
``` ```
```sh ```sh
rclone convmv "stories/The Quick Brown Fox!" --name-transform "date=-{macfriendlytime}" rclone convmv "stories/The Quick Brown Fox!" --name-transform "date=-{macfriendlytime}"
// Output: stories/The Quick Brown Fox!-2025-09-24 0423PM // Output: stories/The Quick Brown Fox!-2025-10-20 0101PM
``` ```
```sh ```sh

225
rclone.1 generated
View File

@@ -15,7 +15,7 @@
. ftr VB CB . ftr VB CB
. ftr VBI CBI . ftr VBI CBI
.\} .\}
.TH "rclone" "1" "Sep 24, 2025" "User Manual" "" .TH "rclone" "1" "Oct 20, 2025" "User Manual" ""
.hy .hy
.SH NAME .SH NAME
.PP .PP
@@ -292,6 +292,8 @@ HiDrive
.IP \[bu] 2 .IP \[bu] 2
HTTP HTTP
.IP \[bu] 2 .IP \[bu] 2
Huawei OBS
.IP \[bu] 2
iCloud Drive iCloud Drive
.IP \[bu] 2 .IP \[bu] 2
ImageKit ImageKit
@@ -376,8 +378,12 @@ Qiniu Cloud Object Storage (Kodo)
.IP \[bu] 2 .IP \[bu] 2
Quatrix by Maytech Quatrix by Maytech
.IP \[bu] 2 .IP \[bu] 2
RackCorp Object Storage
.IP \[bu] 2
Rackspace Cloud Files Rackspace Cloud Files
.IP \[bu] 2 .IP \[bu] 2
Rclone Serve S3
.IP \[bu] 2
rsync.net rsync.net
.IP \[bu] 2 .IP \[bu] 2
Scaleway Scaleway
@@ -3808,11 +3814,14 @@ Remote authorization.
.PP .PP
Remote authorization. Remote authorization.
Used to authorize a remote or headless rclone from a machine with a Used to authorize a remote or headless rclone from a machine with a
browser - use as instructed by rclone config. browser.
Use as instructed by rclone config.
See also the remote setup documentation.
.PP .PP
The command requires 1-3 arguments: The command requires 1-3 arguments:
.IP \[bu] 2 .IP \[bu] 2
fs name (e.g., \[dq]drive\[dq], \[dq]s3\[dq], etc.) Name of a backend (e.g.
\[dq]drive\[dq], \[dq]s3\[dq])
.IP \[bu] 2 .IP \[bu] 2
Either a base64 encoded JSON blob obtained from a previous rclone config Either a base64 encoded JSON blob obtained from a previous rclone config
session session
@@ -3828,7 +3837,7 @@ template is used.
.IP .IP
.nf .nf
\f[C] \f[C]
rclone authorize <fs name> [base64_json_blob | client_id client_secret] [flags] rclone authorize <backendname> [base64_json_blob | client_id client_secret] [flags]
\f[R] \f[R]
.fi .fi
.SS Options .SS Options
@@ -5794,14 +5803,14 @@ rclone convmv \[dq]stories/The Quick Brown Fox!.txt\[dq] --name-transform \[dq]a
.nf .nf
\f[C] \f[C]
rclone convmv \[dq]stories/The Quick Brown Fox!\[dq] --name-transform \[dq]date=-{YYYYMMDD}\[dq] rclone convmv \[dq]stories/The Quick Brown Fox!\[dq] --name-transform \[dq]date=-{YYYYMMDD}\[dq]
// Output: stories/The Quick Brown Fox!-20250924 // Output: stories/The Quick Brown Fox!-20251020
\f[R] \f[R]
.fi .fi
.IP .IP
.nf .nf
\f[C] \f[C]
rclone convmv \[dq]stories/The Quick Brown Fox!\[dq] --name-transform \[dq]date=-{macfriendlytime}\[dq] rclone convmv \[dq]stories/The Quick Brown Fox!\[dq] --name-transform \[dq]date=-{macfriendlytime}\[dq]
// Output: stories/The Quick Brown Fox!-2025-09-24 0413PM // Output: stories/The Quick Brown Fox!-2025-10-20 1251PM
\f[R] \f[R]
.fi .fi
.IP .IP
@@ -10834,7 +10843,7 @@ a single username and password with the \f[V]--rc-user\f[R] and
Alternatively, you can have the reverse proxy manage authentication and Alternatively, you can have the reverse proxy manage authentication and
use the username provided in the configured header with use the username provided in the configured header with
\f[V]--user-from-header\f[R] (e.g., \f[V]--user-from-header\f[R] (e.g.,
\f[V]--rc---user-from-header=x-remote-user\f[R]). \f[V]--rc-user-from-header=x-remote-user\f[R]).
Ensure the proxy is trusted and headers cannot be spoofed, as Ensure the proxy is trusted and headers cannot be spoofed, as
misconfiguration may lead to unauthorized access. misconfiguration may lead to unauthorized access.
.PP .PP
@@ -13558,7 +13567,7 @@ a single username and password with the \f[V]--user\f[R] and
Alternatively, you can have the reverse proxy manage authentication and Alternatively, you can have the reverse proxy manage authentication and
use the username provided in the configured header with use the username provided in the configured header with
\f[V]--user-from-header\f[R] (e.g., \f[V]--user-from-header\f[R] (e.g.,
\f[V]----user-from-header=x-remote-user\f[R]). \f[V]--user-from-header=x-remote-user\f[R]).
Ensure the proxy is trusted and headers cannot be spoofed, as Ensure the proxy is trusted and headers cannot be spoofed, as
misconfiguration may lead to unauthorized access. misconfiguration may lead to unauthorized access.
.PP .PP
@@ -15279,7 +15288,7 @@ a single username and password with the \f[V]--user\f[R] and
Alternatively, you can have the reverse proxy manage authentication and Alternatively, you can have the reverse proxy manage authentication and
use the username provided in the configured header with use the username provided in the configured header with
\f[V]--user-from-header\f[R] (e.g., \f[V]--user-from-header\f[R] (e.g.,
\f[V]----user-from-header=x-remote-user\f[R]). \f[V]--user-from-header=x-remote-user\f[R]).
Ensure the proxy is trusted and headers cannot be spoofed, as Ensure the proxy is trusted and headers cannot be spoofed, as
misconfiguration may lead to unauthorized access. misconfiguration may lead to unauthorized access.
.PP .PP
@@ -15533,7 +15542,7 @@ a single username and password with the \f[V]--user\f[R] and
Alternatively, you can have the reverse proxy manage authentication and Alternatively, you can have the reverse proxy manage authentication and
use the username provided in the configured header with use the username provided in the configured header with
\f[V]--user-from-header\f[R] (e.g., \f[V]--user-from-header\f[R] (e.g.,
\f[V]----user-from-header=x-remote-user\f[R]). \f[V]--user-from-header=x-remote-user\f[R]).
Ensure the proxy is trusted and headers cannot be spoofed, as Ensure the proxy is trusted and headers cannot be spoofed, as
misconfiguration may lead to unauthorized access. misconfiguration may lead to unauthorized access.
.PP .PP
@@ -17444,7 +17453,7 @@ a single username and password with the \f[V]--user\f[R] and
Alternatively, you can have the reverse proxy manage authentication and Alternatively, you can have the reverse proxy manage authentication and
use the username provided in the configured header with use the username provided in the configured header with
\f[V]--user-from-header\f[R] (e.g., \f[V]--user-from-header\f[R] (e.g.,
\f[V]----user-from-header=x-remote-user\f[R]). \f[V]--user-from-header=x-remote-user\f[R]).
Ensure the proxy is trusted and headers cannot be spoofed, as Ensure the proxy is trusted and headers cannot be spoofed, as
misconfiguration may lead to unauthorized access. misconfiguration may lead to unauthorized access.
.PP .PP
@@ -22813,24 +22822,26 @@ The options set by environment variables can be seen with the
\f[V]rclone version -vv\f[R]. \f[V]rclone version -vv\f[R].
.SH Configuring rclone on a remote / headless machine .SH Configuring rclone on a remote / headless machine
.PP .PP
Some of the configurations (those involving oauth2) require an Internet Some of the configurations (those involving oauth2) require an
connected web browser. internet-connected web browser.
.PP .PP
If you are trying to set rclone up on a remote or headless box with no If you are trying to set rclone up on a remote or headless machine with
browser available on it (e.g. no browser available on it (e.g.
a NAS or a server in a datacenter) then you will need to use an a NAS or a server in a datacenter), then you will need to use an
alternative means of configuration. alternative means of configuration.
There are two ways of doing it, described below. There are three ways of doing it, described below.
.SS Configuring using rclone authorize .SS Configuring using rclone authorize
.PP .PP
On the headless box run \f[V]rclone\f[R] config but answer \f[V]N\f[R] On the headless machine run rclone config, but answer \f[V]N\f[R] to the
to the \f[V]Use auto config?\f[R] question. question
\f[V]Use web browser to automatically authenticate rclone with remote?\f[R].
.IP .IP
.nf .nf
\f[C] \f[C]
Use auto config? Use web browser to automatically authenticate rclone with remote?
* Say Y if not sure * Say Y if the machine running rclone has a web browser you can use
* Say N if you are working on a remote or headless machine * 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 (default) y) Yes (default)
n) No n) No
@@ -22842,21 +22853,24 @@ a web browser available.
For more help and alternate methods see: https://rclone.org/remote_setup/ For more help and alternate methods see: https://rclone.org/remote_setup/
Execute the following on the machine with the web browser (same rclone Execute the following on the machine with the web browser (same rclone
version recommended): version recommended):
rclone authorize \[dq]onedrive\[dq] rclone authorize \[dq]onedrive\[dq]
Then paste the result. Then paste the result.
Enter a value. Enter a value.
config_token> config_token>
\f[R] \f[R]
.fi .fi
.PP .PP
Then on your main desktop machine Then on your main desktop machine, run rclone
authorize (https://rclone.org/commands/rclone_authorize/).
.IP .IP
.nf .nf
\f[C] \f[C]
rclone authorize \[dq]onedrive\[dq] rclone authorize \[dq]onedrive\[dq]
If your browser doesn\[aq]t open automatically go to the following link: http://127.0.0.1:53682/auth NOTICE: Make sure your Redirect URL is set to \[dq]http://localhost:53682/\[dq] in your custom config.
Log in and authorize rclone for access NOTICE: If your browser doesn\[aq]t open automatically go to the following link: http://127.0.0.1:53682/auth?state=xxxxxxxxxxxxxxxxxxxxxx
Waiting for code... NOTICE: Log in and authorize rclone for access
NOTICE: Waiting for code...
Got code Got code
Paste the following into your remote machine ---> Paste the following into your remote machine --->
SECRET_TOKEN SECRET_TOKEN
@@ -22864,7 +22878,7 @@ SECRET_TOKEN
\f[R] \f[R]
.fi .fi
.PP .PP
Then back to the headless box, paste in the code Then back to the headless machine, paste in the code.
.IP .IP
.nf .nf
\f[C] \f[C]
@@ -22883,10 +22897,13 @@ y/e/d>
.fi .fi
.SS Configuring by copying the config file .SS Configuring by copying the config file
.PP .PP
Rclone stores all of its config in a single configuration file. Rclone stores all of its configuration in a single file.
This can easily be copied to configure a remote rclone. This can easily be copied to configure a remote rclone (although some
backends does not support reusing the same configuration, consult your
backend documentation to be sure).
.PP .PP
So first configure rclone on your desktop machine with Start by running rclone config to create the configuration file on your
desktop machine.
.IP .IP
.nf .nf
\f[C] \f[C]
@@ -22894,10 +22911,7 @@ rclone config
\f[R] \f[R]
.fi .fi
.PP .PP
to set up the config file. Then locate the file by running rclone config file.
.PP
Find the config file by running \f[V]rclone config file\f[R], for
example
.IP .IP
.nf .nf
\f[C] \f[C]
@@ -22907,13 +22921,15 @@ Configuration file is stored at:
\f[R] \f[R]
.fi .fi
.PP .PP
Now transfer it to the remote box (scp, cut paste, ftp, sftp, etc.) Finally, transfer the file to the remote machine (scp, cut paste, ftp,
and place it in the correct place (use \f[V]rclone config file\f[R] on sftp, etc.)
the remote box to find out where). and place it in the correct location (use rclone config file on the
remote machine to find out where).
.SS Configuring using SSH Tunnel .SS Configuring using SSH Tunnel
.PP .PP
Linux and MacOS users can utilize SSH Tunnel to redirect the headless If you have an SSH client installed on your local machine, you can set
box port 53682 to local machine by using the following command: up an SSH tunnel to redirect the port 53682 into the headless machine by
using the following command:
.IP .IP
.nf .nf
\f[C] \f[C]
@@ -22921,24 +22937,30 @@ ssh -L localhost:53682:localhost:53682 username\[at]remote_server
\f[R] \f[R]
.fi .fi
.PP .PP
Then on the headless box run \f[V]rclone config\f[R] and answer Then on the headless machine run rclone config and answer \f[V]Y\f[R] to
\f[V]Y\f[R] to the \f[V]Use auto config?\f[R] question. the question
\f[V]Use web browser to automatically authenticate rclone with remote?\f[R].
.IP .IP
.nf .nf
\f[C] \f[C]
Use auto config? Use web browser to automatically authenticate rclone with remote?
* Say Y if not sure * Say Y if the machine running rclone has a web browser you can use
* Say N if you are working on a remote or headless machine * 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 (default) y) Yes (default)
n) No n) No
y/n> y y/n> y
NOTICE: Make sure your Redirect URL is set to \[dq]http://localhost:53682/\[dq] in your custom config.
NOTICE: If your browser doesn\[aq]t open automatically go to the following link: http://127.0.0.1:53682/auth?state=xxxxxxxxxxxxxxxxxxxxxx
NOTICE: Log in and authorize rclone for access
NOTICE: Waiting for code...
\f[R] \f[R]
.fi .fi
.PP .PP
Then copy and paste the auth url Finally, copy and paste the presented URL
\f[V]http://127.0.0.1:53682/auth?state=xxxxxxxxxxxx\f[R] to the browser \f[V]http://127.0.0.1:53682/auth?state=xxxxxxxxxxxxxxxxxxxxxx\f[R] to
on your local machine, complete the auth and it is done. the browser on your local machine, complete the auth and you are done.
.SH Filtering, includes and excludes .SH Filtering, includes and excludes
.PP .PP
Filter flags determine which files rclone \f[V]sync\f[R], Filter flags determine which files rclone \f[V]sync\f[R],
@@ -30967,7 +30989,7 @@ Flags for general networking and HTTP stuff.
--tpslimit float Limit HTTP transactions per second to this --tpslimit float Limit HTTP transactions per second to this
--tpslimit-burst int Max burst of transactions for --tpslimit (default 1) --tpslimit-burst int Max burst of transactions for --tpslimit (default 1)
--use-cookies Enable session cookiejar --use-cookies Enable session cookiejar
--user-agent string Set the user-agent to a specified string (default \[dq]rclone/v1.71.1\[dq]) --user-agent string Set the user-agent to a specified string (default \[dq]rclone/v1.71.2\[dq])
\f[R] \f[R]
.fi .fi
.SS Performance .SS Performance
@@ -45274,7 +45296,8 @@ y/e/d> y
.fi .fi
.PP .PP
See the remote setup docs (https://rclone.org/remote_setup/) for how to See the remote setup docs (https://rclone.org/remote_setup/) for how to
set it up on a machine with no Internet browser available. set it up on a machine without an internet-connected web browser
available.
.PP .PP
Note that rclone runs a webserver on your local machine to collect the Note that rclone runs a webserver on your local machine to collect the
token as returned from Box. token as returned from Box.
@@ -47684,7 +47707,8 @@ y/e/d> y
.fi .fi
.PP .PP
See the remote setup docs (https://rclone.org/remote_setup/) for how to See the remote setup docs (https://rclone.org/remote_setup/) for how to
set it up on a machine with no Internet browser available. set it up on a machine without an internet-connected web browser
available.
.PP .PP
Note that rclone runs a webserver on your local machine to collect the Note that rclone runs a webserver on your local machine to collect the
token as returned from Citrix ShareFile. token as returned from Citrix ShareFile.
@@ -49774,7 +49798,8 @@ y/e/d> y
.fi .fi
.PP .PP
See the remote setup docs (https://rclone.org/remote_setup/) for how to See the remote setup docs (https://rclone.org/remote_setup/) for how to
set it up on a machine with no Internet browser available. set it up on a machine without an internet-connected web browser
available.
.PP .PP
Note that rclone runs a webserver on your local machine to collect the Note that rclone runs a webserver on your local machine to collect the
token as returned from Dropbox. token as returned from Dropbox.
@@ -52604,7 +52629,9 @@ Choose a number from below, or type in your own value
\[rs] \[dq]us-east1\[dq] \[rs] \[dq]us-east1\[dq]
13 / Northern Virginia. 13 / Northern Virginia.
\[rs] \[dq]us-east4\[dq] \[rs] \[dq]us-east4\[dq]
14 / Oregon. 14 / Ohio.
\[rs] \[dq]us-east5\[dq]
15 / Oregon.
\[rs] \[dq]us-west1\[dq] \[rs] \[dq]us-west1\[dq]
location> 12 location> 12
The storage class to use when storing objects in Google Cloud Storage. The storage class to use when storing objects in Google Cloud Storage.
@@ -52652,7 +52679,8 @@ y/e/d> y
.fi .fi
.PP .PP
See the remote setup docs (https://rclone.org/remote_setup/) for how to See the remote setup docs (https://rclone.org/remote_setup/) for how to
set it up on a machine with no Internet browser available. set it up on a machine without an internet-connected web browser
available.
.PP .PP
Note that rclone runs a webserver on your local machine to collect the Note that rclone runs a webserver on your local machine to collect the
token as returned from Google if using web browser to automatically token as returned from Google if using web browser to automatically
@@ -53353,6 +53381,12 @@ South Carolina
Northern Virginia Northern Virginia
.RE .RE
.IP \[bu] 2 .IP \[bu] 2
\[dq]us-east5\[dq]
.RS 2
.IP \[bu] 2
Ohio
.RE
.IP \[bu] 2
\[dq]us-west1\[dq] \[dq]us-west1\[dq]
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
@@ -53800,7 +53834,8 @@ y/e/d> y
.fi .fi
.PP .PP
See the remote setup docs (https://rclone.org/remote_setup/) for how to See the remote setup docs (https://rclone.org/remote_setup/) for how to
set it up on a machine with no Internet browser available. set it up on a machine without an internet-connected web browser
available.
.PP .PP
Note that rclone runs a webserver on your local machine to collect the Note that rclone runs a webserver on your local machine to collect the
token as returned from Google if using web browser to automatically token as returned from Google if using web browser to automatically
@@ -56609,7 +56644,8 @@ y/e/d> y
.fi .fi
.PP .PP
See the remote setup docs (https://rclone.org/remote_setup/) for how to See the remote setup docs (https://rclone.org/remote_setup/) for how to
set it up on a machine with no Internet browser available. set it up on a machine without an internet-connected web browser
available.
.PP .PP
Note that rclone runs a webserver on your local machine to collect the Note that rclone runs a webserver on your local machine to collect the
token as returned from Google if using web browser to automatically token as returned from Google if using web browser to automatically
@@ -58086,7 +58122,8 @@ account and hence should not be shared with other persons.\f[R] See the
below section for more information. below section for more information.
.PP .PP
See the remote setup docs (https://rclone.org/remote_setup/) for how to See the remote setup docs (https://rclone.org/remote_setup/) for how to
set it up on a machine with no Internet browser available. set it up on a machine without an internet-connected web browser
available.
.PP .PP
Note that rclone runs a webserver on your local machine to collect the Note that rclone runs a webserver on your local machine to collect the
token as returned from HiDrive. token as returned from HiDrive.
@@ -65379,7 +65416,8 @@ y/e/d> y
.fi .fi
.PP .PP
See the remote setup docs (https://rclone.org/remote_setup/) for how to See the remote setup docs (https://rclone.org/remote_setup/) for how to
set it up on a machine with no Internet browser available. set it up on a machine without an internet-connected web browser
available.
.PP .PP
Note that rclone runs a webserver on your local machine to collect the Note that rclone runs a webserver on your local machine to collect the
token as returned from Microsoft. token as returned from Microsoft.
@@ -70789,7 +70827,8 @@ y/e/d> y
.fi .fi
.PP .PP
See the remote setup docs (https://rclone.org/remote_setup/) for how to See the remote setup docs (https://rclone.org/remote_setup/) for how to
set it up on a machine with no Internet browser available. set it up on a machine without an internet-connected web browser
available.
.PP .PP
Note if you are using remote config with rclone authorize while your Note if you are using remote config with rclone authorize while your
pcloud server is the EU region, you will need to set the hostname in pcloud server is the EU region, you will need to set the hostname in
@@ -71832,7 +71871,8 @@ y/e/d>
.fi .fi
.PP .PP
See the remote setup docs (https://rclone.org/remote_setup/) for how to See the remote setup docs (https://rclone.org/remote_setup/) for how to
set it up on a machine with no Internet browser available. set it up on a machine without an internet-connected web browser
available.
.PP .PP
Note that rclone runs a webserver on your local machine to collect the Note that rclone runs a webserver on your local machine to collect the
token as returned from premiumize.me. token as returned from premiumize.me.
@@ -72554,7 +72594,8 @@ e/n/d/r/c/s/q> q
.fi .fi
.PP .PP
See the remote setup docs (https://rclone.org/remote_setup/) for how to See the remote setup docs (https://rclone.org/remote_setup/) for how to
set it up on a machine with no Internet browser available. set it up on a machine without an internet-connected web browser
available.
.PP .PP
Note that rclone runs a webserver on your local machine to collect the Note that rclone runs a webserver on your local machine to collect the
token as returned from put.io if using web browser to automatically token as returned from put.io if using web browser to automatically
@@ -75275,7 +75316,7 @@ On smbd, it\[aq]s the section title in \f[V]smb.conf\f[R] (usually in
You can find shares by querying the root if you\[aq]re unsure (e.g. You can find shares by querying the root if you\[aq]re unsure (e.g.
\f[V]rclone lsd remote:\f[R]). \f[V]rclone lsd remote:\f[R]).
.PP .PP
You can\[aq]t access to the shared printers from rclone, obviously. You can\[aq]t access the shared printers from rclone, obviously.
.PP .PP
You can\[aq]t use Anonymous access for logging in. You can\[aq]t use Anonymous access for logging in.
You have to use the \f[V]guest\f[R] user with an empty password instead. You have to use the \f[V]guest\f[R] user with an empty password instead.
@@ -78335,7 +78376,8 @@ y/e/d> y
.fi .fi
.PP .PP
See the remote setup docs (https://rclone.org/remote_setup/) for how to See the remote setup docs (https://rclone.org/remote_setup/) for how to
set it up on a machine with no Internet browser available. set it up on a machine without an internet-connected web browser
available.
.PP .PP
Note that rclone runs a webserver on your local machine to collect the Note that rclone runs a webserver on your local machine to collect the
token as returned from Yandex Disk. token as returned from Yandex Disk.
@@ -78666,7 +78708,8 @@ y/e/d>
.fi .fi
.PP .PP
See the remote setup docs (https://rclone.org/remote_setup/) for how to See the remote setup docs (https://rclone.org/remote_setup/) for how to
set it up on a machine with no Internet browser available. set it up on a machine without an internet-connected web browser
available.
.PP .PP
Rclone runs a webserver on your local computer to collect the Rclone runs a webserver on your local computer to collect the
authorization token from Zoho Workdrive. authorization token from Zoho Workdrive.
@@ -80189,6 +80232,60 @@ Options:
.IP \[bu] 2 .IP \[bu] 2
\[dq]error\[dq]: return an error based on option value \[dq]error\[dq]: return an error based on option value
.SH Changelog .SH Changelog
.SS v1.71.2 - 2025-10-20
.PP
See commits (https://github.com/rclone/rclone/compare/v1.71.1...v1.71.2)
.IP \[bu] 2
Bug Fixes
.RS 2
.IP \[bu] 2
build
.RS 2
.IP \[bu] 2
update Go to 1.25.3
.IP \[bu] 2
Update Docker image Alpine version to fix CVE-2025-9230
.RE
.IP \[bu] 2
bisync: Fix race when CaptureOutput is used concurrently (Nick
Craig-Wood)
.IP \[bu] 2
doc fixes (albertony, dougal, iTrooz, Matt LaPaglia, Nick Craig-Wood)
.IP \[bu] 2
index: Add missing providers (dougal)
.IP \[bu] 2
serve http: Fix: logging URL on start (dougal)
.RE
.IP \[bu] 2
Azurefiles
.RS 2
.IP \[bu] 2
Fix server side copy not waiting for completion (Vikas Bhansali)
.RE
.IP \[bu] 2
B2
.RS 2
.IP \[bu] 2
Fix 1TB+ uploads (dougal)
.RE
.IP \[bu] 2
Google Cloud Storage
.RS 2
.IP \[bu] 2
Add region us-east5 (Dulani Woods)
.RE
.IP \[bu] 2
Mega
.RS 2
.IP \[bu] 2
Fix 402 payment required errors (Nick Craig-Wood)
.RE
.IP \[bu] 2
Pikpak
.RS 2
.IP \[bu] 2
Fix unnecessary retries by using URL expire parameter (Youfu Zhang)
.RE
.SS v1.71.1 - 2025-09-24 .SS v1.71.1 - 2025-09-24
.PP .PP
See commits (https://github.com/rclone/rclone/compare/v1.71.0...v1.71.1) See commits (https://github.com/rclone/rclone/compare/v1.71.0...v1.71.1)