Sep 24, 2025
+Oct 20, 2025
rclone - manage files on cloud storage
@@ -444,6 +444,7 @@ S3, that work out of the box.)Remote authorization.
Remote authorization. Used to authorize a remote or headless rclone -from a machine with a browser - use as instructed by rclone config.
+from a machine with a browser. Use as instructed by rclone config. See +also the remote setup documentation.The command requires 1-3 arguments:
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.
-rclone authorize <fs name> [base64_json_blob | client_id client_secret] [flags]rclone authorize <backendname> [base64_json_blob | client_id client_secret] [flags] --auth-no-open-browser Do not automatically open auth link in default browser
-h, --help help for authorize
@@ -4301,10 +4305,10 @@ class="sourceCode sh">// Output: stories/The Quick Brown Fox!.txtrclone convmv "stories/The Quick Brown Fox!" --name-transform "date=-{YYYYMMDD}"
-// Output: stories/The Quick Brown Fox!-20250924rclone convmv "stories/The Quick Brown Fox!" --name-transform "date=-{macfriendlytime}"
-// Output: stories/The Quick Brown Fox!-2025-09-24 0413PMrclone convmv "stories/The Quick Brown Fox!.txt" --name-transform "all,regex=[\\.\\w]/ab"
// Output: ababababababab/ababab ababababab ababababab ababab!abababab--rc-user and
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). Ensure the proxy is
+--rc-user-from-header=x-remote-user). Ensure the proxy is
trusted and headers cannot be spoofed, as misconfiguration may lead to
unauthorized access.
If either of the above authentication methods is not configured and
@@ -10014,7 +10018,7 @@ set a single username and password with the --user and
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). Ensure the proxy is
+--user-from-header=x-remote-user). Ensure the proxy is
trusted and headers cannot be spoofed, as misconfiguration may lead to
unauthorized access.
If either of the above authentication methods is not configured and
@@ -11259,7 +11263,7 @@ set a single username and password with the --user and
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). Ensure the proxy is
+--user-from-header=x-remote-user). Ensure the proxy is
trusted and headers cannot be spoofed, as misconfiguration may lead to
unauthorized access.
If either of the above authentication methods is not configured and
@@ -11439,7 +11443,7 @@ set a single username and password with the --user and
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). Ensure the proxy is
+--user-from-header=x-remote-user). Ensure the proxy is
trusted and headers cannot be spoofed, as misconfiguration may lead to
unauthorized access.
If either of the above authentication methods is not configured and
@@ -12856,7 +12860,7 @@ set a single username and password with the --user and
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). Ensure the proxy is
+--user-from-header=x-remote-user). Ensure the proxy is
trusted and headers cannot be spoofed, as misconfiguration may lead to
unauthorized access.
If either of the above authentication methods is not configured and @@ -16752,18 +16756,20 @@ directory holding the config file.
Some of the configurations (those involving oauth2) require an -Internet connected web browser.
-If you are trying to set rclone up on a remote or headless box with -no browser available on it (e.g. a NAS or a server in a datacenter) then -you will need to use an alternative means of configuration. There are -two ways of doing it, described below.
+internet-connected web browser. +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 you will need to use an alternative means of +configuration. There are three ways of doing it, described below.
On the headless box run rclone config but answer
-N to the Use auto config? question.
Use auto config?
- * Say Y if not sure
- * Say N if you are working on a remote or headless machine
+On the headless machine run rclone
+config, but answer N to the question
+Use web browser to automatically authenticate rclone with remote?.
+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)
n) No
@@ -16775,25 +16781,29 @@ a web browser available.
For more help and alternate methods see: https://rclone.org/remote_setup/
Execute the following on the machine with the web browser (same rclone
version recommended):
-rclone authorize "onedrive"
+ rclone authorize "onedrive"
Then paste the result.
Enter a value.
config_token>
-Then on your main desktop machine
+Then on your main desktop machine, run rclone
+authorize.
rclone authorize "onedrive"
-If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth
-Log in and authorize rclone for access
-Waiting for code...
+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...
+
Got code
Paste the following into your remote machine --->
SECRET_TOKEN
<---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
--------------------
[acd12]
-client_id =
-client_secret =
+client_id =
+client_secret =
token = SECRET_TOKEN
--------------------
y) Yes this is OK
@@ -16802,38 +16812,50 @@ d) Delete this remote
y/e/d>
Configuring by copying
the config file
-Rclone stores all of its config in a single configuration file. This
-can easily be copied to configure a remote rclone.
-So first configure rclone on your desktop machine with
+Rclone stores all of its configuration in a single file. 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).
+Start by running rclone config
+to create the configuration file on your desktop machine.
rclone config
-to set up the config file.
-Find the config file by running rclone config file, for
-example
+Then locate the file by running rclone config file.
$ rclone config file
Configuration file is stored at:
/home/user/.rclone.conf
-Now transfer it to the remote box (scp, cut paste, ftp, sftp, etc.)
-and place it in the correct place (use rclone config file
-on the remote box to find out where).
+Finally, transfer the file to the remote machine (scp, cut paste,
+ftp, sftp, etc.) and place it in the correct location (use rclone config file on the remote
+machine to find out where).
Configuring using SSH Tunnel
-Linux and MacOS users can utilize SSH Tunnel to redirect the headless
-box port 53682 to local machine by using the following command:
+If you have an SSH client installed on your local machine, you can
+set 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
-Then on the headless box run rclone config and answer
-Y to the Use auto config? question.
-Use auto config?
- * Say Y if not sure
- * Say N if you are working on a remote or headless machine
+Then on the headless machine run rclone config and answer
+Y to the question
+Use web browser to automatically authenticate rclone with remote?.
+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)
n) No
-y/n> y
-Then copy and paste the auth url
-http://127.0.0.1:53682/auth?state=xxxxxxxxxxxx to the
-browser on your local machine, complete the auth and it is done.
+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...
+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 you are
+done.
Filtering, includes and
excludes
Filter flags determine which files rclone sync,
@@ -22311,7 +22333,7 @@ split into groups.
--tpslimit float Limit HTTP transactions per second to this
--tpslimit-burst int Max burst of transactions for --tpslimit (default 1)
--use-cookies Enable session cookiejar
- --user-agent string Set the user-agent to a specified string (default "rclone/v1.71.1")Flags helpful for increasing performance.
--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
y/e/d> ySee the remote setup -docs for how to set it up on a machine with no Internet browser -available.
+docs for how to set it up on a machine without an internet-connected +web browser available.Note that rclone runs a webserver on your local machine to collect the token as returned from Box. This only runs from the moment it opens 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 y/e/d> y
See the remote setup -docs for how to set it up on a machine with no Internet browser -available.
+docs for how to set it up on a machine without an internet-connected +web browser available.Note that rclone runs a webserver on your local machine to collect the token as returned from Citrix ShareFile. This only runs from the 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 y/e/d> y
See the remote setup -docs for how to set it up on a machine with no Internet browser -available.
+docs for how to set it up on a machine without an internet-connected +web browser available.Note that rclone runs a webserver on your local machine to collect the token as returned from Dropbox. This only runs from the moment it 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 \ "us-east1" 13 / Northern Virginia. \ "us-east4" -14 / Oregon. +14 / Ohio. + \ "us-east5" +15 / Oregon. \ "us-west1" location> 12 The storage class to use when storing objects in Google Cloud Storage. @@ -38781,8 +38805,8 @@ e) Edit this remote d) Delete this remote y/e/d> y
See the remote setup -docs for how to set it up on a machine with no Internet browser -available.
+docs for how to set it up on a machine without an internet-connected +web browser available.Note that rclone runs a webserver on your local machine to collect the token as returned from Google if using web browser to automatically authenticate. This only runs from the moment it opens your browser to @@ -39272,6 +39296,10 @@ then you will need to set this.
See the remote setup -docs for how to set it up on a machine with no Internet browser -available.
+docs for how to set it up on a machine without an internet-connected +web browser available.Note that rclone runs a webserver on your local machine to collect the token as returned from Google if using web browser to automatically authenticate. This only runs from the moment it opens your browser to @@ -41538,8 +41566,8 @@ e) Edit this remote d) Delete this remote y/e/d> y
See the remote setup -docs for how to set it up on a machine with no Internet browser -available.
+docs for how to set it up on a machine without an internet-connected +web browser available.Note that rclone runs a webserver on your local machine to collect the token as returned from Google if using web browser to automatically 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. See the below section for more information.
See the remote setup -docs for how to set it up on a machine with no Internet browser -available.
+docs for how to set it up on a machine without an internet-connected +web browser available.Note that rclone runs a webserver on your local machine to collect the token as returned from HiDrive. This only runs from the moment it 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 y/e/d> y
See the remote setup -docs for how to set it up on a machine with no Internet browser -available.
+docs for how to set it up on a machine without an internet-connected +web browser available.Note that rclone runs a webserver on your local machine to collect the token as returned from Microsoft. This only runs from the moment it opens your browser to the moment you get back the verification code. @@ -51817,8 +51845,8 @@ e) Edit this remote d) Delete this remote y/e/d> y
See the remote setup -docs for how to set it up on a machine with no Internet browser -available.
+docs for how to set it up on a machine without an internet-connected +web browser available.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 config', otherwise you might get a token error.
@@ -52568,8 +52596,8 @@ e) Edit this remote d) Delete this remote y/e/d>See the remote setup -docs for how to set it up on a machine with no Internet browser -available.
+docs for how to set it up on a machine without an internet-connected +web browser available.Note that rclone runs a webserver on your local machine to collect the token as returned from premiumize.me. This only runs from the moment it opens your browser to the moment you get back the verification code. @@ -53107,8 +53135,8 @@ s) Set configuration password q) Quit config e/n/d/r/c/s/q> q
See the remote setup -docs for how to set it up on a machine with no Internet browser -available.
+docs for how to set it up on a machine without an internet-connected +web browser available.Note that rclone runs a webserver on your local machine to collect
the token as returned from put.io if using web browser to automatically
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 smb.conf (usually in /etc/samba/)
file. 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 with an empty password instead. The rclone
client tries to avoid 8.3 names when uploading files by encoding
@@ -57192,8 +57220,8 @@ e) Edit this remote
d) Delete this remote
y/e/d> y
See the remote setup -docs for how to set it up on a machine with no Internet browser -available.
+docs for how to set it up on a machine without an internet-connected +web browser available.Note that rclone runs a webserver on your local machine to collect the token as returned from Yandex Disk. This only runs from the moment 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 y/e/d>
See the remote setup -docs for how to set it up on a machine with no Internet browser -available.
+docs for how to set it up on a machine without an internet-connected +web browser available.Rclone runs a webserver on your local computer to collect the authorization token from Zoho Workdrive. This is only from the moment your browser is opened until the token is returned. The webserver runs @@ -58481,6 +58509,48 @@ the output.